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

Go to the source code of this file.

Classes

class  Control
 Base class for Control objects. More...
 

Functions

template<>
InputParameters validParams< Control > ()
 

Function Documentation

template<>
InputParameters validParams< Control > ( )

Definition at line 20 of file Control.C.

Referenced by validParams< RealFunctionControl >(), and validParams< TimePeriod >().

21 {
24  params += validParams<SetupInterface>();
26  params.registerBase("Control");
27 
28  params.set<MultiMooseEnum>("execute_on") = Control::getExecuteOptions();
29  params.addParam<std::vector<std::string>>(
30  "depends_on",
31  "The Controls that this control relies upon (i.e. must execute before this one)");
32 
33  return params;
34 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters validParams< SetupInterface >()
InputParameters validParams< FunctionInterface >()
void registerBase(const std::string &value)
This method must be called from every base "Moose System" to create linkage with the Action System...
InputParameters validParams< MooseObject >()
Definition: MooseObject.C:22
static MultiMooseEnum getExecuteOptions()
Return the valid "execute_on" options for Control objects.
Definition: Control.C:51
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
InputParameters validParams< TransientInterface >()