NearestNodeValueAux.C File Reference

Go to the source code of this file.


InputParameters validParams< NearestNodeValueAux > ()

Function Documentation

Definition at line 22 of file NearestNodeValueAux.C.

23 {
25  params.addClassDescription("Retrieves a field value from the closest node on the paired boundary "
26  "and stores it on this boundary or block.");
27  params.set<bool>("_dual_restrictable") = true;
28  params.addRequiredParam<BoundaryName>("paired_boundary", "The boundary to get the value from.");
29  params.addRequiredCoupledVar("paired_variable", "The variable to get the value of.");
30  params.set<bool>("use_displaced_mesh") = true;
31  return params;
32 }
T & set(const std::string &name, bool quiet_mode=false)
Returns a writable reference to the named parameters.
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...
InputParameters validParams< AuxKernel >()
Definition: AuxKernel.C:30
void addRequiredCoupledVar(const std::string &name, const std::string &doc_string)
This method adds a coupled variable name pair.
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...