MultiMooseEnum Class Reference

This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type. More...

#include <MultiMooseEnum.h>

Inheritance diagram for MultiMooseEnum:

Public Member Functions
	MultiMooseEnum (std::string valid_names, bool allow_out_of_range=false)
	Constructor that takes a list of valid enumeration values, and does not set this instance to any particular value. More...
	MultiMooseEnum (const MultiMooseEnum &other_enum)
	Copy Constructor. More...
MultiMooseEnum &	operator= (const MultiMooseEnum &other_enum)=default
	Copy Assignment operator must be explicitly defined when a copy ctor exists and this method is used. More...
const std::string &	operator[] (unsigned int i) const
	Indexing operator Operator to retrieve an item from the MultiMooseEnum. More...
unsigned int	get (unsigned int i) const
	Indexing operator Operator to retrieve the id of an item from the MultiMooseEnum. More...
template<typename T >
std::vector< T >	getEnum () const
	get the current values cast to a vector of enum type T. Deprecated, use getSetValueIDs instead. More...
template<typename T >
std::vector< T >	getSetValueIDs () const
	get the current values cast to a vector of enum type T More...
unsigned int	size () const
	Return the number of active items in the MultiMooseEnum. More...
virtual bool	isValid () const override
	IsValid. More...
MooseEnumBase &	operator+= (const std::string &name)
MooseEnumBase &	operator+= (const std::initializer_list< std::string > &names)
void	addValidName (const std::string &name)
	Extends the range of possible values the variable can be set to. More...
void	addValidName (const std::initializer_list< std::string > &names)
void	addValidName (const MultiMooseEnum &names)
virtual void	deprecate (const std::string &name, const std::string &raw_name="")
	Deprecates various options in the MOOSE enum. More...
std::vector< std::string >	getNames () const
	Method for returning a vector of all valid enumeration names for this instance. More...
std::string	getRawNames () const
	Method for returning the raw name strings for this instance. More...
std::vector< int >	getIDs () const
	Method for returning a vector of ids for this instance. More...
bool	isOutOfRangeAllowed () const
	isOutOfRangeAllowed More...
const std::set< MooseEnumItem > &	items () const
	Return the complete set of available flags. More...
void	addDocumentation (const std::string &name, const std::string &doc)
	Add an item documentation string. More...
const std::map< MooseEnumItem, std::string > &	getItemDocumentation () const
	Get the map containing each item's documentation string. More...
int	getNextValidID () const
	Compute the next valid ID. More...
	MultiMooseEnum (std::string valid_names, std::string initialization_values, bool allow_out_of_range=false)
	Constructor that takes a list of valid enumeration values, and a separate string to set default values for this instance. More...
	MultiMooseEnum (std::string valid_names, const char *initialization_values, bool allow_out_of_range=false)
bool	operator== (const MultiMooseEnum &value) const
	Comparison operators for comparing with character constants, MultiMooseEnums or integer values. More...
bool	operator!= (const MultiMooseEnum &value) const
bool	contains (const std::string &value) const
	Methods for seeing if a value is set in the MultiMooseEnum. More...
bool	contains (int value) const
bool	contains (unsigned short value) const
bool	contains (const MultiMooseEnum &value) const
bool	contains (const MooseEnumItem &value) const
bool	isValueSet (const std::string &value) const
	Methods for seeing if a value is set in the MultiMooseEnum. More...
bool	isValueSet (int value) const
bool	isValueSet (unsigned short value) const
bool	isValueSet (const MultiMooseEnum &value) const
bool	isValueSet (const MooseEnumItem &value) const
MultiMooseEnum &	operator= (const std::string &names)
	Assignment operators to set the objects value from the list of possible values. More...
MultiMooseEnum &	operator= (const std::vector< std::string > &names)
MultiMooseEnum &	operator= (const std::set< std::string > &names)
void	erase (const std::string &names)
	Un-assign, or unset a value. More...
void	erase (const std::vector< std::string > &names)
void	erase (const std::set< std::string > &names)
void	eraseSetValue (const std::string &names)
	Un-assign, or unset a value. More...
void	eraseSetValue (const std::vector< std::string > &names)
void	eraseSetValue (const std::set< std::string > &names)
void	push_back (const std::string &names)
	Insert operators Operator to insert (push_back) values into the enum. More...
void	push_back (const std::vector< std::string > &names)
void	push_back (const std::set< std::string > &names)
void	push_back (const MultiMooseEnum &other_enum)
void	setAdditionalValue (const std::string &names)
	Insert operators Operator to insert (push_back) values into the enum. More...
void	setAdditionalValue (const std::vector< std::string > &names)
void	setAdditionalValue (const std::set< std::string > &names)
void	setAdditionalValue (const MultiMooseEnum &other_enum)
MooseEnumIterator	begin () const
	Returns a begin/end iterator to all of the set values in the enum. More...
MooseEnumIterator	end () const
void	clearSetValues ()
	Clear the MultiMooseEnum. More...
void	clear ()
std::set< MooseEnumItem >::const_iterator	find (const MooseEnumItem &other) const
	Locate an item. More...
std::set< MooseEnumItem >::const_iterator	find (const std::string &name) const
std::set< MooseEnumItem >::const_iterator	find (int id) const

Protected Member Functions
virtual void	checkDeprecated () const override
	Check whether any of the current values are deprecated when called. More...
template<typename InputIterator >
MultiMooseEnum &	assignValues (InputIterator first, InputIterator last, bool append)
	Helper method for all inserts and assignment operators. More...
template<typename InputIterator >
void	removeSetValues (InputIterator first, InputIterator last)
	Helper method for un-assigning enumeration values. More...
	MultiMooseEnum ()
	Protected constructor for use by libmesh::Parameters. More...
	MultiMooseEnum (const MooseEnumBase &other_enum)
	Protected constructor that can accept a MooseEnumBase for ::withOptionsFrom() More...
void	checkDeprecated (const MooseEnumItem &item) const
	Check and warn deprecated values. More...
void	addEnumerationNames (const std::string &names)
	Methods to add possible enumeration value to the enum. More...
const MooseEnumItem &	addEnumerationName (const std::string &raw_name)
const MooseEnumItem &	addEnumerationName (const std::string &name, const int &value)
const MooseEnumItem &	addEnumerationItem (const MooseEnumItem &item)

Protected Attributes
std::vector< MooseEnumItem >	_current_values
	The current value(s) of the MultiMooseEnum. More...
std::set< MooseEnumItem >	_items
	Storage for the assigned items. More...
std::map< MooseEnumItem, MooseEnumItem >	_deprecated_items
	The map of deprecated names and optional replacements. More...
bool	_allow_out_of_range
	Flag to enable enumeration items not previously defined. More...
std::map< MooseEnumItem, std::string >	_item_documentation
	The map of items and their respective documentation strings. More...

Friends
class	libMesh::Parameters
std::ostream &	operator<< (std::ostream &out, const MultiMooseEnum &obj)
	Operator for printing to iostreams. More...

Detailed Description

This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type.

There are two parts to a MultiMooseEnum: 1) The list of all possible values that a variable can have and 2) The subset of these values that the variable is actually set to. It should be initialized with a comma-separated list of strings which become the possible enum values. You may also optionally supply numeric ints for one or more values similar to a C++ enum. This is done with the "=" sign. It can be used any place where an integer (switch statements), const char* or * std::string is expected. In addition the InputParameters system has full support for this Enum type.

Definition at line 41 of file MultiMooseEnum.h.

Constructor & Destructor Documentation

MultiMooseEnum() [1/6]

MultiMooseEnum::MultiMooseEnum	(	std::string	valid_names,
		std::string	initialization_values,
		bool	allow_out_of_range = false
	)

Constructor that takes a list of valid enumeration values, and a separate string to set default values for this instance.

Parameters

valid_names	- a list of all possible values (names) for this enumeration
initialization_values	- the value(s) to set this enumeration instance to
allow_out_of_range	- determines whether this enumeration will accept values outside of its range of initially defined values. A value of true allows the addition of valid values to an object after it has been initialized.

Definition at line 24 of file MultiMooseEnum.C.

  : MooseEnumBase(valid_names, allow_out_of_range)
{
  *this = initialization_values;
}

MultiMooseEnum() [2/6]

MultiMooseEnum::MultiMooseEnum	(	std::string	valid_names,
		const char *	initialization_values,
		bool	allow_out_of_range = false
	)

Definition at line 32 of file MultiMooseEnum.C.

  : MultiMooseEnum(valid_names, std::string(initialization_values), allow_out_of_range)
{
}

MultiMooseEnum() [3/6]

MultiMooseEnum::MultiMooseEnum	(	std::string	valid_names,
		bool	allow_out_of_range = false
	)

Constructor that takes a list of valid enumeration values, and does not set this instance to any particular value.

Parameters

valid_names	- a list of all possible values (names) for this enumeration
allow_out_of_range	- determines whether this enumeration will accept values outside of its range of initially defined values. A value of true allows the addition of valid values to an object after it has been initialized.

Definition at line 39 of file MultiMooseEnum.C.

  : MultiMooseEnum(valid_names, "", allow_out_of_range)
{
}

MultiMooseEnum() [4/6]

MultiMooseEnum::MultiMooseEnum

(

const MultiMooseEnum &

other_enum

)

Copy Constructor.

Parameters

other_enum

- The other enumeration to copy state from

Definition at line 45 of file MultiMooseEnum.C.

  : MooseEnumBase(other_enum), _current_values(other_enum._current_values)
{
}

MultiMooseEnum() [5/6]

MultiMooseEnum::MultiMooseEnum ( )

protected

Protected constructor for use by libmesh::Parameters.

Private constuctor for use by libmesh::Parameters.

Definition at line 53 of file MultiMooseEnum.C.

{}

MultiMooseEnum() [6/6]

MultiMooseEnum::MultiMooseEnum ( const MooseEnumBase &  other_enum )

protected

Protected constructor that can accept a MooseEnumBase for ::withOptionsFrom()

Parameters

other_enum

- MooseEnumBase type to copy names and out-of-range data from

Definition at line 55 of file MultiMooseEnum.C.

: MooseEnumBase(other_enum) {}

Member Function Documentation

addDocumentation()

void MooseEnumBase::addDocumentation ( const std::string &  name, const std::string &  doc  )

inherited

Add an item documentation string.

Definition at line 175 of file MooseEnumBase.C.

Referenced by PseudoTimestep::validParams(), and ReferenceResidualInterface::validParams().

{
  auto it = find(name);
  if (it == _items.end())
    mooseError("Item '", name, "' not found in addDocumentation.");
  _item_documentation[*it] = doc;
}

addEnumerationItem()

const MooseEnumItem & MooseEnumBase::addEnumerationItem ( const MooseEnumItem &  item )

protectedinherited

Definition at line 117 of file MooseEnumBase.C.

Referenced by ExecFlagEnum::addAvailableFlags(), MooseEnumBase::addEnumerationName(), addValidName(), assignValues(), and ReporterProducerEnum::insert().

{
  const auto & item_it = find(item);
  if (item_it != _items.end()) // do nothing for identical insertions
    return *item_it;

  if (find(item.id()) != _items.end())
    mooseError("The supplied id ",
               item.id(),
               " already exists in the enumeration, cannot not add '",
               item,
               "'.");
  if (find(item.name()) != _items.end())
    mooseError("The name '", item.name(), "' already exists in the enumeration.");

  return *_items.insert(item).first;
}

addEnumerationName() [1/2]

const MooseEnumItem & MooseEnumBase::addEnumerationName ( const std::string &  raw_name )

protectedinherited

Definition at line 73 of file MooseEnumBase.C.

Referenced by ConvergenceIterationTypeEnum::addConvergenceIterationType(), MooseEnumBase::addEnumerationNames(), addValidName(), and MooseEnumBase::operator+=().

{
  // Make sure the option is not malformed
  if (raw_name.find_first_of('=') == 0 || raw_name.find_last_of('=') == raw_name.length() - 1)
    mooseError("You cannot place whitespace around the '=' character in MooseEnumBase");

  // Split on equals sign
  std::vector<std::string> name_value;
  MooseUtils::tokenize(MooseUtils::trim(raw_name), name_value, 1, "=");

  // There should be one or two items in the name_value
  if (name_value.size() < 1 || name_value.size() > 2)
    mooseError("Invalid option supplied in MooseEnumBase: ", raw_name);

  // Remove un-wanted space around string
  name_value[0] = MooseUtils::trim(name_value[0]);

  // See if there is a value supplied for this option
  // strtol allows for proper conversions of both int and hex strings
  int value;
  if (name_value.size() == 2)
    value = std::strtol(name_value[1].c_str(), NULL, 0);
  else
    value = getNextValidID();

  return addEnumerationName(name_value[0], value);
}

addEnumerationName() [2/2]

const MooseEnumItem & MooseEnumBase::addEnumerationName ( const std::string &  name, const int &  value  )

protectedinherited

Definition at line 111 of file MooseEnumBase.C.

{
  return addEnumerationItem(MooseEnumItem(name, value));
}

addEnumerationNames()

void MooseEnumBase::addEnumerationNames ( const std::string &  names )

protectedinherited

Methods to add possible enumeration value to the enum.

The MooseEnum/MultiMooseEnum are not designed to be modified, with respect to the list of possible values. However, this is not the case for the ExecFlagEnum which is a special type of MultiMooseEnum for managing the "execute_on" flags. These methods are used by ExecFlagEnum to allow users to modify the available execute flags for their object.

Definition at line 64 of file MooseEnumBase.C.

Referenced by MooseEnumBase::MooseEnumBase().

{
  std::vector<std::string> elements;
  MooseUtils::tokenize(names, elements, 1, " ");
  for (const std::string & raw_name : elements)
    addEnumerationName(raw_name);
}

addValidName() [1/3]

void MultiMooseEnum::addValidName

(

const std::string &

name

)

Extends the range of possible values the variable can be set to.

Definition at line 341 of file MultiMooseEnum.C.

Referenced by addValidName().

{
  addEnumerationName(name);
  checkDeprecated();
}

addValidName() [2/3]

void MultiMooseEnum::addValidName

(

const std::initializer_list< std::string > &

names

)

Definition at line 355 of file MultiMooseEnum.C.

{
  for (const auto & name : names)
    addValidName(name);
}

addValidName() [3/3]

void MultiMooseEnum::addValidName

(

const MultiMooseEnum &

names

)

Definition at line 369 of file MultiMooseEnum.C.

{
  for (const auto & item : names._items)
    addEnumerationItem(MooseEnumItem(item.name(), getNextValidID()));
}

assignValues()

template<typename InputIterator >

MultiMooseEnum & MultiMooseEnum::assignValues ( InputIterator  first, InputIterator  last, bool  append  )

protected

Helper method for all inserts and assignment operators.

Parameters

first	An iterator specifying the beginning of the range of values to set
last	An iterator specifying the end of the range of values to set

Definition at line 261 of file MultiMooseEnum.C.

Referenced by operator=(), and setAdditionalValue().

{
  if (!append)
    clearSetValues();

  for (InputIterator it = first; it != last; ++it)
  {
    const auto iter = find(*it);
    if (iter == _items.end())
    {
      if (!_allow_out_of_range) // Are out of range values allowed?
        mooseError("Invalid option \"",
                   *it,
                   "\" in MultiMooseEnum.  Valid options (not case-sensitive) are \"",
                   getRawNames(),
                   "\".");
      else
      {
        MooseEnumItem created(*it, getNextValidID());
        addEnumerationItem(created);
        _current_values.push_back(created);
      }
    }
    else
      _current_values.push_back(*iter);
  }
  checkDeprecated();
  return *this;
}

begin()

MooseEnumIterator MultiMooseEnum::begin ( ) const

inline

Returns a begin/end iterator to all of the set values in the enum.

Items will always be capitalized.

Definition at line 212 of file MultiMooseEnum.h.

Referenced by Moose::createMapFromVectorAndMultiMooseEnum(), FunctorADConverterTempl< T >::FunctorADConverterTempl(), FunctorSmootherTempl< T >::FunctorSmootherTempl(), GenericFunctorGradientMaterialTempl< is_ad >::GenericFunctorGradientMaterialTempl(), GenericFunctorMaterialTempl< is_ad >::GenericFunctorMaterialTempl(), GenericFunctorTimeDerivativeMaterialTempl< is_ad >::GenericFunctorTimeDerivativeMaterialTempl(), GenericVectorFunctorMaterialTempl< is_ad >::GenericVectorFunctorMaterialTempl(), ParsedFunctorMaterialTempl< is_ad >::ParsedFunctorMaterialTempl(), PiecewiseByBlockFunctorMaterialTempl< T >::PiecewiseByBlockFunctorMaterialTempl(), setAdditionalValue(), and VectorMagnitudeFunctorMaterialTempl< is_ad >::VectorMagnitudeFunctorMaterialTempl().

{ return _current_values.begin(); }

checkDeprecated() [1/2]

void MooseEnumBase::checkDeprecated ( const MooseEnumItem &  item ) const

protectedinherited

Check and warn deprecated values.

Definition at line 136 of file MooseEnumBase.C.

{
  std::map<MooseEnumItem, MooseEnumItem>::const_iterator it = _deprecated_items.find(item);
  if (it != _deprecated_items.end())
  {
    if (it->second.name().empty())
      mooseWarning(item.name() + " is deprecated");
    else
      mooseWarning(item.name() + " is deprecated, consider using " + it->second.name());
  }
}

checkDeprecated() [2/2]

void MultiMooseEnum::checkDeprecated ( ) const

overrideprotectedvirtual

Check whether any of the current values are deprecated when called.

Implements MooseEnumBase.

Definition at line 327 of file MultiMooseEnum.C.

Referenced by addValidName(), assignValues(), and ExecFlagEnum::operator+=().

{
  for (const auto & item : _current_values)
    MooseEnumBase::checkDeprecated(item);
}

clear()

void MultiMooseEnum::clear

(

)

Definition at line 314 of file MultiMooseEnum.C.

{
  mooseDeprecated("MultiMooseEnum::clear is deprecated, use MultiMooseEnum::clearSetValues");
  clearSetValues();
}

clearSetValues()

void MultiMooseEnum::clearSetValues

(

)

Clear the MultiMooseEnum.

Definition at line 308 of file MultiMooseEnum.C.

Referenced by assignValues(), clear(), AdvancedOutput::initExecutionTypes(), ExecFlagEnum::operator=(), and SetupInterface::SetupInterface().

{
  _current_values.clear();
}

contains() [1/5]

bool MultiMooseEnum::contains ( const std::string &  value ) const

inline

Methods for seeing if a value is set in the MultiMooseEnum.

Returns

bool - the truth value indicating whether the value is set

Definition at line 102 of file MultiMooseEnum.h.

Referenced by SetupDebugAction::act(), EigenProblem::checkProblemIntegrity(), Moose::PetscSupport::dontAddPetscFlag(), Moose::PetscSupport::petscSetOptionsHelper(), BlockRestrictionDebugOutput::printBlockRestrictionMap(), and Moose::PetscSupport::setSinglePetscOptionIfAppropriate().

{ return isValueSet(value); }

contains() [2/5]

bool MultiMooseEnum::contains ( int  value ) const

inline

Definition at line 103 of file MultiMooseEnum.h.

{ return isValueSet(value); }

contains() [3/5]

bool MultiMooseEnum::contains ( unsigned short  value ) const

inline

Definition at line 104 of file MultiMooseEnum.h.

{ return isValueSet(value); }

contains() [4/5]

bool MultiMooseEnum::contains ( const MultiMooseEnum &  value ) const

inline

Definition at line 105 of file MultiMooseEnum.h.

{ return isValueSet(value); }

contains() [5/5]

bool MultiMooseEnum::contains ( const MooseEnumItem &  value ) const

inline

Definition at line 106 of file MultiMooseEnum.h.

{ return isValueSet(value); }

deprecate()

void MooseEnumBase::deprecate ( const std::string &  name, const std::string &  raw_name = ""  )

virtualinherited

Deprecates various options in the MOOSE enum.

For each deprecated option, you may supply an optional new option that will be used in a message telling the user which new option replaces the old one.

Definition at line 45 of file MooseEnumBase.C.

{
  std::set<MooseEnumItem>::const_iterator deprecated = find(name);
  if (deprecated == _items.end())
    mooseError("Cannot deprecate the enum item ", name, ", is not an available value.");

  std::set<MooseEnumItem>::const_iterator replaced = find(raw_name);
  if (replaced == _items.end())
    mooseError("Cannot deprecate the enum item ",
               name,
               ", since the replaced item ",
               raw_name,
               " it is not an available value.");

  _deprecated_items.emplace(std::make_pair(*deprecated, *replaced));
  checkDeprecated();
}

end()

MooseEnumIterator MultiMooseEnum::end ( ) const

inline

Definition at line 213 of file MultiMooseEnum.h.

Referenced by FunctorADConverterTempl< T >::FunctorADConverterTempl(), FunctorSmootherTempl< T >::FunctorSmootherTempl(), GenericFunctorGradientMaterialTempl< is_ad >::GenericFunctorGradientMaterialTempl(), GenericFunctorMaterialTempl< is_ad >::GenericFunctorMaterialTempl(), GenericFunctorTimeDerivativeMaterialTempl< is_ad >::GenericFunctorTimeDerivativeMaterialTempl(), GenericVectorFunctorMaterialTempl< is_ad >::GenericVectorFunctorMaterialTempl(), ParsedFunctorMaterialTempl< is_ad >::ParsedFunctorMaterialTempl(), PiecewiseByBlockFunctorMaterialTempl< T >::PiecewiseByBlockFunctorMaterialTempl(), setAdditionalValue(), and VectorMagnitudeFunctorMaterialTempl< is_ad >::VectorMagnitudeFunctorMaterialTempl().

{ return _current_values.end(); }

erase() [1/3]

void MultiMooseEnum::erase

(

const std::string &

names

)

Un-assign, or unset a value.

Deprecated, use eraseSetValue instead.

Parameters

names

- a string, set, or vector giving the name to erase from the enumeration values

Definition at line 149 of file MultiMooseEnum.C.

{
  mooseDeprecated("MultiMooseEnum::erase is deprecated, use MultiMooseEnum::eraseSetValue");
  MultiMooseEnum::eraseSetValue(names);
}

erase() [2/3]

void MultiMooseEnum::erase

(

const std::vector< std::string > &

names

)

Definition at line 162 of file MultiMooseEnum.C.

{
  mooseDeprecated("MultiMooseEnum::erase is deprecated, use MultiMooseEnum::eraseSetValue");
  MultiMooseEnum::eraseSetValue(names);
}

erase() [3/3]

void MultiMooseEnum::erase

(

const std::set< std::string > &

names

)

Definition at line 175 of file MultiMooseEnum.C.

{
  mooseDeprecated("MultiMooseEnum::erase is deprecated, use MultiMooseEnum::eraseSetValue");
  MultiMooseEnum::eraseSetValue(names);
}

eraseSetValue() [1/3]

void MultiMooseEnum::eraseSetValue

(

const std::string &

names

)

Un-assign, or unset a value.

Parameters

names

- a string, set, or vector giving the name to erase from the enumeration values

Definition at line 141 of file MultiMooseEnum.C.

Referenced by Console::Console(), and erase().

{
  std::vector<std::string> names_vector;
  MooseUtils::tokenize(names, names_vector, 1, " ");
  removeSetValues(names_vector.begin(), names_vector.end());
}

eraseSetValue() [2/3]

void MultiMooseEnum::eraseSetValue

(

const std::vector< std::string > &

names

)

Definition at line 156 of file MultiMooseEnum.C.

{
  removeSetValues(names.begin(), names.end());
}

eraseSetValue() [3/3]

void MultiMooseEnum::eraseSetValue

(

const std::set< std::string > &

names

)

Definition at line 169 of file MultiMooseEnum.C.

{
  removeSetValues(names.begin(), names.end());
}

find() [1/3]

std::set< MooseEnumItem >::const_iterator MooseEnumBase::find ( const MooseEnumItem &  other ) const

inherited

Locate an item.

Definition at line 206 of file MooseEnumBase.C.

Referenced by MooseEnumBase::addDocumentation(), MooseEnumBase::addEnumerationItem(), ExecFlagEnum::appendCurrent(), MooseEnum::assign(), assignValues(), MooseEnumBase::deprecate(), FVAdvection::FVAdvection(), MooseEnum::operator==(), moose::internal::ExecFlagRegistry::registerFlag(), moose::internal::ConvergenceIterationTypeRegistry::registerType(), ExecFlagEnum::removeAvailableFlags(), ReadExecutorParamsAction::setupAutoPreconditioning(), and CreateExecutionerAction::setupAutoPreconditioning().

{
  const auto upper = MooseUtils::toUpper(other.name());
  return std::find_if(_items.begin(),
                      _items.end(),
                      [&other, &upper](MooseEnumItem const & item)
                      { return item.id() == other.id() && item.name() == upper; });
}

find() [2/3]

std::set< MooseEnumItem >::const_iterator MooseEnumBase::find ( const std::string &  name ) const

inherited

Definition at line 190 of file MooseEnumBase.C.

{
  std::string upper = MooseUtils::toUpper(name);
  return std::find_if(_items.begin(),
                      _items.end(),
                      [&upper](MooseEnumItem const & item) { return item.name() == upper; });
}

find() [3/3]

std::set< MooseEnumItem >::const_iterator MooseEnumBase::find ( int  id ) const

inherited

Definition at line 199 of file MooseEnumBase.C.

{
  return std::find_if(
      _items.begin(), _items.end(), [&id](MooseEnumItem const & item) { return item.id() == id; });
}

get()

unsigned int MultiMooseEnum::get

(

unsigned int

i

)

const

Indexing operator Operator to retrieve the id of an item from the MultiMooseEnum.

Parameters

i	index corresponding to the desired item

Returns

the id of the MooseEnumItem at the supplied index

Definition at line 250 of file MultiMooseEnum.C.

Referenced by PiecewiseMulticonstant::sample(), Moose::Builder::setScalarParameter(), Moose::PetscSupport::storePetscOptions(), and Transfer::Transfer().

{
  mooseAssert(i < _current_values.size(),
              "Access out of bounds in MultiMooseEnum (i: " << i << " size: "
                                                            << _current_values.size() << ")");

  return _current_values[i].id();
}

getEnum()

template<typename T >

std::vector< T > MultiMooseEnum::getEnum

(

)

const

get the current values cast to a vector of enum type T. Deprecated, use getSetValueIDs instead.

Definition at line 308 of file MultiMooseEnum.h.

{
  mooseDeprecated("MultiMooseEnum::getEnum is deprecated, use MultiMooseEnum::getSetValueIDs");
  return MultiMooseEnum::getSetValueIDs<T>();
}

getIDs()

std::vector< int > MooseEnumBase::getIDs ( ) const

inherited

Method for returning a vector of ids for this instance.

Returns

a vector of ints containing the possible ids for this enumeration

Definition at line 165 of file MooseEnumBase.C.

Referenced by MooseEnum::assign().

{
  std::vector<int> out;
  out.reserve(_items.size());
  for (const auto & item : _items)
    out.push_back(item.id());
  return out;
}

getItemDocumentation()

const std::map< MooseEnumItem, std::string > & MooseEnumBase::getItemDocumentation ( ) const

inherited

Get the map containing each item's documentation string.

Definition at line 184 of file MooseEnumBase.C.

{
  return _item_documentation;
}

getNames()

std::vector< std::string > MooseEnumBase::getNames ( ) const

inherited

Method for returning a vector of all valid enumeration names for this instance.

Returns

a vector of names

Definition at line 149 of file MooseEnumBase.C.

{
  std::vector<std::string> out;
  out.reserve(_items.size());
  for (const auto & item : _items)
    out.push_back(item.name());
  return out;
}

getNextValidID()

int MooseEnumBase::getNextValidID ( ) const

inherited

Compute the next valid ID.

Definition at line 102 of file MooseEnumBase.C.

Referenced by MooseEnumBase::addEnumerationName(), addValidName(), MooseEnum::assign(), assignValues(), and moose::internal::ExecFlagRegistry::registerFlag().

{
  int value = -1; // Use -1 so if no values exist the first will be zero
  for (const auto & item : _items)
    value = std::max(value, item.id());
  return ++value;
}

getRawNames()

std::string MooseEnumBase::getRawNames ( ) const

inherited

Method for returning the raw name strings for this instance.

Returns

a space separated list of names

Definition at line 159 of file MooseEnumBase.C.

Referenced by MooseEnum::assign(), assignValues(), Moose::createMapFromVectorAndMultiMooseEnum(), AdvancedOutput::enableOutputTypes(), MooseEnum::operator==(), PiecewiseConstant::validParams(), LeastSquaresFit::validParams(), BatchMeshGeneratorAction::validParams(), and ComparisonPostprocessor::validParams().

{
  return Moose::stringify(_items, " ");
}

getSetValueIDs()

template<typename T >

std::vector< T > MultiMooseEnum::getSetValueIDs

(

)

const

get the current values cast to a vector of enum type T

Definition at line 294 of file MultiMooseEnum.h.

{
#ifdef LIBMESH_HAVE_CXX11_TYPE_TRAITS
  static_assert(std::is_enum<T>::value == true,
                "The type requested from MooseEnum::getEnum must be an enum type!\n\n");
#endif
  std::vector<T> enum_vec;
  for (const auto & current_value : _current_values)
    enum_vec.push_back(static_cast<T>(current_value.id()));
  return enum_vec;
}

isOutOfRangeAllowed()

bool MooseEnumBase::isOutOfRangeAllowed ( ) const

inlineinherited

isOutOfRangeAllowed

Returns

- a Boolean indicating whether enum names out of range are allowed

Definition at line 88 of file MooseEnumBase.h.

{ return _allow_out_of_range; }

isValid()

virtual bool MultiMooseEnum::isValid ( ) const

inlineoverridevirtual

IsValid.

Returns

- a Boolean indicating whether this Enumeration has been set

Implements MooseEnumBase.

Definition at line 233 of file MultiMooseEnum.h.

Referenced by SetupDebugAction::act(), IterationInfo::declareHelper(), MeshInfo::declareHelper(), MeshInfo::possiblyAddSidesetInfo(), MeshInfo::possiblyAddSubdomainInfo(), and BlockRestrictionDebugOutput::printBlockRestrictionMap().

{ return !_current_values.empty(); }

isValueSet() [1/5]

bool MultiMooseEnum::isValueSet

(

const std::string &

value

)

const

Methods for seeing if a value is set in the MultiMooseEnum.

Returns

bool - the truth value indicating whether the value is set

Definition at line 76 of file MultiMooseEnum.C.

Referenced by Moose::PetscSupport::addPetscFlagsToPetscOptions(), FEProblemBase::addTransfer(), AdvancedOutput::addValidParams(), MultiAppVariableValueSamplePostprocessorTransfer::cacheElemToPostprocessorData(), ChangeOverFixedPointPostprocessor::ChangeOverFixedPointPostprocessor(), ChangeOverTimePostprocessor::ChangeOverTimePostprocessor(), contains(), IterationInfo::declareHelper(), MeshInfo::declareHelper(), EigenExecutionerBase::init(), MultiAppReporterTransfer::initialSetup(), IntegralPreservingFunctionIC::initialSetup(), MultiAppVariableValueSamplePostprocessorTransfer::initialSetup(), Console::initialSetup(), EigenExecutionerBase::inversePowerIteration(), isValueSet(), MultiAppReporterTransfer::MultiAppReporterTransfer(), MultiAppVariableValueSamplePostprocessorTransfer::MultiAppVariableValueSamplePostprocessorTransfer(), operator==(), Console::output(), JSONOutput::outputReporters(), Console::outputSystemInformation(), XMLOutput::outputVectorPostprocessors(), MeshInfo::possiblyAddSidesetInfo(), MeshInfo::possiblyAddSubdomainInfo(), EigenExecutionerBase::postExecute(), ExecFlagEnum::removeAvailableFlags(), MultiAppVariableValueSamplePostprocessorTransfer::setupPostprocessorCommunication(), PerfGraphOutput::shouldOutput(), Output::shouldOutput(), FEProblemBase::shouldPrintExecution(), ElementReporter::shouldStore(), NodalReporter::shouldStore(), and GeneralReporter::shouldStore().

{
  return std::find_if(_current_values.begin(),
                      _current_values.end(),
                      [&value](const MooseEnumItem & item)
                      { return item == value; }) != _current_values.end();
}

isValueSet() [2/5]

bool MultiMooseEnum::isValueSet

(

int

value

)

const

Definition at line 85 of file MultiMooseEnum.C.

{
  return std::find_if(_current_values.begin(),
                      _current_values.end(),
                      [&value](const MooseEnumItem & item)
                      { return item == value; }) != _current_values.end();
}

isValueSet() [3/5]

bool MultiMooseEnum::isValueSet

(

unsigned short

value

)

const

Definition at line 94 of file MultiMooseEnum.C.

{
  return std::find_if(_current_values.begin(),
                      _current_values.end(),
                      [&value](const MooseEnumItem & item)
                      { return item == value; }) != _current_values.end();
}

isValueSet() [4/5]

bool MultiMooseEnum::isValueSet

(

const MultiMooseEnum &

value

)

const

Definition at line 103 of file MultiMooseEnum.C.

{
  for (const auto & item : value._current_values)
    if (!isValueSet(item))
      return false;
  return true;
}

isValueSet() [5/5]

bool MultiMooseEnum::isValueSet

(

const MooseEnumItem &

value

)

const

Definition at line 112 of file MultiMooseEnum.C.

{
  return std::find_if(_current_values.begin(),
                      _current_values.end(),
                      [&value](const MooseEnumItem & item)
                      { return item == value; }) != _current_values.end();
}

items()

const std::set<MooseEnumItem>& MooseEnumBase::items ( ) const

inlineinherited

Return the complete set of available flags.

Definition at line 93 of file MooseEnumBase.h.

Referenced by MooseEnum::assign(), FVAdvection::FVAdvection(), moose::internal::ConvergenceIterationTypeRegistry::registerType(), CreateExecutionerAction::setupAutoPreconditioning(), and ReadExecutorParamsAction::setupAutoPreconditioning().

{ return _items; }

operator!=()

bool MultiMooseEnum::operator!=

(

const MultiMooseEnum &

value

)

const

Definition at line 70 of file MultiMooseEnum.C.

{
  return !(*this == value);
}

operator+=() [1/2]

MooseEnumBase & MultiMooseEnum::operator+=

(

const std::string &

name

)

Definition at line 348 of file MultiMooseEnum.C.

{
  mooseDeprecated("MultiMooseEnum::operator+= is deprecated, use MultiMooseEnum::addValidName");
  return MooseEnumBase::operator+=(name);
}

operator+=() [2/2]

MooseEnumBase & MultiMooseEnum::operator+=

(

const std::initializer_list< std::string > &

names

)

Definition at line 362 of file MultiMooseEnum.C.

{
  mooseDeprecated("MultiMooseEnum::operator+= is deprecated, use MultiMooseEnum::addValidName");
  return MooseEnumBase::operator+=(names);
}

operator=() [1/4]

MultiMooseEnum& MultiMooseEnum::operator= ( const MultiMooseEnum &  other_enum )

default

Copy Assignment operator must be explicitly defined when a copy ctor exists and this method is used.

operator=() [2/4]

MultiMooseEnum & MultiMooseEnum::operator=

(

const std::string &

names

)

Assignment operators to set the objects value from the list of possible values.

Parameters

names

- a string, set, or vector representing one of the enumeration values.

Returns

A reference to this object for chaining

Definition at line 121 of file MultiMooseEnum.C.

{
  std::vector<std::string> names_vector;
  MooseUtils::tokenize(names, names_vector, 1, " ");
  return assignValues(names_vector.begin(), names_vector.end(), false);
}

operator=() [3/4]

MultiMooseEnum & MultiMooseEnum::operator=

(

const std::vector< std::string > &

names

)

Definition at line 129 of file MultiMooseEnum.C.

{
  return assignValues(names.begin(), names.end(), false);
}

operator=() [4/4]

MultiMooseEnum & MultiMooseEnum::operator=

(

const std::set< std::string > &

names

)

Definition at line 135 of file MultiMooseEnum.C.

{
  return assignValues(names.begin(), names.end(), false);
}

operator==()

bool MultiMooseEnum::operator==

(

const MultiMooseEnum &

value

)

const

Comparison operators for comparing with character constants, MultiMooseEnums or integer values.

Parameters

value

- RHS value to compare against

Returns

bool - the truth value for the comparison

Definition at line 58 of file MultiMooseEnum.C.

{
  // Not the same if the lengths are different
  if (value.size() != size())
    return false;

  // Return false if this enum does not contain an item from the other, since they are the same
  // size at this point if this is true then they are equal.
  return isValueSet(value);
}

operator[]()

const std::string & MultiMooseEnum::operator[]

(

unsigned int

i

)

const

Indexing operator Operator to retrieve an item from the MultiMooseEnum.

The reference may not be used to change the item.

Parameters

i

index

Returns

a read/read-write reference to the item as a string.

Definition at line 240 of file MultiMooseEnum.C.

{
  mooseAssert(i < _current_values.size(),
              "Access out of bounds in MultiMooseEnum (i: " << i << " size: "
                                                            << _current_values.size() << ")");

  return _current_values[i].rawName();
}

push_back() [1/4]

void MultiMooseEnum::push_back

(

const std::string &

names

)

Insert operators Operator to insert (push_back) values into the enum.

Existing values are preserved and duplicates are stored. Deprecated, use setAdditionalValue instead.

Parameters

names

- a string, set, or vector representing the enumeration values to set.

Definition at line 190 of file MultiMooseEnum.C.

{
  mooseDeprecated(
      "MultiMooseEnum::push_back is deprecated, use MultiMooseEnum::setAdditionalValue");
  MultiMooseEnum::setAdditionalValue(names);
}

push_back() [2/4]

void MultiMooseEnum::push_back

(

const std::vector< std::string > &

names

)

Definition at line 204 of file MultiMooseEnum.C.

{
  mooseDeprecated(
      "MultiMooseEnum::push_back is deprecated, use MultiMooseEnum::setAdditionalValue");
  MultiMooseEnum::setAdditionalValue(names);
}

push_back() [3/4]

void MultiMooseEnum::push_back

(

const std::set< std::string > &

names

)

Definition at line 218 of file MultiMooseEnum.C.

{
  mooseDeprecated(
      "MultiMooseEnum::push_back is deprecated, use MultiMooseEnum::setAdditionalValue");
  MultiMooseEnum::setAdditionalValue(names);
}

push_back() [4/4]

void MultiMooseEnum::push_back

(

const MultiMooseEnum &

other_enum

)

Definition at line 232 of file MultiMooseEnum.C.

{
  mooseDeprecated(
      "MultiMooseEnum::push_back is deprecated, use MultiMooseEnum::setAdditionalValue");
  MultiMooseEnum::setAdditionalValue(other_enum);
}

removeSetValues()

template<typename InputIterator >

void MultiMooseEnum::removeSetValues ( InputIterator  first, InputIterator  last  )

protected

Helper method for un-assigning enumeration values.

Parameters

first	An iterator specifying the beginning of the range of values to set
last	An iterator specifying the end of the range of values to set

Definition at line 293 of file MultiMooseEnum.C.

Referenced by eraseSetValue().

{
  // Create a new list of enumerations by striping out the supplied values
  for (InputIterator it = first; it != last; ++it)
  {
    std::vector<MooseEnumItem>::iterator iter =
        std::find_if(_current_values.begin(),
                     _current_values.end(),
                     [it](const MooseEnumItem & item) { return item == *it; });
    if (iter != _current_values.end())
      _current_values.erase(iter);
  }
}

setAdditionalValue() [1/4]

void MultiMooseEnum::setAdditionalValue

(

const std::string &

names

)

Insert operators Operator to insert (push_back) values into the enum.

Existing values are preserved and duplicates are stored.

Parameters

names

- a string, set, or vector representing the enumeration values to set.

Definition at line 182 of file MultiMooseEnum.C.

Referenced by Moose::PetscSupport::addPetscFlagsToPetscOptions(), Moose::PetscSupport::addPetscPairsToPetscOptions(), Console::Console(), Moose::PetscSupport::dontAddCommonSNESOptions(), Moose::PetscSupport::dontAddPetscFlag(), MultiAppTransfer::MultiAppTransfer(), Output::Output(), PetscOutput::PetscOutput(), and push_back().

{
  std::vector<std::string> names_vector;
  MooseUtils::tokenize(names, names_vector, 1, " ");
  assignValues(names_vector.begin(), names_vector.end(), true);
}

setAdditionalValue() [2/4]

void MultiMooseEnum::setAdditionalValue

(

const std::vector< std::string > &

names

)

Definition at line 198 of file MultiMooseEnum.C.

{
  assignValues(names.begin(), names.end(), true);
}

setAdditionalValue() [3/4]

void MultiMooseEnum::setAdditionalValue

(

const std::set< std::string > &

names

)

Definition at line 212 of file MultiMooseEnum.C.

{
  assignValues(names.begin(), names.end(), true);
}

setAdditionalValue() [4/4]

void MultiMooseEnum::setAdditionalValue

(

const MultiMooseEnum &

other_enum

)

Definition at line 226 of file MultiMooseEnum.C.

{
  assignValues(other_enum.begin(), other_enum.end(), true);
}

size()

unsigned int MultiMooseEnum::size

(

)

const

Return the number of active items in the MultiMooseEnum.

Definition at line 321 of file MultiMooseEnum.C.

Referenced by Moose::createMapFromVectorAndMultiMooseEnum(), Moose::LibtorchArtificialNeuralNet::forward(), InterfaceKernelTempl< T >::InterfaceKernelTempl(), Moose::LibtorchArtificialNeuralNet::LibtorchArtificialNeuralNet(), MultiAppPostprocessorToAuxScalarTransfer::MultiAppPostprocessorToAuxScalarTransfer(), MultiAppPostprocessorTransfer::MultiAppPostprocessorTransfer(), MultiAppReporterTransfer::MultiAppReporterTransfer(), MultiAppScalarToAuxScalarTransfer::MultiAppScalarToAuxScalarTransfer(), MultiAppVariableValueSamplePostprocessorTransfer::MultiAppVariableValueSamplePostprocessorTransfer(), MultiAppVariableValueSampleTransfer::MultiAppVariableValueSampleTransfer(), MultiAppVectorPostprocessorTransfer::MultiAppVectorPostprocessorTransfer(), operator==(), PiecewiseMulticonstant::PiecewiseMulticonstant(), RefineSidesetGenerator::RefineSidesetGenerator(), MooseMesh::setCoordSystem(), Moose::Builder::setVectorParameter(), SidesetInfoVectorPostprocessor::SidesetInfoVectorPostprocessor(), and Transfer::Transfer().

{
  return _current_values.size();
}

Friends And Related Function Documentation

libMesh::Parameters

friend class libMesh::Parameters

friend

Definition at line 237 of file MultiMooseEnum.h.

operator<<

std::ostream& operator<< ( std::ostream &  out, const MultiMooseEnum &  obj  )

friend

Operator for printing to iostreams.

Definition at line 334 of file MultiMooseEnum.C.

{
  out << Moose::stringify(obj._current_values, " ");
  return out;
}

Member Data Documentation

_allow_out_of_range

bool MooseEnumBase::_allow_out_of_range

protectedinherited

Flag to enable enumeration items not previously defined.

Definition at line 163 of file MooseEnumBase.h.

Referenced by MooseEnum::assign(), assignValues(), MooseEnumBase::isOutOfRangeAllowed(), and MooseEnum::operator==().

_current_values

std::vector<MooseEnumItem> MultiMooseEnum::_current_values

protected

The current value(s) of the MultiMooseEnum.

Definition at line 278 of file MultiMooseEnum.h.

Referenced by ExecFlagEnum::appendCurrent(), assignValues(), begin(), checkDeprecated(), clearSetValues(), end(), get(), getSetValueIDs(), isValid(), isValueSet(), operator<<(), operator[](), removeSetValues(), and size().

_deprecated_items

std::map<MooseEnumItem, MooseEnumItem> MooseEnumBase::_deprecated_items

protectedinherited

The map of deprecated names and optional replacements.

Definition at line 160 of file MooseEnumBase.h.

Referenced by MooseEnumBase::checkDeprecated(), and MooseEnumBase::deprecate().

_item_documentation

std::map<MooseEnumItem, std::string> MooseEnumBase::_item_documentation

protectedinherited

The map of items and their respective documentation strings.

Definition at line 166 of file MooseEnumBase.h.

Referenced by MooseEnumBase::addDocumentation(), and MooseEnumBase::getItemDocumentation().

_items

std::set<MooseEnumItem> MooseEnumBase::_items

protectedinherited

Storage for the assigned items.

Definition at line 157 of file MooseEnumBase.h.

Referenced by MooseEnumBase::addDocumentation(), MooseEnumBase::addEnumerationItem(), addValidName(), ExecFlagEnum::appendCurrent(), MooseEnum::assign(), assignValues(), ReporterProducerEnum::clear(), MooseEnumBase::deprecate(), MooseEnumBase::find(), MooseEnumBase::getIDs(), MooseEnumBase::getNames(), MooseEnumBase::getNextValidID(), MooseEnumBase::getRawNames(), ExecFlagEnum::items(), MooseEnumBase::items(), MooseEnum::operator==(), and ExecFlagEnum::removeAvailableFlags().

---

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

• include/utils/MultiMooseEnum.h
• src/utils/MultiMooseEnum.C