The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system. More...

#include <InputParameters.h>

Inheritance diagram for InputParameters:

Classes
struct	Metadata

Public Member Functions
	InputParameters (const InputParameters &rhs)

	InputParameters (const Parameters &rhs)

virtual	~InputParameters ()=default

virtual void	clear () override

void	addClassDescription (const std::string &doc_string)
	This method adds a description of the class that will be displayed in the input file syntax dump. More...

std::string	getClassDescription () const
	Returns the class description. More...

virtual void	set_attributes (const std::string &name, bool inserted_only) override
	Override from libMesh to set user-defined attributes on our parameter. More...

template<typename T >
T &	set (const std::string &name, bool quiet_mode=false)
	Returns a writable reference to the named parameters. More...

template<typename T , typename UP_T >
void	rangeCheck (const std::string &full_name, const std::string &short_name, InputParameters::Parameter< T > *param, std::ostream &oss=Moose::out)
	Runs a range on the supplied parameter if it exists and throws an error if that check fails. More...

template<typename T , typename UP_T >
void	rangeCheck (const std::string &full_name, const std::string &short_name, InputParameters::Parameter< std::vector< T >> *param, std::ostream &oss=Moose::out)

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...

template<typename T >
void	addRequiredParam (const std::string &name, const std::string &doc_string)
	This method adds a parameter and documentation string to the InputParameters object that will be extracted from the input file. More...

template<typename T >
void	addRequiredParam (const std::string &name, const T &moose_enum, const std::string &doc_string)
	This version of addRequiredParam is here for a consistent use with MooseEnums. More...

template<typename T , typename S >
void	addParam (const std::string &name, const S &value, const std::string &doc_string)
	These methods add an option parameter and a documentation string to the InputParameters object. More...

template<typename T >
void	addParam (const std::string &name, const std::string &doc_string)

template<typename T >
void	addRequiredRangeCheckedParam (const std::string &name, const std::string &parsed_function, const std::string &doc_string)
	These methods add an range checked parameters. More...

template<typename T >
void	addRangeCheckedParam (const std::string &name, const T &value, const std::string &parsed_function, const std::string &doc_string)

template<typename T >
void	addRangeCheckedParam (const std::string &name, const std::string &parsed_function, const std::string &doc_string)

template<typename T >
void	addRequiredCustomTypeParam (const std::string &name, const std::string &custom_type, const std::string &doc_string)
	These methods add an option parameter and with a customer type to the InputParameters object. More...

template<typename T >
void	addCustomTypeParam (const std::string &name, const T &value, const std::string &custom_type, const std::string &doc_string)

template<typename T >
void	addCustomTypeParam (const std::string &name, const std::string &custom_type, const std::string &doc_string)

template<typename T >
void	addPrivateParam (const std::string &name, const T &value)
	These method add a parameter to the InputParameters object which can be retrieved like any other parameter. More...

template<typename T >
void	addPrivateParam (const std::string &name)

template<typename T >
void	addRequiredCommandLineParam (const std::string &name, const std::string &syntax, const std::string &doc_string)
	Add parameters for retrieval from the command line. More...

template<typename T >
void	addCommandLineParam (const std::string &name, const std::string &syntax, const std::string &doc_string)

template<typename T >
void	addCommandLineParam (const std::string &name, const std::string &syntax, const T &value, const std::string &doc_string)

template<typename T >
void	addDeprecatedParam (const std::string &name, const T &value, const std::string &doc_string, const std::string &deprecation_message)

template<typename T >
void	addDeprecatedParam (const std::string &name, const std::string &doc_string, const std::string &deprecation_message)

template<typename T >
void	checkConsistentType (const std::string &name) const
	This method checks to make sure that we aren't adding a parameter with the same name but a different type. More...

std::vector< std::string >	getSyntax (const std::string &name)
	Get the syntax for a command-line parameter. More...

const std::string &	getDescription (const std::string &name)
	Get the documentation string for a parameter. More...

void	addParamNamesToGroup (const std::string &space_delim_names, const std::string group_name)
	This method takes a space delimited list of parameter names and adds them to the specified group name. More...

std::string	getGroupName (const std::string &param_name) const
	This method retrieves the group name for the passed parameter name if one exists. More...

template<typename T >
void	suppressParameter (const std::string &name)
	This method suppresses an inherited parameter so that it isn't required or valid in the derived class. More...

template<typename T >
void	makeParamRequired (const std::string &name)
	Changes the parameter to be required. More...

void	addCoupledVar (const std::string &name, const std::string &doc_string)
	This method adds a coupled variable name pair. More...

void	addCoupledVar (const std::string &name, const Real value, const std::string &doc_string)
	This method adds a coupled variable name pair. More...

void	addCoupledVar (const std::string &name, const std::vector< Real > &value, const std::string &doc_string)
	This method adds a coupled variable name pair. More...

std::string	getMooseType (const std::string &name) const
	Utility functions for retrieving one of the MooseTypes variables into the common "string" base class. More...

std::vector< std::string >	getVecMooseType (const std::string &name) const

void	addRequiredCoupledVar (const std::string &name, const std::string &doc_string)
	This method adds a coupled variable name pair. More...

std::string	getDocString (const std::string &name) const
	Returns the documentation string for the specified parameter name. More...

void	setDocString (const std::string &name, const std::string &doc)
	Set the doc string of a parameter. More...

bool	isParamRequired (const std::string &name) const
	Returns a boolean indicating whether the specified parameter is required or not. More...

bool	isParamValid (const std::string &name) const
	This method returns parameters that have been initialized in one fashion or another, i.e. More...

bool	isParamSetByAddParam (const std::string &name) const
	Returns whether or not the parameter was set due to addParam. More...

bool	isParamDeprecated (const std::string &name) const
	Returns True if the parameters is deprecated. More...

bool	areAllRequiredParamsValid () const
	This method returns true if all of the parameters in this object are valid (i.e. More...

std::string	type (const std::string &name)
	Prints the type of the requested parameter by name. More...

bool	isPrivate (const std::string &name) const
	Returns a Boolean indicating whether the specified parameter is private or not. More...

void	declareControllable (const std::string &name)
	Declare the given parameters as controllable. More...

void	markControlled (const std::string &name)
	Marker a parameter that has been changed by the Control system (this is for output purposes) More...

bool	isControllable (const std::string &name)
	Returns a Boolean indicating whether the specified parameter is controllable. More...

void	registerBase (const std::string &value)
	This method must be called from every base "Moose System" to create linkage with the Action System. More...

void	registerBuildableTypes (const std::string &names)
	This method is here to indicate which Moose types a particular Action may build. More...

void	registerRelationshipManagers (const std::string &names, const std::string &use_as_rm_types="")
	Declares the types of RelationshipManagers that the owning object will either construct (in the case of Actions) or requires (in the case of every other MooseObject). More...

const std::vector< std::string > &	getBuildableTypes () const
	Returns the list of buildable types as a std::vector<std::string> More...

const std::vector< std::pair< std::string, Moose::RelationshipManagerType > > &	getBuildableRelationshipManagerTypes () const
	Returns the list of buildable (or required) RelationshipManager object types for this object. More...

void	checkParams (const std::string &parsing_syntax)
	This function checks parameters stored in the object to make sure they are in the correct state as the user expects: Required parameters are verified as valid meaning that they were either initialized when they were created, or were read from an input file or some other valid source. More...

std::set< std::string >::const_iterator	coupledVarsBegin () const
	Methods returning iterators to the coupled variables names stored in this InputParameters object. More...

std::set< std::string >::const_iterator	coupledVarsEnd () const

const std::set< std::string > &	getCoupledVariableParamNames () const
	Return the coupled variable parameter names. More...

bool	hasCoupledValue (const std::string &coupling_name) const
	Return whether or not the coupled variable exists. More...

bool	hasDefaultCoupledValue (const std::string &coupling_name) const
	Return whether or not the requested parameter has a default coupled value. More...

Real	defaultCoupledValue (const std::string &coupling_name, unsigned int i=0) const
	Get the default value for an optionally coupled variable. More...

unsigned int	numberDefaultCoupledValues (const std::string &coupling_name) const
	Get the number of defaulted coupled value entries. More...

void	defaultCoupledValue (const std::string &coupling_name, Real value, unsigned int i=0)
	Set the default value for an optionally coupled variable (called by the Parser). More...

std::map< std::string, std::pair< std::string, std::string > >	getAutoBuildVectors () const
	Returns the auto build vectors for all parameters. More...

const PostprocessorValue &	getDefaultPostprocessorValue (const std::string &name, bool suppress_error=false) const
	Get the default value for a postprocessor added with addPostprocessor. More...

void	setDefaultPostprocessorValue (const std::string &name, const PostprocessorValue &value)
	Set the default value for a postprocessor added with addPostprocessor. More...

bool	hasDefaultPostprocessorValue (const std::string &name) const
	Returns true if a default PostprocessorValue is defined. More...

void	applyParameters (const InputParameters &common, std::vector< std::string > exclude=std::vector< std::string >())
	Method for applying common parameters. More...

void	applySpecificParameters (const InputParameters &common, const std::vector< std::string > &include)
	Method for applying common parameters. More...

void	applyParameter (const InputParameters &common, const std::string &common_name)
	Apply values from a single parameter in common, to a single parameter stored in this object. More...

void	applyCoupledVar (const InputParameters &common, const std::string &var_name)
	Apply properties of a single coupled variable in common, to a single coupled variable stored in this object. More...

bool	paramSetByUser (const std::string &name) const
	Deprecated method. More...

bool	isParamSetByUser (const std::string &name) const
	Method returns true if the parameter was by the user. More...

std::set< std::string >	getControllableParameters () const
	Return list of controllable parameters. More...

void	setReservedValues (const std::string &name, const std::set< std::string > &reserved)
	Provide a set of reserved values for a parameter. More...

std::set< std::string >	reservedValues (const std::string &name) const
	Get a set of reserved parameter values. More...

std::string &	blockLocation ()
	Get/set a string representing the location (i.e. More...

std::string &	rawParamVal (const std::string &param)
	Get/set a string representing the raw, unmodified token text for the given param. More...

template<>
void	addRequiredParam (const std::string &name, const MooseEnum &moose_enum, const std::string &doc_string)

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

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

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

template<>
void	addPrivateParam (const std::string &)

template<>
void	addPrivateParam (const std::string &)

template<>
void	addDeprecatedParam (const std::string &name, const std::string &doc_string, const std::string &deprecation_message)

template<>
void	addDeprecatedParam (const std::string &name, const std::string &doc_string, const std::string &deprecation_message)

template<>
const MooseEnum &	getParamHelper (const std::string &name, const InputParameters &pars, const MooseEnum *)

template<>
const MultiMooseEnum &	getParamHelper (const std::string &name, const InputParameters &pars, const MultiMooseEnum *)

template<>
void	addRequiredParam (const std::string &name, const MooseEnum &moose_enum, const std::string &doc_string)

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

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

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

template<>
void	addPrivateParam (const std::string &)

template<>
void	addPrivateParam (const std::string &)

template<>
void	addDeprecatedParam (const std::string &, const std::string &, const std::string &)

template<>
void	addDeprecatedParam (const std::string &, const std::string &, const std::string &)

template<>
const MooseEnum &	getParamHelper (const std::string &name, const InputParameters &pars, const MooseEnum *)

template<>
const MultiMooseEnum &	getParamHelper (const std::string &name, const InputParameters &pars, const MultiMooseEnum *)


void	addCoupledVarWithAutoBuild (const std::string &name, const std::string &base_name, const std::string &num_name, const std::string &doc_string)
	These methods add a coupled variable name pair. More...

void	addRequiredCoupledVarWithAutoBuild (const std::string &name, const std::string &base_name, const std::string &num_name, const std::string &doc_string)


void	collapseSyntaxNesting (bool collapse)
	Mutators for controlling whether or not the outermost level of syntax will be collapsed when printed. More...

bool	collapseSyntaxNesting () const


void	mooseObjectSyntaxVisibility (bool visibility)
	Mutators for controlling whether or not the outermost level of syntax will be collapsed when printed. More...

bool	mooseObjectSyntaxVisibility () const


InputParameters &	operator= (const InputParameters &rhs)

InputParameters &	operator+= (const InputParameters &rhs)


std::string &	blockFullpath ()
	Get/set a string representing the full HIT parameter path from the input file (e.g. More...

const std::string &	blockFullpath () const


const std::string &	inputLocation (const std::string &param) const
	Get/set a string representing the location in the input text the parameter originated from (i.e. More...

std::string &	inputLocation (const std::string &param)


const std::string &	paramFullpath (const std::string &param) const
	Get/set a string representing the full HIT parameter path from the input file (e.g. More...

std::string &	paramFullpath (const std::string &param)

Static Public Member Functions

template<typename T >
static const T &	getParamHelper (const std::string &name, const InputParameters &pars, const T *the_type)

template<typename T >
static const std::vector< T > &	getParamHelper (const std::string &name, const InputParameters &pars, const std::vector< T > *the_type)

Private Member Functions
	InputParameters ()

Metadata &	at (const std::string &param)

const Metadata &	at (const std::string &param) const

void	allowCopy (bool status)
	Toggle the availability of the copy constructor. More...

void	checkParamName (const std::string &name) const
	Make sure the parameter name doesn't have any invalid characters. More...

template<typename T , typename S >
void	setParamHelper (const std::string &name, T &l_value, const S &r_value)
	This method is called when adding a Parameter with a default value, can be specialized for non-matching types. More...

template<>
void	setParamHelper (const std::string &name, PostprocessorName &l_value, const Real &r_value)

template<>
void	setParamHelper (const std::string &name, PostprocessorName &l_value, const int &r_value)

template<>
void	setParamHelper (const std::string &, FunctionName &l_value, const Real &r_value)

template<>
void	setParamHelper (const std::string &, FunctionName &l_value, const int &r_value)

template<>
void	setParamHelper (const std::string &, MaterialPropertyName &l_value, const Real &r_value)

template<>
void	setParamHelper (const std::string &, MaterialPropertyName &l_value, const int &r_value)

template<>
void	setParamHelper (const std::string &name, PostprocessorName &l_value, const Real &r_value)

template<>
void	setParamHelper (const std::string &name, PostprocessorName &l_value, const int &r_value)

template<>
void	setParamHelper (const std::string &, FunctionName &l_value, const Real &r_value)

template<>
void	setParamHelper (const std::string &, FunctionName &l_value, const int &r_value)

template<>
void	setParamHelper (const std::string &, MaterialPropertyName &l_value, const Real &r_value)

template<>
void	setParamHelper (const std::string &, MaterialPropertyName &l_value, const int &r_value)

Private Attributes
std::string	_block_location
	original location of input block (i.e. filename,linenum) - used for nice error messages. More...

std::string	_block_fullpath
	full HIT path of the block from the input file - used for nice error messages. More...

std::map< std::string, Metadata >	_params
	The actual parameter data. More...

std::set< std::string >	_coupled_vars
	The coupled variables set. More...

std::string	_class_description
	The class description for the owning object. More...

std::vector< std::string >	_buildable_types
	The parameter is used to restrict types that can be built. More...

std::vector< std::pair< std::string, Moose::RelationshipManagerType > >	_buildable_rm_types
	The RelationshipManagers that this object may either build or require. More...

bool	_collapse_nesting
	This parameter collapses one level of nesting in the syntax blocks. More...

bool	_moose_object_syntax_visibility
	This parameter hides derived MOOSE object types from appearing in syntax dumps. More...

bool	_show_deprecated_message
	Flag for disabling deprecated parameters message, this is used by applyParameters to avoid dumping messages. More...

bool	_allow_copy
	A flag for toggling the error message in the copy constructor. More...

Friends
class	InputParameterWarehouse

InputParameters	emptyInputParameters ()

Detailed Description

The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.

Definition at line 53 of file InputParameters.h.

Constructor & Destructor Documentation

◆ InputParameters() [1/3]

InputParameters::InputParameters ( const InputParameters & rhs )

Definition at line 39 of file InputParameters.C.

   : Parameters(), _show_deprecated_message(true), _allow_copy(true)
 
 {
   *this = rhs;
 }

◆ InputParameters() [2/3]

InputParameters::InputParameters ( const Parameters & rhs )

Definition at line 46 of file InputParameters.C.

   : _show_deprecated_message(true), _allow_copy(true)
 {
   _params.clear();
   Parameters::operator=(rhs);
   _collapse_nesting = false;
   _moose_object_syntax_visibility = true;
 }

◆ ~InputParameters()

virtual InputParameters::~InputParameters ( )

virtualdefault

◆ InputParameters() [3/3]

InputParameters::InputParameters ( )

private

Definition at line 30 of file InputParameters.C.

   : Parameters(),
     _collapse_nesting(false),
     _moose_object_syntax_visibility(true),
     _show_deprecated_message(true),
     _allow_copy(true)
 {
 }

Member Function Documentation

◆ addClassDescription()

void InputParameters::addClassDescription ( const std::string & doc_string )

This method adds a description of the class that will be displayed in the input file syntax dump.

Definition at line 70 of file InputParameters.C.

 {
   _class_description = doc_string;
 }

◆ addCommandLineParam() [1/2]

template<typename T >

void InputParameters::addCommandLineParam	(	const std::string &	name,
		const std::string &	syntax,
		const std::string &	doc_string
	)

Definition at line 1224 of file InputParameters.h.

Referenced by validParams< MooseApp >().

 {
   addParam<T>(name, doc_string);
   MooseUtils::tokenize(syntax, _params[name]._cli_flag_names, 1, " \t\n\v\f\r");
 }

◆ addCommandLineParam() [2/2]

template<typename T >

void InputParameters::addCommandLineParam	(	const std::string &	name,
		const std::string &	syntax,
		const T &	value,
		const std::string &	doc_string
	)

Definition at line 1234 of file InputParameters.h.

 {
   addParam<T>(name, value, doc_string);
   MooseUtils::tokenize(syntax, _params[name]._cli_flag_names, 1, " \t\n\v\f\r");
 }

◆ addCoupledVar() [1/3]

void InputParameters::addCoupledVar	(	const std::string &	name,
		const std::string &	doc_string
	)

This method adds a coupled variable name pair.

The parser will look for variable name pair in the input file and can return a reference to the storage location for the coupled variable if found

Definition at line 183 of file InputParameters.C.

Referenced by applyCoupledVar(), MatDiffusionBase< Real >::validParams(), validParams< DerivativeSumMaterial >(), validParams< ElementVectorL2Error >(), validParams< FindValueOnLine >(), validParams< NodalNormalBC >(), validParams< ParsedMaterialBase >(), validParams< QuotientAux >(), validParams< QuotientScalarAux >(), validParams< SphericalAverage >(), validParams< VectorMagnitudeAux >(), and validParams< VolumeHistogram >().

 {
   addParam<std::vector<VariableName>>(name, doc_string);
   _coupled_vars.insert(name);
 }

◆ addCoupledVar() [2/3]

void InputParameters::addCoupledVar	(	const std::string &	name,
		const Real	value,
		const std::string &	doc_string
	)

This method adds a coupled variable name pair.

The parser will look for variable name pair in the input file and can return a reference to the storage location for the coupled variable if found

Also - you can provide a default value for this variable in the case that an actual variable is not provided.

Definition at line 162 of file InputParameters.C.

 {
   addParam<std::vector<VariableName>>(name, doc_string);
   _coupled_vars.insert(name);
   _params[name]._coupled_default.assign(1, value);
   _params[name]._have_coupled_default = true;
 }

◆ addCoupledVar() [3/3]

void InputParameters::addCoupledVar	(	const std::string &	name,
		const std::vector< Real > &	value,
		const std::string &	doc_string
	)

This method adds a coupled variable name pair.

The parser will look for variable name pair in the input file and can return a reference to the storage location for the coupled variable if found

Also - you can provide a vector of values for this variable in the case that an actual variable is not provided.

Definition at line 171 of file InputParameters.C.

 {
   // std::vector<VariableName>(1, Moose::stringify(value)),
   addParam<std::vector<VariableName>>(name, doc_string);
   _coupled_vars.insert(name);
   _params[name]._coupled_default = value;
   _params[name]._have_coupled_default = true;
 }

◆ addCoupledVarWithAutoBuild()

void InputParameters::addCoupledVarWithAutoBuild	(	const std::string &	name,
		const std::string &	base_name,
		const std::string &	num_name,
		const std::string &	doc_string
	)

These methods add a coupled variable name pair.

The parser will look for variable name pair in the input file and can return a reference to the storage location for the coupled variable if found.

This version of the method will build a vector if the given the base_name and num_name parameters exist in the input file: e.g. [./foo] ... some_base = base_ some_num = 5 [../]

The coupling parameter will be passed this vector: "base_0 base_1 base_2 base_3 base_4"

Definition at line 190 of file InputParameters.C.

Referenced by addRequiredCoupledVarWithAutoBuild().

 {
   addParam<std::vector<VariableName>>(name, doc_string);
   _coupled_vars.insert(name);
   _params[name]._autobuild_vecs = std::make_pair(base_name, num_name);
 
   // Additionally there are two more parameters that need to be added:
   addParam<std::string>(base_name, doc_string + " (base_name)");
   addParam<unsigned int>(num_name, doc_string + " (num_name)");
 }

◆ addCustomTypeParam() [1/2]

template<typename T >

void InputParameters::addCustomTypeParam	(	const std::string &	name,
		const T &	value,
		const std::string &	custom_type,
		const std::string &	doc_string
	)

Definition at line 1170 of file InputParameters.h.

 {
   addParam<T>(name, value, doc_string);
   _params[name]._custom_type = custom_type;
 }

◆ addCustomTypeParam() [2/2]

template<typename T >

void InputParameters::addCustomTypeParam	(	const std::string &	name,
		const std::string &	custom_type,
		const std::string &	doc_string
	)

Definition at line 1181 of file InputParameters.h.

 {
   addParam<T>(name, doc_string);
   _params[name]._custom_type = custom_type;
 }

◆ addDeprecatedParam() [1/6]

template<typename T >

void InputParameters::addDeprecatedParam	(	const std::string &	name,
		const T &	value,
		const std::string &	doc_string,
		const std::string &	deprecation_message
	)

Parameters

name	The name of the parameter
value	The default value of this parameter if it requires one
doc_string	Documentation. This will be shown for –help
deprecation_message	The message that will will print about why this param was deprecated. It might mention the "new way".

Definition at line 1282 of file InputParameters.h.

Referenced by validParams< AdaptivityAction >(), validParams< CommonOutputAction >(), validParams< DerivativeFunctionMaterialBase >(), validParams< DerivativeParsedMaterialHelper >(), validParams< Executioner >(), validParams< GenericFunctionMaterial >(), validParams< OversampleOutput >(), validParams< PetscOutput >(), and validParams< Transient >().

 {
   _show_deprecated_message = false;
   addParam<T>(name, value, doc_string);
 
   _params[name]._deprecation_message = deprecation_message;
   _show_deprecated_message = true;
 }

◆ addDeprecatedParam() [2/6]

template<typename T >

void InputParameters::addDeprecatedParam	(	const std::string &	name,
		const std::string &	doc_string,
		const std::string &	deprecation_message
	)

Definition at line 1296 of file InputParameters.h.

 {
   _show_deprecated_message = false;
   addParam<T>(name, doc_string);
 
   _params[name]._deprecation_message = deprecation_message;
   _show_deprecated_message = true;
 }

◆ addDeprecatedParam() [3/6]

template<>

void InputParameters::addDeprecatedParam	(	const std::string &	,
		const std::string &	,
		const std::string &
	)

Definition at line 892 of file InputParameters.C.

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

◆ addDeprecatedParam() [4/6]

template<>

void InputParameters::addDeprecatedParam	(	const std::string &	,
		const std::string &	,
		const std::string &
	)

Definition at line 902 of file InputParameters.C.

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

◆ addDeprecatedParam() [5/6]

template<>

void InputParameters::addDeprecatedParam	(	const std::string &	name,
		const std::string &	doc_string,
		const std::string &	deprecation_message
	)

◆ addDeprecatedParam() [6/6]

template<>

void InputParameters::addDeprecatedParam	(	const std::string &	name,
		const std::string &	doc_string,
		const std::string &	deprecation_message
	)

◆ addParam() [1/6]

template<typename T , typename S >

void InputParameters::addParam	(	const std::string &	name,
		const S &	value,
		const std::string &	doc_string
	)

These methods add an option parameter and a documentation string to the InputParameters object.

The first version of this function takes a default value which is used if the parameter is not found in the input file. The second method will leave the parameter uninitialized but can be checked with "isParamValid" before use.

Definition at line 1092 of file InputParameters.h.

 {
   checkParamName(name);
   checkConsistentType<T>(name);
 
   T & l_value = InputParameters::set<T>(name);
   _params[name]._doc_string = doc_string;
 
   // Set the parameter now
   setParamHelper(name, l_value, value);
 
   /* Indicate the default value, as set via addParam, is being used. The parameter is removed from
      the list whenever
      it changes, see set_attributes */
   _params[name]._set_by_add_param = true;
 }

◆ addParam() [2/6]

template<typename T >

void InputParameters::addParam	(	const std::string &	name,
		const std::string &	doc_string
	)

Definition at line 1111 of file InputParameters.h.

 {
   checkParamName(name);
   checkConsistentType<T>(name);
 
   InputParameters::insert<T>(name);
   _params[name]._doc_string = doc_string;
 }

◆ addParam() [3/6]

template<>

void InputParameters::addParam	(	const std::string &	,
		const std::string &
	)

Definition at line 849 of file InputParameters.C.

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

◆ addParam() [4/6]

template<>

void InputParameters::addParam	(	const std::string &	,
		const std::string &
	)

Definition at line 858 of file InputParameters.C.

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

◆ addParam() [5/6]

template<>

void InputParameters::addParam	(	const std::string &	,
		const std::string &
	)

◆ addParam() [6/6]

template<>

void InputParameters::addParam	(	const std::string &	,
		const std::string &
	)

◆ addParamNamesToGroup()

void InputParameters::addParamNamesToGroup	(	const std::string &	space_delim_names,
		const std::string	group_name
	)

This method takes a space delimited list of parameter names and adds them to the specified group name.

This information is used in the GUI to group parameters into logical sections.

Definition at line 591 of file InputParameters.C.

Referenced by AdvancedOutput::addValidParams(), ShapeUserObject< SideUserObject >::validParams(), validParams< Checkpoint >(), validParams< CopyNodalVarsAction >(), validParams< DerivativeSumMaterial >(), validParams< DistributedGeneratedMesh >(), validParams< EigenExecutionerBase >(), validParams< Executioner >(), validParams< FileOutput >(), validParams< FunctionParserUtils >(), validParams< GeneratedMesh >(), validParams< GeneratedMeshGenerator >(), validParams< GMVOutput >(), validParams< ImageSampler >(), validParams< LeastSquaresFitHistory >(), validParams< MaterialStdVectorAux >(), validParams< MeshBaseImageSampler >(), validParams< MooseMesh >(), validParams< MooseObject >(), validParams< NodalPatchRecovery >(), validParams< OutputInterface >(), validParams< OversampleOutput >(), validParams< PetscOutput >(), validParams< Postprocessor >(), validParams< RandomInterface >(), validParams< SetupMeshAction >(), validParams< TaggingInterface >(), validParams< Tecplot >(), validParams< Transient >(), validParams< TransientInterface >(), and validParams< VTKOutput >().

 {
   std::vector<std::string> elements;
   MooseUtils::tokenize(space_delim_names, elements, 1, " \t\n\v\f\r"); // tokenize on whitespace
 
   // Since we don't require types (templates) for this method, we need
   // to get a raw list of parameter names to compare against.
   std::set<std::string> param_names;
   for (const auto & it : *this)
     param_names.insert(it.first);
 
   for (const auto & param_name : elements)
     if (_params.count(param_name) > 0)
       _params[param_name]._group = group_name;
     else
       mooseError("Unable to find a parameter with name: ",
                  param_name,
                  " when adding to group ",
                  group_name,
                  '.');
 }

◆ addPrivateParam() [1/6]

template<typename T >

void InputParameters::addPrivateParam	(	const std::string &	name,
		const T &	value
	)

These method add a parameter to the InputParameters object which can be retrieved like any other parameter.

This parameter however is not printed in the Input file syntax dump or web page dump so does not take a documentation string. The first version of this function takes an optional default value.

Definition at line 1202 of file InputParameters.h.

Referenced by AddControlAction::act(), FEProblemBase::addOutput(), ActionFactory::create(), ActionFactory::getValidParams(), Factory::getValidParams(), validParams< Action >(), validParams< BlockRestrictable >(), validParams< BoundaryRestrictable >(), validParams< BoundaryRestrictableRequired >(), validParams< CreateProblemDefaultAction >(), validParams< DisplacedProblem >(), validParams< EigenExecutionerBase >(), validParams< Eigenvalue >(), validParams< ExecutionerAttributeReporter >(), validParams< GlobalParamsAction >(), validParams< InternalSideIndicator >(), validParams< MaterialPropertyInterface >(), validParams< MeshModifier >(), validParams< MooseApp >(), validParams< MooseObject >(), validParams< MoosePartitioner >(), validParams< MoosePreconditioner >(), validParams< NodalNormalsPreprocessor >(), validParams< RelationshipManager >(), validParams< SubProblem >(), and validParams< XDA >().

 {
   checkParamName(name);
   checkConsistentType<T>(name);
 
   InputParameters::set<T>(name) = value;
   _params[name]._is_private = true;
   _params[name]._set_by_add_param = true;
 }

◆ addPrivateParam() [2/6]

template<typename T >

void InputParameters::addPrivateParam ( const std::string & name )

Definition at line 1191 of file InputParameters.h.

 {
   checkParamName(name);
   checkConsistentType<T>(name);
 
   InputParameters::insert<T>(name);
   _params[name]._is_private = true;
 }

◆ addPrivateParam() [3/6]

template<>

void InputParameters::addPrivateParam ( const std::string & )

Definition at line 876 of file InputParameters.C.

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

◆ addPrivateParam() [4/6]

template<>

void InputParameters::addPrivateParam ( const std::string & )

Definition at line 884 of file InputParameters.C.

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

◆ addPrivateParam() [5/6]

template<>

void InputParameters::addPrivateParam ( const std::string & )

◆ addPrivateParam() [6/6]

template<>

void InputParameters::addPrivateParam ( const std::string & )

◆ addRangeCheckedParam() [1/2]

template<typename T >

void InputParameters::addRangeCheckedParam	(	const std::string &	name,
		const T &	value,
		const std::string &	parsed_function,
		const std::string &	doc_string
	)

Definition at line 1139 of file InputParameters.h.

Referenced by validParams< AdaptivityAction >(), validParams< AnnularMesh >(), validParams< AnnularMeshGenerator >(), validParams< ConcentricCircleMesh >(), validParams< ConcentricCircleMeshGenerator >(), validParams< ConstantDT >(), validParams< DerivativeFunctionMaterialBase >(), validParams< DistributedGeneratedMesh >(), validParams< ElementLpNormAux >(), validParams< ElementPointNeighbors >(), validParams< ElementSideNeighborLayers >(), validParams< ElementW1pError >(), validParams< ErrorFractionMarker >(), validParams< GeneratedMesh >(), validParams< GeneratedMeshGenerator >(), validParams< IterationAdaptiveDT >(), validParams< LogConstantDT >(), validParams< NewmarkBeta >(), validParams< PatternedMesh >(), validParams< PatternedMeshGenerator >(), validParams< SideSetsAroundSubdomain >(), and validParams< SideSetsAroundSubdomainGenerator >().

 {
   addParam<T>(name, value, doc_string);
   _params[name]._range_function = parsed_function;
 }

◆ addRangeCheckedParam() [2/2]

template<typename T >

void InputParameters::addRangeCheckedParam	(	const std::string &	name,
		const std::string &	parsed_function,
		const std::string &	doc_string
	)

Definition at line 1150 of file InputParameters.h.

 {
   addParam<T>(name, doc_string);
   _params[name]._range_function = parsed_function;
 }

◆ addRequiredCommandLineParam()

template<typename T >

void InputParameters::addRequiredCommandLineParam	(	const std::string &	name,
		const std::string &	syntax,
		const std::string &	doc_string
	)

Add parameters for retrieval from the command line.

NOTE: This ONLY works for App objects! This is not valid for normal MOOSE objects!

Parameters

name	The name of the parameter
syntax	Space separated list of command-line switch syntax that can set this option
doc_string	Documentation. This will be shown for –help

Definition at line 1214 of file InputParameters.h.

 {
   addRequiredParam<T>(name, doc_string);
   MooseUtils::tokenize(syntax, _params[name]._cli_flag_names, 1, " \t\n\v\f\r");
 }

◆ addRequiredCoupledVar()

void InputParameters::addRequiredCoupledVar	(	const std::string &	name,
		const std::string &	doc_string
	)

This method adds a coupled variable name pair.

The parser will look for variable name pair in the input file and can return a reference to the storage location for the coupled variable. If the coupled variable is not supplied in the input file, and error is thrown.

Version 2: An auto built vector will be built from the base_name and num_name param. See addCoupledVar for an example

Definition at line 216 of file InputParameters.C.

 {
   addRequiredParam<std::vector<VariableName>>(name, doc_string);
   _coupled_vars.insert(name);
 }

◆ addRequiredCoupledVarWithAutoBuild()

void InputParameters::addRequiredCoupledVarWithAutoBuild	(	const std::string &	name,
		const std::string &	base_name,
		const std::string &	num_name,
		const std::string &	doc_string
	)

Definition at line 205 of file InputParameters.C.

 {
   addRequiredParam<std::vector<VariableName>>(name, doc_string);
 
   addCoupledVarWithAutoBuild(name, base_name, num_name, doc_string);
 }

◆ addRequiredCustomTypeParam()

template<typename T >

void InputParameters::addRequiredCustomTypeParam	(	const std::string &	name,
		const std::string &	custom_type,
		const std::string &	doc_string
	)

These methods add an option parameter and with a customer type to the InputParameters object.

The custom type will be output in YAML dumps and can be used within the GUI application.

Definition at line 1160 of file InputParameters.h.

Referenced by validParams< MooseParsedFunction >(), and validParams< Terminator >().

 {
   addRequiredParam<T>(name, doc_string);
   _params[name]._custom_type = custom_type;
 }

◆ addRequiredParam() [1/6]

template<typename T >

void InputParameters::addRequiredParam	(	const std::string &	name,
		const std::string &	doc_string
	)

This method adds a parameter and documentation string to the InputParameters object that will be extracted from the input file.

If the parameter is missing in the input file, and error will be thrown

Definition at line 1070 of file InputParameters.h.

 {
   checkParamName(name);
   checkConsistentType<T>(name);
 
   InputParameters::insert<T>(name);
   _params[name]._required = true;
   _params[name]._doc_string = doc_string;
 }

◆ addRequiredParam() [2/6]

template<typename T >

void InputParameters::addRequiredParam	(	const std::string &	name,
		const T &	moose_enum,
		const std::string &	doc_string
	)

This version of addRequiredParam is here for a consistent use with MooseEnums.

Use of this function for any other type will throw an error.

Definition at line 1082 of file InputParameters.h.

 {
   mooseError("You cannot call addRequiredParam and supply a default value for this type, please "
              "use addParam instead");
 }

◆ addRequiredParam() [3/6]

template<>

void InputParameters::addRequiredParam	(	const std::string &	name,
		const MooseEnum &	moose_enum,
		const std::string &	doc_string
	)

Definition at line 813 of file InputParameters.C.

 {
   InputParameters::set<MooseEnum>(name) = moose_enum; // valid parameter is set by set_attributes
   _params[name]._required = true;
   _params[name]._doc_string = doc_string;
 }

◆ addRequiredParam() [4/6]

template<>

void InputParameters::addRequiredParam	(	const std::string &	name,
		const MultiMooseEnum &	moose_enum,
		const std::string &	doc_string
	)

Definition at line 824 of file InputParameters.C.

 {
   InputParameters::set<MultiMooseEnum>(name) =
       moose_enum; // valid parameter is set by set_attributes
   _params[name]._required = true;
   _params[name]._doc_string = doc_string;
 }

◆ addRequiredParam() [5/6]

template<>

void InputParameters::addRequiredParam	(	const std::string &	name,
		const MooseEnum &	moose_enum,
		const std::string &	doc_string
	)

◆ addRequiredParam() [6/6]

template<>

void InputParameters::addRequiredParam	(	const std::string &	name,
		const MultiMooseEnum &	moose_enum,
		const std::string &	doc_string
	)

◆ addRequiredRangeCheckedParam()

template<typename T >

void InputParameters::addRequiredRangeCheckedParam	(	const std::string &	name,
		const std::string &	parsed_function,
		const std::string &	doc_string
	)

These methods add an range checked parameters.

A lower and upper bound can be supplied and the supplied parameter will be checked to fall within that range.

Definition at line 1129 of file InputParameters.h.

Referenced by validParams< AnnularMesh >(), validParams< AnnularMeshGenerator >(), validParams< LogConstantDT >(), validParams< MaxIncrement >(), validParams< SpiralAnnularMesh >(), validParams< SpiralAnnularMeshGenerator >(), and validParams< VectorPostprocessorFunction >().

 {
   addRequiredParam<T>(name, doc_string);
   _params[name]._range_function = parsed_function;
 }

◆ allowCopy()

void InputParameters::allowCopy ( bool status )

inlineprivate

Toggle the availability of the copy constructor.

When MooseObject is created via the Factory this flag is set to false, so when a MooseObject is created if the constructor is not a const reference an error is produced. This method allows the InputParameterWarehouse to disable copying.

Definition at line 820 of file InputParameters.h.

820 { _allow_copy = status; }

InputParameters::_allow_copy

bool _allow_copy

A flag for toggling the error message in the copy constructor.

Definition: InputParameters.h:873

◆ applyCoupledVar()

void InputParameters::applyCoupledVar	(	const InputParameters &	common,
		const std::string &	var_name
	)

Apply properties of a single coupled variable in common, to a single coupled variable stored in this object.

Parameters

common	The set of InputParameters from which to extract the coupled variable's properties
var_name	The name of the coupled variable whose properties are to be applied

In order to apply the properties, both the local parameters and the common parameters must have a coupled variable with name var_name

Definition at line 722 of file InputParameters.C.

Referenced by applyParameters(), and applySpecificParameters().

 {
   // Disable the display of deprecated message when applying common parameters, this avoids a dump
   // of messages
   _show_deprecated_message = false;
 
   // If the local parameters has a coupled variable, populate it with the value from the common
   // parameters, if the common parameters has the coupled variable too
   if (hasCoupledValue(var_name))
   {
     if (common.hasDefaultCoupledValue(var_name))
     {
       // prepare a vector of default coupled values
       std::vector<Real> defaults(common.numberDefaultCoupledValues(var_name));
       for (unsigned int j = 0; j < common.numberDefaultCoupledValues(var_name); ++j)
         defaults[j] = common.defaultCoupledValue(var_name, j);
       addCoupledVar(var_name, defaults, common.getDocString(var_name));
     }
     else if (common.hasCoupledValue(var_name))
       addCoupledVar(var_name, common.getDocString(var_name));
   }
 
   // Enable deprecated message printing
   _show_deprecated_message = true;
 }

◆ applyParameter()

void InputParameters::applyParameter	(	const InputParameters &	common,
		const std::string &	common_name
	)

Apply values from a single parameter in common, to a single parameter stored in this object.

Parameters

common	The set of InputParameters from which to extract parameters from
common_name	The name within common from which to get the parameter values

In order to apply common parameter 4 statements must be satisfied (1) A local parameter must exist with the same name as common parameter (2) Common parameter must valid (3) Local parameter must be invalid OR not have been set from its default (4) Both cannot be private

Definition at line 749 of file InputParameters.C.

Referenced by applyParameters(), and applySpecificParameters().

 {
   // Disable the display of deprecated message when applying common parameters, this avoids a dump
   // of messages
   _show_deprecated_message = false;
 
   // Extract the properties from the local parameter for the current common parameter name
   const bool local_exist = _values.find(common_name) != _values.end();
   const bool local_set = _params.count(common_name) > 0 && !_params[common_name]._set_by_add_param;
   const bool local_priv = isPrivate(common_name);
   const bool local_valid = isParamValid(common_name);
 
   // Extract the properties from the common parameter
   const bool common_exist = common._values.find(common_name) != common._values.end();
   const bool common_priv = common.isPrivate(common_name);
   const bool common_valid = common.isParamValid(common_name);
 
   /* In order to apply common parameter 4 statements must be satisfied
    * (1) A local parameter must exist with the same name as common parameter
    * (2) Common parameter must valid and exist
    * (3) Local parameter must be invalid OR not have been set from its default
    * (4) Both cannot be private
    */
   if (local_exist && common_exist && common_valid && (!local_valid || !local_set) &&
       (!common_priv || !local_priv))
   {
     delete _values[common_name];
     _values[common_name] = common._values.find(common_name)->second->clone();
     set_attributes(common_name, false);
   }
 
   // Enable deprecated message printing
   _show_deprecated_message = true;
 }

◆ applyParameters()

void InputParameters::applyParameters	(	const InputParameters &	common,
		std::vector< std::string >	exclude = `std::vector<std::string>()`
	)

Method for applying common parameters.

Parameters

common	The set of parameters to apply to the parameters stored in this object
exclude	A vector of parameters to exclude

In order to apply common parameter 4 statements must be satisfied (1) A local parameter must exist with the same name as common parameter (2) Common parameter must valid (3) Local parameter must be invalid OR not have been set from its default (4) Both cannot be private

Output objects have a set of common parameters that are passed down to each of the output objects created. This method is used for applying those common parameters.

See also: CommonOutputAction AddOutputAction

Definition at line 655 of file InputParameters.C.

Referenced by SetupMeshAction::act(), FEProblemBase::addOutput(), MooseADObjectAction::addRelationshipManagers(), and MooseObjectAction::addRelationshipManagers().

 {
   // Loop through the common parameters
   for (const auto & it : common)
   {
     // Common parameter name
     const std::string & common_name = it.first;
 
     // Continue to next parameter, if the current is in list of  excluded parameters
     if (std::find(exclude.begin(), exclude.end(), common_name) != exclude.end())
       continue;
 
     applyParameter(common, common_name);
   }
 
   // Loop through the coupled variables
   for (std::set<std::string>::const_iterator it = common.coupledVarsBegin();
        it != common.coupledVarsEnd();
        ++it)
   {
     // Variable name
     const std::string var_name = *it;
 
     // Continue to next variable, if the current is in list of  excluded parameters
     if (std::find(exclude.begin(), exclude.end(), var_name) != exclude.end())
       continue;
 
     applyCoupledVar(common, var_name);
   }
 }

◆ applySpecificParameters()

void InputParameters::applySpecificParameters	(	const InputParameters &	common,
		const std::vector< std::string > &	include
	)

Method for applying common parameters.

Parameters

common	The set of parameters to apply to the parameters stored in this object
include	A vector of parameters to apply

In order to apply common parameter 4 statements must be satisfied (1) A local parameter must exist with the same name as common parameter (2) Common parameter must valid (3) Local parameter must be invalid OR not have been set from its default (4) Both cannot be private

Output objects have a set of common parameters that are passed down to each of the output objects created. This method is used for applying those common parameters.

See also: CommonOutputAction AddOutputAction

Definition at line 688 of file InputParameters.C.

 {
   // Loop through the common parameters
   for (const auto & it : common)
   {
 
     // Common parameter name
     const std::string & common_name = it.first;
 
     // Continue to next parameter, if the current is not in list of included parameters
     if (std::find(include.begin(), include.end(), common_name) == include.end())
       continue;
 
     applyParameter(common, common_name);
   }
 
   // Loop through the coupled variables
   for (std::set<std::string>::const_iterator it = common.coupledVarsBegin();
        it != common.coupledVarsEnd();
        ++it)
   {
     // Variable name
     const std::string var_name = *it;
 
     // Continue to next variable, if the current is not in list of included parameters
     if (std::find(include.begin(), include.end(), var_name) == include.end())
       continue;
 
     applyCoupledVar(common, var_name);
   }
 }

◆ areAllRequiredParamsValid()

bool InputParameters::areAllRequiredParamsValid ( ) const

This method returns true if all of the parameters in this object are valid (i.e.

isParamValid(name) == true - for all parameters)

Definition at line 282 of file InputParameters.C.

Referenced by ActionWarehouse::buildBuildableActions().

 {
   for (const auto & it : *this)
     if (isParamRequired(it.first) && !isParamValid(it.first))
       return false;
   return true;
 }

◆ at() [1/2]

Metadata& InputParameters::at ( const std::string & param )

inlineprivate

Definition at line 798 of file InputParameters.h.

Referenced by inputLocation(), and paramFullpath().

   {
     if (_params.count(param) == 0)
       mooseError("param '", param, "' not present in InputParams");
     return _params[param];
   }

◆ at() [2/2]

const Metadata& InputParameters::at ( const std::string & param ) const

inlineprivate

Definition at line 804 of file InputParameters.h.

   {
     if (_params.count(param) == 0)
       mooseError("param '", param, "' not present in InputParams");
     return _params.at(param);
   }

◆ blockFullpath() [1/2]

std::string& InputParameters::blockFullpath ( )

inline

Get/set a string representing the full HIT parameter path from the input file (e.g.

"Mesh/foo") for the block containing parameters for this object.

Definition at line 718 of file InputParameters.h.

Referenced by AddICAction::act(), checkParams(), MooseADObjectAction::MooseADObjectAction(), and MooseObjectAction::MooseObjectAction().

718 { return _block_fullpath; }

InputParameters::_block_fullpath

std::string _block_fullpath

full HIT path of the block from the input file - used for nice error messages.

Definition: InputParameters.h:838

◆ blockFullpath() [2/2]

const std::string& InputParameters::blockFullpath ( ) const

inline

Definition at line 719 of file InputParameters.h.

719 { return _block_fullpath; }

InputParameters::_block_fullpath

std::string _block_fullpath

full HIT path of the block from the input file - used for nice error messages.

Definition: InputParameters.h:838

◆ blockLocation()

std::string& InputParameters::blockLocation ( )

inline

Get/set a string representing the location (i.e.

filename,linenum) in the input text for the block containing parameters for this object.

Definition at line 711 of file InputParameters.h.

Referenced by checkParams(), and Parser::walkRaw().

711 { return _block_location; };

InputParameters::_block_location

std::string _block_location

original location of input block (i.e. filename,linenum) - used for nice error messages.

Definition: InputParameters.h:835

◆ checkConsistentType()

template<typename T >

void InputParameters::checkConsistentType ( const std::string & name ) const

This method checks to make sure that we aren't adding a parameter with the same name but a different type.

It throws a MooseError if an inconsistent type is detected. While this state is supported by libMesh it brings nothing but blood and tears for those who try ;)

Parameters

name	the name of the parameter

Definition at line 1245 of file InputParameters.h.

 {
   // Do we have a paremeter with the same name but a different type?
   InputParameters::const_iterator it = _values.find(name);
   if (it != _values.end() && dynamic_cast<const Parameter<T> *>(it->second) == NULL)
     mooseError("Attempting to set parameter \"",
                name,
                "\" with type (",
                demangle(typeid(T).name()),
                ")\nbut the parameter already exists as type (",
                it->second->type(),
                ")");
 }

◆ checkParamName()

void InputParameters::checkParamName ( const std::string & name ) const

private

Make sure the parameter name doesn't have any invalid characters.

Definition at line 1035 of file InputParameters.C.

Referenced by addParam(), addPrivateParam(), addRequiredParam(), and set().

 {
   const static pcrecpp::RE valid("[\\w:/]+");
   if (!valid.FullMatch(name))
     mooseError("Invalid parameter name: '", name, "'");
 }

◆ checkParams()

void InputParameters::checkParams ( const std::string & parsing_syntax )

This function checks parameters stored in the object to make sure they are in the correct state as the user expects: Required parameters are verified as valid meaning that they were either initialized when they were created, or were read from an input file or some other valid source.

Definition at line 410 of file InputParameters.C.

Referenced by FEProblemBase::addInitialCondition(), ActionFactory::create(), Factory::create(), and AppFactory::createShared().

 {
   std::string parampath = blockFullpath() != "" ? blockFullpath() : parsing_syntax;
   std::ostringstream oss;
   // Required parameters
   for (const auto & it : *this)
   {
     if (!isParamValid(it.first) && isParamRequired(it.first))
     {
       oss << blockLocation() << ": missing required parameter '" << parampath + "/" + it.first
           << "'\n";
       oss << "\tDoc String: \"" + getDocString(it.first) + "\"" << std::endl;
     }
   }
 
   // Range checked parameters
   for (const auto & it : *this)
   {
     std::string long_name(parampath + "/" + it.first);
 
     dynamicCastRangeCheck(Real, Real, long_name, it.first, it.second, oss);
     dynamicCastRangeCheck(int, long, long_name, it.first, it.second, oss);
     dynamicCastRangeCheck(long, long, long_name, it.first, it.second, oss);
     dynamicCastRangeCheck(unsigned int, long, long_name, it.first, it.second, oss);
   }
 
   // Controllable parameters
   for (const auto & param_name : getControllableParameters())
   {
     if (isPrivate(param_name))
       oss << inputLocation(param_name) << ": private parameter '" << paramFullpath(param_name)
           << "' marked controllable";
 
     checkMooseType(NonlinearVariableName, param_name);
     checkMooseType(AuxVariableName, param_name);
     checkMooseType(VariableName, param_name);
     checkMooseType(BoundaryName, param_name);
     checkMooseType(SubdomainName, param_name);
     checkMooseType(PostprocessorName, param_name);
     checkMooseType(VectorPostprocessorName, param_name);
     checkMooseType(UserObjectName, param_name);
     checkMooseType(MaterialPropertyName, param_name);
   }
 
   if (!oss.str().empty())
     mooseError(oss.str());
 }

◆ clear()

void InputParameters::clear ( )

overridevirtual

Definition at line 56 of file InputParameters.C.

 {
   Parameters::clear();
   _params.clear();
   _coupled_vars.clear();
   _collapse_nesting = false;
   _moose_object_syntax_visibility = true;
   _show_deprecated_message = true;
   _allow_copy = true;
   _block_fullpath = "";
   _block_location = "";
 }

◆ collapseSyntaxNesting() [1/2]

void InputParameters::collapseSyntaxNesting ( bool collapse )

Mutators for controlling whether or not the outermost level of syntax will be collapsed when printed.

Definition at line 368 of file InputParameters.C.

Referenced by Parser::buildFullTree(), and Parser::buildJsonSyntaxTree().

 {
   _collapse_nesting = collapse;
 }

◆ collapseSyntaxNesting() [2/2]

bool InputParameters::collapseSyntaxNesting ( ) const

Definition at line 374 of file InputParameters.C.

 {
   return _collapse_nesting;
 }

◆ coupledVarsBegin()

std::set<std::string>::const_iterator InputParameters::coupledVarsBegin ( ) const

inline

Methods returning iterators to the coupled variables names stored in this InputParameters object.

Definition at line 511 of file InputParameters.h.

Referenced by Coupleable::Coupleable(), FunctionMaterialBase::FunctionMaterialBase(), LazyCoupleable::LazyCoupleable(), and ScalarCoupleable::ScalarCoupleable().

   {
     return _coupled_vars.begin();
   }

◆ coupledVarsEnd()

std::set<std::string>::const_iterator InputParameters::coupledVarsEnd ( ) const

inline

Definition at line 515 of file InputParameters.h.

Referenced by Coupleable::Coupleable(), FunctionMaterialBase::FunctionMaterialBase(), LazyCoupleable::LazyCoupleable(), and ScalarCoupleable::ScalarCoupleable().

   {
     return _coupled_vars.end();
   }

◆ declareControllable()

void InputParameters::declareControllable ( const std::string & name )

Declare the given parameters as controllable.

Definition at line 297 of file InputParameters.C.

Referenced by validParams< BodyForce >(), validParams< ConstantAux >(), validParams< ConstantFunction >(), validParams< ConstantPointSource >(), validParams< ConstantRate >(), validParams< ConstantScalarAux >(), validParams< Damper >(), validParams< DirichletBC >(), validParams< FunctionValuePostprocessor >(), validParams< GenericConstantMaterial >(), validParams< IterationAdaptiveDT >(), validParams< LagrangeVecDirichletBC >(), validParams< NeumannBC >(), validParams< PenaltyDirichletBC >(), validParams< PresetBC >(), and validParams< VectorBodyForce >().

 {
   std::vector<std::string> names;
   MooseUtils::tokenize<std::string>(input_names, names, 1, " ");
   for (auto & name : names)
   {
     auto map_iter = _params.find(name);
     if (map_iter != _params.end()) // error is handled by checkParams method
       map_iter->second._controllable = true;
     else
       mooseError("The input parameter '",
                  name,
                  "' does not exist, thus cannot be marked as controllable.");
   }
 }

◆ defaultCoupledValue() [1/2]

Real InputParameters::defaultCoupledValue	(	const std::string &	coupling_name,
		unsigned int	i = `0`
	)		const

Get the default value for an optionally coupled variable.

Parameters

coupling_name	The name of the coupling parameter to get the default value for.
i	By default 0, in general the index of the requested coupled default value.

Definition at line 480 of file InputParameters.C.

Referenced by applyCoupledVar(), ParsedMaterialHelper::functionParse(), Coupleable::getADDefaultValue(), ScalarCoupleable::getDefaultValue(), and Coupleable::getDefaultValue().

 {
   auto value_it = _params.find(coupling_name);
 
   if (value_it == _params.end() || !value_it->second._have_coupled_default)
     mooseError("Attempted to retrieve default value for coupled variable '",
                coupling_name,
                "' when none was provided. \n\nThere are three reasons why this may have "
                "occurred:\n 1. The other version of params.addCoupledVar() should be used in order "
                "to provide a default value. \n 2. This should have been a required coupled "
                "variable added with params.addRequiredCoupledVar() \n 3. The call to get the "
                "coupled value should have been properly guarded with isCoupled()\n");
 
   return value_it->second._coupled_default[i];
 }

◆ defaultCoupledValue() [2/2]

void InputParameters::defaultCoupledValue	(	const std::string &	coupling_name,
		Real	value,
		unsigned int	i = `0`
	)

Set the default value for an optionally coupled variable (called by the Parser).

Parameters

coupling_name	The name of the coupling parameter to get the default value for.
value	Default value to set.
i	By default 0, in general the index of the requested coupled default value.

Definition at line 472 of file InputParameters.C.

 {
   _params[coupling_name]._coupled_default.resize(i + 1);
   _params[coupling_name]._coupled_default[i] = value;
   _params[coupling_name]._have_coupled_default = true;
 }

◆ getAutoBuildVectors()

std::map< std::string, std::pair< std::string, std::string > > InputParameters::getAutoBuildVectors ( ) const

Returns the auto build vectors for all parameters.

Definition at line 508 of file InputParameters.C.

 {
   std::map<std::string, std::pair<std::string, std::string>> abv;
   for (auto it = _params.begin(); it != _params.end(); ++it)
   {
     if (!it->second._autobuild_vecs.first.empty())
       abv[it->first] = it->second._autobuild_vecs;
   }
   return abv;
 }

◆ getBuildableRelationshipManagerTypes()

const std::vector< std::pair< std::string, Moose::RelationshipManagerType > > & InputParameters::getBuildableRelationshipManagerTypes ( ) const

Returns the list of buildable (or required) RelationshipManager object types for this object.

Definition at line 362 of file InputParameters.C.

Referenced by MooseADObjectAction::addRelationshipManagers(), and MooseObjectAction::addRelationshipManagers().

 {
   return _buildable_rm_types;
 }

◆ getBuildableTypes()

const std::vector< std::string > & InputParameters::getBuildableTypes ( ) const

Returns the list of buildable types as a std::vector<std::string>

Definition at line 356 of file InputParameters.C.

Referenced by Parser::buildFullTree(), and Parser::buildJsonSyntaxTree().

 {
   return _buildable_types;
 }

◆ getCheckedPointerParam()

template<typename T >

T InputParameters::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.

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

Definition at line 1056 of file InputParameters.h.

Referenced by Coupleable::Coupleable(), MooseObject::getCheckedPointerParam(), Action::getCheckedPointerParam(), MooseVariableInterface< Real >::MooseVariableInterface(), and ScalarCoupleable::ScalarCoupleable().

 {
   T param = this->get<T>(name);
 
   // Note: You will receive a compile error on this line if you attempt to pass a non-pointer
   // template type to this method
   if (param == NULL)
     mooseError("Parameter ", name, " is NULL.\n", error_string);
   return this->get<T>(name);
 }

◆ getClassDescription()

std::string InputParameters::getClassDescription ( ) const

Returns the class description.

Definition at line 102 of file InputParameters.C.

Referenced by JsonSyntaxTree::addParameters().

 {
   return _class_description;
 }

◆ getControllableParameters()

std::set<std::string> InputParameters::getControllableParameters ( ) const

inline

Return list of controllable parameters.

Definition at line 686 of file InputParameters.h.

Referenced by checkParams().

   {
     std::set<std::string> controllable;
     for (auto it = _params.begin(); it != _params.end(); ++it)
       if (it->second._controllable)
         controllable.insert(it->first);
     return controllable;
   }

◆ getCoupledVariableParamNames()

const std::set<std::string>& InputParameters::getCoupledVariableParamNames ( ) const

inline

Return the coupled variable parameter names.

Definition at line 523 of file InputParameters.h.

523 { return _coupled_vars; }

InputParameters::_coupled_vars

std::set< std::string > _coupled_vars

The coupled variables set.

Definition: InputParameters.h:845

◆ getDefaultPostprocessorValue()

const PostprocessorValue & InputParameters::getDefaultPostprocessorValue	(	const std::string &	name,
		bool	suppress_error = `false`
	)		const

Get the default value for a postprocessor added with addPostprocessor.

Parameters

name	The name of the postprocessor
suppress_error	If true, the error check is suppressed

Returns: The default value for the postprocessor

Definition at line 630 of file InputParameters.C.

Referenced by PostprocessorInterface::getDefaultPostprocessorValue(), PostprocessorInterface::getPostprocessorValue(), PostprocessorInterface::getPostprocessorValueOld(), and PostprocessorInterface::getPostprocessorValueOlder().

 {
   // Check that a default exists, error if it does not
   auto it = _params.find(name);
   if (!suppress_error && (it == _params.end() || !it->second._have_default_postprocessor_val))
     mooseError("A default PostprcessorValue does not exist for the given name: ", name);
 
   return it->second._default_postprocessor_val;
 }

◆ getDescription()

const std::string & InputParameters::getDescription ( const std::string & name )

Get the documentation string for a parameter.

Definition at line 804 of file InputParameters.C.

 {
   if (_params.count(name) == 0)
     mooseError("No parameter exists with the name ", name);
   return _params[name]._doc_string;
 }

◆ getDocString()

std::string InputParameters::getDocString ( const std::string & name ) const

Returns the documentation string for the specified parameter name.

Definition at line 223 of file InputParameters.C.

Referenced by applyCoupledVar(), and checkParams().

 {
   std::string doc_string;
   auto it = _params.find(name);
   if (it != _params.end())
     for (const auto & ch : it->second._doc_string)
     {
       if (ch == '\n')
         doc_string += " ... ";
       else
         doc_string += ch;
     }
 
   return doc_string;
 }

◆ getGroupName()

std::string InputParameters::getGroupName ( const std::string & param_name ) const

This method retrieves the group name for the passed parameter name if one exists.

Otherwise an empty string is returned.

Definition at line 621 of file InputParameters.C.

 {
   auto it = _params.find(param_name);
   if (it != _params.end())
     return it->second._group;
   return std::string();
 }

◆ getMooseType()

std::string InputParameters::getMooseType ( const std::string & name ) const

Utility functions for retrieving one of the MooseTypes variables into the common "string" base class.

Scalar and Vector versions are supplied

Definition at line 530 of file InputParameters.C.

Referenced by MooseObjectWarehouseBase< Indicator >::addObject(), BlockRestrictable::initializeBlockRestrictable(), isValid(), and MooseVariableInterface< Real >::MooseVariableInterface().

 {
   std::string var;
 
   if (have_parameter<VariableName>(name))
     var = get<VariableName>(name);
   else if (have_parameter<NonlinearVariableName>(name))
     var = get<NonlinearVariableName>(name);
   else if (have_parameter<AuxVariableName>(name))
     var = get<AuxVariableName>(name);
   else if (have_parameter<PostprocessorName>(name))
     var = get<PostprocessorName>(name);
   else if (have_parameter<VectorPostprocessorName>(name))
     var = get<VectorPostprocessorName>(name);
   else if (have_parameter<FunctionName>(name))
     var = get<FunctionName>(name);
   else if (have_parameter<UserObjectName>(name))
     var = get<UserObjectName>(name);
   else if (have_parameter<MaterialPropertyName>(name))
     var = get<MaterialPropertyName>(name);
   else if (have_parameter<std::string>(name))
     var = get<std::string>(name);
 
   return var;
 }

◆ getParamHelper() [1/6]

template<typename T >

const T & InputParameters::getParamHelper	(	const std::string &	name,
		const InputParameters &	pars,
		const T *	the_type
	)

static

Definition at line 1391 of file InputParameters.h.

Referenced by MooseObject::getParam(), Action::getParam(), and MooseApp::getParam().

 {
   if (!pars.isParamValid(name))
     mooseError("The parameter \"", name, "\" is being retrieved before being set.\n");
 
   return pars.get<T>(name);
 }

◆ getParamHelper() [2/6]

template<typename T >

const std::vector< T > & InputParameters::getParamHelper	(	const std::string &	name,
		const InputParameters &	pars,
		const std::vector< T > *	the_type
	)

static

Definition at line 1414 of file InputParameters.h.

 {
   return pars.get<std::vector<T>>(name);
 }

◆ getParamHelper() [3/6]

template<>

const MooseEnum& InputParameters::getParamHelper	(	const std::string &	name,
		const InputParameters &	pars,
		const MooseEnum *
	)

Definition at line 1003 of file InputParameters.C.

 {
   return pars.get<MooseEnum>(name);
 }

◆ getParamHelper() [4/6]

template<>

const MultiMooseEnum& InputParameters::getParamHelper	(	const std::string &	name,
		const InputParameters &	pars,
		const MultiMooseEnum *
	)

Definition at line 1012 of file InputParameters.C.

 {
   return pars.get<MultiMooseEnum>(name);
 }

◆ getParamHelper() [5/6]

template<>

const MooseEnum& InputParameters::getParamHelper	(	const std::string &	name,
		const InputParameters &	pars,
		const MooseEnum *
	)

◆ getParamHelper() [6/6]

template<>

const MultiMooseEnum& InputParameters::getParamHelper	(	const std::string &	name,
		const InputParameters &	pars,
		const MultiMooseEnum *
	)

◆ getSyntax()

std::vector< std::string > InputParameters::getSyntax ( const std::string & name )

Get the syntax for a command-line parameter.

Definition at line 615 of file InputParameters.C.

 {
   return _params[name]._cli_flag_names;
 }

◆ getVecMooseType()

std::vector< std::string > InputParameters::getVecMooseType ( const std::string & name ) const

Definition at line 557 of file InputParameters.C.

Referenced by MooseObjectWarehouseBase< Indicator >::addObject(), Coupleable::Coupleable(), isValid(), MooseVariableInterface< Real >::MooseVariableInterface(), and ScalarCoupleable::ScalarCoupleable().

 {
   std::vector<std::string> svars;
 
   if (have_parameter<std::vector<VariableName>>(name))
   {
     std::vector<VariableName> vars = get<std::vector<VariableName>>(name);
     std::copy(vars.begin(), vars.end(), std::back_inserter(svars));
   }
   else if (have_parameter<std::vector<NonlinearVariableName>>(name))
   {
     std::vector<NonlinearVariableName> vars = get<std::vector<NonlinearVariableName>>(name);
     std::copy(vars.begin(), vars.end(), std::back_inserter(svars));
   }
   else if (have_parameter<std::vector<AuxVariableName>>(name))
   {
     std::vector<AuxVariableName> vars = get<std::vector<AuxVariableName>>(name);
     std::copy(vars.begin(), vars.end(), std::back_inserter(svars));
   }
   else if (have_parameter<std::vector<MaterialPropertyName>>(name))
   {
     std::vector<MaterialPropertyName> vars = get<std::vector<MaterialPropertyName>>(name);
     std::copy(vars.begin(), vars.end(), std::back_inserter(svars));
   }
   else if (have_parameter<std::vector<std::string>>(name))
   {
     std::vector<std::string> vars = get<std::vector<std::string>>(name);
     std::copy(vars.begin(), vars.end(), std::back_inserter(svars));
   }
 
   return svars;
 }

◆ hasCoupledValue()

bool InputParameters::hasCoupledValue ( const std::string & coupling_name ) const

Return whether or not the coupled variable exists.

Parameters

coupling_name The name of the coupled variable to test for

Returns: True if the variable exists in the coupled variables for this InputParameters object

Definition at line 459 of file InputParameters.C.

Referenced by applyCoupledVar(), Coupleable::isCoupled(), and ScalarCoupleable::isCoupledScalar().

 {
   return _coupled_vars.find(coupling_name) != _coupled_vars.end();
 }

◆ hasDefaultCoupledValue()

bool InputParameters::hasDefaultCoupledValue ( const std::string & coupling_name ) const

Return whether or not the requested parameter has a default coupled value.

Parameters

coupling_name The name of the coupling parameter to get the default value for.

Definition at line 465 of file InputParameters.C.

Referenced by applyCoupledVar(), Coupleable::coupledComponents(), and FunctionMaterialBase::FunctionMaterialBase().

 {
   return _params.count(coupling_name) > 0 && _params.at(coupling_name)._have_coupled_default &&
          _coupled_vars.count(coupling_name) > 0;
 }

◆ hasDefaultPostprocessorValue()

bool InputParameters::hasDefaultPostprocessorValue ( const std::string & name ) const

Returns true if a default PostprocessorValue is defined.

Parameters

name	The name of the postprocessor

Returns: True if a default value exists

Definition at line 649 of file InputParameters.C.

Referenced by PostprocessorInterface::getPostprocessorValue(), PostprocessorInterface::getPostprocessorValueOld(), and PostprocessorInterface::getPostprocessorValueOlder().

 {
   return _params.count(name) > 0 && _params.at(name)._have_default_postprocessor_val;
 }

◆ inputLocation() [1/2]

const std::string& InputParameters::inputLocation ( const std::string & param ) const

inline

Get/set a string representing the location in the input text the parameter originated from (i.e.

filename,linenum) for the given param.

Definition at line 727 of file InputParameters.h.

Referenced by checkParams(), MooseObject::paramError(), Action::paramError(), MooseObject::paramInfo(), Action::paramInfo(), MooseObject::paramWarning(), and Action::paramWarning().

   {
     return at(param)._input_location;
   };

◆ inputLocation() [2/2]

std::string& InputParameters::inputLocation ( const std::string & param )

inline

Definition at line 731 of file InputParameters.h.

731 { return at(param)._input_location; };

InputParameters::Metadata::_input_location

std::string _input_location

original location of parameter (i.e. filename,linenum) - used for nice error messages.

Definition: InputParameters.h:791

InputParameters::at

Metadata & at(const std::string &param)

Definition: InputParameters.h:798

◆ isControllable()

bool InputParameters::isControllable ( const std::string & name )

Returns a Boolean indicating whether the specified parameter is controllable.

Definition at line 314 of file InputParameters.C.

 {
   return _params.count(name) > 0 && _params[name]._controllable;
 }

◆ isParamDeprecated()

bool InputParameters::isParamDeprecated ( const std::string & name ) const

Returns True if the parameters is deprecated.

Definition at line 276 of file InputParameters.C.

 {
   return _params.count(name) > 0 && !_params.at(name)._deprecation_message.empty();
 }

◆ isParamRequired()

bool InputParameters::isParamRequired ( const std::string & name ) const

Returns a boolean indicating whether the specified parameter is required or not.

Definition at line 251 of file InputParameters.C.

Referenced by areAllRequiredParamsValid(), and checkParams().

 {
   return _params.count(name) > 0 && _params.at(name)._required;
 }

◆ isParamSetByAddParam()

bool InputParameters::isParamSetByAddParam ( const std::string & name ) const

Returns whether or not the parameter was set due to addParam.

If not then it was either set programmatically or was read through the input file.

Definition at line 270 of file InputParameters.C.

Referenced by Transient::init(), MooseApp::MooseApp(), and Transient::Transient().

 {
   return _params.count(name) > 0 && _params.at(name)._set_by_add_param;
 }

◆ isParamSetByUser()

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

Method returns true if the parameter was by the user.

Parameters

name	The parameter name

Definition at line 793 of file InputParameters.C.

Referenced by CreateProblemAction::act(), CreateProblemDefaultAction::act(), BreakMeshByBlockGeneratorBase::BreakMeshByBlockGeneratorBase(), BreakMeshByBlockBase::checkInputParameter(), Console::Console(), Executioner::Executioner(), Exodus::Exodus(), Console::initialSetup(), InterfaceKernel::InterfaceKernel(), paramSetByUser(), RandomIC::RandomIC(), Transient::setupTimeIntegrator(), and Transient::Transient().

 {
   if (!isParamValid(name))
     // if the parameter is invalid, it is for sure not set by the user
     return false;
   else
     // If the parameters is not located in the list, then it was set by the user
     return _params.count(name) > 0 && !_params.at(name)._set_by_add_param;
 }

◆ isParamValid()

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

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

The value was supplied as a default argument or read and properly converted from the input file

Definition at line 257 of file InputParameters.C.

Referenced by AddPeriodicBCAction::act(), MaterialOutputAction::act(), FEProblem::addLineSearch(), MooseObjectWarehouseBase< Indicator >::addObject(), JsonSyntaxTree::addParameters(), applyParameter(), areAllRequiredParamsValid(), BoundsAux::BoundsAux(), checkParams(), AppFactory::createShared(), FileRangeBuilder::FileRangeBuilder(), GapValueAux::GapValueAux(), ExtraNodesetGenerator::generate(), MooseApp::getCheckpointDirectories(), getParamHelper(), InterfaceKernel::InterfaceKernel(), isParamSetByUser(), MooseObject::isParamValid(), Action::isParamValid(), MooseApp::isParamValid(), isValid(), LayeredBase::LayeredBase(), MaterialPropertyInterface::MaterialPropertyInterface(), AddExtraNodeset::modify(), NodeFaceConstraint::NodeFaceConstraint(), PenetrationAux::PenetrationAux(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseLinearInterpolationMaterial::PiecewiseLinearInterpolationMaterial(), rangeCheck(), MeshBaseImageSampler::setupImageSampler(), ImageSampler::setupImageSampler(), SetupMeshAction::setupMesh(), Moose::PetscSupport::storePetscOptions(), Moose::SlepcSupport::storeSlepcOptions(), DumpObjectsProblem::stringifyParameters(), validParams< BlockRestrictable >(), validParams< BoundaryRestrictable >(), validParams< BoundaryRestrictableRequired >(), MeshBaseImageSampler::vtkMagnitude(), ImageSampler::vtkMagnitude(), ImageSampler::vtkThreshold(), and MeshBaseImageSampler::vtkThreshold().

 {
   if (have_parameter<MooseEnum>(name))
     return get<MooseEnum>(name).isValid();
   else if (have_parameter<MultiMooseEnum>(name))
     return get<MultiMooseEnum>(name).isValid();
   else if (have_parameter<ExecFlagEnum>(name))
     return get<ExecFlagEnum>(name).isValid();
   else
     return _params.count(name) > 0 && _params.at(name)._valid;
 }

◆ isPrivate()

bool InputParameters::isPrivate ( const std::string & name ) const

Returns a Boolean indicating whether the specified parameter is private or not.

Definition at line 291 of file InputParameters.C.

Referenced by applyParameter(), checkParams(), and DumpObjectsProblem::stringifyParameters().

 {
   return _params.count(name) > 0 && _params.at(name)._is_private;
 }

◆ makeParamRequired()

template<typename T >

void InputParameters::makeParamRequired ( const std::string & name )

Changes the parameter to be required.

Parameters

name	The parameter name

Definition at line 1272 of file InputParameters.h.

 {
   if (!this->have_parameter<T>(name))
     mooseError("Unable to require nonexistent parameter: ", name);
 
   _params[name]._required = true;
 }

◆ markControlled()

void InputParameters::markControlled ( const std::string & name )

Marker a parameter that has been changed by the Control system (this is for output purposes)

◆ mooseObjectSyntaxVisibility() [1/2]

void InputParameters::mooseObjectSyntaxVisibility ( bool visibility )

Mutators for controlling whether or not the outermost level of syntax will be collapsed when printed.

Definition at line 380 of file InputParameters.C.

Referenced by Parser::buildFullTree(), and Parser::buildJsonSyntaxTree().

 {
   _moose_object_syntax_visibility = visibility;
 }

◆ mooseObjectSyntaxVisibility() [2/2]

bool InputParameters::mooseObjectSyntaxVisibility ( ) const

Definition at line 386 of file InputParameters.C.

 {
   return _moose_object_syntax_visibility;
 }

◆ numberDefaultCoupledValues()

unsigned int InputParameters::numberDefaultCoupledValues ( const std::string & coupling_name ) const

Get the number of defaulted coupled value entries.

Parameters

coupling_name The name of the coupling parameter to get the default value for.

Definition at line 497 of file InputParameters.C.

Referenced by applyCoupledVar(), Coupleable::Coupleable(), Coupleable::coupledComponents(), and Coupleable::getDefaultValue().

 {
   auto value_it = _params.find(coupling_name);
   if (value_it == _params.end())
     mooseError("Attempted to retrieve default value for coupled variable '",
                coupling_name,
                "' when none was provided.");
   return value_it->second._coupled_default.size();
 }

◆ operator+=()

InputParameters & InputParameters::operator+= ( const InputParameters & rhs )

Definition at line 142 of file InputParameters.C.

 {
   Parameters::operator+=(rhs);
 
   // TODO: this is not a proper merge - if a particular parameter exists in both this and rhs,
   // then we should actually smartly merge both metadata structs before storing in this.
   for (auto it = rhs._params.begin(); it != rhs._params.end(); ++it)
     _params[it->first] = it->second;
 
   _buildable_types.insert(
       _buildable_types.end(), rhs._buildable_types.begin(), rhs._buildable_types.end());
   _buildable_rm_types.insert(
       _buildable_rm_types.end(), rhs._buildable_rm_types.begin(), rhs._buildable_rm_types.end());
 
   // Collapse nesting and moose object syntax hiding are not modified with +=
   _coupled_vars.insert(rhs._coupled_vars.begin(), rhs._coupled_vars.end());
   return *this;
 }

◆ operator=()

InputParameters & InputParameters::operator= ( const InputParameters & rhs )

Definition at line 108 of file InputParameters.C.

 {
   // An error to help minimize the segmentation faults that occure when MooseObjects do not have the
   // correct constructor
   if (!rhs._allow_copy)
   {
     const std::string & name =
         rhs.get<std::string>("_object_name"); // If _allow_parameter_copy is set then so is name
                                               // (see InputParameterWarehouse::addInputParameters)
     mooseError("Copying of the InputParameters object for the ",
                name,
                " object is not allowed.\n\nThe likely cause for this error ",
                "is having a constructor that does not use a const reference, all constructors\nfor "
                "MooseObject based classes should be as follows:\n\n",
                "    MyObject::MyObject(const InputParameters & parameters);");
   }
 
   Parameters::operator=(rhs);
 
   _params = rhs._params;
 
   _buildable_types = rhs._buildable_types;
   _buildable_rm_types = rhs._buildable_rm_types;
   _collapse_nesting = rhs._collapse_nesting;
   _moose_object_syntax_visibility = rhs._moose_object_syntax_visibility;
   _coupled_vars = rhs._coupled_vars;
   _allow_copy = rhs._allow_copy;
   _block_fullpath = rhs._block_fullpath;
   _block_location = rhs._block_location;
 
   return *this;
 }

◆ paramFullpath() [1/2]

const std::string& InputParameters::paramFullpath ( const std::string & param ) const

inline

Get/set a string representing the full HIT parameter path from the input file (e.g.

"Mesh/foo/bar" for param "bar") for the given param.

Definition at line 739 of file InputParameters.h.

Referenced by checkParams(), MooseObject::paramError(), Action::paramError(), MooseObject::paramInfo(), Action::paramInfo(), MooseObject::paramWarning(), and Action::paramWarning().

   {
     return at(param)._param_fullpath;
   };

◆ paramFullpath() [2/2]

std::string& InputParameters::paramFullpath ( const std::string & param )

inline

Definition at line 743 of file InputParameters.h.

743 { return at(param)._param_fullpath; };

InputParameters::Metadata::_param_fullpath

std::string _param_fullpath

full HIT path of the parameter from the input file - used for nice error messages.

Definition: InputParameters.h:793

InputParameters::at

Metadata & at(const std::string &param)

Definition: InputParameters.h:798

◆ paramSetByUser()

bool InputParameters::paramSetByUser ( const std::string & name ) const

Deprecated method.

Use isParamSetByUser() instead.

Definition at line 786 of file InputParameters.C.

 {
   mooseDeprecated("paramSetByUser() is deprecated. Use isParamSetByUser() instead.");
   return isParamSetByUser(name);
 }

◆ rangeCheck() [1/2]

template<typename T , typename UP_T >

void InputParameters::rangeCheck	(	const std::string &	full_name,
		const std::string &	short_name,
		InputParameters::Parameter< T > *	param,
		std::ostream &	oss = `Moose::out`
	)

Runs a range on the supplied parameter if it exists and throws an error if that check fails.

Returns: Boolean indicating whether range check exists

Definition at line 1014 of file InputParameters.h.

Referenced by Parser::setScalarValueTypeParameter().

 {
   mooseAssert(param, "Parameter is NULL");
 
   if (!isParamValid(short_name) || _params[short_name]._range_function.empty())
     return;
 
   // Parse the expression
   FunctionParserBase<UP_T> fp;
   if (fp.Parse(_params[short_name]._range_function, short_name) != -1) // -1 for success
   {
     oss << "Error parsing expression: " << _params[short_name]._range_function << '\n';
     return;
   }
 
   // ensure range-checked input file parameter comparison functions
   // do absolute floating point comparisons instead of using a default epsilon.
   auto tmp_eps = fp.epsilon();
   fp.setEpsilon(0);
   // We require a non-const value for the implicit upscaling of the parameter type
   std::vector<UP_T> value(1, param->set());
   UP_T result = fp.Eval(&value[0]);
   fp.setEpsilon(tmp_eps);
 
   if (fp.EvalError())
   {
     oss << "Error evaluating expression: " << _params[short_name]._range_function
         << "\nPerhaps you used the wrong variable name?\n";
     return;
   }
 
   if (!result)
     oss << "Range check failed for parameter " << full_name
         << "\n\tExpression: " << _params[short_name]._range_function << "\n\tValue: " << value[0]
         << '\n';
 }

◆ rangeCheck() [2/2]

template<typename T , typename UP_T >

void InputParameters::rangeCheck	(	const std::string &	full_name,
		const std::string &	short_name,
		InputParameters::Parameter< std::vector< T >> *	param,
		std::ostream &	oss = `Moose::out`
	)

Automatically detect the variables used in the range checking expression. We allow the following variables (where snam is the short_name of the parameter)

snam : tests every component in the vector 'snam > 0' snam_size : the size of the vector 'snam_size = 5' snam_i : where i is a number from 0 to sname_size-1 tests a specific component 'snam_0 > snam_1'

Definition at line 901 of file InputParameters.h.

 {
   mooseAssert(param, "Parameter is NULL");
 
   if (!isParamValid(short_name) || _params[short_name]._range_function.empty())
     return;
 
   FunctionParserBase<UP_T> fp;
   std::vector<std::string> vars;
   if (fp.ParseAndDeduceVariables(_params[short_name]._range_function, vars) != -1) // -1 for success
   {
     oss << "Error parsing expression: " << _params[short_name]._range_function << '\n';
     return;
   }
 
   // Fparser parameter buffer
   std::vector<UP_T> parbuf(vars.size());
 
   // parameter vector
   const std::vector<T> & value = param->set();
 
   // iterate over all vector values (maybe ;)
   bool need_to_iterate = false;
   unsigned int i = 0;
   do
   {
     // set parameters
     for (unsigned int j = 0; j < vars.size(); j++)
     {
       if (vars[j] == short_name)
       {
         if (value.size() == 0)
         {
           oss << "Range checking empty vector: " << _params[short_name]._range_function << '\n';
           return;
         }
 
         parbuf[j] = value[i];
         need_to_iterate = true;
       }
       else if (vars[j] == short_name + "_size")
         parbuf[j] = value.size();
       else
       {
         if (vars[j].substr(0, short_name.size() + 1) != short_name + "_")
         {
           oss << "Error parsing expression: " << _params[short_name]._range_function << '\n';
           return;
         }
         std::istringstream iss(vars[j]);
         iss.seekg(short_name.size() + 1);
 
         size_t index;
         if (iss >> index && iss.eof())
         {
           if (index >= value.size())
           {
             oss << "Error parsing expression: " << _params[short_name]._range_function
                 << "\nOut of range variable " << vars[j] << '\n';
             return;
           }
           parbuf[j] = value[index];
         }
         else
         {
           oss << "Error parsing expression: " << _params[short_name]._range_function
               << "\nInvalid variable " << vars[j] << '\n';
           return;
         }
       }
     }
 
     // ensure range-checked input file parameter comparison functions
     // do absolute floating point comparisons instead of using a default epsilon.
     auto tmp_eps = fp.epsilon();
     fp.setEpsilon(0);
     UP_T result = fp.Eval(&parbuf[0]);
     fp.setEpsilon(tmp_eps);
 
     // test function using the parameters determined above
     if (fp.EvalError())
     {
       oss << "Error evaluating expression: " << _params[short_name]._range_function << '\n';
       return;
     }
 
     if (!result)
     {
       oss << "Range check failed for parameter " << full_name
           << "\n\tExpression: " << _params[short_name]._range_function << "\n";
       if (need_to_iterate)
         oss << "\t Component: " << i << '\n';
     }
 
   } while (need_to_iterate && ++i < value.size());
 }

◆ rawParamVal()

std::string& InputParameters::rawParamVal ( const std::string & param )

inline

Get/set a string representing the raw, unmodified token text for the given param.

This is usually only set/useable for file-path type parameters.

Definition at line 750 of file InputParameters.h.

Referenced by Parser::setFilePathParam(), and Parser::setVectorFilePathParam().

750 { return _params[param]._raw_val; };

InputParameters::_params

std::map< std::string, Metadata > _params

The actual parameter data.

Definition: InputParameters.h:842

◆ registerBase()

void InputParameters::registerBase ( const std::string & value )

This method must be called from every base "Moose System" to create linkage with the Action System.

See "Moose.C" for the registerMooseObjectTask() calls.

Definition at line 320 of file InputParameters.C.

Referenced by validParams< ADMaterial< RESIDUAL > >(), validParams< Damper >(), validParams< Distribution >(), validParams< EigenKernel >(), validParams< Executioner >(), validParams< Function >(), validParams< Kernel >(), validParams< LineSearch >(), validParams< MeshGenerator >(), validParams< MeshModifier >(), validParams< MooseMesh >(), validParams< MoosePartitioner >(), validParams< MoosePreconditioner >(), validParams< Predictor >(), validParams< Problem >(), validParams< RelationshipManager >(), validParams< ScalarInitialCondition >(), validParams< Split >(), validParams< TimeIntegrator >(), validParams< TimeStepper >(), and validParams< VectorKernel >().

 {
   InputParameters::set<std::string>("_moose_base") = value;
   _params["_moose_base"]._is_private = true;
 }

◆ registerBuildableTypes()

void InputParameters::registerBuildableTypes ( const std::string & names )

This method is here to indicate which Moose types a particular Action may build.

It takes a space delimited list of registered MooseObjects. TODO: For now we aren't actually checking this list when we build objects. Since individual actions can do whatever they want it's not exactly trivial to check this without changing the user API. This function properly restricts the syntax and YAML dumps.

Definition at line 327 of file InputParameters.C.

 {
   _buildable_types.clear();
   MooseUtils::tokenize(names, _buildable_types, 1, " \t\n\v\f\r"); // tokenize on whitespace
 }

◆ registerRelationshipManagers()

void InputParameters::registerRelationshipManagers	(	const std::string &	names,
		const std::string &	use_as_rm_types = `""`
	)

Declares the types of RelationshipManagers that the owning object will either construct (in the case of Actions) or requires (in the case of every other MooseObject).

With normal MooseObject-derived types built by MooseObjectAction, MOOSE will attempt to use the InputParameters available to it to construct the required RelationshipManager automatically. Actions may run custom logic to create RelationshipManagers. The names and rm_type lists must have the same number of entries.

Parameters

names A space delimited list of RelationshipMangers that may be built by this object.

Definition at line 334 of file InputParameters.C.

 {
   _buildable_rm_types.clear();
 
   std::vector<std::string> buildable_rm_types;
   MooseUtils::tokenize(names, buildable_rm_types, 1, " \t\n\v\f\r"); // tokenize on whitespace
 
   std::vector<std::string> use_as_rm_type_strings;
   MooseUtils::tokenize(use_as_rm_types, use_as_rm_type_strings, 1, " \t\n\v\f\r");
 
   for (std::size_t i = 0; i < buildable_rm_types.size(); ++i)
   {
     Moose::RelationshipManagerType use_as_type = Moose::RelationshipManagerType::DEFAULT;
     if (i < use_as_rm_type_strings.size())
       use_as_type = Moose::stringToEnum<Moose::RelationshipManagerType>(use_as_rm_type_strings[i]);
 
     _buildable_rm_types.emplace_back(std::make_pair(buildable_rm_types[i], use_as_type));
   }
 }

◆ reservedValues()

std::set< std::string > InputParameters::reservedValues ( const std::string & name ) const

Get a set of reserved parameter values.

Returns a set by value since we can return an empty set.

Definition at line 1026 of file InputParameters.C.

 {
   auto it = _params.find(name);
   if (it == _params.end())
     return std::set<std::string>();
   return it->second._reserved_values;
 }

◆ set()

template<typename T >

T & InputParameters::set	(	const std::string &	name,
		bool	quiet_mode = `false`
	)

Returns a writable reference to the named parameters.

Note: This is not a virtual function! Use caution when comparing to the parent class implementation

Parameters

name	The name of the parameter to set
quiet_mode	When true the parameter is kept with set_by_add_param=true, this is generally not needed.

"quite_mode" returns a writable reference to the named parameter, without setting set_by_add_param to false. Using this method of set will make the parameter to continue to behave if its value where set ONLY by addParam and not by any other method.

This was added for handling parameters in the Output objects that have behavior dependent on whether the user modified the parameters.

Definition at line 883 of file InputParameters.h.

Referenced by AB2PredictorCorrector::AB2PredictorCorrector(), CreateExecutionerAction::act(), PartitionerAction::act(), AddICAction::act(), AddMeshModifierAction::act(), CreateProblemAction::act(), SetupDebugAction::act(), SetupMeshAction::act(), CreateDisplacedProblemAction::act(), SetupPredictorAction::act(), SetupTimeStepperAction::act(), SetupResidualDebugAction::act(), MaterialDerivativeTestAction::act(), CommonOutputAction::act(), AddNodalNormalsAction::act(), Executioner::addAttributeReporter(), FEProblemBase::addAuxKernel(), FEProblemBase::addAuxScalarKernel(), FEProblemBase::addBoundaryCondition(), FEProblemBase::addConstraint(), FEProblemBase::addDamper(), FEProblemBase::addDGKernel(), FEProblemBase::addDiracKernel(), FEProblemBase::addDistribution(), FEProblemBase::addFunction(), FEProblemBase::addIndicator(), FEProblemBase::addInitialCondition(), FEProblemBase::addInterfaceKernel(), MooseEigenSystem::addKernel(), AuxiliarySystem::addKernel(), FEProblemBase::addKernel(), FEProblem::addLineSearch(), FEProblemBase::addMarker(), FEProblemBase::addMaterialHelper(), FEProblemBase::addMultiApp(), FEProblemBase::addNodalKernel(), FEProblemBase::addOutput(), FEProblemBase::addPredictor(), FEProblemBase::addScalarKernel(), AuxiliarySystem::addTimeIntegrator(), NonlinearSystemBase::addTimeIntegrator(), FEProblemBase::addTimeIntegrator(), FEProblemBase::addTransfer(), FEProblemBase::addUserObject(), AStableDirk4::AStableDirk4(), ActionWarehouse::buildBuildableActions(), Parser::buildFullTree(), Parser::buildJsonSyntaxTree(), MooseObjectUnitTest::buildObjects(), OversampleOutput::cloneMesh(), CommonOutputAction::create(), ActionFactory::create(), Factory::create(), MultiApp::createApp(), AppFactory::createAppShared(), AddVariableAction::createInitialConditionAction(), MooseApp::createMinimalApp(), AppFactory::createShared(), FEProblemBase::getFunction(), MaterialOutputAction::getParams(), Moose::SlepcSupport::getSlepcValidParams(), Transient::init(), NearestPointBase< LayeredAverage >::NearestPointBase(), MultiAppProjectionTransfer::projectSolution(), GlobalParamsAction::setDoubleIndexParam(), FEProblem::setInputParametersFEProblem(), FEProblemBase::setInputParametersFEProblem(), GlobalParamsAction::setScalarParam(), MooseApp::setupOptions(), GlobalParamsAction::setVectorParam(), validParams< AlgebraicRelationshipManager >(), validParams< Control >(), validParams< ControlOutput >(), validParams< ConvectiveFluxBC >(), validParams< CoupledTiedValueConstraint >(), validParams< CSVReader >(), validParams< DiscreteElementUserObject >(), validParams< DistributedGeneratedMesh >(), validParams< DOFMapOutput >(), validParams< EigenDirichletBC >(), validParams< ElementQualityChecker >(), validParams< ElementVariablesDifferenceMax >(), validParams< EqualValueEmbeddedConstraint >(), validParams< ExternalProblem >(), validParams< GapValueAux >(), validParams< GeometricRelationshipManager >(), validParams< InterfaceTimeKernel >(), validParams< LeastSquaresFitHistory >(), validParams< Marker >(), validParams< Material >(), validParams< MultiAppTransfer >(), validParams< NearestNodeDistanceAux >(), validParams< NearestNodeValueAux >(), validParams< NodalL2Norm >(), validParams< NodalNormalBC >(), validParams< NodalNormalsEvaluator >(), validParams< NodalSum >(), validParams< ODETimeKernel >(), validParams< PenetrationAux >(), validParams< PerfGraphOutput >(), validParams< PerflogDumper >(), validParams< SamplerBase >(), validParams< ScalarConstantIC >(), validParams< SetupMeshAction >(), validParams< SinDirichletBC >(), validParams< TiedValueConstraint >(), validParams< TimeKernel >(), validParams< TimeNodalKernel >(), validParams< TopResidualDebugOutput >(), validParams< Transfer >(), validParams< TwoMaterialPropertyInterface >(), validParams< UserObject >(), validParams< VariableResidualNormsDebugOutput >(), validParams< VectorOfPostprocessors >(), validParams< VTKOutput >(), and Parser::walkRaw().

 {
   checkParamName(name);
   checkConsistentType<T>(name);
 
   if (!this->have_parameter<T>(name))
     _values[name] = new Parameter<T>;
 
   set_attributes(name, false);
 
   if (quiet_mode)
     _params[name]._set_by_add_param = true;
 
   return cast_ptr<Parameter<T> *>(_values[name])->set();
 }

◆ set_attributes()

void InputParameters::set_attributes	(	const std::string &	name,
		bool	inserted_only
	)

overridevirtual

Override from libMesh to set user-defined attributes on our parameter.

"._set_by_add_param" and ".deprecated_params" are not populated until after the default value has already been set in libMesh (first callback to this method). Therefore if a variable is in/not in one of these sets, you can be assured it was put there outside of the "addParam*()" calls.

Definition at line 76 of file InputParameters.C.

Referenced by applyParameter(), and set().

 {
   if (!inserted_only)
   {
     _params[name]._set_by_add_param = false;
 
     // valid_params don't make sense for MooseEnums
     if (!have_parameter<MooseEnum>(name) && !have_parameter<MultiMooseEnum>(name))
       _params[name]._valid = true;
 
     if (_show_deprecated_message)
     {
       if (_params.count(name) && !_params[name]._deprecation_message.empty())
         mooseDeprecated(
             "The parameter ", name, " is deprecated.\n", _params[name]._deprecation_message);
     }
   }
 }

◆ setDefaultPostprocessorValue()

void InputParameters::setDefaultPostprocessorValue	(	const std::string &	name,
		const PostprocessorValue &	value
	)

Set the default value for a postprocessor added with addPostprocessor.

Parameters

name	The name of the postprocessor value The value of the postprocessor default to set

Definition at line 641 of file InputParameters.C.

 {
   _params[name]._default_postprocessor_val = value;
   _params[name]._have_default_postprocessor_val = true;
 }

◆ setDocString()

void InputParameters::setDocString	(	const std::string &	name,
		const std::string &	doc
	)

Set the doc string of a parameter.

This method is generally used from within the validParams function to modify the documentation for an existing parameter, such as a parameter that is supplied from an interface class.

Definition at line 240 of file InputParameters.C.

Referenced by Moose::SlepcSupport::getSlepcValidParams(), and validParams< MultiAppTransfer >().

 {
   auto it = _params.find(name);
   if (it == _params.end())
     mooseError("Unable to set the documentation string (using setDocString) for the \"",
                name,
                "\" parameter, the parameter does not exist.");
   it->second._doc_string = doc;
 }

◆ setParamHelper() [1/13]

template<typename T , typename S >

void InputParameters::setParamHelper	(	const std::string &	name,
		T &	l_value,
		const S &	r_value
	)

private

This method is called when adding a Parameter with a default value, can be specialized for non-matching types.

Definition at line 1122 of file InputParameters.h.

Referenced by addParam().

 {
   l_value = r_value;
 }

◆ setParamHelper() [2/13]

template<>

void InputParameters::setParamHelper	(	const std::string &	name,
		PostprocessorName &	l_value,
		const Real &	r_value
	)

private

Definition at line 923 of file InputParameters.C.

 {
   // Store the default value
   _params[name]._default_postprocessor_val = r_value;
   _params[name]._have_default_postprocessor_val = true;
 
   // Assign the default value so that it appears in the dump
   std::ostringstream oss;
   oss << r_value;
   l_value = oss.str();
 }

◆ setParamHelper() [3/13]

template<>

void InputParameters::setParamHelper	(	const std::string &	name,
		PostprocessorName &	l_value,
		const int &	r_value
	)

private

Definition at line 939 of file InputParameters.C.

 {
   // Store the default value
   _params[name]._default_postprocessor_val = r_value;
   _params[name]._have_default_postprocessor_val = true;
 
   // Assign the default value so that it appears in the dump
   std::ostringstream oss;
   oss << r_value;
   l_value = oss.str();
 }

◆ setParamHelper() [4/13]

template<>

void InputParameters::setParamHelper	(	const std::string &	,
		FunctionName &	l_value,
		const Real &	r_value
	)

private

Definition at line 955 of file InputParameters.C.

 {
   // Assign the default value so that it appears in the dump
   std::ostringstream oss;
   oss << r_value;
   l_value = oss.str();
 }

◆ setParamHelper() [5/13]

template<>

void InputParameters::setParamHelper	(	const std::string &	,
		FunctionName &	l_value,
		const int &	r_value
	)

private

Definition at line 967 of file InputParameters.C.

 {
   // Assign the default value so that it appears in the dump
   std::ostringstream oss;
   oss << r_value;
   l_value = oss.str();
 }

◆ setParamHelper() [6/13]

template<>

void InputParameters::setParamHelper	(	const std::string &	,
		MaterialPropertyName &	l_value,
		const Real &	r_value
	)

private

Definition at line 979 of file InputParameters.C.

 {
   // Assign the default value so that it appears in the dump
   std::ostringstream oss;
   oss << r_value;
   l_value = oss.str();
 }

◆ setParamHelper() [7/13]

template<>

void InputParameters::setParamHelper	(	const std::string &	,
		MaterialPropertyName &	l_value,
		const int &	r_value
	)

private

Definition at line 991 of file InputParameters.C.

 {
   // Assign the default value so that it appears in the dump
   std::ostringstream oss;
   oss << r_value;
   l_value = oss.str();
 }

◆ setParamHelper() [8/13]

template<>

void InputParameters::setParamHelper	(	const std::string &	name,
		PostprocessorName &	l_value,
		const Real &	r_value
	)

private

◆ setParamHelper() [9/13]

template<>

void InputParameters::setParamHelper	(	const std::string &	name,
		PostprocessorName &	l_value,
		const int &	r_value
	)

private

◆ setParamHelper() [10/13]

template<>

void InputParameters::setParamHelper	(	const std::string &	,
		FunctionName &	l_value,
		const Real &	r_value
	)

private

◆ setParamHelper() [11/13]

template<>

void InputParameters::setParamHelper	(	const std::string &	,
		FunctionName &	l_value,
		const int &	r_value
	)

private

◆ setParamHelper() [12/13]

template<>

void InputParameters::setParamHelper	(	const std::string &	,
		MaterialPropertyName &	l_value,
		const Real &	r_value
	)

private

◆ setParamHelper() [13/13]

template<>

void InputParameters::setParamHelper	(	const std::string &	,
		MaterialPropertyName &	l_value,
		const int &	r_value
	)

private

◆ setReservedValues()

void InputParameters::setReservedValues	(	const std::string &	name,
		const std::set< std::string > &	reserved
	)

Provide a set of reserved values for a parameter.

These are values that are in addition to the normal set of values the parameter can take.

Definition at line 1020 of file InputParameters.C.

Referenced by validParams< OutputInterface >().

 {
   _params[name]._reserved_values = reserved;
 }

◆ suppressParameter()

template<typename T >

void InputParameters::suppressParameter ( const std::string & name )

This method suppresses an inherited parameter so that it isn't required or valid in the derived class.

The parameter is added to the private parameter list. Suppressing a parameter can have dire consequences. Use at your own risk!

Definition at line 1261 of file InputParameters.h.

Referenced by validParams< AutoPositionsMultiApp >(), validParams< CentroidMultiApp >(), validParams< CSV >(), validParams< DiscreteElementUserObject >(), validParams< GridPartitioner >(), validParams< MaterialPropertyDebugOutput >(), and validParams< VariableResidualNormsDebugOutput >().

 {
   if (!this->have_parameter<T>(name))
     mooseError("Unable to suppress nonexistent parameter: ", name);
 
   _params[name]._required = false;
   _params[name]._is_private = true;
 }

◆ type()

std::string InputParameters::type ( const std::string & name )

Prints the type of the requested parameter by name.

Definition at line 520 of file InputParameters.C.

 {
   if (_coupled_vars.find(name) != _coupled_vars.end())
     return "std::vector<VariableName>";
   else if (_params.count(name) > 0 && !_params[name]._custom_type.empty())
     return _params[name]._custom_type;
   return _values[name]->type();
 }

Friends And Related Function Documentation

◆ emptyInputParameters

InputParameters emptyInputParameters ( )

friend

Definition at line 24 of file InputParameters.C.

 {
   InputParameters params;
   return params;
 }

◆ InputParameterWarehouse

friend class InputParameterWarehouse

friend

Definition at line 877 of file InputParameters.h.

Member Data Documentation

◆ _allow_copy

bool InputParameters::_allow_copy

private

A flag for toggling the error message in the copy constructor.

Definition at line 873 of file InputParameters.h.

Referenced by allowCopy(), clear(), and operator=().

◆ _block_fullpath

std::string InputParameters::_block_fullpath

private

full HIT path of the block from the input file - used for nice error messages.

Definition at line 838 of file InputParameters.h.

Referenced by blockFullpath(), clear(), and operator=().

◆ _block_location

std::string InputParameters::_block_location

private

original location of input block (i.e. filename,linenum) - used for nice error messages.

Definition at line 835 of file InputParameters.h.

Referenced by blockLocation(), clear(), and operator=().

◆ _buildable_rm_types

std::vector<std::pair<std::string, Moose::RelationshipManagerType> > InputParameters::_buildable_rm_types

private

The RelationshipManagers that this object may either build or require.

The optional second argument may be supplied to "downgrade" the functionality of the corresponding relationship manager (e.g. An AlgebraicRelationshipManager could be only used as a GeometricRelationshipManager for a given simulation).

Definition at line 859 of file InputParameters.h.

Referenced by getBuildableRelationshipManagerTypes(), operator+=(), operator=(), and registerRelationshipManagers().

◆ _buildable_types

std::vector<std::string> InputParameters::_buildable_types

private

The parameter is used to restrict types that can be built.

Typically this is used for MooseObjectAction derived Actions.

Definition at line 853 of file InputParameters.h.

Referenced by getBuildableTypes(), operator+=(), operator=(), and registerBuildableTypes().

◆ _class_description

std::string InputParameters::_class_description

private

The class description for the owning object.

This string is used in many places including mouse-over events, and external documentation produced from the source code.

Definition at line 849 of file InputParameters.h.

Referenced by addClassDescription(), and getClassDescription().

◆ _collapse_nesting

bool InputParameters::_collapse_nesting

private

This parameter collapses one level of nesting in the syntax blocks.

It is used in conjunction with MooseObjectAction derived Actions.

Definition at line 863 of file InputParameters.h.

Referenced by clear(), collapseSyntaxNesting(), InputParameters(), and operator=().

◆ _coupled_vars

std::set<std::string> InputParameters::_coupled_vars

private

The coupled variables set.

Definition at line 845 of file InputParameters.h.

Referenced by addCoupledVar(), addCoupledVarWithAutoBuild(), addRequiredCoupledVar(), clear(), coupledVarsBegin(), coupledVarsEnd(), getCoupledVariableParamNames(), hasCoupledValue(), hasDefaultCoupledValue(), operator+=(), operator=(), and type().

◆ _moose_object_syntax_visibility

bool InputParameters::_moose_object_syntax_visibility

private

This parameter hides derived MOOSE object types from appearing in syntax dumps.

Definition at line 866 of file InputParameters.h.

Referenced by clear(), InputParameters(), mooseObjectSyntaxVisibility(), and operator=().

◆ _params

std::map<std::string, Metadata> InputParameters::_params

private

The actual parameter data.

Each Metadata object contains attributes for the corresponding parameter.

Definition at line 842 of file InputParameters.h.

Referenced by addCommandLineParam(), addCoupledVar(), addCoupledVarWithAutoBuild(), addCustomTypeParam(), addDeprecatedParam(), addParam(), addParamNamesToGroup(), addPrivateParam(), addRangeCheckedParam(), addRequiredCommandLineParam(), addRequiredCustomTypeParam(), addRequiredParam(), addRequiredRangeCheckedParam(), applyParameter(), at(), clear(), declareControllable(), defaultCoupledValue(), getAutoBuildVectors(), getControllableParameters(), getDefaultPostprocessorValue(), getDescription(), getDocString(), getGroupName(), getSyntax(), hasDefaultCoupledValue(), hasDefaultPostprocessorValue(), InputParameters(), isControllable(), isParamDeprecated(), isParamRequired(), isParamSetByAddParam(), isParamSetByUser(), isParamValid(), isPrivate(), makeParamRequired(), numberDefaultCoupledValues(), operator+=(), operator=(), rangeCheck(), rawParamVal(), registerBase(), reservedValues(), set(), set_attributes(), setDefaultPostprocessorValue(), setDocString(), setReservedValues(), suppressParameter(), and type().

◆ _show_deprecated_message

bool InputParameters::_show_deprecated_message

private

Flag for disabling deprecated parameters message, this is used by applyParameters to avoid dumping messages.

Definition at line 870 of file InputParameters.h.

Referenced by addDeprecatedParam(), applyCoupledVar(), applyParameter(), clear(), and set_attributes().

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

include/utils/InputParameters.h
src/utils/InputParameters.C

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ InputParameters() [1/3]

◆ InputParameters() [2/3]

◆ ~InputParameters()

◆ InputParameters() [3/3]

Member Function Documentation

◆ addClassDescription()

◆ addCommandLineParam() [1/2]

◆ addCommandLineParam() [2/2]

◆ addCoupledVar() [1/3]

◆ addCoupledVar() [2/3]

◆ addCoupledVar() [3/3]

◆ addCoupledVarWithAutoBuild()

The coupling parameter will be passed this vector: "base_0 base_1 base_2 base_3 base_4"

◆ addCustomTypeParam() [1/2]

◆ addCustomTypeParam() [2/2]

◆ addDeprecatedParam() [1/6]

◆ addDeprecatedParam() [2/6]

◆ addDeprecatedParam() [3/6]

◆ addDeprecatedParam() [4/6]

◆ addDeprecatedParam() [5/6]

◆ addDeprecatedParam() [6/6]

◆ addParam() [1/6]

◆ addParam() [2/6]

◆ addParam() [3/6]

◆ addParam() [4/6]

◆ addParam() [5/6]

◆ addParam() [6/6]

◆ addParamNamesToGroup()

◆ addPrivateParam() [1/6]

◆ addPrivateParam() [2/6]

◆ addPrivateParam() [3/6]

◆ addPrivateParam() [4/6]

◆ addPrivateParam() [5/6]

◆ addPrivateParam() [6/6]

◆ addRangeCheckedParam() [1/2]

◆ addRangeCheckedParam() [2/2]

◆ addRequiredCommandLineParam()

◆ addRequiredCoupledVar()

◆ addRequiredCoupledVarWithAutoBuild()

◆ addRequiredCustomTypeParam()

◆ addRequiredParam() [1/6]

◆ addRequiredParam() [2/6]

◆ addRequiredParam() [3/6]

◆ addRequiredParam() [4/6]

◆ addRequiredParam() [5/6]

◆ addRequiredParam() [6/6]

◆ addRequiredRangeCheckedParam()

◆ allowCopy()

◆ applyCoupledVar()

◆ applyParameter()

◆ applyParameters()

◆ applySpecificParameters()

◆ areAllRequiredParamsValid()

◆ at() [1/2]

◆ at() [2/2]

◆ blockFullpath() [1/2]

◆ blockFullpath() [2/2]

◆ blockLocation()

◆ checkConsistentType()

◆ checkParamName()

◆ checkParams()

◆ clear()

◆ collapseSyntaxNesting() [1/2]

◆ collapseSyntaxNesting() [2/2]

◆ coupledVarsBegin()

◆ coupledVarsEnd()

◆ declareControllable()

◆ defaultCoupledValue() [1/2]

◆ defaultCoupledValue() [2/2]

◆ getAutoBuildVectors()

◆ getBuildableRelationshipManagerTypes()

◆ getBuildableTypes()