https://mooseframework.inl.gov
Classes | Namespaces | Functions | Variables
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::CommandLineMetadata
 Structure for storing information about a command line parameter. More...
 
class  InputParameters::SetHitNodeKey
 Class that is used as a parameter to setHitNode() that allows only relevant classes to set the hit node. More...
 
class  InputParameters::SetParamHitNodeKey
 Class that is used as a parameter to setHitNode(param) that allows only relevant classes to set the hit node. More...
 
struct  InputParameters::isValidCommandLineType< T >
 Determines whether or not the given type is a type that is supported for a command line parameter. More...
 
class  InputParameters::CommandLineParamSetKey
 Class that is used as a parameter to commandLineParamSet() that allows only the CommandLine to set that a parmeter is set by the command line. More...
 
struct  InputParameters::Metadata
 

Namespaces

 hit
 
 Moose
 MOOSE now contains C++17 code, so give a reasonable error message stating what the user can do to address this in their environment if C++17 compatibility isn't found.
 
 Moose::internal
 

Functions

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::addRequiredParam< std::vector< MultiMooseEnum > > (const std::string &name, const std::vector< MultiMooseEnum > &moose_enums, const std::string &doc_string)
 
template<>
void InputParameters::addParam< std::vector< MooseEnum > > (const std::string &, const std::string &)
 
template<>
void InputParameters::addParam< std::vector< MultiMooseEnum > > (const std::string &, const std::string &)
 
template<>
void InputParameters::addRequiredParam< std::vector< MultiMooseEnum > > (const std::string &, const std::string &)
 
template<>
void InputParameters::addDeprecatedParam< std::vector< MooseEnum > > (const std::string &, const std::string &, const std::string &)
 
InputParameters emptyInputParameters ()
 
template<typename T >
constexpr T * Moose::internal::getNullptrExample ()
 
template<typename T >
constexpr bool Moose::internal::isMFEMFunctorNameTypeHelper (T *)
 
template<typename T , typename A >
constexpr bool Moose::internal::isMFEMFunctorNameTypeHelper (std::vector< T, A > *)
 
template<typename T >
constexpr bool Moose::internal::isScalarFunctorNameTypeHelper (T *)
 
template<typename T , typename A >
constexpr bool Moose::internal::isScalarFunctorNameTypeHelper (std::vector< T, A > *)
 
template<typename T >
constexpr bool Moose::internal::isVectorFunctorNameTypeHelper (T *)
 
template<typename T , typename A >
constexpr bool Moose::internal::isVectorFunctorNameTypeHelper (std::vector< T, A > *)
 
template<typename T >
constexpr bool Moose::internal::isFunctorNameTypeHelper (T *ex)
 

Variables

class FunctionParserBase Action
 

Function Documentation

◆ emptyInputParameters()

InputParameters emptyInputParameters ( )

Definition at line 30 of file InputParameters.C.

Referenced by NEML2ModelExecutor::actionParams(), ConstantReporter::addReporterTypeParams(), Moose::FV::advectedInterpolationParameter(), Factory::clone(), CompositionDT::compositionDTParams(), AppFactory::createAppShared(), Moose::createMooseApp(), TransientBase::defaultSteadyStateConvergenceParams(), dummyParams(), AdvancedOutput::enableOutputTypes(), FEProblemSolve::feProblemDefaultConvergenceParams(), FixedPointSolve::fixedPointDefaultConvergenceParams(), MooseServer::gatherDocumentCompletionItems(), MooseServer::gatherDocumentDefinitionLocations(), PhysicsBase::getAdditionalRMParams(), MooseServer::getHoverDisplayText(), MooseServer::getNodesByValueAndTypes(), Moose::PetscSupport::getPetscValidParams(), MooseServer::getRequiredParamsText(), Moose::SlepcSupport::getSlepcEigenProblemValidParams(), ParsedMaterialBase::validParams(), MeshChangedInterface::validParams(), MeshDisplacedInterface::validParams(), FVDiffusionInterpolationInterface::validParams(), FVRelationshipManagerInterface::validParams(), MultiSystemSolveObject::validParams(), NonlinearSolveObject::validParams(), ReferenceResidualInterface::validParams(), FixedPointSolve::validParams(), VectorPostprocessorInterface::validParams(), ReporterInterface::validParams(), BoundaryRestrictableRequired::validParams(), MFEMBlockRestrictable::validParams(), MFEMBoundaryRestrictable::validParams(), GeometricSearchInterface::validParams(), ElementIDInterface::validParams(), UserObjectInterface::validParams(), NeighborCoupleableMooseVariableDependencyIntermediateInterface::validParams(), DistributionInterface::validParams(), SetupInterface::validParams(), ReporterTransferInterface::validParams(), InitialConditionInterface::validParams(), FunctorInterface::validParams(), MOOSEToNEML2::validParams(), SamplerInterface::validParams(), MooseObject::validParams(), ExecutorInterface::validParams(), TransientInterface::validParams(), FileRangeBuilder::validParams(), RandomInterface::validParams(), LayeredBase::validParams(), SamplerBase::validParams(), MortarConsumerInterface::validParams(), PostprocessorInterface::validParams(), DiffusionLHDGAssemblyHelper::validParams(), BoundaryRestrictable::validParams(), IPHDGAssemblyHelper::validParams(), OrientedBoxInterface::validParams(), ShapeUserObject< SideUserObject >::validParams(), MooseParsedFunctionBase::validParams(), OutputInterface::validParams(), NestedSolveTempl< is_ad >::validParams(), FunctionInterface::validParams(), Reporter::validParams(), TaggingInterface::validParams(), FunctionParserUtils< false >::validParams(), PerfGraphInterface::validParams(), BlockRestrictable::validParams(), Moose::Builder::validParams(), MaterialPropertyInterface::validParams(), MeshBaseImageSampler::validParams(), ImageSampler::validParams(), MooseAppCoordTransform::validParams(), and MooseApp::validParams().

31 {
32  InputParameters params;
33  return params;
34 }
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 &  ,
const std::string &  ,
const std::string &   
)

Definition at line 1354 of file InputParameters.C.

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

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

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

Definition at line 1291 of file InputParameters.C.

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

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

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

Definition at line 1300 of file InputParameters.C.

1302 {
1303  mooseError(
1304  "You must supply a vector of MultiMooseEnum object(s) when using addParam, even if the "
1305  "parameter is not required!");
1306 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302

◆ 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 1238 of file InputParameters.C.

1242 {
1243  InputParameters::set<std::vector<MooseEnum>>(name) =
1244  moose_enums; // valid parameter is set by set_attributes
1245  auto & metadata = _params[name];
1246  metadata._required = true;
1247  metadata._doc_string = doc_string;
1248 }
std::string name(const ElemQuality q)

◆ InputParameters::addRequiredParam< std::vector< MultiMooseEnum > >() [1/2]

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

Definition at line 1252 of file InputParameters.C.

1256 {
1257  mooseAssert(
1258  moose_enums.size() == 1,
1259  "Only 1 MultiMooseEnum is supported in addRequiredParam<std::vector<MultiMooseEnum>> for " +
1260  name);
1261  mooseAssert(!moose_enums[0].items().empty(),
1262  "The MultiMooseEnum in addRequiredParam<std::vector<MultiMooseEnum>> is empty for " +
1263  name);
1264  InputParameters::set<std::vector<MultiMooseEnum>>(name) =
1265  moose_enums; // valid parameter is set by set_attributes
1266  auto & metadata = _params[name];
1267  metadata._required = true;
1268  metadata._doc_string = doc_string;
1269 }
std::string name(const ElemQuality q)

◆ InputParameters::addRequiredParam< std::vector< MultiMooseEnum > >() [2/2]

template<>
void InputParameters::addRequiredParam< std::vector< MultiMooseEnum > > ( const std::string &  ,
const std::string &   
)

Definition at line 1310 of file InputParameters.C.

1312 {
1313  mooseError("You must supply a vector of MultiMooseEnum object(s) when using addRequiredParam!");
1314 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302

Variable Documentation

◆ Action

Definition at line 108 of file InputParameters.h.