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::vector< std::string >	_cli_flag_names

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	_vector_of_postprocessors = false
	are pps provided as single pp or as vector of pps More...

std::vector< bool >	_have_default_postprocessor_val = {false}

std::vector< PostprocessorValue >	_default_postprocessor_val = {0}

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

std::string	_input_location
	original location of parameter (i.e. filename,linenum) - used for nice error messages. More...

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

std::string	_raw_val
	raw token text for a parameter - usually only set for filepath type params. 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 825 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 836 of file InputParameters.h.

◆ _cli_flag_names

std::vector<std::string> InputParameters::Metadata::_cli_flag_names

Definition at line 830 of file InputParameters.h.

◆ _controllable

bool InputParameters::Metadata::_controllable = false

True if the parameters is controllable.

Definition at line 867 of file InputParameters.h.

◆ _controllable_flags

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

Controllable execute flag restriction.

Definition at line 869 of file InputParameters.h.

◆ _coupled_default

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

The default value for optionally coupled variables.

Definition at line 849 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 829 of file InputParameters.h.

◆ _default_postprocessor_val

std::vector<PostprocessorValue> InputParameters::Metadata::_default_postprocessor_val = {0}

Definition at line 853 of file InputParameters.h.

◆ _deprecation_message

std::string InputParameters::Metadata::_deprecation_message

If non-empty, this parameter is deprecated.

Definition at line 859 of file InputParameters.h.

◆ _doc_string

std::string InputParameters::Metadata::_doc_string

Definition at line 827 of file InputParameters.h.

◆ _group

std::string InputParameters::Metadata::_group

The names of the parameters organized into groups.

Definition at line 832 of file InputParameters.h.

◆ _have_coupled_default

bool InputParameters::Metadata::_have_coupled_default = false

Definition at line 847 of file InputParameters.h.

◆ _have_default_postprocessor_val

std::vector<bool> InputParameters::Metadata::_have_default_postprocessor_val = {false}

Definition at line 852 of file InputParameters.h.

◆ _ignore

bool InputParameters::Metadata::_ignore = false

whether user setting of this parameter should be ignored

Definition at line 871 of file InputParameters.h.

◆ _input_location

std::string InputParameters::Metadata::_input_location

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

Definition at line 861 of file InputParameters.h.

Referenced by InputParameters::inputLocation().

◆ _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 846 of file InputParameters.h.

◆ _param_fullpath

std::string InputParameters::Metadata::_param_fullpath

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

Definition at line 863 of file InputParameters.h.

Referenced by InputParameters::paramFullpath().

◆ _range_function

std::string InputParameters::Metadata::_range_function

The map of functions used for range checked parameters.

Definition at line 834 of file InputParameters.h.

◆ _raw_val

std::string InputParameters::Metadata::_raw_val

raw token text for a parameter - usually only set for filepath type params.

Definition at line 865 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 838 of file InputParameters.h.

◆ _reserved_values

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

The reserved option names for a parameter.

Definition at line 857 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 855 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 844 of file InputParameters.h.

◆ _vector_of_postprocessors

bool InputParameters::Metadata::_vector_of_postprocessors = false

are pps provided as single pp or as vector of pps

Definition at line 851 of file InputParameters.h.

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

include/utils/InputParameters.h

Public Attributes