www.mooseframework.org
Functions
SolutionAux.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< SolutionAux > ()
 

Function Documentation

Definition at line 21 of file SolutionAux.C.

22 {
24  params.addClassDescription("Creates fields by using information from a SolutionUserObject.");
25  params.addRequiredParam<UserObjectName>("solution", "The name of the SolutionUserObject");
26  params.addParam<std::string>("from_variable",
27  "The name of the variable to extract from the file");
28 
29  params.addParam<bool>(
30  "direct",
31  false,
32  "If true the meshes must be the same and then the values are simply copied over.");
33  params.addParam<Real>(
34  "scale_factor",
35  1.0,
36  "Scale factor (a) to be applied to the solution (x): ax+b, where b is the 'add_factor'");
37  params.addParam<Real>(
38  "add_factor",
39  0.0,
40  "Add this value (b) to the solution (x): ax+b, where a is the 'scale_factor'");
41  return params;
42 }
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< AuxKernel >()
Definition: AuxKernel.C:30
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...
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...