Classes | Namespaces | Functions
Output.h File Reference

Go to the source code of this file.


class  Output
 Based class for output objects. More...


 The following methods are specializations for using the libMesh::Parallel::packed_range_* routines for std::strings.


InputParameters validParams< Output > ()

Function Documentation

InputParameters validParams< Output > ( )

Definition at line 34 of file Output.C.

Referenced by validParams< ControlOutput >(), validParams< MaterialPropertyDebugOutput >(), and validParams< PetscOutput >().

35 {
36  // Get the parameters from the parent object
39  // Displaced Mesh options
40  params.addParam<bool>(
41  "use_displaced", false, "Enable/disable the use of the displaced mesh for outputting");
43  // Output intervals and timing
44  params.addParam<unsigned int>(
45  "interval", 1, "The interval at which time steps are output to the solution file");
46  params.addParam<std::vector<Real>>("sync_times",
47  "Times at which the output and solution is forced to occur");
48  params.addParam<bool>("sync_only", false, "Only export results at sync times");
49  params.addParam<Real>("start_time", "Time at which this output object begins to operate");
50  params.addParam<Real>("end_time", "Time at which this output object stop operating");
51  params.addParam<Real>(
52  "time_tolerance", 1e-14, "Time tolerance utilized checking start and end times");
54  // Add the 'execute_on' input parameter for users to set
55  params.addParam<MultiMooseEnum>("execute_on",
56  Output::getExecuteOptions("initial timestep_end"),
57  "Set to "
58  "(none|initial|linear|nonlinear|timestep_end|timestep_begin|"
59  "final|failed|custom) to execute only at that moment");
61  // Add ability to append to the 'execute_on' list
62  params.addParam<MultiMooseEnum>("additional_execute_on",
64  "This list of output flags is added to the existing flags "
65  "(initial|linear|nonlinear|timestep_end|timestep_begin|final|"
66  "failed|custom) to execute only at that moment");
68  // 'Timing' group
69  params.addParamNamesToGroup("time_tolerance interval sync_times sync_only start_time end_time ",
70  "Timing");
72  // Add a private parameter for indicating if it was created with short-cut syntax
73  params.addPrivateParam<bool>("_built_by_moose", false);
75  // Register this class as base class
76  params.declareControllable("enable");
77  params.registerBase("Output");
79  return params;
80 }
void addPrivateParam(const std::string &name, const T &value)
These method add a parameter to the InputParameters object which can be retrieved like any other para...
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
void registerBase(const std::string &value)
This method must be called from every base "Moose System" to create linkage with the Action System...
void declareControllable(const std::string &name)
Declare the given parameters as controllable.
InputParameters validParams< MooseObject >()
Definition: MooseObject.C:22
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.
void addParamNamesToGroup(const std::string &space_delim_names, const std::string group_name)
This method takes a space delimited list of parameter names and adds them to the specified group name...