- output_nonlinearFalseSpecifies whether output occurs on each nonlinear residual evaluation
Default:False
C++ Type:bool
Description:Specifies whether output occurs on each nonlinear residual evaluation
- suffixcpThis will be appended to the file_base to create the directory name for checkpoint files.
Default:cp
C++ Type:std::string
Description:This will be appended to the file_base to create the directory name for checkpoint files.
- num_files2Number of the restart files to save
Default:2
C++ Type:unsigned int
Description:Number of the restart files to save
- append_date_formatThe format of the date/time to append, if not given UTC format used (see http://www.cplusplus.com/reference/ctime/strftime).
C++ Type:std::string
Description:The format of the date/time to append, if not given UTC format used (see http://www.cplusplus.com/reference/ctime/strftime).
- file_baseThe desired solution output name without an extension
C++ Type:std::string
Description:The desired solution output name without an extension
- end_stepTime step at which this output object stop operating
C++ Type:int
Description:Time step at which this output object stop operating
- output_linearFalseSpecifies whether output occurs on each linear residual evaluation
Default:False
C++ Type:bool
Description:Specifies whether output occurs on each linear residual evaluation
- append_dateFalseWhen true the date and time are appended to the output filename.
Default:False
C++ Type:bool
Description:When true the date and time are appended to the output filename.
- use_displacedFalseEnable/disable the use of the displaced mesh for outputting
Default:False
C++ Type:bool
Description:Enable/disable the use of the displaced mesh for outputting
- additional_execute_onThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, FAILED, CUSTOM.
C++ Type:ExecFlagEnum
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, FINAL, FAILED, CUSTOM.
- execute_onINITIAL TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, FAILED, CUSTOM.
Default:INITIAL TIMESTEP_END
C++ Type:ExecFlagEnum
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, FINAL, FAILED, CUSTOM.
- start_stepTime step at which this output object begins to operate
C++ Type:int
Description:Time step at which this output object begins to operate
Checkpoint
The Checkpoint has not been documented, if you would like to contribute to MOOSE by writing documentation, please see Documenting MOOSE. The content contained on this page explains the typical documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
!syntax description /Outputs/Checkpoint
Input Parameters
- padding4The number of for extension suffix (e.g., out.e-s002)
Default:4
C++ Type:unsigned int
Description:The number of for extension suffix (e.g., out.e-s002)
- binaryTrueToggle the output of binary files
Default:True
C++ Type:bool
Description:Toggle the output of binary files
- enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Description:Set the enabled status of the MooseObject.
- output_if_base_containsIf this is supplied then output will only be done in the case that the output base contains one of these strings. This is helpful in outputting only a subset of outputs when using MultiApps.
C++ Type:std::vector
Description:If this is supplied then output will only be done in the case that the output base contains one of these strings. This is helpful in outputting only a subset of outputs when using MultiApps.
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector
Description:Adds user-defined labels for accessing object parameters via control logic.
Advanced Parameters
- time_tolerance1e-14Time tolerance utilized checking start and end times
Default:1e-14
C++ Type:double
Description:Time tolerance utilized checking start and end times
- start_timeTime at which this output object begins to operate
C++ Type:double
Description:Time at which this output object begins to operate
- interval1The interval at which time steps are output to the solution file
Default:1
C++ Type:unsigned int
Description:The interval at which time steps are output to the solution file
- sync_timesTimes at which the output and solution is forced to occur
C++ Type:std::vector
Description:Times at which the output and solution is forced to occur
- end_timeTime at which this output object stop operating
C++ Type:double
Description:Time at which this output object stop operating
- sync_onlyFalseOnly export results at sync times
Default:False
C++ Type:bool
Description:Only export results at sync times
Timing Parameters
- linear_residual_start_timeSpecifies a start time to begin output on each linear residual evaluation
C++ Type:double
Description:Specifies a start time to begin output on each linear residual evaluation
- nonlinear_residual_start_timeSpecifies a start time to begin output on each nonlinear residual evaluation
C++ Type:double
Description:Specifies a start time to begin output on each nonlinear residual evaluation
- linear_residual_dt_divisor1000Number of divisions applied to time step when outputting linear residuals
Default:1000
C++ Type:double
Description:Number of divisions applied to time step when outputting linear residuals
- nonlinear_residual_dt_divisor1000Number of divisions applied to time step when outputting non-linear residuals
Default:1000
C++ Type:double
Description:Number of divisions applied to time step when outputting non-linear residuals
- linear_residual_end_timeSpecifies an end time to begin output on each linear residual evaluation
C++ Type:double
Description:Specifies an end time to begin output on each linear residual evaluation
- nonlinear_residual_end_timeSpecifies an end time to begin output on each nonlinear residual evaluation
C++ Type:double
Description:Specifies an end time to begin output on each nonlinear residual evaluation