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
namespace	hit
namespace	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.
namespace	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 31 of file InputParameters.C.

{
  InputParameters params;
  return params;
}

Referenced by NEML2ModelExecutor::actionParams(), ConstantReporter::addReporterTypeParams(), Moose::FV::advectedInterpolationParameter(), SurfaceDelaunayGeneratorBase::boundaryAndHolesParams(), 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(), MortarConsumerInterface::triangulationParams(), MooseBase::validParams(), DistributionInterface::validParams(), FixedPointSolve::validParams(), MultiSystemSolveObject::validParams(), NonlinearSolveObject::validParams(), ExecutorInterface::validParams(), FunctionInterface::validParams(), MooseParsedFunctionBase::validParams(), PiecewiseTabularInterface::validParams(), FVDiffusionInterpolationInterface::validParams(), GeometricSearchInterface::validParams(), DiffusionLHDGAssemblyHelper::validParams(), ElementAndTraceScalarHDGAssemblyHelper::validParams(), InitialConditionInterface::validParams(), BlockRestrictable::validParams(), BoundaryRestrictable::validParams(), BoundaryRestrictableRequired::validParams(), ElementIDInterface::validParams(), FunctorInterface::validParams(), FVInterpolationMethodInterface::validParams(), FVRelationshipManagerInterface::validParams(), MeshChangedInterface::validParams(), MeshDisplacedInterface::validParams(), MortarConsumerInterface::validParams(), OrientedBoxInterface::validParams(), OutputInterface::validParams(), PerfGraphInterface::validParams(), PostprocessorInterface::validParams(), RandomInterface::validParams(), ReferenceResidualInterface::validParams(), SetupInterface::validParams(), TaggingInterface::validParams(), TransientInterface::validParams(), MaterialPropertyInterface::validParams(), ParsedMaterialBase::validParams(), MFEMProblemSolve::validParams(), MFEMBlockRestrictable::validParams(), MFEMBoundaryRestrictable::validParams(), MOOSEToNEML2::validParams(), Moose::Builder::validParams(), Reporter::validParams(), ReporterInterface::validParams(), SamplerInterface::validParams(), ReporterTransferInterface::validParams(), LayeredBase::validParams(), ShapeUserObject< T >::validParams(), UserObjectInterface::validParams(), FileRangeBuilder::validParams(), ImageSampler::validParams(), MeshBaseImageSampler::validParams(), MooseAppCoordTransform::validParams(), NestedSolveTempl< is_ad >::validParams(), Moose::PeriodicBCHelper::validParams(), NeighborCoupleableMooseVariableDependencyIntermediateInterface::validParams(), SamplerBase::validParams(), and VectorPostprocessorInterface::validParams().

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

template<>

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

Definition at line 1499 of file InputParameters.C.

{
  mooseError("You must supply a vector of MooseEnum object(s) and the deprecation string when "
             "using addDeprecatedParam, even if the parameter is not required!");
}

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

template<>

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

Definition at line 1436 of file InputParameters.C.

{
  mooseError("You must supply a vector of MooseEnum object(s) when using addParam, even if the "
             "parameter is not required!");
}

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

template<>

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

Definition at line 1445 of file InputParameters.C.

{
  mooseError(
      "You must supply a vector of MultiMooseEnum object(s) when using addParam, even if the "
      "parameter is not required!");
}

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

{
  InputParameters::set<std::vector<MooseEnum>>(name) =
      moose_enums; // valid parameter is set by set_attributes
  auto & metadata = _params[name];
  metadata._required = true;
  metadata._doc_string = doc_string;
}

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

template<>

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

Definition at line 1455 of file InputParameters.C.

{
  mooseError("You must supply a vector of MultiMooseEnum object(s) when using addRequiredParam!");
}

InputParameters::addRequiredParam< std::vector< MultiMooseEnum > >() [2/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 1397 of file InputParameters.C.

{
  mooseAssert(
      moose_enums.size() == 1,
      "Only 1 MultiMooseEnum is supported in addRequiredParam<std::vector<MultiMooseEnum>> for " +
          name);
  mooseAssert(!moose_enums[0].items().empty(),
              "The MultiMooseEnum in addRequiredParam<std::vector<MultiMooseEnum>> is empty for " +
                  name);
  InputParameters::set<std::vector<MultiMooseEnum>>(name) =
      moose_enums; // valid parameter is set by set_attributes
  auto & metadata = _params[name];
  metadata._required = true;
  metadata._doc_string = doc_string;
}

Variable Documentation

Action

class FunctionParserBase Action

Definition at line 109 of file InputParameters.h.