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

This class sums up all force/velocity vectors and counts molecules inside a linked cell. More...

#include <ComputeAvgForceAndVelocity.h>

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

Public Member Functions
	ComputeAvgForceAndVelocity (coupling::interface::MDSolverInterface< LinkedCell, dim > *const mdSolverInterface)
	~ComputeAvgForceAndVelocity ()
void	beginCellIteration ()
void	endCellIteration ()
void	handleCell (LinkedCell &cell)
tarch::la::Vector< dim, double >	getAvgForce () const
tarch::la::Vector< dim, double >	getAvgVelocity () const

Private Attributes
coupling::interface::MDSolverInterface< LinkedCell, dim > *const	_mdSolverInterface
tarch::la::Vector< dim, double >	_force
tarch::la::Vector< dim, double >	_velocity
unsigned int	_particleCounter

Detailed Description

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

This class sums up all force/velocity vectors and counts molecules inside a linked cell.

This class sums up all force and velocity vectors and counts molecules inside a linked cell. Afterwards, the average force/velocity contribution is computed.

Template Parameters

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

Author

Philipp Neumann

Constructor & Destructor Documentation

ComputeAvgForceAndVelocity()

template<class LinkedCell, unsigned int dim>

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

inline

Constructor

Parameters

mdSolverInterface

~ComputeAvgForceAndVelocity()

template<class LinkedCell, unsigned int dim>

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

inline

Destructor

Member Function Documentation

beginCellIteration()

template<class LinkedCell, unsigned int dim>

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

inline

sets force, velocity and moluce counter to zero, before the iteration process begins.

endCellIteration()

template<class LinkedCell, unsigned int dim>

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

inline

the average force and velocity contribution incide a linked cell are computed, by dividing the summation calculated in endCellIteration() over number of the particles inside the cell.

getAvgForce()

template<class LinkedCell, unsigned int dim>

tarch::la::Vector< dim, double > coupling::cellmappings::ComputeAvgForceAndVelocity< LinkedCell, dim >::getAvgForce ( ) const

inline

returns the force vectors inside a linked cell

Returns

_force

getAvgVelocity()

template<class LinkedCell, unsigned int dim>

tarch::la::Vector< dim, double > coupling::cellmappings::ComputeAvgForceAndVelocity< LinkedCell, dim >::getAvgVelocity ( ) const

inline

returns the velocity vectors inside a linked cell

Returns

_velocity

handleCell()

template<class LinkedCell, unsigned int dim>

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

inline

sums up all force and velocity vectors and counts molecules inside a linked cell.

Parameters

cell

---

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

• coupling/cell-mappings/ComputeAvgForceAndVelocity.h