Action to generate batches of mesh generators from vectors of parameter values. More...

#include <BatchMeshGeneratorAction.h>

Inheritance diagram for BatchMeshGeneratorAction:

Public Types
enum	MultiBatchParamsMethod { MultiBatchParamsMethod::corresponding, MultiBatchParamsMethod::cartesian_product }

enum	ParameterType { ParameterType::BOOL, ParameterType::REAL, ParameterType::SHORT, ParameterType::USHORT, ParameterType::INT, ParameterType::UINT, ParameterType::LONG, ParameterType::ULONG, ParameterType::LONGLONG, ParameterType::ULONGLONG, ParameterType::DOFIDTYPE, ParameterType::BDRYIDTYPE, ParameterType::SDIDTYPE, ParameterType::STRING, ParameterType::SDNAME, ParameterType::BDRYNAME, ParameterType::MGNAME, ParameterType::MFNAME, ParameterType::ENUM, ParameterType::REALVECTORVALUE, ParameterType::POINT }

using	DataFileParameterType = DataFileName
	The parameter type this interface expects for a data file name. More...

Public Member Functions
	BatchMeshGeneratorAction (const InputParameters &params)

virtual void	act () override final
	Method to add objects to the simulation or perform other setup tasks. More...

void	timedAct ()
	The method called externally that causes the action to act() More...

virtual void	addRelationshipManagers (Moose::RelationshipManagerType when_type)
	Method to add a relationship manager for the objects being added to the system. More...

MooseObjectName	uniqueActionName () const
	The unique name for accessing input parameters of this action in the InputParameterWarehouse. More...

const std::string &	specificTaskName () const

const std::set< std::string > &	getAllTasks () const

void	appendTask (const std::string &task)

MooseApp &	getMooseApp () const
	Get the MooseApp this class is associated with. More...

const std::string &	type () const
	Get the type of this class. More...

const std::string &	name () const
	Get the name of the class. More...

std::string	typeAndName () const
	Get the class's combined type and name; useful in error handling. More...

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const
	Get the parameters of the object. More...

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () const

template<typename T >
const T &	getParam (const std::string &name) const
	Retrieve a parameter for the object. More...

template<typename T1 , typename T2 >
std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const
	Retrieve two parameters and provide pair of parameters for the object. More...

template<typename T >
const T *	queryParam (const std::string &name) const
	Query a parameter for the object. More...

template<typename T >
const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const
	Retrieve a renamed parameter for the object. More...

template<typename T >
T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
	Verifies that the requested parameter exists and is not NULL and returns it to the caller. More...

bool	isParamValid (const std::string &name) const
	Test if the supplied parameter is valid. More...

bool	isParamSetByUser (const std::string &name) const
	Test if the supplied parameter is set by a user, as opposed to not set or set to default. More...

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
	Connect controllable parameter of this action with the controllable parameters of the objects added by this action. More...

template<typename... Args>
void	paramError (const std::string &param, Args... args) const
	Emits an error prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message. More...

template<typename... Args>
void	paramWarning (const std::string &param, Args... args) const
	Emits a warning prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message. More...

template<typename... Args>
void	paramInfo (const std::string &param, Args... args) const
	Emits an informational message prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message. More...

std::string	messagePrefix (const bool hit_prefix=true) const

std::string	errorPrefix (const std::string &) const
	Deprecated message prefix; the error type is no longer used. More...

template<typename... Args>
void	mooseError (Args &&... args) const
	Emits an error prefixed with object name and type and optionally a file path to the top-level block parameter if available. More...

template<typename... Args>
void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

template<typename... Args>
void	mooseErrorNonPrefixed (Args &&... args) const
	Emits an error without the prefixing included in mooseError(). More...

template<typename... Args>
void	mooseWarning (Args &&... args) const
	Emits a warning prefixed with object name and type. More...

template<typename... Args>
void	mooseWarningNonPrefixed (Args &&... args) const
	Emits a warning without the prefixing included in mooseWarning(). More...

template<typename... Args>
void	mooseDeprecated (Args &&... args) const

template<typename... Args>
void	mooseInfo (Args &&... args) const

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr) const
	External method for calling moose error with added object context. More...

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

std::string	getDataFileName (const std::string &param) const
	Deprecated method. More...

std::string	getDataFileNameByName (const std::string &relative_path) const
	Deprecated method. More...

std::string	getDataFilePath (const std::string &relative_path) const
	Returns the path of a data file for a given relative file path. More...

PerfGraph &	perfGraph ()
	Get the PerfGraph. More...

void	assertParamDefined (const std::string &libmesh_dbg_var(param)) const

Static Public Member Functions
static InputParameters	validParams ()

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node)
	External method for calling moose error with added object context. More...

Public Attributes
const ConsoleStream	_console
	An instance of helper class to write streams to the Console objects. More...

Static Public Attributes
static const std::string	unique_action_name_param = "_unique_action_name"
	The name of the parameter that contains the unique action name. More...

static const std::string	type_param = "_type"
	The name of the parameter that contains the object type. More...

static const std::string	name_param = "_object_name"
	The name of the parameter that contains the object name. More...

static const std::string	unique_name_param = "_unique_name"
	The name of the parameter that contains the unique object name. More...

static const std::string	app_param = "_moose_app"
	The name of the parameter that contains the MooseApp. More...

static const std::string	moose_base_param = "_moose_base"
	The name of the parameter that contains the moose system base. More...

static constexpr auto	SYSTEM = "MeshMetaData"
	The system name used when initializing the Restartable interface. More...

static constexpr auto	NAME = "<empty>"
	The data name used when initializing the Restartable interface for non-MeshGenerator objects. More...

Protected Member Functions
virtual void	addMeshGenerators ()

void	setScalarParams (InputParameters &params, const std::string &param_name, const ParameterType &param_type, const std::string &param_value) const
	Set the scalar input parameters for a unit mesh generator. More...

void	setVectorParams (InputParameters &params, const std::string &param_name, const ParameterType &param_type, const std::vector< std::string > &param_value) const
	Set the vector input parameters for a unit mesh generator. More...

template<typename T >
void	convertAndSetNumericVector (InputParameters &params, const std::string &param_name, const std::vector< std::string > &param_value) const
	Convert a vector of strings to a numeric vector and set it in the InputParameters object. More...

template<typename T >
void	convertAndSetCompoundRealScalarVector (InputParameters &params, const std::string &param_name, const std::vector< std::string > &param_value) const
	Convert a vector of strings to a compound real scalar type vector and set it in the InputParameters object. More...

template<typename T >
void	convertAndSetStringLikeVector (InputParameters &params, const std::string &param_name, const std::vector< std::string > &param_value) const
	Convert a vector of strings to a string-derived type vector and set it in the InputParameters object. More...

void	checkInputParametersTypes (const InputParameters &params, const std::string &action_input_param_name, const std::vector< std::string > &param_names, const std::vector< ParameterType > &param_types, const bool &is_vector=false) const
	Check the types of the input parameters are valid, otherwise throw an error. More...

template<typename T >
void	checkInputParameterType (const InputParameters &params, const std::string &action_input_param_name, const std::string &param_name, const bool &is_vector) const
	Check the type of the input parameter is valid, otherwise throw an error. More...

template<typename T >
T	convertStringToCompoundRealScalar (const std::string &str) const
	Convert a string to a compound real scalar type. More...

bool	isCompoundRealScalarType (const ParameterType &param_type) const
	Check if the parameter type is a compound real scalar type. More...

bool	addRelationshipManagers (Moose::RelationshipManagerType when_type, const InputParameters &moose_object_pars)
	Method to add a relationship manager for the objects being added to the system. More...

void	associateWithParameter (const std::string &param_name, InputParameters &params) const
	Associates the object's parameters `params` with the input location from this Action's parameter with the name `param_name`, if one exists. More...

void	associateWithParameter (const InputParameters &from_params, const std::string &param_name, InputParameters &params) const
	The same as associateWithParameter() without `from_params`, but instead allows you to associate this with another object's parameters instead of the parameters from this action. More...

template<typename T >
const T &	getMeshProperty (const std::string &data_name, const std::string &prefix)
	Method for retrieving a property with the given type and name exists in the mesh meta-data store. More...

template<typename T >
const T &	getMeshProperty (const std::string &data_name)

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

template<typename T >
bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name) const

template<typename T >
bool	hasMeshProperty (const std::string &data_name) const

std::string	meshPropertyName (const std::string &data_name) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level) const
	Call to register a named section for timing. More...

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const
	Call to register a named section for timing. More...

std::string	timedSectionName (const std::string &section_name) const

void	assertParamDefined (const std::string &param) const
	Check in debug mode that this parameter has been added to the validParams. More...

void	checkParamsBothSetOrNotSet (const std::string &param1, const std::string &param2) const
	Check that two parameters are either both set or both not set. More...

void	checkSecondParamSetOnlyIfFirstOneTrue (const std::string &param1, const std::string &param2) const
	Check that a parameter is set only if the first one is set to true. More...

void	checkSecondParamSetOnlyIfFirstOneSet (const std::string &param1, const std::string &param2) const
	Check that a parameter is set only if the first one is set. More...

void	checkSecondParamNotSetIfFirstOneSet (const std::string &param1, const std::string &param2) const
	Check that a parameter is not set if the first one is set. More...

void	checkVectorParamsSameLength (const std::string &param1, const std::string &param2) const
	Check that the two vector parameters are of the same length. More...

void	checkVectorParamAndMultiMooseEnumLength (const std::string &param1, const std::string &param2) const
	Check that this vector parameter (with name defined in `param1`) has the same length as the MultiMooseEnum (with name defined in `param2`) More...

void	checkTwoDVectorParamsSameLength (const std::string &param1, const std::string &param2) const
	Check that the two-D vectors have exactly the same length in both dimensions. More...

void	checkVectorParamsNoOverlap (const std::vector< std::string > &param_vecs) const
	Check that there is no overlap between the items in each vector parameters Each vector parameter should also have unique items. More...

void	checkTwoDVectorParamsNoRespectiveOverlap (const std::vector< std::string > &param_vecs) const
	Check that there is no overlap between the respective items in each vector of the two-D parameters Each vector of the two-D vector parameter should also have unique items. More...

void	checkTwoDVectorParamInnerSameLengthAsOneDVector (const std::string &param1, const std::string &param2) const
	Check that each inner vector of a two-D vector parameter are the same size as another one-D vector parameter. More...

void	checkTwoDVectorParamMultiMooseEnumSameLength (const std::string &param1, const std::string &param2, const bool error_for_param2) const
	Check that the size of a two-D vector parameter matches the size of a MultiMooseEnum parameter. More...

void	checkVectorParamNotEmpty (const std::string &param1) const
	Check that the user did not pass an empty vector. More...

void	checkVectorParamsSameLengthIfSet (const std::string &param1, const std::string &param2, const bool ignore_empty_default_param2=false) const
	Check that two vector parameters are the same length if both are set. More...

void	checkVectorParamLengthSameAsCombinedOthers (const std::string &param1, const std::string &param2, const std::string &param3) const
	Check that a vector parameter is the same length as two others combined. More...

void	checkBlockwiseConsistency (const std::string &block_param_name, const std::vector< std::string > &parameter_names) const
	Check if the user commited errors during the definition of block-wise parameters. More...

bool	parameterConsistent (const InputParameters &other_param, const std::string &param_name) const
	Return whether two parameters are consistent. More...

void	warnInconsistent (const InputParameters &parameters, const std::string &param_name) const
	Emits a warning if two parameters are not equal to each other. More...

void	errorDependentParameter (const std::string &param1, const std::string &value_not_set, const std::vector< std::string > &dependent_params) const
	Error messages for parameters that should depend on another parameter. More...

void	errorInconsistentDependentParameter (const std::string &param1, const std::string &value_set, const std::vector< std::string > &dependent_params) const
	Error messages for parameters that should depend on another parameter but with a different error message. More...

Static Protected Member Functions
static std::string	meshPropertyName (const std::string &data_name, const std::string &prefix)

Protected Attributes
const std::string	_mesh_generator_type
	Type (object name) of the mesh generator to use for batch generation. More...

const std::string	_mesh_name_prefix
	Prefix to use for naming the batch generated meshes. More...

const std::vector< std::string >	_batch_scalar_input_param_names
	Names of the scalar input parameters to vary in the batch generation. More...

const std::vector< ParameterType >	_batch_scalar_input_param_types
	Types of the scalar input parameters to vary in the batch generation. More...

std::vector< std::vector< std::string > >	_batch_scalar_input_param_values
	Values of the scalar input parameters to vary in the batch generation. More...

const std::vector< std::string >	_batch_vector_input_param_names
	Names of the vector input parameters to vary in the batch generation. More...

const std::vector< ParameterType >	_batch_vector_input_param_types
	Types of the vector input parameters to vary in the batch generation. More...

std::vector< std::vector< std::vector< std::string > > >	_batch_vector_input_param_values
	Values of the vector input parameters to vary in the batch generation. More...

const MultiBatchParamsMethod	_multi_batch_params_method
	Method to use for generating the batch parameters. More...

const std::vector< std::string >	_fixed_scalar_input_param_names
	Names of the vector input parameters to keep fixed in the batch generation. More...

const std::vector< ParameterType >	_fixed_scalar_input_param_types
	Types of the vector input parameters to keep fixed in the batch generation. More...

std::vector< std::string >	_fixed_scalar_input_param_values
	Values of the vector input parameters to keep fixed in the batch generation. More...

const std::vector< std::string >	_fixed_vector_input_param_names
	Names of the vector input parameters to keep fixed in the batch generation. More...

const std::vector< ParameterType >	_fixed_vector_input_param_types
	Types of the vector input parameters to keep fixed in the batch generation. More...

std::vector< std::vector< std::string > >	_fixed_vector_input_param_values
	Values of the vector input parameters to keep fixed in the batch generation. More...

const bool	_use_decomposed_index
	Flag to indicate if the decomposed index should be used in the mesh name. More...

std::string	_registered_identifier

std::string	_specific_task_name
	This member will only be populated if this Action instance is only designed to handle one task. More...

std::set< std::string >	_all_tasks
	A list of all the tasks that this Action will satisfy. More...

ActionWarehouse &	_awh
	Reference to ActionWarehouse where we store object build by actions. More...

const std::string &	_current_task
	The current action (even though we have separate instances for each action) More...

std::shared_ptr< MooseMesh > &	_mesh

std::shared_ptr< MooseMesh > &	_displaced_mesh

std::shared_ptr< FEProblemBase > &	_problem
	Convenience reference to a problem this action works on. More...

PerfID	_act_timer
	Timers. More...

MooseApp &	_app
	The MOOSE application this is associated with. More...

Factory &	_factory
	The Factory associated with the MooseApp. More...

ActionFactory &	_action_factory
	Builds Actions. More...

const std::string &	_type
	The type of this class. More...

const std::string &	_name
	The name of this class. More...

const InputParameters &	_pars
	The object's parameters. More...

const Parallel::Communicator &	_communicator

MooseApp &	_pg_moose_app
	The MooseApp that owns the PerfGraph. More...

const std::string	_prefix
	A prefix to use for all sections. More...

Detailed Description

Action to generate batches of mesh generators from vectors of parameter values.

Definition at line 20 of file BatchMeshGeneratorAction.h.

Member Typedef Documentation

◆ DataFileParameterType

using DataFileInterface::DataFileParameterType = DataFileName

inherited

The parameter type this interface expects for a data file name.

Definition at line 27 of file DataFileInterface.h.

Member Enumeration Documentation

◆ MultiBatchParamsMethod

enum BatchMeshGeneratorAction::MultiBatchParamsMethod

strong

Enumerator
corresponding
cartesian_product

Definition at line 30 of file BatchMeshGeneratorAction.h.

   {
     corresponding,
     cartesian_product
   };

◆ ParameterType

enum BatchMeshGeneratorAction::ParameterType

strong

Enumerator
BOOL
REAL
SHORT
USHORT
INT
UINT
LONG
ULONG
LONGLONG
ULONGLONG
DOFIDTYPE
BDRYIDTYPE
SDIDTYPE
STRING
SDNAME
BDRYNAME
MGNAME
MFNAME
ENUM
REALVECTORVALUE
POINT

Definition at line 36 of file BatchMeshGeneratorAction.h.

   {
     BOOL,
     REAL,
     SHORT,
     USHORT,
     INT,
     UINT,
     LONG,
     ULONG,
     LONGLONG,
     ULONGLONG,
     DOFIDTYPE,
     BDRYIDTYPE,
     SDIDTYPE,
     STRING,
     SDNAME,
     BDRYNAME,
     MGNAME,
     MFNAME,
     ENUM,
     REALVECTORVALUE,
     POINT
   };

Constructor & Destructor Documentation

◆ BatchMeshGeneratorAction()

BatchMeshGeneratorAction::BatchMeshGeneratorAction ( const InputParameters & params )

The compound real scalar value type does not alter the length of 'batch_vector_input_param_values'

Definition at line 103 of file BatchMeshGeneratorAction.C.

   : Action(params),
     InputParametersChecksUtils<BatchMeshGeneratorAction>(this),
     _mesh_generator_type(getParam<std::string>("mesh_generator_type")),
     _mesh_name_prefix(getParam<std::string>("mesh_name_prefix")),
     _batch_scalar_input_param_names(
         getParam<std::vector<std::string>>("batch_scalar_input_param_names")),
     _batch_scalar_input_param_types(isParamValid("batch_scalar_input_param_types")
                                         ? getParam<MultiMooseEnum>("batch_scalar_input_param_types")
                                               .template getSetValueIDs<ParameterType>()
                                         : std::vector<ParameterType>()),
     _batch_scalar_input_param_values(
         getParam<std::vector<std::vector<std::string>>>("batch_scalar_input_param_values")),
     _batch_vector_input_param_names(
         getParam<std::vector<std::string>>("batch_vector_input_param_names")),
     _batch_vector_input_param_types(isParamValid("batch_vector_input_param_types")
                                         ? getParam<MultiMooseEnum>("batch_vector_input_param_types")
                                               .template getSetValueIDs<ParameterType>()
                                         : std::vector<ParameterType>()),
     _batch_vector_input_param_values(getParam<std::vector<std::vector<std::vector<std::string>>>>(
         "batch_vector_input_param_values")),
     _multi_batch_params_method(getParam<MooseEnum>("multi_batch_params_method")
                                    .template getEnum<MultiBatchParamsMethod>()),
     _fixed_scalar_input_param_names(
         getParam<std::vector<std::string>>("fixed_scalar_input_param_names")),
     _fixed_scalar_input_param_types(isParamValid("fixed_scalar_input_param_types")
                                         ? getParam<MultiMooseEnum>("fixed_scalar_input_param_types")
                                               .template getSetValueIDs<ParameterType>()
                                         : std::vector<ParameterType>()),
     _fixed_scalar_input_param_values(
         getParam<std::vector<std::string>>("fixed_scalar_input_param_values")),
     _fixed_vector_input_param_names(
         getParam<std::vector<std::string>>("fixed_vector_input_param_names")),
     _fixed_vector_input_param_types(isParamValid("fixed_vector_input_param_types")
                                         ? getParam<MultiMooseEnum>("fixed_vector_input_param_types")
                                               .template getSetValueIDs<ParameterType>()
                                         : std::vector<ParameterType>()),
     _fixed_vector_input_param_values(
         getParam<std::vector<std::vector<std::string>>>("fixed_vector_input_param_values")),
     _use_decomposed_index(getParam<bool>("use_decomposed_index"))
 {
   // Sanity check for the fixed input parameters
   checkVectorParamAndMultiMooseEnumLength<std::string>("fixed_scalar_input_param_names",
                                                        "fixed_scalar_input_param_types");
   const auto fixed_scalar_real_compound_num =
       std::count_if(_fixed_scalar_input_param_types.begin(),
                     _fixed_scalar_input_param_types.end(),
                     [this](const ParameterType & type) { return isCompoundRealScalarType(type); });
   if (fixed_scalar_real_compound_num > 0)
   {
     if (_fixed_scalar_input_param_types.size() +
             (Moose::dim - 1) * fixed_scalar_real_compound_num !=
         _fixed_scalar_input_param_values.size())
       paramError("fixed_scalar_input_param_values",
                  "This parameter must have a size that is consistent with "
                  "fixed_scalar_input_param_names. Note that each REALVECTORVALUE or POINT type "
                  "parameter must be represented as ",
                  std::to_string(Moose::dim),
                  " separate values instead of 1.");
     // Rearrange _fixed_scalar_input_param_values so that each compound real scalar value is in one
     // single string
     auto fixed_scalar_input_param_values_tmp(_fixed_scalar_input_param_values);
     _fixed_scalar_input_param_values.resize(_fixed_scalar_input_param_types.size());
     unsigned int raw_value_ct = 0;
     for (const auto i : index_range(_fixed_scalar_input_param_types))
     {
       if (isCompoundRealScalarType(_fixed_scalar_input_param_types[i]))
       {
         // In that case, the string element needs to contain three elements separated by spaces
         _fixed_scalar_input_param_values[i] = MooseUtils::join(
             fixed_scalar_input_param_values_tmp.begin() + raw_value_ct,
             fixed_scalar_input_param_values_tmp.begin() + raw_value_ct + Moose::dim,
             " ");
         raw_value_ct += Moose::dim;
       }
       else
       {
         _fixed_scalar_input_param_values[i] = fixed_scalar_input_param_values_tmp[raw_value_ct];
         raw_value_ct += 1;
       }
     }
   }
   else
     checkVectorParamsSameLength<std::string, std::string>("fixed_scalar_input_param_names",
                                                           "fixed_scalar_input_param_values");
 
   checkVectorParamAndMultiMooseEnumLength<std::string>("fixed_vector_input_param_names",
                                                        "fixed_vector_input_param_types");
   // The compound real scalar value type does not alter the length of
   // 'fixed_vector_input_param_values'
   checkVectorParamsSameLength<std::string, std::vector<std::string>>(
       "fixed_vector_input_param_names", "fixed_vector_input_param_values");
   // But we still need to process the affected elements
   for (const auto i : index_range(_fixed_vector_input_param_types))
   {
     if (isCompoundRealScalarType(_fixed_vector_input_param_types[i]))
     {
       // Ensure that each compound real scalar value is represented as Moose::dim Real values
       if (_fixed_vector_input_param_values[i].size() % Moose::dim != 0)
         paramError("fixed_vector_input_param_values",
                    "This parameter must have a size that is consistent with "
                    "fixed_vector_input_param_names. Note that each REALVECTORVALUE or POINT type "
                    "parameter must be represented as ",
                    std::to_string(Moose::dim),
                    " separate values instead of 1.");
       auto unit_fixed_vector_input_param_values_tmp(_fixed_vector_input_param_values[i]);
       _fixed_vector_input_param_values[i].resize(unit_fixed_vector_input_param_values_tmp.size() /
                                                  Moose::dim);
       for (const auto j : index_range(_fixed_vector_input_param_values[i]))
         _fixed_vector_input_param_values[i][j] = MooseUtils::join(
             unit_fixed_vector_input_param_values_tmp.begin() + j * Moose::dim,
             unit_fixed_vector_input_param_values_tmp.begin() + j * Moose::dim + Moose::dim,
             " ");
     }
   }
 
   // Sanity check for the batch input parameters
   checkVectorParamAndMultiMooseEnumLength<std::string>("batch_scalar_input_param_names",
                                                        "batch_scalar_input_param_types");
   // The compound real scalar value type does not alter the length of
   // 'batch_scalar_input_param_values'
   checkVectorParamsSameLength<std::string, std::vector<std::string>>(
       "batch_scalar_input_param_names", "batch_scalar_input_param_values");
   // But we still need to process the affected elements
   for (const auto i : index_range(_batch_scalar_input_param_types))
   {
     if (isCompoundRealScalarType(_batch_scalar_input_param_types[i]))
     {
       // Ensure that each compound real scalar value is represented as Moose::dim Real values
       if (_batch_scalar_input_param_values[i].size() % Moose::dim != 0)
         paramError("batch_scalar_input_param_values",
                    "This parameter must have a size that is consistent with "
                    "batch_scalar_input_param_names. Note that each REALVECTORVALUE or POINT type "
                    "parameter must be represented as ",
                    std::to_string(Moose::dim),
                    " separate values instead of 1.");
       auto unit_batch_scalar_input_param_values_tmp(_batch_scalar_input_param_values[i]);
       _batch_scalar_input_param_values[i].resize(unit_batch_scalar_input_param_values_tmp.size() /
                                                  3);
       for (const auto j : index_range(_batch_scalar_input_param_values[i]))
         _batch_scalar_input_param_values[i][j] = MooseUtils::join(
             unit_batch_scalar_input_param_values_tmp.begin() + j * Moose::dim,
             unit_batch_scalar_input_param_values_tmp.begin() + j * Moose::dim + Moose::dim,
             " ");
     }
   }
 
   checkVectorParamAndMultiMooseEnumLength<std::string>("batch_vector_input_param_names",
                                                        "batch_vector_input_param_types");
   checkVectorParamsSameLength<std::string, std::vector<std::vector<std::string>>>(
       "batch_vector_input_param_names", "batch_vector_input_param_values");
   // But we still need to process the affected elements
   for (const auto i : index_range(_batch_vector_input_param_types))
   {
     if (isCompoundRealScalarType(_batch_vector_input_param_types[i]))
     {
       for (const auto j : index_range(_batch_vector_input_param_values[i]))
       {
         // Ensure that each compound real scalar value is represented as Moose::dim Real values
         if (_batch_vector_input_param_values[i][j].size() % Moose::dim != 0)
           paramError("batch_vector_input_param_values",
                      "This parameter must have a size that is consistent with "
                      "batch_vector_input_param_names. Note that each REALVECTORVALUE or POINT type "
                      "parameter must be represented as ",
                      Moose::dim,
                      " separate values instead of 1.");
         auto unit_batch_vector_input_param_values_tmp(_batch_vector_input_param_values[i][j]);
         _batch_vector_input_param_values[i][j].resize(
             unit_batch_vector_input_param_values_tmp.size() / 3);
         for (const auto k : index_range(_batch_vector_input_param_values[i][j]))
           _batch_vector_input_param_values[i][j][k] = MooseUtils::join(
               unit_batch_vector_input_param_values_tmp.begin() + k * Moose::dim,
               unit_batch_vector_input_param_values_tmp.begin() + k * Moose::dim + Moose::dim,
               " ");
       }
     }
   }
 
   // At least we want this action to create one mesh generator
   if (_batch_scalar_input_param_names.empty() && _batch_vector_input_param_names.empty())
     mooseError("BatchMeshGeneratorAction: " + _name +
                ", batch_scalar_input_param_names and batch_vector_input_param_names cannot be "
                "empty at the same time.");
 
   // If the previous check is passed, batch_params_sizes will not be empty
   // But we need to check if any element of the batch_params_values are empty
   std::set<unsigned int> batch_params_sizes;
   for (const auto & unit_batch_scalar_param_values : _batch_scalar_input_param_values)
   {
     if (unit_batch_scalar_param_values.empty())
       paramError("batch_scalar_input_param_values",
                  "this parameter cannot contain empty elements.");
     batch_params_sizes.emplace(unit_batch_scalar_param_values.size());
   }
   for (const auto & unit_batch_vector_param_values : _batch_vector_input_param_values)
   {
     if (unit_batch_vector_param_values.empty())
       paramError("batch_vector_input_param_values",
                  "this parameter cannot contain empty elements.");
     batch_params_sizes.emplace(unit_batch_vector_param_values.size());
   }
 
   // Then for the corresponding method, the sizes of the batch_params_values should be the same
   if (_multi_batch_params_method == MultiBatchParamsMethod::corresponding &&
       batch_params_sizes.size() > 1)
     mooseError("BatchMeshGeneratorAction: " + _name +
                ", elements of batch_scalar_input_param_values and batch_vector_input_param_values "
                "must have the same size in corresponding mode.");
 
   // Decomposed index cannot be used with the corresponding method
   if (_use_decomposed_index && _multi_batch_params_method == MultiBatchParamsMethod::corresponding)
     paramError("use_decomposed_index",
                "Decomposed index cannot be used with the corresponding method.");
   // Check the parameter types are given correctly here so that we do not need to do it when setting
   // the values.
   auto set_params = _app.getFactory().getValidParams(_mesh_generator_type);
   // batch scalar input parameters
   checkInputParametersTypes(set_params,
                             "batch_scalar_input_param_names",
                             _batch_scalar_input_param_names,
                             _batch_scalar_input_param_types);
   // fix scalar input parameters
   checkInputParametersTypes(set_params,
                             "fixed_scalar_input_param_names",
                             _fixed_scalar_input_param_names,
                             _fixed_scalar_input_param_types);
   // batch vector input parameters
   checkInputParametersTypes(set_params,
                             "batch_vector_input_param_names",
                             _batch_vector_input_param_names,
                             _batch_vector_input_param_types,
                             true);
   // fix vector input parameters
   checkInputParametersTypes(set_params,
                             "fixed_vector_input_param_names",
                             _fixed_vector_input_param_names,
                             _fixed_vector_input_param_types,
                             true);
 }

Member Function Documentation

◆ act()

void BatchMeshGeneratorAction::act ( )

finaloverridevirtual

Method to add objects to the simulation or perform other setup tasks.

Implements Action.

Definition at line 345 of file BatchMeshGeneratorAction.C.

 {
   if (_current_task == "add_mesh_generator")
     addMeshGenerators();
 }

◆ addMeshGenerators()

void BatchMeshGeneratorAction::addMeshGenerators ( )

protectedvirtual

Definition at line 352 of file BatchMeshGeneratorAction.C.

Referenced by act().

 {
   std::vector<std::vector<std::string>> processed_batch_scalar_input_param_values;
   std::vector<std::vector<std::vector<std::string>>> processed_batch_vector_input_param_values;
   // generate the decomposed indices for the cartesian product method
   std::vector<std::vector<unsigned int>> processed_batch_indices;
   if (_multi_batch_params_method == MultiBatchParamsMethod::corresponding)
   {
     processed_batch_scalar_input_param_values = _batch_scalar_input_param_values;
     processed_batch_vector_input_param_values = _batch_vector_input_param_values;
     if (_use_decomposed_index)
     {
       processed_batch_indices.push_back(std::vector<unsigned int>(
           processed_batch_vector_input_param_values.empty()
               ? processed_batch_scalar_input_param_values.front().size()
               : processed_batch_vector_input_param_values.front().size()));
       std::iota(processed_batch_indices.back().begin(), processed_batch_indices.back().end(), 0);
     }
   }
   else // cartesian_product
   {
     // We basically need to reconstruct the corresponding parameters based on the cartesian product
     // algorithm
     for (const auto i : index_range(_batch_scalar_input_param_values))
     {
       // For the first element, just copy the parameters
       if (processed_batch_scalar_input_param_values.empty())
       {
         processed_batch_scalar_input_param_values.push_back(_batch_scalar_input_param_values[i]);
         if (_use_decomposed_index)
         {
           processed_batch_indices.push_back(
               std::vector<unsigned int>(_batch_scalar_input_param_values[i].size()));
           std::iota(
               processed_batch_indices.back().begin(), processed_batch_indices.back().end(), 0);
         }
       }
       else
       {
         const unsigned int num_new_batch_params = _batch_scalar_input_param_values[i].size();
         const unsigned int num_processed_batch_params =
             processed_batch_scalar_input_param_values.front().size();
         // All the elements in the processed_batch_scalar_input_param_values need to be duplicated
         // for num_new_batch_params times
         for (auto & unit_processed_batch_scalar_input_param_values :
              processed_batch_scalar_input_param_values)
         {
           auto temp_params = unit_processed_batch_scalar_input_param_values;
           for (unsigned int j = 1; j < num_new_batch_params; j++)
           {
             unit_processed_batch_scalar_input_param_values.insert(
                 unit_processed_batch_scalar_input_param_values.end(),
                 temp_params.begin(),
                 temp_params.end());
           }
         }
         if (_use_decomposed_index)
         {
           // Same as the composed indices
           for (auto & unit_processed_batch_indices : processed_batch_indices)
           {
             auto temp_indices = unit_processed_batch_indices;
             for (unsigned int j = 1; j < num_new_batch_params; j++)
             {
               unit_processed_batch_indices.insert(
                   unit_processed_batch_indices.end(), temp_indices.begin(), temp_indices.end());
             }
           }
         }
 
         // Then, add a new element to the processed_batch_scalar_input_param_values by repeating
         // each element in _batch_scalar_input_param_values[i] for num_processed_batch_params times
         processed_batch_scalar_input_param_values.push_back({});
         for (const auto & unit_batch_scalar_input_param_values :
              _batch_scalar_input_param_values[i])
           for (unsigned int j = 0; j < num_processed_batch_params; j++)
             processed_batch_scalar_input_param_values.back().push_back(
                 unit_batch_scalar_input_param_values);
         if (_use_decomposed_index)
         {
           // Same as the composed indices
           processed_batch_indices.push_back({});
           for (const auto & unit_batch_scalar_input_param_values_index :
                index_range(_batch_scalar_input_param_values[i]))
             for (unsigned int j = 0; j < num_processed_batch_params; j++)
               processed_batch_indices.back().push_back(unit_batch_scalar_input_param_values_index);
         }
       }
     }
     for (const auto i : index_range(_batch_vector_input_param_values))
     {
       // For the first element, just copy the parameters
       if (processed_batch_vector_input_param_values.empty())
       {
         if (processed_batch_scalar_input_param_values.empty())
         {
           // if no batch scalar input parameters are used
           // we just need to initiate the processed_batch_vector_input_param_values as the first one
           // to fill
           processed_batch_vector_input_param_values.push_back(_batch_vector_input_param_values[i]);
           if (_use_decomposed_index)
           {
             processed_batch_indices.push_back(
                 std::vector<unsigned int>(_batch_vector_input_param_values[i].size()));
             std::iota(
                 processed_batch_indices.back().begin(), processed_batch_indices.back().end(), 0);
           }
         }
         else
         {
           processed_batch_vector_input_param_values.push_back({});
           // if there are batch scalar input parameters, then each element needs to be duplicated
           // for that amount of times
           for (const auto & unit_batch_vector_input_param_values :
                _batch_vector_input_param_values[i])
             for (unsigned int j = 0; j < processed_batch_scalar_input_param_values.front().size();
                  j++)
               processed_batch_vector_input_param_values.back().push_back(
                   unit_batch_vector_input_param_values);
           // Then the scalar input parameters need to be duplicated for the number of elements in
           // the processed_batch_vector_input_param_values
           for (auto & unit_processed_batch_scalar_input_param_values :
                processed_batch_scalar_input_param_values)
           {
             auto temp_params = unit_processed_batch_scalar_input_param_values;
             for (unsigned int j = 1; j < processed_batch_vector_input_param_values.back().size();
                  j++)
             {
               unit_processed_batch_scalar_input_param_values.insert(
                   unit_processed_batch_scalar_input_param_values.end(),
                   temp_params.begin(),
                   temp_params.end());
             }
           }
           if (_use_decomposed_index)
           {
             // Add the indices for the first batch vector input parameter
             processed_batch_indices.push_back({});
             for (const auto & unit_batch_vector_input_param_values_index :
                  index_range(_batch_vector_input_param_values[i]))
               for (unsigned int j = 0; j < processed_batch_indices.front().size(); j++)
                 processed_batch_indices.back().push_back(
                     unit_batch_vector_input_param_values_index);
             // Duplicate the indices for the batch scalar input parameters
             for (unsigned int k = 1; k < processed_batch_indices.size(); k++)
             {
               auto & unit_processed_batch_indices = processed_batch_indices[k - 1];
               auto temp_indices = unit_processed_batch_indices;
               for (unsigned int j = 1; j < _batch_vector_input_param_values[i].size(); j++)
               {
                 unit_processed_batch_indices.insert(
                     unit_processed_batch_indices.end(), temp_indices.begin(), temp_indices.end());
               }
             }
           }
         }
       }
       else
       {
         const unsigned int num_new_batch_params = _batch_vector_input_param_values[i].size();
         const unsigned int num_processed_batch_params =
             processed_batch_vector_input_param_values.front().size();
         // All the elements in the processed_batch_vector_input_param_values need to be duplicated
         // for num_new_batch_params times
         for (auto & unit_processed_batch_vector_input_param_values :
              processed_batch_vector_input_param_values)
         {
           auto temp_params = unit_processed_batch_vector_input_param_values;
           for (unsigned int j = 1; j < num_new_batch_params; j++)
           {
             unit_processed_batch_vector_input_param_values.insert(
                 unit_processed_batch_vector_input_param_values.end(),
                 temp_params.begin(),
                 temp_params.end());
           }
         }
         if (_use_decomposed_index)
         {
           // Same for the decomposed indices
           for (auto & unit_processed_batch_indices : processed_batch_indices)
           {
             auto temp_indices = unit_processed_batch_indices;
             for (unsigned int j = 1; j < num_new_batch_params; j++)
             {
               unit_processed_batch_indices.insert(
                   unit_processed_batch_indices.end(), temp_indices.begin(), temp_indices.end());
             }
           }
         }
         // if there are also batch scalar input parameters, it also needs to be duplicated
         for (auto & unit_processed_batch_scalar_input_param_values :
              processed_batch_scalar_input_param_values)
         {
           auto temp_params = unit_processed_batch_scalar_input_param_values;
           for (unsigned int j = 1; j < num_new_batch_params; j++)
           {
             unit_processed_batch_scalar_input_param_values.insert(
                 unit_processed_batch_scalar_input_param_values.end(),
                 temp_params.begin(),
                 temp_params.end());
           }
         }
         // Then, add a new element to the processed_batch_vector_input_param_values by repeating
         // each element in _batch_vector_input_param_values[i] for num_processed_batch_params times
         processed_batch_vector_input_param_values.push_back({});
         for (const auto & unit_batch_vector_input_param_values :
              _batch_vector_input_param_values[i])
           for (unsigned int j = 0; j < num_processed_batch_params; j++)
             processed_batch_vector_input_param_values.back().push_back(
                 unit_batch_vector_input_param_values);
         if (_use_decomposed_index)
         {
           // Same for the decomposed indices
           processed_batch_indices.push_back({});
           for (const auto & unit_batch_vector_input_param_values_index :
                index_range(_batch_vector_input_param_values[i]))
             for (unsigned int j = 0; j < num_processed_batch_params; j++)
               processed_batch_indices.back().push_back(unit_batch_vector_input_param_values_index);
         }
       }
     }
   }
 
   // Now, we can add the mesh generators by looping through the processed params
   const unsigned int num_batch_params =
       processed_batch_vector_input_param_values.empty()
           ? processed_batch_scalar_input_param_values.front().size()
           : processed_batch_vector_input_param_values.front().size();
   for (const auto i : make_range(num_batch_params))
   {
     auto params = _app.getFactory().getValidParams(_mesh_generator_type);
     for (const auto j : index_range(_batch_scalar_input_param_values))
       setScalarParams(params,
                       _batch_scalar_input_param_names[j],
                       _batch_scalar_input_param_types[j],
                       processed_batch_scalar_input_param_values[j][i]);
     for (const auto j : index_range(_batch_vector_input_param_values))
       setVectorParams(params,
                       _batch_vector_input_param_names[j],
                       _batch_vector_input_param_types[j],
                       processed_batch_vector_input_param_values[j][i]);
     for (const auto j : index_range(_fixed_scalar_input_param_names))
       setScalarParams(params,
                       _fixed_scalar_input_param_names[j],
                       _fixed_scalar_input_param_types[j],
                       _fixed_scalar_input_param_values[j]);
     for (const auto j : index_range(_fixed_vector_input_param_names))
       setVectorParams(params,
                       _fixed_vector_input_param_names[j],
                       _fixed_vector_input_param_types[j],
                       _fixed_vector_input_param_values[j]);
 
     std::string mesh_index;
     if (_use_decomposed_index)
       for (const auto & process_batch_index : processed_batch_indices)
         mesh_index += '_' + std::to_string(process_batch_index[i]);
     else
       mesh_index = "_" + std::to_string(i);
 
     _app.getMeshGeneratorSystem().addMeshGenerator(
         _mesh_generator_type, _mesh_name_prefix + mesh_index, params);
   }
 }

◆ addRelationshipManagers() [1/2]

bool Action::addRelationshipManagers	(	Moose::RelationshipManagerType	when_type,
		const InputParameters &	moose_object_pars
	)

protectedinherited

Method to add a relationship manager for the objects being added to the system.

Relationship managers have to be added relatively early. In many cases before the Action::act() method is called.

Parameters

when_type	The parameter indicating the normal time for adding either Geometric or Algebraic RelationshipManagers. It may not always be possible to add your RelationshipManager as early as you'd like. In these cases, your DistributedMesh may consume more memory during the problem setup.
moose_object_pars	The MooseObject to inspect for RelationshipManagers to add

Returns: Whether a relationship manager was added

Definition at line 130 of file Action.C.

Referenced by CouplingFunctorCheckAction::act(), and PhysicsBase::addRelationshipManagers().

 {
   const auto & buildable_types = moose_object_pars.getBuildableRelationshipManagerTypes();
 
   bool added = false;
 
   for (const auto & buildable_type : buildable_types)
   {
     auto & rm_name = std::get<0>(buildable_type);
     auto & rm_type = std::get<1>(buildable_type);
     auto rm_input_parameter_func = std::get<2>(buildable_type);
 
     added = addRelationshipManager(
                 input_rm_type, moose_object_pars, rm_name, rm_type, rm_input_parameter_func) ||
             added;
   }
 
   return added;
 }

◆ addRelationshipManagers() [2/2]

void Action::addRelationshipManagers ( Moose::RelationshipManagerType when_type )

virtualinherited

Method to add a relationship manager for the objects being added to the system.

Relationship managers have to be added relatively early. In many cases before the Action::act() method is called.

Parameters

when_type The parameter indicating the normal time for adding either Geometric or Algebraic RelationshipManagers. It may not always be possible to add your RelationshipManager as early as you'd like. In these cases, your DistributedMesh may consume more memory during the problem setup.

Reimplemented in PhysicsBase, ProjectedStatefulMaterialStorageAction, AddActionComponentAction, and MooseObjectAction.

Definition at line 125 of file Action.C.

126 {

127 }

◆ appendTask()

void Action::appendTask ( const std::string & task )

inlineinherited

Definition at line 107 of file Action.h.

107 { _all_tasks.insert(task); }

Action::_all_tasks

std::set< std::string > _all_tasks

A list of all the tasks that this Action will satisfy.

Definition: Action.h:159

◆ assertParamDefined() [1/2]

void InputParametersChecksUtils< BatchMeshGeneratorAction >::assertParamDefined ( const std::string & param ) const

protectedinherited

Check in debug mode that this parameter has been added to the validParams.

Parameters

param parameter that should be defined

◆ assertParamDefined() [2/2]

void InputParametersChecksUtils< BatchMeshGeneratorAction >::assertParamDefined ( const std::string & libmesh_dbg_varparam ) const

inherited

Definition at line 206 of file InputParametersChecksUtils.h.

 {
   mooseAssert(forwardParameters().template have_parameter<T>(param),
               "Parameter '" + param + "' is not defined with type '" +
                   MooseUtils::prettyCppType<T>() + "' in object type '" +
                   MooseUtils::prettyCppType(forwardType()) + "'. Check your code.");
 }

◆ associateWithParameter() [1/2]

void Action::associateWithParameter	(	const std::string &	param_name,
		InputParameters &	params
	)		const

protectedinherited

Associates the object's parameters params with the input location from this Action's parameter with the name param_name, if one exists.

For example, you have a parameter in this action of type bool with name "add_mesh". You then add an action within this action that creates a mesh if this param is true. If you call associateWithParameter("add_mesh", action_params) where action_params are the parameters for the action, we then associate that action with the "add_mesh" parameter. Therefore, the resulting created mesh will also be associated with the "add_mesh" param and any errors that are non-parameter errors (i.e., mooseError/mooseWarning) will have the line context of the "add_mesh" parameter in this action. The same goes for any errors that are produce within the created action.

Definition at line 152 of file Action.C.

Referenced by CommonOutputAction::create(), AddVariableAction::createInitialConditionAction(), CreateExecutionerAction::setupAutoPreconditioning(), and ReadExecutorParamsAction::setupAutoPreconditioning().

 {
   associateWithParameter(parameters(), param_name, params);
 }

◆ associateWithParameter() [2/2]

void Action::associateWithParameter	(	const InputParameters &	from_params,
		const std::string &	param_name,
		InputParameters &	params
	)		const

protectedinherited

The same as associateWithParameter() without from_params, but instead allows you to associate this with another object's parameters instead of the parameters from this action.

An example here is when you want to associate the creation of an action with an argument from the application.

Definition at line 158 of file Action.C.

 {
   const auto to_hit_node = params.getHitNode();
   if (!to_hit_node || to_hit_node->isRoot())
   {
     if (const auto hit_node = from_params.getHitNode(param_name))
       params.setHitNode(*hit_node, {});
     else if (const auto hit_node = from_params.getHitNode())
       params.setHitNode(*hit_node, {});
   }
 }

◆ callMooseError() [1/2]

void MooseBase::callMooseError	(	std::string	msg,
		const bool	with_prefix,
		const hit::Node *	node = `nullptr`
	)		const

inherited

External method for calling moose error with added object context.

Parameters

msg	The message
with_prefix	If true, add the prefix from messagePrefix(), which is the object information (type, name, etc)
node	Optional hit node to add file path context as a prefix

Definition at line 102 of file MooseBase.C.

Referenced by InputParameters::callMooseError(), MooseBase::mooseDocumentedError(), MooseBase::mooseError(), and MooseBase::mooseErrorNonPrefixed().

 {
   callMooseError(&_app, _pars, msg, with_prefix, node);
 }

◆ callMooseError() [2/2]

void MooseBase::callMooseError	(	MooseApp *const	app,
		const InputParameters &	params,
		std::string	msg,
		const bool	with_prefix,
		const hit::Node *	node
	)

staticinherited

External method for calling moose error with added object context.

Needed so that objects without the MooseBase context (InputParameters) can call errors with context

Parameters

app	The app pointer (if available); adds multiapp context and clears the console
params	The parameters, needed to obtain object information
msg	The message
with_prefix	If true, add the prefix from messagePrefix(), which is the object information (type, name, etc)
node	Optional hit node to add file path context as a prefix

Definition at line 110 of file MooseBase.C.

 {
   if (!node)
     node = MooseBase::getHitNode(params);
 
   std::string multiapp_prefix = "";
   if (app)
   {
     if (!app->isUltimateMaster())
       multiapp_prefix = app->name();
     app->getOutputWarehouse().mooseConsole();
   }
 
   if (with_prefix)
     // False here because the hit context will get processed by the node
     msg = messagePrefix(params, false) + msg;
 
   moose::internal::mooseErrorRaw(msg, multiapp_prefix, node);
 }

◆ checkBlockwiseConsistency()

void InputParametersChecksUtils< BatchMeshGeneratorAction >::checkBlockwiseConsistency	(	const std::string &	block_param_name,
		const std::vector< std::string > &	parameter_names
	)		const

protectedinherited

Check if the user commited errors during the definition of block-wise parameters.

Parameters

block_param_name	the name of the parameter that provides the groups of blocks
parameter_names	vector of the names of the parameters that are defined on a per-block basis

Definition at line 483 of file InputParametersChecksUtils.h.

 {
   const std::vector<std::vector<SubdomainName>> & block_names =
       forwardGetParam<std::vector<std::vector<SubdomainName>>>(block_param_name);
 
   if (block_names.size())
   {
     // We only check block-restrictions if the customer class is not restricted to `ANY_BLOCK_ID`.
     // If the users define blocks that are not on the mesh, they will receive errors from the
     // objects created by the customer class
     const auto & object_blocks = forwardBlocks();
     if (std::find(object_blocks.begin(), object_blocks.end(), "ANY_BLOCK_ID") ==
         object_blocks.end())
       for (const auto & block_group : block_names)
         for (const auto & block : block_group)
           if (std::find(object_blocks.begin(), object_blocks.end(), block) == object_blocks.end())
             forwardParamError(block_param_name,
                               "Block '" + block + "' is not present in the block restriction of " +
                                   forwardName() +
                                   "!\nBlock restriction: " + Moose::stringify(object_blocks));
 
     for (const auto & param_name : parameter_names)
     {
       const std::vector<T> & param_vector = forwardGetParam<std::vector<T>>(param_name);
       if (block_names.size() != param_vector.size())
         forwardParamError(param_name,
                           "The number of entries in '" + param_name + "' (" +
                               std::to_string(param_vector.size()) +
                               ") is not the same as the number of blocks"
                               " (" +
                               std::to_string(block_names.size()) + ") in '" + block_param_name +
                               "'!");
     }
   }
   else
   {
     unsigned int previous_size = 0;
     for (const auto param_i : index_range(parameter_names))
     {
       const std::vector<T> & param_vector =
           forwardGetParam<std::vector<T>>(parameter_names[param_i]);
       if (param_i == 0)
       {
         if (param_vector.size() > 1)
           forwardParamError(parameter_names[param_i],
                             "The user should only use one or zero entries in " +
                                 parameter_names[param_i] + " if " + block_param_name +
                                 " not defined!");
         previous_size = param_vector.size();
       }
       else
       {
         if (previous_size != param_vector.size())
           forwardParamError(parameter_names[param_i],
                             "The number of entries in '" + parameter_names[param_i] +
                                 "' is not the same as the number of entries in '" +
                                 parameter_names[param_i - 1] + "'!");
       }
     }
   }
 }

◆ checkInputParametersTypes()

void BatchMeshGeneratorAction::checkInputParametersTypes	(	const InputParameters &	params,
		const std::string &	action_input_param_name,
		const std::vector< std::string > &	param_names,
		const std::vector< ParameterType > &	param_types,
		const bool &	is_vector = `false`
	)		const

protected

Check the types of the input parameters are valid, otherwise throw an error.

Parameters

params	InputParameters object to check the parameters
action_input_param_name	Name of the action input parameter used for error message
param_names	Names of the parameters to check
param_types	Types of the parameters to check
is_vector	Flag to indicate if the parameters are vectors

Definition at line 832 of file BatchMeshGeneratorAction.C.

Referenced by BatchMeshGeneratorAction().

 {
   for (const auto i : index_range(param_names))
   {
     switch (param_types[i])
     {
       case (ParameterType::REAL):
         checkInputParameterType<Real>(params, action_input_param_name, param_names[i], is_vector);
         break;
       case (ParameterType::SHORT):
         checkInputParameterType<short>(params, action_input_param_name, param_names[i], is_vector);
         break;
       case (ParameterType::USHORT):
         checkInputParameterType<unsigned short>(
             params, action_input_param_name, param_names[i], is_vector);
         break;
       case (ParameterType::INT):
         checkInputParameterType<int>(params, action_input_param_name, param_names[i], is_vector);
         break;
       case (ParameterType::UINT):
         checkInputParameterType<unsigned int>(
             params, action_input_param_name, param_names[i], is_vector);
         break;
       case (ParameterType::LONG):
         checkInputParameterType<long>(params, action_input_param_name, param_names[i], is_vector);
         break;
       case (ParameterType::ULONG):
         checkInputParameterType<unsigned long>(
             params, action_input_param_name, param_names[i], is_vector);
         break;
       case (ParameterType::LONGLONG):
         checkInputParameterType<long long>(
             params, action_input_param_name, param_names[i], is_vector);
         break;
       case (ParameterType::ULONGLONG):
         checkInputParameterType<unsigned long long>(
             params, action_input_param_name, param_names[i], is_vector);
         break;
       case (ParameterType::DOFIDTYPE):
         checkInputParameterType<dof_id_type>(
             params, action_input_param_name, param_names[i], is_vector);
         break;
       case (ParameterType::BDRYIDTYPE):
         checkInputParameterType<boundary_id_type>(
             params, action_input_param_name, param_names[i], is_vector);
         break;
       case (ParameterType::SDIDTYPE):
         checkInputParameterType<subdomain_id_type>(
             params, action_input_param_name, param_names[i], is_vector);
         break;
       case (ParameterType::ENUM):
         if (is_vector)
           checkInputParameterType<MultiMooseEnum>(
               params, action_input_param_name, param_names[i], false);
         else
           checkInputParameterType<MooseEnum>(
               params, action_input_param_name, param_names[i], false);
         break;
       case (ParameterType::STRING):
         checkInputParameterType<std::string>(
             params, action_input_param_name, param_names[i], is_vector);
         break;
       case (ParameterType::SDNAME):
         checkInputParameterType<SubdomainName>(
             params, action_input_param_name, param_names[i], is_vector);
         break;
       case (ParameterType::BDRYNAME):
         checkInputParameterType<BoundaryName>(
             params, action_input_param_name, param_names[i], is_vector);
         break;
       case (ParameterType::MGNAME):
         checkInputParameterType<MeshGeneratorName>(
             params, action_input_param_name, param_names[i], is_vector);
         break;
       case (ParameterType::MFNAME):
         checkInputParameterType<MeshFileName>(
             params, action_input_param_name, param_names[i], is_vector);
         break;
       case (ParameterType::BOOL):
         checkInputParameterType<bool>(params, action_input_param_name, param_names[i], is_vector);
         break;
       case (ParameterType::REALVECTORVALUE):
         checkInputParameterType<RealVectorValue>(
             params, action_input_param_name, param_names[i], is_vector);
         break;
       case (ParameterType::POINT):
         checkInputParameterType<Point>(params, action_input_param_name, param_names[i], is_vector);
         break;
       default:
         mooseAssert(
             false,
             "impossible situation."); // as we use MultiMooseEnum to ensure the type is valid
     }
   }
 }

◆ checkInputParameterType()

template<typename T >

void BatchMeshGeneratorAction::checkInputParameterType	(	const InputParameters &	params,
		const std::string &	action_input_param_name,
		const std::string &	param_name,
		const bool &	is_vector
	)		const

protected

Check the type of the input parameter is valid, otherwise throw an error.

Parameters

params	InputParameters object to check the parameter
action_input_param_name	Name of the action input parameter used for error message
param_name	Name of the parameter to check
is_vector	Flag to indicate if the parameter is a vector

Definition at line 934 of file BatchMeshGeneratorAction.C.

 {
   if ((is_vector && !params.isType<std::vector<T>>(param_name)) ||
       (!is_vector && !params.isType<T>(param_name)))
     paramError(action_input_param_name,
                "the input parameter, " + param_name + ", has the wrong type. It should be " +
                    params.type(param_name) + ".");
 }

◆ checkParamsBothSetOrNotSet()

void InputParametersChecksUtils< BatchMeshGeneratorAction >::checkParamsBothSetOrNotSet	(	const std::string &	param1,
		const std::string &	param2
	)		const

protectedinherited

Check that two parameters are either both set or both not set.

Parameters

param1	first parameter to check
param2	second parameter to check

Definition at line 592 of file InputParametersChecksUtils.h.

 {
   if ((forwardIsParamValid(param1) + forwardIsParamValid(param2)) % 2 != 0)
     forwardParamError(param1,
                       "Parameters '" + param1 + "' and '" + param2 +
                           "' must be either both set or both not set.");
 }

◆ checkSecondParamNotSetIfFirstOneSet()

void InputParametersChecksUtils< BatchMeshGeneratorAction >::checkSecondParamNotSetIfFirstOneSet	(	const std::string &	param1,
		const std::string &	param2
	)		const

protectedinherited

Check that a parameter is not set if the first one is set.

Parameters

param1	first parameter to check, check that the second is not if this one is set
param2	second parameter to check, that should not be set if first one is set

Definition at line 628 of file InputParametersChecksUtils.h.

 {
   if (forwardIsParamSetByUser(param1) && forwardIsParamSetByUser(param2))
     forwardParamError(param2,
                       "Parameter '" + param2 + "' should not be specified if parameter '" + param1 +
                           "' is specified.");
 }

◆ checkSecondParamSetOnlyIfFirstOneSet()

void InputParametersChecksUtils< BatchMeshGeneratorAction >::checkSecondParamSetOnlyIfFirstOneSet	(	const std::string &	param1,
		const std::string &	param2
	)		const

protectedinherited

Check that a parameter is set only if the first one is set.

Parameters

param1	first parameter to check, check the second if set
param2	second parameter to check, that should be set if first one is set

Definition at line 617 of file InputParametersChecksUtils.h.

 {
   if (!forwardIsParamSetByUser(param1) && forwardIsParamSetByUser(param2))
     forwardParamError(param2,
                       "Parameter '" + param2 + "' should not be set if parameter '" + param1 +
                           "' is not specified.");
 }

◆ checkSecondParamSetOnlyIfFirstOneTrue()

void InputParametersChecksUtils< BatchMeshGeneratorAction >::checkSecondParamSetOnlyIfFirstOneTrue	(	const std::string &	param1,
		const std::string &	param2
	)		const

protectedinherited

Check that a parameter is set only if the first one is set to true.

Parameters

param1	first parameter to check, check the second if true
param2	second parameter to check, that should be set if first one is true

Definition at line 603 of file InputParametersChecksUtils.h.

 {
   mooseAssert(forwardParameters().template have_parameter<bool>(param1),
               "Cannot check if parameter " + param1 +
                   " is true if it's not a bool parameter of this object");
   if (!forwardGetParam<bool>(param1) && forwardIsParamSetByUser(param2))
     forwardParamError(param2,
                       "Parameter '" + param1 + "' cannot be set to false if parameter '" + param2 +
                           "' is set by the user");
 }

◆ checkTwoDVectorParamInnerSameLengthAsOneDVector()

void InputParametersChecksUtils< BatchMeshGeneratorAction >::checkTwoDVectorParamInnerSameLengthAsOneDVector	(	const std::string &	param1,
		const std::string &	param2
	)		const

protectedinherited

Check that each inner vector of a two-D vector parameter are the same size as another one-D vector parameter.

Parameters

param1	two-D vector parameter to check the dimensions of
param2	one-D vector parameter to set the desired size

Definition at line 296 of file InputParametersChecksUtils.h.

 {
   assertParamDefined<std::vector<std::vector<T>>>(param1);
   assertParamDefined<std::vector<S>>(param2);
   for (const auto & sub_vec_i : index_range(forwardGetParam<std::vector<std::vector<T>>>(param1)))
   {
     const auto size_1 = forwardGetParam<std::vector<std::vector<T>>>(param1)[sub_vec_i].size();
     const auto size_2 = forwardGetParam<std::vector<S>>(param2).size();
     if (size_1 != size_2)
       forwardParamError(param1,
                         "Vector at index " + std::to_string(sub_vec_i) + " (size " +
                             std::to_string(size_1) +
                             ") "
                             " of this parameter should be the same length as parameter '" +
                             param2 + "' (size " + std::to_string(size_2) + ")");
   }
 }

◆ checkTwoDVectorParamMultiMooseEnumSameLength()

void InputParametersChecksUtils< BatchMeshGeneratorAction >::checkTwoDVectorParamMultiMooseEnumSameLength	(	const std::string &	param1,
		const std::string &	param2,
		const bool	error_for_param2
	)		const

protectedinherited

Check that the size of a two-D vector parameter matches the size of a MultiMooseEnum parameter.

Parameters

param1	two-D vector parameter to check the unrolled size of
param2	MultiMooseEnum parameter to set the desired size

Definition at line 318 of file InputParametersChecksUtils.h.

 {
   assertParamDefined<std::vector<std::vector<T>>>(param1);
   assertParamDefined<MultiMooseEnum>(param2);
   const auto vec1 = forwardGetParam<std::vector<std::vector<T>>>(param1);
   const auto enum2 = forwardGetParam<MultiMooseEnum>(param2);
   const auto size_1 = vec1.empty() ? 0 : vec1.size() * vec1[0].size();
   const auto size_2 = enum2.size();
   if (size_1 != size_2)
   {
     if (error_for_param2)
       forwardParamError(param2,
                         "Vector enumeration parameter (size " + std::to_string(size_2) +
                             ") is not the same size as the vector of vector parameter '" + param1 +
                             "' (size " + std::to_string(size_1) + ")");
     else
       forwardParamError(param1,
                         "Vector of vector parameter '" + param1 + "' (total size " +
                             std::to_string(size_1) +
                             ") is not the same size as vector-enumeration parameter '" + param2 +
                             "' (size " + std::to_string(size_2) + ")");
   }
 }

◆ checkTwoDVectorParamsNoRespectiveOverlap()

void InputParametersChecksUtils< BatchMeshGeneratorAction >::checkTwoDVectorParamsNoRespectiveOverlap ( const std::vector< std::string > & param_vecs ) const

protectedinherited

Check that there is no overlap between the respective items in each vector of the two-D parameters Each vector of the two-D vector parameter should also have unique items.

Parameters

param_vecs vector of parameters that should not overlap with each other

Definition at line 395 of file InputParametersChecksUtils.h.

 {
   // Outer loop, each param is the name of a parameter for a vector of vectors
   for (const auto & param : param_vec)
   {
     assertParamDefined<std::vector<std::vector<T>>>(param);
     const auto & twoD_vec = forwardGetParam<std::vector<std::vector<T>>>(param);
     std::vector<std::set<T>> unique_params(twoD_vec.size());
 
     // Loop over each outer vector and compare the inner vectors respectively to other parameters
     for (const auto i : index_range(twoD_vec))
     {
       for (const auto & value : twoD_vec[i])
         if (!unique_params[i].insert(value).second)
         {
           auto copy_params = param_vec;
           copy_params.erase(std::find(copy_params.begin(), copy_params.end(), param));
           forwardMooseError("Item '" + value + "' specified in vector parameter '" + param +
                             "' is also present in one or more of the two-D vector parameters '" +
                             Moose::stringify(copy_params) +
                             "' in the inner vector of the same index, which is not allowed.");
         }
     }
   }
 }

◆ checkTwoDVectorParamsSameLength()

void InputParametersChecksUtils< BatchMeshGeneratorAction >::checkTwoDVectorParamsSameLength	(	const std::string &	param1,
		const std::string &	param2
	)		const

protectedinherited

Check that the two-D vectors have exactly the same length in both dimensions.

Parameters

param1	first two-D vector parameter to check the dimensions of
param2	second two-D vector parameter to check the dimensions of

Definition at line 269 of file InputParametersChecksUtils.h.

 {
   checkVectorParamsSameLength<std::vector<T>, std::vector<S>>(param1, param2);
   if (forwardIsParamValid(param1) && forwardIsParamValid(param2))
   {
     const auto value1 = forwardGetParam<std::vector<std::vector<T>>>(param1);
     const auto value2 = forwardGetParam<std::vector<std::vector<S>>>(param2);
     for (const auto index : index_range(value1))
       if (value1[index].size() != value2[index].size())
         forwardParamError(
             param1,
             "Vector at index " + std::to_string(index) + " of 2D vector parameter '" + param1 +
                 "' is not the same size as its counterpart from 2D vector parameter '" + param2 +
                 "'.\nSize first vector: " + std::to_string(value1[index].size()) +
                 "\nSize second vector: " + std::to_string(value2[index].size()));
   }
   // handle empty vector defaults
   else if (forwardIsParamValid(param1) || forwardIsParamValid(param2))
     if (forwardGetParam<std::vector<T>>(param1).size() ||
         forwardGetParam<std::vector<T>>(param2).size())
       checkParamsBothSetOrNotSet(param1, param2);
 }

◆ checkVectorParamAndMultiMooseEnumLength()

void InputParametersChecksUtils< BatchMeshGeneratorAction >::checkVectorParamAndMultiMooseEnumLength	(	const std::string &	param1,
		const std::string &	param2
	)		const

protectedinherited

Check that this vector parameter (with name defined in param1) has the same length as the MultiMooseEnum (with name defined in param2)

Parameters

param1	vector parameter to compare the size of
param2	multiMooseEnum parameter to compare the size of

Definition at line 243 of file InputParametersChecksUtils.h.

 {
   assertParamDefined<std::vector<T>>(param1);
   assertParamDefined<MultiMooseEnum>(param2);
 
   if (forwardIsParamValid(param1) && forwardIsParamValid(param2))
   {
     const auto size_1 = forwardGetParam<std::vector<T>>(param1).size();
     const auto size_2 = forwardGetParam<MultiMooseEnum>(param2).size();
     if (size_1 != size_2)
       forwardParamError(param1,
                         "Vector parameters '" + param1 + "' (size " + std::to_string(size_1) +
                             ") and '" + param2 + "' (size " + std::to_string(size_2) +
                             ") must be the same size");
   }
   // handle empty vector defaults
   else if (forwardIsParamValid(param1) || forwardIsParamValid(param2))
     if (forwardGetParam<std::vector<T>>(param1).size() ||
         forwardGetParam<MultiMooseEnum>(param2).size())
       checkParamsBothSetOrNotSet(param1, param2);
 }

◆ checkVectorParamLengthSameAsCombinedOthers()

void InputParametersChecksUtils< BatchMeshGeneratorAction >::checkVectorParamLengthSameAsCombinedOthers	(	const std::string &	param1,
		const std::string &	param2,
		const std::string &	param3
	)		const

protectedinherited

Check that a vector parameter is the same length as two others combined.

Parameters

param1	vector parameter that provides the target size
param2	vector parameter that provides one term in the combined size
param3	vector parameter that provides one term in the combined size

Definition at line 346 of file InputParametersChecksUtils.h.

 {
   assertParamDefined<std::vector<T>>(param1);
   assertParamDefined<std::vector<S>>(param2);
   assertParamDefined<std::vector<U>>(param3);
   const auto size_1 = forwardGetParam<std::vector<T>>(param1).size();
   const auto size_2 = forwardGetParam<std::vector<S>>(param2).size();
   const auto size_3 = forwardGetParam<std::vector<U>>(param3).size();
 
   if (size_1 != size_2 + size_3)
     forwardParamError(param1,
                       "Vector parameter '" + param1 + "' (size " + std::to_string(size_1) +
                           ") should be the same size as parameter '" + param2 + "' and '" + param3 +
                           " combined (total size " + std::to_string(size_2 + size_3) + ")");
 }

◆ checkVectorParamNotEmpty()

void InputParametersChecksUtils< BatchMeshGeneratorAction >::checkVectorParamNotEmpty ( const std::string & param1 ) const

protectedinherited

Check that the user did not pass an empty vector.

Parameters

param1 vector parameter that should not be empty

Definition at line 425 of file InputParametersChecksUtils.h.

 {
   assertParamDefined<std::vector<T>>(param);
   if (!forwardGetParam<std::vector<T>>(param).size())
     forwardParamError(param, "Parameter '" + param + "' should not be set to an empty vector.");
 }

◆ checkVectorParamsNoOverlap()

void InputParametersChecksUtils< BatchMeshGeneratorAction >::checkVectorParamsNoOverlap ( const std::vector< std::string > & param_vecs ) const

protectedinherited

Check that there is no overlap between the items in each vector parameters Each vector parameter should also have unique items.

Parameters

param_vecs vector of parameters that should not overlap with each other

Definition at line 366 of file InputParametersChecksUtils.h.

 {
   std::set<std::string> unique_params;
   for (const auto & param : param_vec)
   {
     assertParamDefined<std::vector<T>>(param);
 
     for (const auto & value : forwardGetParam<std::vector<T>>(param))
       if (!unique_params.insert(value).second)
       {
         auto copy_params = param_vec;
         copy_params.erase(std::find(copy_params.begin(), copy_params.end(), param));
         // Overlap between multiple vectors of parameters
         if (copy_params.size())
           forwardMooseError("Item '" + value + "' specified in vector parameter '" + param +
                             "' is also present in one or more of the parameters '" +
                             Moose::stringify(copy_params) + "', which is not allowed.");
         // Overlap within a single vector parameter caused by a repeated item
         else
           forwardMooseError("Item '" + value + "' specified in vector parameter '" + param +
                             "' is repeated, which is not allowed.");
       }
   }
 }

◆ checkVectorParamsSameLength()

void InputParametersChecksUtils< BatchMeshGeneratorAction >::checkVectorParamsSameLength	(	const std::string &	param1,
		const std::string &	param2
	)		const

protectedinherited

Check that the two vector parameters are of the same length.

Parameters

param1	first vector parameter to compare the size of
param2	second vector parameter to compare the size of

Definition at line 217 of file InputParametersChecksUtils.h.

 {
   assertParamDefined<std::vector<T>>(param1);
   assertParamDefined<std::vector<S>>(param2);
 
   if (forwardIsParamValid(param1) && forwardIsParamValid(param2))
   {
     const auto size_1 = forwardGetParam<std::vector<T>>(param1).size();
     const auto size_2 = forwardGetParam<std::vector<S>>(param2).size();
     if (size_1 != size_2)
       forwardParamError(param1,
                         "Vector parameters '" + param1 + "' (size " + std::to_string(size_1) +
                             ") and '" + param2 + "' (size " + std::to_string(size_2) +
                             ") must be the same size");
   }
   // handle empty vector defaults
   else if (forwardIsParamValid(param1) || forwardIsParamValid(param2))
     if (forwardGetParam<std::vector<T>>(param1).size() ||
         forwardGetParam<std::vector<T>>(param2).size())
       checkParamsBothSetOrNotSet(param1, param2);
 }

◆ checkVectorParamsSameLengthIfSet()

void InputParametersChecksUtils< BatchMeshGeneratorAction >::checkVectorParamsSameLengthIfSet	(	const std::string &	param1,
		const std::string &	param2,
		const bool	ignore_empty_default_param2 = `false`
	)		const

protectedinherited

Check that two vector parameters are the same length if both are set.

Parameters

param1	first vector parameter to check the size of
param2	second vector parameter to check the size of

Definition at line 435 of file InputParametersChecksUtils.h.

 {
   assertParamDefined<std::vector<T>>(param1);
   assertParamDefined<std::vector<S>>(param2);
 
   if (forwardIsParamValid(param1) && forwardIsParamValid(param2))
   {
     const auto size_1 = forwardGetParam<std::vector<T>>(param1).size();
     const auto size_2 = forwardGetParam<std::vector<S>>(param2).size();
     if (ignore_empty_default_param2 && (size_2 == 0) && !forwardIsParamSetByUser(param2))
       return;
     if (size_1 != size_2)
       forwardParamError(param1,
                         "Parameter '" + param1 + "' (size " + std::to_string(size_1) + ") and '" +
                             param2 + "' (size " + std::to_string(size_2) +
                             ") must be the same size if set.");
   }
 }

◆ connectControllableParams()

void MooseBase::connectControllableParams	(	const std::string &	parameter,
		const std::string &	object_type,
		const std::string &	object_name,
		const std::string &	object_parameter
	)		const

inherited

Connect controllable parameter of this action with the controllable parameters of the objects added by this action.

Parameters

parameter	Name of the controllable parameter of this action
object_type	Type of the object added by this action.
object_name	Name of the object added by this action.
object_parameter	Name of the parameter of the object.

Definition at line 74 of file MooseBase.C.

 {
   auto & factory = _app.getFactory();
   auto & ip_warehouse = _app.getInputParameterWarehouse();
 
   MooseObjectParameterName primary_name(uniqueName(), parameter);
   const auto base_type = factory.getValidParams(object_type).getBase();
   MooseObjectParameterName secondary_name(base_type, object_name, object_parameter);
   ip_warehouse.addControllableParameterConnection(primary_name, secondary_name);
 
   const auto & tags = _pars.get<std::vector<std::string>>("control_tags");
   for (const auto & tag : tags)
   {
     if (!tag.empty())
     {
       // Only adds the parameter with the different control tags if the derived class
       // properly registers the parameter to its own syntax
       MooseObjectParameterName tagged_name(tag, name(), parameter);
       ip_warehouse.addControllableParameterConnection(
           tagged_name, secondary_name, /*error_on_empty=*/false);
     }
   }
 }

◆ convertAndSetCompoundRealScalarVector()

template<typename T >

void BatchMeshGeneratorAction::convertAndSetCompoundRealScalarVector	(	InputParameters &	params,
		const std::string &	param_name,
		const std::vector< std::string > &	param_value
	)		const

protected

Convert a vector of strings to a compound real scalar type vector and set it in the InputParameters object.

Parameters

params	InputParameters object to set the parameter
param_name	Name of the parameter to set
param_value	Value of the parameter to set in string format

Definition at line 802 of file BatchMeshGeneratorAction.C.

 {
   std::vector<T> values(param_value.size());
   std::transform(param_value.begin(),
                  param_value.end(),
                  values.begin(),
                  [this](const std::string & val)
                  { return convertStringToCompoundRealScalar<T>(val); });
   params.set<std::vector<T>>(param_name) = values;
 }

◆ convertAndSetNumericVector()

template<typename T >

void BatchMeshGeneratorAction::convertAndSetNumericVector	(	InputParameters &	params,
		const std::string &	param_name,
		const std::vector< std::string > &	param_value
	)		const

protected

Convert a vector of strings to a numeric vector and set it in the InputParameters object.

Parameters

params	InputParameters object to set the parameter
param_name	Name of the parameter to set
param_value	Value of the parameter to set in string format

Definition at line 787 of file BatchMeshGeneratorAction.C.

 {
   std::vector<T> values(param_value.size());
   std::transform(param_value.begin(),
                  param_value.end(),
                  values.begin(),
                  [](const std::string & val) { return MooseUtils::convert<T>(val); });
   params.set<std::vector<T>>(param_name) = values;
 }

◆ convertAndSetStringLikeVector()

template<typename T >

void BatchMeshGeneratorAction::convertAndSetStringLikeVector	(	InputParameters &	params,
		const std::string &	param_name,
		const std::vector< std::string > &	param_value
	)		const

protected

Convert a vector of strings to a string-derived type vector and set it in the InputParameters object.

Parameters

params	InputParameters object to set the parameter
param_name	Name of the parameter to set
param_value	Value of the parameter to set in string format

Definition at line 818 of file BatchMeshGeneratorAction.C.

 {
   std::vector<T> values(param_value.size());
   std::transform(param_value.begin(),
                  param_value.end(),
                  values.begin(),
                  [](const std::string & val) { return T(val); });
   params.set<std::vector<T>>(param_name) = values;
 }

◆ convertStringToCompoundRealScalar()

template<typename T >

T BatchMeshGeneratorAction::convertStringToCompoundRealScalar ( const std::string & str ) const

protected

Convert a string to a compound real scalar type.

Parameters

str	String to convert

Returns: Converted compound real scalar type

Definition at line 948 of file BatchMeshGeneratorAction.C.

 {
   const auto split_str = MooseUtils::split(str, " ");
   mooseAssert(split_str.size() == Moose::dim,
               "string used for compound real scalar conversion should contain three elements.");
   T ret(MooseUtils::convert<Real>(split_str[0]));
   for (const auto i :
        make_range(static_cast<std::remove_cv_t<decltype(Moose::dim)>>(1), Moose::dim))
     ret(i) = MooseUtils::convert<Real>(split_str[i]);
   return ret;
 }

◆ errorDependentParameter()

void InputParametersChecksUtils< BatchMeshGeneratorAction >::errorDependentParameter	(	const std::string &	param1,
		const std::string &	value_not_set,
		const std::vector< std::string > &	dependent_params
	)		const

protectedinherited

Error messages for parameters that should depend on another parameter.

Parameters

param1	the parameter has not been set to the desired value (for logging purposes)
value_not_set	the desired value (for logging purposes)
dependent_params	all the parameters that should not have been since 'param1' was not set to 'value_not_set'

Definition at line 562 of file InputParametersChecksUtils.h.

 {
   for (const auto & dependent_param : dependent_params)
     if (forwardIsParamSetByUser(dependent_param))
       forwardParamError(dependent_param,
                         "Parameter '" + dependent_param +
                             "' should not be set by the user if parameter '" + param1 +
                             "' has not been set to '" + value_not_set + "'");
 }

◆ errorInconsistentDependentParameter()

void InputParametersChecksUtils< BatchMeshGeneratorAction >::errorInconsistentDependentParameter	(	const std::string &	param1,
		const std::string &	value_set,
		const std::vector< std::string > &	dependent_params
	)		const

protectedinherited

Error messages for parameters that should depend on another parameter but with a different error message.

Parameters

param1	the parameter has not been set to the desired value (for logging purposes)
value_set	the value it has been set to and which is not appropriate (for logging purposes)
dependent_params	all the parameters that should not have been set since 'param1' was set to 'value_set'

Definition at line 577 of file InputParametersChecksUtils.h.

 {
   for (const auto & dependent_param : dependent_params)
     if (forwardIsParamSetByUser(dependent_param))
       forwardParamError(dependent_param,
                         "Parameter '" + dependent_param +
                             "' should not be set by the user if parameter '" + param1 +
                             "' has been set to '" + value_set + "'");
 }

◆ errorPrefix()

std::string MooseBase::errorPrefix ( const std::string & ) const

inlineinherited

Deprecated message prefix; the error type is no longer used.

Definition at line 260 of file MooseBase.h.

260 { return messagePrefix(); }

MooseBase::messagePrefix

std::string messagePrefix(const bool hit_prefix=true) const

Definition: MooseBase.h:252

◆ getAllTasks()

const std::set<std::string>& Action::getAllTasks ( ) const

inlineinherited

Definition at line 105 of file Action.h.

Referenced by AddKernelAction::act().

105 { return _all_tasks; }

Action::_all_tasks

std::set< std::string > _all_tasks

A list of all the tasks that this Action will satisfy.

Definition: Action.h:159

◆ getBase()

const std::string& MooseBase::getBase ( ) const

inlineinherited

Returns: The registered base for this object (set via InputParameters::registerBase())

Definition at line 143 of file MooseBase.h.

Referenced by Factory::copyConstruct(), and MooseBase::uniqueParameterName().

143 { return _pars.getBase(); }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:362

InputParameters::getBase

const std::string & getBase() const

Definition: InputParameters.C:497

◆ getCheckedPointerParam()

template<typename T >

T MooseBase::getCheckedPointerParam	(	const std::string &	name,
		const std::string &	error_string = `""`
	)		const

inherited

Verifies that the requested parameter exists and is not NULL and returns it to the caller.

The template parameter must be a pointer or an error will be thrown.

Definition at line 428 of file MooseBase.h.

 {
   return _pars.getCheckedPointerParam<T>(name, error_string);
 }

◆ getDataFileName()

std::string DataFileInterface::getDataFileName ( const std::string & param ) const

inherited

Deprecated method.

The data file paths are now automatically set within the InputParameters object, so using getParam<DataFileName>("param_name") is now sufficient.

Definition at line 21 of file DataFileInterface.C.

 {
   _parent.mooseDeprecated("getDataFileName() is deprecated. The file path is now directly set "
                           "within the InputParameters.\nUse getParam<DataFileName>(\"",
                           param,
                           "\") instead.");
   return _parent.getParam<DataFileName>(param);
 }

◆ getDataFileNameByName()

std::string DataFileInterface::getDataFileNameByName ( const std::string & relative_path ) const

inherited

Deprecated method.

Use getDataFilePath() instead.

Definition at line 31 of file DataFileInterface.C.

 {
   _parent.mooseDeprecated("getDataFileNameByName() is deprecated. Use getDataFilePath(\"",
                           relative_path,
                           "\") instead.");
   return getDataFilePath(relative_path);
 }

◆ getDataFilePath()

std::string DataFileInterface::getDataFilePath ( const std::string & relative_path ) const

inherited

Returns the path of a data file for a given relative file path.

This can be used for hardcoded datafile names and will search the same locations as getDataFileName

Definition at line 40 of file DataFileInterface.C.

Referenced by DataFileInterface::getDataFileNameByName().

 {
   // This should only ever be used with relative paths. There is no point to
   // use this search path with an absolute path.
   if (std::filesystem::path(relative_path).is_absolute())
     _parent.mooseWarning("While using getDataFilePath(\"",
                          relative_path,
                          "\"): This API should not be used for absolute paths.");
 
   // This will search the data paths for this relative path
   std::optional<std::string> error;
   Moose::DataFileUtils::Path found_path;
   {
     // Throw on error so that if getPath() fails, we can throw an error
     // with the context of _parent.mooseError()
     Moose::ScopedThrowOnError scoped_throw_on_error;
 
     try
     {
       found_path = Moose::DataFileUtils::getPath(relative_path);
     }
     catch (std::exception & e)
     {
       error = e.what();
     }
   }
 
   if (error)
     _parent.mooseError(*error);
 
   mooseAssert(found_path.context == Moose::DataFileUtils::Context::DATA,
               "Should only ever obtain data");
   mooseAssert(found_path.data_name, "Should be set");
 
   const std::string msg =
       "Using data file '" + found_path.path + "' from " + *found_path.data_name + " data";
   _parent.mooseInfo(msg);
 
   return found_path.path;
 }

◆ getHitNode()

const hit::Node* MooseBase::getHitNode ( ) const

inlineinherited

Returns: The block-level hit node for this object, if any

Definition at line 132 of file MooseBase.h.

Referenced by FEProblemBase::addAnyRedistributers(), MooseBase::callMooseError(), MooseBase::getHitNode(), and MooseBase::messagePrefix().

132 { return getHitNode(_pars); }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:362

MooseBase::getHitNode

const hit::Node * getHitNode() const

Definition: MooseBase.h:132

◆ getMeshProperty() [1/2]

template<typename T >

const T & MeshMetaDataInterface::getMeshProperty	(	const std::string &	data_name,
		const std::string &	prefix
	)

protectedinherited

Method for retrieving a property with the given type and name exists in the mesh meta-data store.

This method will throw an error if the property does not exist.

Definition at line 134 of file MeshMetaDataInterface.h.

 {
   if (!hasMeshProperty(data_name, prefix))
     mooseErrorInternal("Failed to get mesh property '", prefix, "/", data_name, "'");
 
   auto value = &getMeshPropertyInternal(data_name, prefix);
   mooseAssert(value->declared(), "Value has not been declared");
   const RestartableData<T> * T_value = dynamic_cast<const RestartableData<T> *>(value);
   if (!T_value)
     mooseErrorInternal("While retrieving mesh property '",
                        prefix,
                        "/",
                        data_name,
                        "' with type '",
                        MooseUtils::prettyCppType<T>(),
                        "',\nthe property exists with different type '",
                        value->type(),
                        "'");
   return T_value->get();
 }

◆ getMeshProperty() [2/2]

template<typename T >

const T& MeshMetaDataInterface::getMeshProperty ( const std::string & data_name )

inlineprotectedinherited

Definition at line 56 of file MeshMetaDataInterface.h.

   {
     return getMeshProperty<T>(data_name, meshPropertyPrefix(data_name));
   }

◆ getMooseApp()

MooseApp& MooseBase::getMooseApp ( ) const

inlineinherited

Get the MooseApp this class is associated with.

Definition at line 83 of file MooseBase.h.

Referenced by ChainControlSetupAction::act(), AddDefaultConvergenceAction::addDefaultMultiAppFixedPointConvergence(), AddDefaultConvergenceAction::addDefaultNonlinearConvergence(), AddDefaultConvergenceAction::addDefaultSteadyStateConvergence(), FEProblemBase::advanceState(), ParsedChainControl::buildFunction(), ReporterTransferInterface::checkHasReporterValue(), AddDefaultConvergenceAction::checkUnusedMultiAppFixedPointConvergenceParameters(), AddDefaultConvergenceAction::checkUnusedNonlinearConvergenceParameters(), AddDefaultConvergenceAction::checkUnusedSteadyStateConvergenceParameters(), Coupleable::checkWritableVar(), ComponentPhysicsInterface::ComponentPhysicsInterface(), Coupleable::Coupleable(), MortarData::createMortarInterface(), EigenProblem::doFreeNonlinearPowerIterations(), Terminator::execute(), FEProblemSolve::FEProblemSolve(), SolutionInvalidInterface::flagInvalidSolutionInternal(), ChainControl::getChainControlDataSystem(), DefaultConvergenceBase::getSharedExecutionerParam(), ChainControlDataPostprocessor::initialSetup(), MaterialPropertyInterface::MaterialPropertyInterface(), MooseVariableDataFV< OutputType >::MooseVariableDataFV(), ProgressOutput::output(), PetscOutputInterface::petscLinearOutput(), PetscOutputInterface::petscNonlinearOutput(), PetscOutputInterface::PetscOutputInterface(), PostprocessorInterface::postprocessorsAdded(), MultiApp::preTransfer(), Reporter::Reporter(), ReporterInterface::reportersAdded(), MultiApp::restore(), and VectorPostprocessorInterface::vectorPostprocessorsAdded().

83 { return _app; }

MooseBase::_app

MooseApp & _app

The MOOSE application this is associated with.

Definition: MooseBase.h:353

◆ getParam() [1/2]

template<typename T >

const T & MooseBase::getParam ( const std::string & name ) const

inherited

Retrieve a parameter for the object.

Parameters

name	The name of the parameter

Returns: The value of the parameter

Definition at line 384 of file MooseBase.h.

 {
   return InputParameters::getParamHelper<T>(name, _pars);
 }

◆ getParam() [2/2]

template<typename T1 , typename T2 >

std::vector< std::pair< T1, T2 > > MooseBase::getParam	(	const std::string &	param1,
		const std::string &	param2
	)		const

inherited

Retrieve two parameters and provide pair of parameters for the object.

Parameters

param1	The name of first parameter
param2	The name of second parameter

Returns: Vector of pairs of first and second parameters

Definition at line 421 of file MooseBase.h.

 {
   return _pars.get<T1, T2>(param1, param2);
 }

◆ getRenamedParam()

template<typename T >

const T & MooseBase::getRenamedParam	(	const std::string &	old_name,
		const std::string &	new_name
	)		const

inherited

Retrieve a renamed parameter for the object.

This helper makes sure we check both names before erroring, and that only one parameter is passed to avoid silent errors

Parameters

old_name	the old name for the parameter
new_name	the new name for the parameter

Definition at line 398 of file MooseBase.h.

 {
   // Most important: accept new parameter
   if (isParamSetByUser(new_name) && !isParamValid(old_name))
     return getParam<T>(new_name);
   // Second most: accept old parameter
   if (isParamValid(old_name) && !isParamSetByUser(new_name))
     return getParam<T>(old_name);
   // Third most: accept default for new parameter
   if (isParamValid(new_name) && !isParamValid(old_name))
     return getParam<T>(new_name);
   // Refuse: no default, no value passed
   if (!isParamValid(old_name) && !isParamValid(new_name))
     mooseError("parameter '" + new_name +
                "' is being retrieved without being set.\nDid you misspell it?");
   // Refuse: both old and new parameters set by user
   else
     mooseError("Parameter '" + new_name + "' may not be provided alongside former parameter '" +
                old_name + "'");
 }

◆ hasBase()

bool MooseBase::hasBase ( ) const

inlineinherited

Returns: Whether or not this object has a registered base (set via InputParameters::registerBase())

Definition at line 138 of file MooseBase.h.

138 { return _pars.hasBase(); }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:362

InputParameters::hasBase

bool hasBase() const

Definition: InputParameters.C:491

◆ hasMeshProperty() [1/4]

bool MeshMetaDataInterface::hasMeshProperty	(	const std::string &	data_name,
		const std::string &	prefix
	)		const

protectedinherited

Returns: Whether or not a mesh meta-data exists.

Definition at line 25 of file MeshMetaDataInterface.C.

Referenced by MeshGenerator::declareMeshProperty(), MeshMetaDataInterface::getMeshProperty(), MeshMetaDataInterface::hasMeshProperty(), and MeshGenerator::setMeshProperty().

 {
   return _meta_data_app.hasRestartableMetaData(meshPropertyName(data_name, prefix),
                                                MooseApp::MESH_META_DATA);
 }

◆ hasMeshProperty() [2/4]

template<typename T >

bool MeshMetaDataInterface::hasMeshProperty	(	const std::string &	data_name,
		const std::string &	prefix
	)		const

protectedinherited

Returns: Whether or not a mesh meta-data exists with the given type.

Definition at line 158 of file MeshMetaDataInterface.h.

 {
   if (!hasMeshProperty(data_name, prefix))
     return false;
   const auto & value = getMeshPropertyInternal(data_name, prefix);
   return dynamic_cast<const RestartableData<T> *>(&value) != nullptr;
 }

◆ hasMeshProperty() [3/4]

bool MeshMetaDataInterface::hasMeshProperty ( const std::string & data_name ) const

inlineprotectedinherited

Returns: Whether or not a mesh meta-data exists with the default prefix.

Definition at line 74 of file MeshMetaDataInterface.h.

   {
     return hasMeshProperty(data_name, meshPropertyPrefix(data_name));
   }

◆ hasMeshProperty() [4/4]

template<typename T >

bool MeshMetaDataInterface::hasMeshProperty ( const std::string & data_name ) const

inlineprotectedinherited

Returns: Whether or not a mesh meta-data exists with the default prefix and the given type.

Definition at line 82 of file MeshMetaDataInterface.h.

   {
     return hasMeshProperty<T>(data_name, meshPropertyPrefix(data_name));
   }

◆ isCompoundRealScalarType()

bool BatchMeshGeneratorAction::isCompoundRealScalarType ( const ParameterType & param_type ) const

protected

Check if the parameter type is a compound real scalar type.

Parameters

param_type Parameter type to check

Returns: True if the parameter type is a compound real scalar type, false otherwise

Definition at line 961 of file BatchMeshGeneratorAction.C.

Referenced by BatchMeshGeneratorAction().

 {
   const auto valid_types = {ParameterType::REALVECTORVALUE, ParameterType::POINT};
   return std::count(valid_types.begin(), valid_types.end(), param_type);
 }

◆ isParamSetByUser()

bool MooseBase::isParamSetByUser ( const std::string & name ) const

inlineinherited

Test if the supplied parameter is set by a user, as opposed to not set or set to default.

Parameters

name	The name of the parameter to test

Definition at line 201 of file MooseBase.h.

Referenced by SetupDebugAction::act(), ADConservativeAdvectionBC::ADConservativeAdvectionBC(), DiffusionCG::addFEBCs(), DiffusionPhysicsBase::addInitialConditions(), MFEMMesh::buildMesh(), LibtorchNeuralNetControl::conditionalParameterError(), MooseApp::copyInputs(), DiffusionPhysicsBase::DiffusionPhysicsBase(), MooseApp::errorCheck(), MooseBase::getRenamedParam(), DefaultConvergenceBase::getSharedExecutionerParam(), AddVariableAction::init(), PhysicsBase::initializePhysics(), ElementSubdomainModifierBase::initialSetup(), MatrixSymmetryCheck::MatrixSymmetryCheck(), MeshDiagnosticsGenerator::MeshDiagnosticsGenerator(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), SolutionInvalidityOutput::output(), Output::Output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), PetscExternalPartitioner::partition(), PiecewiseTabularBase::PiecewiseTabularBase(), MooseMesh::prepare(), SolutionUserObjectBase::readXda(), PhysicsBase::reportPotentiallyMissedParameters(), MooseApp::runInputFile(), MooseApp::runInputs(), MFEMSolverBase::setPreconditioner(), SetupMeshAction::setupMesh(), MooseApp::setupOptions(), SideSetsFromBoundingBoxGenerator::SideSetsFromBoundingBoxGenerator(), TimedSubdomainModifier::TimedSubdomainModifier(), and XYDelaunayGenerator::XYDelaunayGenerator().

   {
     return _pars.isParamSetByUser(name);
   }

◆ isParamValid()

bool MooseBase::isParamValid ( const std::string & name ) const

inlineinherited

Test if the supplied parameter is valid.

Parameters

name	The name of the parameter to test

Definition at line 195 of file MooseBase.h.

195 { return _pars.isParamValid(name); }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:362

MooseBase::name

const std::string & name() const

Get the name of the class.

Definition: MooseBase.h:99

InputParameters::isParamValid

bool isParamValid(const std::string &name) const

This method returns parameters that have been initialized in one fashion or another, i.e.

Definition: InputParameters.C:386

◆ meshPropertyName() [1/2]

std::string MeshMetaDataInterface::meshPropertyName	(	const std::string &	data_name,
		const std::string &	prefix
	)

staticprotectedinherited

Returns: The full name for mesh property data.

Definition at line 33 of file MeshMetaDataInterface.C.

Referenced by MeshGenerator::declareMeshProperty(), MeshMetaDataInterface::getMeshPropertyInternal(), MeshMetaDataInterface::hasMeshProperty(), MeshMetaDataInterface::meshPropertyName(), and MeshGenerator::setMeshPropertyHelper().

 {
   return std::string(SYSTEM) + "/" + prefix + "/" + data_name;
 }

◆ meshPropertyName() [2/2]

std::string MeshMetaDataInterface::meshPropertyName ( const std::string & data_name ) const

inlineprotectedinherited

Returns: The default mesh property name for mesh property data

Definition at line 95 of file MeshMetaDataInterface.h.

   {
     return meshPropertyName(data_name, meshPropertyPrefix(data_name));
   }

◆ messagePrefix()

std::string MooseBase::messagePrefix ( const bool hit_prefix = true ) const

inlineinherited

Returns: A prefix to be used in messages that contain the input file location associated with this object (if any) and the name and type of the object.

Definition at line 252 of file MooseBase.h.

Referenced by MooseBase::callMooseError(), MooseBase::errorPrefix(), MooseBase::mooseDeprecated(), MooseBase::mooseInfo(), and MooseBase::mooseWarning().

   {
     return messagePrefix(_pars, hit_prefix);
   }

◆ mooseDeprecated()

template<typename... Args>

void MooseBase::mooseDeprecated ( Args &&... args ) const

inlineinherited

Definition at line 310 of file MooseBase.h.

Referenced by FEProblemBase::addAuxArrayVariable(), FEProblemBase::addAuxScalarVariable(), FEProblemBase::addAuxVariable(), FEProblemBase::advanceMultiApps(), MultiApp::appProblem(), MooseMesh::buildSideList(), ChangeOverTimestepPostprocessor::ChangeOverTimestepPostprocessor(), AddVariableAction::determineType(), EigenProblem::EigenProblem(), Eigenvalue::Eigenvalue(), MooseMesh::elem(), UserForcingFunction::f(), FaceFaceConstraint::FaceFaceConstraint(), FunctionDT::FunctionDT(), RandomICBase::generateRandom(), MooseMesh::getBoundariesToElems(), DataFileInterface::getDataFileName(), DataFileInterface::getDataFileNameByName(), Control::getExecuteOptions(), FEProblemBase::getNonlinearSystem(), MooseApp::getRecoverFileBase(), FEProblemBase::getUserObjects(), FEProblemBase::hasPostprocessor(), MooseApp::hasRecoverFileBase(), MatDiffusionBase< Real >::MatDiffusionBase(), MultiAppNearestNodeTransfer::MultiAppNearestNodeTransfer(), MultiAppShapeEvaluationTransfer::MultiAppShapeEvaluationTransfer(), MultiAppUserObjectTransfer::MultiAppUserObjectTransfer(), NodalScalarKernel::NodalScalarKernel(), MooseMesh::node(), FixedPointSolve::numPicardIts(), RelationshipManager::operator>=(), PercentChangePostprocessor::PercentChangePostprocessor(), ReferenceResidualConvergence::ReferenceResidualConvergence(), Residual::Residual(), MooseMesh::setBoundaryToNormalMap(), Exodus::setOutputDimension(), MooseApp::setupOptions(), UserForcingFunction::UserForcingFunction(), and VariableResidual::VariableResidual().

   {
     moose::internal::mooseDeprecatedStream(
         _console, false, true, messagePrefix(true), std::forward<Args>(args)...);
   }

◆ mooseDocumentedError()

template<typename... Args>

void MooseBase::mooseDocumentedError	(	const std::string &	repo_name,
		const unsigned int	issue_num,
		Args &&...	args
	)		const

inlineinherited

Definition at line 273 of file MooseBase.h.

Referenced by ArrayDGLowerDKernel::ArrayDGLowerDKernel(), ArrayHFEMDirichletBC::ArrayHFEMDirichletBC(), ArrayLowerDIntegratedBC::ArrayLowerDIntegratedBC(), DGLowerDKernel::DGLowerDKernel(), HFEMDirichletBC::HFEMDirichletBC(), and LowerDIntegratedBC::LowerDIntegratedBC().

   {
     callMooseError(moose::internal::formatMooseDocumentedError(
                        repo_name, issue_num, argumentsToString(std::forward<Args>(args)...)),
                    /* with_prefix = */ true);
   }

◆ mooseError()

template<typename... Args>

void MooseBase::mooseError ( Args &&... args ) const

inlineinherited

Emits an error prefixed with object name and type and optionally a file path to the top-level block parameter if available.

Definition at line 267 of file MooseBase.h.

   {
     callMooseError(argumentsToString(std::forward<Args>(args)...), /* with_prefix = */ true);
   }

◆ mooseErrorNonPrefixed()

template<typename... Args>

void MooseBase::mooseErrorNonPrefixed ( Args &&... args ) const

inlineinherited

Emits an error without the prefixing included in mooseError().

Definition at line 286 of file MooseBase.h.

   {
     callMooseError(argumentsToString(std::forward<Args>(args)...), /* with_prefix = */ false);
   }

◆ mooseInfo()

template<typename... Args>

void MooseBase::mooseInfo ( Args &&... args ) const

inlineinherited

Definition at line 317 of file MooseBase.h.

Referenced by SetupRecoverFileBaseAction::act(), AStableDirk4::AStableDirk4(), MeshDiagnosticsGenerator::checkNonConformalMeshFromAdaptivity(), MultiAppGeneralFieldNearestLocationTransfer::evaluateInterpValuesNearestNode(), PIDTransientControl::execute(), Executioner::Executioner(), ExplicitRK2::ExplicitRK2(), ExplicitTVDRK2::ExplicitTVDRK2(), DataFileInterface::getDataFilePath(), MFEMScalarFESpace::getFECName(), MultiAppTransfer::getPointInTargetAppFrame(), ImplicitMidpoint::ImplicitMidpoint(), ParsedDownSelectionPositions::initialize(), PropertyReadFile::initialize(), MultiAppGeneralFieldTransfer::initialSetup(), InversePowerMethod::InversePowerMethod(), LStableDirk2::LStableDirk2(), LStableDirk3::LStableDirk3(), LStableDirk4::LStableDirk4(), PNGOutput::makeMeshFunc(), NonlinearEigen::NonlinearEigen(), SolutionInvalidityOutput::output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), MooseBase::paramInfo(), ProjectionAux::ProjectionAux(), ReferenceResidualConvergence::ReferenceResidualConvergence(), MFEMDataCollection::registerFields(), FEProblemBase::setRestartFile(), MooseApp::setupOptions(), SolutionUserObjectBase::SolutionUserObjectBase(), SymmetryTransformGenerator::SymmetryTransformGenerator(), TransientBase::takeStep(), and TransientBase::TransientBase().

   {
     moose::internal::mooseInfoStream(_console, messagePrefix(true), std::forward<Args>(args)...);
   }

◆ mooseWarning()

template<typename... Args>

void MooseBase::mooseWarning ( Args &&... args ) const

inlineinherited

Emits a warning prefixed with object name and type.

Definition at line 295 of file MooseBase.h.

Referenced by CopyMeshPartitioner::_do_partition(), AddKernelAction::act(), MeshOnlyAction::act(), AddFunctionAction::act(), MaterialOutputAction::act(), CommonOutputAction::act(), MFEMProblem::addFunction(), MooseMesh::addPeriodicVariable(), DiracKernelBase::addPoint(), BoundaryMarker::BoundaryMarker(), DistributedRectilinearMeshGenerator::buildCube(), MultiAppVariableValueSamplePostprocessorTransfer::cacheElemToPostprocessorData(), CartesianMeshGenerator::CartesianMeshGenerator(), CheckOutputAction::checkConsoleOutput(), MultiAppTransfer::checkMultiAppExecuteOn(), MeshDiagnosticsGenerator::checkNonMatchingEdges(), ActionComponent::checkRequiredTasks(), PhysicsBase::checkRequiredTasks(), SampledOutput::cloneMesh(), MultiAppGeneralFieldTransfer::closestToPosition(), VariableValueElementSubdomainModifier::computeSubdomainID(), GapValueAux::computeValue(), MultiApp::createApp(), DebugResidualAux::DebugResidualAux(), MeshDiagnosticsGenerator::diagnosticsLog(), CartesianGridDivision::divisionIndex(), CylindricalGridDivision::divisionIndex(), SphericalGridDivision::divisionIndex(), ElementMaterialSampler::ElementMaterialSampler(), Postprocessor::evaluateDotWarning(), MeshDivisionFunctorReductionVectorPostprocessor::execute(), ElementQualityChecker::finalize(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), FixedPointSolve::FixedPointSolve(), SubdomainPerElementGenerator::generate(), StitchMeshGenerator::generate(), ParsedGenerateSideset::generate(), MultiAppTransfer::getAppInfo(), FunctorBinnedValuesDivision::getBinIndex(), DataFileInterface::getDataFilePath(), PointSamplerBase::getLocalElemContainingPoint(), FEProblemBase::getMaterial(), LineValueSampler::getValue(), Terminator::handleMessage(), IndicatorMarker::IndicatorMarker(), CylindricalGridDivision::initialize(), CartesianGridDivision::initialize(), SphericalGridDivision::initialize(), ElementGroupCentroidPositions::initialize(), MultiAppGeneralFieldNearestLocationTransfer::initialSetup(), BoundsBase::initialSetup(), ReferenceResidualConvergence::initialSetup(), MultiAppGeneralFieldTransfer::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), MaterialBase::initStatefulProperties(), LeastSquaresFit::LeastSquaresFit(), IterationAdaptiveDT::limitDTToPostprocessorValue(), MooseApp::loadLibraryAndDependencies(), FEProblemBase::mesh(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), NewmarkBeta::NewmarkBeta(), NodalPatchRecovery::NodalPatchRecovery(), NonlocalIntegratedBC::NonlocalIntegratedBC(), NonlocalKernel::NonlocalKernel(), Output::Output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), MooseBase::paramWarning(), PiecewiseConstantFromCSV::PiecewiseConstantFromCSV(), Executioner::problem(), PropertyReadFile::readData(), TestSourceStepper::rejectStep(), PhysicsBase::reportPotentiallyMissedParameters(), MaterialBase::resetQpProperties(), SecondTimeDerivativeAux::SecondTimeDerivativeAux(), MooseMesh::setCoordSystem(), SidesetAroundSubdomainUpdater::SidesetAroundSubdomainUpdater(), FEProblemBase::sizeZeroes(), TransientMultiApp::solveStep(), Tecplot::Tecplot(), TimeDerivativeAux::TimeDerivativeAux(), Checkpoint::updateCheckpointFiles(), SampledOutput::updateSample(), PiecewiseConstantFromCSV::value(), and VariableCondensationPreconditioner::VariableCondensationPreconditioner().

   {
     moose::internal::mooseWarningStream(_console, messagePrefix(true), std::forward<Args>(args)...);
   }

◆ mooseWarningNonPrefixed()

template<typename... Args>

void MooseBase::mooseWarningNonPrefixed ( Args &&... args ) const

inlineinherited

Emits a warning without the prefixing included in mooseWarning().

Definition at line 304 of file MooseBase.h.

   {
     moose::internal::mooseWarningStream(_console, std::forward<Args>(args)...);
   }

◆ name()

const std::string& MooseBase::name ( ) const

inlineinherited

Get the name of the class.

Returns: The name of the class

Definition at line 99 of file MooseBase.h.

   {
     mooseAssert(_name.size(), "Empty name");
     return _name;
   }

◆ paramError()

template<typename... Args>

void MooseBase::paramError	(	const std::string &	param,
		Args...	args
	)		const

inherited

Emits an error prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseError - only printing a message using the given args.

Definition at line 435 of file MooseBase.h.

 {
   _pars.paramError(param, std::forward<Args>(args)...);
 }

◆ parameterConsistent()

bool InputParametersChecksUtils< BatchMeshGeneratorAction >::parameterConsistent	(	const InputParameters &	other_param,
		const std::string &	param_name
	)		const

protectedinherited

Return whether two parameters are consistent.

Parameters

other_param	InputParameters object from another object to check the 'param_name' parameter in
param_name	the name of the parameter to check for consistency

Definition at line 460 of file InputParametersChecksUtils.h.

 {
   assertParamDefined<T>(param_name);
   mooseAssert(other_param.have_parameter<T>(param_name),
               "This should have been a parameter from the parameters being compared");
   bool consistent = true;
   if (forwardParameters().isParamValid(param_name) && other_param.isParamValid(param_name))
   {
     if constexpr (std::is_same_v<MooseEnum, T>)
     {
       if (!forwardGetParam<T>(param_name).compareCurrent(other_param.get<T>(param_name)))
         consistent = false;
     }
     else if (forwardGetParam<T>(param_name) != other_param.get<T>(param_name))
       consistent = false;
   }
   return consistent;
 }

◆ parameters()

const InputParameters& MooseBase::parameters ( ) const

inlineinherited

Get the parameters of the object.

Returns: The parameters of the object

Definition at line 127 of file MooseBase.h.

127 { return _pars; }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:362

◆ paramInfo()

template<typename... Args>

void MooseBase::paramInfo	(	const std::string &	param,
		Args...	args
	)		const

inherited

Emits an informational message prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseInfo - only printing a message using the given args.

Definition at line 449 of file MooseBase.h.

Referenced by GridPartitioner::_do_partition(), ComboMarker::ComboMarker(), Control::Control(), FunctorIC::FunctorIC(), and TransientMultiApp::TransientMultiApp().

 {
   mooseInfo(_pars.paramMessage(param, std::forward<Args>(args)...));
 }

◆ paramWarning()

template<typename... Args>

void MooseBase::paramWarning	(	const std::string &	param,
		Args...	args
	)		const

inherited

Emits a warning prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseWarning - only printing a message using the given args.

Definition at line 442 of file MooseBase.h.

Referenced by GridPartitioner::_do_partition(), MultiAppTransfer::checkParentAppUserObjectExecuteOn(), EigenProblem::checkProblemIntegrity(), CombinerGenerator::copyIntoMesh(), DefaultMultiAppFixedPointConvergence::DefaultMultiAppFixedPointConvergence(), MultiAppNearestNodeTransfer::execute(), FEProblemSolve::FEProblemSolve(), UniqueExtraIDMeshGenerator::generate(), PlaneIDMeshGenerator::generate(), Terminator::initialSetup(), SampledOutput::initSample(), MooseMesh::MooseMesh(), FEProblemBase::setPreserveMatrixSparsityPattern(), and Terminator::Terminator().

 {
   mooseWarning(_pars.paramMessage(param, std::forward<Args>(args)...));
 }

◆ perfGraph()

PerfGraph & PerfGraphInterface::perfGraph ( )

inherited

Get the PerfGraph.

Definition at line 78 of file PerfGraphInterface.C.

Referenced by CommonOutputAction::act(), PerfGraphData::finalize(), and PerfGraphOutput::output().

 {
   return _pg_moose_app.perfGraph();
 }

◆ queryParam()

template<typename T >

const T * MooseBase::queryParam ( const std::string & name ) const

inherited

Query a parameter for the object.

If the parameter is not valid, nullptr will be returned

Parameters

name	The name of the parameter

Returns: A pointer to the parameter value, if it exists

Definition at line 391 of file MooseBase.h.

 {
   return isParamValid(name) ? &getParam<T>(name) : nullptr;
 }

◆ registerTimedSection() [1/2]

PerfID PerfGraphInterface::registerTimedSection	(	const std::string &	section_name,
		const unsigned int	level
	)		const

protectedinherited

Call to register a named section for timing.

Parameters

section_name	The name of the code section to be timed
level	The importance of the timer - lower is more important (0 will always come out)

Returns: The ID of the section - use when starting timing

Definition at line 53 of file PerfGraphInterface.C.

 {
   const auto timed_section_name = timedSectionName(section_name);
   if (!moose::internal::getPerfGraphRegistry().sectionExists(timed_section_name))
     return moose::internal::getPerfGraphRegistry().registerSection(timed_section_name, level);
   else
     return moose::internal::getPerfGraphRegistry().sectionID(timed_section_name);
 }

◆ registerTimedSection() [2/2]

PerfID PerfGraphInterface::registerTimedSection	(	const std::string &	section_name,
		const unsigned int	level,
		const std::string &	live_message,
		const bool	print_dots = `true`
	)		const

protectedinherited

Call to register a named section for timing.

Parameters

section_name	The name of the code section to be timed
level	The importance of the timer - lower is more important (0 will always come out)
live_message	The message to be printed to the screen during execution
print_dots	Whether or not progress dots should be printed for this section

Returns: The ID of the section - use when starting timing

Definition at line 64 of file PerfGraphInterface.C.

 {
   const auto timed_section_name = timedSectionName(section_name);
   if (!moose::internal::getPerfGraphRegistry().sectionExists(timed_section_name))
     return moose::internal::getPerfGraphRegistry().registerSection(
         timedSectionName(section_name), level, live_message, print_dots);
   else
     return moose::internal::getPerfGraphRegistry().sectionID(timed_section_name);
 }

◆ setScalarParams()

void BatchMeshGeneratorAction::setScalarParams	(	InputParameters &	params,
		const std::string &	param_name,
		const ParameterType &	param_type,
		const std::string &	param_value
	)		const

protected

Set the scalar input parameters for a unit mesh generator.

Parameters

params	InputParameters object to set the parameters
param_name	Name of the parameter to set
param_type	Type of the parameter to set
param_value	Value of the parameter to set in string format

Definition at line 617 of file BatchMeshGeneratorAction.C.

Referenced by addMeshGenerators().

 {
   switch (param_type)
   {
     case (ParameterType::REAL):
       params.set<Real>(param_name) = MooseUtils::convert<Real>(param_value);
       break;
     case (ParameterType::SHORT):
       params.set<short>(param_name) = MooseUtils::convert<short>(param_value);
       break;
     case (ParameterType::USHORT):
       params.set<unsigned short>(param_name) = MooseUtils::convert<unsigned short>(param_value);
       break;
     case (ParameterType::INT):
       params.set<int>(param_name) = MooseUtils::convert<int>(param_value);
       break;
     case (ParameterType::UINT):
       params.set<unsigned int>(param_name) = MooseUtils::convert<unsigned int>(param_value);
       break;
     case (ParameterType::LONG):
       params.set<long>(param_name) = MooseUtils::convert<long>(param_value);
       break;
     case (ParameterType::ULONG):
       params.set<unsigned long>(param_name) = MooseUtils::convert<unsigned long>(param_value);
       break;
     case (ParameterType::LONGLONG):
       params.set<long long>(param_name) = MooseUtils::convert<long long>(param_value);
       break;
     case (ParameterType::ULONGLONG):
       params.set<unsigned long long>(param_name) =
           MooseUtils::convert<unsigned long long>(param_value);
       break;
     case (ParameterType::DOFIDTYPE):
       params.set<dof_id_type>(param_name) = MooseUtils::convert<dof_id_type>(param_value);
       break;
     case (ParameterType::BDRYIDTYPE):
       params.set<boundary_id_type>(param_name) = MooseUtils::convert<boundary_id_type>(param_value);
       break;
     case (ParameterType::SDIDTYPE):
       params.set<subdomain_id_type>(param_name) =
           MooseUtils::convert<subdomain_id_type>(param_value);
       break;
     case (ParameterType::ENUM):
       params.set<MooseEnum>(param_name) = param_value;
       break;
     case (ParameterType::STRING):
       params.set<std::string>(param_name) = param_value;
       break;
     case (ParameterType::SDNAME):
       params.set<SubdomainName>(param_name) = param_value;
       break;
     case (ParameterType::BDRYNAME):
       params.set<BoundaryName>(param_name) = param_value;
       break;
     case (ParameterType::MGNAME):
       params.set<MeshGeneratorName>(param_name) = param_value;
       break;
     case (ParameterType::MFNAME):
       params.set<MeshFileName>(param_name) = param_value;
       break;
     case (ParameterType::BOOL):
       hit::toBool(param_value, &params.set<bool>(param_name));
       break;
     case (ParameterType::REALVECTORVALUE):
       params.set<RealVectorValue>(param_name) =
           convertStringToCompoundRealScalar<RealVectorValue>(param_value);
       break;
     case (ParameterType::POINT):
       params.set<Point>(param_name) = convertStringToCompoundRealScalar<Point>(param_value);
       break;
     default:
       mooseAssert(false,
                   "impossible situation."); // as we use MultiMooseEnum to ensure the type is valid
   }
 }

◆ setVectorParams()

void BatchMeshGeneratorAction::setVectorParams	(	InputParameters &	params,
		const std::string &	param_name,
		const ParameterType &	param_type,
		const std::vector< std::string > &	param_value
	)		const

protected

Set the vector input parameters for a unit mesh generator.

Parameters

params	InputParameters object to set the parameters
param_name	Name of the parameter to set
param_type	Type of the parameter to set
param_value	Value of the parameter to set in string format

Definition at line 697 of file BatchMeshGeneratorAction.C.

Referenced by addMeshGenerators().

 {
   switch (param_type)
   {
     case (ParameterType::REAL):
       convertAndSetNumericVector<Real>(params, param_name, param_value);
       break;
     case (ParameterType::SHORT):
       convertAndSetNumericVector<short>(params, param_name, param_value);
       break;
     case (ParameterType::USHORT):
       convertAndSetNumericVector<unsigned short>(params, param_name, param_value);
       break;
     case (ParameterType::INT):
       convertAndSetNumericVector<int>(params, param_name, param_value);
       break;
     case (ParameterType::UINT):
       convertAndSetNumericVector<unsigned int>(params, param_name, param_value);
       break;
     case (ParameterType::LONG):
       convertAndSetNumericVector<long>(params, param_name, param_value);
       break;
     case (ParameterType::ULONG):
       convertAndSetNumericVector<unsigned long>(params, param_name, param_value);
       break;
     case (ParameterType::LONGLONG):
       convertAndSetNumericVector<long long>(params, param_name, param_value);
       break;
     case (ParameterType::ULONGLONG):
       convertAndSetNumericVector<unsigned long long>(params, param_name, param_value);
       break;
     case (ParameterType::DOFIDTYPE):
       convertAndSetNumericVector<dof_id_type>(params, param_name, param_value);
       break;
     case (ParameterType::BDRYIDTYPE):
       convertAndSetNumericVector<boundary_id_type>(params, param_name, param_value);
       break;
     case (ParameterType::SDIDTYPE):
       convertAndSetNumericVector<subdomain_id_type>(params, param_name, param_value);
       break;
     case (ParameterType::ENUM):
       params.set<MultiMooseEnum>(param_name) = param_value;
       break;
     case (ParameterType::STRING):
       params.set<std::vector<std::string>>(param_name) = param_value;
       break;
     case (ParameterType::SDNAME):
       convertAndSetStringLikeVector<SubdomainName>(params, param_name, param_value);
       break;
     case (ParameterType::BDRYNAME):
       convertAndSetStringLikeVector<BoundaryName>(params, param_name, param_value);
       break;
     case (ParameterType::MGNAME):
       convertAndSetStringLikeVector<MeshGeneratorName>(params, param_name, param_value);
       break;
     case (ParameterType::MFNAME):
       convertAndSetStringLikeVector<MeshFileName>(params, param_name, param_value);
       break;
     case (ParameterType::BOOL):
     {
       std::vector<bool> values(param_value.size());
       std::transform(param_value.begin(),
                      param_value.end(),
                      values.begin(),
                      [](const std::string & val)
                      {
                        bool tmp;
                        hit::toBool(val, &tmp);
                        return tmp;
                      });
       params.set<std::vector<bool>>(param_name) = values;
       break;
     }
     case (ParameterType::REALVECTORVALUE):
       convertAndSetCompoundRealScalarVector<RealVectorValue>(params, param_name, param_value);
       break;
     case (ParameterType::POINT):
       convertAndSetCompoundRealScalarVector<Point>(params, param_name, param_value);
       break;
     default:
       mooseAssert(false,
                   "impossible situation."); // as we use MultiMooseEnum to ensure the type is valid
   }
 }

◆ specificTaskName()

const std::string& Action::specificTaskName ( ) const

inlineinherited

Definition at line 103 of file Action.h.

103 { return _specific_task_name; }

Action::_specific_task_name

std::string _specific_task_name

This member will only be populated if this Action instance is only designed to handle one task...

Definition: Action.h:152

◆ timedAct()

void Action::timedAct ( )

inherited

The method called externally that causes the action to act()

Definition at line 75 of file Action.C.

Referenced by ActionWarehouse::executeActionsWithAction().

 {
   TIME_SECTION(_act_timer);
   act();
 }

◆ timedSectionName()

std::string PerfGraphInterface::timedSectionName ( const std::string & section_name ) const

protectedinherited

Returns: The name of the timed section with the name section_name.

Optionally adds a prefix if one is defined.

Definition at line 47 of file PerfGraphInterface.C.

Referenced by PerfGraphInterface::registerTimedSection().

 {
   return _prefix.empty() ? "" : (_prefix + "::") + section_name;
 }

◆ type()

const std::string& MooseBase::type ( ) const

inlineinherited

Get the type of this class.

Returns: the name of the type of this class

Definition at line 89 of file MooseBase.h.

   {
     mooseAssert(_type.size(), "Empty type");
     return _type;
   }

◆ typeAndName()

std::string MooseBase::typeAndName ( ) const

inherited

Get the class's combined type and name; useful in error handling.

Returns: The type and name of this class in the form '<type()> "<name()>"'.

Definition at line 54 of file MooseBase.C.

Referenced by FEProblemBase::addPostprocessor(), MaterialPropertyStorage::addProperty(), FEProblemBase::addReporter(), FEProblemBase::addVectorPostprocessor(), MeshGeneratorSystem::dataDrivenError(), ReporterContext< std::vector< T > >::finalize(), and ReporterData::getReporterInfo().

 {
   return type() + std::string(" \"") + name() + std::string("\"");
 }

◆ uniqueActionName()

MooseObjectName Action::uniqueActionName ( ) const

inlineinherited

The unique name for accessing input parameters of this action in the InputParameterWarehouse.

Definition at line 101 of file Action.h.

Referenced by NEML2Action::NEML2Action().

101 { return uniqueName(); }

MooseBase::uniqueName

MooseObjectName uniqueName() const

Definition: MooseBase.C:66

◆ uniqueName()

MooseObjectName MooseBase::uniqueName ( ) const

inherited

Returns: The unique name for accessing input parameters of this object in the InputParameterWarehouse

Definition at line 66 of file MooseBase.C.

Referenced by MooseBase::connectControllableParams(), and Action::uniqueActionName().

 {
   if (!_pars.have_parameter<std::string>(unique_name_param))
     mooseError("uniqueName(): Object does not have a unique name");
   return MooseObjectName(_pars.get<std::string>(unique_name_param));
 }

◆ uniqueParameterName()

MooseObjectParameterName MooseBase::uniqueParameterName ( const std::string & parameter_name ) const

inherited

Returns: The unique parameter name of a valid parameter of this object for accessing parameter controls

Definition at line 60 of file MooseBase.C.

 {
   return MooseObjectParameterName(getBase(), name(), parameter_name);
 }

◆ validParams()

InputParameters BatchMeshGeneratorAction::validParams ( )

static

Definition at line 25 of file BatchMeshGeneratorAction.C.

 {
   InputParameters params = Action::validParams();
 
   params.set<std::string>("type") = "BatchMeshGeneratorAction";
 
   params.addClassDescription("Batch generate meshes using actions.");
   params.addRequiredParam<std::string>("mesh_generator_type",
                                        "Type of the mesh generator to be batch generated.");
   params.addRequiredParam<std::string>("mesh_name_prefix",
                                        "Prefix name of the meshes to be batch generated.");
 
   params.addParam<std::vector<std::string>>("batch_scalar_input_param_names",
                                             std::vector<std::string>(),
                                             "Names of the scalar input parameters to be altered.");
   MultiMooseEnum default_types(
       "BOOL REAL SHORT USHORT INT UINT LONG ULONG LONGLONG ULONGLONG DOFIDTYPE BDRYIDTYPE SDIDTYPE "
       "STRING SDNAME BDRYNAME MGNAME MFNAME ENUM REALVECTORVALUE POINT",
       "");
   params.addParam<MultiMooseEnum>(
       "batch_scalar_input_param_types",
       default_types,
       "Types of the scalar input parameters to be altered in each generator of the batch.");
   params.addParam<std::vector<std::vector<std::string>>>(
       "batch_scalar_input_param_values",
       {},
       "Values of the scalar input parameters to be assigned.");
 
   params.addParam<std::vector<std::string>>("batch_vector_input_param_names",
                                             std::vector<std::string>(),
                                             "Name of the vector input parameters to be altered.");
   params.addParam<MultiMooseEnum>("batch_vector_input_param_types",
                                   default_types,
                                   "Type of the vector input parameters to be altered.");
   params.addParam<std::vector<std::vector<std::vector<std::string>>>>(
       "batch_vector_input_param_values",
       {},
       "Values of the vector input parameters to be assigned.");
 
   MooseEnum multi_batch_params_method("corresponding cartesian_product", "cartesian_product");
   params.addParam<MooseEnum>("multi_batch_params_method",
                              multi_batch_params_method,
                              "Method to generate multiple batch parameters.Options: " +
                                  multi_batch_params_method.getRawNames());
 
   params.addParam<std::vector<std::string>>(
       "fixed_scalar_input_param_names", {}, "Names of the input parameters to be fixed.");
   params.addParam<MultiMooseEnum>("fixed_scalar_input_param_types",
                                   default_types,
                                   "Types of the input parameters to be fixed.");
   params.addParam<std::vector<std::string>>(
       "fixed_scalar_input_param_values", {}, "Values of the input parameters to be fixed.");
   params.addParam<std::vector<std::string>>(
       "fixed_vector_input_param_names", {}, "Names of the input vector parameters to be fixed.");
   params.addParam<MultiMooseEnum>("fixed_vector_input_param_types",
                                   default_types,
                                   "Types of the input vector parameters to be fixed.");
   params.addParam<std::vector<std::vector<std::string>>>(
       "fixed_vector_input_param_values", {}, "Values of the input vector parameters to be fixed.");
   params.addParam<bool>("use_decomposed_index",
                         false,
                         "Whether to use the decomposed index for the mesh name (only effective for "
                         "the cartesian_product method).");
 
   params.addParamNamesToGroup("batch_scalar_input_param_names batch_scalar_input_param_types "
                               "batch_scalar_input_param_values "
                               "batch_vector_input_param_names batch_vector_input_param_types "
                               "batch_vector_input_param_values",
                               "Batch Input");
   params.addParamNamesToGroup("fixed_scalar_input_param_names fixed_scalar_input_param_types "
                               "fixed_scalar_input_param_values "
                               "fixed_vector_input_param_names fixed_vector_input_param_types "
                               "fixed_vector_input_param_values",
                               "Fixed Input");
 
   return params;
 }

◆ warnInconsistent()

void InputParametersChecksUtils< BatchMeshGeneratorAction >::warnInconsistent	(	const InputParameters &	parameters,
		const std::string &	param_name
	)		const

protectedinherited

Emits a warning if two parameters are not equal to each other.

Parameters

other_param	InputParameters object from another object to check the 'param_name' parameter in
param_name	the name of the parameter to check for consistency

Definition at line 549 of file InputParametersChecksUtils.h.

 {
   const bool consistent = parameterConsistent<T>(other_param, param_name);
   if (!consistent)
     forwardMooseWarning("Parameter " + param_name + " is inconsistent between Physics \"" +
                         forwardName() + "\" of type \"" + forwardType() +
                         "\" and the parameter set for \"" + other_param.getObjectName() +
                         "\" of type \"" + other_param.getObjectType() + "\"");
 }

Member Data Documentation

◆ _act_timer

PerfID Action::_act_timer

protectedinherited

Timers.

Definition at line 174 of file Action.h.

Referenced by Action::timedAct().

◆ _action_factory

ActionFactory& ParallelParamObject::_action_factory

protectedinherited

Builds Actions.

Definition at line 40 of file ParallelParamObject.h.

Referenced by AddActionComponentAction::act(), CreateMeshSetupActionsForComponents::act(), ActionComponent::checkRequiredTasks(), PhysicsBase::checkRequiredTasks(), CommonOutputAction::create(), AddVariableAction::createInitialConditionAction(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), CreateExecutionerAction::setupAutoPreconditioning(), and ReadExecutorParamsAction::setupAutoPreconditioning().

◆ _all_tasks

std::set<std::string> Action::_all_tasks

protectedinherited

A list of all the tasks that this Action will satisfy.

Note: That this is not populated at construction time. However, all tasks will be added prior to act().

Definition at line 159 of file Action.h.

Referenced by Action::appendTask(), and Action::getAllTasks().

◆ _app

MooseApp& MooseBase::_app

protectedinherited

The MOOSE application this is associated with.

Definition at line 353 of file MooseBase.h.

◆ _awh

ActionWarehouse& Action::_awh

protectedinherited

Reference to ActionWarehouse where we store object build by actions.

Definition at line 162 of file Action.h.

Referenced by CheckIntegrityAction::act(), ReadExecutorParamsAction::act(), SetupDampersAction::act(), CreateExecutionerAction::act(), CreateProblemDefaultAction::act(), CombineComponentsMeshes::act(), SetupMeshAction::act(), SetupTimeStepperAction::act(), AddActionComponentAction::act(), CreateMeshSetupActionsForComponents::act(), AddRelationshipManager::act(), AddActionComponentAction::AddActionComponentAction(), CommonOutputAction::create(), AddVariableAction::createInitialConditionAction(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), PhysicsBase::getActionComponent(), NEML2Action::getCommonAction(), PhysicsBase::getCoupledPhysics(), ActionComponent::getProblem(), CommonOutputAction::hasConsole(), ComponentPhysicsInterface::physicsExists(), CreateExecutionerAction::setupAutoPreconditioning(), ReadExecutorParamsAction::setupAutoPreconditioning(), CylinderComponent::setupComponent(), and SetupDebugAction::SetupDebugAction().

◆ _batch_scalar_input_param_names

const std::vector<std::string> BatchMeshGeneratorAction::_batch_scalar_input_param_names

protected

Names of the scalar input parameters to vary in the batch generation.

Definition at line 68 of file BatchMeshGeneratorAction.h.

Referenced by addMeshGenerators(), and BatchMeshGeneratorAction().

◆ _batch_scalar_input_param_types

const std::vector<ParameterType> BatchMeshGeneratorAction::_batch_scalar_input_param_types

protected

Types of the scalar input parameters to vary in the batch generation.

Definition at line 70 of file BatchMeshGeneratorAction.h.

Referenced by addMeshGenerators(), and BatchMeshGeneratorAction().

◆ _batch_scalar_input_param_values

std::vector<std::vector<std::string> > BatchMeshGeneratorAction::_batch_scalar_input_param_values

protected

Values of the scalar input parameters to vary in the batch generation.

Definition at line 72 of file BatchMeshGeneratorAction.h.

Referenced by addMeshGenerators(), and BatchMeshGeneratorAction().

◆ _batch_vector_input_param_names

const std::vector<std::string> BatchMeshGeneratorAction::_batch_vector_input_param_names

protected

Names of the vector input parameters to vary in the batch generation.

Definition at line 74 of file BatchMeshGeneratorAction.h.

Referenced by addMeshGenerators(), and BatchMeshGeneratorAction().

◆ _batch_vector_input_param_types

const std::vector<ParameterType> BatchMeshGeneratorAction::_batch_vector_input_param_types

protected

Types of the vector input parameters to vary in the batch generation.

Definition at line 76 of file BatchMeshGeneratorAction.h.

Referenced by addMeshGenerators(), and BatchMeshGeneratorAction().

◆ _batch_vector_input_param_values

std::vector<std::vector<std::vector<std::string> > > BatchMeshGeneratorAction::_batch_vector_input_param_values

protected

Values of the vector input parameters to vary in the batch generation.

Definition at line 78 of file BatchMeshGeneratorAction.h.

Referenced by addMeshGenerators(), and BatchMeshGeneratorAction().

◆ _console

const ConsoleStream ConsoleStreamInterface::_console

inherited

An instance of helper class to write streams to the Console objects.

Definition at line 31 of file ConsoleStreamInterface.h.

◆ _current_task

const std::string& Action::_current_task

protectedinherited

The current action (even though we have separate instances for each action)

Definition at line 165 of file Action.h.

Referenced by ElementIDOutputAction::act(), AddFVInterfaceKernelAction::act(), AddScalarKernelAction::act(), SetupMeshCompleteAction::act(), AddInterfaceKernelAction::act(), CheckFVBCAction::act(), AddKernelAction::act(), CheckIntegrityAction::act(), AddDGKernelAction::act(), CopyNodalVarsAction::act(), CreateProblemDefaultAction::act(), AddFVBCAction::act(), SetupMeshAction::act(), AddFVKernelAction::act(), CombineComponentsMeshes::act(), AdaptivityAction::act(), AddDefaultConvergenceAction::act(), AddTimeStepperAction::act(), SetupTimeIntegratorAction::act(), SetupRecoverFileBaseAction::act(), AddLinearFVBCAction::act(), CreateMeshSetupActionsForComponents::act(), AddActionComponentAction::act(), AddLinearFVKernelAction::act(), AddOutputAction::act(), CreateDisplacedProblemAction::act(), MaterialDerivativeTestAction::act(), AddRelationshipManager::act(), SetAdaptivityOptionsAction::act(), DisplayGhostingAction::act(), act(), MaterialOutputAction::act(), AddPeriodicBCAction::act(), CommonOutputAction::act(), ActionComponent::act(), AddNodalNormalsAction::act(), PhysicsBase::act(), PhysicsComponentInterface::actOnAdditionalTasks(), and ProjectedStatefulMaterialStorageAction::processProperty().

◆ _displaced_mesh

std::shared_ptr<MooseMesh>& Action::_displaced_mesh

protectedinherited

Definition at line 168 of file Action.h.

Referenced by SetupMeshCompleteAction::act(), SetupMeshAction::act(), and CreateDisplacedProblemAction::act().

◆ _factory

Factory& ParallelParamObject::_factory

protectedinherited

The Factory associated with the MooseApp.

Definition at line 37 of file ParallelParamObject.h.

Referenced by ElementIDOutputAction::act(), AutoCheckpointAction::act(), PartitionerAction::act(), CreateExecutionerAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), CombineComponentsMeshes::act(), SetupMeshAction::act(), AdaptivityAction::act(), SetupPredictorAction::act(), SetupTimeStepperAction::act(), SetupDebugAction::act(), ComposeTimeStepperAction::act(), SetupPreconditionerAction::act(), SetupResidualDebugAction::act(), MaterialDerivativeTestAction::act(), CreateDisplacedProblemAction::act(), SetAdaptivityOptionsAction::act(), DisplayGhostingAction::act(), AddControlAction::act(), MaterialOutputAction::act(), AddPeriodicBCAction::act(), CommonOutputAction::act(), AddNodalNormalsAction::act(), ComponentMeshTransformHelper::addMeshGenerators(), CylinderComponent::addMeshGenerators(), DiffusionPhysicsBase::addPostprocessors(), CreateDisplacedProblemAction::addProxyRelationshipManagers(), Action::addRelationshipManager(), SampledOutput::cloneMesh(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), ActionComponent::getFactory(), PhysicsBase::getFactory(), MaterialOutputAction::getParams(), and ProjectedStatefulMaterialStorageAction::processProperty().

◆ _fixed_scalar_input_param_names

const std::vector<std::string> BatchMeshGeneratorAction::_fixed_scalar_input_param_names

protected

Names of the vector input parameters to keep fixed in the batch generation.

Definition at line 82 of file BatchMeshGeneratorAction.h.

Referenced by addMeshGenerators(), and BatchMeshGeneratorAction().

◆ _fixed_scalar_input_param_types

const std::vector<ParameterType> BatchMeshGeneratorAction::_fixed_scalar_input_param_types

protected

Types of the vector input parameters to keep fixed in the batch generation.

Definition at line 84 of file BatchMeshGeneratorAction.h.

Referenced by addMeshGenerators(), and BatchMeshGeneratorAction().

◆ _fixed_scalar_input_param_values

std::vector<std::string> BatchMeshGeneratorAction::_fixed_scalar_input_param_values

protected

Values of the vector input parameters to keep fixed in the batch generation.

Definition at line 86 of file BatchMeshGeneratorAction.h.

Referenced by addMeshGenerators(), and BatchMeshGeneratorAction().

◆ _fixed_vector_input_param_names

const std::vector<std::string> BatchMeshGeneratorAction::_fixed_vector_input_param_names

protected

Names of the vector input parameters to keep fixed in the batch generation.

Definition at line 88 of file BatchMeshGeneratorAction.h.

Referenced by addMeshGenerators(), and BatchMeshGeneratorAction().

◆ _fixed_vector_input_param_types

const std::vector<ParameterType> BatchMeshGeneratorAction::_fixed_vector_input_param_types

protected

Types of the vector input parameters to keep fixed in the batch generation.

Definition at line 90 of file BatchMeshGeneratorAction.h.

Referenced by addMeshGenerators(), and BatchMeshGeneratorAction().

◆ _fixed_vector_input_param_values

std::vector<std::vector<std::string> > BatchMeshGeneratorAction::_fixed_vector_input_param_values

protected

Values of the vector input parameters to keep fixed in the batch generation.

Definition at line 92 of file BatchMeshGeneratorAction.h.

Referenced by addMeshGenerators(), and BatchMeshGeneratorAction().

◆ _mesh

std::shared_ptr<MooseMesh>& Action::_mesh

protectedinherited

◆ _mesh_generator_type

const std::string BatchMeshGeneratorAction::_mesh_generator_type

protected

Type (object name) of the mesh generator to use for batch generation.

Definition at line 64 of file BatchMeshGeneratorAction.h.

Referenced by addMeshGenerators(), and BatchMeshGeneratorAction().

◆ _mesh_name_prefix

const std::string BatchMeshGeneratorAction::_mesh_name_prefix

protected

Prefix to use for naming the batch generated meshes.

Definition at line 66 of file BatchMeshGeneratorAction.h.

Referenced by addMeshGenerators().

◆ _multi_batch_params_method

const MultiBatchParamsMethod BatchMeshGeneratorAction::_multi_batch_params_method

protected

Method to use for generating the batch parameters.

Definition at line 80 of file BatchMeshGeneratorAction.h.

Referenced by addMeshGenerators(), and BatchMeshGeneratorAction().

◆ _name

const std::string& MooseBase::_name

protectedinherited

The name of this class.

Definition at line 359 of file MooseBase.h.

◆ _pars

const InputParameters& MooseBase::_pars

protectedinherited

The object's parameters.

Definition at line 362 of file MooseBase.h.

Referenced by AddFVICAction::act(), AddICAction::act(), CreateProblemDefaultAction::act(), CreateProblemAction::act(), SetupMeshAction::act(), ComposeTimeStepperAction::act(), SetupDebugAction::act(), AddAuxKernelAction::act(), AddPeriodicBCAction::act(), CommonOutputAction::act(), FunctorMaterial::addFunctorPropertyByBlocks(), BreakMeshByBlockGeneratorBase::BreakMeshByBlockGeneratorBase(), PiecewiseTabularBase::buildFromFile(), PNGOutput::calculateRescalingValues(), MooseBase::callMooseError(), MooseBase::connectControllableParams(), Console::Console(), MooseApp::copyInputs(), MaterialBase::declareADProperty(), MaterialBase::declareProperty(), FEProblemSolve::FEProblemSolve(), FunctionMaterialBase< is_ad >::FunctionMaterialBase(), FileMeshGenerator::generate(), MooseBase::getBase(), MooseBase::getCheckedPointerParam(), MaterialBase::getGenericZeroMaterialProperty(), MooseBase::getHitNode(), MeshGenerator::getMeshGeneratorNameFromParam(), MeshGenerator::getMeshGeneratorNamesFromParam(), MooseBase::getParam(), MooseBase::hasBase(), MeshGenerator::hasGenerateData(), AddVariableAction::init(), AdvancedOutput::initExecutionTypes(), Console::initialSetup(), MooseBase::isParamSetByUser(), MooseBase::isParamValid(), MultiApp::keepSolutionDuringRestore(), MooseBase::messagePrefix(), MooseBase::MooseBase(), MooseApp::outputMachineReadableData(), MooseBase::paramError(), MooseBase::parameters(), MooseBase::paramInfo(), MooseBase::paramWarning(), MooseMesh::prepare(), Eigenvalue::prepareSolverOptions(), MooseMesh::setCoordSystem(), MooseMesh::setPartitionerHelper(), SetupMeshAction::setupMesh(), TransientBase::setupTimeIntegrator(), MooseApp::showInputs(), and MooseBase::uniqueName().

◆ _pg_moose_app

MooseApp& PerfGraphInterface::_pg_moose_app

protectedinherited

The MooseApp that owns the PerfGraph.

Definition at line 124 of file PerfGraphInterface.h.

Referenced by PerfGraphInterface::perfGraph().

◆ _prefix

const std::string PerfGraphInterface::_prefix

protectedinherited

A prefix to use for all sections.

Definition at line 127 of file PerfGraphInterface.h.

Referenced by PerfGraphInterface::timedSectionName().

◆ _problem

std::shared_ptr<FEProblemBase>& Action::_problem

protectedinherited

Convenience reference to a problem this action works on.

Definition at line 171 of file Action.h.

◆ _registered_identifier

std::string Action::_registered_identifier

protectedinherited

Definition at line 144 of file Action.h.

Referenced by SetupMeshAction::act().

◆ _specific_task_name

std::string Action::_specific_task_name

protectedinherited

This member will only be populated if this Action instance is only designed to handle one task.

This happens when an Action is registered with several pieces of syntax in which case separate instances are built to handle the different incoming parameter values.

Definition at line 152 of file Action.h.

Referenced by Action::specificTaskName().

◆ _type

const std::string& MooseBase::_type

protectedinherited

The type of this class.

Definition at line 356 of file MooseBase.h.

Referenced by ExplicitTimeIntegrator::ExplicitTimeIntegrator(), FEProblemSolve::FEProblemSolve(), FillBetweenSidesetsGenerator::generate(), FillBetweenCurvesGenerator::generate(), FillBetweenPointVectorsGenerator::generate(), ExplicitTimeIntegrator::init(), FEProblemBase::init(), MooseBase::MooseBase(), MooseStaticCondensationPreconditioner::MooseStaticCondensationPreconditioner(), PhysicsBasedPreconditioner::PhysicsBasedPreconditioner(), FEProblemBase::solverTypeString(), and MooseBase::type().

◆ _use_decomposed_index

const bool BatchMeshGeneratorAction::_use_decomposed_index

protected

Flag to indicate if the decomposed index should be used in the mesh name.

Definition at line 94 of file BatchMeshGeneratorAction.h.

Referenced by addMeshGenerators(), and BatchMeshGeneratorAction().

◆ app_param

const std::string MooseBase::app_param = "_moose_app"

staticinherited

The name of the parameter that contains the MooseApp.

Definition at line 59 of file MooseBase.h.

Referenced by FEProblemBase::addAnyRedistributers(), MeshGenerator::addMeshSubgenerator(), InputParameters::callMooseError(), ActionFactory::create(), Factory::getValidParams(), ActionFactory::getValidParams(), AutomaticMortarGeneration::initOutput(), SetupMeshAction::modifyParamsForUseSplit(), and MortarNodalGeometryOutput::validParams().

◆ moose_base_param

const std::string MooseBase::moose_base_param = "_moose_base"

staticinherited

The name of the parameter that contains the moose system base.

Definition at line 61 of file MooseBase.h.

Referenced by InputParameters::getBase(), InputParameters::hasBase(), and InputParameters::registerBase().

◆ NAME

constexpr auto MeshMetaDataInterface::NAME = "<empty>"

staticinherited

The data name used when initializing the Restartable interface for non-MeshGenerator objects.

Definition at line 33 of file MeshMetaDataInterface.h.

◆ name_param

const std::string MooseBase::name_param = "_object_name"

staticinherited

The name of the parameter that contains the object name.

Definition at line 55 of file MooseBase.h.

Referenced by InputParameterWarehouse::addInputParameters(), MooseObjectUnitTest::buildObjects(), ActionFactory::create(), AppFactory::create(), InputParameters::getObjectName(), AutomaticMortarGeneration::initOutput(), InputParameters::isMooseBaseObject(), MooseMesh::prepare(), CouplingFunctorCheckAction::validParams(), and MooseBase::validParams().

◆ SYSTEM

constexpr auto MeshMetaDataInterface::SYSTEM = "MeshMetaData"

staticinherited

The system name used when initializing the Restartable interface.

Definition at line 30 of file MeshMetaDataInterface.h.

Referenced by MeshMetaDataInterface::meshPropertyName().

◆ type_param

const std::string MooseBase::type_param = "_type"

staticinherited

The name of the parameter that contains the object type.

Definition at line 53 of file MooseBase.h.

Referenced by ActionFactory::create(), AppFactory::create(), InputParameters::getObjectType(), Factory::initialize(), InputParameters::isMooseBaseObject(), InputParameters::queryObjectType(), MooseBase::validParams(), and MortarNodalGeometryOutput::validParams().

◆ unique_action_name_param

const std::string Action::unique_action_name_param = "_unique_action_name"

staticinherited

The name of the parameter that contains the unique action name.

Definition at line 37 of file Action.h.

Referenced by ActionFactory::create(), and Action::validParams().

◆ unique_name_param

const std::string MooseBase::unique_name_param = "_unique_name"

staticinherited

The name of the parameter that contains the unique object name.

Definition at line 57 of file MooseBase.h.

Referenced by InputParameterWarehouse::addInputParameters(), AppFactory::create(), InputParameterWarehouse::removeInputParameters(), MooseBase::uniqueName(), and MooseBase::validParams().

The documentation for this class was generated from the following files:

include/actions/BatchMeshGeneratorAction.h
src/actions/BatchMeshGeneratorAction.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ DataFileParameterType

Member Enumeration Documentation

◆ MultiBatchParamsMethod

◆ ParameterType

Constructor & Destructor Documentation

◆ BatchMeshGeneratorAction()

Member Function Documentation

◆ act()

◆ addMeshGenerators()

◆ addRelationshipManagers() [1/2]

◆ addRelationshipManagers() [2/2]

◆ appendTask()

◆ assertParamDefined() [1/2]

◆ assertParamDefined() [2/2]

◆ associateWithParameter() [1/2]

◆ associateWithParameter() [2/2]

◆ callMooseError() [1/2]

◆ callMooseError() [2/2]

◆ checkBlockwiseConsistency()

◆ checkInputParametersTypes()

◆ checkInputParameterType()

◆ checkParamsBothSetOrNotSet()

◆ checkSecondParamNotSetIfFirstOneSet()

◆ checkSecondParamSetOnlyIfFirstOneSet()

◆ checkSecondParamSetOnlyIfFirstOneTrue()

◆ checkTwoDVectorParamInnerSameLengthAsOneDVector()

◆ checkTwoDVectorParamMultiMooseEnumSameLength()

◆ checkTwoDVectorParamsNoRespectiveOverlap()

◆ checkTwoDVectorParamsSameLength()

◆ checkVectorParamAndMultiMooseEnumLength()

◆ checkVectorParamLengthSameAsCombinedOthers()

◆ checkVectorParamNotEmpty()

◆ checkVectorParamsNoOverlap()

◆ checkVectorParamsSameLength()

◆ checkVectorParamsSameLengthIfSet()

◆ connectControllableParams()

◆ convertAndSetCompoundRealScalarVector()

◆ convertAndSetNumericVector()

◆ convertAndSetStringLikeVector()

◆ convertStringToCompoundRealScalar()

◆ errorDependentParameter()

◆ errorInconsistentDependentParameter()

◆ errorPrefix()

◆ getAllTasks()

◆ getBase()

◆ getCheckedPointerParam()

◆ getDataFileName()

◆ getDataFileNameByName()

◆ getDataFilePath()

◆ getHitNode()

◆ getMeshProperty() [1/2]

◆ getMeshProperty() [2/2]

◆ getMooseApp()

◆ getParam() [1/2]

◆ getParam() [2/2]

◆ getRenamedParam()

◆ hasBase()

◆ hasMeshProperty() [1/4]

◆ hasMeshProperty() [2/4]

◆ hasMeshProperty() [3/4]

◆ hasMeshProperty() [4/4]

◆ isCompoundRealScalarType()

◆ isParamSetByUser()

◆ isParamValid()

◆ meshPropertyName() [1/2]

◆ meshPropertyName() [2/2]

◆ messagePrefix()

◆ mooseDeprecated()

◆ mooseDocumentedError()

◆ mooseError()