ChainControlDataSystem Class Reference

System that manages ChainControls. More...

#include <ChainControlDataSystem.h>

Public Member Functions
	ChainControlDataSystem (MooseApp &app)
bool	hasChainControlData (const std::string &data_name) const
	Queries if the chain control data of the given name exists.
template<typename T >
bool	hasChainControlDataOfType (const std::string &data_name) const
	Queries if the chain control data of the given name and type exists.
template<typename T >
ChainControlData< T > &	getChainControlData (const std::string &data_name)
	Gets the chain control data of the given name and type and creates if it does not exist.
template<typename T >
ChainControlData< T > &	declareChainControlData (const std::string &data_name, ChainControl &chain_control)
	Declares chain control data of of the given name and type and creates if it does not exist.
void	copyValuesBack ()
	Copies current chain control data values into old values.
const std::map< std::string, std::unique_ptr< ChainControlDataBase > > &	getChainControlDataMap () const
	Gets the map of ChainControlData names to the relevant ChainControlDataBase.
std::string	outputChainControlMap () const
	Output the chain control map to a string.

Private Attributes
MooseApp &	_app
	The MooseApp that owns this system.
std::map< std::string, std::unique_ptr< ChainControlDataBase > >	_chain_control_data_map
	Map of chain control data name to its value.

Detailed Description

System that manages ChainControls.

To be owned by the MooseApp.

Definition at line 23 of file ChainControlDataSystem.h.

Constructor & Destructor Documentation

ChainControlDataSystem()

ChainControlDataSystem::ChainControlDataSystem

(

MooseApp &

app

)

Definition at line 12 of file ChainControlDataSystem.C.

: _app(app) {}

Member Function Documentation

copyValuesBack()

void ChainControlDataSystem::copyValuesBack

(

)

Copies current chain control data values into old values.

Definition at line 21 of file ChainControlDataSystem.C.

{
  for (const auto & item : _chain_control_data_map)
    item.second->copyValuesBack();
}

Referenced by ChainControlSetupAction::act(), and FEProblemBase::advanceState().

declareChainControlData()

template<typename T >

ChainControlData< T > & ChainControlDataSystem::declareChainControlData	(	const std::string &	data_name,
		ChainControl &	chain_control
	)

Declares chain control data of of the given name and type and creates if it does not exist.

If the data has already been declared, an error is thrown; otherwise the data is now set to be declared, and the declaring ChainControl is captured.

Template Parameters

T	Type of the data

Parameters

[in]	data_name	Chain control data name
[in]	chain_control	Chain control that is declaring the data

Returns

Reference to the declared chain control data

Definition at line 129 of file ChainControlDataSystem.h.

{
  auto & data = getChainControlData<T>(data_name);
  if (!data.getDeclared())
  {
    data.setDeclared();
    data.setChainControl(chain_control);
  }
  else
    mooseError("The chain control data '", data_name, "' has already been declared.");
 
  return data;
}

Referenced by ChainControl::declareChainControlData().

getChainControlData()

template<typename T >

ChainControlData< T > & ChainControlDataSystem::getChainControlData

(

const std::string &

data_name

)

Gets the chain control data of the given name and type and creates if it does not exist.

If the data exists but of another type, then an error is thrown.

Template Parameters

T	Type of the data

Parameters

[in]

data_name

Chain control data name

Returns

Reference to the requested chain control data

Definition at line 108 of file ChainControlDataSystem.h.

{
  if (hasChainControlData(data_name))
  {
    if (!hasChainControlDataOfType<T>(data_name))
      mooseError("The chain control data '",
                 data_name,
                 "' was requested with the type '",
                 MooseUtils::prettyCppType<T>(),
                 "' but has the type '",
                 _chain_control_data_map[data_name]->type(),
                 "'.");
  }
  else
    _chain_control_data_map[data_name] = std::make_unique<ChainControlData<T>>(_app, data_name);
 
  return static_cast<ChainControlData<T> &>(*_chain_control_data_map[data_name]);
}

Referenced by ChainControl::getChainControlDataOldByName(), and ChainControlParsedFunctionWrapper::initializeFunctionInputs().

getChainControlDataMap()

const std::map< std::string, std::unique_ptr< ChainControlDataBase > > & ChainControlDataSystem::getChainControlDataMap

(

)

const

Gets the map of ChainControlData names to the relevant ChainControlDataBase.

Definition at line 28 of file ChainControlDataSystem.C.

{
  return _chain_control_data_map;
}

Referenced by ChainControlSetupAction::act().

hasChainControlData()

bool ChainControlDataSystem::hasChainControlData

(

const std::string &

data_name

)

const

Queries if the chain control data of the given name exists.

Parameters

[in]

data_name

Chain control data name

Returns

True if the chain control data of the given name exists

Definition at line 15 of file ChainControlDataSystem.C.

{
  return _chain_control_data_map.find(data_name) != _chain_control_data_map.end();
}

Referenced by getChainControlData(), and hasChainControlDataOfType().

hasChainControlDataOfType()

template<typename T >

bool ChainControlDataSystem::hasChainControlDataOfType

(

const std::string &

data_name

)

const

Queries if the chain control data of the given name and type exists.

Template Parameters

T	Type of the data

Parameters

[in]

data_name

Chain control data name

Returns

True if the chain control data of the given name and type exists

Definition at line 97 of file ChainControlDataSystem.h.

{
  if (hasChainControlData(data_name))
    return dynamic_cast<ChainControlData<T> *>(_chain_control_data_map.at(data_name).get()) !=
           nullptr;
  else
    return false;
}

Referenced by ChainControlParsedFunctionWrapper::initializeFunctionInputs().

outputChainControlMap()

std::string ChainControlDataSystem::outputChainControlMap

(

)

const

Output the chain control map to a string.

Definition at line 34 of file ChainControlDataSystem.C.

{
  std::string map_str = "Chain control data:\n";
  for (const auto & item : _chain_control_data_map)
  {
    map_str += item.first + " (" + item.second->type() + ") declared? " +
               (item.second->getDeclared() ? "true" : "false");
    if (const auto ctl_real = dynamic_cast<ChainControlData<Real> *>(item.second.get()))
      map_str += ". Current value: " + std::to_string(ctl_real->get());
    else if (const auto ctl_bool = dynamic_cast<ChainControlData<bool> *>(item.second.get()))
      map_str += ". Current value: " + std::to_string(ctl_bool->get());
    else
      mooseWarning("Chain control data output has not been enabled for this this data type: ",
                   item.second->type());
    map_str += "\n";
  }
 
  return map_str;
}

Referenced by ChainControlSetupAction::act(), SubProblem::initialSetup(), and SubProblem::timestepSetup().

Member Data Documentation

_app

MooseApp& ChainControlDataSystem::_app

private

The MooseApp that owns this system.

Definition at line 89 of file ChainControlDataSystem.h.

Referenced by getChainControlData().

_chain_control_data_map

std::map<std::string, std::unique_ptr<ChainControlDataBase> > ChainControlDataSystem::_chain_control_data_map

private

Map of chain control data name to its value.

Definition at line 92 of file ChainControlDataSystem.h.

Referenced by copyValuesBack(), getChainControlData(), getChainControlDataMap(), hasChainControlData(), hasChainControlDataOfType(), and outputChainControlMap().

---

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

• include/base/ChainControlDataSystem.h
• src/base/ChainControlDataSystem.C