coupling::configurations::MaMiCoConfiguration< dim > Class Template Reference

parses all sub-tags for MaMiCo configuration. More...

#include <MaMiCoConfiguration.h>

Inheritance diagram for coupling::configurations::MaMiCoConfiguration< dim >:

Collaboration diagram for coupling::configurations::MaMiCoConfiguration< dim >:

Public Member Functions
	MaMiCoConfiguration ()
virtual	~MaMiCoConfiguration ()
void	parseSubtag (tinyxml2::XMLElement *node)
std::string	getTag () const
bool	isValid () const
const coupling::configurations::CouplingCellConfiguration< dim > &	getCouplingCellConfiguration () const
const coupling::configurations::ParticleInsertionConfiguration &	getParticleInsertionConfiguration () const
const coupling::configurations::MomentumInsertionConfiguration &	getMomentumInsertionConfiguration () const
const coupling::configurations::BoundaryForceConfiguration< dim > &	getBoundaryForceConfiguration () const
const coupling::configurations::TransferStrategyConfiguration< dim > &	getTransferStrategyConfiguration () const
const coupling::configurations::ParallelTopologyConfiguration &	getParallelTopologyConfiguration () const
const coupling::configurations::TimeIntegrationConfiguration &	getTimeIntegrationConfiguration () const
const coupling::configurations::ThermostatConfiguration &	getThermostatConfiguration () const
Public Member Functions inherited from tarch::configuration::Configuration
virtual	~Configuration ()

Private Attributes
bool	_isValid
coupling::configurations::CouplingCellConfiguration< dim >	_couplingCellConfiguration
coupling::configurations::ParticleInsertionConfiguration	_particleInsertionConfiguration
coupling::configurations::MomentumInsertionConfiguration	_momentumInsertionConfiguration
coupling::configurations::BoundaryForceConfiguration< dim >	_boundaryForceConfiguration
coupling::configurations::TransferStrategyConfiguration< dim >	_transferStrategyConfiguration
coupling::configurations::ParallelTopologyConfiguration	_parallelTopologyConfiguration
coupling::configurations::TimeIntegrationConfiguration	_timeIntegrationConfiguration
coupling::configurations::ThermostatConfiguration	_thermostatConfiguration
bool	_isDefinedParticleInsertion
bool	_isDefinedMomentumInsertion
bool	_isDefinedBoundaryForce
bool	_isDefinedTransferStrategy
bool	_isDefinedParallelTopology
bool	_isDefinedThermostat

Detailed Description

template<unsigned int dim>
class coupling::configurations::MaMiCoConfiguration< dim >

parses all sub-tags for MaMiCo configuration.

parses all sub-tags for MaMiCo configuration. Derive from the class tarch::configuration::Configuration

Template Parameters

dim	Number of dimensions; it can be 1, 2 or 3

Author

Philipp Neumann

Constructor & Destructor Documentation

MaMiCoConfiguration()

template<unsigned int dim>

coupling::configurations::MaMiCoConfiguration< dim >::MaMiCoConfiguration ( )

inline

Constructor, initializes the class

~MaMiCoConfiguration()

template<unsigned int dim>

virtual coupling::configurations::MaMiCoConfiguration< dim >::~MaMiCoConfiguration ( )

inlinevirtual

Destructor

Member Function Documentation

getBoundaryForceConfiguration()

template<unsigned int dim>

const coupling::configurations::BoundaryForceConfiguration< dim > & coupling::configurations::MaMiCoConfiguration< dim >::getBoundaryForceConfiguration ( ) const

inline

Returns

_boundaryForceConfiguration

getCouplingCellConfiguration()

template<unsigned int dim>

const coupling::configurations::CouplingCellConfiguration< dim > & coupling::configurations::MaMiCoConfiguration< dim >::getCouplingCellConfiguration ( ) const

inline

Returns

_couplingCellConfiguration

getMomentumInsertionConfiguration()

template<unsigned int dim>

const coupling::configurations::MomentumInsertionConfiguration & coupling::configurations::MaMiCoConfiguration< dim >::getMomentumInsertionConfiguration ( ) const

inline

Returns

_momentumInsertionConfiguration

getParallelTopologyConfiguration()

template<unsigned int dim>

const coupling::configurations::ParallelTopologyConfiguration & coupling::configurations::MaMiCoConfiguration< dim >::getParallelTopologyConfiguration ( ) const

inline

Returns

_parallelTopologyConfiguration

getParticleInsertionConfiguration()

template<unsigned int dim>

const coupling::configurations::ParticleInsertionConfiguration & coupling::configurations::MaMiCoConfiguration< dim >::getParticleInsertionConfiguration ( ) const

inline

Returns

_particleInsertionConfiguration

getTag()

template<unsigned int dim>

std::string coupling::configurations::MaMiCoConfiguration< dim >::getTag ( ) const

inlinevirtual

Returns name of xml tag that is associated to the configuration.

Returns

name of xml tag that is associated to the configuration

Implements tarch::configuration::Configuration.

getThermostatConfiguration()

template<unsigned int dim>

const coupling::configurations::ThermostatConfiguration & coupling::configurations::MaMiCoConfiguration< dim >::getThermostatConfiguration ( ) const

inline

Returns

_thermostatConfiguration

getTimeIntegrationConfiguration()

template<unsigned int dim>

const coupling::configurations::TimeIntegrationConfiguration & coupling::configurations::MaMiCoConfiguration< dim >::getTimeIntegrationConfiguration ( ) const

inline

Returns

_timeIntegrationConfiguration

getTransferStrategyConfiguration()

template<unsigned int dim>

const coupling::configurations::TransferStrategyConfiguration< dim > & coupling::configurations::MaMiCoConfiguration< dim >::getTransferStrategyConfiguration ( ) const

inline

Returns

_transferStrategyConfiguration

isValid()

template<unsigned int dim>

bool coupling::configurations::MaMiCoConfiguration< dim >::isValid ( ) const

inlinevirtual

Is config valid?

This operation usually fails, if

• parseSubtag() hasn't been called, i.e. configuration has not been used, or
• parseSubtag() failed due to a wrong file.

If a tag ain't optional and parseSubtag() was not called (first case)

Returns

_isValid

Implements tarch::configuration::Configuration.

parseSubtag()

template<unsigned int dim>

void coupling::configurations::MaMiCoConfiguration< dim >::parseSubtag ( tinyxml2::XMLElement * node )

virtual

parseSubtag

Parameters

node

Implements tarch::configuration::Configuration.

---

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

• coupling/configurations/MaMiCoConfiguration.h