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

Go to the source code of this file.

Classes

class  FunctionParserBase< T >
 
class  InputParameters
 The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system. More...
 
struct  InputParameters::Metadata
 

Functions

template<class T >
InputParameters validParams ()
 This is the templated validParams() function that every MooseObject-derived class is required to specialize. More...
 
template<>
void InputParameters::addRequiredParam< std::vector< MooseEnum > > (const std::string &name, const std::vector< MooseEnum > &moose_enums, const std::string &doc_string)
 
template<>
void InputParameters::addParam< std::vector< MooseEnum > > (const std::string &, const std::string &)
 
template<>
void InputParameters::addDeprecatedParam< std::vector< MooseEnum > > (const std::string &name, const std::string &doc_string, const std::string &deprecation_message)
 
InputParameters emptyInputParameters ()
 

Function Documentation

◆ emptyInputParameters()

InputParameters emptyInputParameters ( )

Definition at line 24 of file InputParameters.C.

Referenced by OversampleOutput::cloneMesh(), AdvancedOutput::enableOutputTypes(), Moose::PetscSupport::getPetscValidParams(), Moose::SlepcSupport::getSlepcEigenProblemValidParams(), NearestPointBase< LayeredSideAverage, SideIntegralVariableUserObject >::NearestPointBase(), ShapeUserObject< SideUserObject >::validParams(), validParams< Action >(), validParams< BlockRestrictable >(), validParams< BoundaryRestrictable >(), validParams< BoundaryRestrictableRequired >(), validParams< DistributionInterface >(), validParams< FEProblemSolve >(), validParams< FileRangeBuilder >(), validParams< FunctionInterface >(), validParams< FunctionParserUtils >(), validParams< ImageSampler >(), validParams< LayeredBase >(), validParams< MaterialPropertyInterface >(), validParams< MeshBaseImageSampler >(), validParams< MeshChangedInterface >(), validParams< MooseApp >(), validParams< MooseObject >(), validParams< MooseParsedFunctionBase >(), validParams< OrientedBoxInterface >(), validParams< OutputInterface >(), validParams< ParsedMaterialBase >(), validParams< PerfGraphInterface >(), validParams< PicardSolve >(), validParams< Problem >(), validParams< RandomInterface >(), validParams< SamplerBase >(), validParams< SamplerInterface >(), validParams< SetupInterface >(), validParams< TaggingInterface >(), and validParams< TransientInterface >().

25 {
26  InputParameters params;
27  return params;
28 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...

◆ InputParameters::addDeprecatedParam< std::vector< MooseEnum > >()

template<>
void InputParameters::addDeprecatedParam< std::vector< MooseEnum > > ( const std::string &  name,
const std::string &  doc_string,
const std::string &  deprecation_message 
)

Definition at line 914 of file InputParameters.C.

918 {
919  mooseError("You must supply a vector of MooseEnum object(s) and the deprecation string when "
920  "using addDeprecatedParam, even if the parameter is not required!");
921 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:207

◆ InputParameters::addParam< std::vector< MooseEnum > >()

template<>
void InputParameters::addParam< std::vector< MooseEnum > > ( const std::string &  ,
const std::string &   
)

Definition at line 869 of file InputParameters.C.

871 {
872  mooseError("You must supply a vector of MooseEnum object(s) when using addParam, even if the "
873  "parameter is not required!");
874 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:207

◆ InputParameters::addRequiredParam< std::vector< MooseEnum > >()

template<>
void InputParameters::addRequiredParam< std::vector< MooseEnum > > ( const std::string &  name,
const std::vector< MooseEnum > &  moose_enums,
const std::string &  doc_string 
)

Definition at line 838 of file InputParameters.C.

842 {
843  InputParameters::set<std::vector<MooseEnum>>(name) =
844  moose_enums; // valid parameter is set by set_attributes
845  _params[name]._required = true;
846  _params[name]._doc_string = doc_string;
847 }

◆ validParams()

template<class T >
InputParameters validParams ( )

This is the templated validParams() function that every MooseObject-derived class is required to specialize.

Definition at line 1469 of file InputParameters.h.

1470 {
1471  static_assert(false && sizeof(T), "Missing validParams declaration!");
1472 
1473  mooseError("Missing validParams declaration!");
1474 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:207