coupling::configurations::MomentumInsertionConfiguration Class Reference

momentum insertion configuration. friend class: NieTest More...

#include <MomentumInsertionConfiguration.h>

Inheritance diagram for coupling::configurations::MomentumInsertionConfiguration:

Collaboration diagram for coupling::configurations::MomentumInsertionConfiguration:

Public Types
enum	MomentumInsertionType {   ADDITIVE_MOMENTUM_INSERTION = 0 , DIRECT_VELOCITY_INSERTION = 1 , VELOCITY_GRADIENT_RELAXATION = 2 , NO_INSERTION = 3 ,   VELOCITY_GRADIENT_RELAXATION_TOPONLY = 4 , NIE_VELOCITY_IMPOSITION = 5 }

Public Member Functions
	MomentumInsertionConfiguration ()
virtual	~MomentumInsertionConfiguration ()
void	parseSubtag (tinyxml2::XMLElement *node)
std::string	getTag () const
bool	isValid () const
const MomentumInsertionType &	getMomentumInsertionType () const
unsigned int	getInnerOverlap () const
template<class LinkedCell, unsigned int dim>
MomentumInsertion< LinkedCell, dim > *	interpreteConfiguration (coupling::interface::MDSolverInterface< LinkedCell, dim > *const mdSolverInterface, const coupling::datastructures::CouplingCellWithLinkedCells< LinkedCell, dim > *const couplingCells, unsigned int numberMDTimestepsPerCouplingCycle) const
Public Member Functions inherited from tarch::configuration::Configuration
virtual	~Configuration ()

Protected Member Functions
	MomentumInsertionConfiguration (MomentumInsertionType insertionType)

Private Attributes
MomentumInsertionType	_insertionType
double	_velocityRelaxationFactor
unsigned int	_innerOverlap
unsigned int	_outerOverlap
bool	_isValid

Friends
class	::NieTest

Detailed Description

momentum insertion configuration. friend class: NieTest

momentum insertion configuration. friend class: NieTest

Author

Philipp Neumann

Member Enumeration Documentation

MomentumInsertionType

enum coupling::configurations::MomentumInsertionConfiguration::MomentumInsertionType

momentum insertion types that are implemented.

Enumerator
ADDITIVE_MOMENTUM_INSERTION	ADDITIVE_MOMENTUM_INSERTION
DIRECT_VELOCITY_INSERTION	DIRECT_VELOCITY_INSERTION
VELOCITY_GRADIENT_RELAXATION	VELOCITY_GRADIENT_RELAXATION
NO_INSERTION	NO_INSERTION
VELOCITY_GRADIENT_RELAXATION_TOPONLY	VELOCITY_GRADIENT_RELAXATION_TOPONLY
NIE_VELOCITY_IMPOSITION	NIE_VELOCITY_IMPOSITION

Constructor & Destructor Documentation

MomentumInsertionConfiguration()

coupling::configurations::MomentumInsertionConfiguration::MomentumInsertionConfiguration ( )

inline

Constructor, initializes the class

~MomentumInsertionConfiguration()

virtual coupling::configurations::MomentumInsertionConfiguration::~MomentumInsertionConfiguration ( )

inlinevirtual

Destructor

Member Function Documentation

getInnerOverlap()

unsigned int coupling::configurations::MomentumInsertionConfiguration::getInnerOverlap ( ) const

inline

Returns

_innerOverlap

getMomentumInsertionType()

const MomentumInsertionType & coupling::configurations::MomentumInsertionConfiguration::getMomentumInsertionType ( ) const

inline

Returns momentum insertion type.

Returns

_insertionType

getTag()

std::string coupling::configurations::MomentumInsertionConfiguration::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<class LinkedCell, unsigned int dim>

MomentumInsertion< LinkedCell, dim > * coupling::configurations::MomentumInsertionConfiguration::interpreteConfiguration ( coupling::interface::MDSolverInterface< LinkedCell, dim > *const mdSolverInterface, const coupling::datastructures::CouplingCellWithLinkedCells< LinkedCell, dim > *const couplingCells, unsigned int numberMDTimestepsPerCouplingCycle ) const

inline

Returns momentum insertion configuration.

Template Parameters

LinkedCell	type of the cell
dim	Number of dimensions; it can be 1, 2 or 3

Parameters

mdSolverInterface
couplingCells
numberMDTimestepsPerCouplingCycle

Returns

momentum insertion config

isValid()

bool coupling::configurations::MomentumInsertionConfiguration::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()

void coupling::configurations::MomentumInsertionConfiguration::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/MomentumInsertionConfiguration.h