Console

under construction:Undocumented Class

The Console 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/Console

Input Parameters

  • output_screenTrueOutput to the screen

    Default:True

    C++ Type:bool

    Options:

    Description:Output to the screen

  • 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

    Options:

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

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

  • output_fileFalseOutput to the file

    Default:False

    C++ Type:bool

    Options:

    Description:Output to the file

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

    Default:False

    C++ Type:bool

    Options:

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

  • 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

  • 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

    Options:

    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.

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

    Default:False

    C++ Type:bool

    Options:

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

  • file_baseThe desired solution output name without an extension

    C++ Type:std::string

    Options:

    Description:The desired solution output name without an extension

  • 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

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

    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.

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

    C++ Type:unsigned int

    Options:

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

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

    Default:False

    C++ Type:bool

    Options:

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

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

    Default:ENVIRONMENT

    C++ Type:MooseEnum

    Options:ENVIRONMENT AUTO 80 120 160

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

  • scientific_timeFalseControl the printing of time and dt in scientific notation

    Default:False

    C++ Type:bool

    Options:

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

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

    Default:True

    C++ Type:bool

    Options:

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

  • 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

  • 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

  • append_restartFalseAppend existing file on restart

    Default:False

    C++ Type:bool

    Options:

    Description:Append existing file on restart

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

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

  • verboseFalsePrint detailed diagnostics on timestep calculation

    Default:False

    C++ Type:bool

    Options:

    Description:Print detailed diagnostics on timestep calculation

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

    Default:framework mesh aux nonlinear relationship execution

    C++ Type:MultiMooseEnum

    Options:framework mesh aux nonlinear relationship execution output

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

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

    Default:4

    C++ Type:unsigned int

    Options:

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

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

  • show_multiapp_nameFalseIndent multiapp output using the multiapp name

    Default:False

    C++ Type:bool

    Options:

    Description:Indent multiapp output using the multiapp name

  • 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

    Options:

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

  • 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

    Options:

    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.

Advanced Parameters

  • execute_postprocessors_onINITIAL TIMESTEP_ENDControl of when postprocessors are output

    Default:INITIAL TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL FAILED CUSTOM

    Description:Control of when postprocessors are output

  • execute_input_onEnable/disable the output of the input file

    C++ Type:ExecFlagEnum

    Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL FAILED CUSTOM

    Description:Enable/disable the output of the input file

  • execute_scalars_onINITIAL TIMESTEP_ENDControl the output of scalar variables

    Default:INITIAL TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL FAILED CUSTOM

    Description:Control the output of scalar variables

  • 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

    Options:

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

  • execute_system_information_onINITIALControl when the output of the simulation information occurs

    Default:INITIAL

    C++ Type:ExecFlagEnum

    Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL FAILED CUSTOM

    Description:Control when the output of the simulation information occurs

  • 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

    Options:

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

  • execute_vector_postprocessors_onINITIAL TIMESTEP_ENDEnable/disable the output of VectorPostprocessors

    Default:INITIAL TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL FAILED CUSTOM

    Description:Enable/disable the output of VectorPostprocessors

Variables Parameters

  • 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

    Options:

    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.

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

    Default:False

    C++ Type:bool

    Options:

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

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

    Default:True

    C++ Type:bool

    Options:

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

Norms Parameters

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

    Default:False

    C++ Type:bool

    Options:

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

Perf Log Parameters

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

    Default:True

    C++ Type:bool

    Options:

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

Performance Log Parameters

Input Files

Child Objects

References