CSV

Output for postprocessors, vector postprocessors, and scalar variables using comma seperated values (CSV).

Overview

The CSV output object creates files containing comma separated values. Unless disabled (see [syntax/Outputs/index.md) all postprocessors and scalar variables will be written to a single file that includes a time column.

If vector postprocessors exist within the simulation an additional set of files will be created, there will be one file for every vector that exists within a VectorPostprocessor object for each timestep.

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.
alignFalseAlign the outputted csv data by padding the numbers with trailing whitespace
Default:False
C++ Type:bool
Options:
Description:Align the outputted csv data by padding the numbers with trailing whitespace
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).
append_restartFalseAppend existing file on restart
Default:False
C++ Type:bool
Options:
Description:Append existing file on restart
create_final_symlinkFalseEnable/disable the creation of a _FINAL symlink for vector postprocessor data with 'execute_on' includes 'FINAL'.
Default:False
C++ Type:bool
Options:
Description:Enable/disable the creation of a _FINAL symlink for vector postprocessor data with 'execute_on' includes 'FINAL'.
create_latest_symlinkFalseEnable/disable the creation of a _LATEST symlink for vector postprocessor data.
Default:False
C++ Type:bool
Options:
Description:Enable/disable the creation of a _LATEST symlink for vector postprocessor data.
delimiter,Assign the delimiter (default is ','
Default:,
C++ Type:std::string
Options:
Description:Assign the delimiter (default is ','
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.
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.
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
postprocessors_as_reportersFalseOutput Postprocessors values as Reporter values.
Default:False
C++ Type:bool
Options:
Description:Output Postprocessors values as Reporter values.
precision14Set the output precision
Default:14
C++ Type:unsigned int
Options:
Description:Set the output precision
sort_columnsFalseToggle the sorting of columns alphabetically.
Default:False
C++ Type:bool
Options:
Description:Toggle the sorting of columns alphabetically.
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
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
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.
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
vectorpostprocessors_as_reportersFalseOutput VectorsPostprocessors vectors as Reporter values.
Default:False
C++ Type:bool
Options:
Description:Output VectorsPostprocessors vectors as Reporter values.

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
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<std::string>
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

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

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_reporters_onControl of when Reporter values are output
C++ Type:ExecFlagEnum
Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, FAILED, CUSTOM
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, FINAL, FAILED, CUSTOM
Description:Control the output of scalar variables
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<VariableName>
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<VariableName>
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

Overview
Input Parameters