AnalysisStepUserObject

Maps the time steps and the load step simulation times. It can be used in either direction depending on the simulation setup. It generates steps to be used in StepPeriod to control the enabled/disabled state of objects with user-provided simulation steps.

Description

AnalysisStepUserObject is a general user object that performs basic computations to provide an analysis step given a simulation time step value or a simulation time step value given an analysis step. This user object is used to interface with AbaqusUMATStress and AbaqusUExternalDB to provide analysis step information to user routines. AnalysisStepUserObject can also interface with AnalysisStepPeriod to enable/disable boundary conditions and constraints according the user-defined analysis steps.

Example Input File Syntax

[UserObjects<<<{"href": "../../syntax/UserObjects/index.html"}>>>]
  [step_uo]
    type = AnalysisStepUserObject<<<{"description": "Maps the time steps and the load step simulation times. It can be used in either direction depending on the simulation setup. It generates steps to be used in StepPeriod to control the enabled/disabled state of objects with user-provided simulation steps.", "href": "AnalysisStepUserObject.html"}>>>
    step_start_times<<<{"description": "The beginning of step times. The number of steps is inferred from the number of times. One step is defined by its start time; and its end time is taken from the start time of the next step (if it exists). This list needs to be in ascending value order."}>>> = '0 5'
  []
[]
(moose/modules/solid_mechanics/test/tests/umat/analysis_steps/elastic_temperature_steps_uo.i)

Input Parameters

  • number_stepsTotal number of steps in the total time inteval (provided as total_time_interval).

    C++ Type:unsigned int

    Controllable:No

    Description:Total number of steps in the total time inteval (provided as total_time_interval).

  • set_sync_timesFalseWhether to make the output times include the step times.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Whether to make the output times include the step times.

  • step_durationsThe durations of the steps. 'n' of step time intervals define 'n+1' steps starting at time equals zero.

    C++ Type:std::vector<double>

    Unit:(no unit assumed)

    Controllable:No

    Description:The durations of the steps. 'n' of step time intervals define 'n+1' steps starting at time equals zero.

  • step_end_timesThe end of step times. The number of steps is inferred from the number of times. One step is defined by the interval between previous start time and the next. The first step is assumed to start at time zero. This list needs to be in ascending value order.

    C++ Type:std::vector<double>

    Unit:(no unit assumed)

    Controllable:No

    Description:The end of step times. The number of steps is inferred from the number of times. One step is defined by the interval between previous start time and the next. The first step is assumed to start at time zero. This list needs to be in ascending value order.

  • step_start_timesThe beginning of step times. The number of steps is inferred from the number of times. One step is defined by its start time; and its end time is taken from the start time of the next step (if it exists). This list needs to be in ascending value order.

    C++ Type:std::vector<double>

    Unit:(no unit assumed)

    Controllable:No

    Description:The beginning of step times. The number of steps is inferred from the number of times. One step is defined by its start time; and its end time is taken from the start time of the next step (if it exists). This list needs to be in ascending value order.

  • total_time_intervalThe total time interval in which the steps take place. This option needs to be used together with the 'number_steps'.

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The total time interval in which the steps take place. This option needs to be used together with the 'number_steps'.

Optional Parameters

  • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

    Default:False

    C++ Type:bool

    Controllable:No

    Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

  • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.

    Default:TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:NONE, INITIAL, LINEAR, LINEAR_CONVERGENCE, NONLINEAR, NONLINEAR_CONVERGENCE, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM

    Controllable:No

    Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.

  • execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

    Default:0

    C++ Type:int

    Controllable:No

    Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

  • force_postauxFalseForces the UserObject to be executed in POSTAUX

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Forces the UserObject to be executed in POSTAUX

  • force_preauxFalseForces the UserObject to be executed in PREAUX

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Forces the UserObject to be executed in PREAUX

  • force_preicFalseForces the UserObject to be executed in PREIC during initial setup

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Forces the UserObject to be executed in PREIC during initial setup

Execution Scheduling Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector<std::string>

    Controllable:No

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Controllable:Yes

    Description:Set the enabled status of the MooseObject.

  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters

  • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

    C++ Type:MaterialPropertyName

    Unit:(no unit assumed)

    Controllable:No

    Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

  • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

Material Property Retrieval Parameters