www.mooseframework.org
Functions
SolutionFunction.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< SolutionFunction > ()
 

Function Documentation

Definition at line 22 of file SolutionFunction.C.

23 {
24  // Get the Function input parameters
26 
27  // Add required parameters
28  params.addRequiredParam<UserObjectName>("solution",
29  "The SolutionUserObject to extract data from.");
30  params.addParam<std::string>("from_variable",
31  "The name of the variable in the file that is to be extracted");
32 
33  // Add optional paramters
34  params.addParam<Real>(
35  "scale_factor",
36  1.0,
37  "Scale factor (a) to be applied to the solution (x): ax+b, where b is the 'add_factor'");
38  params.addParam<Real>(
39  "add_factor",
40  0.0,
41  "Add this value (b) to the solution (x): ax+b, where a is the 'scale_factor'");
42 
43  // Return the parameters object
44  return params;
45 }
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...
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...
InputParameters validParams< Function >()
Definition: Function.C:19