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

Go to the source code of this file.

Classes

class  RealFunctionControl
 A basic control for changing an input parameter using a Function. More...
 

Functions

template<>
InputParameters validParams< RealFunctionControl > ()
 

Function Documentation

Definition at line 21 of file RealFunctionControl.C.

22 {
24  params.addClassDescription(
25  "Sets the value of a 'Real' input parameters to the value of a provided function.");
26  params.addRequiredParam<FunctionName>(
27  "function", "The function to use for controlling the specified parameter.");
28  params.addRequiredParam<std::string>(
29  "parameter",
30  "The input parameter(s) to control. Specify a single parameter name and all "
31  "parameters in all objects matching the name will be updated");
32  return params;
33 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
void addRequiredParam(const std::string &name, const std::string &doc_string)
This method adds a parameter and documentation string to the InputParameters object that will be extr...
InputParameters validParams< Control >()
Definition: Control.C:20
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...