MooseEnumBase Class Reference

The base class for both the MooseEnum and MultiMooseEnum classes. More...

#include <MooseEnumBase.h>

Inheritance diagram for MooseEnumBase:

Public Member Functions
	MooseEnumBase (std::string names, bool allow_out_of_range=false)
	Constructor that takes a list of enumeration values, and a separate string to set a default for this instance.
	MooseEnumBase (const MooseEnumBase &other_enum)
	Copy Constructor for use when creating vectors of MooseEnumBases.
MooseEnumBase &	operator= (const MooseEnumBase &other_enum)=default
	Copy Assignment operator must be explicitly defined when a copy ctor exists and this method is used.
virtual	~MooseEnumBase ()=default
	This class must have a virtual destructor since it has derived classes.
virtual void	deprecate (const std::string &name, const std::string &raw_name="")
	Deprecates various options in the MOOSE enum.
std::vector< std::string >	getNames () const
	Method for returning a vector of all valid enumeration names for this instance.
std::string	getRawNames () const
	Method for returning the raw name strings for this instance.
std::vector< int >	getIDs () const
	Method for returning a vector of ids for this instance.
virtual bool	isValid () const =0
	IsValid.
bool	isOutOfRangeAllowed () const
	isOutOfRangeAllowed
const std::set< MooseEnumItem > &	items () const
	Return the complete set of available flags.
void	addDocumentation (const std::string &name, const std::string &doc)
	Add an item documentation string.
const std::map< MooseEnumItem, std::string > &	getItemDocumentation () const
	Get the map containing each item's documentation string.
int	getNextValidID () const
	Compute the next valid ID.
MooseEnumBase &	operator+= (const std::string &name)
	Adds an enumeration item from name.
MooseEnumBase &	operator+= (const std::initializer_list< std::string > &names)
	Adds enumeration items from a list of names.
std::set< MooseEnumItem >::const_iterator	find (const MooseEnumItem &other) const
	Locate an item.
std::set< MooseEnumItem >::const_iterator	find (const std::string &name) const
std::set< MooseEnumItem >::const_iterator	find (int id) const

Protected Member Functions
	MooseEnumBase ()
	Private constuctor for use by libmesh::Parameters.
virtual void	checkDeprecated () const =0
	Method that must be implemented to check derived class values against the _deprecated_names.
void	checkDeprecated (const MooseEnumItem &item) const
	Check and warn deprecated values.
void	addEnumerationNames (const std::string &names)
	Methods to add possible enumeration value to the enum.
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::set< MooseEnumItem >	_items
	Storage for the assigned items.
std::map< MooseEnumItem, MooseEnumItem >	_deprecated_items
	The map of deprecated names and optional replacements.
bool	_allow_out_of_range
	Flag to enable enumeration items not previously defined.
std::map< MooseEnumItem, std::string >	_item_documentation
	The map of items and their respective documentation strings.

Detailed Description

The base class for both the MooseEnum and MultiMooseEnum classes.

Definition at line 24 of file MooseEnumBase.h.

Constructor & Destructor Documentation

MooseEnumBase() [1/3]

MooseEnumBase::MooseEnumBase	(	std::string	names,
		bool	allow_out_of_range = false
	)

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

Parameters

names	- a list of names for this enumeration
allow_out_of_range	- determines whether this enumeration will accept values outside of its range of defined values.

Definition at line 23 of file MooseEnumBase.C.

  : _allow_out_of_range(allow_out_of_range)
{
  if (names.find(',') != std::string::npos)
    mooseError("Spaces are required to separate options, comma support has been removed.");
  else
    addEnumerationNames(names);
}

MooseEnumBase() [2/3]

MooseEnumBase::MooseEnumBase

(

const MooseEnumBase &

other_enum

)

Copy Constructor for use when creating vectors of MooseEnumBases.

Parameters

other_enum

- The other enumeration to copy state from

Definition at line 32 of file MooseEnumBase.C.

  : _items(other_enum._items),
    _deprecated_items(other_enum._deprecated_items),
    _allow_out_of_range(other_enum._allow_out_of_range)
{
}

~MooseEnumBase()

virtual MooseEnumBase::~MooseEnumBase ( )

virtualdefault

This class must have a virtual destructor since it has derived classes.

MooseEnumBase() [3/3]

MooseEnumBase::MooseEnumBase ( )

protected

Private constuctor for use by libmesh::Parameters.

Definition at line 42 of file MooseEnumBase.C.

: _allow_out_of_range(false) {}

Member Function Documentation

addDocumentation()

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

Add an item documentation string.

Definition at line 175 of file MooseEnumBase.C.

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

Referenced by MortarConsumerInterface::triangulationParams(), MortarConsumerInterface::validParams(), ReferenceResidualInterface::validParams(), MFEMSamplerBase::validParams(), and PseudoTimestep::validParams().

addEnumerationItem()

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

protected

Definition at line 117 of file MooseEnumBase.C.

{
  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;
}

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

addEnumerationName() [1/2]

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

protected

Definition at line 111 of file MooseEnumBase.C.

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

addEnumerationName() [2/2]

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

protected

Definition at line 73 of file MooseEnumBase.C.

{
  // 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);
}

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

addEnumerationNames()

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

protected

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.

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

Referenced by MooseEnumBase().

checkDeprecated() [1/2]

virtual void MooseEnumBase::checkDeprecated ( ) const

protectedpure virtual

Method that must be implemented to check derived class values against the _deprecated_names.

Implemented in MooseEnum, and MultiMooseEnum.

Referenced by MooseEnum::checkDeprecated(), MultiMooseEnum::checkDeprecated(), deprecate(), and operator+=().

checkDeprecated() [2/2]

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

protected

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());
  }
}

deprecate()

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

virtual

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();
}

find() [1/3]

std::set< MooseEnumItem >::const_iterator MooseEnumBase::find

(

const MooseEnumItem &

other

)

const

Locate an item.

Definition at line 206 of file MooseEnumBase.C.

{
  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; });
}

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

find() [2/3]

std::set< MooseEnumItem >::const_iterator MooseEnumBase::find

(

const std::string &

name

)

const

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

Definition at line 199 of file MooseEnumBase.C.

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

getIDs()

std::vector< int > MooseEnumBase::getIDs

(

)

const

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.

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

Referenced by MooseEnum::assign().

getItemDocumentation()

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

(

)

const

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

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;
}

Referenced by Moose::PetscSupport::dontAddCommonKSPOptions(), and Moose::PetscSupport::dontAddCommonSNESOptions().

getNextValidID()

int MooseEnumBase::getNextValidID

(

)

const

Compute the next valid ID.

Definition at line 102 of file MooseEnumBase.C.

{
  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;
}

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

getRawNames()

std::string MooseEnumBase::getRawNames

(

)

const

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.

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

Referenced by MooseEnum::assign(), MultiMooseEnum::assignValues(), AdvancedOutput::enableOutputTypes(), MooseEnum::operator==(), PiecewiseConstant::validParams(), and ComparisonPostprocessor::validParams().

isOutOfRangeAllowed()

bool MooseEnumBase::isOutOfRangeAllowed ( ) const

inline

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 MooseEnumBase::isValid ( ) const

pure virtual

IsValid.

Returns

- a Boolean indicating whether this Enumeration has been set

Implemented in MooseEnum, and MultiMooseEnum.

items()

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

inline

Return the complete set of available flags.

Definition at line 93 of file MooseEnumBase.h.

{ return _items; }

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

operator+=() [1/2]

MooseEnumBase & MooseEnumBase::operator+=

(

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

names

)

Adds enumeration items from a list of names.

Definition at line 224 of file MooseEnumBase.C.

{
  for (const auto & name : names)
    *this += name;
  return *this;
}

operator+=() [2/2]

MooseEnumBase & MooseEnumBase::operator+=

(

const std::string &

name

)

Adds an enumeration item from name.

Definition at line 216 of file MooseEnumBase.C.

{
  addEnumerationName(name);
  checkDeprecated();
  return *this;
}

Referenced by MultiMooseEnum::operator+=(), and MultiMooseEnum::operator+=().

operator=()

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

default

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

Member Data Documentation

_allow_out_of_range

bool MooseEnumBase::_allow_out_of_range

protected

Flag to enable enumeration items not previously defined.

Definition at line 163 of file MooseEnumBase.h.

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

_deprecated_items

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

protected

The map of deprecated names and optional replacements.

Definition at line 160 of file MooseEnumBase.h.

Referenced by checkDeprecated(), and deprecate().

_item_documentation

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

protected

The map of items and their respective documentation strings.

Definition at line 166 of file MooseEnumBase.h.

Referenced by addDocumentation(), and getItemDocumentation().

_items

std::set<MooseEnumItem> MooseEnumBase::_items

protected

Storage for the assigned items.

Definition at line 157 of file MooseEnumBase.h.

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

---

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

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