Console

The Console object in MOOSE is a buffered ostringstream object that should be used to for all screen based output. Each MooseObject derived class has access to the _console member for screen writing. Output to this object can be controlled in various ways from the [Outputs] block. Information can be disabled, output at a lower frequency, colored, or color removed.

Multiapp Output

When using the MOOSE Multiapp system, Output to the _console object will be automatically indented and labeled according to the multiapp level. This can make it easier to identify where output is coming from in a more complex simulation.

Input Parameters

  • append_restartFalseAppend existing file on restart

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Append existing file on restart

  • output_fileFalseOutput to the file. The default behavior is to write to file only from the head processor. If "--keep-cout" is passed to the executable, then each processor will write to its own file. The same parallel behaviour can also be achieved by passing "--keep-cout --redirect-stdout" to the executable without setting this parameter to true.

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Output to the file. The default behavior is to write to file only from the head processor. If "--keep-cout" is passed to the executable, then each processor will write to its own file. The same parallel behaviour can also be achieved by passing "--keep-cout --redirect-stdout" to the executable without setting this parameter to true.

  • output_screenTrueOutput to the screen

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Output to the screen

  • print_mesh_changed_infoFalseWhen true, each time the mesh is changed the mesh information is printed

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:When true, each time the mesh is changed the mesh information is printed

  • use_displacedFalseEnable/disable the use of the displaced mesh for outputting

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Enable/disable the use of the displaced mesh for outputting

Optional Parameters

  • additional_execute_onThe 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.

    C++ Type:ExecFlagEnum

    Unit:(no unit assumed)

    Options:NONE, INITIAL, LINEAR, NONLINEAR_CONVERGENCE, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, FAILED, 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.

  • execute_onINITIAL TIMESTEP_BEGIN LINEAR NONLINEAR FAILEDThe 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:INITIAL TIMESTEP_BEGIN LINEAR NONLINEAR FAILED

    C++ Type:ExecFlagEnum

    Unit:(no unit assumed)

    Options:NONE, INITIAL, LINEAR, NONLINEAR_CONVERGENCE, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, FAILED, 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.

  • output_linearFalseSpecifies whether output occurs on each PETSc linear residual evaluation

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Specifies whether output occurs on each PETSc linear residual evaluation

  • output_nonlinearFalseSpecifies whether output occurs on each PETSc nonlinear residual evaluation

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Specifies whether output occurs on each PETSc nonlinear residual evaluation

Execution Scheduling Parameters

  • all_variable_normsFalseIf true, all variable norms will be printed after each solve

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:If true, all variable norms will be printed after each solve

  • outlier_multiplier0.8 2 Multiplier utilized to determine if a residual norm is an outlier. If the variable residual is less than multiplier[0] times the total residual it is colored red. If the variable residual is less than multiplier[1] times the average residual it is colored yellow.

    Default:0.8 2

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Multiplier utilized to determine if a residual norm is an outlier. If the variable residual is less than multiplier[0] times the total residual it is colored red. If the variable residual is less than multiplier[1] times the average residual it is colored yellow.

  • outlier_variable_normsTrueIf true, outlier variable norms will be printed after each solve

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:If true, outlier variable norms will be printed after each solve

Variable And Residual Norms Parameters

  • append_dateFalseWhen true the date and time are appended to the output filename.

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:When true the date and time are appended to the output filename.

  • append_date_formatThe format of the date/time to append, if not given UTC format is used (see http://www.cplusplus.com/reference/ctime/strftime).

    C++ Type:std::string

    Unit:(no unit assumed)

    Controllable:No

    Description:The format of the date/time to append, if not given UTC format is used (see http://www.cplusplus.com/reference/ctime/strftime).

  • file_baseThe desired solution output name without an extension. If not provided, MOOSE sets it with Outputs/file_base when available. Otherwise, MOOSE uses input file name and this object name for a master input or uses master file_base, the subapp name and this object name for a subapp input to set it.

    C++ Type:std::string

    Unit:(no unit assumed)

    Controllable:No

    Description:The desired solution output name without an extension. If not provided, MOOSE sets it with Outputs/file_base when available. Otherwise, MOOSE uses input file name and this object name for a master input or uses master file_base, the subapp name and this object name for a subapp input to set it.

  • 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<std::string>

    Unit:(no unit assumed)

    Controllable:No

    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.

  • padding4The number of digits for the extension suffix (e.g., out.e-s002)

    Default:4

    C++ Type:unsigned int

    Unit:(no unit assumed)

    Controllable:No

    Description:The number of digits for the extension suffix (e.g., out.e-s002)

File Name Customization Parameters

  • 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.

  • show_multiapp_nameFalseIndent multiapp output using the multiapp name

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Indent multiapp output using the multiapp name

  • system_infoframework mesh aux nonlinear executionList of information types to display ('framework', 'mesh', 'aux', 'nonlinear', 'relationship', 'execution', 'output')

    Default:framework mesh aux nonlinear execution

    C++ Type:MultiMooseEnum

    Unit:(no unit assumed)

    Options:framework, mesh, aux, nonlinear, relationship, execution, output

    Controllable:No

    Description:List of information types to display ('framework', 'mesh', 'aux', 'nonlinear', 'relationship', 'execution', 'output')

  • verboseFalsePrint detailed diagnostics on timestep calculation

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Print detailed diagnostics on timestep calculation

Advanced Parameters

  • end_stepTime step at which this output object stop operating

    C++ Type:int

    Unit:(no unit assumed)

    Controllable:No

    Description:Time step at which this output object stop operating

  • end_timeTime at which this output object stop operating

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Time at which this output object stop operating

  • min_simulation_time_interval0The minimum simulation time between output steps

    Default:0

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The minimum simulation time between output steps

  • simulation_time_interval1.79769e+308The target simulation time interval (in seconds) at which to output

    Default:1.79769e+308

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The target simulation time interval (in seconds) at which to output

  • start_stepTime step at which this output object begins to operate

    C++ Type:int

    Unit:(no unit assumed)

    Controllable:No

    Description:Time step at which this output object begins to operate

  • start_timeTime at which this output object begins to operate

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Time at which this output object begins to operate

  • sync_onlyFalseOnly export results at sync times

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Only export results at sync times

  • sync_timesTimes at which the output and solution is forced to occur

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Times at which the output and solution is forced to occur

  • sync_times_objectTimes object providing the times at which the output and solution is forced to occur

    C++ Type:TimesName

    Unit:(no unit assumed)

    Controllable:No

    Description:Times object providing the times at which the output and solution is forced to occur

  • time_step_interval1The interval (number of time steps) at which output occurs. Unless explicitly set, the default value of this parameter is set to infinity if the wall_time_interval is explicitly set.

    Default:1

    C++ Type:unsigned int

    Unit:(no unit assumed)

    Controllable:No

    Description:The interval (number of time steps) at which output occurs. Unless explicitly set, the default value of this parameter is set to infinity if the wall_time_interval is explicitly set.

  • time_tolerance1e-14Time tolerance utilized checking start and end times

    Default:1e-14

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Time tolerance utilized checking start and end times

  • wall_time_interval1.79769e+308The target wall time interval (in seconds) at which to output

    Default:1.79769e+308

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The target wall time interval (in seconds) at which to output

Timing And Frequency Of Output Parameters

  • execute_input_onEnable/disable the output of the input file

    C++ Type:ExecFlagEnum

    Unit:(no unit assumed)

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

    Controllable:No

    Description:Enable/disable the output of the input file

  • execute_postprocessors_onINITIAL TIMESTEP_ENDControl of when postprocessors are output

    Default:INITIAL TIMESTEP_END

    C++ Type:ExecFlagEnum

    Unit:(no unit assumed)

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

    Controllable:No

    Description:Control of when postprocessors are output

  • execute_reporters_onINITIAL TIMESTEP_ENDControl of when Reporter values are output

    Default:INITIAL TIMESTEP_END

    C++ Type:ExecFlagEnum

    Unit:(no unit assumed)

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

    Controllable:No

    Description:Control of when Reporter values are output

  • execute_scalars_onINITIAL TIMESTEP_ENDControl the output of scalar variables

    Default:INITIAL TIMESTEP_END

    C++ Type:ExecFlagEnum

    Unit:(no unit assumed)

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

    Controllable:No

    Description:Control the output of scalar variables

  • execute_system_information_onINITIALControl when the output of the simulation information occurs

    Default:INITIAL

    C++ Type:ExecFlagEnum

    Unit:(no unit assumed)

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

    Controllable:No

    Description:Control when the output of the simulation information occurs

  • execute_vector_postprocessors_onINITIAL TIMESTEP_ENDEnable/disable the output of VectorPostprocessors

    Default:INITIAL TIMESTEP_END

    C++ Type:ExecFlagEnum

    Unit:(no unit assumed)

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

    Controllable:No

    Description:Enable/disable the output of VectorPostprocessors

  • hideA list of the variables and postprocessors that should NOT be output to the Exodus file (may include Variables, ScalarVariables, and Postprocessor names).

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

    Unit:(no unit assumed)

    Controllable:No

    Description:A list of the variables and postprocessors that should NOT be output to the Exodus file (may include Variables, ScalarVariables, and Postprocessor names).

  • showA list of the variables and postprocessors that should be output to the Exodus file (may include Variables, ScalarVariables, and Postprocessor names).

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

    Unit:(no unit assumed)

    Controllable:No

    Description:A list of the variables and postprocessors that should be output to the Exodus file (may include Variables, ScalarVariables, and Postprocessor names).

Selection/Restriction Of Output Parameters

  • fit_modeENVIRONMENTSpecifies the wrapping mode for post-processor tables that are printed to the screen (ENVIRONMENT: Read "MOOSE_PPS_WIDTH" for desired width (if not set, defaults to AUTO), AUTO: Attempt to determine width automatically (serial only), : Desired width

    Default:ENVIRONMENT

    C++ Type:MooseEnum

    Unit:(no unit assumed)

    Options:ENVIRONMENT, AUTO, 80, 120, 160

    Controllable:No

    Description:Specifies the wrapping mode for post-processor tables that are printed to the screen (ENVIRONMENT: Read "MOOSE_PPS_WIDTH" for desired width (if not set, defaults to AUTO), AUTO: Attempt to determine width automatically (serial only), : Desired width

  • max_rows15The maximum number of postprocessor/scalar values displayed on screen during a timestep (set to 0 for unlimited)

    Default:15

    C++ Type:unsigned int

    Unit:(no unit assumed)

    Controllable:No

    Description:The maximum number of postprocessor/scalar values displayed on screen during a timestep (set to 0 for unlimited)

  • new_row_tolerance1e-12The independent variable tolerance for determining when a new row should be added to the table (Note: This value must be set independently for Postprocessor output to type=Console and type=CSV file separately.

    Default:1e-12

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The independent variable tolerance for determining when a new row should be added to the table (Note: This value must be set independently for Postprocessor output to type=Console and type=CSV file separately.

  • time_columnTrueWhether or not the 'time' column should be written for Postprocessor CSV files

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Whether or not the 'time' column should be written for Postprocessor CSV files

  • time_dataFalseWhen true and VectorPostprocessor data exists, write a csv file containing the timestep and time information.

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:When true and VectorPostprocessor data exists, write a csv file containing the timestep and time information.

Table Formatting Parameters

  • libmesh_logTruePrint the libMesh performance log, requires libMesh to be configured with --enable-perflog

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Print the libMesh performance log, requires libMesh to be configured with --enable-perflog

  • solve_logFalseToggles the printing of the 'Moose Test Performance' log

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Toggles the printing of the 'Moose Test Performance' log

Perf Log Parameters

  • linear_residual_dt_divisor1000Number of divisions applied to time step when outputting linear residuals

    Default:1000

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Number of divisions applied to time step when outputting linear residuals

  • linear_residual_end_timeSpecifies an end time to begin output on each linear residual evaluation

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Specifies an end time to begin output on each linear residual evaluation

  • linear_residual_start_timeSpecifies a start time to begin output on each linear residual evaluation

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Specifies a start time to begin output on each linear residual evaluation

  • nonlinear_residual_dt_divisor1000Number of divisions applied to time step when outputting non-linear residuals

    Default:1000

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Number of divisions applied to time step when outputting non-linear residuals

  • nonlinear_residual_end_timeSpecifies an end time to begin output on each nonlinear residual evaluation

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Specifies an end time to begin output on each nonlinear residual evaluation

  • nonlinear_residual_start_timeSpecifies a start time to begin output on each nonlinear residual evaluation

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Specifies a start time to begin output on each nonlinear residual evaluation

Petsc Linear/Nonlinear Output Parameters

  • postprocessors_as_reportersFalseOutput Postprocessors values as Reporter values.

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Output Postprocessors values as Reporter values.

  • vectorpostprocessors_as_reportersFalseOutput VectorsPostprocessors vectors as Reporter values.

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Output VectorsPostprocessors vectors as Reporter values.

Conversions Before Output Parameters

  • scientific_timeFalseControl the printing of time and dt in scientific notation

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Control the printing of time and dt in scientific notation

  • time_formatplainThe format for the printed times ('dtime' means a format like 1d 01:01:0.1)

    Default:plain

    C++ Type:MooseEnum

    Unit:(no unit assumed)

    Options:plain, second, minute, hour, day, dtime

    Controllable:No

    Description:The format for the printed times ('dtime' means a format like 1d 01:01:0.1)

  • time_precisionThe number of significant digits that are printed on time related outputs

    C++ Type:unsigned int

    Unit:(no unit assumed)

    Controllable:No

    Description:The number of significant digits that are printed on time related outputs

Time Output Formatting Parameters

References

No citations exist within this document.