Public Attributes | |
std::string | _doc_string |
std::string | _custom_type |
The custom type that will be printed in the YAML dump for a parameter if supplied. More... | |
std::optional< CommandLineMetadata > | _cl_data |
The data pertaining to a command line parameter (empty if not a command line param) More... | |
std::string | _group |
The names of the parameters organized into groups. More... | |
std::string | _range_function |
The map of functions used for range checked parameters. More... | |
std::pair< std::string, std::string > | _autobuild_vecs |
directions for auto build vectors (base_, 5) -> "base_0 base_1 base_2 base_3 base_4") More... | |
bool | _required = false |
True for parameters that are required (i.e. will cause an abort if not supplied) More... | |
bool | _valid = false |
Whether the parameter is either explicitly set or provided a default value when added Note: We do not store MooseEnum names in valid params, instead we ask MooseEnums whether they are valid or not. More... | |
bool | _is_private = false |
The set of parameters that will NOT appear in the the dump of the parser tree. More... | |
bool | _have_coupled_default = false |
std::vector< Real > | _coupled_default = {0} |
The default value for optionally coupled variables. More... | |
bool | _set_by_add_param = false |
True if a parameters value was set by addParam, and not set again. More... | |
std::set< std::string > | _reserved_values |
The reserved option names for a parameter. More... | |
std::string | _deprecation_message |
If non-empty, this parameter is deprecated. More... | |
const hit::Node * | _hit_node |
Original location of parameter node; used for error messages. More... | |
bool | _controllable = false |
True if the parameters is controllable. More... | |
std::set< ExecFlagType > | _controllable_flags |
Controllable execute flag restriction. More... | |
bool | _ignore = false |
whether user setting of this parameter should be ignored More... | |
Definition at line 1121 of file InputParameters.h.
std::pair<std::string, std::string> InputParameters::Metadata::_autobuild_vecs |
directions for auto build vectors (base_, 5) -> "base_0 base_1 base_2 base_3 base_4")
Definition at line 1133 of file InputParameters.h.
std::optional<CommandLineMetadata> InputParameters::Metadata::_cl_data |
The data pertaining to a command line parameter (empty if not a command line param)
Definition at line 1127 of file InputParameters.h.
Referenced by InputParameters::addCommandLineParamHelper(), InputParameters::getCommandLineMetadata(), and InputParameters::isCommandLineParameter().
bool InputParameters::Metadata::_controllable = false |
True if the parameters is controllable.
Definition at line 1156 of file InputParameters.h.
std::set<ExecFlagType> InputParameters::Metadata::_controllable_flags |
Controllable execute flag restriction.
Definition at line 1158 of file InputParameters.h.
Referenced by InputParameters::getControllableExecuteOnTypes().
std::vector<Real> InputParameters::Metadata::_coupled_default = {0} |
The default value for optionally coupled variables.
Definition at line 1146 of file InputParameters.h.
std::string InputParameters::Metadata::_custom_type |
The custom type that will be printed in the YAML dump for a parameter if supplied.
Definition at line 1125 of file InputParameters.h.
std::string InputParameters::Metadata::_deprecation_message |
If non-empty, this parameter is deprecated.
Definition at line 1152 of file InputParameters.h.
std::string InputParameters::Metadata::_doc_string |
Definition at line 1123 of file InputParameters.h.
std::string InputParameters::Metadata::_group |
The names of the parameters organized into groups.
Definition at line 1129 of file InputParameters.h.
bool InputParameters::Metadata::_have_coupled_default = false |
Definition at line 1144 of file InputParameters.h.
const hit::Node* InputParameters::Metadata::_hit_node |
Original location of parameter node; used for error messages.
Definition at line 1154 of file InputParameters.h.
Referenced by InputParameters::applyParameter(), InputParameters::getHitNode(), and InputParameters::setHitNode().
bool InputParameters::Metadata::_ignore = false |
whether user setting of this parameter should be ignored
Definition at line 1160 of file InputParameters.h.
bool InputParameters::Metadata::_is_private = false |
The set of parameters that will NOT appear in the the dump of the parser tree.
Definition at line 1143 of file InputParameters.h.
std::string InputParameters::Metadata::_range_function |
The map of functions used for range checked parameters.
Definition at line 1131 of file InputParameters.h.
bool InputParameters::Metadata::_required = false |
True for parameters that are required (i.e. will cause an abort if not supplied)
Definition at line 1135 of file InputParameters.h.
std::set<std::string> InputParameters::Metadata::_reserved_values |
The reserved option names for a parameter.
Definition at line 1150 of file InputParameters.h.
bool InputParameters::Metadata::_set_by_add_param = false |
True if a parameters value was set by addParam, and not set again.
Definition at line 1148 of file InputParameters.h.
bool InputParameters::Metadata::_valid = false |
Whether the parameter is either explicitly set or provided a default value when added Note: We do not store MooseEnum names in valid params, instead we ask MooseEnums whether they are valid or not.
Definition at line 1141 of file InputParameters.h.