MaterialStdVectorAux.C File Reference

Go to the source code of this file.


InputParameters validParams< MaterialStdVectorAux > ()

Function Documentation

Definition at line 19 of file MaterialStdVectorAux.C.

20 {
21  InputParameters params = validParams<MaterialStdVectorAuxBase<>>();
22  params.addClassDescription("Extracts a component of a material type std::vector<Real> to an aux "
23  "variable. If the std::vector is not of sufficient size then zero is "
24  "returned");
25  params.addParam<unsigned int>(
26  "selected_qp",
27  "Evaluate the std::vector<Real> at this quadpoint. This only needs to be "
28  "used if you are interested in a particular quadpoint in each element: "
29  "otherwise do not include this parameter in your input file");
30  params.addParamNamesToGroup("selected_qp", "Advanced");
31  return params;
32 }
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...
void addParamNamesToGroup(const std::string &space_delim_names, const std::string group_name)
This method takes a space delimited list of parameter names and adds them to the specified group name...