CommonOutputAction

under construction:Undocumented Class

The CommonOutputAction has not been documented. The content contained on this page includes the typical automatic documentation associated with an Action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

!syntax description /Outputs/CommonOutputAction

Input Parameters

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

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

    Default:True

    C++ Type:bool

    Options:

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

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

    C++ Type:std::string

    Options:

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

  • tecplotFalseOutput the results using the default settings for Tecplot output

    Default:False

    C++ Type:bool

    Options:

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

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

    Default:__all__

    C++ Type:std::vector

    Options:

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

  • inactiveIf specified blocks matching these identifiers will be skipped.

    C++ Type:std::vector

    Options:

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

  • 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

    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.

  • nemesisFalseOutput the results using the default settings for Nemesis output

    Default:False

    C++ Type:bool

    Options:

    Description:Output the results using the default settings for Nemesis 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

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

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

    Default:False

    C++ Type:bool

    Options:

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

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

    Default:False

    C++ Type:bool

    Options:

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

  • vtkFalseOutput the results using the default settings for VTKOutput output

    Default:False

    C++ Type:bool

    Options:

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

  • controlsFalseEnable the screen output of Control systems.

    Default:False

    C++ Type:bool

    Options:

    Description:Enable the screen output of Control systems.

  • checkpointFalseCreate checkpoint files using the default options.

    Default:False

    C++ Type:bool

    Options:

    Description:Create checkpoint files using the default options.

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

    Default:False

    C++ Type:bool

    Options:

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

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

    Default:True

    C++ Type:bool

    Options:

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

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

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

    Default:False

    C++ Type:bool

    Options:

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

  • gmvFalseOutput the results using the default settings for GMV output

    Default:False

    C++ Type:bool

    Options:

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

  • exodusFalseOutput the results using the default settings for Exodus output

    Default:False

    C++ Type:bool

    Options:

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

  • 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_baseCommon file base name to be utilized with all output objects

    C++ Type:std::string

    Options:

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

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

    Default:False

    C++ Type:bool

    Options:

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

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

    Default:False

    C++ Type:bool

    Options:

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

  • consoleTrueOutput the results using the default settings for Console output

    Default:True

    C++ Type:bool

    Options:

    Description:Output the results using the default settings for Console 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

    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.

  • interval1The interval at which timesteps are output to the solution file

    Default:1

    C++ Type:unsigned int

    Options:

    Description:The interval at which timesteps 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

  • dofmapFalseCreate the dof map .json output file

    Default:False

    C++ Type:bool

    Options:

    Description:Create the dof map .json output file

Optional Parameters

References