Moose::ParameterRegistration::detail Namespace Reference

Functions
	registerParameter (FileName)
	registerParameter (FileNameNoExtension)
	registerParameter (RelativeFileName)
	registerParameter (DataFileName)
	registerParameter (MeshFileName)
	registerParameter (MatrixFileName)
	registerParameter (OutFileBase)
	registerParameter (NonlinearVariableName)
	registerParameter (LinearVariableName)
	registerParameter (SolverVariableName)
	registerParameter (AuxVariableName)
	registerParameter (VariableName)
	registerParameter (BoundaryName)
	registerParameter (SubdomainName)
	registerParameter (PostprocessorName)
	registerParameter (VectorPostprocessorName)
	registerParameter (MeshDivisionName)
	registerParameter (FunctionName)
	registerParameter (DistributionName)
	registerParameter (SamplerName)
	registerParameter (UserObjectName)
	registerParameter (IndicatorName)
	registerParameter (MarkerName)
	registerParameter (MultiAppName)
	registerParameter (OutputName)
	registerParameter (MaterialPropertyName)
	registerParameter (MooseFunctorName)
	registerParameter (MaterialName)
	registerParameter (TagName)
	registerParameter (MeshGeneratorName)
	registerParameter (ExtraElementIDName)
	registerParameter (ReporterValueName)
	registerParameter (ComponentName)
	registerParameter (PhysicsName)
	registerParameter (PositionsName)
	registerParameter (TimesName)
	registerParameter (ExecutorName)
	registerParameter (ParsedFunctionExpression)
	registerParameter (NonlinearSystemName)
	registerParameter (ConvergenceName)
	registerParameter (LinearSystemName)
	registerParameter (SolverSystemName)
	registerParameter (MFEMScalarCoefficientName)
	registerParameter (MFEMVectorCoefficientName)
	registerParameter (MFEMMatrixCoefficientName)
	registerParameter (double)
	registerParameter (std::string)
	registerParameter (short int)
	registerParameter (int)
	registerParameter (long int)
	registerParameter (unsigned short)
	registerParameter (unsigned long long)
	registerScalarParameter (bool)
	registerVectorParameter (bool)
	registerScalarParameter (CLIArgString)
	registerMapParameter (std::string, unsigned int)
	registerMapParameter (std::string, Real)
	registerMapParameter (std::string, std::string)
	registerMapParameter (unsigned int, unsigned int)
	registerMapParameter (unsigned long long, unsigned int)

Variables
static Moose::ParameterRegistry &	registry = Moose::ParameterRegistry::get()
const auto	convert_reporter_name
	Helper for converting a string to a ReporterName, which requires splitting the string at the '/' delimiter. More...
const auto	set_scalar_component_value
	Helper for setting a scalar component value (one with 3 real values) More...
static auto	point
static auto	realvectorvalue
static auto	realeigenvector
static auto	realeigenmatrix
static auto	mooseenum
static auto	multimooseenum
static auto	execflagenum
static auto	realtensorvalue
static auto	reportername
const auto	set_vector_component_value
	Helper for setting a vector component value (one with 3 real values) More...
static auto	vector_point
static auto	vector_realvectorvalue
static auto	vector_mooseenum
static auto	vector_multimooseenum
static auto	vector_reportername
static auto	vector_cliargstring
const auto	set_double_vector_component_value
	Helper for setting a double vector component value (one with 3 real values) More...
static auto	doublevector_point
static auto	doublevector_realvectorvalue

Function Documentation

registerMapParameter() [1/5]

Moose::ParameterRegistration::detail::registerMapParameter	(	std::string	,
		unsigned	int
	)

registerMapParameter() [2/5]

Moose::ParameterRegistration::detail::registerMapParameter	(	std::string	,
		Real
	)

registerMapParameter() [3/5]

Moose::ParameterRegistration::detail::registerMapParameter	(	std::string	,
		std::string
	)

registerMapParameter() [4/5]

Moose::ParameterRegistration::detail::registerMapParameter	(	unsigned	int,
		unsigned	int
	)

registerMapParameter() [5/5]

Moose::ParameterRegistration::detail::registerMapParameter	(	unsigned long	long,
		unsigned	int
	)

registerParameter() [1/52]

Moose::ParameterRegistration::detail::registerParameter

(

FileName

)

registerParameter() [2/52]

Moose::ParameterRegistration::detail::registerParameter

(

FileNameNoExtension

)

registerParameter() [3/52]

Moose::ParameterRegistration::detail::registerParameter

(

RelativeFileName

)

registerParameter() [4/52]

Moose::ParameterRegistration::detail::registerParameter

(

DataFileName

)

registerParameter() [5/52]

Moose::ParameterRegistration::detail::registerParameter

(

MeshFileName

)

registerParameter() [6/52]

Moose::ParameterRegistration::detail::registerParameter

(

MatrixFileName

)

registerParameter() [7/52]

Moose::ParameterRegistration::detail::registerParameter

(

OutFileBase

)

registerParameter() [8/52]

Moose::ParameterRegistration::detail::registerParameter

(

NonlinearVariableName

)

registerParameter() [9/52]

Moose::ParameterRegistration::detail::registerParameter

(

LinearVariableName

)

registerParameter() [10/52]

Moose::ParameterRegistration::detail::registerParameter

(

SolverVariableName

)

registerParameter() [11/52]

Moose::ParameterRegistration::detail::registerParameter

(

AuxVariableName

)

registerParameter() [12/52]

Moose::ParameterRegistration::detail::registerParameter

(

VariableName

)

registerParameter() [13/52]

Moose::ParameterRegistration::detail::registerParameter

(

BoundaryName

)

registerParameter() [14/52]

Moose::ParameterRegistration::detail::registerParameter

(

SubdomainName

)

registerParameter() [15/52]

Moose::ParameterRegistration::detail::registerParameter

(

PostprocessorName

)

registerParameter() [16/52]

Moose::ParameterRegistration::detail::registerParameter

(

VectorPostprocessorName

)

registerParameter() [17/52]

Moose::ParameterRegistration::detail::registerParameter

(

MeshDivisionName

)

registerParameter() [18/52]

Moose::ParameterRegistration::detail::registerParameter

(

FunctionName

)

registerParameter() [19/52]

Moose::ParameterRegistration::detail::registerParameter

(

DistributionName

)

registerParameter() [20/52]

Moose::ParameterRegistration::detail::registerParameter

(

SamplerName

)

registerParameter() [21/52]

Moose::ParameterRegistration::detail::registerParameter

(

UserObjectName

)

registerParameter() [22/52]

Moose::ParameterRegistration::detail::registerParameter

(

IndicatorName

)

registerParameter() [23/52]

Moose::ParameterRegistration::detail::registerParameter

(

MarkerName

)

registerParameter() [24/52]

Moose::ParameterRegistration::detail::registerParameter

(

MultiAppName

)

registerParameter() [25/52]

Moose::ParameterRegistration::detail::registerParameter

(

OutputName

)

registerParameter() [26/52]

Moose::ParameterRegistration::detail::registerParameter

(

MaterialPropertyName

)

registerParameter() [27/52]

Moose::ParameterRegistration::detail::registerParameter

(

MooseFunctorName

)

registerParameter() [28/52]

Moose::ParameterRegistration::detail::registerParameter

(

MaterialName

)

registerParameter() [29/52]

Moose::ParameterRegistration::detail::registerParameter

(

TagName

)

registerParameter() [30/52]

Moose::ParameterRegistration::detail::registerParameter

(

MeshGeneratorName

)

registerParameter() [31/52]

Moose::ParameterRegistration::detail::registerParameter

(

ExtraElementIDName

)

registerParameter() [32/52]

Moose::ParameterRegistration::detail::registerParameter

(

ReporterValueName

)

registerParameter() [33/52]

Moose::ParameterRegistration::detail::registerParameter

(

ComponentName

)

registerParameter() [34/52]

Moose::ParameterRegistration::detail::registerParameter

(

PhysicsName

)

registerParameter() [35/52]

Moose::ParameterRegistration::detail::registerParameter

(

PositionsName

)

registerParameter() [36/52]

Moose::ParameterRegistration::detail::registerParameter

(

TimesName

)

registerParameter() [37/52]

Moose::ParameterRegistration::detail::registerParameter

(

ExecutorName

)

registerParameter() [38/52]

Moose::ParameterRegistration::detail::registerParameter

(

ParsedFunctionExpression

)

registerParameter() [39/52]

Moose::ParameterRegistration::detail::registerParameter

(

NonlinearSystemName

)

registerParameter() [40/52]

Moose::ParameterRegistration::detail::registerParameter

(

ConvergenceName

)

registerParameter() [41/52]

Moose::ParameterRegistration::detail::registerParameter

(

LinearSystemName

)

registerParameter() [42/52]

Moose::ParameterRegistration::detail::registerParameter

(

SolverSystemName

)

registerParameter() [43/52]

Moose::ParameterRegistration::detail::registerParameter

(

MFEMScalarCoefficientName

)

registerParameter() [44/52]

Moose::ParameterRegistration::detail::registerParameter

(

MFEMVectorCoefficientName

)

registerParameter() [45/52]

Moose::ParameterRegistration::detail::registerParameter

(

MFEMMatrixCoefficientName

)

registerParameter() [46/52]

Moose::ParameterRegistration::detail::registerParameter

(

double

)

registerParameter() [47/52]

Moose::ParameterRegistration::detail::registerParameter

(

std::string

)

registerParameter() [48/52]

Moose::ParameterRegistration::detail::registerParameter

(

short

int

)

registerParameter() [49/52]

Moose::ParameterRegistration::detail::registerParameter

(

int

)

registerParameter() [50/52]

Moose::ParameterRegistration::detail::registerParameter

(

long

int

)

registerParameter() [51/52]

Moose::ParameterRegistration::detail::registerParameter

(

unsigned

short

)

registerParameter() [52/52]

Moose::ParameterRegistration::detail::registerParameter

(

unsigned long

long

)

registerScalarParameter() [1/2]

Moose::ParameterRegistration::detail::registerScalarParameter

(

bool

)

registerScalarParameter() [2/2]

Moose::ParameterRegistration::detail::registerScalarParameter

(

CLIArgString

)

registerVectorParameter()

Moose::ParameterRegistration::detail::registerVectorParameter

(

bool

)

Variable Documentation

convert_reporter_name

const auto Moose::ParameterRegistration::detail::convert_reporter_name

Initial value:

= [](const std::string & val,
                                      const hit::Field & field) -> ReporterName
{
  const auto names = MooseUtils::rsplit(val, "/", 2);
  if (names.size() != 2)
    throw std::invalid_argument("invalid syntax in ReporterName parameter " + field.fullpath() +
                                ": supplied name '" + val + "' must contain the '/' delimiter");
  return {names[0], names[1]};
}

Helper for converting a string to a ReporterName, which requires splitting the string at the '/' delimiter.

Definition at line 142 of file ParameterRegistration.C.

doublevector_point

auto Moose::ParameterRegistration::detail::doublevector_point

static

Initial value:

= registry.add<std::vector<std::vector<Point>>>(
    [](std::vector<std::vector<Point>> & value, const hit::Field & field)
    { set_double_vector_component_value(value, field); })

Definition at line 415 of file ParameterRegistration.C.

doublevector_realvectorvalue

auto Moose::ParameterRegistration::detail::doublevector_realvectorvalue

static

Initial value:

= registry.add<std::vector<std::vector<RealVectorValue>>>(
    [](std::vector<std::vector<RealVectorValue>> & value, const hit::Field & field)
    { set_double_vector_component_value(value, field); })

Definition at line 419 of file ParameterRegistration.C.

execflagenum

auto Moose::ParameterRegistration::detail::execflagenum

static

Initial value:

= registry.add<ExecFlagEnum>(
    [](ExecFlagEnum & value, const hit::Field & field)
    { value = MooseUtils::stringJoin(field.param<std::vector<std::string>>(), " "); })

Definition at line 225 of file ParameterRegistration.C.

mooseenum

auto Moose::ParameterRegistration::detail::mooseenum

static

Initial value:

= registry.add<MooseEnum>([](MooseEnum & value, const hit::Field & field)
                                                { value = field.param<std::string>(); })

Definition at line 218 of file ParameterRegistration.C.

multimooseenum

auto Moose::ParameterRegistration::detail::multimooseenum

static

Initial value:

= registry.add<MultiMooseEnum>(
    [](MultiMooseEnum & value, const hit::Field & field)
    { value = MooseUtils::stringJoin(field.param<std::vector<std::string>>(), " "); })

Definition at line 221 of file ParameterRegistration.C.

point

auto Moose::ParameterRegistration::detail::point

static

Initial value:

= registry.add<Point>([](Point & value, const hit::Field & field)
                                        { set_scalar_component_value(value, field); })

Definition at line 171 of file ParameterRegistration.C.

Referenced by ReporterPointSource::addPoints(), MooseMesh::addQuadratureNode(), MultiAppGeneralFieldTransfer::cacheOutgoingPointInfo(), MooseMeshUtils::computeDistanceToAxis(), OrientedBoxInterface::containsPoint(), coordTransformFactor(), MooseMeshUtils::coordTransformFactor(), Moose::Kokkos::Assembly::coordTransformFactor(), MooseMeshUtils::coordTransformFactorRZGeneral(), MultiAppNearestNodeTransfer::execute(), MultiAppUserObjectTransfer::execute(), ReporterPointSource::fillPoint(), MultiAppGeometricInterpolationTransfer::fillSourceInterpolationPoints(), ElementGenerator::generate(), XYDelaunayGenerator::generate(), MooseUtils::DelimitedFileReaderTempl< T >::getDataAsPoints(), PropertyReadFile::getVoronoiData(), MultiAppGeneralFieldTransfer::inMesh(), MultiAppGeometricInterpolationTransfer::interpolateTargetPoints(), Boundary2DDelaunayGenerator::levelSetEvaluator(), CutMeshByLevelSetGeneratorBase::levelSetEvaluator(), MultiAppGeneralFieldTransfer::locatePointReceivers(), MultiAppCoordTransform::mapBack(), MultiAppCoordTransform::operator()(), geom_utils::pointInPolygon(), CutMeshByLevelSetGeneratorBase::pointLevelSetRelation(), geom_utils::pointOnEdge(), geom_utils::projectPoint(), NearestPointAverage::spatialValue(), NearestPointIntegralVariablePostprocessor::spatialValue(), and MultiAppShapeEvaluationTransfer::transferVariable().

realeigenmatrix

auto Moose::ParameterRegistration::detail::realeigenmatrix

static

Initial value:

= registry.add<RealEigenMatrix>(
    [](RealEigenMatrix & value, const hit::Field & field)
    {
      value.resize(0, 0);
      std::vector<std::string> tokens;
      MooseUtils::tokenize(field.param<std::string>(), tokens, 1, ";");

      for (const auto i : index_range(tokens))
      {
        const auto token = MooseUtils::trim(tokens[i]);
        std::vector<Real> values;
        if (!MooseUtils::tokenizeAndConvert<Real>(token, values))
          throw std::invalid_argument("invalid syntax for parameter: " + field.fullpath() + "[" +
                                      std::to_string(i) + "]='" + token + "'");
        if (i == 0)
          value.resize(tokens.size(), values.size());
        else if (libMesh::cast_int<std::size_t>(value.cols()) != values.size())
          throw std::invalid_argument("matrix is not square for parameter " + field.fullpath());
        for (const auto j : index_range(values))
          value(i, j) = values[j];
      }
    })

Definition at line 195 of file ParameterRegistration.C.

realeigenvector

auto Moose::ParameterRegistration::detail::realeigenvector

static

Initial value:

= registry.add<RealEigenVector>(
    [](RealEigenVector & value, const hit::Field & field)
    {
      const auto vec = field.param<std::vector<double>>();
      value.resize(vec.size());
      for (const auto i : index_range(vec))
        value(i) = Real(vec[i]);
    })

Definition at line 186 of file ParameterRegistration.C.

realtensorvalue

auto Moose::ParameterRegistration::detail::realtensorvalue

static

Initial value:

= registry.add<RealTensorValue>(
    [](RealTensorValue & value, const hit::Field & field)
    {
      const auto vec = field.param<std::vector<double>>();
      if (vec.size() != LIBMESH_DIM * LIBMESH_DIM)
        throw std::invalid_argument("invalid RealTensorValue parameter '" + field.fullpath() +
                                    "': size is " + std::to_string(vec.size()) + " but should be " +
                                    std::to_string(LIBMESH_DIM * LIBMESH_DIM));

      for (const auto i : make_range(LIBMESH_DIM))
        for (const auto j : make_range(LIBMESH_DIM))
          value(i, j) = Real(vec[i * LIBMESH_DIM + j]);
    })

Definition at line 229 of file ParameterRegistration.C.

realvectorvalue

auto Moose::ParameterRegistration::detail::realvectorvalue

static

Initial value:

=
    registry.add<RealVectorValue>([](RealVectorValue & value, const hit::Field & field)
                                  { set_scalar_component_value(value, field); })

Definition at line 174 of file ParameterRegistration.C.

registry

Moose::ParameterRegistry& Moose::ParameterRegistration::detail::registry = Moose::ParameterRegistry::get()

static

Definition at line 53 of file ParameterRegistration.C.

Referenced by dataLoad(), dataStore(), Moose::ParameterRegistry::get(), Moose::WebServerControlTypeRegistry::get(), and MooseApp::registerInterfaceObject().

reportername

auto Moose::ParameterRegistration::detail::reportername

static

Initial value:

= registry.add<ReporterName>(
    [](ReporterName & value, const hit::Field & field)
    { value = convert_reporter_name(field.param<std::string>(), field); })

Definition at line 243 of file ParameterRegistration.C.

set_double_vector_component_value

const auto Moose::ParameterRegistration::detail::set_double_vector_component_value

Helper for setting a double vector component value (one with 3 real values)

Definition at line 374 of file ParameterRegistration.C.

set_scalar_component_value

const auto Moose::ParameterRegistration::detail::set_scalar_component_value

Initial value:

= [](auto & value, const hit::Field & field)
{
  const auto vec = field.param<std::vector<double>>();
  if (vec.size() != LIBMESH_DIM)
    throw std::invalid_argument("wrong number of values in " + MooseUtils::prettyCppType(&value) +
                                " parameter '" + field.fullpath() + "': was given " +
                                std::to_string(vec.size()) + " component(s) but should have " +
                                std::to_string(LIBMESH_DIM));

  for (const auto d : make_range(LIBMESH_DIM))
    value(d) = Real(vec[d]);
}

Helper for setting a scalar component value (one with 3 real values)

Definition at line 157 of file ParameterRegistration.C.

set_vector_component_value

const auto Moose::ParameterRegistration::detail::set_vector_component_value

Initial value:

= [](auto & value, const hit::Field & field)
{
  value.clear();
  const auto vec = field.param<std::vector<double>>();

  if (vec.size() % LIBMESH_DIM)
    throw std::invalid_argument("wrong number of values in vector parameter '" + field.fullpath() +
                                "': size " + std::to_string(vec.size()) + " is not a multiple of " +
                                std::to_string(LIBMESH_DIM));

  const std::size_t size = vec.size() / LIBMESH_DIM;
  value.resize(size);
  for (const auto i : make_range(size))
    for (const auto d : make_range(LIBMESH_DIM))
      value[i](d) = vec[i * LIBMESH_DIM + d];
}

Helper for setting a vector component value (one with 3 real values)

Definition at line 252 of file ParameterRegistration.C.

vector_cliargstring

auto Moose::ParameterRegistration::detail::vector_cliargstring

static

Definition at line 329 of file ParameterRegistration.C.

vector_mooseenum

auto Moose::ParameterRegistration::detail::vector_mooseenum

static

Initial value:

= registry.add<std::vector<MooseEnum>>(
    [](std::vector<MooseEnum> & value, const hit::Field & field)
    {
      mooseAssert(!value.empty(), "Missing a value to initialize on");

      
      
      
      const auto vec = field.param<std::vector<std::string>>();
      value.resize(vec.size(), value[0]);
      for (const auto i : index_range(vec))
        value[i] = vec[i];
    })

Definition at line 283 of file ParameterRegistration.C.

vector_multimooseenum

auto Moose::ParameterRegistration::detail::vector_multimooseenum

static

Initial value:

= registry.add<std::vector<MultiMooseEnum>>(
    [](std::vector<MultiMooseEnum> & value, const hit::Field & field)
    {
      mooseAssert(!value.empty(), "Missing a value to initialize on");

      const auto tokens = MooseUtils::split(field.param<std::string>(), ";");
      for (const auto i : index_range(tokens))
      {
        const auto & entry = tokens[i];
        if (MooseUtils::trim(entry) == "")
          throw std::invalid_argument("entry " + std::to_string(i) + " in '" + field.fullpath() +
                                      "' is empty");
      }
      value.resize(tokens.size(), value[0]);
      for (const auto i : index_range(tokens))
      {
        std::vector<std::string> strvals;
        MooseUtils::tokenize<std::string>(tokens[i], strvals, 1, " ");
        value[i] = strvals;
      }
    })

Definition at line 297 of file ParameterRegistration.C.

vector_point

auto Moose::ParameterRegistration::detail::vector_point

static

Initial value:

=
    registry.add<std::vector<Point>>([](std::vector<Point> & value, const hit::Field & field)
                                     { set_vector_component_value(value, field); })

Definition at line 270 of file ParameterRegistration.C.

vector_realvectorvalue

auto Moose::ParameterRegistration::detail::vector_realvectorvalue

static

Initial value:

= registry.add<std::vector<RealVectorValue>>(
    [](std::vector<RealVectorValue> & value, const hit::Field & field)
    { set_vector_component_value(value, field); })

Definition at line 274 of file ParameterRegistration.C.

vector_reportername

auto Moose::ParameterRegistration::detail::vector_reportername

static

Initial value:

= registry.add<std::vector<ReporterName>>(
    [](std::vector<ReporterName> & value, const hit::Field & field)
    {
      value.clear();
      const auto names = field.param<std::vector<std::string>>();
      value.resize(names.size());
      for (const auto i : index_range(names))
        value[i] = convert_reporter_name(names[i], field);
    })

Definition at line 319 of file ParameterRegistration.C.