www.mooseframework.org
Functions
BoundaryRestrictable.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< BoundaryRestrictable > ()
 

Function Documentation

Definition at line 23 of file BoundaryRestrictable.C.

Referenced by validParams< AutoPositionsMultiApp >(), validParams< AuxKernel >(), validParams< DGKernel >(), validParams< InitialCondition >(), validParams< InterfaceKernel >(), validParams< Material >(), validParams< NodalKernel >(), and validParams< NodalUserObject >().

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