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

transfer strategy configuration, i.e. algorithm/combin. of quantity transfer steps and quantity interpretation (e.g. momentum vs. velocity). More...

#include <TransferStrategyConfiguration.h>

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

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

Public Types
enum	StrategyType {   DirectTransferStrategy = 0 , DifferenceTransferStrategy = 1 , TransferStrategy4FluxCoupling = 2 , TransferStrategy4SchwarzCoupling = 3 ,   AveragingTransferStrategy = 4 , TransferStrategy4NieCoupling = 5 }

Public Member Functions
	TransferStrategyConfiguration ()
virtual	~TransferStrategyConfiguration ()
void	parseSubtag (tinyxml2::XMLElement *node)
std::string	getTag () const
bool	isValid () const
template<class LinkedCell>
coupling::transferstrategies::TransferStrategy< LinkedCell, dim > *	interpreteConfiguration (coupling::interface::MDSolverInterface< LinkedCell, dim > *const mdSolverInterface, unsigned int numberOfMDTimesteps) const
StrategyType	getStrategyType () const
Public Member Functions inherited from tarch::configuration::Configuration
virtual	~Configuration ()

Protected Member Functions
	TransferStrategyConfiguration (StrategyType type, tarch::la::Vector< 2 *dim, bool > massFluxBoundary, double shiftTimestep)

Private Attributes
StrategyType	_type
tarch::la::Vector< 2 *dim, bool >	_massFluxBoundary
double	_shiftTimestep
bool	_isValid

Detailed Description

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

transfer strategy configuration, i.e. algorithm/combin. of quantity transfer steps and quantity interpretation (e.g. momentum vs. velocity).

transfer strategy configuration, i.e. algorithm/combin. of quantity transfer steps and quantity interpretation (e.g. momentum vs. velocity). Derive from the class tarch::configuration::Configuration

Template Parameters

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

Author

Philipp Neumann

Member Enumeration Documentation

StrategyType

template<unsigned int dim>

enum coupling::configurations::TransferStrategyConfiguration::StrategyType

transfer strategy types that are implemented.

Enumerator
DirectTransferStrategy	DirectTransferStrategy
DifferenceTransferStrategy	DifferenceTransferStrategy
TransferStrategy4FluxCoupling	TransferStrategy4FluxCoupling
TransferStrategy4SchwarzCoupling	TransferStrategy4SchwarzCoupling
AveragingTransferStrategy	AveragingTransferStrategy
TransferStrategy4NieCoupling	TransferStrategy4NieCoupling

Constructor & Destructor Documentation

TransferStrategyConfiguration()

template<unsigned int dim>

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

inline

Constructor, initializes the class

~TransferStrategyConfiguration()

template<unsigned int dim>

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

inlinevirtual

Destructor

Member Function Documentation

getStrategyType()

template<unsigned int dim>

StrategyType coupling::configurations::TransferStrategyConfiguration< dim >::getStrategyType ( ) const

inline

Returns the transfer strategy type.

Returns

_type

getTag()

template<unsigned int dim>

std::string coupling::configurations::TransferStrategyConfiguration< 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.

interpreteConfiguration()

template<unsigned int dim>

template<class LinkedCell>

coupling::transferstrategies::TransferStrategy< LinkedCell, dim > * coupling::configurations::TransferStrategyConfiguration< dim >::interpreteConfiguration ( coupling::interface::MDSolverInterface< LinkedCell, dim > *const mdSolverInterface, unsigned int numberOfMDTimesteps ) const

inline

Returns transfer strategy configuration.

Template Parameters

LinkedCell

type of the cell

Parameters

mdSolverInterface
numberOfMDTimesteps

Returns

transfer strategy config

isValid()

template<unsigned int dim>

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

inlinevirtual

checks if the configuration is valid. This operation usually fails, if e.g. 1. parseSubtag() hasn't been called, i.e. configuration has not been used, or 2. parseSubtag() failed due to a wrong file. 3. 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::TransferStrategyConfiguration< dim >::parseSubtag ( tinyxml2::XMLElement * node )

inlinevirtual

parseSubtag

Parameters

node

Implements tarch::configuration::Configuration.

---

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

• coupling/configurations/TransferStrategyConfiguration.h