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

This class computes the kinetic energy. inside a linked cell. More...

#include <ComputeKineticEnergyMapping.h>

Public Member Functions
	ComputeKineticEnergyMapping (coupling::interface::MDSolverInterface< LinkedCell, dim > *const mdSolverInterface)
	~ComputeKineticEnergyMapping ()
void	beginCellIteration ()
void	endCellIteration ()
void	handleCell (LinkedCell &cell)
double	getKineticEnergy () const

Private Attributes
coupling::interface::MDSolverInterface< LinkedCell, dim > *const	_mdSolverInterface
double	_kineticEnergy

Detailed Description

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

This class computes the kinetic energy. inside a linked cell.

Template Parameters

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

Author

Philipp Neumann

Constructor & Destructor Documentation

ComputeKineticEnergyMapping()

template<class LinkedCell, unsigned int dim>

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

inline

Constructor

Parameters

mdSolverInterface

~ComputeKineticEnergyMapping()

template<class LinkedCell, unsigned int dim>

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

inline

Destructor

Member Function Documentation

beginCellIteration()

template<class LinkedCell, unsigned int dim>

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

inline

sets the kinetic energy to zero, before the iteration process begins.

endCellIteration()

template<class LinkedCell, unsigned int dim>

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

inline

computes the kinetic energy in a linked cell, by multiplying the specific kinetic energy with the mass and 0.5.

getKineticEnergy()

template<class LinkedCell, unsigned int dim>

double coupling::cellmappings::ComputeKineticEnergyMapping< LinkedCell, dim >::getKineticEnergy ( ) const

inline

returns the kinetic energy inside a linked cell

Returns

_kineticEnergy

handleCell()

template<class LinkedCell, unsigned int dim>

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

inline

sums up the specific kinetic energy of all molecules inside a linked cell.

Parameters

cell

---

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

• coupling/cell-mappings/ComputeKineticEnergyMapping.h