ExecFlagEnum Class Reference

A MultiMooseEnum object to hold "execute_on" flags. More...

#include <ExecFlagEnum.h>

Inheritance diagram for ExecFlagEnum:

Public Member Functions
	ExecFlagEnum ()
	ExecFlagEnum (const ExecFlagEnum &other)
	ExecFlagEnum (const MultiMooseEnum &other)
ExecFlagEnum &	operator= (const ExecFlagEnum &other)=default
std::string	getDocString () const
	Generate a documentation string for the "execute_on" parameter. More...
const std::set< ExecFlagType > &	items () const
	Reference the all the available items. 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...
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...
template<typename... Args>
void	addAvailableFlags (const ExecFlagType &flag, Args... flags)
	Add additional execute_on flags to the list of possible flags. More...
const ExecFlagType &	addAvailableFlags (const ExecFlagType &flag)
ExecFlagEnum &	operator= (const std::initializer_list< ExecFlagType > &flags)
ExecFlagEnum &	operator= (const ExecFlagType &flags)
ExecFlagEnum &	operator+= (const std::initializer_list< ExecFlagType > &flags)
ExecFlagEnum &	operator+= (const ExecFlagType &flags)
MultiMooseEnum &	operator= (const MultiMooseEnum &other_enum)=default
	Assignment operators for setting the current flags. More...
MultiMooseEnum &	operator= (const std::string &names)
	Assignment operators for setting the current flags. More...
MultiMooseEnum &	operator= (const std::vector< std::string > &names)
	Assignment operators for setting the current flags. More...
MultiMooseEnum &	operator= (const std::set< std::string > &names)
	Assignment operators for setting the current flags. More...
template<typename... Args>
void	removeAvailableFlags (const ExecFlagType &flag, Args... flags)
	Remove flags from being available. More...
void	removeAvailableFlags (const ExecFlagType &flag)
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
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
void	appendCurrent (const ExecFlagType &item)
	Append the list of current flags. More...
virtual void	checkDeprecated () const override
	Check whether any of the current values are deprecated when called. More...
void	checkDeprecated (const MooseEnumItem &item) const
	Check and warn deprecated values. 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...
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...

Detailed Description

A MultiMooseEnum object to hold "execute_on" flags.

This object allows available flags to be added or removed thus each object can control the flags that are available.

Definition at line 21 of file ExecFlagEnum.h.

Constructor & Destructor Documentation

ExecFlagEnum() [1/3]

ExecFlagEnum::ExecFlagEnum

(

)

Definition at line 15 of file ExecFlagEnum.C.

: MultiMooseEnum() {}

ExecFlagEnum() [2/3]

ExecFlagEnum::ExecFlagEnum

(

const ExecFlagEnum &

other

)

Definition at line 17 of file ExecFlagEnum.C.

: MultiMooseEnum(other) {}

ExecFlagEnum() [3/3]

ExecFlagEnum::ExecFlagEnum

(

const MultiMooseEnum &

other

)

Definition at line 16 of file ExecFlagEnum.C.

: MultiMooseEnum(other) {}

Member Function Documentation

addAvailableFlags() [1/2]

template<typename... Args>

void ExecFlagEnum::addAvailableFlags	(	const ExecFlagType &	flag,
		Args...	flags
	)

Add additional execute_on flags to the list of possible flags.

Use a recursive variadic template function to allow for an arbitrary number arguments: addAvaiableFlags(EXEC_INITIAL); addAvaiableFlags(EXEC_INITIAL, EXEC_TIMESTEP_END);

Definition at line 82 of file ExecFlagEnum.h.

Referenced by AdvancedOutput::addValidParams(), Output::getDefaultExecFlagEnum(), moose::internal::ExecFlagRegistry::registerFlag(), FunctorMaterial::validParams(), SpatialUserObjectFunctor< ElementIntegralVariableUserObject >::validParams(), Postprocessor::validParams(), MultiAppTransfer::validParams(), Control::validParams(), Sampler::validParams(), AuxKernelTempl< Real >::validParams(), and MultiApp::validParams().

{
  addAvailableFlags(flag);
  addAvailableFlags(flags...);
}

addAvailableFlags() [2/2]

const ExecFlagType & ExecFlagEnum::addAvailableFlags

(

const ExecFlagType &

flag

)

Definition at line 20 of file ExecFlagEnum.C.

{
  return addEnumerationItem(flag);
}

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 addAvailableFlags(), MooseEnumBase::addEnumerationName(), MultiMooseEnum::addValidName(), MultiMooseEnum::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 MooseEnumBase::addEnumerationNames(), MultiMooseEnum::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 )

inherited

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

Definition at line 341 of file MultiMooseEnum.C.

Referenced by MultiMooseEnum::addValidName().

{
  addEnumerationName(name);
  checkDeprecated();
}

addValidName() [2/3]

void MultiMooseEnum::addValidName ( const std::initializer_list< std::string > &  names )

inherited

Definition at line 355 of file MultiMooseEnum.C.

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

addValidName() [3/3]

void MultiMooseEnum::addValidName ( const MultiMooseEnum &  names )

inherited

Definition at line 369 of file MultiMooseEnum.C.

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

appendCurrent()

void ExecFlagEnum::appendCurrent ( const ExecFlagType &  item )

protected

Append the list of current flags.

Definition at line 83 of file ExecFlagEnum.C.

Referenced by operator+=().

{
  if (find(item) == _items.end())
    mooseError("The supplied item '",
               item,
               "' is not an available item for the "
               "ExecFlagEnum object, thus it cannot be set as current.");
  _current_values.push_back(item);
}

assignValues()

template<typename InputIterator >

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

protectedinherited

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 MultiMooseEnum::operator=(), and MultiMooseEnum::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

inlineinherited

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(), MultiMooseEnum::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

overrideprotectedvirtualinherited

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

Implements MooseEnumBase.

Definition at line 327 of file MultiMooseEnum.C.

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

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

clear()

void MultiMooseEnum::clear ( )

inherited

Definition at line 314 of file MultiMooseEnum.C.

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

clearSetValues()

void MultiMooseEnum::clearSetValues ( )

inherited

Clear the MultiMooseEnum.

Definition at line 308 of file MultiMooseEnum.C.

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

{
  _current_values.clear();
}

contains() [1/5]

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

inlineinherited

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

inlineinherited

Definition at line 103 of file MultiMooseEnum.h.

{ return isValueSet(value); }

contains() [3/5]

bool MultiMooseEnum::contains ( unsigned short  value ) const

inlineinherited

Definition at line 104 of file MultiMooseEnum.h.

{ return isValueSet(value); }

contains() [4/5]

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

inlineinherited

Definition at line 105 of file MultiMooseEnum.h.

{ return isValueSet(value); }

contains() [5/5]

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

inlineinherited

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

inlineinherited

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(), MultiMooseEnum::setAdditionalValue(), and VectorMagnitudeFunctorMaterialTempl< is_ad >::VectorMagnitudeFunctorMaterialTempl().

{ return _current_values.end(); }

erase() [1/3]

void MultiMooseEnum::erase ( const std::string &  names )

inherited

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 )

inherited

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 )

inherited

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 )

inherited

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 MultiMooseEnum::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 )

inherited

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 )

inherited

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(), appendCurrent(), MooseEnum::assign(), MultiMooseEnum::assignValues(), MooseEnumBase::deprecate(), FVAdvection::FVAdvection(), MooseEnum::operator==(), moose::internal::ExecFlagRegistry::registerFlag(), removeAvailableFlags(), CreateExecutionerAction::setupAutoPreconditioning(), and ReadExecutorParamsAction::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

inherited

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

getDocString()

std::string ExecFlagEnum::getDocString

(

)

const

Generate a documentation string for the "execute_on" parameter.

Definition at line 40 of file ExecFlagEnum.C.

Referenced by CommonOutputAction::validParams(), SetupInterface::validParams(), Output::validParams(), and AuxKernelTempl< Real >::validParams().

{
  std::string doc("The list of flag(s) indicating when this object should be executed. For a "
                  "description of each flag, see ");
  doc += MooseUtils::mooseDocsURL("source/interfaces/SetupInterface.html");
  doc += ".";
  return doc;
}

getEnum()

template<typename T >

std::vector< T > MultiMooseEnum::getEnum ( ) const

inherited

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(), MultiMooseEnum::addValidName(), MooseEnum::assign(), MultiMooseEnum::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(), MultiMooseEnum::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

inherited

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

inlineoverridevirtualinherited

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

inherited

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(), MultiMooseEnum::contains(), IterationInfo::declareHelper(), MeshInfo::declareHelper(), EigenExecutionerBase::init(), MultiAppReporterTransfer::initialSetup(), IntegralPreservingFunctionIC::initialSetup(), MultiAppVariableValueSamplePostprocessorTransfer::initialSetup(), Console::initialSetup(), EigenExecutionerBase::inversePowerIteration(), MultiMooseEnum::isValueSet(), MultiAppReporterTransfer::MultiAppReporterTransfer(), MultiAppVariableValueSamplePostprocessorTransfer::MultiAppVariableValueSamplePostprocessorTransfer(), MultiMooseEnum::operator==(), Console::output(), JSONOutput::outputReporters(), Console::outputSystemInformation(), XMLOutput::outputVectorPostprocessors(), MeshInfo::possiblyAddSidesetInfo(), MeshInfo::possiblyAddSubdomainInfo(), EigenExecutionerBase::postExecute(), removeAvailableFlags(), MultiAppVariableValueSamplePostprocessorTransfer::setupPostprocessorCommunication(), PerfGraphOutput::shouldOutput(), Output::shouldOutput(), FEProblemBase::shouldPrintExecution(), NodalReporter::shouldStore(), ElementReporter::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

inherited

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

inherited

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

inherited

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

inherited

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<ExecFlagType>& ExecFlagEnum::items ( ) const

inline

Reference the all the available items.

Definition at line 71 of file ExecFlagEnum.h.

Referenced by ExecuteMooseObjectWarehouse< Transfer >::ExecuteMooseObjectWarehouse(), groupUserObjects(), EigenExecutionerBase::normalizeSolution(), and moose::internal::ExecFlagRegistry::registerFlag().

{ return _items; }

operator!=()

bool MultiMooseEnum::operator!= ( const MultiMooseEnum &  value ) const

inherited

Definition at line 70 of file MultiMooseEnum.C.

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

operator+=() [1/4]

ExecFlagEnum & ExecFlagEnum::operator+=

(

const std::initializer_list< ExecFlagType > &

flags

)

Definition at line 66 of file ExecFlagEnum.C.

{
  for (const ExecFlagType & flag : flags)
    appendCurrent(flag);
  checkDeprecated();
  return *this;
}

operator+=() [2/4]

ExecFlagEnum & ExecFlagEnum::operator+=

(

const ExecFlagType &

flags

)

Definition at line 75 of file ExecFlagEnum.C.

{
  appendCurrent(flag);
  checkDeprecated();
  return *this;
}

operator+=() [3/4]

MooseEnumBase & MultiMooseEnum::operator+= ( const std::string &  name )

inherited

Definition at line 348 of file MultiMooseEnum.C.

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

operator+=() [4/4]

MooseEnumBase & MultiMooseEnum::operator+= ( const std::initializer_list< std::string > &  names )

inherited

Definition at line 362 of file MultiMooseEnum.C.

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

operator=() [1/7]

ExecFlagEnum& ExecFlagEnum::operator= ( const ExecFlagEnum &  other )

default

operator=() [2/7]

MultiMooseEnum& MultiMooseEnum::operator=

default

Assignment operators for setting the current flags.

operator=() [3/7]

MultiMooseEnum & MultiMooseEnum::operator=

Assignment operators for setting the current flags.

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=() [4/7]

MultiMooseEnum & MultiMooseEnum::operator=

Assignment operators for setting the current flags.

Definition at line 135 of file MultiMooseEnum.C.

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

operator=() [5/7]

MultiMooseEnum & MultiMooseEnum::operator=

Assignment operators for setting the current flags.

Definition at line 129 of file MultiMooseEnum.C.

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

operator=() [6/7]

ExecFlagEnum & ExecFlagEnum::operator=

(

const std::initializer_list< ExecFlagType > &

flags

)

Definition at line 50 of file ExecFlagEnum.C.

{
  clearSetValues();
  *this += flags;
  return *this;
}

operator=() [7/7]

ExecFlagEnum & ExecFlagEnum::operator=

(

const ExecFlagType &

flags

)

Definition at line 58 of file ExecFlagEnum.C.

{
  clearSetValues();
  *this += flag;
  return *this;
}

operator==()

bool MultiMooseEnum::operator== ( const MultiMooseEnum &  value ) const

inherited

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

inherited

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 )

inherited

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 )

inherited

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 )

inherited

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 )

inherited

Definition at line 232 of file MultiMooseEnum.C.

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

removeAvailableFlags() [1/2]

template<typename... Args>

void ExecFlagEnum::removeAvailableFlags	(	const ExecFlagType &	flag,
		Args...	flags
	)

Remove flags from being available.

Definition at line 90 of file ExecFlagEnum.h.

Referenced by PropertyReadFile::validParams().

{
  removeAvailableFlags(flag);
  removeAvailableFlags(flags...);
}

removeAvailableFlags() [2/2]

void ExecFlagEnum::removeAvailableFlags

(

const ExecFlagType &

flag

)

Definition at line 26 of file ExecFlagEnum.C.

{
  if (find(flag) == _items.end())
    mooseError("The supplied item '",
               flag,
               "' is not an available enum item for the "
               "MultiMooseEnum object, thus it cannot be removed.");
  else if (isValueSet(flag))
    mooseError("The supplied item '", flag, "' is a selected item, thus it can not be removed.");

  _items.erase(flag);
}

removeSetValues()

template<typename InputIterator >

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

protectedinherited

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 MultiMooseEnum::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 )

inherited

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 MultiMooseEnum::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 )

inherited

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 )

inherited

Definition at line 212 of file MultiMooseEnum.C.

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

setAdditionalValue() [4/4]

void MultiMooseEnum::setAdditionalValue ( const MultiMooseEnum &  other_enum )

inherited

Definition at line 226 of file MultiMooseEnum.C.

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

size()

unsigned int MultiMooseEnum::size ( ) const

inherited

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(), MultiMooseEnum::operator==(), PiecewiseMulticonstant::PiecewiseMulticonstant(), RefineSidesetGenerator::RefineSidesetGenerator(), MooseMesh::setCoordSystem(), Moose::Builder::setVectorParameter(), SidesetInfoVectorPostprocessor::SidesetInfoVectorPostprocessor(), and Transfer::Transfer().

{
  return _current_values.size();
}

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(), MultiMooseEnum::assignValues(), MooseEnumBase::isOutOfRangeAllowed(), and MooseEnum::operator==().

_current_values

std::vector<MooseEnumItem> MultiMooseEnum::_current_values

protectedinherited

The current value(s) of the MultiMooseEnum.

Definition at line 278 of file MultiMooseEnum.h.

Referenced by appendCurrent(), MultiMooseEnum::assignValues(), MultiMooseEnum::begin(), MultiMooseEnum::checkDeprecated(), MultiMooseEnum::clearSetValues(), MultiMooseEnum::end(), MultiMooseEnum::get(), MultiMooseEnum::getSetValueIDs(), MultiMooseEnum::isValid(), MultiMooseEnum::isValueSet(), operator<<(), MultiMooseEnum::operator[](), MultiMooseEnum::removeSetValues(), and MultiMooseEnum::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(), MultiMooseEnum::addValidName(), appendCurrent(), MooseEnum::assign(), MultiMooseEnum::assignValues(), ReporterProducerEnum::clear(), MooseEnumBase::deprecate(), MooseEnumBase::find(), MooseEnumBase::getIDs(), MooseEnumBase::getNames(), MooseEnumBase::getNextValidID(), MooseEnumBase::getRawNames(), items(), MooseEnumBase::items(), MooseEnum::operator==(), and removeAvailableFlags().

---

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

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