Classes | Functions
BoundaryRestrictableRequired.h File Reference

Go to the source code of this file.


class  BoundaryRestrictableRequired
 A class for requiring an object to be boundary restricted. More...


InputParameters validParams< BoundaryRestrictableRequired > ()

Function Documentation

Definition at line 21 of file BoundaryRestrictableRequired.C.

Referenced by validParams< BoundaryCondition >(), and validParams< SideUserObject >().

22 {
23  // Create instance of InputParameters
26  // Create user-facing 'boundary' input for restricting inheriting object to boundaries
27  params.addRequiredParam<std::vector<BoundaryName>>(
28  "boundary", "The list of boundary IDs from the mesh where this boundary condition applies");
30  // A parameter for disabling error message for objects restrictable by boundary and block,
31  // if the parameter is valid it was already set so don't do anything
32  if (!params.isParamValid("_dual_restrictable"))
33  params.addPrivateParam<bool>("_dual_restrictable", false);
35  return params;
36 }
void addPrivateParam(const std::string &name, const T &value)
These method add a parameter to the InputParameters object which can be retrieved like any other para...
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 emptyInputParameters()
bool isParamValid(const std::string &name) const
This method returns parameters that have been initialized in one fashion or another, i.e.