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

Go to the source code of this file.

Classes

class  LinearCombinationFunction
 Sum_over_i (w_i * functions_i) More...
 

Functions

template<>
InputParameters validParams< LinearCombinationFunction > ()
 

Function Documentation

Definition at line 19 of file LinearCombinationFunction.C.

20 {
22  params.addRequiredParam<std::vector<FunctionName>>(
23  "functions", "This function will return Sum_over_i(w_i * functions_i)");
24  params.addRequiredParam<std::vector<Real>>(
25  "w", "This function will return Sum_over_i(w_i * functions_i)");
26  params.addClassDescription("Returns the linear combination of the functions");
27  return params;
28 }
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 addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...
InputParameters validParams< Function >()
Definition: Function.C:19