CommonOutputAction

Overview

An action, that acts when the [Outputs] block exists. It adds short-cut syntax options, such as the "exodus" parameter, as well as common parameters that are applied to all output objects. For example, the following enables two output objects and sets the output "time_step_interval" to every 10 timesteps for both objects.

[Outputs]
  exodus = true
  csv = true
  interval = 10
[]

Please refer to the Output System for more information.

Input Parameters

• active__all__ If specified only the blocks named will be visited and made active

  Default:__all__

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

  Controllable:No

  Description:If specified only the blocks named will be visited and made active

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

  Default:False

  C++ Type:bool

  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 (see http://www.cplusplus.com/reference/ctime/strftime).

  C++ Type:std::string

  Controllable:No

  Description:The format of the date/time to append (see http://www.cplusplus.com/reference/ctime/strftime).

• checkpointFalseCreate checkpoint files using the default options.

  Default:False

  C++ Type:bool

  Controllable:No

  Description:Create checkpoint files using the default options.

• colorTrueSet to false to turn off all coloring in all outputs

  Default:True

  C++ Type:bool

  Controllable:No

  Description:Set to false to turn off all coloring in all outputs

• consoleTrueOutput the results using the default settings for Console output

  Default:True

  C++ Type:bool

  Controllable:No

  Description:Output the results using the default settings for Console output

• control_tagsAdds user-defined labels for accessing object parameters via control logic.

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

  Controllable:No

  Description:Adds user-defined labels for accessing object parameters via control logic.

• controlsFalseEnable the screen output of Control systems.

  Default:False

  C++ Type:bool

  Controllable:No

  Description:Enable the screen output of Control systems.

• csvFalseOutput the scalar variable and postprocessors to a *.csv file using the default CSV output.

  Default:False

  C++ Type:bool

  Controllable:No

  Description:Output the scalar variable and postprocessors to a *.csv file using the default CSV output.

• dofmapFalseCreate the dof map .json output file

  Default:False

  C++ Type:bool

  Controllable:No

  Description:Create the dof map .json output file

• execute_onINITIAL TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, FAILED, CUSTOM.

  Default:INITIAL TIMESTEP_END

  C++ Type:ExecFlagEnum

  Options:FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, 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, the available options include FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, FAILED, CUSTOM.

• exodusFalseOutput the results using the default settings for Exodus output.

  Default:False

  C++ Type:bool

  Controllable:No

  Description:Output the results using the default settings for Exodus output.

• file_baseCommon file base name to be utilized with all output objects

  C++ Type:std::string

  Controllable:No

  Description:Common file base name to be utilized with all output objects

• gmvFalseOutput the results using the default settings for GMV output

  Default:False

  C++ Type:bool

  Controllable:No

  Description:Output the results using the default settings for GMV output

• gnuplotFalseOutput the scalar and postprocessor results using the default settings for GNUPlot output

  Default:False

  C++ Type:bool

  Controllable:No

  Description:Output the scalar and postprocessor results using the default settings for GNUPlot output

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

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

• inactiveIf specified blocks matching these identifiers will be skipped.

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

  Controllable:No

  Description:If specified blocks matching these identifiers will be skipped.

• jsonFalseOutput Reporter values to a *.json file using the default JSON output.

  Default:False

  C++ Type:bool

  Controllable:No

  Description:Output Reporter values to a *.json file using the default JSON output.

• minimum_time_interval0The minimum simulation time between output steps

  Default:0

  C++ Type:double

  Controllable:No

  Description:The minimum simulation time between output steps

• nemesisFalseOutput the results using the default settings for Nemesis output

  Default:False

  C++ Type:bool

  Controllable:No

  Description:Output the results using the default settings for Nemesis output

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

  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.

• perf_graphFalseEnable printing of the performance graph to the screen (Console)

  Default:False

  C++ Type:bool

  Controllable:No

  Description:Enable printing of the performance graph to the screen (Console)

• perf_graph_liveTrueEnables printing of live progress messages

  Default:True

  C++ Type:bool

  Controllable:No

  Description:Enables printing of live progress messages

• perf_graph_live_mem_limit100Memory (in MB) to cause a message to be printed.

  Default:100

  C++ Type:unsigned int

  Controllable:No

  Description:Memory (in MB) to cause a message to be printed.

• perf_graph_live_time_limit5Time (in seconds) to wait before printing a message.

  Default:5

  C++ Type:double

  Controllable:No

  Description:Time (in seconds) to wait before printing a message.

• print_linear_converged_reasonTrueEnable/disable printing of the linear solver convergence reason to the screen. This parameter only affects the output of the third-party solver (e.g. PETSc), not MOOSE itself.

  Default:True

  C++ Type:bool

  Controllable:No

  Description:Enable/disable printing of the linear solver convergence reason to the screen. This parameter only affects the output of the third-party solver (e.g. PETSc), not MOOSE itself.

• print_linear_residualsTrueEnable printing of linear residuals to the screen (Console)

  Default:True

  C++ Type:bool

  Controllable:No

  Description:Enable printing of linear residuals to the screen (Console)

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

  Default:False

  C++ Type:bool

  Controllable:No

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

• print_nonlinear_converged_reasonTrueEnable/disable printing of the nonlinear solver convergence reason to the screen. This parameter only affects the output of the third-party solver (e.g. PETSc), not MOOSE itself.

  Default:True

  C++ Type:bool

  Controllable:No

  Description:Enable/disable printing of the nonlinear solver convergence reason to the screen. This parameter only affects the output of the third-party solver (e.g. PETSc), not MOOSE itself.

• print_nonlinear_residualsTrueEnable printing of nonlinear residuals to the screen (Console)

  Default:True

  C++ Type:bool

  Controllable:No

  Description:Enable printing of nonlinear residuals to the screen (Console)

• progressFalsePrint a progress bar

  Default:False

  C++ Type:bool

  Controllable:No

  Description:Print a progress bar

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

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

• solution_historyFalsePrint a solution history file (.slh) using the default settings

  Default:False

  C++ Type:bool

  Controllable:No

  Description:Print a solution history file (.slh) using the default settings

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

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

  Controllable:No

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

• tecplotFalseOutput the results using the default settings for Tecplot output

  Default:False

  C++ Type:bool

  Controllable:No

  Description:Output the results using the default settings for Tecplot output

• time_step_interval1The interval (number of time steps) at which output occurs

  Default:1

  C++ Type:unsigned int

  Controllable:No

  Description:The interval (number of time steps) at which output occurs

• vtkFalseOutput the results using the default settings for VTKOutput output

  Default:False

  C++ Type:bool

  Controllable:No

  Description:Output the results using the default settings for VTKOutput output

• xdaFalseOutput the results using the default settings for XDA/XDR output (ascii)

  Default:False

  C++ Type:bool

  Controllable:No

  Description:Output the results using the default settings for XDA/XDR output (ascii)

• xdrFalseOutput the results using the default settings for XDA/XDR output (binary)

  Default:False

  C++ Type:bool

  Controllable:No

  Description:Output the results using the default settings for XDA/XDR output (binary)

• xmlFalseOutput the vector postprocessors to a *.xml file using the default XML output.

  Default:False

  C++ Type:bool

  Controllable:No

  Description:Output the vector postprocessors to a *.xml file using the default XML output.