Public Attributes
std::string	_doc_string

std::string	_doc_unit
	The developer-designated unit of the parameter for use in documentation. More...

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::optional< Moose::DataFileUtils::Path >	_data_file_name_path
	The searched path information pertaining to a DataFileName parameter. 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...

Detailed Description

Definition at line 1352 of file InputParameters.h.

Member Data Documentation

◆ _autobuild_vecs

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 1368 of file InputParameters.h.

◆ _cl_data

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 1360 of file InputParameters.h.

Referenced by InputParameters::addCommandLineParamHelper(), InputParameters::commandLineParamSet(), InputParameters::getCommandLineMetadata(), InputParameters::isCommandLineParameter(), InputParameters::queryCommandLineMetadata(), and InputParameters::setGlobalCommandLineParam().

◆ _controllable

bool InputParameters::Metadata::_controllable = false

True if the parameters is controllable.

Definition at line 1391 of file InputParameters.h.

◆ _controllable_flags

std::set<ExecFlagType> InputParameters::Metadata::_controllable_flags

Controllable execute flag restriction.

Definition at line 1393 of file InputParameters.h.

Referenced by InputParameters::getControllableExecuteOnTypes().

◆ _coupled_default

std::vector<Real> InputParameters::Metadata::_coupled_default = {0}

The default value for optionally coupled variables.

Definition at line 1381 of file InputParameters.h.

◆ _custom_type

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 1358 of file InputParameters.h.

◆ _data_file_name_path

std::optional<Moose::DataFileUtils::Path> InputParameters::Metadata::_data_file_name_path

The searched path information pertaining to a DataFileName parameter.

Definition at line 1362 of file InputParameters.h.

Referenced by InputParameters::finalize(), and InputParameters::queryDataFileNamePath().

◆ _deprecation_message

std::string InputParameters::Metadata::_deprecation_message

If non-empty, this parameter is deprecated.

Definition at line 1387 of file InputParameters.h.

◆ _doc_string

std::string InputParameters::Metadata::_doc_string

Definition at line 1354 of file InputParameters.h.

◆ _doc_unit

std::string InputParameters::Metadata::_doc_unit

The developer-designated unit of the parameter for use in documentation.

Definition at line 1356 of file InputParameters.h.

◆ _group

std::string InputParameters::Metadata::_group

The names of the parameters organized into groups.

Definition at line 1364 of file InputParameters.h.

◆ _have_coupled_default

bool InputParameters::Metadata::_have_coupled_default = false

Definition at line 1379 of file InputParameters.h.

◆ _hit_node

const hit::Node* InputParameters::Metadata::_hit_node

Original location of parameter node; used for error messages.

Definition at line 1389 of file InputParameters.h.

Referenced by InputParameters::applyParameter(), InputParameters::getHitNode(), and InputParameters::setHitNode().

◆ _ignore

bool InputParameters::Metadata::_ignore = false

whether user setting of this parameter should be ignored

Definition at line 1395 of file InputParameters.h.

◆ _is_private

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 1378 of file InputParameters.h.

◆ _range_function

std::string InputParameters::Metadata::_range_function

The map of functions used for range checked parameters.

Definition at line 1366 of file InputParameters.h.

◆ _required

bool InputParameters::Metadata::_required = false

True for parameters that are required (i.e. will cause an abort if not supplied)

Definition at line 1370 of file InputParameters.h.

◆ _reserved_values

std::set<std::string> InputParameters::Metadata::_reserved_values

The reserved option names for a parameter.

Definition at line 1385 of file InputParameters.h.

◆ _set_by_add_param

bool InputParameters::Metadata::_set_by_add_param = false

True if a parameters value was set by addParam, and not set again.

Definition at line 1383 of file InputParameters.h.

◆ _valid

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 1376 of file InputParameters.h.

The documentation for this struct was generated from the following file:

include/utils/InputParameters.h

Public Attributes