https://mooseframework.inl.gov
Functions
InputParameters.C File Reference

Go to the source code of this file.

Functions

InputParameters emptyInputParameters ()
 
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 &)
 

Function Documentation

◆ emptyInputParameters()

InputParameters emptyInputParameters ( )

Definition at line 31 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::getFileNameTypeValues(), MooseServer::getHoverDisplayText(), MooseServer::getNodesByValueAndTypes(), Moose::PetscSupport::getPetscValidParams(), MooseServer::getRequiredParamsText(), Moose::SlepcSupport::getSlepcEigenProblemValidParams(), PiecewiseTabularInterface::validParams(), ParsedMaterialBase::validParams(), FVDiffusionInterpolationInterface::validParams(), FVRelationshipManagerInterface::validParams(), MFEMProblemSolve::validParams(), MultiSystemSolveObject::validParams(), MeshDisplacedInterface::validParams(), NonlinearSolveObject::validParams(), ReferenceResidualInterface::validParams(), MeshChangedInterface::validParams(), FixedPointSolve::validParams(), VectorPostprocessorInterface::validParams(), ReporterInterface::validParams(), ElementIDInterface::validParams(), MFEMBlockRestrictable::validParams(), GeometricSearchInterface::validParams(), MFEMBoundaryRestrictable::validParams(), UserObjectInterface::validParams(), FVInterpolationMethodInterface::validParams(), NeighborCoupleableMooseVariableDependencyIntermediateInterface::validParams(), DistributionInterface::validParams(), ReporterTransferInterface::validParams(), InitialConditionInterface::validParams(), FunctorInterface::validParams(), MOOSEToNEML2::validParams(), SamplerInterface::validParams(), Moose::PeriodicBCHelper::validParams(), BoundaryRestrictableRequired::validParams(), ExecutorInterface::validParams(), FileRangeBuilder::validParams(), SetupInterface::validParams(), LayeredBase::validParams(), MortarConsumerInterface::validParams(), SamplerBase::validParams(), DiffusionLHDGAssemblyHelper::validParams(), OrientedBoxInterface::validParams(), ShapeUserObject< SideUserObject >::validParams(), MooseParsedFunctionBase::validParams(), IPHDGAssemblyHelper::validParams(), NestedSolveTempl< is_ad >::validParams(), RandomInterface::validParams(), TransientInterface::validParams(), BoundaryRestrictable::validParams(), PostprocessorInterface::validParams(), Reporter::validParams(), OutputInterface::validParams(), FunctionParserUtils< false >::validParams(), FunctionInterface::validParams(), PerfGraphInterface::validParams(), MooseBase::validParams(), TaggingInterface::validParams(), Moose::Builder::validParams(), BlockRestrictable::validParams(), MaterialPropertyInterface::validParams(), MeshBaseImageSampler::validParams(), ImageSampler::validParams(), and MooseAppCoordTransform::validParams().

32 {
33  InputParameters params;
34  return params;
35 }
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 1436 of file InputParameters.C.

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

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

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

Definition at line 1373 of file InputParameters.C.

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

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

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

Definition at line 1382 of file InputParameters.C.

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

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

1324 {
1325  InputParameters::set<std::vector<MooseEnum>>(name) =
1326  moose_enums; // valid parameter is set by set_attributes
1327  auto & metadata = _params[name];
1328  metadata._required = true;
1329  metadata._doc_string = doc_string;
1330 }
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 1334 of file InputParameters.C.

1338 {
1339  mooseAssert(
1340  moose_enums.size() == 1,
1341  "Only 1 MultiMooseEnum is supported in addRequiredParam<std::vector<MultiMooseEnum>> for " +
1342  name);
1343  mooseAssert(!moose_enums[0].items().empty(),
1344  "The MultiMooseEnum in addRequiredParam<std::vector<MultiMooseEnum>> is empty for " +
1345  name);
1346  InputParameters::set<std::vector<MultiMooseEnum>>(name) =
1347  moose_enums; // valid parameter is set by set_attributes
1348  auto & metadata = _params[name];
1349  metadata._required = true;
1350  metadata._doc_string = doc_string;
1351 }
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 1392 of file InputParameters.C.

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