VTK

Output data using the Visualization Toolkit (VTK).

Overview

The VTK output write variable, postprocessor, and scalar variable information using the Visualization Toolkit format. To use this object libMesh must be configured with the --enable-vtk option.

Input Parameters

  • 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

    Options:

    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.

Required 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, 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.

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

  • 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

    Options:

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

  • end_stepTime step at which this output object stop operating

    C++ Type:int

    Options:

    Description:Time step at which this output object stop operating

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

  • 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

  • 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

  • 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

  • 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

Optional Parameters

  • binaryFalseSet VTK files to output in binary format

    Default:False

    C++ Type:bool

    Options:

    Description:Set VTK files to output in binary format

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

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    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

    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.

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

    Default:3

    C++ Type:unsigned int

    Options:

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

Advanced Parameters

  • end_timeTime at which this output object stop operating

    C++ Type:double

    Options:

    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

    Options:

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

  • start_timeTime at which this output object begins to operate

    C++ Type:double

    Options:

    Description:Time at which this output object begins to operate

  • sync_onlyFalseOnly export results at sync times

    Default:False

    C++ Type:bool

    Options:

    Description:Only export results at sync times

  • 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

  • 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

Timing Parameters

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

    C++ Type:MeshFileName

    Options:

    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

    Options:

    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

    Options:

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

Oversampling Parameters

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

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

Variables Parameters

  • 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

  • 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

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

  • 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

  • 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

Petsc Parameters