www.mooseframework.org
Functions
MaterialStdVectorRealGradientAux.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< MaterialStdVectorRealGradientAux > ()
 

Function Documentation

Definition at line 19 of file MaterialStdVectorRealGradientAux.C.

20 {
21  InputParameters params = validParams<MaterialStdVectorAuxBase<>>();
22  params.addClassDescription("Extracts a component of a material's std::vector<RealGradient> to an "
23  "aux variable. If the std::vector is not of sufficient size then "
24  "zero is returned");
25  params.addParam<unsigned int>(
26  "component", 0, "The gradient component to be extracted for this kernel");
27  return params;
28 }
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...