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

reads boundary force tag More...

#include <BoundaryForceConfiguration.h>

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

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

Public Types
enum	BoundaryForceType { ZHOU = 0 , NO_BOUNDARYFORCE = 1 }

Public Member Functions
	BoundaryForceConfiguration ()
virtual	~BoundaryForceConfiguration ()
void	parseSubtag (tinyxml2::XMLElement *node)
std::string	getTag () const
bool	isValid () const
const BoundaryForceType &	getBoundaryForceType () const
const tarch::la::Vector< 2 *dim, bool > &	getBoundary () const
template<class LinkedCell>
coupling::BoundaryForceController< LinkedCell, dim > *	interpreteConfiguration (coupling::interface::MDSolverInterface< LinkedCell, dim > *const mdSolverInterface) const
Public Member Functions inherited from tarch::configuration::Configuration
virtual	~Configuration ()

Protected Member Functions
	BoundaryForceConfiguration (BoundaryForceType insertionType, double density, double temperature, tarch::la::Vector< 2 *dim, bool > boundary)

Private Attributes
BoundaryForceType	_insertionType
double	_density
double	_temperature
tarch::la::Vector< 2 *dim, bool >	_boundary
bool	_isValid

Detailed Description

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

reads boundary force tag

boundary force configuration

Template Parameters

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

Author

Philipp Neumann

Member Enumeration Documentation

BoundaryForceType

template<unsigned int dim>

enum coupling::configurations::BoundaryForceConfiguration::BoundaryForceType

boundary force types that are implemented.

Enumerator
ZHOU	ZHOU
NO_BOUNDARYFORCE	NO_BOUNDARYFORCE

Constructor & Destructor Documentation

BoundaryForceConfiguration()

template<unsigned int dim>

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

inline

Constructor, initializes the class

~BoundaryForceConfiguration()

template<unsigned int dim>

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

inlinevirtual

Destructor

Member Function Documentation

getBoundary()

template<unsigned int dim>

const tarch::la::Vector< 2 *dim, bool > & coupling::configurations::BoundaryForceConfiguration< dim >::getBoundary ( ) const

inline

Returns boundary ??

Returns

_boundary

getBoundaryForceType()

template<unsigned int dim>

const BoundaryForceType & coupling::configurations::BoundaryForceConfiguration< dim >::getBoundaryForceType ( ) const

inline

Returns boundary force type.

Returns

_insertionType

getTag()

template<unsigned int dim>

std::string coupling::configurations::BoundaryForceConfiguration< 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::BoundaryForceController< LinkedCell, dim > * coupling::configurations::BoundaryForceConfiguration< dim >::interpreteConfiguration ( coupling::interface::MDSolverInterface< LinkedCell, dim > *const mdSolverInterface ) const

inline

Returns boundary force configuration.

Template Parameters

LinkedCell

type of the cell

Parameters

mdSolverInterface

Returns

boundary force config

isValid()

template<unsigned int dim>

bool coupling::configurations::BoundaryForceConfiguration< 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::BoundaryForceConfiguration< 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/BoundaryForceConfiguration.h