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

Go to the source code of this file.

Classes

class  SetupInterface
 

Functions

template<typename T >
InputParameters validParams ()
 
template<>
InputParameters validParams< SetupInterface > ()
 

Function Documentation

template<typename T >
InputParameters validParams ( )

Definition at line 21 of file SetupInterface.C.

Referenced by validParams< AuxKernel >(), validParams< AuxScalarKernel >(), validParams< Constraint >(), validParams< Control >(), validParams< MultiApp >(), validParams< Sampler >(), validParams< Transfer >(), and validParams< UserObject >().

22 {
24 
25  // Get an MooseEnum of the available 'execute_on' options
27 
28  // Add the 'execute_on' input parameter for users to set
29  params.addParam<MultiMooseEnum>("execute_on",
30  execute_options,
31  "Set to (nonlinear|linear|timestep_end|timestep_begin|custom) "
32  "to execute only at that moment");
33 
34  // The Output system uses different options for the 'execute_on' than other systems, therefore the
35  // check of the options
36  // cannot occur based on the 'execute_on' parameter, so this flag triggers the check
37  params.addPrivateParam<bool>("check_execute_on", true);
38 
39  return params;
40 }
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...
InputParameters emptyInputParameters()
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.