CompositeFunction.C File Reference

Go to the source code of this file.


InputParameters validParams< CompositeFunction > ()

Function Documentation

Definition at line 19 of file CompositeFunction.C.

20 {
22  params.addParam<std::vector<FunctionName>>("functions",
23  "The functions to be multiplied together.");
24  params.addParam<Real>("scale_factor", 1.0, "Scale factor to be applied to the ordinate values");
25  params.addClassDescription("Multiplies an arbitrary set of functions together");
26  return params;
27 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
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...
InputParameters validParams< Function >()
Definition: Function.C:19