- time_intervalTime interval between times
C++ Type:double
Controllable:No
Description:Time interval between times
TimeIntervalTimes
This object specifies times with a fixed time interval between a start time and end time. The start time and end time may be provided or if not, taken to be the start time and end time from the simulation (in this case, the executioner type must be Transient). If the end time does not fall exactly at the end of the end of the last time interval, then the end time is only included if the parameter "always_include_end_time" is set to true.
Input Parameters
- always_include_end_timeTrueIf true, includes the end time even if the last time interval would be partial
Default:True
C++ Type:bool
Controllable:No
Description:If true, includes the end time even if the last time interval would be partial
- end_timeEnd time. If not provided, the simulation end time is used.
C++ Type:double
Controllable:No
Description:End time. If not provided, the simulation end time is used.
- execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, ALWAYS.
Default:TIMESTEP_END
C++ Type:ExecFlagEnum
Controllable:No
Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, ALWAYS.
- 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
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.
- start_timeStart time. If not provided, the simulation start time is used.
C++ Type:double
Controllable:No
Description:Start time. If not provided, the simulation start time is used.
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).
- auto_broadcastFalseWether Times should be broadcasted across all ranks
Default:False
C++ Type:bool
Controllable:No
Description:Wether Times should be broadcasted across all ranks
- auto_sortTrueWhether Times should be sorted
Default:True
C++ Type:bool
Controllable:No
Description:Whether Times should be sorted
- 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.
- 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
- outputsVector of output names where you would like to restrict the output of variables(s) associated with this object
C++ Type:std::vector<OutputName>
Controllable:No
Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object
- unique_timesTrueWhether duplicate values should be removed from the Times vector
Default:True
C++ Type:bool
Controllable:No
Description:Whether duplicate values should be removed from the Times vector
- unique_tolerance1e-12Absolute tolerance for removing duplicated times when getting a set of unique times
Default:1e-12
C++ Type:double
Controllable:No
Description:Absolute tolerance for removing duplicated times when getting a set of unique times
- 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.