www.mooseframework.org
Classes | Functions
BlockRestrictable.h File Reference

Go to the source code of this file.

Classes

class  BlockRestrictable
 An interface that restricts an object to subdomains via the 'blocks' input parameter. More...
 

Functions

template<>
InputParameters validParams< BlockRestrictable > ()
 

Function Documentation

Definition at line 28 of file BlockRestrictable.C.

Referenced by validParams< AuxKernel >(), validParams< DGKernel >(), validParams< ElementUserObject >(), validParams< Indicator >(), validParams< InitialCondition >(), validParams< InternalSideUserObject >(), validParams< KernelBase >(), validParams< LineMaterialSamplerBase< Real > >(), validParams< Marker >(), validParams< Material >(), validParams< NodalKernel >(), and validParams< NodalUserObject >().

29 {
30  // Create InputParameters object that will be appended to the parameters for the inheriting object
32 
33  // Add the user-facing 'block' input parameter
34  params.addParam<std::vector<SubdomainName>>(
35  "block", "The list of block ids (SubdomainID) that this object will be applied");
36 
37  // A parameter for disabling error message for objects restrictable by boundary and block,
38  // if the parameter is valid it was already set so don't do anything
39  if (!params.isParamValid("_dual_restrictable"))
40  params.addPrivateParam<bool>("_dual_restrictable", false);
41 
42  // Return the parameters
43  return params;
44 }
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...