- allow_unimplementedFalseSet to true to allow the empty output of data that does not have a JSON output implementation
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Set to true to allow the empty output of data that does not have a JSON output implementation
- entriesvalue typeThe entries to output for each restartable value
Default:value type
C++ Type:MultiMooseEnum
Unit:(no unit assumed)
Controllable:No
Description:The entries to output for each restartable value
- excludeThe data name patterns to exclude (* for matching all, ? for matching a single character)
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:The data name patterns to exclude (* for matching all, ? for matching a single character)
- 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
Unit:(no unit assumed)
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.
- includeThe data name patterns to include (* for matching all, ? for matching a single character)
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:The data name patterns to include (* for matching all, ? for matching a single character)
- mapThe data map to use; if unset, use system restartable data
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:The data map to use; if unset, use system restartable data
- 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
Unit:(no unit assumed)
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.
RestartableDataReporter
A Reporter object for outputting Restartable data in a human-readable form. This includes restartable metadata, such as mesh metadata. This object is particularly useful for inspecting restartable data for the purposes of debugging.
Only data types that have a to_json specialization support having their values output. If the "allow_unimplemented" parameter is set to true, restartable data with unimplemented specializations will still have their auxiliary information output (type, whether or not the data is loaded/stored, etc).
The "include" and "exclude" parameters enable the filtering of data by name. With these parameters, you can use * as a wildcard match of any number of characters and ? as a wildcard match for a single character.
Example Input Syntax
The following input file snippet demonstrates the use of the RestartableDataReporter object.
[Reporters]
[data]
type = RestartableDataReporter
include = 'FEProblemBase/*/time*'
[]
[]
Input 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
Unit:(no unit assumed)
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).
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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>
Unit:(no unit assumed)
Controllable:No
Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object
- 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
Unit:(no unit assumed)
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.