Gnuplot

under construction:Undocumented Class

The Gnuplot has not been documented, if you would like to contribute to MOOSE by writing documentation, please see Documenting MOOSE. The content contained on this page explains the typical documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

!syntax description /Outputs/Gnuplot

Input Parameters

  • 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

    Options:

    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

    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.

  • 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

  • new_row_tolerance1e-12The independent variable tolerance for determining when a new row should be added to the table (Note: This value must be set independently for Postprocessor output to type=Console and type=CSV file separately.

    Default:1e-12

    C++ Type:double

    Options:

    Description:The independent variable tolerance for determining when a new row should be added to the table (Note: This value must be set independently for Postprocessor output to type=Console and type=CSV file separately.

  • file_baseThe desired solution output name without an extension

    C++ Type:std::string

    Options:

    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

    Options:

    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

    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.

  • time_dataFalseWhen true and VecptorPostprocessor data exists, write a csv file containing the timestep and time information.

    Default:False

    C++ Type:bool

    Options:

    Description:When true and VecptorPostprocessor data exists, write a csv file containing the timestep and time information.

  • extensionpngGNU plot file extension

    Default:png

    C++ Type:MooseEnum

    Options:png ps gif

    Description:GNU plot file extension

  • time_columnTrueWhether or not the 'time' column should be written for Postprocessor CSV files

    Default:True

    C++ Type:bool

    Options:

    Description:Whether or not the 'time' column should be written for Postprocessor CSV files

  • end_stepTime step at which this output object stop operating

    C++ Type:int

    Options:

    Description:Time step at which this output object stop operating

  • 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

  • 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

  • append_restartFalseAppend existing file on restart

    Default:False

    C++ Type:bool

    Options:

    Description:Append existing file on restart

Optional Parameters

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

    Default:4

    C++ Type:unsigned int

    Options:

    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

    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.

Advanced Parameters

  • 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

  • start_timeTime at which this output object begins to operate

    C++ Type:double

    Options:

    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

    Options:

    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

    Options:

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

  • end_timeTime at which this output object stop operating

    C++ Type:double

    Options:

    Description:Time at which this output object stop operating

  • sync_onlyFalseOnly export results at sync times

    Default:False

    C++ Type:bool

    Options:

    Description:Only export results at sync times

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

  • execute_postprocessors_onControl of when postprocessors are output

    C++ Type:ExecFlagEnum

    Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL FAILED CUSTOM

    Description:Control of when postprocessors are output

  • execute_vector_postprocessors_onEnable/disable the output of VectorPostprocessors

    C++ Type:ExecFlagEnum

    Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL FAILED CUSTOM

    Description:Enable/disable the output of VectorPostprocessors

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

  • execute_scalars_onControl the output of scalar variables

    C++ Type:ExecFlagEnum

    Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL FAILED CUSTOM

    Description:Control the output of scalar variables

Variables Parameters

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

  • 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

  • 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

  • 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

  • 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

Petsc Parameters

Input Files

References