www.mooseframework.org
Functions
NodalVariableValue.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< NodalVariableValue > ()
 

Function Documentation

Definition at line 26 of file NodalVariableValue.C.

27 {
29  params.addRequiredParam<VariableName>("variable", "The variable to be monitored");
30  params.addRequiredParam<unsigned int>("nodeid", "The ID of the node where we monitor");
31  params.addParam<Real>("scale_factor", 1, "A scale factor to be applied to the variable");
32  params.addClassDescription("Outputs values of a nodal variable at a particular location");
33  return params;
34 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters validParams< GeneralPostprocessor >()
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...
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...