Exodus

Object for output data in the Exodus II format

Overview

The Exodus output object is the preferred way to write out simulation results. It creates ExodusII formatted files that are easily read by Peacock, Paraview, Visit and other postprocessing applications.

ExodusII has many benefits over other formats. It is a binary format based on NetCDF so the files are compact. It also can store multiple timesteps worth of information within one file, reducing output file clutter and storage for simulation results. Only if the mesh changes (adaptivity, movement if outputting the displaced mesh) will a new file need to be written.

Most of the time to do Exodus output you can simply set exodus = true in your Outputs block. For more control you can add sub-block of Outputs and set type = Exodus. That gives you full access to the parameters described below.

Advanced Parameters

output_dimension

The output_dimension parameter allows you to override the default selection for the dimensionality of the output. This is normally not needed (MOOSE can usually figure out what the dimensionality should be), but there are special cases where you might want to set this option. In particular, if you are running a 2D simulation that is generating 3D displacement fields you will need to use output_dimension = 3 to force the dimension so that Peacock and Paraview can properly render those displacements.

Input Parameters

  • discontinuousFalseEnables discontinuous output format for Exodus files.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Enables discontinuous output format for Exodus files.

  • overwriteFalseWhen true the latest timestep will overwrite the existing file, so only a single timestep exists.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:When true the latest timestep will overwrite the existing file, so only a single timestep exists.

  • sequenceFalseEnable/disable sequential file output (enabled by default when 'use_displace = true', otherwise defaults to false

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Enable/disable sequential file output (enabled by default when 'use_displace = true', otherwise defaults to false

  • side_discontinuousFalseEnables adding side-discontinuous output in Exodus files.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Enables adding side-discontinuous output in Exodus files.

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

    Default:False

    C++ Type:bool

    Controllable:No

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

  • write_hdf5FalseEnables HDF5 output format for Exodus files.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Enables HDF5 output format for Exodus files.

Optional Parameters

  • 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, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, FAILED, CUSTOM, ALWAYS.

    C++ Type:ExecFlagEnum

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

    Controllable:No

    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, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, FAILED, CUSTOM, ALWAYS.

  • 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, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, FAILED, CUSTOM, ALWAYS.

    Default:INITIAL TIMESTEP_END

    C++ Type:ExecFlagEnum

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

    Controllable:No

    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, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, FAILED, CUSTOM, ALWAYS.

  • output_linearFalseSpecifies whether output occurs on each PETSc linear residual evaluation

    Default:False

    C++ Type:bool

    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

    Controllable:No

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

Execution Scheduling Parameters

  • 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, if not given UTC format is used (see http://www.cplusplus.com/reference/ctime/strftime).

    C++ Type:std::string

    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

    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>

    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.

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

    Default:3

    C++ Type:unsigned int

    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>

    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

    Controllable:Yes

    Description:Set the enabled status of the MooseObject.

  • output_dimensiondefaultThe dimension of the output file

    Default:default

    C++ Type:MooseEnum

    Options:default, 1, 2, 3, problem_dimension

    Controllable:No

    Description:The dimension of the output file

Advanced Parameters

  • elemental_as_nodalFalseOutput elemental nonlinear variables as nodal

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Output elemental nonlinear variables as nodal

  • postprocessors_as_reportersFalseOutput Postprocessors values as Reporter values.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Output Postprocessors values as Reporter values.

  • scalar_as_nodalFalseOutput scalar variables as nodal

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Output scalar variables as nodal

  • vectorpostprocessors_as_reportersFalseOutput VectorsPostprocessors vectors as Reporter values.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Output VectorsPostprocessors vectors as Reporter values.

Conversions Before Output Parameters

  • end_stepTime step at which this output object stop operating

    C++ Type:int

    Controllable:No

    Description:Time step at which this output object stop operating

  • end_timeTime at which this output object stop operating

    C++ Type:double

    Controllable:No

    Description:Time at which this output object stop operating

  • interval1The interval at which time steps are output to the solution file

    Default:1

    C++ Type:unsigned int

    Controllable:No

    Description:The interval at which time steps are output to the solution file

  • minimum_time_interval0The minimum simulation time between output steps

    Default:0

    C++ Type:double

    Controllable:No

    Description:The minimum simulation time between output steps

  • start_stepTime step at which this output object begins to operate

    C++ Type:int

    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

    Controllable:No

    Description:Time at which this output object begins to operate

  • sync_onlyFalseOnly export results at sync times

    Default:False

    C++ Type:bool

    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>

    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

    Controllable:No

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

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

    Default:1e-14

    C++ Type:double

    Controllable:No

    Description:Time tolerance utilized checking start and end times

Timing And Frequency Of Output Parameters

  • execute_elemental_onControl the output of elemental variables

    C++ Type:ExecFlagEnum

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

    Controllable:No

    Description:Control the output of elemental variables

  • execute_input_onINITIALEnable/disable the output of the input file

    Default:INITIAL

    C++ Type:ExecFlagEnum

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

    Controllable:No

    Description:Enable/disable the output of the input file

  • execute_nodal_onControl the output of nodal variables

    C++ Type:ExecFlagEnum

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

    Controllable:No

    Description:Control the output of nodal variables

  • execute_postprocessors_onControl of when postprocessors are output

    C++ Type:ExecFlagEnum

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

    Controllable:No

    Description:Control of when postprocessors are output

  • execute_reporters_onControl of when Reporter values are output

    C++ Type:ExecFlagEnum

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

    Controllable:No

    Description:Control of when Reporter values are output

  • execute_scalars_onControl the output of scalar variables

    C++ Type:ExecFlagEnum

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

    Controllable:No

    Description:Control the output of scalar variables

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

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

Selection/Restriction Of Output Parameters

  • extra_element_ids_to_outputList of extra element ids defined on the mesh that should be written to the output.

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

    Controllable:No

    Description:List of extra element ids defined on the mesh that should be written to the output.

  • output_extra_element_idsFalseFlag indicating if extra element ids defined on the mesh should be outputted

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Flag indicating if extra element ids defined on the mesh should be outputted

Mesh Parameters

  • fileThe name of the mesh file to read, for oversampling

    C++ Type:MeshFileName

    Controllable:No

    Description:The name of the mesh file to read, for oversampling

  • positionSet a positional offset, this vector will get added to the nodal coordinates to move the domain.

    C++ Type:libMesh::Point

    Controllable:No

    Description:Set a positional offset, this vector will get added to the nodal coordinates to move the domain.

  • refinements0Number of uniform refinements for oversampling (refinement levels beyond any uniform refinements)

    Default:0

    C++ Type:unsigned int

    Controllable:No

    Description:Number of uniform refinements for oversampling (refinement levels beyond any uniform refinements)

Oversampling Parameters

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

    Default:1000

    C++ Type:double

    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

    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

    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

    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

    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

    Controllable:No

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

Petsc Linear/Nonlinear Output Parameters

  • output_material_propertiesFalseFlag indicating if material properties should be output

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Flag indicating if material properties should be output

  • show_material_propertiesList of material properties that should be written to the output

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

    Controllable:No

    Description:List of material properties that should be written to the output

Materials Parameters