TopResidualDebugOutput

under construction:Undocumented Class

The TopResidualDebugOutput has not been documented. The content contained on this page includes the typical automatic 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/TopResidualDebugOutput

Input Parameters

end_stepTime step at which this output object stop operating
C++ Type:int
Options:
Description:Time step at which this output object stop operating
output_nonlinearFalseSpecifies whether output occurs on each nonlinear residual evaluation
Default:False
C++ Type:bool
Options:
Description:Specifies whether output occurs on each nonlinear residual evaluation
num_residuals0The number of top residuals to print out (0 = no output)
Default:0
C++ Type:unsigned int
Options:
Description:The number of top residuals to print out (0 = no output)
output_linearFalseSpecifies whether output occurs on each linear residual evaluation
Default:False
C++ Type:bool
Options:
Description:Specifies whether output occurs on each linear residual evaluation
use_displacedFalseEnable/disable the use of the displaced mesh for outputting
Default:False
C++ Type:bool
Options:
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
Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL FAILED CUSTOM
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_onLINEAR NONLINEAR 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:LINEAR NONLINEAR TIMESTEP_END
C++ Type:ExecFlagEnum
Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL FAILED CUSTOM
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
Options:
Description:Time step at which this output object begins to operate

Optional Parameters

time_tolerance1e-14Time tolerance utilized checking start and end times
Default:1e-14
C++ Type:double
Options:
Description:Time tolerance utilized checking start and end times
start_timeTime at which this output object begins to operate
C++ Type:double
Options:
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
Options:
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
Options:
Description:Times at which the output and solution is forced to occur
end_timeTime at which this output object stop operating
C++ Type:double
Options:
Description:Time at which this output object stop operating
sync_onlyFalseOnly export results at sync times
Default:False
C++ Type:bool
Options:
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
Options:
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
Options:
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
Options:
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
Options:
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
Options:
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
Options:
Description:Specifies an end time to begin output on each nonlinear residual evaluation

Petsc Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector
Options:
Description:Adds user-defined labels for accessing object parameters via control logic.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Options:
Description:Set the enabled status of the MooseObject.

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools

TopResidualDebugOutput

Input Parameters

Optional Parameters

Timing Parameters

Petsc Parameters

Advanced Parameters

Input Files

References

TopResidualDebugOutput

Input Parameters

Optional Parameters

Timing Parameters

Petsc Parameters

Advanced Parameters

Input Files

test/tests/outputs/debug/show_top_residuals.i

test/tests/outputs/debug/show_top_residuals_nonlinear_only.i

test/tests/outputs/debug/show_top_residuals_scalar.i

References