www.mooseframework.org
Classes | Functions
CommonOutputAction.h File Reference

Go to the source code of this file.

Classes

class  CommonOutputAction
 Meta-action for creating common output object parameters This action serves two purpose, first it adds common output object parameters. More...
 

Functions

template<>
InputParameters validParams< CommonOutputAction > ()
 

Function Documentation

Definition at line 34 of file CommonOutputAction.C.

35 {
37 
38  // Short-cut methods for typical output objects
39  params.addParam<bool>(
40  "exodus", false, "Output the results using the default settings for Exodus output");
41  params.addParam<bool>(
42  "nemesis", false, "Output the results using the default settings for Nemesis output");
43  params.addParam<bool>(
44  "console", true, "Output the results using the default settings for Console output");
45  params.addParam<bool>("csv",
46  false,
47  "Output the scalar variable and postprocessors to a *.csv "
48  "file using the default CSV output.");
49  params.addParam<bool>(
50  "vtk", false, "Output the results using the default settings for VTKOutput output");
51  params.addParam<bool>(
52  "xda", false, "Output the results using the default settings for XDA/XDR output (ascii)");
53  params.addParam<bool>(
54  "xdr", false, "Output the results using the default settings for XDA/XDR output (binary)");
55  params.addParam<bool>("checkpoint", false, "Create checkpoint files using the default options.");
56  params.addParam<bool>(
57  "gmv", false, "Output the results using the default settings for GMV output");
58  params.addParam<bool>(
59  "tecplot", false, "Output the results using the default settings for Tecplot output");
60  params.addParam<bool>(
61  "gnuplot",
62  false,
63  "Output the scalar and postprocessor results using the default settings for GNUPlot output");
64  params.addParam<bool>(
65  "solution_history", false, "Print a solution history file (.slh) using the default settings");
66  params.addParam<bool>("dofmap", false, "Create the dof map .json output file");
67  params.addParam<bool>("controls", false, "Enable the screen output of Control systems.");
68 
69  // Common parameters
70 
71  // Note: Be sure that objects that share these parameters utilize the same defaults
72  params.addParam<bool>("color", true, "Set to false to turn off all coloring in all outputs");
73  params.addParam<std::string>("file_base",
74  "Common file base name to be utilized with all output objects");
75  params.addParam<std::vector<std::string>>("output_if_base_contains",
76  "If this is supplied then output will only be done in "
77  "the case that the output base contains one of these "
78  "strings. This is helpful in outputting only a subset "
79  "of outputs when using MultiApps.");
80  params.addParam<unsigned int>(
81  "interval", 1, "The interval at which timesteps are output to the solution file");
82  params.addParam<std::vector<Real>>("sync_times",
83  std::vector<Real>(),
84  "Times at which the output and solution is forced to occur");
85  params.addParam<bool>(
86  "append_date", false, "When true the date and time are appended to the output filename.");
87  params.addParam<std::string>("append_date_format",
88  "The format of the date/time to append (see "
89  "http://www.cplusplus.com/reference/ctime/"
90  "strftime).");
91 
92  params.addParam<std::vector<VariableName>>(
93  "hide",
94  "A list of the variables and postprocessors that should NOT be output to the Exodus "
95  "file (may include Variables, ScalarVariables, and Postprocessor names).");
96  params.addParam<std::vector<VariableName>>(
97  "show",
98  "A list of the variables and postprocessors that should be output to the Exodus file "
99  "(may include Variables, ScalarVariables, and Postprocessor names).");
100 
101  // Add the 'execute_on' input parameter
102  params.addParam<MultiMooseEnum>(
103  "execute_on",
104  Output::getExecuteOptions("initial timestep_end"),
105  "Set to (initial|linear|nonlinear|timestep_end|timestep_begin|final|failed|custom) to "
106  "execute only at that moment (default: 'initial timestep_end')");
107 
108  // Add special Console flags
109  params.addParam<bool>(
110  "print_perf_log", false, "Enable printing of the performance log to the screen (Console)");
111  params.addParam<bool>("print_mesh_changed_info",
112  false,
113  "When true, each time the mesh is changed the mesh information is printed");
114  params.addParam<bool>("print_linear_residuals",
115  true,
116  "Enable printing of linear residuals to the screen (Console)");
117 
118  // Return object
119  return params;
120 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an option parameter and a documentation string to the InputParameters object...
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
static MultiMooseEnum getExecuteOptions()
Returns the available options for the &#39;execute_on&#39; input parameters.
InputParameters validParams< Action >()
Definition: Action.C:23