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

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

    Default:False

    C++ Type:bool

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

  • discontinuousFalseEnables discontinuous output format for Exodus files.

    Default:False

    C++ Type:bool

    Description:Enables discontinuous output format for Exodus files.

  • 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

    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

    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.

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

    Default:False

    C++ Type:bool

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

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

    Default:False

    C++ Type:bool

    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

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

  • file_baseThe desired solution output name without an extension

    C++ Type:std::string

    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

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

  • 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

    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_nonlinearFalseSpecifies whether output occurs on each nonlinear residual evaluation

    Default:False

    C++ Type:bool

    Description:Specifies whether output occurs on each nonlinear residual evaluation

  • end_stepTime step at which this output object stop operating

    C++ Type:int

    Description:Time step at which this output object stop operating

  • output_linearFalseSpecifies whether output occurs on each linear residual evaluation

    Default:False

    C++ Type:bool

    Description:Specifies whether output occurs on each linear residual evaluation

Optional Parameters

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

    Default:3

    C++ Type:unsigned int

    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

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

  • output_dimensiondefaultThe dimension of the output file

    Default:default

    C++ Type:MooseEnum

    Description:The dimension of the output file

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Description:Set the enabled status of the MooseObject.

  • 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

    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

  • scalar_as_nodalFalseOutput scalar variables as nodal

    Default:False

    C++ Type:bool

    Description:Output scalar variables as nodal

  • execute_postprocessors_onControl of when postprocessors are output

    C++ Type:ExecFlagEnum

    Description:Control of when postprocessors are 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

    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_input_onINITIALEnable/disable the output of the input file

    Default:INITIAL

    C++ Type:ExecFlagEnum

    Description:Enable/disable the output of the input file

  • execute_scalars_onControl the output of scalar variables

    C++ Type:ExecFlagEnum

    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

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

  • elemental_as_nodalFalseOutput elemental nonlinear variables as nodal

    Default:False

    C++ Type:bool

    Description:Output elemental nonlinear variables as nodal

  • execute_nodal_onControl the output of nodal variables

    C++ Type:ExecFlagEnum

    Description:Control the output of nodal variables

  • execute_elemental_onControl the output of elemental variables

    C++ Type:ExecFlagEnum

    Description:Control the output of elemental variables

Variables Parameters

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

    Default:1e-14

    C++ Type:double

    Description:Time tolerance utilized checking start and end times

  • start_timeTime at which this output object begins to operate

    C++ Type:double

    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

    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

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

  • end_timeTime at which this output object stop operating

    C++ Type:double

    Description:Time at which this output object stop operating

  • sync_onlyFalseOnly export results at sync times

    Default:False

    C++ Type:bool

    Description:Only export results at sync times

Timing Parameters

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

    C++ Type:libMesh::Point

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

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

    C++ Type:MeshFileName

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

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

    Default:0

    C++ Type:unsigned int

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

Oversampling Parameters

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

    C++ Type:double

    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

    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

    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

    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

    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

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

Petsc Parameters

  • output_material_propertiesFalseFlag indicating if material properties should be output

    Default:False

    C++ Type:bool

    Description:Flag indicating if material properties should be output

  • show_material_propertiesList of materialproperties that should be written to the output

    C++ Type:std::vector

    Description:List of materialproperties that should be written to the output

Materials Parameters