The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system. More...
#include <InputParameters.h>
Classes | |
struct | CommandLineMetadata |
Structure for storing information about a command line parameter. More... | |
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... | |
bool | attemptPrintDeprecated (const std::string &name) |
Prints the deprecated parameter message, assuming we have the right flags set. More... | |
template<typename T > | |
void | setHelper (const std::string &name) |
This functions is called in set as a 'callback' to avoid code duplication. 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... Ts> | |
void | setParameters (const std::string &name, const T &value, Ts... extra_input_parameters) |
Given a series of parameters names and values, sets each name to the corresponding value. 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 > | |
void | addParam (const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string) |
Enable support for initializer lists as default arguments for container type. More... | |
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 | addDeprecatedCustomTypeParam (const std::string &name, const std::string &custom_type, const std::string &doc_string, const std::string &deprecation_msg) |
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... | |
bool | isCommandLineParameter (const std::string &name) const |
const std::vector< std::string > & | getCommandLineSyntax (const std::string &name) const |
CommandLineMetadata::ArgumentType | getCommandLineArgumentType (const std::string &name) const |
const std::string & | getDescription (const std::string &name) const |
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 ¶m_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... | |
template<typename T > | |
void | makeParamNotRequired (const std::string &name) |
Changes the parameter to not be required. More... | |
void | addCoupledVar (const std::string &name, const std::string &doc_string) |
This method adds a coupled variable name pair. More... | |
void | addDeprecatedCoupledVar (const std::string &old_name, const std::string &new_name, const std::string &removal_date="") |
This method adds a deprecated 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... | |
void | makeParamNotRequired (const std::string &name) |
Forces parameter of given name to be not required regardless of type. 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) const |
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, std::set< ExecFlagType > execute_flags={}) |
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) const |
Returns a Boolean indicating whether the specified parameter is controllable. More... | |
const std::set< ExecFlagType > & | getControllableExecuteOnTypes (const std::string &name) const |
Return the allowed execute flags for a controllable parameter. 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 | registerSystemAttributeName (const std::string &value) |
This method is used to define the MOOSE system name that is used by the TheWarehouse object for storing objects to be retrieved for execution. More... | |
const std::string & | getSystemAttributeName () const |
Get the system attribute name if it was registered. More... | |
void | registerBuildableTypes (const std::string &names) |
This method is here to indicate which Moose types a particular Action may build. More... | |
void | addRelationshipManager (const std::string &name, Moose::RelationshipManagerType rm_type, Moose::RelationshipManagerInputParameterCallback input_parameter_callback=nullptr) |
Tells MOOSE about a RelationshipManager that this object needs. More... | |
void | clearRelationshipManagers () |
Clears all currently registered RelationshipManagers. 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::tuple< std::string, Moose::RelationshipManagerType, Moose::RelationshipManagerInputParameterCallback > > & | 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... | |
const std::unordered_map< std::string, std::string > & | getNewToDeprecatedVarMap () const |
Return the new to deprecated variable name map. More... | |
bool | isRangeChecked (const std::string ¶m_name) const |
Return whether a parameter has a range check. More... | |
std::string | rangeCheckedFunction (const std::string &name) const |
Return the range check function for any parameter (empty string if it is not range checked) More... | |
bool | hasDefault (const std::string ¶m_name) const |
Return whether a parameter has a default. 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... | |
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, bool allow_private=false) |
Method for applying common parameters. More... | |
void | applyParameter (const InputParameters &common, const std::string &common_name, bool allow_private=false) |
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... | |
template<typename R1 , typename R2 , typename V1 = typename std::conditional<std::is_same<R1, MooseEnumItem>::value, MultiMooseEnum, std::vector<R1>>::type, typename V2 = typename std::conditional<std::is_same<R2, MooseEnumItem>::value, MultiMooseEnum, std::vector<R2>>::type> | |
std::vector< std::pair< R1, R2 > > | get (const std::string ¶m1, const std::string ¶m2) const |
Combine two vector parameters into a single vector of pairs. More... | |
std::set< std::string > | getParametersList () const |
std::set< std::string > | getControllableParameters () const |
Return list of controllable parameters. More... | |
std::set< std::string > | getGroupParameters (const std::string &group) const |
Return names of parameters within a group. 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 | errorPrefix (const std::string ¶m) const |
generate error message prefix with parameter name and location (if available) More... | |
std::string & | rawParamVal (const std::string ¶m) |
Get/set a string representing the raw, unmodified token text for the given param. More... | |
const std::string & | rawParamVal (const std::string ¶m) const |
template<typename T > | |
void | ignoreParameter (const std::string &name) |
Informs this object that values for this parameter set from the input file or from the command line should be ignored. More... | |
bool | shouldIgnore (const std::string &name) |
Whether to ignore the value of an input parameter set in the input file or from the command line. More... | |
template<typename T > | |
bool | isType (const std::string &name) const |
std::string | varName (const std::string &var_param_name, const std::string &moose_object_with_var_param_name) const |
Determine the actual variable name from the given variable parameter name. More... | |
void | renameParam (const std::string &old_name, const std::string &new_name, const std::string &new_docstring) |
Rename a parameter and provide a new documentation string. More... | |
void | renameCoupledVar (const std::string &old_name, const std::string &new_name, const std::string &new_docstring) |
Rename a coupled variable and provide a new documentation string. More... | |
void | deprecateParam (const std::string &old_name, const std::string &new_name, const std::string &removal_date) |
void | deprecateCoupledVar (const std::string &old_name, const std::string &new_name, const std::string &removal_date) |
std::string | checkForRename (const std::string &name) const |
Checks whether the provided name is a renamed parameter name. More... | |
template<typename T > | |
const T & | get (std::string_view name) const |
A wrapper around the Parameters base class method. More... | |
template<typename T > | |
bool | have_parameter (std::string_view name) const |
A wrapper around the Parameters base class method. More... | |
template<typename T > | |
void | transferParam (const InputParameters &source_param, const std::string &name, const std::string &new_name="", const std::string &new_description="") |
A routine to transfer a parameter from one class' validParams to another. More... | |
std::vector< std::string > | paramAliases (const std::string ¶m_name) const |
Return all the aliased names associated with param_name . 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 *, const MooseObject *moose_object) |
template<> | |
const MultiMooseEnum & | getParamHelper (const std::string &name, const InputParameters &pars, const MultiMooseEnum *, const MooseObject *moose_object) |
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_in, const InputParameters &pars, const MooseEnum *, const MooseObject *) |
template<> | |
const MultiMooseEnum & | getParamHelper (const std::string &name_in, const InputParameters &pars, const MultiMooseEnum *, const MooseObject *) |
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) |
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 & | blockLocation () |
Get/set a string representing the location (i.e. More... | |
const std::string & | blockLocation () const |
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 ¶m) 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 ¶m) |
const std::string & | paramFullpath (const std::string ¶m) const |
Get/set a string representing the full HIT parameter path from the input file (e.g. More... | |
std::string & | paramFullpath (const std::string ¶m) |
Static Public Member Functions | |
template<typename T > | |
static const T & | getParamHelper (const std::string &name, const InputParameters &pars, const T *the_type, const MooseObject *moose_object=nullptr) |
Private Member Functions | |
InputParameters () | |
void | setParameters () |
Method to terminate the recursive setParameters definition. More... | |
std::string | appendFunctorDescription (const std::string &doc_string) const |
Appends description of what a functor is to a doc string. More... | |
void | setDeprecatedVarDocString (const std::string &new_name, const std::string &doc_string) |
Private method for setting deprecated coupled variable documentation strings. More... | |
void | renameParamInternal (const std::string &old_name, const std::string &new_name, const std::string &docstring, const std::string &removal_date) |
void | renameCoupledVarInternal (const std::string &old_name, const std::string &new_name, const std::string &docstring, const std::string &removal_date) |
Metadata & | at (const std::string ¶m_name) |
const Metadata & | at (const std::string ¶m_name) 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... | |
const CommandLineMetadata & | getCommandLineMetadata (const std::string &name) const |
template<typename T > | |
void | addCommandLineParamHelper (const std::string &name, const std::string &syntax) |
Helper for all of the addCommandLineParam() calls, which sets up _cl_data in the metadata. 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 &, MooseFunctorName &l_value, const Real &r_value) |
template<> | |
void | setParamHelper (const std::string &, MooseFunctorName &l_value, const int &r_value) |
template<> | |
void | setParamHelper (const std::string &, PostprocessorName &l_value, const Real &r_value) |
template<> | |
void | setParamHelper (const std::string &, 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 &, MooseFunctorName &l_value, const Real &r_value) |
template<> | |
void | setParamHelper (const std::string &, MooseFunctorName &l_value, const int &r_value) |
Static Private Member Functions | |
static void | callMooseErrorHelper (const MooseObject &object, const std::string &error) |
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::tuple< std::string, Moose::RelationshipManagerType, Moose::RelationshipManagerInputParameterCallback > > | _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... | |
std::unordered_map< std::string, std::string > | _new_to_deprecated_coupled_vars |
A map from deprecated coupled variable names to the new blessed name. More... | |
std::map< std::string, std::pair< std::string, std::string > > | _old_to_new_name_and_dep |
A map from base-class/deprecated parameter names to derived-class/blessed parameter names and the deprecation messages in the case that the "old" parameter name is a deprecated parameter name. More... | |
std::multimap< std::string, std::string > | _new_to_old_names |
A map from derived-class/blessed parameter names to associated base-class/deprecated parameter names. More... | |
Friends | |
class | InputParameterWarehouse |
class | Parser |
class | ActionWarehouse |
InputParameters | emptyInputParameters () |
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
Definition at line 48 of file InputParameters.h.
InputParameters::InputParameters | ( | const InputParameters & | rhs | ) |
Definition at line 43 of file InputParameters.C.
InputParameters::InputParameters | ( | const Parameters & | rhs | ) |
Definition at line 49 of file InputParameters.C.
|
virtualdefault |
|
private |
Definition at line 34 of file InputParameters.C.
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 76 of file InputParameters.C.
Referenced by FVDiffusionInterface::validParams(), FVOneVarDiffusionInterface::validParams(), FVTwoVarContinuityConstraint::validParams(), AddBCAction::validParams(), AddConstraintAction::validParams(), SetupMeshCompleteAction::validParams(), AverageNodalVariableValue::validParams(), ElementArrayL2Norm::validParams(), AddFunctorMaterialAction::validParams(), FVScalarLagrangeMultiplierInterface::validParams(), FVAdvection::validParams(), AddFVInitialConditionAction::validParams(), AddPostprocessorAction::validParams(), FVFunctorTimeKernel::validParams(), EmptyPostprocessor::validParams(), FVMatAdvection::validParams(), FVReaction::validParams(), ArrayVariableComponent::validParams(), FVTimeKernel::validParams(), ADRobinBC::validParams(), AddScalarKernelAction::validParams(), ArrayVarReductionAux::validParams(), NumElems::validParams(), NumLinearIterations::validParams(), NumNodes::validParams(), BuildArrayVariableAux::validParams(), NumRelationshipManagers::validParams(), NumVars::validParams(), ADVectorRobinBC::validParams(), PerfGraphData::validParams(), ArrayHFEMDirichletBC::validParams(), AnalyticalIndicator::validParams(), GradientJumpIndicator::validParams(), Residual::validParams(), LaplacianJumpIndicator::validParams(), ArrayNeumannBC::validParams(), ValueJumpIndicator::validParams(), ArrayPenaltyDirichletBC::validParams(), AddDamperAction::validParams(), AddFVInterfaceKernelAction::validParams(), ArrayVacuumBC::validParams(), ADTimeDerivative::validParams(), TimestepSize::validParams(), VariableResidual::validParams(), VectorPostprocessorComponent::validParams(), ADVectorDiffusion::validParams(), VectorPostprocessorReductionValue::validParams(), ADVectorTimeDerivative::validParams(), ArrayDiffusion::validParams(), ArrayReaction::validParams(), ExternalProblem::validParams(), ArrayTimeDerivative::validParams(), ConstantReporter::validParams(), ElementVariableStatistics::validParams(), NodalVariableStatistics::validParams(), AddTransferAction::validParams(), MassEigenKernel::validParams(), ADScalarTimeDerivative::validParams(), CoupledODETimeDerivative::validParams(), ODETimeDerivative::validParams(), MassLumpedTimeDerivative::validParams(), AddUserObjectAction::validParams(), ElementIntegerAux::validParams(), HFEMDirichletBC::validParams(), AddDGKernelAction::validParams(), AddIndicatorAction::validParams(), AddVectorPostprocessorAction::validParams(), ConstantDT::validParams(), TimeDerivative::validParams(), TestSourceStepper::validParams(), CheckFVBCAction::validParams(), VectorTimeDerivative::validParams(), AddInitialConditionAction::validParams(), ExtraElementIDAux::validParams(), ErrorFractionMarker::validParams(), ErrorToleranceMarker::validParams(), UniformMarker::validParams(), ValueRangeMarker::validParams(), ValueThresholdMarker::validParams(), GenericConstant2DArray::validParams(), AddBoundsVectorsAction::validParams(), AddDiracKernelAction::validParams(), AddInterfaceKernelAction::validParams(), CopyNodalVarsAction::validParams(), GenericConstantArray::validParams(), EqualValueBoundaryConstraint::validParams(), ConstantVectorPostprocessor::validParams(), AddKernelAction::validParams(), FileMesh::validParams(), CreateExecutionerAction::validParams(), TiledMesh::validParams(), AddMarkerAction::validParams(), BoundaryDeletionGenerator::validParams(), AddMaterialAction::validParams(), DynamicObjectRegistrationAction::validParams(), ArrayHFEMDiffusion::validParams(), DGConvection::validParams(), AddElementalFieldAction::validParams(), AddMeshGeneratorAction::validParams(), ElementIDOutputAction::validParams(), HFEMDiffusion::validParams(), GlobalParamsAction::validParams(), InversePowerMethod::validParams(), AddMultiAppAction::validParams(), PartitionerAction::validParams(), ProcessorIDAux::validParams(), AddNodalKernelAction::validParams(), ReadExecutorParamsAction::validParams(), PenaltyDirichletNodalKernel::validParams(), JSONOutput::validParams(), XMLOutput::validParams(), ExtraIDIntegralReporter::validParams(), CoefReactionTempl< is_ad >::validParams(), DerivativeSumMaterialTempl< is_ad >::validParams(), GenericConstantVectorMaterialTempl< is_ad >::validParams(), VerifyElementUniqueID::validParams(), VerifyNodalUniqueID::validParams(), LineValueSampler::validParams(), PointValueSampler::validParams(), SideValueSampler::validParams(), CreateProblemAction::validParams(), AddFieldSplitAction::validParams(), PeriodicFunction::validParams(), SetupMeshAction::validParams(), FVPostprocessorDirichletBC::validParams(), ElementExtremeMaterialPropertyTempl< is_ad >::validParams(), ElementExtremeValue::validParams(), ElementL2Error::validParams(), ArrayFunctionIC::validParams(), NodalExtremeValue::validParams(), FunctionScalarIC::validParams(), AddFVBCAction::validParams(), SideExtremeValue::validParams(), TimeExtremeValue::validParams(), ArrayBodyForce::validParams(), AddFVKernelAction::validParams(), LogConstantDT::validParams(), BoxMarker::validParams(), ActivateElementsUserObjectBase::validParams(), ElementQualityChecker::validParams(), ElementSubdomainModifier::validParams(), CSVReaderVectorPostprocessor::validParams(), Eigenvalues::validParams(), GapValueAux::validParams(), ADDGKernel::validParams(), OverlayMeshGenerator::validParams(), AdaptivityAction::validParams(), NodalPatchRecoveryAuxBase::validParams(), MooseObjectAction::validParams(), PenetrationAux::validParams(), UniqueExtraIDMeshGenerator::validParams(), SetupDebugAction::validParams(), AddFunctionAction::validParams(), SetupPreconditionerAction::validParams(), TimeDerivativeAux::validParams(), FVFunctorDirichletBCTempl< is_ad >::validParams(), SidesetInfoVectorPostprocessor::validParams(), SetupPredictorAction::validParams(), AverageElementSize::validParams(), AreaPostprocessor::validParams(), ConstantPostprocessor::validParams(), AddPositionsAction::validParams(), SetupTimeIntegratorAction::validParams(), ElementAverageSecondTimeDerivative::validParams(), ElementAverageTimeDerivative::validParams(), ElementExtremeFunctorValueTempl< is_ad >::validParams(), VectorVariableMagnitudeAux::validParams(), VolumeAux::validParams(), FVCoupledForce::validParams(), SetupTimeStepperAction::validParams(), ElementL2Difference::validParams(), WeightedGapAux::validParams(), AdvectiveFluxAux::validParams(), FunctionElementAverage::validParams(), FunctionElementIntegral::validParams(), FunctionSideAverage::validParams(), NodalL2Error::validParams(), NodalMaxValueId::validParams(), NodalSum::validParams(), AddReporterAction::validParams(), ElementsAlongLine::validParams(), ScalarComponentIC::validParams(), ADVectorMatchedValueBC::validParams(), NumResidualEvaluations::validParams(), ConstantAux::validParams(), ScalarVariable::validParams(), ScalePostprocessor::validParams(), ConstantScalarAux::validParams(), InterfaceDiffusion::validParams(), CopyValueAux::validParams(), TimeIntegratedPostprocessor::validParams(), TimePostprocessor::validParams(), AddTimesAction::validParams(), VolumePostprocessor::validParams(), SingleMatrixPreconditioner::validParams(), DebugResidualAux::validParams(), ArrayCoupledTimeDerivative::validParams(), AddTimeStepperAction::validParams(), RestartableDataReporter::validParams(), CoupledTimeDerivative::validParams(), DivField::validParams(), NullScalarKernel::validParams(), GradField::validParams(), FunctionDiffusion::validParams(), ExplicitEuler::validParams(), FunctorDirichletBC::validParams(), MassMatrix::validParams(), ExplicitSSPRungeKutta::validParams(), FunctorNeumannBC::validParams(), ImplicitEuler::validParams(), MaterialDerivativeTestKernel::validParams(), TimeIntervalTimes::validParams(), NullKernel::validParams(), VectorCoupledTimeDerivative::validParams(), MultiAppCloneReporterTransfer::validParams(), MultiAppReporterTransfer::validParams(), BoundaryMarker::validParams(), InterfaceQpMaterialPropertyRealUO::validParams(), ComboMarker::validParams(), ElemSideNeighborLayersGeomTester::validParams(), ForcingFunctionAux::validParams(), ElemSideNeighborLayersTester::validParams(), GeometrySphere::validParams(), FunctionArrayAux::validParams(), InterfaceQpValueUserObject::validParams(), JSONFileReader::validParams(), ComposeTimeStepperAction::validParams(), VariableOldValueBounds::validParams(), AnnularMesh::validParams(), ElementsAlongPlane::validParams(), GeneratedMesh::validParams(), IntersectionPointsAlongLine::validParams(), LineFunctionSampler::validParams(), RinglebMesh::validParams(), SpiralAnnularMesh::validParams(), ExtraElementIntegerDivision::validParams(), NestedDivision::validParams(), AddDistributionAction::validParams(), AddMetaDataGenerator::validParams(), BlockDeletionGenerator::validParams(), BlockToMeshConverterGenerator::validParams(), DeprecatedBlockAction::validParams(), BreakBoundaryOnSubdomainGenerator::validParams(), BreakMeshByBlockGeneratorBase::validParams(), CoarsenBlockGenerator::validParams(), ElementGenerator::validParams(), ElementsToTetrahedronsConverter::validParams(), ExtraNodesetGenerator::validParams(), FileMeshGenerator::validParams(), FillBetweenCurvesGenerator::validParams(), ArrayDGDiffusion::validParams(), FillBetweenPointVectorsGenerator::validParams(), FillBetweenSidesetsGenerator::validParams(), FlipSidesetGenerator::validParams(), AddMeshDivisionAction::validParams(), LowerDBlockFromSidesetGenerator::validParams(), MoveNodeGenerator::validParams(), NodeSetsFromSideSetsGenerator::validParams(), FunctionDiracSource::validParams(), PlaneIDMeshGenerator::validParams(), RefineBlockGenerator::validParams(), RefineSidesetGenerator::validParams(), RenameBlockGenerator::validParams(), RenameBoundaryGenerator::validParams(), RinglebMeshGenerator::validParams(), SideSetsFromNodeSetsGenerator::validParams(), SideSetsFromNormalsGenerator::validParams(), SmoothMeshGenerator::validParams(), SphereMeshGenerator::validParams(), SpiralAnnularMeshGenerator::validParams(), ConstantFunction::validParams(), SubdomainIDGenerator::validParams(), SubdomainPerElementGenerator::validParams(), SymmetryTransformGenerator::validParams(), TiledMeshGenerator::validParams(), ProjectionAux::validParams(), PiecewiseConstant::validParams(), LowerBoundNodalKernel::validParams(), CoupledForceNodalKernel::validParams(), ReactionNodalKernel::validParams(), SecondTimeDerivativeAux::validParams(), UpperBoundNodalKernel::validParams(), FunctorADConverterTempl< T >::validParams(), GMVOutput::validParams(), SplineFunction::validParams(), FunctorSmootherTempl< T >::validParams(), PerfGraphOutput::validParams(), ReporterDebugOutput::validParams(), Tecplot::validParams(), VTKOutput::validParams(), XDA::validParams(), TagVectorArrayVariableValueAux::validParams(), FVBoundaryScalarLagrangeMultiplierConstraint::validParams(), DiffusionCG::validParams(), DiffusionFV::validParams(), FilePositions::validParams(), InputPositions::validParams(), MultiAppPositions::validParams(), ReporterPositions::validParams(), TransformedPositions::validParams(), VariableGradientComponent::validParams(), AxisymmetricCenterlineAverageValue::validParams(), ChangeOverTimePostprocessor::validParams(), ChangeOverFixedPointPostprocessor::validParams(), VectorMagnitudeAux::validParams(), ElementAverageMaterialPropertyTempl< is_ad >::validParams(), VectorPostprocessorVisualizationAux::validParams(), SphericalAverage::validParams(), VectorVariableComponentAux::validParams(), FVAnisotropicDiffusion::validParams(), SetupResidualDebugAction::validParams(), ElementL2FunctorErrorTempl< is_ad >::validParams(), ElementSidesL2Norm::validParams(), FVMassMatrix::validParams(), OldEqualValueConstraint::validParams(), ArrayParsedAux::validParams(), FVScalarLagrangeMultiplierConstraint::validParams(), NearestNodeNumber::validParams(), MeshGeneratorMesh::validParams(), NodalMaxValue::validParams(), NumFailedTimeSteps::validParams(), NumFixedPointIterations::validParams(), IntegralPreservingFunctionIC::validParams(), NumNonlinearIterations::validParams(), EqualValueConstraint::validParams(), ExtraIDIntegralVectorPostprocessor::validParams(), ParsedPostprocessor::validParams(), ElementValueSampler::validParams(), PseudoTimestep::validParams(), Receiver::validParams(), CylindricalAverage::validParams(), SideAverageMaterialPropertyTempl< is_ad >::validParams(), InterfaceReaction::validParams(), PenaltyInterfaceDiffusionTempl< T, is_ad >::validParams(), MessageFromInput::validParams(), ADConservativeAdvection::validParams(), ConvectiveFluxBC::validParams(), FiniteDifferencePreconditioner::validParams(), AccumulateReporter::validParams(), DiffusionFluxAux::validParams(), IterationInfo::validParams(), EigenDirichletBC::validParams(), ConservativeAdvection::validParams(), DivergenceAuxTempl< is_ad >::validParams(), Diffusion::validParams(), ParsedODEKernel::validParams(), ActuallyExplicitEuler::validParams(), BDF2::validParams(), MaterialDerivativeRankFourTestKernel::validParams(), NewmarkBeta::validParams(), MaterialDerivativeRankTwoTestKernel::validParams(), MatchedValueBCTempl< is_ad >::validParams(), ExodusFileTimes::validParams(), InputTimes::validParams(), ElementLengthAux::validParams(), SimulationTimes::validParams(), ReactionTempl< is_ad >::validParams(), ExodusTimeSequenceStepper::validParams(), FunctionDT::validParams(), PostprocessorDT::validParams(), TimeSequenceStepper::validParams(), MultiAppPostprocessorToAuxScalarTransfer::validParams(), MultiAppScalarToAuxScalarTransfer::validParams(), BoundaryPreservedMarker::validParams(), GeometryBase::validParams(), ReporterPointMarker::validParams(), InterfaceValueUserObject::validParams(), LayeredAverage::validParams(), LayeredSideAverageFunctor::validParams(), LayeredSideIntegralFunctor::validParams(), NearestNodeNumberUO::validParams(), FunctorAux::validParams(), ConstantBounds::validParams(), ProjectedStatefulMaterialNodalPatchRecoveryBase::validParams(), MaterialFunctorConverterTempl< T >::validParams(), VectorFromComponentVariablesMaterialTempl< is_ad >::validParams(), ReporterTimes::validParams(), EqualGradientConstraint::validParams(), ConcentricCircleMesh::validParams(), ImageMesh::validParams(), NodalValueSampler::validParams(), GhostingAux::validParams(), SpatialUserObjectVectorPostprocessor::validParams(), HardwareIDAux::validParams(), FunctorBinnedValuesDivision::validParams(), InterfaceValueUserObjectAux::validParams(), SubdomainsDivision::validParams(), PIDTransientControl::validParams(), AnnularMeshGenerator::validParams(), BreakMeshByBlockGenerator::validParams(), CartesianMeshGenerator::validParams(), MaxIncrement::validParams(), ADDGAdvection::validParams(), ConcentricCircleMeshGenerator::validParams(), CutMeshByPlaneGenerator::validParams(), MaterialRealDenseMatrixAux::validParams(), MaterialRealTensorValueAux::validParams(), MaterialStdVectorAuxTempl< is_ad >::validParams(), GeneratedMeshGenerator::validParams(), ImageSubdomainGenerator::validParams(), MaterialStdVectorRealGradientAux::validParams(), MeshDiagnosticsGenerator::validParams(), ConstantPointSource::validParams(), MeshRepairGenerator::validParams(), ParsedSubdomainMeshGenerator::validParams(), PatchMeshGenerator::validParams(), CSVFileTimes::validParams(), PolyLineMeshGenerator::validParams(), ParsedAux::validParams(), NullExecutor::validParams(), SideSetExtruderGenerator::validParams(), SideSetsBetweenSubdomainsGenerator::validParams(), ParsedVectorAux::validParams(), SideSetsFromPointsGenerator::validParams(), LinearCombinationFunction::validParams(), VectorDiffusion::validParams(), TransformGenerator::validParams(), CentroidMultiApp::validParams(), QuadraturePointMultiApp::validParams(), PiecewiseConstantFromCSV::validParams(), PiecewiseLinear::validParams(), PiecewiseLinearBase::validParams(), Console::validParams(), ControlOutput::validParams(), FVDirichletBC::validParams(), SpatialUserObjectAux::validParams(), ParsedFunctorMaterialTempl< is_ad >::validParams(), VectorMagnitudeFunctorMaterialTempl< is_ad >::validParams(), TagMatrixAux::validParams(), FVConstantScalarOutflowBC::validParams(), TagVectorArrayVariableAux::validParams(), TagVectorAux::validParams(), FVFunctionDirichletBC::validParams(), ElementCentroidPositions::validParams(), FunctorPositions::validParams(), FVNeumannBC::validParams(), WorkBalance::validParams(), VectorFunctionAux::validParams(), InterfaceQpMaterialPropertyBaseUserObject< Real >::validParams(), VectorPenaltyDirichletBC::validParams(), ReferenceResidualProblem::validParams(), ElementHCurlError::validParams(), ElementHCurlSemiError::validParams(), ElementHDivError::validParams(), ElementL1Error::validParams(), PositionsFunctorValueSampler::validParams(), ADDirichletBC::validParams(), FunctionSideIntegral::validParams(), ADFunctionDirichletBC::validParams(), ADFunctionNeumannBC::validParams(), InterfaceIntegralPostprocessor::validParams(), LineMaterialRealSampler::validParams(), SetAdaptivityOptionsAction::validParams(), MaterialVectorPostprocessor::validParams(), NodalL2Norm::validParams(), EqualValueEmbeddedConstraint::validParams(), ADVectorFunctionDirichletBC::validParams(), LeastSquaresFit::validParams(), ADVectorFunctionNeumannBC::validParams(), PercentChangePostprocessor::validParams(), ArrayDirichletBC::validParams(), RelativeSolutionDifferenceNorm::validParams(), FunctorVectorElementalAuxTempl< is_ad >::validParams(), MatDiffusion::validParams(), CoupledTiedValueConstraint::validParams(), ADMatCoupledForce::validParams(), ADMatReaction::validParams(), DirichletBC::validParams(), StitchBoundaryMeshGenerator::validParams(), EigenArrayDirichletBC::validParams(), NumMeshDivisions::validParams(), SolutionInvalidityReporter::validParams(), CoupledForceTempl< is_ad >::validParams(), FunctionGradientNeumannBC::validParams(), LayeredSideAverage::validParams(), LayeredSideDiffusiveFluxAverage::validParams(), NumPositions::validParams(), SideSetsFromBoundingBoxGenerator::validParams(), NeumannBCTempl< is_ad >::validParams(), ElementLpNormAux::validParams(), SolutionTimeAdaptiveDT::validParams(), TimeSequenceFromTimes::validParams(), FunctionNeumannBC::validParams(), ElementQualityAux::validParams(), VectorFunctionReaction::validParams(), PostprocessorDirichletBC::validParams(), InterfaceUserObject::validParams(), MultiAppVariableValueSampleTransfer::validParams(), VectorDivPenaltyDirichletBC::validParams(), VectorFunctionDirichletBC::validParams(), VectorDirichletBC::validParams(), MemoryUsage::validParams(), ArrayConstantIC::validParams(), FunctionAux::validParams(), ParsedCurveGenerator::validParams(), FunctorTimes::validParams(), GenericConstantRankTwoTensorTempl< is_ad >::validParams(), GenericFunctionRankTwoTensorTempl< is_ad >::validParams(), NodalNormalsCorner::validParams(), NodalNormalsEvaluator::validParams(), FunctionScalarAux::validParams(), FunctorElementalGradientAuxTempl< is_ad >::validParams(), VectorCurlPenaltyDirichletBC::validParams(), ImageMeshGenerator::validParams(), DistributedPositions::validParams(), CreateDisplacedProblemAction::validParams(), MultiAppShapeEvaluationTransfer::validParams(), VariableValueVolumeHistogram::validParams(), CartesianGridDivision::validParams(), CylindricalGridDivision::validParams(), TiedValueConstraint::validParams(), BoolFunctionControl::validParams(), SphericalGridDivision::validParams(), ConditionalFunctionEnableControl::validParams(), AdvancedExtruderGenerator::validParams(), AllSideSetsByNormalsGenerator::validParams(), MaterialRateRealAuxTempl< is_ad >::validParams(), BoundingValueElementDamper::validParams(), BoundingValueNodalDamper::validParams(), BreakMeshByElementGenerator::validParams(), CircularBoundaryCorrectionGenerator::validParams(), CombinerGenerator::validParams(), ElementHDivSemiError::validParams(), MeshCollectionGenerator::validParams(), MeshExtruderGenerator::validParams(), MeshDivisionAux::validParams(), MultiAppGeneralFieldShapeEvaluationTransfer::validParams(), NearestNodeDistanceAux::validParams(), VectorConstantPointSource::validParams(), DifferencePostprocessor::validParams(), MaterialDerivativeTestAction::validParams(), NormalizationAux::validParams(), BicubicSplineFunction::validParams(), ElementGroupCentroidPositions::validParams(), CompositeFunction::validParams(), StackGenerator::validParams(), StitchedMeshGenerator::validParams(), VariableTimeIntegrationAux::validParams(), FullSolveMultiApp::validParams(), QuotientScalarAux::validParams(), ScalarTagMatrixAux::validParams(), ScalarTagVectorAux::validParams(), LayeredExtremumMaterialProperty::validParams(), FileOutput::validParams(), Gnuplot::validParams(), GenericFunctorGradientMaterialTempl< is_ad >::validParams(), SingleRankPartitioner::validParams(), GenericFunctorMaterialTempl< is_ad >::validParams(), SolutionHistory::validParams(), BlockWeightedPartitioner::validParams(), NodalPatchRecoveryMaterialProperty::validParams(), FVFunctorNeumannBC::validParams(), GenericVectorFunctorMaterialTempl< is_ad >::validParams(), VectorMemoryUsage::validParams(), CumulativeValuePostprocessor::validParams(), FunctionElementIntegralUserObject::validParams(), ElementIntegralMaterialPropertyTempl< is_ad >::validParams(), TimeDerivativeNodalKernel::validParams(), DOFMapOutput::validParams(), MeshDivisionFunctorReductionVectorPostprocessor::validParams(), FVOrthogonalDiffusion::validParams(), LeastSquaresFitHistory::validParams(), ConstantRate::validParams(), PointValue::validParams(), QuotientAux::validParams(), MultiAppPostprocessorInterpolationTransfer::validParams(), NearestNodeValueAux::validParams(), SideAverageValue::validParams(), XYMeshLineCutter::validParams(), CoupledValueFunctionMaterialTempl< is_ad >::validParams(), AnisotropicDiffusion::validParams(), LayeredIntegral::validParams(), PiecewiseLinearInterpolationMaterial::validParams(), NearestPointLayeredSideAverageFunctor::validParams(), CoarsenedPiecewiseLinear::validParams(), OneDEqualValueConstraintBC::validParams(), FEProblem::validParams(), MatCoupledForce::validParams(), VectorOfPostprocessors::validParams(), ParsedNodeTransformGenerator::validParams(), MultiAppGeneralFieldUserObjectTransfer::validParams(), MultiAppPostprocessorTransfer::validParams(), CentralDifference::validParams(), MultiAppVectorPostprocessorTransfer::validParams(), PerfGraphReporter::validParams(), PointwiseRenormalizeVector::validParams(), CreateApplicationBlockAction::validParams(), GreaterThanLessThanPostprocessor::validParams(), MatNeumannBCTempl< is_ad >::validParams(), InterfaceAverageVariableValuePostprocessor::validParams(), DisplayGhostingAction::validParams(), ConstantDamper::validParams(), OrientedSubdomainBoundingBoxGenerator::validParams(), ElementAverageValue::validParams(), NearestPositionsDivision::validParams(), MultiAppVariableValueSamplePostprocessorTransfer::validParams(), FunctionDirichletBC::validParams(), SetupQuadratureAction::validParams(), MaterialPropertyValueTempl< is_ad >::validParams(), XYDelaunayGenerator::validParams(), NearestPointLayeredSideIntegralFunctor::validParams(), LayeredSideIntegral::validParams(), PiecewiseLinearFromVectorPostprocessor::validParams(), CSV::validParams(), FVFunctionNeumannBC::validParams(), RandomPartitioner::validParams(), FVDirichletBCBase::validParams(), MaterialADConverterTempl< T >::validParams(), AddOutputAction::validParams(), FVBodyForce::validParams(), ADPiecewiseLinearInterpolationMaterial::validParams(), ElementIntegralFunctorPostprocessorTempl< is_ad >::validParams(), LinearNodalConstraint::validParams(), InterpolatedStatefulMaterialTempl< T >::validParams(), FunctionValuePostprocessor::validParams(), NumDOFs::validParams(), VectorNeumannBC::validParams(), AddAuxVariableAction::validParams(), InterfacePostprocessor::validParams(), EigenProblem::validParams(), ElementH1SemiError::validParams(), ElementH1ErrorFunctionAux::validParams(), AddSamplerAction::validParams(), ParsedGenerateSideset::validParams(), FunctionLayeredIntegral::validParams(), ParsedMaterialTempl< is_ad >::validParams(), MaterialDerivativeTestKernelBase< Real >::validParams(), VectorBodyForce::validParams(), ElementUOAux::validParams(), SideIntegralMaterialPropertyTempl< is_ad >::validParams(), MaterialRankFourTensorAux::validParams(), ElementVectorL2Error::validParams(), ReporterPointSource::validParams(), ElementH1Error::validParams(), ADConservativeAdvectionBC::validParams(), DerivativeParsedMaterialTempl< is_ad >::validParams(), ElementIntegralVariableUserObject::validParams(), SolutionAux::validParams(), SolutionScalarAux::validParams(), FVBoundaryIntegralValueConstraint::validParams(), PetscExternalPartitioner::validParams(), DiffusionPhysicsBase::validParams(), NodalEqualValueConstraint::validParams(), ElementIntegralArrayVariablePostprocessor::validParams(), FVDivergence::validParams(), InterfaceQpUserObjectBase::validParams(), UserForcingFunctionNodalKernel::validParams(), PostprocessorNeumannBC::validParams(), MultiAppDofCopyTransfer::validParams(), ElementL2ErrorFunctionAux::validParams(), NearestPointAverage::validParams(), NearestPointIntegralVariablePostprocessor::validParams(), SideSetsAroundSubdomainGenerator::validParams(), ElementalVariableValue::validParams(), CrankNicolson::validParams(), ElementIntegralUserObject::validParams(), TransfiniteMeshGenerator::validParams(), MatReaction::validParams(), LibtorchControlValuePostprocessor::validParams(), TimePeriod::validParams(), ScalarConstantIC::validParams(), BoundingBoxIC::validParams(), TimePeriodBase::validParams(), FindValueOnLine::validParams(), PlaneDeletionGenerator::validParams(), MultiAppGeneralFieldNearestLocationTransfer::validParams(), ElementIntegralVariablePostprocessor::validParams(), SideIntegralFunctorPostprocessorTempl< is_ad >::validParams(), MaterialPropertyDebugOutput::validParams(), TransientMultiApp::validParams(), TagVectorSum::validParams(), OrientedBoxMarker::validParams(), CoupledVarNeumannBCTempl< false >::validParams(), ScalarL2Error::validParams(), ImageFunction::validParams(), ElementVariablesDifferenceMax::validParams(), ContainsPointAux::validParams(), CSVTimeSequenceStepper::validParams(), FieldSplitPreconditioner::validParams(), LibtorchArtificialNeuralNetParameters::validParams(), MultiAppProjectionTransfer::validParams(), MultiAppCopyTransfer::validParams(), FVOrthogonalBoundaryDiffusion::validParams(), StitchedMesh::validParams(), GenericConstantMaterialTempl< is_ad >::validParams(), RealFunctionControl::validParams(), PNGOutput::validParams(), VariableResidualNormsDebugOutput::validParams(), ADMatDiffusionBase< Real >::validParams(), Exodus::validParams(), VacuumBC::validParams(), LibmeshPartitioner::validParams(), DGDiffusion::validParams(), PiecewiseMulticonstant::validParams(), LinearCombinationPostprocessor::validParams(), Nemesis::validParams(), FVConstantIC::validParams(), NearestPointLayeredSideIntegral::validParams(), HistogramVectorPostprocessor::validParams(), MeshInfo::validParams(), MooseParsedVectorFunction::validParams(), PhysicsBase::validParams(), SideIntegralVariablePostprocessor::validParams(), MultiAppNearestNodeTransfer::validParams(), MaterialRealAuxTempl< is_ad >::validParams(), ADDGDiffusion::validParams(), FVDiffusion::validParams(), PiecewiseMultilinear::validParams(), InterfaceIntegralVariableValuePostprocessor::validParams(), PenaltyEqualValueConstraintTempl< is_ad >::validParams(), BodyForceTempl< is_ad >::validParams(), CommonOutputAction::validParams(), AddPeriodicBCAction::validParams(), AdamsPredictor::validParams(), PatternedMeshGenerator::validParams(), NearestPointLayeredSideDiffusiveFluxAverage::validParams(), NodalVariableValue::validParams(), NearestPointLayeredIntegral::validParams(), InternalSideIntegralVariablePostprocessor::validParams(), Heun::validParams(), ParsedElementDeletionGenerator::validParams(), Split::validParams(), ExplicitMidpoint::validParams(), Ralston::validParams(), LibtorchNeuralNetControl::validParams(), SubdomainBoundingBoxGenerator::validParams(), SinDirichletBC::validParams(), NearestPointLayeredAverage::validParams(), AddControlAction::validParams(), NearestPointLayeredSideAverage::validParams(), MaterialRealVectorValueAuxTempl< is_ad >::validParams(), SinNeumannBC::validParams(), WeakGradientBC::validParams(), InterfaceDiffusiveFluxIntegralTempl< is_ad >::validParams(), EigenExecutionerBase::validParams(), NodalNormalsPreprocessor::validParams(), SideAdvectiveFluxIntegralTempl< is_ad >::validParams(), ADFunctionPenaltyDirichletBC::validParams(), NearestRadiusLayeredAverage::validParams(), DiffusionFluxBC::validParams(), FVFunctionIC::validParams(), GhostingUserObject::validParams(), DistributedRectilinearMeshGenerator::validParams(), FunctionIC::validParams(), HFEMTestJump::validParams(), VectorConstantIC::validParams(), AddNodalNormalsAction::validParams(), HFEMTrialJump::validParams(), SideDiffusiveFluxIntegralTempl< is_ad, Real >::validParams(), MaterialRankTwoTensorAuxTempl< is_ad >::validParams(), FunctionPenaltyDirichletBC::validParams(), DumpObjectsProblem::validParams(), PropertyReadFile::validParams(), FVIntegralValueConstraint::validParams(), BoundingBoxNodeSetGenerator::validParams(), Axisymmetric2D3DSolutionFunction::validParams(), MooseParsedGradFunction::validParams(), FVBoundedValueConstraint::validParams(), VectorFunctionIC::validParams(), MultiAppUserObjectTransfer::validParams(), GenericFunctionMaterialTempl< is_ad >::validParams(), MooseParsedFunction::validParams(), MultiAppGeometricInterpolationTransfer::validParams(), DGFunctionDiffusionDirichletBC::validParams(), ProjectedStatefulMaterialStorageAction::validParams(), GenericFunctionVectorMaterialTempl< is_ad >::validParams(), PatternedMesh::validParams(), GridPartitioner::validParams(), AB2PredictorCorrector::validParams(), FVPointValueConstraint::validParams(), InterfaceUserObjectBase::validParams(), ADPeriodicSegmentalConstraint::validParams(), PostprocessorComparison::validParams(), PeriodicSegmentalConstraint::validParams(), ADPenaltyPeriodicSegmentalConstraint::validParams(), SolutionUserObject::validParams(), PenaltyPeriodicSegmentalConstraint::validParams(), ConstantIC::validParams(), PhysicsBasedPreconditioner::validParams(), ScalarSolutionIC::validParams(), ElementW1pError::validParams(), AverageValueConstraint::validParams(), RelativeDifferencePostprocessor::validParams(), VectorPostprocessorComparison::validParams(), ScalarLagrangeMultiplier::validParams(), Transient::validParams(), IterationAdaptiveDT::validParams(), PostprocessorSpatialUserObject::validParams(), ScalarLMKernelTempl< is_ad >::validParams(), VariableCondensationPreconditioner::validParams(), RadialAverage::validParams(), FunctionMaterialBase< is_ad >::validParams(), Steady::validParams(), CompositionDT::validParams(), PenaltyDirichletBC::validParams(), ADPenaltyDirichletBC::validParams(), DisplacedProblem::validParams(), Eigenvalue::validParams(), SimplePredictor::validParams(), SolutionIC::validParams(), DerivativeParsedMaterialHelperTempl< is_ad >::validParams(), RandomIC::validParams(), LStableDirk2::validParams(), Terminator::validParams(), MooseVariableBase::validParams(), RandomICBase::validParams(), MeshDivision::validParams(), LStableDirk3::validParams(), DerivativeFunctionMaterialBaseTempl< is_ad >::validParams(), ImplicitMidpoint::validParams(), OutputInterface::validParams(), ExplicitTVDRK2::validParams(), PiecewiseBilinear::validParams(), AStableDirk4::validParams(), LStableDirk4::validParams(), Sampler::validParams(), ParsedMaterialHelper< is_ad >::validParams(), Checkpoint::validParams(), and TopResidualDebugOutput::validParams().
void InputParameters::addCommandLineParam | ( | const std::string & | name, |
const std::string & | syntax, | ||
const std::string & | doc_string | ||
) |
Definition at line 1607 of file InputParameters.h.
Referenced by MooseApp::addAppParam(), Moose::addMainCommandLineParams(), and MooseApp::validParams().
void InputParameters::addCommandLineParam | ( | const std::string & | name, |
const std::string & | syntax, | ||
const T & | value, | ||
const std::string & | doc_string | ||
) |
|
private |
Helper for all of the addCommandLineParam() calls, which sets up _cl_data in the metadata.
Definition at line 1480 of file InputParameters.h.
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 249 of file InputParameters.C.
Referenced by applyCoupledVar(), transferParam(), BuildArrayVariableAux::validParams(), ArrayHFEMDirichletBC::validParams(), HFEMDirichletBC::validParams(), DerivativeSumMaterialTempl< is_ad >::validParams(), PenetrationAux::validParams(), ElementExtremeValue::validParams(), NodalExtremeValue::validParams(), SideExtremeValue::validParams(), InterfaceQpValueUserObject::validParams(), FunctionDiffusion::validParams(), VectorFromComponentVariablesMaterialTempl< is_ad >::validParams(), ParsedODEKernel::validParams(), ArrayParsedAux::validParams(), VectorMagnitudeAux::validParams(), SpatialAverageBase::validParams(), ParsedAux::validParams(), ParsedVectorAux::validParams(), ParsedMaterialBase::validParams(), NodalNormalBC::validParams(), QuotientScalarAux::validParams(), VariableValueVolumeHistogram::validParams(), ADMatReaction::validParams(), PointwiseRenormalizeVector::validParams(), QuotientAux::validParams(), CoupledValueFunctionMaterialTempl< is_ad >::validParams(), ElementVectorL2Error::validParams(), ADKernelSUPGTempl< T >::validParams(), FindValueOnLine::validParams(), MatReaction::validParams(), ADKernelScalarBase::validParams(), MortarScalarBase::validParams(), ADMortarScalarBase::validParams(), CoupledVarNeumannBCTempl< false >::validParams(), KernelScalarBase::validParams(), InterfaceIntegralVariableValuePostprocessor::validParams(), ADMatDiffusionBase< Real >::validParams(), MatDiffusionBase< Real >::validParams(), SideAdvectiveFluxIntegralTempl< is_ad >::validParams(), InterfaceDiffusiveFluxIntegralTempl< is_ad >::validParams(), BoundaryCondition::validParams(), NodeFaceConstraint::validParams(), MortarConstraintBase::validParams(), FVBoundaryCondition::validParams(), and FVInterfaceKernel::validParams().
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 220 of file InputParameters.C.
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 233 of file InputParameters.C.
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 [../]
Definition at line 287 of file InputParameters.C.
Referenced by addRequiredCoupledVarWithAutoBuild().
void InputParameters::addCustomTypeParam | ( | const std::string & | name, |
const T & | value, | ||
const std::string & | custom_type, | ||
const std::string & | doc_string | ||
) |
Definition at line 1536 of file InputParameters.h.
Referenced by ParsedVectorAux::validParams(), ParsedMaterialBase::validParams(), and MooseParsedFunction::validParams().
void InputParameters::addCustomTypeParam | ( | const std::string & | name, |
const std::string & | custom_type, | ||
const std::string & | doc_string | ||
) |
Definition at line 1547 of file InputParameters.h.
void InputParameters::addDeprecatedCoupledVar | ( | const std::string & | old_name, |
const std::string & | new_name, | ||
const std::string & | removal_date = "" |
||
) |
This method adds a deprecated 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. The doc string for the deprecated variable will be constructed from the doc string for the new variable. A deprecation message will also be automatically generated
Definition at line 259 of file InputParameters.C.
void InputParameters::addDeprecatedCustomTypeParam | ( | const std::string & | name, |
const std::string & | custom_type, | ||
const std::string & | doc_string, | ||
const std::string & | deprecation_msg | ||
) |
Definition at line 1557 of file InputParameters.h.
Referenced by ParsedMaterialBase::validParams(), and MooseParsedFunction::validParams().
void InputParameters::addDeprecatedParam | ( | const std::string & | name, |
const T & | value, | ||
const std::string & | doc_string, | ||
const std::string & | deprecation_message | ||
) |
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 1698 of file InputParameters.h.
Referenced by AdaptivityAction::validParams(), SetupDebugAction::validParams(), AnnularMesh::validParams(), BlockDeletionGenerator::validParams(), RenameBlockGenerator::validParams(), RenameBoundaryGenerator::validParams(), AnnularMeshGenerator::validParams(), ParsedSubdomainMeshGenerator::validParams(), SideSetsBetweenSubdomainsGenerator::validParams(), Console::validParams(), PostprocessorDT::validParams(), VectorFunctionDirichletBC::validParams(), SideSetsFromBoundingBoxGenerator::validParams(), PicardSolve::validParams(), FixedPointSolve::validParams(), ParsedGenerateSideset::validParams(), DerivativeKernelInterface< T >::validParams(), Exodus::validParams(), MooseParsedVectorFunction::validParams(), CommonOutputAction::validParams(), MatDiffusionBase< Real >::validParams(), PropertyReadFile::validParams(), MooseParsedGradFunction::validParams(), MultiAppUserObjectTransfer::validParams(), MultiAppTransfer::validParams(), Transient::validParams(), FunctionMaterialBase< is_ad >::validParams(), OversampleOutput::validParams(), MooseParsedFunctionBase::validParams(), DerivativeFunctionMaterialBaseTempl< is_ad >::validParams(), Executioner::validParams(), Output::validParams(), MultiApp::validParams(), and FEProblemBase::validParams().
void InputParameters::addDeprecatedParam | ( | const std::string & | name, |
const std::string & | doc_string, | ||
const std::string & | deprecation_message | ||
) |
Definition at line 1712 of file InputParameters.h.
void InputParameters::addDeprecatedParam | ( | const std::string & | , |
const std::string & | , | ||
const std::string & | |||
) |
Definition at line 1078 of file InputParameters.C.
void InputParameters::addDeprecatedParam | ( | const std::string & | , |
const std::string & | , | ||
const std::string & | |||
) |
Definition at line 1088 of file InputParameters.C.
void InputParameters::addDeprecatedParam | ( | const std::string & | name, |
const std::string & | doc_string, | ||
const std::string & | deprecation_message | ||
) |
void InputParameters::addDeprecatedParam | ( | const std::string & | name, |
const std::string & | doc_string, | ||
const std::string & | deprecation_message | ||
) |
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 1436 of file InputParameters.h.
Referenced by addDeprecatedCoupledVar(), ConstantReporter::addReporterTypeParams(), MultiAppTransfer::addSkipCoordCollapsingParam(), AdvancedOutput::addValidParams(), Moose::commonAdaptivityParams(), Moose::PetscSupport::getPetscValidParams(), Moose::SlepcSupport::getSlepcEigenProblemValidParams(), FVDiffusionInterface::validParams(), FVOneVarDiffusionInterface::validParams(), ArrayVariableComponent::validParams(), ValueRangeMarker::validParams(), ValueThresholdMarker::validParams(), ConstantVectorPostprocessor::validParams(), FileMesh::validParams(), TiledMesh::validParams(), ArrayVarReductionAux::validParams(), InversePowerMethod::validParams(), NonlinearEigen::validParams(), ADRobinBC::validParams(), ADVectorRobinBC::validParams(), CopyNodalVarsAction::validParams(), ArrayNeumannBC::validParams(), ArrayHFEMDirichletBC::validParams(), PenaltyDirichletNodalKernel::validParams(), ArrayPenaltyDirichletBC::validParams(), ArrayVacuumBC::validParams(), CreateExecutionerAction::validParams(), ElementIntegerAux::validParams(), HFEMDirichletBC::validParams(), FVFunctorTimeKernel::validParams(), FVMatAdvection::validParams(), FVReaction::validParams(), NumElems::validParams(), NumRelationshipManagers::validParams(), NumVars::validParams(), PerfGraphData::validParams(), Residual::validParams(), VectorPostprocessorReductionValue::validParams(), EqualValueBoundaryConstraint::validParams(), ArrayTimeDerivative::validParams(), ElementStatistics::validParams(), NodalStatistics::validParams(), MassEigenKernel::validParams(), DynamicObjectRegistrationAction::validParams(), ReadExecutorParamsAction::validParams(), TimeDerivative::validParams(), VectorTimeDerivative::validParams(), ErrorFractionMarker::validParams(), ErrorToleranceMarker::validParams(), DerivativeSumMaterialTempl< is_ad >::validParams(), ThresholdElementSubdomainModifier::validParams(), CreateProblemAction::validParams(), JSONOutput::validParams(), AddFieldSplitAction::validParams(), ExtremeValueBase< SideVariablePostprocessor >::validParams(), ExtraIDIntegralReporter::validParams(), CoefReactionTempl< is_ad >::validParams(), ActivateElementsByPath::validParams(), ActivateElementsCoupled::validParams(), CSVReaderVectorPostprocessor::validParams(), Eigenvalues::validParams(), FEProblemSolve::validParams(), SetupMeshAction::validParams(), UniqueExtraIDMeshGenerator::validParams(), GapValueAux::validParams(), MooseObjectAction::validParams(), TimeExtremeValue::validParams(), AdaptivityAction::validParams(), ActivateElementsUserObjectBase::validParams(), PenetrationAux::validParams(), ElementQualityChecker::validParams(), ElementSubdomainModifier::validParams(), ProjectionAux::validParams(), ConditionalEnableControl::validParams(), SetupDebugAction::validParams(), SecondTimeDerivativeAux::validParams(), SidesetInfoVectorPostprocessor::validParams(), TimeDerivativeAux::validParams(), ArrayDGDiffusion::validParams(), AnnularMesh::validParams(), GeneratedMesh::validParams(), SpiralAnnularMesh::validParams(), RinglebMesh::validParams(), AddMetaDataGenerator::validParams(), BlockDeletionGenerator::validParams(), BreakBoundaryOnSubdomainGenerator::validParams(), BreakMeshByBlockGeneratorBase::validParams(), CoarsenBlockGenerator::validParams(), ElementGenerator::validParams(), ExtraNodesetGenerator::validParams(), FileMeshGenerator::validParams(), FillBetweenCurvesGenerator::validParams(), FillBetweenPointVectorsGenerator::validParams(), FillBetweenSidesetsGenerator::validParams(), AdvectiveFluxAux::validParams(), LowerDBlockFromSidesetGenerator::validParams(), ConstantFunction::validParams(), MoveNodeGenerator::validParams(), PiecewiseConstant::validParams(), PlaneIDMeshGenerator::validParams(), RefineBlockGenerator::validParams(), RefineSidesetGenerator::validParams(), RenameBlockGenerator::validParams(), RenameBoundaryGenerator::validParams(), RinglebMeshGenerator::validParams(), SideSetsFromNormalsGenerator::validParams(), SmoothMeshGenerator::validParams(), SphereMeshGenerator::validParams(), SpiralAnnularMeshGenerator::validParams(), ConstantAux::validParams(), SubdomainPerElementGenerator::validParams(), TiledMeshGenerator::validParams(), CoupledForceNodalKernel::validParams(), LowerBoundNodalKernel::validParams(), FVFunctorDirichletBCTempl< is_ad >::validParams(), ReactionNodalKernel::validParams(), UpperBoundNodalKernel::validParams(), DeprecatedBlockAction::validParams(), DirichletBCBase::validParams(), FVCoupledForce::validParams(), FunctorDirichletBC::validParams(), FunctorNeumannBC::validParams(), ElementExtremeFunctorValueTempl< is_ad >::validParams(), ConstantPostprocessor::validParams(), InterfaceDiffusion::validParams(), ScalarVariable::validParams(), ScalePostprocessor::validParams(), TimeIntegratedPostprocessor::validParams(), SingleMatrixPreconditioner::validParams(), RestartableDataReporter::validParams(), NullScalarKernel::validParams(), BoundsBase::validParams(), CoefTimeDerivative::validParams(), DivField::validParams(), TimeIntervalTimes::validParams(), GradField::validParams(), FunctionDiffusion::validParams(), MultiAppCloneReporterTransfer::validParams(), MultiAppReporterTransfer::validParams(), NullKernel::validParams(), ElemSideNeighborLayersTester::validParams(), GeometrySphere::validParams(), BoundaryMarker::validParams(), PIDTransientControl::validParams(), MultiAppConservativeTransfer::validParams(), SpatialAverageBase::validParams(), SpatialUserObjectVectorPostprocessor::validParams(), MaterialFunctorConverterTempl< T >::validParams(), ParsedMaterialBase::validParams(), ADDGAdvection::validParams(), ConcentricCircleMesh::validParams(), MaxIncrement::validParams(), ImageMesh::validParams(), MeshGeneratorMesh::validParams(), SetupResidualDebugAction::validParams(), FunctorBinnedValuesDivision::validParams(), ArrayParsedAux::validParams(), AnnularMeshGenerator::validParams(), VariableGradientComponent::validParams(), BreakMeshByBlockGenerator::validParams(), VectorPostprocessorVisualizationAux::validParams(), CartesianMeshGenerator::validParams(), VectorVariableComponentAux::validParams(), ConcentricCircleMeshGenerator::validParams(), CutMeshByPlaneGenerator::validParams(), GeneratedMeshGenerator::validParams(), MeshDiagnosticsGenerator::validParams(), MeshRepairGenerator::validParams(), ParsedSubdomainMeshGenerator::validParams(), PatchMeshGenerator::validParams(), PolyLineMeshGenerator::validParams(), PiecewiseLinear::validParams(), SideSetExtruderGenerator::validParams(), DivergenceAuxTempl< is_ad >::validParams(), SideSetsBetweenSubdomainsGenerator::validParams(), SplineFunction::validParams(), FunctorADConverterTempl< T >::validParams(), FunctorSmootherTempl< T >::validParams(), TransformGenerator::validParams(), Receiver::validParams(), FVBoundaryScalarLagrangeMultiplierConstraint::validParams(), Console::validParams(), ControlOutput::validParams(), GMVOutput::validParams(), FunctorAux::validParams(), PerfGraphOutput::validParams(), FVAnisotropicDiffusion::validParams(), Tecplot::validParams(), VTKOutput::validParams(), DiffusionCG::validParams(), DiffusionFV::validParams(), FVMassMatrix::validParams(), MultiAppPositions::validParams(), TransformedPositions::validParams(), MatchedValueBCTempl< is_ad >::validParams(), ChangeOverFixedPointPostprocessor::validParams(), ChangeOverTimePostprocessor::validParams(), FVScalarLagrangeMultiplierConstraint::validParams(), GhostingAux::validParams(), InterfaceValueUserObjectAux::validParams(), NumNonlinearIterations::validParams(), ParsedPostprocessor::validParams(), MaterialRealTensorValueAux::validParams(), PseudoTimestep::validParams(), MaterialRealDenseMatrixAux::validParams(), PenaltyInterfaceDiffusionTempl< T, is_ad >::validParams(), MaterialStdVectorAuxTempl< is_ad >::validParams(), FiniteDifferencePreconditioner::validParams(), ADConservativeAdvection::validParams(), MaterialStdVectorRealGradientAux::validParams(), IterationInfo::validParams(), ParsedODEKernel::validParams(), ActuallyExplicitEuler::validParams(), NewmarkBeta::validParams(), CSVFileTimes::validParams(), Times::validParams(), ConservativeAdvection::validParams(), FunctionDT::validParams(), PostprocessorDT::validParams(), TimeSequenceStepperBase::validParams(), EqualValueConstraint::validParams(), ReactionTempl< is_ad >::validParams(), ParsedAux::validParams(), NodalConstraint::validParams(), GeometryBase::validParams(), InterfaceValueUserObject::validParams(), ParsedVectorAux::validParams(), QuadraturePointMarker::validParams(), InterfaceQpMaterialPropertyBaseUserObject< Real >::validParams(), TiedValueConstraint::validParams(), BoundingValueElementDamper::validParams(), ScalarTagMatrixAux::validParams(), LeastSquaresFit::validParams(), MaterialVectorPostprocessor::validParams(), PositionsFunctorValueSampler::validParams(), ScalarTagVectorAux::validParams(), BoundingValueNodalDamper::validParams(), WorkBalance::validParams(), CoupledForceTempl< is_ad >::validParams(), FunctorTimes::validParams(), TagMatrixAux::validParams(), CartesianGridDivision::validParams(), CylindricalGridDivision::validParams(), SphericalGridDivision::validParams(), AdvancedExtruderGenerator::validParams(), VariableTimeIntegrationAux::validParams(), BreakMeshByElementGenerator::validParams(), CircularBoundaryCorrectionGenerator::validParams(), CombinerGenerator::validParams(), BicubicSplineFunction::validParams(), CompositeFunction::validParams(), ImageMeshGenerator::validParams(), MeshExtruderGenerator::validParams(), ParsedCurveGenerator::validParams(), ADFunctionDirichletBC::validParams(), SideSetsFromBoundingBoxGenerator::validParams(), ADVectorFunctionDirichletBC::validParams(), ADVectorFunctionNeumannBC::validParams(), StackGenerator::validParams(), StitchBoundaryMeshGenerator::validParams(), StitchedMeshGenerator::validParams(), CreateDisplacedProblemAction::validParams(), ParsedFunctorMaterialTempl< is_ad >::validParams(), VectorMagnitudeFunctorMaterialTempl< is_ad >::validParams(), FullSolveMultiApp::validParams(), FVNeumannBC::validParams(), FunctorElementalGradientAuxTempl< is_ad >::validParams(), MaterialStdVectorAuxBaseTempl< Real, is_ad >::validParams(), FunctionGradientNeumannBC::validParams(), MultiAppShapeEvaluationTransfer::validParams(), FunctorVectorElementalAuxTempl< is_ad >::validParams(), ElementGroupCentroidPositions::validParams(), Positions::validParams(), NeumannBCTempl< is_ad >::validParams(), FunctionSideIntegral::validParams(), MemoryUsage::validParams(), VectorCurlPenaltyDirichletBC::validParams(), VectorDivPenaltyDirichletBC::validParams(), VectorFunctionDirichletBC::validParams(), MaterialDerivativeTestAction::validParams(), ReferenceResidualProblem::validParams(), VectorPenaltyDirichletBC::validParams(), ADMatCoupledForce::validParams(), ADMatReaction::validParams(), MeshDivisionAux::validParams(), ScalarKernelBase::validParams(), VariableValueVolumeHistogram::validParams(), CoupledTiedValueConstraint::validParams(), SetAdaptivityOptionsAction::validParams(), EqualValueEmbeddedConstraint::validParams(), NormalizationAux::validParams(), Constraint::validParams(), VectorFunctionReaction::validParams(), SolutionTimeAdaptiveDT::validParams(), MultiAppVariableValueSamplePostprocessorTransfer::validParams(), CoupledValueFunctionMaterialTempl< is_ad >::validParams(), VectorMemoryUsage::validParams(), LeastSquaresFitHistory::validParams(), PointVariableSamplerBase::validParams(), FVOrthogonalDiffusion::validParams(), PiecewiseLinearInterpolationMaterial::validParams(), SetupQuadratureAction::validParams(), MultiAppPostprocessorInterpolationTransfer::validParams(), MaterialAuxBaseTempl< RealVectorValue, is_ad >::validParams(), CreateApplicationBlockAction::validParams(), CoarsenedPiecewiseLinear::validParams(), OrientedSubdomainBoundingBoxGenerator::validParams(), ParsedNodeTransformGenerator::validParams(), PiecewiseLinearFromVectorPostprocessor::validParams(), PiecewiseTabularBase::validParams(), GenericFunctorMaterialTempl< is_ad >::validParams(), GenericVectorFunctorMaterialTempl< is_ad >::validParams(), XYDelaunayGenerator::validParams(), XYMeshLineCutter::validParams(), FVFunctorNeumannBC::validParams(), CSV::validParams(), DOFMapOutput::validParams(), FileOutput::validParams(), Gnuplot::validParams(), SolutionHistory::validParams(), SingleRankPartitioner::validParams(), GenericFunctorGradientMaterialTempl< is_ad >::validParams(), DisplayGhostingAction::validParams(), GreaterThanLessThanPostprocessor::validParams(), MatCoupledForce::validParams(), MaterialPropertyValueTempl< is_ad >::validParams(), MultiAppPostprocessorTransfer::validParams(), PointwiseRenormalizeVector::validParams(), PointSamplerBase::validParams(), ADPiecewiseLinearInterpolationMaterial::validParams(), NodalScalarKernel::validParams(), RandomPartitioner::validParams(), ReporterPointSource::validParams(), FixedPointSolve::validParams(), FVBodyForce::validParams(), ElementDeletionGeneratorBase::validParams(), ADConservativeAdvectionBC::validParams(), ParsedGenerateSideset::validParams(), MaterialADConverterTempl< T >::validParams(), LinearNodalConstraint::validParams(), FVFunctionNeumannBC::validParams(), ElementUOAux::validParams(), NumDOFs::validParams(), IntegratedBCBase::validParams(), ElementIntegralFunctorPostprocessorTempl< is_ad >::validParams(), MaterialDerivativeTestKernelBase< Real >::validParams(), EigenProblem::validParams(), VectorNeumannBC::validParams(), FunctionValuePostprocessor::validParams(), ADKernelSUPGTempl< T >::validParams(), TagAuxBase< AuxKernel >::validParams(), ElementVectorL2Error::validParams(), ElemElemConstraint::validParams(), VectorBodyForce::validParams(), MultiAppGeneralFieldNearestLocationTransfer::validParams(), MortarNodalAuxKernelTempl< ComputeValueType >::validParams(), SolutionAux::validParams(), DiffusionPhysicsBase::validParams(), SolutionScalarAux::validParams(), PetscExternalPartitioner::validParams(), MultiAppDofCopyTransfer::validParams(), SideSetsAroundSubdomainGenerator::validParams(), DerivativeKernelInterface< T >::validParams(), TimePeriod::validParams(), TimeStepper::validParams(), TransfiniteMeshGenerator::validParams(), FindValueOnLine::validParams(), PostprocessorNeumannBC::validParams(), InterfaceQpUserObjectBase::validParams(), ElementIntegralArrayVariablePostprocessor::validParams(), BoundingBoxIC::validParams(), MatReaction::validParams(), LibtorchControlValuePostprocessor::validParams(), StitchedMesh::validParams(), ADMortarScalarBase::validParams(), ElementVariablesDifferenceMax::validParams(), CSVTimeSequenceStepper::validParams(), FVOrthogonalBoundaryDiffusion::validParams(), TransientMultiApp::validParams(), CoupledVarNeumannBCTempl< false >::validParams(), FieldSplitPreconditioner::validParams(), KernelScalarBase::validParams(), SideIntegralFunctorPostprocessorTempl< is_ad >::validParams(), ElementSideNeighborLayers::validParams(), EigenKernel::validParams(), MultiAppProjectionTransfer::validParams(), ADKernelScalarBase::validParams(), MortarScalarBase::validParams(), PhysicsBase::validParams(), LibmeshPartitioner::validParams(), DGDiffusion::validParams(), MeshInfo::validParams(), ADDirichletBCBase::validParams(), Exodus::validParams(), MooseParsedVectorFunction::validParams(), ADMatDiffusionBase< Real >::validParams(), PiecewiseMulticonstant::validParams(), ADDGDiffusion::validParams(), PNGOutput::validParams(), FVDiffusion::validParams(), VariableResidualNormsDebugOutput::validParams(), MultiAppNearestNodeTransfer::validParams(), VacuumBC::validParams(), InterfaceIntegralVariableValuePostprocessor::validParams(), LinearCombinationPostprocessor::validParams(), PiecewiseMultilinear::validParams(), BodyForceTempl< is_ad >::validParams(), CommonOutputAction::validParams(), LibtorchNeuralNetControl::validParams(), Split::validParams(), ExplicitTimeIntegrator::validParams(), ParsedElementDeletionGenerator::validParams(), PatternedMeshGenerator::validParams(), AddPeriodicBCAction::validParams(), AdamsPredictor::validParams(), SubdomainBoundingBoxGenerator::validParams(), MaterialRealVectorValueAuxTempl< is_ad >::validParams(), NodalVariableValue::validParams(), NodalPatchRecovery::validParams(), FunctionIC::validParams(), EigenExecutionerBase::validParams(), InterfaceDiffusiveFluxIntegralTempl< is_ad >::validParams(), SetupInterface::validParams(), DistributedRectilinearMeshGenerator::validParams(), GhostingUserObject::validParams(), RelationshipManager::validParams(), SinNeumannBC::validParams(), FVFunctionIC::validParams(), MatDiffusionBase< Real >::validParams(), NodalNormalsPreprocessor::validParams(), PiecewiseMultiInterpolation::validParams(), ADDirichletBCBaseTempl< Real >::validParams(), SideAdvectiveFluxIntegralTempl< is_ad >::validParams(), MooseParsedGradFunction::validParams(), Axisymmetric2D3DSolutionFunction::validParams(), Damper::validParams(), SideDiffusiveFluxIntegralTempl< is_ad, Real >::validParams(), BoundingBoxNodeSetGenerator::validParams(), NodalBCBase::validParams(), VectorConstantIC::validParams(), SideSetsGeneratorBase::validParams(), PropertyReadFile::validParams(), AddNodalNormalsAction::validParams(), VectorFunctionIC::validParams(), ComparisonPostprocessor::validParams(), TableOutput::validParams(), GenericFunctionMaterialTempl< is_ad >::validParams(), InterfaceKernelBase::validParams(), Predictor::validParams(), GenericFunctionVectorMaterialTempl< is_ad >::validParams(), MultiAppUserObjectTransfer::validParams(), DGFunctionDiffusionDirichletBC::validParams(), MultiAppGeometricInterpolationTransfer::validParams(), ProjectedStatefulMaterialStorageAction::validParams(), ADNodalBCTempl< RealVectorValue, ADDirichletBCBase >::validParams(), PatternedMesh::validParams(), NearestPointBase< LayeredSideDiffusiveFluxAverage, SideIntegralVariableUserObject >::validParams(), DiracKernelBase::validParams(), GridPartitioner::validParams(), AB2PredictorCorrector::validParams(), SolutionUserObject::validParams(), PenaltyPeriodicSegmentalConstraint::validParams(), ElementIndicator::validParams(), ADPenaltyPeriodicSegmentalConstraint::validParams(), MultiAppTransfer::validParams(), FVKernel::validParams(), NodalUserObject::validParams(), IterationAdaptiveDT::validParams(), TransientInterface::validParams(), NodalKernelBase::validParams(), Transient::validParams(), BoundaryCondition::validParams(), VariableCondensationPreconditioner::validParams(), VectorPostprocessor::validParams(), FunctionMaterialBase< is_ad >::validParams(), Steady::validParams(), FileRangeBuilder::validParams(), Material::validParams(), ADPenaltyDirichletBC::validParams(), Indicator::validParams(), NodeFaceConstraint::validParams(), PenaltyDirichletBC::validParams(), FVFluxKernel::validParams(), MoosePreconditioner::validParams(), RandomInterface::validParams(), InternalSideIndicator::validParams(), Eigenvalue::validParams(), LayeredBase::validParams(), MooseObject::validParams(), RandomIC::validParams(), MultiAppGeneralFieldTransfer::validParams(), TaggingInterface::validParams(), MortarConsumerInterface::validParams(), DerivativeParsedMaterialHelperTempl< is_ad >::validParams(), OversampleOutput::validParams(), RandomICBase::validParams(), MooseVariableBase::validParams(), AuxScalarKernel::validParams(), Terminator::validParams(), PetscOutput::validParams(), ShapeUserObject< SideUserObject >::validParams(), MooseParsedFunctionBase::validParams(), BoundaryRestrictable::validParams(), Transfer::validParams(), DGKernelBase::validParams(), OutputInterface::validParams(), Control::validParams(), NestedSolveTempl< is_ad >::validParams(), MeshGenerator::validParams(), Action::validParams(), ScalarInitialCondition::validParams(), MortarConstraintBase::validParams(), PiecewiseBilinear::validParams(), Executioner::validParams(), DomainUserObject::validParams(), AStableDirk4::validParams(), Output::validParams(), MeshBaseImageSampler::validParams(), UserObject::validParams(), FunctionParserUtils< false >::validParams(), Sampler::validParams(), ImageSampler::validParams(), InitialConditionBase::validParams(), ParsedMaterialHelper< is_ad >::validParams(), Checkpoint::validParams(), FVBoundaryCondition::validParams(), FVInterfaceKernel::validParams(), Moose::Builder::validParams(), BlockRestrictable::validParams(), MaterialPropertyInterface::validParams(), AuxKernelTempl< Real >::validParams(), TopResidualDebugOutput::validParams(), SubProblem::validParams(), MaterialBase::validParams(), MooseApp::validParams(), MooseMesh::validParams(), MultiApp::validParams(), Executor::validParams(), and FEProblemBase::validParams().
void InputParameters::addParam | ( | const std::string & | name, |
const std::string & | doc_string | ||
) |
Definition at line 1459 of file InputParameters.h.
|
inline |
void InputParameters::addParam | ( | const std::string & | , |
const std::string & | |||
) |
Definition at line 1035 of file InputParameters.C.
void InputParameters::addParam | ( | const std::string & | , |
const std::string & | |||
) |
Definition at line 1044 of file InputParameters.C.
void InputParameters::addParam | ( | const std::string & | , |
const std::string & | |||
) |
void InputParameters::addParam | ( | const std::string & | , |
const std::string & | |||
) |
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 775 of file InputParameters.C.
Referenced by MultiAppTransfer::addSkipCoordCollapsingParam(), AdvancedOutput::addValidParams(), Moose::PetscSupport::getPetscValidParams(), Moose::SlepcSupport::getSlepcEigenProblemValidParams(), CopyNodalVarsAction::validParams(), NodalPatchRecoveryBase::validParams(), DerivativeSumMaterialTempl< is_ad >::validParams(), MooseObjectAction::validParams(), SetupMeshAction::validParams(), GeneratedMesh::validParams(), MaterialStdVectorAuxTempl< is_ad >::validParams(), MultiAppConservativeTransfer::validParams(), Times::validParams(), Console::validParams(), GMVOutput::validParams(), Tecplot::validParams(), VTKOutput::validParams(), DiffusionFV::validParams(), AdvancedExtruderGenerator::validParams(), SetAdaptivityOptionsAction::validParams(), Constraint::validParams(), Positions::validParams(), ScalarKernelBase::validParams(), LeastSquaresFitHistory::validParams(), PiecewiseTabularBase::validParams(), CSV::validParams(), FileOutput::validParams(), FixedPointSolve::validParams(), IntegratedBCBase::validParams(), TransfiniteMeshGenerator::validParams(), DiffusionPhysicsBase::validParams(), TransientMultiApp::validParams(), Exodus::validParams(), PhysicsBase::validParams(), NodalPatchRecovery::validParams(), Postprocessor::validParams(), EigenExecutionerBase::validParams(), NodalBCBase::validParams(), InterfaceKernelBase::validParams(), TableOutput::validParams(), DiracKernelBase::validParams(), NearestPointBase< LayeredSideDiffusiveFluxAverage, SideIntegralVariableUserObject >::validParams(), SolutionUserObject::validParams(), FVKernel::validParams(), TransientInterface::validParams(), NodalKernelBase::validParams(), Transient::validParams(), BoundaryCondition::validParams(), RadialAverage::validParams(), VectorPostprocessor::validParams(), Material::validParams(), Indicator::validParams(), RandomInterface::validParams(), ProjectedStatefulMaterialNodalPatchRecoveryTempl< T, is_ad >::validParams(), FVFluxKernel::validParams(), LayeredBase::validParams(), Eigenvalue::validParams(), MultiAppGeneralFieldTransfer::validParams(), TaggingInterface::validParams(), OversampleOutput::validParams(), MooseObject::validParams(), AuxScalarKernel::validParams(), MooseVariableBase::validParams(), ShapeUserObject< SideUserObject >::validParams(), PetscOutput::validParams(), DGKernelBase::validParams(), OutputInterface::validParams(), MeshGenerator::validParams(), Executioner::validParams(), Output::validParams(), UserObject::validParams(), MeshBaseImageSampler::validParams(), FunctionParserUtils< false >::validParams(), ImageSampler::validParams(), InitialConditionBase::validParams(), FVBoundaryCondition::validParams(), FVInterfaceKernel::validParams(), AuxKernelTempl< Real >::validParams(), SubProblem::validParams(), MultiApp::validParams(), and FEProblemBase::validParams().
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 1584 of file InputParameters.h.
Referenced by AddControlAction::act(), FEProblemBase::addOutput(), ActionFactory::create(), ActionFactory::getValidParams(), GlobalParamsAction::validParams(), CreateProblemDefaultAction::validParams(), NodalReporter::validParams(), XDA::validParams(), ElementReporter::validParams(), GeneralReporter::validParams(), MoosePartitioner::validParams(), BoundaryRestrictableRequired::validParams(), RelationshipManager::validParams(), NodalNormalsPreprocessor::validParams(), EigenExecutionerBase::validParams(), VectorPostprocessor::validParams(), InternalSideIndicator::validParams(), MoosePreconditioner::validParams(), DisplacedProblem::validParams(), Eigenvalue::validParams(), MooseObject::validParams(), TaggingInterface::validParams(), MooseVariableBase::validParams(), BoundaryRestrictable::validParams(), MeshGenerator::validParams(), Action::validParams(), Output::validParams(), Checkpoint::validParams(), BlockRestrictable::validParams(), MaterialPropertyInterface::validParams(), AuxKernelTempl< Real >::validParams(), MaterialBase::validParams(), MooseApp::validParams(), MultiApp::validParams(), and FEProblemBase::validParams().
void InputParameters::addPrivateParam | ( | const std::string & | name | ) |
Definition at line 1573 of file InputParameters.h.
void InputParameters::addPrivateParam | ( | const std::string & | ) |
Definition at line 1062 of file InputParameters.C.
void InputParameters::addPrivateParam | ( | const std::string & | ) |
Definition at line 1070 of file InputParameters.C.
void InputParameters::addPrivateParam | ( | const std::string & | ) |
void InputParameters::addPrivateParam | ( | const std::string & | ) |
void InputParameters::addRangeCheckedParam | ( | const std::string & | name, |
const T & | value, | ||
const std::string & | parsed_function, | ||
const std::string & | doc_string | ||
) |
Definition at line 1505 of file InputParameters.h.
Referenced by MultiAppTransfer::addBBoxFactorParam(), Moose::commonAdaptivityParams(), ConstantDT::validParams(), ErrorFractionMarker::validParams(), PeriodicFunction::validParams(), LogConstantDT::validParams(), AnnularMesh::validParams(), CoarsenBlockGenerator::validParams(), FillBetweenCurvesGenerator::validParams(), GeneratedMesh::validParams(), FillBetweenPointVectorsGenerator::validParams(), FillBetweenSidesetsGenerator::validParams(), AnnularMeshGenerator::validParams(), ConcentricCircleMesh::validParams(), NewmarkBeta::validParams(), ConcentricCircleMeshGenerator::validParams(), ImageMesh::validParams(), EqualValueConstraint::validParams(), GeneratedMeshGenerator::validParams(), CircularBoundaryCorrectionGenerator::validParams(), ParsedCurveGenerator::validParams(), ElementLpNormAux::validParams(), ImageMeshGenerator::validParams(), CylindricalGridDivision::validParams(), SphericalGridDivision::validParams(), AdvancedExtruderGenerator::validParams(), XYDelaunayGenerator::validParams(), FixedPointSolve::validParams(), TimeStepper::validParams(), TransfiniteMeshGenerator::validParams(), SideSetsAroundSubdomainGenerator::validParams(), ElementSideNeighborLayers::validParams(), PNGOutput::validParams(), PatternedMeshGenerator::validParams(), ElementPointNeighborLayers::validParams(), DistributedRectilinearMeshGenerator::validParams(), PatternedMesh::validParams(), ElementW1pError::validParams(), IterationAdaptiveDT::validParams(), RadialAverage::validParams(), MultiAppGeneralFieldTransfer::validParams(), MooseVariableBase::validParams(), DerivativeFunctionMaterialBaseTempl< is_ad >::validParams(), Output::validParams(), and MultiApp::validParams().
void InputParameters::addRangeCheckedParam | ( | const std::string & | name, |
const std::string & | parsed_function, | ||
const std::string & | doc_string | ||
) |
Definition at line 1516 of file InputParameters.h.
void InputParameters::addRelationshipManager | ( | const std::string & | name, |
Moose::RelationshipManagerType | rm_type, | ||
Moose::RelationshipManagerInputParameterCallback | input_parameter_callback = nullptr |
||
) |
Tells MOOSE about a RelationshipManager that this object needs.
RelationshipManagers handle element "ghosting", "non-local DOF access" and "sparsity pattern" relationships.
Basically: if this object needs non-local (ie non-current-element) data access then you probably need a relationship manager
name | The name of the RelationshipManager type |
rm_type | The type (GEOMETRIC/ALGEBRAIC) of the RelationshipManger. Note: You can use boolean logic to to "or" RelationshipManagerTypes together to make a RelationshipManager that is multi-typed. |
input_parameter_callback | This is a function pointer that will get called to fill in the RelationShipManager's InputParameters. See MooseTypes.h for the signature of this function. |
Definition at line 487 of file InputParameters.C.
Referenced by NodalPatchRecoveryBase::validParams(), ProjectionAux::validParams(), ElemSideNeighborLayersTester::validParams(), ElemSideNeighborLayersGeomTester::validParams(), FVFunctorDirichletBCTempl< is_ad >::validParams(), ProjectedStatefulMaterialNodalPatchRecoveryBase::validParams(), GMVOutput::validParams(), Tecplot::validParams(), FunctorElementalGradientAuxTempl< is_ad >::validParams(), MultiAppProjectionTransfer::validParams(), Exodus::validParams(), DistributedRectilinearMeshGenerator::validParams(), InterfaceKernelBase::validParams(), InternalSideUserObject::validParams(), InterfaceUserObjectBase::validParams(), FVKernel::validParams(), SideUserObject::validParams(), RadialAverage::validParams(), InterfaceMaterial::validParams(), ProjectedStatefulMaterialNodalPatchRecoveryTempl< T, is_ad >::validParams(), MortarConsumerInterface::validParams(), DGKernelBase::validParams(), MortarConstraintBase::validParams(), DomainUserObject::validParams(), FVInterfaceKernel::validParams(), AuxKernelTempl< Real >::validParams(), and MooseVariableFV< Real >::validParams().
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!
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 1597 of file InputParameters.h.
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 313 of file InputParameters.C.
Referenced by transferParam(), ArrayVariableComponent::validParams(), FVScalarLagrangeMultiplierInterface::validParams(), VariableInnerProduct::validParams(), ElementVariableStatistics::validParams(), NodalVariableStatistics::validParams(), CoupledODETimeDerivative::validParams(), CoupledVarThresholdElementSubdomainModifier::validParams(), LowerDIntegratedBC::validParams(), ArrayVarReductionAux::validParams(), SideVariablePostprocessor::validParams(), ActivateElementsCoupled::validParams(), SideValueSampler::validParams(), DerivativeSumMaterialTempl< is_ad >::validParams(), ElementVariablePostprocessor::validParams(), VectorVariableMagnitudeAux::validParams(), ArrayCoupledTimeDerivative::validParams(), InterfaceQpValueUserObject::validParams(), ElementVariableVectorPostprocessor::validParams(), ArrayLowerDIntegratedBC::validParams(), NodalVariableVectorPostprocessor::validParams(), CoupledTimeDerivative::validParams(), DivField::validParams(), ADVectorMatchedValueBC::validParams(), GradField::validParams(), VectorCoupledTimeDerivative::validParams(), ProjectionAux::validParams(), CoupledForceNodalKernel::validParams(), LowerBoundNodalKernel::validParams(), UpperBoundNodalKernel::validParams(), SecondTimeDerivativeAux::validParams(), CopyValueAux::validParams(), ElementL2Difference::validParams(), VectorMagnitudeAux::validParams(), VectorVariableComponentAux::validParams(), FVBoundaryScalarLagrangeMultiplierConstraint::validParams(), DiffusionFluxAux::validParams(), FVScalarLagrangeMultiplierConstraint::validParams(), ConservativeAdvection::validParams(), VariableGradientComponent::validParams(), MatchedValueBCTempl< is_ad >::validParams(), VectorFromComponentVariablesMaterialTempl< is_ad >::validParams(), VariableTimeIntegrationAux::validParams(), ElementLpNormAux::validParams(), CoupledForceTempl< is_ad >::validParams(), NormalizationAux::validParams(), ScalarTagMatrixAux::validParams(), ElementHCurlSemiError::validParams(), ElementHDivSemiError::validParams(), NodalVariablePostprocessor::validParams(), MatCoupledForce::validParams(), NearestNodeValueAux::validParams(), OneDEqualValueConstraintBC::validParams(), PiecewiseLinearInterpolationMaterial::validParams(), PointVariableSamplerBase::validParams(), MaterialDerivativeTestKernelBase< Real >::validParams(), InterpolatedStatefulMaterialTempl< T >::validParams(), ADPiecewiseLinearInterpolationMaterial::validParams(), TagAuxBase< AuxKernel >::validParams(), SideIntegralVariableUserObject::validParams(), ElementIntegralVariableUserObject::validParams(), NodalEqualValueConstraint::validParams(), ElementIntegralVariablePostprocessor::validParams(), ElementIntegralArrayVariablePostprocessor::validParams(), ElementVariablesDifferenceMax::validParams(), CoupledVarNeumannBCTempl< false >::validParams(), DGLowerDKernel::validParams(), SideIntegralVariablePostprocessor::validParams(), InterfaceIntegralVariableValuePostprocessor::validParams(), InternalSideIntegralVariablePostprocessor::validParams(), InterfaceDiffusiveFluxIntegralTempl< is_ad >::validParams(), ArrayDGLowerDKernel::validParams(), HFEMTestJump::validParams(), CompositeTensorBase< T, U >::validParams(), HFEMTrialJump::validParams(), InterfaceKernelBase::validParams(), PeriodicSegmentalConstraint::validParams(), ADPenaltyPeriodicSegmentalConstraint::validParams(), PenaltyPeriodicSegmentalConstraint::validParams(), NodeElemConstraint::validParams(), ADPeriodicSegmentalConstraint::validParams(), and ScalarLagrangeMultiplier::validParams().
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 302 of file InputParameters.C.
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 1526 of file InputParameters.h.
Referenced by ArrayParsedAux::validParams(), ParsedAux::validParams(), ParsedODEKernel::validParams(), ParsedPostprocessor::validParams(), ParsedVectorAux::validParams(), ParsedFunctorMaterialTempl< is_ad >::validParams(), and Terminator::validParams().
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, an error will be thrown
Definition at line 1410 of file InputParameters.h.
Referenced by FVDiffusionInterface::validParams(), FVOneVarDiffusionInterface::validParams(), EqualValueBoundaryConstraint::validParams(), AnalyticalIndicator::validParams(), PenaltyDirichletNodalKernel::validParams(), ArrayDiffusion::validParams(), ArrayReaction::validParams(), PerfGraphData::validParams(), DGConvection::validParams(), IndicatorMarker::validParams(), VariableResidual::validParams(), VectorPostprocessorComponent::validParams(), VectorPostprocessorReductionValue::validParams(), UniformMarker::validParams(), ValueRangeMarker::validParams(), GenericConstant2DArray::validParams(), ConstantDT::validParams(), GenericConstantArray::validParams(), TestSourceStepper::validParams(), FileMesh::validParams(), TiledMesh::validParams(), BoundaryDeletionGenerator::validParams(), ConstantVectorPostprocessor::validParams(), ExtraElementIDAux::validParams(), ArrayPenaltyDirichletBC::validParams(), FVAdvection::validParams(), FVMatAdvection::validParams(), ExtraIDIntegralReporter::validParams(), ActivateElementsCoupled::validParams(), GenericConstantVectorMaterialTempl< is_ad >::validParams(), NodalPatchRecoveryBase::validParams(), PeriodicFunction::validParams(), ThresholdElementSubdomainModifier::validParams(), LineValueSampler::validParams(), PointValueSampler::validParams(), MooseObjectAction::validParams(), UniqueExtraIDMeshGenerator::validParams(), FunctionScalarIC::validParams(), ArrayFunctionIC::validParams(), PenetrationAux::validParams(), ElementExtremeMaterialPropertyTempl< is_ad >::validParams(), ElementL2Error::validParams(), NodalPatchRecoveryAuxBase::validParams(), ArrayBodyForce::validParams(), TimeExtremeValue::validParams(), BoxMarker::validParams(), ActivateElementsUserObjectBase::validParams(), ElementQualityChecker::validParams(), CSVReaderVectorPostprocessor::validParams(), GapValueAux::validParams(), OverlayMeshGenerator::validParams(), FVPostprocessorDirichletBC::validParams(), SubdomainPerElementGenerator::validParams(), SymmetryTransformGenerator::validParams(), SubdomainIDGenerator::validParams(), TiledMeshGenerator::validParams(), BoundsBase::validParams(), ScalarComponentIC::validParams(), ElementExtremeFunctorValueTempl< is_ad >::validParams(), FunctionElementIntegral::validParams(), ProjectedMaterialPropertyNodalPatchRecoveryAux::validParams(), NodalL2Error::validParams(), ScalarVariable::validParams(), ScalePostprocessor::validParams(), ComboMarker::validParams(), AdvectiveFluxAux::validParams(), BoundaryMarker::validParams(), ExplicitSSPRungeKutta::validParams(), ArrayDGDiffusion::validParams(), FunctionDiracSource::validParams(), MultiAppCloneReporterTransfer::validParams(), MultiAppReporterTransfer::validParams(), FunctionArrayAux::validParams(), AnnularMesh::validParams(), GeneratedMesh::validParams(), ElemSideNeighborLayersGeomTester::validParams(), ElemSideNeighborLayersTester::validParams(), JSONFileReader::validParams(), RinglebMesh::validParams(), ExtraElementIntegerDivision::validParams(), NestedDivision::validParams(), ElementsAlongLine::validParams(), ElementsAlongPlane::validParams(), IntersectionPointsAlongLine::validParams(), BlockToMeshConverterGenerator::validParams(), LineFunctionSampler::validParams(), BreakBoundaryOnSubdomainGenerator::validParams(), CoarsenBlockGenerator::validParams(), FVFunctorDirichletBCTempl< is_ad >::validParams(), ElementGenerator::validParams(), ElementsToTetrahedronsConverter::validParams(), ExtraNodesetGenerator::validParams(), FileMeshGenerator::validParams(), FillBetweenCurvesGenerator::validParams(), FillBetweenPointVectorsGenerator::validParams(), FillBetweenSidesetsGenerator::validParams(), FlipSidesetGenerator::validParams(), LowerDBlockFromSidesetGenerator::validParams(), DebugResidualAux::validParams(), NodeSetsFromSideSetsGenerator::validParams(), MoveNodeGenerator::validParams(), ConstantScalarAux::validParams(), PlaneIDMeshGenerator::validParams(), FunctorDirichletBC::validParams(), FunctorNeumannBC::validParams(), RefineBlockGenerator::validParams(), RefineSidesetGenerator::validParams(), RenameBlockGenerator::validParams(), RenameBoundaryGenerator::validParams(), FVCoupledForce::validParams(), RinglebMeshGenerator::validParams(), SideSetsFromNodeSetsGenerator::validParams(), SideSetsFromNormalsGenerator::validParams(), SmoothMeshGenerator::validParams(), VectorFromComponentVariablesMaterialTempl< is_ad >::validParams(), TransformGenerator::validParams(), DivergenceAuxTempl< is_ad >::validParams(), IntegralPreservingFunctionIC::validParams(), FilePositions::validParams(), InputPositions::validParams(), MultiAppPositions::validParams(), ReporterPositions::validParams(), TransformedPositions::validParams(), ChangeOverFixedPointPostprocessor::validParams(), ChangeOverTimePostprocessor::validParams(), ConstantBounds::validParams(), TagVectorArrayVariableValueAux::validParams(), ElementLengthAux::validParams(), InterfaceReaction::validParams(), PenaltyInterfaceDiffusionTempl< T, is_ad >::validParams(), EqualGradientConstraint::validParams(), ConcentricCircleMesh::validParams(), ADConservativeAdvection::validParams(), ElementL2FunctorErrorTempl< is_ad >::validParams(), NearestNodeNumber::validParams(), ParsedPostprocessor::validParams(), SpatialUserObjectVectorPostprocessor::validParams(), MaterialDerivativeRankFourTestKernel::validParams(), MaterialDerivativeRankTwoTestKernel::validParams(), PseudoTimestep::validParams(), DiffusionFluxAux::validParams(), PIDTransientControl::validParams(), Times::validParams(), CylindricalAverage::validParams(), BoundaryPreservedMarker::validParams(), AccumulateReporter::validParams(), ReporterPointMarker::validParams(), CSVFileTimes::validParams(), ExodusFileTimes::validParams(), InputTimes::validParams(), ReporterTimes::validParams(), QuadraturePointMarker::validParams(), ExodusTimeSequenceStepper::validParams(), PostprocessorDT::validParams(), ADDGAdvection::validParams(), TimeSequenceStepper::validParams(), MultiAppConservativeTransfer::validParams(), ConstantPointSource::validParams(), MultiAppPostprocessorToAuxScalarTransfer::validParams(), MultiAppScalarToAuxScalarTransfer::validParams(), Distribution::validParams(), VectorPostprocessorVisualizationAux::validParams(), MessageFromInput::validParams(), NearestNodeNumberUO::validParams(), LinearCombinationFunction::validParams(), FunctorBinnedValuesDivision::validParams(), ExtraIDIntegralVectorPostprocessor::validParams(), AnnularMeshGenerator::validParams(), PiecewiseConstantFromCSV::validParams(), SpatialAverageBase::validParams(), BreakMeshByBlockGenerator::validParams(), CartesianMeshGenerator::validParams(), SplineFunction::validParams(), CutMeshByPlaneGenerator::validParams(), ConcentricCircleMeshGenerator::validParams(), FunctorAux::validParams(), GeneratedMeshGenerator::validParams(), ImageSubdomainGenerator::validParams(), MeshDiagnosticsGenerator::validParams(), MeshRepairGenerator::validParams(), ParsedSubdomainMeshGenerator::validParams(), FVAnisotropicDiffusion::validParams(), SideSetExtruderGenerator::validParams(), GhostingAux::validParams(), SideSetsBetweenSubdomainsGenerator::validParams(), SideSetsFromPointsGenerator::validParams(), InterfaceValueUserObjectAux::validParams(), VariableValueVolumeHistogram::validParams(), PostprocessorDirichletBC::validParams(), ArrayConstantIC::validParams(), VectorFunctionAux::validParams(), VectorCurlPenaltyDirichletBC::validParams(), VectorDirichletBC::validParams(), VectorDivPenaltyDirichletBC::validParams(), DistributedPositions::validParams(), FVConstantScalarOutflowBC::validParams(), MeshDivisionAux::validParams(), FunctorPositions::validParams(), VectorPenaltyDirichletBC::validParams(), Positions::validParams(), NearestNodeDistanceAux::validParams(), ParsedFunctorMaterialTempl< is_ad >::validParams(), InterfaceQpMaterialPropertyBaseUserObject< Real >::validParams(), DifferencePostprocessor::validParams(), ElementHCurlSemiError::validParams(), ElementHDivSemiError::validParams(), EqualValueEmbeddedConstraint::validParams(), VectorConstantPointSource::validParams(), BoolFunctionControl::validParams(), PercentChangePostprocessor::validParams(), SpatialUserObjectAux::validParams(), SolutionTimeAdaptiveDT::validParams(), AdvancedExtruderGenerator::validParams(), MaterialVectorPostprocessor::validParams(), FunctionAux::validParams(), TagVectorArrayVariableAux::validParams(), AllSideSetsByNormalsGenerator::validParams(), ADDirichletBC::validParams(), LeastSquaresFit::validParams(), GenericConstantRankTwoTensorTempl< is_ad >::validParams(), StitchedMeshGenerator::validParams(), FunctorTimes::validParams(), TagVectorAux::validParams(), MultiAppVariableValueSampleTransfer::validParams(), ElementQualityAux::validParams(), CylindricalGridDivision::validParams(), ElementL1Error::validParams(), ADFunctionNeumannBC::validParams(), NodalNormalsCorner::validParams(), FunctionScalarAux::validParams(), PositionsFunctorValueSampler::validParams(), LayeredSideDiffusiveFluxAverage::validParams(), BreakMeshByElementGenerator::validParams(), CircularBoundaryCorrectionGenerator::validParams(), VectorMagnitudeFunctorMaterialTempl< is_ad >::validParams(), CombinerGenerator::validParams(), MaterialDerivativeTestAction::validParams(), ConditionalFunctionEnableControl::validParams(), ArrayDirichletBC::validParams(), FVDirichletBC::validParams(), FVFunctionDirichletBC::validParams(), DirichletBC::validParams(), FunctorElementalGradientAuxTempl< is_ad >::validParams(), FunctionGradientNeumannBC::validParams(), MeshCollectionGenerator::validParams(), MeshExtruderGenerator::validParams(), GenericFunctionRankTwoTensorTempl< is_ad >::validParams(), BicubicSplineFunction::validParams(), FunctorVectorElementalAuxTempl< is_ad >::validParams(), ParsedCurveGenerator::validParams(), FunctionNeumannBC::validParams(), TimeSequenceFromTimes::validParams(), NumPositions::validParams(), NumMeshDivisions::validParams(), SideSetsFromBoundingBoxGenerator::validParams(), StackGenerator::validParams(), StitchBoundaryMeshGenerator::validParams(), CoarsenedPiecewiseLinear::validParams(), XYDelaunayGenerator::validParams(), XYMeshLineCutter::validParams(), ConstantRate::validParams(), ParsedNodeTransformGenerator::validParams(), BlockWeightedPartitioner::validParams(), FunctionElementIntegralUserObject::validParams(), ElementIntegralMaterialPropertyTempl< is_ad >::validParams(), CumulativeValuePostprocessor::validParams(), NearestNodeValueAux::validParams(), GreaterThanLessThanPostprocessor::validParams(), MaterialPropertyValueTempl< is_ad >::validParams(), MeshDivisionFunctorReductionVectorPostprocessor::validParams(), ConstantDamper::validParams(), MultiAppVectorPostprocessorTransfer::validParams(), CoupledValueFunctionMaterialTempl< is_ad >::validParams(), FVOrthogonalDiffusion::validParams(), MultiAppVariableValueSamplePostprocessorTransfer::validParams(), OneDEqualValueConstraintBC::validParams(), MultiAppGeneralFieldUserObjectTransfer::validParams(), PiecewiseLinearInterpolationMaterial::validParams(), VectorOfPostprocessors::validParams(), NearestPositionsDivision::validParams(), MultiAppPostprocessorInterpolationTransfer::validParams(), LeastSquaresFitHistory::validParams(), FVFunctorNeumannBC::validParams(), MaterialAuxBaseTempl< RealVectorValue, is_ad >::validParams(), PointValue::validParams(), MultiAppPostprocessorTransfer::validParams(), OrientedSubdomainBoundingBoxGenerator::validParams(), PiecewiseLinearFromVectorPostprocessor::validParams(), AnisotropicDiffusion::validParams(), FunctionDirichletBC::validParams(), MatNeumannBCTempl< is_ad >::validParams(), MaterialDerivativeTestKernelBase< Real >::validParams(), MaterialRankFourTensorAux::validParams(), ElementIntegralFunctorPostprocessorTempl< is_ad >::validParams(), ElementH1SemiError::validParams(), ElementDeletionGeneratorBase::validParams(), FunctionValuePostprocessor::validParams(), ADPiecewiseLinearInterpolationMaterial::validParams(), ReporterPointSource::validParams(), ElementUOAux::validParams(), SideIntegralFunctorUserObject::validParams(), InterpolatedStatefulMaterialTempl< T >::validParams(), ParsedGenerateSideset::validParams(), FVFunctionNeumannBC::validParams(), LinearNodalConstraint::validParams(), TransfiniteMeshGenerator::validParams(), BoundingBoxIC::validParams(), AuxNodalScalarKernel::validParams(), ElementL2ErrorFunctionAux::validParams(), UserForcingFunctionNodalKernel::validParams(), ElementalVariableValue::validParams(), ScalarConstantIC::validParams(), LibtorchControlValuePostprocessor::validParams(), SideSetsAroundSubdomainGenerator::validParams(), SolutionScalarAux::validParams(), FVDivergence::validParams(), SolutionAux::validParams(), PlaneDeletionGenerator::validParams(), ScalarL2Error::validParams(), TagVectorSum::validParams(), BoundaryRestrictableRequired::validParams(), SideIntegralFunctorPostprocessorTempl< is_ad >::validParams(), CSVTimeSequenceStepper::validParams(), GenericConstantMaterialTempl< is_ad >::validParams(), StitchedMesh::validParams(), MultiAppCopyTransfer::validParams(), FieldSplitPreconditioner::validParams(), OrientedBoxMarker::validParams(), LibtorchArtificialNeuralNetParameters::validParams(), ContainsPointAux::validParams(), FVOrthogonalBoundaryDiffusion::validParams(), DGDiffusion::validParams(), LinearCombinationPostprocessor::validParams(), HistogramVectorPostprocessor::validParams(), LibmeshPartitioner::validParams(), RealFunctionControl::validParams(), PNGOutput::validParams(), ADDGDiffusion::validParams(), FVDiffusion::validParams(), FVConstantIC::validParams(), NodalVariableValue::validParams(), SubdomainBoundingBoxGenerator::validParams(), PatternedMeshGenerator::validParams(), ParsedElementDeletionGenerator::validParams(), LibtorchNeuralNetControl::validParams(), ADFunctionPenaltyDirichletBC::validParams(), DistributedRectilinearMeshGenerator::validParams(), ProxyRelationshipManager::validParams(), NodalNormalsPreprocessor::validParams(), SideAdvectiveFluxIntegralTempl< is_ad >::validParams(), EigenExecutionerBase::validParams(), InterfaceDiffusiveFluxIntegralTempl< is_ad >::validParams(), FunctionIC::validParams(), RelationshipManager::validParams(), FVFunctionIC::validParams(), VectorConstantIC::validParams(), DumpObjectsProblem::validParams(), MaterialRankTwoTensorAuxTempl< is_ad >::validParams(), BoundingBoxNodeSetGenerator::validParams(), PropertyReadFile::validParams(), FunctionPenaltyDirichletBC::validParams(), FVBoundedValueConstraint::validParams(), Axisymmetric2D3DSolutionFunction::validParams(), NodalDamper::validParams(), CompositeTensorBase< T, U >::validParams(), Predictor::validParams(), ComparisonPostprocessor::validParams(), DGFunctionDiffusionDirichletBC::validParams(), MultiAppUserObjectTransfer::validParams(), ElementDamper::validParams(), CompileTimeDerivativesMaterial< N, is_ad, MaxD >::validParams(), FVPointValueConstraint::validParams(), AB2PredictorCorrector::validParams(), PatternedMesh::validParams(), NodeElemConstraint::validParams(), PostprocessorComparison::validParams(), ConstantIC::validParams(), SolutionUserObject::validParams(), ElementIndicator::validParams(), AverageValueConstraint::validParams(), RelativeDifferencePostprocessor::validParams(), ScalarSolutionIC::validParams(), ElementW1pError::validParams(), PhysicsBasedPreconditioner::validParams(), VectorPostprocessorComparison::validParams(), PostprocessorSpatialUserObject::validParams(), IterationAdaptiveDT::validParams(), RadialAverage::validParams(), ScalarLMKernelTempl< is_ad >::validParams(), VariableCondensationPreconditioner::validParams(), PenaltyDirichletBC::validParams(), ADPenaltyDirichletBC::validParams(), InternalSideIndicator::validParams(), ProjectedStatefulMaterialNodalPatchRecoveryTempl< T, is_ad >::validParams(), SamplerBase::validParams(), SolutionIC::validParams(), LayeredBase::validParams(), MortarConsumerInterface::validParams(), AuxScalarKernel::validParams(), LineMaterialSamplerBase< Real >::validParams(), OrientedBoxInterface::validParams(), FVInitialConditionBase::validParams(), InitialConditionBase::validParams(), FVBoundaryCondition::validParams(), FVInterfaceKernel::validParams(), AuxKernelTempl< Real >::validParams(), and MultiApp::validParams().
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 1426 of file InputParameters.h.
void InputParameters::addRequiredParam | ( | const std::string & | name, |
const MooseEnum & | moose_enum, | ||
const std::string & | doc_string | ||
) |
Definition at line 996 of file InputParameters.C.
void InputParameters::addRequiredParam | ( | const std::string & | name, |
const MultiMooseEnum & | moose_enum, | ||
const std::string & | doc_string | ||
) |
Definition at line 1008 of file InputParameters.C.
void InputParameters::addRequiredParam | ( | const std::string & | name, |
const MooseEnum & | moose_enum, | ||
const std::string & | doc_string | ||
) |
void InputParameters::addRequiredParam | ( | const std::string & | name, |
const MultiMooseEnum & | moose_enum, | ||
const std::string & | doc_string | ||
) |
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 1495 of file InputParameters.h.
Referenced by LogConstantDT::validParams(), AnnularMesh::validParams(), SpiralAnnularMesh::validParams(), TimeIntervalTimes::validParams(), SpiralAnnularMeshGenerator::validParams(), FillBetweenCurvesGenerator::validParams(), FillBetweenPointVectorsGenerator::validParams(), FillBetweenSidesetsGenerator::validParams(), SphereMeshGenerator::validParams(), PseudoTimestep::validParams(), AnnularMeshGenerator::validParams(), FunctorBinnedValuesDivision::validParams(), MaxIncrement::validParams(), ParsedCurveGenerator::validParams(), SphericalGridDivision::validParams(), CartesianGridDivision::validParams(), CylindricalGridDivision::validParams(), and PenaltyEqualValueConstraintTempl< is_ad >::validParams().
|
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 1111 of file InputParameters.h.
Referenced by ActionWarehouse::printInputFile().
|
private |
Appends description of what a functor is to a doc string.
Definition at line 1108 of file InputParameters.C.
Referenced by addParam(), and addRequiredParam().
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.
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 894 of file InputParameters.C.
Referenced by applyParameters(), and applySpecificParameters().
void InputParameters::applyParameter | ( | const InputParameters & | common, |
const std::string & | common_name, | ||
bool | allow_private = false |
||
) |
Apply values from a single parameter in common, to a single parameter stored in this object.
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 921 of file InputParameters.C.
Referenced by ComposeTimeStepperAction::act(), applyParameters(), and applySpecificParameters().
void InputParameters::applyParameters | ( | const InputParameters & | common, |
std::vector< std::string > | exclude = std::vector<std::string>() |
||
) |
Method for applying common 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.
Definition at line 827 of file InputParameters.C.
Referenced by FEProblemBase::addOutput(), and ProjectedStatefulMaterialStorageAction::processProperty().
void InputParameters::applySpecificParameters | ( | const InputParameters & | common, |
const std::vector< std::string > & | include, | ||
bool | allow_private = false |
||
) |
Method for applying common 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.
Definition at line 859 of file InputParameters.C.
Referenced by AddVariableAction::init(), OverlayMeshGenerator::OverlayMeshGenerator(), and ProjectedStatefulMaterialStorageAction::processProperty().
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 405 of file InputParameters.C.
Referenced by ActionWarehouse::buildBuildableActions().
|
inlineprivate |
Definition at line 1087 of file InputParameters.h.
Referenced by addCommandLineParamHelper(), getCommandLineMetadata(), getControllableExecuteOnTypes(), inputLocation(), isCommandLineParameter(), and paramFullpath().
|
inlineprivate |
Definition at line 1094 of file InputParameters.h.
bool InputParameters::attemptPrintDeprecated | ( | const std::string & | name | ) |
Prints the deprecated parameter message, assuming we have the right flags set.
Definition at line 104 of file InputParameters.C.
|
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 858 of file InputParameters.h.
Referenced by AddFVICAction::act(), AddICAction::act(), AddAuxKernelAction::act(), checkParams(), MooseBaseParameterInterface::getRenamedParam(), MooseApp::getRenamedParam(), MooseObjectAction::MooseObjectAction(), and Moose::Builder::walkRaw().
|
inline |
Definition at line 859 of file InputParameters.h.
|
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 849 of file InputParameters.h.
Referenced by checkParams(), and Moose::Builder::walkRaw().
|
inline |
Definition at line 850 of file InputParameters.h.
|
staticprivate |
Definition at line 1454 of file InputParameters.C.
Referenced by getParamHelper().
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 ;)
name | the name of the parameter |
Definition at line 1628 of file InputParameters.h.
std::string InputParameters::checkForRename | ( | const std::string & | name | ) | const |
Checks whether the provided name is a renamed parameter name.
If so we return the 'new' name. If not we return the incoming name
name | The name to check for whether it is a renamed name |
name
is a renamed name, else name
Definition at line 1432 of file InputParameters.C.
Referenced by applyParameter(), at(), attemptPrintDeprecated(), checkConsistentType(), checkParams(), ScalarCoupleable::checkVar(), Coupleable::checkVar(), Coupleable::coupledComponents(), ScalarCoupleable::coupledScalarComponents(), declareControllable(), get(), getCheckedPointerParam(), getCommandLineMetadata(), getControllableExecuteOnTypes(), getDescription(), getDocString(), getGroupName(), getMooseType(), getParamHelper(), ScalarCoupleable::getScalarVar(), Coupleable::getVarHelper(), getVecMooseType(), hasDefault(), have_parameter(), ignoreParameter(), isCommandLineParameter(), isControllable(), Coupleable::isCoupled(), ScalarCoupleable::isCoupledScalar(), isParamDeprecated(), isParamRequired(), isParamSetByAddParam(), isParamSetByUser(), isParamValid(), isPrivate(), isRangeChecked(), isType(), makeParamNotRequired(), makeParamRequired(), rangeCheckedFunction(), reservedValues(), set(), set_attributes(), setDocString(), setReservedValues(), shouldIgnore(), suppressParameter(), transferParam(), and type().
|
private |
Make sure the parameter name doesn't have any invalid characters.
Definition at line 1252 of file InputParameters.C.
Referenced by addParam(), addPrivateParam(), addRequiredParam(), and set().
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 553 of file InputParameters.C.
Referenced by FEProblemBase::addFVInitialCondition(), FEProblemBase::addInitialCondition(), ActionFactory::create(), Factory::create(), and AppFactory::createShared().
|
overridevirtual |
Definition at line 59 of file InputParameters.C.
|
inline |
Clears all currently registered RelationshipManagers.
Definition at line 581 of file InputParameters.h.
Referenced by ElemSideNeighborLayersGeomTester::validParams().
void InputParameters::collapseSyntaxNesting | ( | bool | collapse | ) |
Mutators for controlling whether or not the outermost level of syntax will be collapsed when printed.
Definition at line 510 of file InputParameters.C.
Referenced by Moose::Builder::buildFullTree(), and Moose::Builder::buildJsonSyntaxTree().
bool InputParameters::collapseSyntaxNesting | ( | ) | const |
Definition at line 516 of file InputParameters.C.
|
inline |
Methods returning iterators to the coupled variables names stored in this InputParameters object.
Definition at line 636 of file InputParameters.h.
Referenced by Coupleable::Coupleable(), FunctionMaterialBase< is_ad >::FunctionMaterialBase(), LazyCoupleable::LazyCoupleable(), and ScalarCoupleable::ScalarCoupleable().
|
inline |
Definition at line 640 of file InputParameters.h.
Referenced by Coupleable::Coupleable(), FunctionMaterialBase< is_ad >::FunctionMaterialBase(), LazyCoupleable::LazyCoupleable(), and ScalarCoupleable::ScalarCoupleable().
void InputParameters::declareControllable | ( | const std::string & | name, |
std::set< ExecFlagType > | execute_flags = {} |
||
) |
Declare the given parameters as controllable.
Definition at line 421 of file InputParameters.C.
Referenced by GenericConstant2DArray::validParams(), PenaltyDirichletNodalKernel::validParams(), GenericConstantArray::validParams(), GenericConstantVectorMaterialTempl< is_ad >::validParams(), ConstantScalarAux::validParams(), ConstantFunction::validParams(), ConstantPostprocessor::validParams(), ConstantAux::validParams(), ReactionTempl< is_ad >::validParams(), ConstantPointSource::validParams(), DirichletBC::validParams(), NeumannBCTempl< is_ad >::validParams(), ADDirichletBC::validParams(), VectorDirichletBC::validParams(), ArrayDirichletBC::validParams(), VectorConstantPointSource::validParams(), PiecewiseTabularBase::validParams(), PiecewiseLinearInterpolationMaterial::validParams(), ConstantRate::validParams(), FunctionValuePostprocessor::validParams(), FVBodyForce::validParams(), VectorBodyForce::validParams(), TimeStepper::validParams(), GenericConstantMaterialTempl< is_ad >::validParams(), BodyForceTempl< is_ad >::validParams(), Damper::validParams(), InterfaceKernelBase::validParams(), DiracKernelBase::validParams(), IterationAdaptiveDT::validParams(), PenaltyDirichletBC::validParams(), ADPenaltyDirichletBC::validParams(), AuxScalarKernel::validParams(), Output::validParams(), UserObject::validParams(), FVBoundaryCondition::validParams(), FVInterfaceKernel::validParams(), AuxKernelTempl< Real >::validParams(), MultiApp::validParams(), and FEProblemBase::validParams().
Real InputParameters::defaultCoupledValue | ( | const std::string & | coupling_name, |
unsigned int | i = 0 |
||
) | const |
Get the default value for an optionally coupled variable.
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 658 of file InputParameters.C.
Referenced by applyCoupledVar(), ScalarCoupleable::getADDefaultValue(), Coupleable::getADDefaultValue(), Coupleable::getADDefaultVectorValue(), Coupleable::getDefaultArrayValue(), ScalarCoupleable::getDefaultValue(), Coupleable::getDefaultValue(), Coupleable::getDefaultVectorValue(), and transferParam().
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).
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 650 of file InputParameters.C.
void InputParameters::deprecateCoupledVar | ( | const std::string & | old_name, |
const std::string & | new_name, | ||
const std::string & | removal_date | ||
) |
Definition at line 1424 of file InputParameters.C.
Referenced by DerivativeSumMaterialTempl< is_ad >::validParams(), ParsedAux::validParams(), ParsedMaterialBase::validParams(), ParsedODEKernel::validParams(), MaterialDerivativeTestKernelBase< Real >::validParams(), and CompositeTensorBase< T, U >::validParams().
void InputParameters::deprecateParam | ( | const std::string & | old_name, |
const std::string & | new_name, | ||
const std::string & | removal_date | ||
) |
Definition at line 1416 of file InputParameters.C.
Referenced by ParsedAux::validParams(), ParsedODEKernel::validParams(), PicardSolve::validParams(), CommonOutputAction::validParams(), and Output::validParams().
std::string InputParameters::errorPrefix | ( | const std::string & | param | ) | const |
generate error message prefix with parameter name and location (if available)
Definition at line 1308 of file InputParameters.C.
Referenced by attemptPrintDeprecated(), get(), and paramErrorPrefix().
std::vector< std::pair< R1, R2 > > InputParameters::get | ( | const std::string & | param1, |
const std::string & | param2 | ||
) | const |
Combine two vector parameters into a single vector of pairs.
Definition at line 1856 of file InputParameters.h.
Referenced by ElementIDOutputAction::act(), AddMaterialAction::act(), SplitMeshAction::act(), MeshOnlyAction::act(), SetupMeshAction::act(), SetupDebugAction::act(), MaterialOutputAction::act(), ActionWarehouse::addActionBlock(), FEProblemBase::addAuxKernel(), FEProblemBase::addAuxScalarKernel(), FEProblemBase::addAuxVariable(), FEProblemBase::addBoundaryCondition(), FEProblemBase::addConstraint(), NonlinearSystemBase::addDGKernel(), FEProblemBase::addDGKernel(), FEProblemBase::addDiracKernel(), FunctorMaterial::addFunctorPropertyByBlocks(), FEProblemBase::addFVInitialCondition(), FEProblemBase::addFVKernel(), FEProblemBase::addIndicator(), FEProblemBase::addInitialCondition(), FEProblemBase::addInterfaceKernel(), MooseEigenSystem::addKernel(), AuxiliarySystem::addKernel(), NonlinearSystemBase::addKernel(), FEProblemBase::addKernel(), FEProblem::addLineSearch(), FEProblemBase::addMarker(), FEProblemBase::addMaterialHelper(), FEProblemBase::addMultiApp(), NonlinearSystemBase::addNodalKernel(), FEProblemBase::addNodalKernel(), MooseObjectWarehouseBase< Indicator >::addObject(), FEProblemBase::addObjectParamsHelper(), FEProblemBase::addOutput(), JsonSyntaxTree::addParameters(), Action::addRelationshipManager(), FEProblemBase::addScalarKernel(), FEProblemBase::addTransfer(), FEProblemBase::addUserObject(), MooseServer::addValuesToList(), AuxiliarySystem::addVariable(), AddVariableAction::addVariable(), SystemBase::addVariable(), FEProblemBase::addVariable(), FVFluxKernel::adjustRMGhostLayers(), assemble_l2(), Moose::assemble_matrix(), AuxKernelTempl< Real >::AuxKernelTempl(), AuxScalarKernel::AuxScalarKernel(), BoundsBase::BoundsBase(), Moose::Builder::buildFullTree(), Moose::Builder::buildJsonSyntaxTree(), PostprocessorInterface::checkParam(), Moose::SlepcSupport::clearFreeNonlinearPowerIterations(), Moose::compute_bounds(), Moose::compute_jacobian(), Moose::compute_nearnullspace(), Moose::compute_nullspace(), Moose::compute_postcheck(), Moose::compute_transpose_nullspace(), MooseBaseParameterInterface::connectControllableParams(), Coupleable::coupledMatrixTagValue(), Coupleable::coupledMatrixTagValues(), PostprocessorInterface::coupledPostprocessors(), Coupleable::coupledVectorTagArrayGradient(), Coupleable::coupledVectorTagArrayGradients(), Coupleable::coupledVectorTagArrayValues(), Coupleable::coupledVectorTagDofValues(), Coupleable::coupledVectorTagGradient(), Coupleable::coupledVectorTagGradients(), Coupleable::coupledVectorTagValues(), ActionFactory::create(), AddVariableAction::createInitialConditionAction(), AppFactory::createShared(), MaterialBase::declareADProperty(), MaterialBase::declareProperty(), Postprocessor::declareValue(), FunctorInterface::deduceFunctorName(), AddVariableAction::feType(), FileRangeBuilder::FileRangeBuilder(), FVAdvection::FVAdvection(), FVAnisotropicDiffusion::FVAnisotropicDiffusion(), FVDiffusion::FVDiffusion(), GapValueAux::GapValueAux(), ParsedSubdomainMeshGenerator::generate(), MooseServer::getActionParameters(), MooseApp::getCheckpointDirectories(), DistributionInterface::getDistribution(), ElementIDInterface::getElementID(), ElementIDInterface::getElementIDByName(), ElementIDInterface::getElementIDIndex(), ElementIDInterface::getElementIDNeighbor(), ElementIDInterface::getElementIDNeighborByName(), FunctionInterface::getFunction(), MaterialBase::getGenericZeroMaterialProperty(), MooseServer::getHoverDisplayText(), MaterialPropertyInterface::getMaterial(), MaterialPropertyInterface::getMaterialDataType(), MaterialPropertyInterface::getMaterialPropertyName(), MooseServer::getObjectParameters(), MooseBaseParameterInterface::getParam(), getParamHelper(), PostprocessorInterface::getPostprocessorNameInternal(), ReporterInterface::getReporterName(), Reporter::getReporterValueName(), SamplerInterface::getSampler(), AddVariableAction::getSubdomainIDs(), CommonOutputAction::hasConsole(), MeshGeneratorSystem::hasDataDrivenAllowed(), FunctionInterface::hasFunction(), MeshGenerator::hasGenerateData(), ImageSampler::ImageSampler(), AddVariableAction::init(), FullSolveMultiApp::initialSetup(), FEProblemBase::initNullSpaceVectors(), isValid(), IterationAdaptiveDT::IterationAdaptiveDT(), LayeredBase::LayeredBase(), SetupMeshAction::modifyParamsForUseSplit(), MooseApp::MooseApp(), MooseVariableInterface< Real >::MooseVariableInterface(), NodeFaceConstraint::NodeFaceConstraint(), operator=(), OrientedBoxInterface::OrientedBoxInterface(), OutputInterface::OutputInterface(), ConsoleUtils::outputLegacyInformation(), ParsedMaterialBase::ParsedMaterialBase(), PenetrationAux::PenetrationAux(), ProjectedStatefulMaterialStorageAction::ProjectedStatefulMaterialStorageAction(), ReferenceResidualProblem::ReferenceResidualProblem(), InputParameterWarehouse::removeInputParameters(), OutputWarehouse::resetFileBase(), Moose::SlepcSupport::setEigenProblemSolverParams(), Moose::SlepcSupport::setNewtonPetscOptions(), MooseMesh::setPartitioner(), FVKernel::setRMParams(), Moose::SlepcSupport::setSlepcEigenSolverTolerances(), CreateExecutionerAction::setupAutoPreconditioning(), ReadExecutorParamsAction::setupAutoPreconditioning(), MeshBaseImageSampler::setupImageSampler(), ImageSampler::setupImageSampler(), SideSetsFromBoundingBoxGenerator::SideSetsFromBoundingBoxGenerator(), Reporter::store(), Moose::PetscSupport::storePetscOptions(), Moose::SlepcSupport::storeSolveType(), DumpObjectsProblem::stringifyParameters(), TaggingInterface::TaggingInterface(), transferParam(), MooseBaseParameterInterface::uniqueName(), MooseBaseParameterInterface::uniqueParameterName(), FVFunctorDirichletBCTempl< is_ad >::validParams(), ElemSideNeighborLayersGeomTester::validParams(), ElemSideNeighborLayersTester::validParams(), ProjectionAux::validParams(), FunctorElementalGradientAuxTempl< is_ad >::validParams(), NearestRadiusLayeredAverage::validParams(), DistributedRectilinearMeshGenerator::validParams(), FVKernel::validParams(), MortarConsumerInterface::validParams(), MortarConstraintBase::validParams(), FVInterfaceKernel::validParams(), Coupleable::vectorTagDofValueHelper(), Coupleable::vectorTagValueHelper(), MeshBaseImageSampler::vtkFlip(), MeshBaseImageSampler::vtkShiftAndScale(), ImageSampler::vtkShiftAndScale(), MeshBaseImageSampler::vtkThreshold(), ImageSampler::vtkThreshold(), and Moose::Builder::walkRaw().
const T & InputParameters::get | ( | std::string_view | name | ) | const |
A wrapper around the Parameters
base class method.
Checks for parameter rename before calling the base class method
name | The name to query the parameter values map with |
Definition at line 1905 of file InputParameters.h.
std::map< std::string, std::pair< std::string, std::string > > InputParameters::getAutoBuildVectors | ( | ) | const |
Returns the auto build vectors for all parameters.
Definition at line 686 of file InputParameters.C.
const std::vector< std::tuple< std::string, Moose::RelationshipManagerType, Moose::RelationshipManagerInputParameterCallback > > & InputParameters::getBuildableRelationshipManagerTypes | ( | ) | const |
Returns the list of buildable (or required) RelationshipManager object types for this object.
Definition at line 504 of file InputParameters.C.
Referenced by Action::addRelationshipManagers().
const std::vector< std::string > & InputParameters::getBuildableTypes | ( | ) | const |
Returns the list of buildable types as a std::vector<std::string>
Definition at line 496 of file InputParameters.C.
Referenced by Moose::Builder::buildFullTree(), and Moose::Builder::buildJsonSyntaxTree().
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 1394 of file InputParameters.h.
Referenced by Coupleable::Coupleable(), Postprocessor::declareValue(), MooseBaseParameterInterface::getCheckedPointerParam(), ElementIDInterface::getElementID(), ElementIDInterface::getElementIDByName(), ElementIDInterface::getElementIDNeighbor(), ElementIDInterface::getElementIDNeighborByName(), MooseVariableInterface< Real >::MooseVariableInterface(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), ScalarCoupleable::ScalarCoupleable(), and TaggingInterface::TaggingInterface().
std::string InputParameters::getClassDescription | ( | ) | const |
Returns the class description.
Definition at line 133 of file InputParameters.C.
Referenced by JsonSyntaxTree::addParameters(), MooseServer::addValuesToList(), and MooseServer::getHoverDisplayText().
InputParameters::CommandLineMetadata::ArgumentType InputParameters::getCommandLineArgumentType | ( | const std::string & | name | ) | const |
name
Definition at line 811 of file InputParameters.C.
|
private |
name
. Definition at line 1260 of file InputParameters.C.
Referenced by getCommandLineArgumentType(), and getCommandLineSyntax().
const std::vector< std::string > & InputParameters::getCommandLineSyntax | ( | const std::string & | name | ) | const |
name
Definition at line 805 of file InputParameters.C.
Referenced by MooseApp::copyInputs(), and MooseApp::showInputs().
const std::set< ExecFlagType > & InputParameters::getControllableExecuteOnTypes | ( | const std::string & | name | ) | const |
Return the allowed execute flags for a controllable parameter.
Definition at line 450 of file InputParameters.C.
std::set< std::string > InputParameters::getControllableParameters | ( | ) | const |
Return list of controllable parameters.
Definition at line 1298 of file InputParameters.C.
Referenced by checkParams(), and get().
|
inline |
Return the coupled variable parameter names.
Definition at line 648 of file InputParameters.h.
const std::string & InputParameters::getDescription | ( | const std::string & | name | ) | const |
Get the documentation string for a parameter.
Definition at line 985 of file InputParameters.C.
Referenced by transferParam().
std::string InputParameters::getDocString | ( | const std::string & | name | ) | const |
Returns the documentation string for the specified parameter name.
Definition at line 320 of file InputParameters.C.
Referenced by applyCoupledVar(), checkParams(), and MooseServer::getHoverDisplayText().
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 817 of file InputParameters.C.
std::set< std::string > InputParameters::getGroupParameters | ( | const std::string & | group | ) | const |
Return names of parameters within a group.
Definition at line 1279 of file InputParameters.C.
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 712 of file InputParameters.C.
Referenced by MooseObjectWarehouseBase< Indicator >::addObject(), BlockRestrictable::initializeBlockRestrictable(), isValid(), and varName().
|
inline |
Return the new to deprecated variable name map.
Definition at line 653 of file InputParameters.h.
std::set< std::string > InputParameters::getParametersList | ( | ) | const |
Definition at line 1289 of file InputParameters.C.
Referenced by MooseServer::gatherDocumentCompletionItems(), and MooseServer::getHoverDisplayText().
|
static |
Definition at line 1817 of file InputParameters.h.
Referenced by MooseBaseParameterInterface::getParam(), MooseApp::getParam(), MooseBaseParameterInterface::getRenamedParam(), and MooseApp::getRenamedParam().
const MooseEnum& InputParameters::getParamHelper | ( | const std::string & | name_in, |
const InputParameters & | pars, | ||
const MooseEnum * | , | ||
const MooseObject * | |||
) |
Definition at line 1213 of file InputParameters.C.
const MultiMooseEnum& InputParameters::getParamHelper | ( | const std::string & | name_in, |
const InputParameters & | pars, | ||
const MultiMooseEnum * | , | ||
const MooseObject * | |||
) |
Definition at line 1224 of file InputParameters.C.
const MooseEnum& InputParameters::getParamHelper | ( | const std::string & | name, |
const InputParameters & | pars, | ||
const MooseEnum * | , | ||
const MooseObject * | moose_object | ||
) |
const MultiMooseEnum& InputParameters::getParamHelper | ( | const std::string & | name, |
const InputParameters & | pars, | ||
const MultiMooseEnum * | , | ||
const MooseObject * | moose_object | ||
) |
const std::string & InputParameters::getSystemAttributeName | ( | ) | const |
Get the system attribute name if it was registered.
Otherwise throw an error. See the AttribSystem object for use Attribute.h/C.
Definition at line 471 of file InputParameters.C.
Referenced by AttribSystem::initFrom().
std::vector< std::string > InputParameters::getVecMooseType | ( | const std::string & | name | ) | const |
Definition at line 740 of file InputParameters.C.
Referenced by MooseObjectWarehouseBase< Indicator >::addObject(), Coupleable::Coupleable(), isValid(), ScalarCoupleable::ScalarCoupleable(), and varName().
bool InputParameters::hasCoupledValue | ( | const std::string & | coupling_name | ) | const |
Return whether or not the coupled variable exists.
coupling_name | The name of the coupled variable to test for |
Definition at line 637 of file InputParameters.C.
Referenced by applyCoupledVar(), Coupleable::isCoupled(), ScalarCoupleable::isCoupledScalar(), and transferParam().
bool InputParameters::hasDefault | ( | const std::string & | param_name | ) | const |
Return whether a parameter has a default.
Definition at line 622 of file InputParameters.C.
Referenced by transferParam().
bool InputParameters::hasDefaultCoupledValue | ( | const std::string & | coupling_name | ) | const |
Return whether or not the requested parameter has a default coupled value.
coupling_name | The name of the coupling parameter to get the default value for. |
Definition at line 643 of file InputParameters.C.
Referenced by applyCoupledVar(), Coupleable::coupledComponents(), FunctionMaterialBase< is_ad >::FunctionMaterialBase(), hasDefault(), Coupleable::isCoupledConstant(), and transferParam().
bool InputParameters::have_parameter | ( | std::string_view | name | ) | const |
A wrapper around the Parameters
base class method.
Checks for parameter rename before calling the base class method
name | The name to query the parameter values map with |
Definition at line 1914 of file InputParameters.h.
Referenced by ActionWarehouse::addActionBlock(), FEProblemBase::addAuxKernel(), FEProblemBase::addAuxScalarKernel(), FEProblemBase::addBoundaryCondition(), FEProblemBase::addConstraint(), FEProblemBase::addDGKernel(), FEProblemBase::addDiracKernel(), FunctorMaterial::addFunctorPropertyByBlocks(), FEProblemBase::addIndicator(), FEProblemBase::addInterfaceKernel(), MooseEigenSystem::addKernel(), FEProblemBase::addKernel(), FEProblemBase::addMarker(), FEProblemBase::addMaterialHelper(), FEProblemBase::addMultiApp(), FEProblemBase::addNodalKernel(), FEProblemBase::addObjectParamsHelper(), FEProblemBase::addScalarKernel(), FEProblemBase::addTransfer(), MooseServer::addValuesToList(), Moose::Builder::buildFullTree(), Moose::Builder::buildJsonSyntaxTree(), Coupleable::checkVar(), MaterialBase::declareADProperty(), MaterialBase::declareProperty(), FunctorInterface::deduceFunctorName(), MooseServer::getActionParameters(), MooseServer::getCompletionItemKind(), MaterialBase::getGenericZeroMaterialProperty(), MooseServer::getHoverDisplayText(), MaterialPropertyInterface::getMaterialPropertyName(), MooseServer::getObjectParameters(), getVecMooseType(), AdvancedOutput::initExecutionTypes(), AttribDisplaced::initFrom(), isParamValid(), MooseApp::MooseApp(), OutputOnWarehouse::OutputOnWarehouse(), DumpObjectsProblem::stringifyParameters(), transferParam(), BlockRestrictable::validParams(), and Moose::Builder::walkRaw().
void InputParameters::ignoreParameter | ( | const std::string & | name | ) |
Informs this object that values for this parameter set from the input file or from the command line should be ignored.
Definition at line 1665 of file InputParameters.h.
Referenced by AddElementalFieldAction::validParams().
|
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 867 of file InputParameters.h.
Referenced by checkParams(), errorPrefix(), and MooseBaseParameterInterface::paramErrorMsg().
|
inline |
Definition at line 871 of file InputParameters.h.
bool InputParameters::isCommandLineParameter | ( | const std::string & | name | ) | const |
name
is a command line parameter Definition at line 799 of file InputParameters.C.
bool InputParameters::isControllable | ( | const std::string & | name | ) | const |
Returns a Boolean indicating whether the specified parameter is controllable.
Definition at line 443 of file InputParameters.C.
Referenced by transferParam().
bool InputParameters::isParamDeprecated | ( | const std::string & | name | ) | const |
Returns True if the parameters is deprecated.
Definition at line 398 of file InputParameters.C.
bool InputParameters::isParamRequired | ( | const std::string & | name | ) | const |
Returns a boolean indicating whether the specified parameter is required or not.
Definition at line 352 of file InputParameters.C.
Referenced by areAllRequiredParamsValid(), checkParams(), MooseServer::getCompletionItemKind(), and transferParam().
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 391 of file InputParameters.C.
Referenced by MultiApp::createApp(), hasDefault(), MooseApp::MooseApp(), PicardSolve::PicardSolve(), and Transient::Transient().
bool InputParameters::isParamSetByUser | ( | const std::string & | name | ) | const |
Method returns true if the parameter was by the user.
name | The parameter name |
Definition at line 971 of file InputParameters.C.
Referenced by CreateProblemAction::act(), MeshOnlyAction::act(), SetupMeshAction::act(), SystemBase::addVariable(), ADVectorFunctionDirichletBC::ADVectorFunctionDirichletBC(), AnnularMesh::AnnularMesh(), AnnularMeshGenerator::AnnularMeshGenerator(), BreakMeshByBlockGeneratorBase::BreakMeshByBlockGeneratorBase(), PiecewiseTabularBase::buildFromFile(), PNGOutput::calculateRescalingValues(), Console::Console(), Executor::Executor(), Exodus::Exodus(), FEProblemBase::FEProblemBase(), FEProblemSolve::FEProblemSolve(), FileMeshGenerator::generate(), AddVariableAction::init(), Console::initialSetup(), InterfaceDiffusiveFluxIntegralTempl< is_ad >::InterfaceDiffusiveFluxIntegralTempl(), InterfaceIntegralVariableValuePostprocessor::InterfaceIntegralVariableValuePostprocessor(), InterfaceKernelTempl< T >::InterfaceKernelTempl(), MooseBaseParameterInterface::isParamSetByUser(), MooseApp::isParamSetByUser(), MultiApp::keepSolutionDuringRestore(), LayeredBase::LayeredBase(), LibtorchNeuralNetControl::LibtorchNeuralNetControl(), MultiApp::MultiApp(), MultiAppGeneralFieldUserObjectTransfer::MultiAppGeneralFieldUserObjectTransfer(), MultiAppTransfer::MultiAppTransfer(), MultiAppVariableValueSamplePostprocessorTransfer::MultiAppVariableValueSamplePostprocessorTransfer(), NearestPointBase< LayeredSideDiffusiveFluxAverage, SideIntegralVariableUserObject >::NearestPointBase(), paramSetByUser(), PatchMeshGenerator::PatchMeshGenerator(), MooseMesh::prepare(), PropertyReadFile::PropertyReadFile(), RandomIC::RandomIC(), MooseMesh::setCoordSystem(), Transient::setupTimeIntegrator(), SideSetsFromBoundingBoxGenerator::SideSetsFromBoundingBoxGenerator(), Transfer::Transfer(), Transient::Transient(), VectorBodyForce::VectorBodyForce(), VectorFunctionDirichletBC::VectorFunctionDirichletBC(), VectorFunctionIC::VectorFunctionIC(), and VectorMagnitudeFunctorMaterialTempl< is_ad >::VectorMagnitudeFunctorMaterialTempl().
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 368 of file InputParameters.C.
Referenced by ElementIDOutputAction::act(), ReadExecutorParamsAction::act(), CreateExecutionerAction::act(), CreateProblemDefaultAction::act(), MeshOnlyAction::act(), SetupMeshAction::act(), AddVariableAction::act(), AddPeriodicBCAction::act(), MaterialOutputAction::act(), FEProblemBase::addConstraint(), FEProblemBase::addDamper(), FunctorMaterial::addFunctorPropertyByBlocks(), FEProblem::addLineSearch(), MooseObjectWarehouseBase< Indicator >::addObject(), FEProblemBase::addObjectParamsHelper(), JsonSyntaxTree::addParameters(), FEProblemBase::addTransfer(), AddVariableAction::addVariable(), ADInterfaceKernelTempl< T >::ADInterfaceKernelTempl(), ADPiecewiseLinearInterpolationMaterial::ADPiecewiseLinearInterpolationMaterial(), applyParameter(), areAllRequiredParamsValid(), UserObjectInterface::castUserObject(), PostprocessorInterface::checkParam(), checkParams(), Coupleable::coupledMatrixTagValue(), Coupleable::coupledMatrixTagValues(), Coupleable::coupledVectorTagArrayGradient(), Coupleable::coupledVectorTagArrayGradients(), Coupleable::coupledVectorTagArrayValues(), Coupleable::coupledVectorTagDofValues(), Coupleable::coupledVectorTagGradient(), Coupleable::coupledVectorTagGradients(), Coupleable::coupledVectorTagValues(), AppFactory::createShared(), FunctorInterface::deduceFunctorName(), FileRangeBuilder::FileRangeBuilder(), GapValueAux::GapValueAux(), MooseServer::getCompletionItemKind(), MaterialPropertyInterface::getMaterialDataType(), MaterialPropertyInterface::getMaterialPropertyName(), getParamHelper(), ReporterInterface::getReporterName(), Reporter::getReporterValueName(), GhostingUserObject::GhostingUserObject(), hasDefault(), InterfaceKernelTempl< T >::InterfaceKernelTempl(), isParamSetByUser(), MooseBaseParameterInterface::isParamValid(), MooseApp::isParamValid(), isValid(), LayeredBase::LayeredBase(), LayeredSideIntegralBase< SideIntegralVariableUserObject >::LayeredSideIntegralBase(), MaterialVectorPostprocessor::MaterialVectorPostprocessor(), MultiApp::MultiApp(), NodeFaceConstraint::NodeFaceConstraint(), ParsedMaterialBase::ParsedMaterialBase(), PenetrationAux::PenetrationAux(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseLinearInterpolationMaterial::PiecewiseLinearInterpolationMaterial(), ReporterInterface::possiblyCheckHasReporter(), PseudoTimestep::PseudoTimestep(), rangeCheck(), ReferenceResidualProblem::ReferenceResidualProblem(), RenameBoundaryGenerator::RenameBoundaryGenerator(), MooseMesh::setPartitioner(), MeshBaseImageSampler::setupImageSampler(), ImageSampler::setupImageSampler(), SetupMeshAction::setupMesh(), Moose::PetscSupport::storePetscOptions(), Moose::SlepcSupport::storeSolveType(), DumpObjectsProblem::stringifyParameters(), BoundaryRestrictableRequired::validParams(), BoundaryRestrictable::validParams(), Coupleable::vectorTagDofValueHelper(), Coupleable::vectorTagValueHelper(), MeshBaseImageSampler::vtkMagnitude(), ImageSampler::vtkMagnitude(), MeshBaseImageSampler::vtkThreshold(), and ImageSampler::vtkThreshold().
bool InputParameters::isPrivate | ( | const std::string & | name | ) | const |
Returns a Boolean indicating whether the specified parameter is private or not.
Definition at line 414 of file InputParameters.C.
Referenced by applyParameter(), checkParams(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), DumpObjectsProblem::stringifyParameters(), and transferParam().
bool InputParameters::isRangeChecked | ( | const std::string & | param_name | ) | const |
Return whether a parameter has a range check.
Definition at line 608 of file InputParameters.C.
Referenced by transferParam().
bool InputParameters::isType | ( | const std::string & | name | ) | const |
name
is of type T. Definition at line 1894 of file InputParameters.h.
Referenced by PostprocessorInterface::checkParam(), PostprocessorInterface::coupledPostprocessors(), MeshGenerator::getMeshGeneratorNameFromParam(), MeshGenerator::getMeshGeneratorNamesFromParam(), PostprocessorInterface::getPostprocessorNameInternal(), ReporterInterface::getReporterName(), and Reporter::getReporterValueName().
void InputParameters::makeParamNotRequired | ( | const std::string & | name | ) |
Changes the parameter to not be required.
name | The parameter name |
Definition at line 1686 of file InputParameters.h.
Referenced by MooseServer::getObjectParameters(), and MortarConstraintBase::validParams().
void InputParameters::makeParamNotRequired | ( | const std::string & | name | ) |
Forces parameter of given name to be not required regardless of type.
Definition at line 359 of file InputParameters.C.
void InputParameters::makeParamRequired | ( | const std::string & | name | ) |
Changes the parameter to be required.
name | The parameter name |
Definition at line 1674 of file InputParameters.h.
void InputParameters::markControlled | ( | const std::string & | name | ) |
void InputParameters::mooseObjectSyntaxVisibility | ( | bool | visibility | ) |
Mutators for controlling whether or not the outermost level of syntax will be collapsed when printed.
Definition at line 522 of file InputParameters.C.
Referenced by Moose::Builder::buildFullTree(), and Moose::Builder::buildJsonSyntaxTree().
bool InputParameters::mooseObjectSyntaxVisibility | ( | ) | const |
Definition at line 528 of file InputParameters.C.
unsigned int InputParameters::numberDefaultCoupledValues | ( | const std::string & | coupling_name | ) | const |
Get the number of defaulted coupled value entries.
coupling_name | The name of the coupling parameter to get the default value for. |
Definition at line 675 of file InputParameters.C.
Referenced by applyCoupledVar(), Coupleable::Coupleable(), Coupleable::coupledComponents(), Coupleable::getADDefaultVectorValue(), Coupleable::getDefaultArrayValue(), Coupleable::getDefaultValue(), and transferParam().
InputParameters & InputParameters::operator+= | ( | const InputParameters & | rhs | ) |
Definition at line 176 of file InputParameters.C.
InputParameters & InputParameters::operator= | ( | const InputParameters & | rhs | ) |
Definition at line 139 of file InputParameters.C.
std::vector< std::string > InputParameters::paramAliases | ( | const std::string & | param_name | ) | const |
Return all the aliased names associated with param_name
.
The returned container will always contain param_name
itself. Other aliases in addition to param_name
will include the base class parameter name if param_name
is the derived class parameter name, or deprecated names that param_name
is meant to replace.
param_name | The name of the parameter that we want to lookup aliases for. This parameter name must exist in our metadata and parameter names to values map, e.g. this parameter must represent the derived class parameter name if a base class parameter has been renamed or the blessed parameter name in situations where associated parameter names have been deprecated |
param_name
, including param_name
itself Definition at line 1441 of file InputParameters.C.
|
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 879 of file InputParameters.h.
Referenced by checkParams(), and errorPrefix().
|
inline |
Definition at line 883 of file InputParameters.h.
bool InputParameters::paramSetByUser | ( | const std::string & | name | ) | const |
Deprecated method.
Use isParamSetByUser() instead.
Definition at line 964 of file InputParameters.C.
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.
Definition at line 1352 of file InputParameters.h.
Referenced by Moose::Builder::setScalarValueTypeParameter().
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 1239 of file InputParameters.h.
std::string InputParameters::rangeCheckedFunction | ( | const std::string & | name | ) | const |
Return the range check function for any parameter (empty string if it is not range checked)
Definition at line 615 of file InputParameters.C.
Referenced by transferParam().
|
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 893 of file InputParameters.h.
Referenced by Moose::Builder::setFilePathParam(), and Moose::Builder::setVectorFilePathParam().
|
inline |
Definition at line 894 of file InputParameters.h.
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 457 of file InputParameters.C.
Referenced by Kernel::validParams(), VectorKernel::validParams(), LineSearch::validParams(), ArrayKernel::validParams(), BoundsBase::validParams(), Distribution::validParams(), Times::validParams(), Positions::validParams(), Problem::validParams(), ScalarKernelBase::validParams(), Constraint::validParams(), ADInterfaceKernelTempl< T >::validParams(), LayeredExtremumMaterialProperty::validParams(), MoosePartitioner::validParams(), TimeStepper::validParams(), NearestPointIntegralVariablePostprocessor::validParams(), EigenKernel::validParams(), Postprocessor::validParams(), Split::validParams(), RelationshipManager::validParams(), Damper::validParams(), Predictor::validParams(), FVKernel::validParams(), NodalKernelBase::validParams(), BoundaryCondition::validParams(), DiracKernelTempl< T >::validParams(), VectorPostprocessor::validParams(), Indicator::validParams(), InterfaceKernelTempl< T >::validParams(), MoosePreconditioner::validParams(), TimeIntegrator::validParams(), AuxScalarKernel::validParams(), MooseVariableBase::validParams(), MeshDivision::validParams(), DGKernelBase::validParams(), MeshGenerator::validParams(), Control::validParams(), Marker::validParams(), Action::validParams(), ScalarInitialCondition::validParams(), FVInitialConditionBase::validParams(), Reporter::validParams(), Executioner::validParams(), Function::validParams(), Output::validParams(), UserObject::validParams(), Sampler::validParams(), InitialConditionBase::validParams(), FVBoundaryCondition::validParams(), FVInterfaceKernel::validParams(), AuxKernelTempl< Real >::validParams(), MultiApp::validParams(), and Executor::validParams().
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 480 of file InputParameters.C.
void InputParameters::registerSystemAttributeName | ( | const std::string & | value | ) |
This method is used to define the MOOSE system name that is used by the TheWarehouse object for storing objects to be retrieved for execution.
The base class of every object class that will be called for execution (e.g., UserObject objects) should call this method.
This is different from registerBase because the name supplied to registerBase is used to associate syntax, but the objects created often go to the same objects for execution, as is the case for Postprocessor object which are executed with UserObjects.
See the AttribSystem object for use Attribute.h/C.
Definition at line 464 of file InputParameters.C.
Referenced by Distribution::validParams(), FVDirichletBCBase::validParams(), TimeStepper::validParams(), FVFluxBC::validParams(), FVElementalKernel::validParams(), FVFluxKernel::validParams(), UserObject::validParams(), Sampler::validParams(), and FVInterfaceKernel::validParams().
void InputParameters::renameCoupledVar | ( | const std::string & | old_name, |
const std::string & | new_name, | ||
const std::string & | new_docstring | ||
) |
Rename a coupled variable and provide a new documentation string.
old_name | The old name of the coupled variable |
new_name | The new name of the coupled variable |
new_docstring | The new documentation string for the coupled variable |
Definition at line 1408 of file InputParameters.C.
Referenced by ADPenaltyPeriodicSegmentalConstraint::validParams(), ADPeriodicSegmentalConstraint::validParams(), PeriodicSegmentalConstraint::validParams(), PenaltyPeriodicSegmentalConstraint::validParams(), and ScalarLMKernelTempl< is_ad >::validParams().
|
private |
Definition at line 1382 of file InputParameters.C.
Referenced by deprecateCoupledVar(), and renameCoupledVar().
void InputParameters::renameParam | ( | const std::string & | old_name, |
const std::string & | new_name, | ||
const std::string & | new_docstring | ||
) |
Rename a parameter and provide a new documentation string.
old_name | The old name of the parameter |
new_name | The new name of the parameter |
new_docstring | The new documentation string for the parameter If left empty, uses the old docstring for the renamed parameter |
Definition at line 1400 of file InputParameters.C.
Referenced by MassMatrix::validParams().
|
private |
Definition at line 1348 of file InputParameters.C.
Referenced by deprecateParam(), renameCoupledVarInternal(), and renameParam().
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 1242 of file InputParameters.C.
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
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 1210 of file InputParameters.h.
Referenced by AB2PredictorCorrector::AB2PredictorCorrector(), ElementIDOutputAction::act(), AddFVICAction::act(), AddICAction::act(), PartitionerAction::act(), CreateExecutionerAction::act(), CreateProblemAction::act(), AdaptivityAction::act(), SetupDebugAction::act(), AddTimeStepperAction::act(), SetupPredictorAction::act(), SetupTimeStepperAction::act(), SetupResidualDebugAction::act(), AddAuxKernelAction::act(), MaterialDerivativeTestAction::act(), SetAdaptivityOptionsAction::act(), CreateDisplacedProblemAction::act(), DisplayGhostingAction::act(), AddPeriodicBCAction::act(), MaterialOutputAction::act(), AddNodalNormalsAction::act(), FEProblemBase::addAnyRedistributers(), FEProblemBase::addAuxArrayVariable(), FEProblemBase::addAuxKernel(), FEProblemBase::addAuxScalarKernel(), FEProblemBase::addAuxScalarVariable(), FEProblemBase::addAuxVariable(), FEProblemBase::addBoundaryCondition(), FEProblemBase::addConstraint(), FEProblemBase::addDamper(), FEProblemBase::addDGKernel(), FEProblemBase::addDiracKernel(), FEProblemBase::addDistribution(), DiffusionCG::addFEBCs(), DiffusionCG::addFEKernels(), FEProblemBase::addFunction(), FEProblemBase::addFunctorMaterial(), DiffusionFV::addFVBCs(), FEProblemBase::addFVInitialCondition(), DiffusionFV::addFVKernels(), FEProblemBase::addIndicator(), FEProblemBase::addInitialCondition(), FEProblemBase::addInterfaceKernel(), MooseEigenSystem::addKernel(), FEProblemBase::addKernel(), FEProblem::addLineSearch(), FEProblemBase::addMarker(), FEProblemBase::addMaterialHelper(), FEProblemBase::addMeshDivision(), MeshGenerator::addMeshSubgenerator(), FEProblemBase::addMultiApp(), FEProblemBase::addNodalKernel(), DiffusionCG::addNonlinearVariables(), FEProblemBase::addObjectParamsHelper(), FEProblemBase::addOutput(), FEProblemBase::addPredictor(), CreateDisplacedProblemAction::addProxyRelationshipManagers(), Action::addRelationshipManager(), FEProblemBase::addScalarKernel(), AuxiliarySystem::addTimeIntegrator(), NonlinearSystemBase::addTimeIntegrator(), FEProblemBase::addTimeIntegrator(), FEProblemBase::addTransfer(), SystemBase::addVariable(), FEProblemBase::addVariable(), FVFluxKernel::adjustRMGhostLayers(), MeshGeneratorSystem::appendMeshGenerator(), AStableDirk4::AStableDirk4(), ActionWarehouse::buildBuildableActions(), MooseObjectUnitTest::buildObjects(), OversampleOutput::cloneMesh(), CommonOutputAction::create(), Factory::create(), MultiApp::createApp(), AppFactory::createAppShared(), AddVariableAction::createInitialConditionAction(), MooseApp::createMinimalApp(), AppFactory::createShared(), ExtraIDIntegralReporter::ExtraIDIntegralReporter(), FEProblemBase::getFunction(), MaterialOutputAction::getParams(), Moose::SlepcSupport::getSlepcValidParams(), AddElementalFieldAction::init(), SetupMeshAction::modifyParamsForUseSplit(), NearestPointBase< LayeredSideDiffusiveFluxAverage, SideIntegralVariableUserObject >::NearestPointBase(), MooseServer::parseDocumentForDiagnostics(), GlobalParamsAction::setDoubleIndexParam(), MeshGenerator::setHasGenerateData(), FEProblem::setInputParametersFEProblem(), FEProblemBase::setInputParametersFEProblem(), GlobalParamsAction::setParam(), FVKernel::setRMParams(), GlobalParamsAction::setScalarParam(), GlobalParamsAction::setTripleIndexParam(), ReadExecutorParamsAction::setupAutoPreconditioning(), CreateExecutionerAction::setupAutoPreconditioning(), MooseApp::setupOptions(), GlobalParamsAction::setVectorParam(), SideSetExtruderGenerator::SideSetExtruderGenerator(), FVOneVarDiffusionInterface::validParams(), AddFVICAction::validParams(), AddICAction::validParams(), InversePowerMethod::validParams(), NonlinearEigen::validParams(), ExternalProblem::validParams(), FVFunctorTimeKernel::validParams(), FVTimeKernel::validParams(), ADScalarTimeKernel::validParams(), GenericConstant2DArray::validParams(), GenericConstantArray::validParams(), DiscreteElementUserObject::validParams(), GenericConstantVectorMaterialTempl< is_ad >::validParams(), NodalPatchRecoveryBase::validParams(), JSONOutput::validParams(), GapValueAux::validParams(), PenetrationAux::validParams(), ElementQualityChecker::validParams(), ElementSubdomainModifier::validParams(), CSVReaderVectorPostprocessor::validParams(), NodalSum::validParams(), FVFunctorDirichletBCTempl< is_ad >::validParams(), ProjectionAux::validParams(), WeightedGapAux::validParams(), ElemSideNeighborLayersGeomTester::validParams(), MassMatrix::validParams(), TimeIntervalTimes::validParams(), ElemSideNeighborLayersTester::validParams(), JSONFileReader::validParams(), EigenDirichletBC::validParams(), PerfGraphOutput::validParams(), ReporterDebugOutput::validParams(), VTKOutput::validParams(), ExodusFileTimes::validParams(), SimulationTimes::validParams(), FilePositions::validParams(), InputPositions::validParams(), MultiAppPositions::validParams(), ODETimeKernel::validParams(), TransformedPositions::validParams(), PiecewiseConstantFromCSV::validParams(), ProjectedStatefulMaterialNodalPatchRecoveryBase::validParams(), ReporterPositions::validParams(), AccumulateReporter::validParams(), FVAnisotropicDiffusion::validParams(), CSVFileTimes::validParams(), InputTimes::validParams(), FVMassMatrix::validParams(), GhostEverything::validParams(), GhostHigherDLowerDPointNeighbors::validParams(), GhostLowerDElems::validParams(), GhostingAux::validParams(), ArrayTimeKernel::validParams(), TimeKernel::validParams(), AddAuxKernelAction::validParams(), VectorTimeKernel::validParams(), ReporterTimes::validParams(), MessageFromInput::validParams(), MeshGeneratorMesh::validParams(), PseudoTimestep::validParams(), Console::validParams(), ConvectiveFluxBC::validParams(), ControlOutput::validParams(), Positions::validParams(), CoupledTiedValueConstraint::validParams(), NodalNormalsEvaluator::validParams(), EqualValueEmbeddedConstraint::validParams(), DistributedPositions::validParams(), ElementCentroidPositions::validParams(), TiedValueConstraint::validParams(), FunctorPositions::validParams(), ADTimeKernelTempl< T >::validParams(), VectorMagnitudeFunctorMaterialTempl< is_ad >::validParams(), NearestNodeDistanceAux::validParams(), NodalL2Norm::validParams(), GenericConstantRankTwoTensorTempl< is_ad >::validParams(), ADTimeKernelValueTempl< T >::validParams(), FunctorElementalGradientAuxTempl< is_ad >::validParams(), FunctorTimes::validParams(), ElementGroupCentroidPositions::validParams(), InterfaceTimeKernel::validParams(), ADTimeKernelGradTempl< T >::validParams(), NodalNormalBC::validParams(), EigenArrayDirichletBC::validParams(), LeastSquaresFitHistory::validParams(), BlockWeightedPartitioner::validParams(), DOFMapOutput::validParams(), GenericFunctorMaterialTempl< is_ad >::validParams(), GenericVectorFunctorMaterialTempl< is_ad >::validParams(), PerfGraphReporter::validParams(), GenericFunctorGradientMaterialTempl< is_ad >::validParams(), MultiAppGeneralFieldUserObjectTransfer::validParams(), NearestNodeValueAux::validParams(), VectorOfPostprocessors::validParams(), ReporterPointSource::validParams(), ElementUOAux::validParams(), AddOutputAction::validParams(), IntegratedBCBase::validParams(), TagAuxBase< AuxKernel >::validParams(), InterfaceQpUserObjectBase::validParams(), TimeNodalKernel::validParams(), NearestPointAverage::validParams(), MultiAppGeneralFieldNearestLocationTransfer::validParams(), MortarNodalAuxKernelTempl< ComputeValueType >::validParams(), MaterialPropertyDebugOutput::validParams(), ElementVariablesDifferenceMax::validParams(), GenericConstantMaterialTempl< is_ad >::validParams(), FVDiffusion::validParams(), Exodus::validParams(), VariableResidualNormsDebugOutput::validParams(), Postprocessor::validParams(), SinDirichletBC::validParams(), DistributedRectilinearMeshGenerator::validParams(), NearestRadiusLayeredAverage::validParams(), GhostingUserObject::validParams(), TwoMaterialPropertyInterface::validParams(), FVFluxBC::validParams(), NodalBCBase::validParams(), PropertyReadFile::validParams(), KernelBase::validParams(), InterfaceKernelBase::validParams(), MultiAppUserObjectTransfer::validParams(), ThreeMaterialPropertyInterface::validParams(), MultiAppTransfer::validParams(), RadialAverage::validParams(), InterfaceMaterial::validParams(), ProjectedStatefulMaterialNodalPatchRecoveryTempl< T, is_ad >::validParams(), SamplerBase::validParams(), MortarConsumerInterface::validParams(), Control::validParams(), Marker::validParams(), MortarConstraintBase::validParams(), Output::validParams(), UserObject::validParams(), Sampler::validParams(), Checkpoint::validParams(), FVInterfaceKernel::validParams(), AuxKernelTempl< Real >::validParams(), TopResidualDebugOutput::validParams(), MooseVariableFV< Real >::validParams(), MultiApp::validParams(), Moose::Builder::walkRaw(), and RelationshipManager::zeroLayerGhosting().
|
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 82 of file InputParameters.C.
Referenced by applyParameter().
|
private |
Private method for setting deprecated coupled variable documentation strings.
Definition at line 202 of file InputParameters.C.
Referenced by addCoupledVar().
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 339 of file InputParameters.C.
Referenced by Moose::SlepcSupport::getSlepcValidParams(), PropertyReadFile::validParams(), FVBoundedValueConstraint::validParams(), FVIntegralValueConstraint::validParams(), FVPointValueConstraint::validParams(), MultiAppTransfer::validParams(), MortarConstraintBase::validParams(), Output::validParams(), and AuxKernelTempl< Real >::validParams().
void InputParameters::setHelper | ( | const std::string & | name | ) |
This functions is called in set as a 'callback' to avoid code duplication.
Definition at line 1203 of file InputParameters.h.
void InputParameters::setParameters | ( | const std::string & | name, |
const T & | value, | ||
Ts... | extra_input_parameters | ||
) |
Given a series of parameters names and values, sets each name to the corresponding value.
Any number of name, value pairs can be supplied.
Note that each value
must be of the correct type for the parameter of that name, not merely of a type convertible to the correct type.
name | The name of the first parameter to set |
Definition at line 1229 of file InputParameters.h.
Referenced by AutoCheckpointAction::act(), and MeshGenerator::addMeshSubgenerator().
|
inlineprivate |
Method to terminate the recursive setParameters definition.
Definition at line 1017 of file InputParameters.h.
Referenced by setParameters().
|
private |
Definition at line 1117 of file InputParameters.C.
|
private |
This method is called when adding a Parameter with a default value, can be specialized for non-matching types.
Definition at line 1473 of file InputParameters.h.
Referenced by addParam().
|
private |
Definition at line 1129 of file InputParameters.C.
|
private |
Definition at line 1141 of file InputParameters.C.
|
private |
Definition at line 1153 of file InputParameters.C.
|
private |
Definition at line 1165 of file InputParameters.C.
|
private |
Definition at line 1177 of file InputParameters.C.
|
private |
Definition at line 1189 of file InputParameters.C.
|
private |
Definition at line 1201 of file InputParameters.C.
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
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 1234 of file InputParameters.C.
Referenced by OutputInterface::validParams().
bool InputParameters::shouldIgnore | ( | const std::string & | name | ) |
Whether to ignore the value of an input parameter set in the input file or from the command line.
Definition at line 1269 of file InputParameters.C.
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 1651 of file InputParameters.h.
Referenced by ExternalProblem::validParams(), DiscreteElementUserObject::validParams(), ElementSubdomainModifier::validParams(), CSVReaderVectorPostprocessor::validParams(), MultiAppCloneReporterTransfer::validParams(), MassMatrix::validParams(), FVMassMatrix::validParams(), DiffusionFV::validParams(), PseudoTimestep::validParams(), CentroidMultiApp::validParams(), QuadraturePointMultiApp::validParams(), AccumulateReporter::validParams(), MultiAppGeneralFieldShapeEvaluationTransfer::validParams(), ElementHCurlSemiError::validParams(), ElementHDivSemiError::validParams(), CSV::validParams(), MultiAppGeneralFieldUserObjectTransfer::validParams(), ReporterPointSource::validParams(), MortarNodalAuxKernelTempl< ComputeValueType >::validParams(), MultiAppGeneralFieldNearestLocationTransfer::validParams(), VariableResidualNormsDebugOutput::validParams(), NearestRadiusLayeredAverage::validParams(), MultiAppUserObjectTransfer::validParams(), and Marker::validParams().
void InputParameters::transferParam | ( | const InputParameters & | source_param, |
const std::string & | name, | ||
const std::string & | new_name = "" , |
||
const std::string & | new_description = "" |
||
) |
A routine to transfer a parameter from one class' validParams to another.
source_param | The parameters list holding the param we would like to transfer |
name | The name of the parameter to transfer |
new_description | A new description of the parameter. If unspecified, uses the source_params' |
Definition at line 1923 of file InputParameters.h.
Referenced by DiffusionCG::validParams().
std::string InputParameters::type | ( | const std::string & | name | ) | const |
Prints the type of the requested parameter by name.
Definition at line 698 of file InputParameters.C.
Referenced by MooseServer::addValuesToList(), PostprocessorInterface::checkParam(), MeshGenerator::getMeshGeneratorNameFromParam(), MeshGenerator::getMeshGeneratorNamesFromParam(), ReporterInterface::getReporterName(), and Reporter::getReporterValueName().
std::string InputParameters::varName | ( | const std::string & | var_param_name, |
const std::string & | moose_object_with_var_param_name | ||
) | const |
Determine the actual variable name from the given variable parameter name.
var_param_name | the name of the variable parameter, e.g. 'variable' |
moose_object_with_var_param_name | the name of the moose object holding the variable parameter. Used for potential error messaging |
Definition at line 1317 of file InputParameters.C.
Referenced by FEProblemBase::addBoundaryCondition(), FEProblemBase::addConstraint(), FEProblemBase::addDamper(), FEProblemBase::addDGKernel(), FEProblemBase::addDiracKernel(), FEProblemBase::addInterfaceKernel(), FEProblemBase::addKernel(), FEProblemBase::addNodalKernel(), FEProblemBase::addObjectParamsHelper(), FEProblemBase::addScalarKernel(), and MooseVariableInterface< Real >::MooseVariableInterface().
|
friend |
Definition at line 1198 of file InputParameters.h.
|
friend |
Definition at line 28 of file InputParameters.C.
|
friend |
Definition at line 1195 of file InputParameters.h.
|
friend |
Definition at line 1196 of file InputParameters.h.
|
private |
A flag for toggling the error message in the copy constructor.
Definition at line 1178 of file InputParameters.h.
Referenced by allowCopy(), clear(), and operator=().
|
private |
full HIT path of the block from the input file - used for nice error messages.
Definition at line 1140 of file InputParameters.h.
Referenced by blockFullpath(), clear(), and operator=().
|
private |
original location of input block (i.e. filename,linenum) - used for nice error messages.
Definition at line 1137 of file InputParameters.h.
Referenced by blockLocation(), clear(), and operator=().
|
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 1164 of file InputParameters.h.
Referenced by addRelationshipManager(), clearRelationshipManagers(), getBuildableRelationshipManagerTypes(), operator+=(), and operator=().
|
private |
The parameter is used to restrict types that can be built.
Typically this is used for MooseObjectAction derived Actions.
Definition at line 1155 of file InputParameters.h.
Referenced by getBuildableTypes(), operator+=(), operator=(), and registerBuildableTypes().
|
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 1151 of file InputParameters.h.
Referenced by addClassDescription(), and getClassDescription().
|
private |
This parameter collapses one level of nesting in the syntax blocks.
It is used in conjunction with MooseObjectAction derived Actions.
Definition at line 1168 of file InputParameters.h.
Referenced by clear(), collapseSyntaxNesting(), InputParameters(), and operator=().
|
private |
The coupled variables set.
Definition at line 1147 of file InputParameters.h.
Referenced by addCoupledVar(), addCoupledVarWithAutoBuild(), addDeprecatedCoupledVar(), addRequiredCoupledVar(), clear(), coupledVarsBegin(), coupledVarsEnd(), getCoupledVariableParamNames(), hasCoupledValue(), hasDefaultCoupledValue(), operator+=(), operator=(), renameCoupledVarInternal(), and type().
|
private |
This parameter hides derived MOOSE object types from appearing in syntax dumps.
Definition at line 1171 of file InputParameters.h.
Referenced by clear(), InputParameters(), mooseObjectSyntaxVisibility(), and operator=().
|
private |
A map from deprecated coupled variable names to the new blessed name.
Definition at line 1181 of file InputParameters.h.
Referenced by addDeprecatedCoupledVar(), checkParams(), clear(), getNewToDeprecatedVarMap(), operator+=(), operator=(), and setDeprecatedVarDocString().
|
private |
A map from derived-class/blessed parameter names to associated base-class/deprecated parameter names.
Definition at line 1191 of file InputParameters.h.
Referenced by clear(), operator+=(), operator=(), paramAliases(), and renameParamInternal().
|
private |
A map from base-class/deprecated parameter names to derived-class/blessed parameter names and the deprecation messages in the case that the "old" parameter name is a deprecated parameter name.
The deprecation message will be empty if the "old" parameter name represents a base class parameter name
Definition at line 1187 of file InputParameters.h.
Referenced by attemptPrintDeprecated(), checkForRename(), clear(), operator+=(), operator=(), and renameParamInternal().
|
private |
The actual parameter data.
Each Metadata object contains attributes for the corresponding parameter.
Definition at line 1144 of file InputParameters.h.
Referenced by addCoupledVar(), addCoupledVarWithAutoBuild(), addCustomTypeParam(), addDeprecatedCoupledVar(), addDeprecatedCustomTypeParam(), addDeprecatedParam(), addParam(), addParamNamesToGroup(), addPrivateParam(), addRangeCheckedParam(), addRequiredCustomTypeParam(), addRequiredParam(), addRequiredRangeCheckedParam(), applyParameter(), at(), attemptPrintDeprecated(), clear(), declareControllable(), defaultCoupledValue(), getAutoBuildVectors(), getControllableParameters(), getDescription(), getDocString(), getGroupName(), getGroupParameters(), getParametersList(), hasDefaultCoupledValue(), ignoreParameter(), InputParameters(), isControllable(), isParamDeprecated(), isParamRequired(), isParamSetByAddParam(), isParamSetByUser(), isParamValid(), isPrivate(), isRangeChecked(), isType(), makeParamNotRequired(), makeParamRequired(), numberDefaultCoupledValues(), operator+=(), operator=(), rangeCheck(), rangeCheckedFunction(), rawParamVal(), registerBase(), registerSystemAttributeName(), renameParamInternal(), reservedValues(), set(), set_attributes(), setDeprecatedVarDocString(), setDocString(), setReservedValues(), shouldIgnore(), suppressParameter(), transferParam(), and type().
|
private |
Flag for disabling deprecated parameters message, this is used by applyParameters to avoid dumping messages.
Definition at line 1175 of file InputParameters.h.
Referenced by addDeprecatedCoupledVar(), addDeprecatedCustomTypeParam(), addDeprecatedParam(), applyCoupledVar(), applyParameter(), attemptPrintDeprecated(), and clear().