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

This class computes the mass over certain linked cells. More...

#include <ComputeMassMapping.h>

Public Member Functions
	ComputeMassMapping (coupling::interface::MDSolverInterface< LinkedCell, dim > *const mdSolverInterface)
	~ComputeMassMapping ()
void	beginCellIteration ()
void	endCellIteration ()
void	handleCell (LinkedCell &cell)
double	getMass () const
unsigned int	getNumberOfParticles () const

Private Attributes
coupling::interface::MDSolverInterface< LinkedCell, dim > *const	_mdSolverInterface
double	_mass
unsigned int	_particleCounter

Detailed Description

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

This class computes the mass over certain linked cells.

Template Parameters

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

Author

Philipp Neumann

Constructor & Destructor Documentation

ComputeMassMapping()

template<class LinkedCell, unsigned int dim>

coupling::cellmappings::ComputeMassMapping< LinkedCell, dim >::ComputeMassMapping ( coupling::interface::MDSolverInterface< LinkedCell, dim > *const mdSolverInterface )

inline

Constructor

Parameters

mdSolverInterface

~ComputeMassMapping()

template<class LinkedCell, unsigned int dim>

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

inline

Destructor

Member Function Documentation

beginCellIteration()

template<class LinkedCell, unsigned int dim>

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

inline

sets the mass and the particlee counter to zero, before the iteration process begins.

endCellIteration()

template<class LinkedCell, unsigned int dim>

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

inline

computes the mass in a linked cell, by multiplying the number of particles inside the cell with the particel mass(which is assuemd to be constant).

getMass()

template<class LinkedCell, unsigned int dim>

double coupling::cellmappings::ComputeMassMapping< LinkedCell, dim >::getMass ( ) const

inline

returns the mass inside a linked cell

Returns

_mass

getNumberOfParticles()

template<class LinkedCell, unsigned int dim>

unsigned int coupling::cellmappings::ComputeMassMapping< LinkedCell, dim >::getNumberOfParticles ( ) const

inline

returns the number of particles inside a linked cell

Returns

_particleCounter

handleCell()

template<class LinkedCell, unsigned int dim>

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

inline

counts the molecules inside a linked cell.

Parameters

cell

---

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

• coupling/cell-mappings/ComputeMassMapping.h