ControllableAlias Class Reference

Allows for aliases to be defined via InputParameterWarehouse::addControllableParameterAlias. More...

#include <ControllableItem.h>

Inheritance diagram for ControllableAlias:

Public Member Functions
	ControllableAlias (const MooseObjectParameterName &name, ControllableItem *)
virtual const MooseObjectParameterName &	name () const override
	Return the name of the master parameter. More...
virtual std::string	dump (unsigned int indent=0) const override
	Returns a string displaying the parameter name and current value. More...
void	connect (ControllableItem *item, bool type_check=true)
	Connects the supplied item with this item to allow for multiple parameters to be changed by one. More...
template<typename T >
void	set (const T &value, bool type_check=true)
	Set the value(s) of the controlled parameters stored in this class. More...
template<typename T >
std::vector< T >	get (bool type_check=true) const
	Return a copy of all values for this "item". More...
template<typename T >
bool	check () const
	Return true if the template argument is valid for ALL items. More...
std::string	type () const
	Return the type of the master parameter. More...
const std::set< ExecFlagType > &	getExecuteOnFlags () const
	Return the execute flag restrictions, an empty set is un-restricted. More...
bool	operator== (const ControllableItem &rhs) const
	Use the master name for comparison operators to allow object to work within a set/map. More...
bool	operator!= (const ControllableItem &rhs) const
bool	operator< (const ControllableItem &rhs) const
void	resetChanged ()
	Methods for ControlOutput::outputChangedControls, these don't have meaning outside of this function. More...
bool	isChanged ()

Protected Attributes
std::vector< std::pair< MooseObjectParameterName, libMesh::Parameters::Value * > >	_pairs
	List of names for this item. More...
bool	_changed = false
	Flag for ControlOutput, allows output objects to keep track of when a parameter is altered. More...
std::set< ExecFlagType >	_execute_flags
	Flags to which the control is restricted (if not set it is unrestricted) More...

Private Attributes
MooseObjectParameterName	_name

Detailed Description

Allows for aliases to be defined via InputParameterWarehouse::addControllableParameterAlias.

Definition at line 190 of file ControllableItem.h.

Constructor & Destructor Documentation

ControllableAlias()

ControllableAlias::ControllableAlias	(	const MooseObjectParameterName &	name,
		ControllableItem *	item
	)

Definition at line 78 of file ControllableItem.C.

  : ControllableItem(), _name(name)
{
  connect(item, false);
}

Member Function Documentation

check()

template<typename T >

bool ControllableItem::check ( ) const

inherited

Return true if the template argument is valid for ALL items.

Definition at line 175 of file ControllableItem.h.

{
  return std::all_of(_pairs.begin(),
                     _pairs.end(),
                     [](std::pair<MooseObjectParameterName, libMesh::Parameters::Value *> pair)
                     {
                       libMesh::Parameters::Parameter<T> * param =
                           dynamic_cast<libMesh::Parameters::Parameter<T> *>(pair.second);
                       return param != nullptr;
                     });
}

connect()

void ControllableItem::connect ( ControllableItem *  item, bool  type_check = true  )

inherited

Connects the supplied item with this item to allow for multiple parameters to be changed by one.

Definition at line 24 of file ControllableItem.C.

Referenced by ControllableAlias().

{
  for (const auto & pair : item->_pairs)
  {
    if (type_check && type() != pair.second->type())
      mooseError("The master parameter (",
                 name(),
                 ") has a type '",
                 type(),
                 "' and cannot be connected to the parameter (",
                 pair.first,
                 ") with a different type of '",
                 pair.second->type(),
                 "'.");

    _pairs.emplace_back(pair.first, pair.second);
  }
}

dump()

std::string ControllableAlias::dump ( unsigned int  indent = 0 ) const

overridevirtual

Returns a string displaying the parameter name and current value.

Reimplemented from ControllableItem.

Definition at line 91 of file ControllableItem.C.

{
  // The output stream
  std::ostringstream oss;
  oss << ConsoleUtils::indent(indent) << COLOR_GREEN << _name << COLOR_DEFAULT;
  for (const auto & pair : _pairs)
  {
    oss << ConsoleUtils::indent(indent + 2) << COLOR_YELLOW << pair.first << COLOR_DEFAULT << " = ";
    pair.second->print(oss);
    oss << " <" << pair.second->type() << ">\n";
  }
  return oss.str();
}

get()

template<typename T >

std::vector< T > ControllableItem::get ( bool  type_check = true ) const

inherited

Return a copy of all values for this "item".

Definition at line 153 of file ControllableItem.h.

{
  std::vector<T> output;
  output.reserve(_pairs.size());
  for (const auto & pair : _pairs)
  {
    libMesh::Parameters::Parameter<T> * param =
        dynamic_cast<libMesh::Parameters::Parameter<T> *>(pair.second);
    if (type_check && param == nullptr)
      mooseError("Failed to get the '",
                 pair.first,
                 "' parameter the supplied template argument must be of type '",
                 pair.second->type(),
                 "'.");
    else if (param != nullptr)
      output.push_back(param->get());
  }
  return output;
}

getExecuteOnFlags()

const std::set<ExecFlagType>& ControllableItem::getExecuteOnFlags ( ) const

inlineinherited

Return the execute flag restrictions, an empty set is un-restricted.

Definition at line 108 of file ControllableItem.h.

{ return _execute_flags; }

isChanged()

bool ControllableItem::isChanged ( )

inlineinherited

Definition at line 102 of file ControllableItem.h.

{ return _changed; }

name()

const MooseObjectParameterName & ControllableAlias::name ( ) const

overridevirtual

Return the name of the master parameter.

Reimplemented from ControllableItem.

Definition at line 85 of file ControllableItem.C.

{
  return _name;
}

operator!=()

bool ControllableItem::operator!= ( const ControllableItem &  rhs ) const

inlineinherited

Definition at line 77 of file ControllableItem.h.

{ return name() != rhs.name(); }

operator<()

bool ControllableItem::operator< ( const ControllableItem &  rhs ) const

inlineinherited

Definition at line 78 of file ControllableItem.h.

{ return name() < rhs.name(); }

operator==()

bool ControllableItem::operator== ( const ControllableItem &  rhs ) const

inlineinherited

Use the master name for comparison operators to allow object to work within a set/map.

Definition at line 76 of file ControllableItem.h.

{ return name() == rhs.name(); }

resetChanged()

void ControllableItem::resetChanged ( )

inlineinherited

Methods for ControlOutput::outputChangedControls, these don't have meaning outside of this function.

Definition at line 101 of file ControllableItem.h.

{ _changed = false; }

set()

template<typename T >

void ControllableItem::set ( const T &  value, bool  type_check = true  )

inherited

Set the value(s) of the controlled parameters stored in this class.

The 'skip_type_check' flag allows this object to work with ControllableParameter that can store values of varying types.

Definition at line 131 of file ControllableItem.h.

{
  for (auto & pair : _pairs)
  {
    libMesh::Parameters::Parameter<T> * param =
        dynamic_cast<libMesh::Parameters::Parameter<T> *>(pair.second);
    if (type_check && param == nullptr)
      mooseError("Failed to set the '",
                 pair.first,
                 "' parameter the supplied template argument must be of type '",
                 pair.second->type(),
                 "'.");
    else if (param != nullptr)
    {
      param->set() = value;
      _changed = true;
    }
  }
}

type()

std::string ControllableItem::type ( ) const

inherited

Return the type of the master parameter.

Definition at line 67 of file ControllableItem.C.

Referenced by ControllableItem::connect().

{
  return _pairs[0].second->type();
}

Member Data Documentation

_changed

bool ControllableItem::_changed = false

protectedinherited

Flag for ControlOutput, allows output objects to keep track of when a parameter is altered.

Definition at line 123 of file ControllableItem.h.

Referenced by ControllableItem::isChanged(), ControllableItem::resetChanged(), and ControllableItem::set().

_execute_flags

std::set<ExecFlagType> ControllableItem::_execute_flags

protectedinherited

Flags to which the control is restricted (if not set it is unrestricted)

Definition at line 126 of file ControllableItem.h.

Referenced by ControllableItem::getExecuteOnFlags().

_name

MooseObjectParameterName ControllableAlias::_name

private

Definition at line 198 of file ControllableItem.h.

Referenced by dump(), and name().

_pairs

std::vector<std::pair<MooseObjectParameterName, libMesh::Parameters::Value *> > ControllableItem::_pairs

protectedinherited

List of names for this item.

Definition at line 120 of file ControllableItem.h.

Referenced by ControllableItem::check(), ControllableItem::connect(), ControllableItem::ControllableItem(), ControllableItem::dump(), dump(), ControllableItem::get(), ControllableItem::name(), ControllableItem::set(), and ControllableItem::type().

---

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

• include/controls/ControllableItem.h
• src/controls/ControllableItem.C