coupling::cellmappings::SetMomentumMapping< LinkedCell, dim > Class Template Reference

This class sets a certain momentum over several linked cells. More...

#include <SetMomentumMapping.h>

Collaboration diagram for coupling::cellmappings::SetMomentumMapping< LinkedCell, dim >:

Public Member Functions
	SetMomentumMapping (const tarch::la::Vector< dim, double > &oldMomentum, const tarch::la::Vector< dim, double > &newMomentum, const unsigned int &numberParticles, coupling::interface::MDSolverInterface< LinkedCell, dim > *const mdSolverInterface)
	~SetMomentumMapping ()
void	beginCellIteration ()
void	endCellIteration ()
void	handleCell (LinkedCell &cell)

Private Member Functions
tarch::la::Vector< dim, double >	getVelocity (const unsigned int &numberParticles, const tarch::la::Vector< dim, double > &momentum) const

Private Attributes
coupling::interface::MDSolverInterface< LinkedCell, dim > *const	_mdSolverInterface
tarch::la::Vector< dim, double >	_oldVelocity
tarch::la::Vector< dim, double >	_newVelocity

Detailed Description

template<class LinkedCell, unsigned int dim>
class coupling::cellmappings::SetMomentumMapping< LinkedCell, dim >

This class sets a certain momentum over several linked cells.

Template Parameters

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

Author

Philipp Neumann

Constructor & Destructor Documentation

SetMomentumMapping()

template<class LinkedCell, unsigned int dim>

coupling::cellmappings::SetMomentumMapping< LinkedCell, dim >::SetMomentumMapping ( const tarch::la::Vector< dim, double > & oldMomentum, const tarch::la::Vector< dim, double > & newMomentum, const unsigned int & numberParticles, coupling::interface::MDSolverInterface< LinkedCell, dim > *const mdSolverInterface )

inline

obtains the old momentum over the region of interest. Besides, obtains the new momentum that shall be set and the number of particles contained in the coupling cell.

Parameters

oldMomentum
newMomentum
numberParticles
mdSolverInterface

~SetMomentumMapping()

template<class LinkedCell, unsigned int dim>

coupling::cellmappings::SetMomentumMapping< LinkedCell, dim >::~SetMomentumMapping ( )

inline

Destructor

Member Function Documentation

beginCellIteration()

template<class LinkedCell, unsigned int dim>

void coupling::cellmappings::SetMomentumMapping< LinkedCell, dim >::beginCellIteration ( )

inline

empty function

endCellIteration()

template<class LinkedCell, unsigned int dim>

void coupling::cellmappings::SetMomentumMapping< LinkedCell, dim >::endCellIteration ( )

inline

empty function

getVelocity()

template<class LinkedCell, unsigned int dim>

tarch::la::Vector< dim, double > coupling::cellmappings::SetMomentumMapping< LinkedCell, dim >::getVelocity ( const unsigned int & numberParticles, const tarch::la::Vector< dim, double > & momentum ) const

inlineprivate

returns mean velocity og the cell

Parameters

numberParticles
momentum

Returns

mean velocity og the cell

handleCell()

template<class LinkedCell, unsigned int dim>

void coupling::cellmappings::SetMomentumMapping< LinkedCell, dim >::handleCell ( LinkedCell & cell )

inline

applies a certain momentum over several linked cells, by steering the velocity.

Parameters

cell

---

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

• coupling/cell-mappings/SetMomentumMapping.h