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

This class deletes a certain particle from a coupling cell. More...

#include <DeleteParticleMapping.h>

Public Member Functions
	DeleteParticleMapping (const unsigned int &particle, coupling::interface::MDSolverInterface< LinkedCell, dim > *const mdSolverInterface)
	~DeleteParticleMapping ()
void	beginCellIteration ()
void	endCellIteration ()
void	handleCell (LinkedCell &cell)
coupling::datastructures::Molecule< dim >	getDeletedMolecule () const

Private Attributes
coupling::interface::MDSolverInterface< LinkedCell, dim > *const	_mdSolverInterface
const unsigned int	_particle
unsigned int	_particleCounter
coupling::datastructures::Molecule< dim >	_deletedMoleculeCopy

Detailed Description

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

This class deletes a certain particle from a coupling cell.

Template Parameters

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

Author

Philipp Neumann

Constructor & Destructor Documentation

DeleteParticleMapping()

template<class LinkedCell, unsigned int dim>

coupling::cellmappings::DeleteParticleMapping< LinkedCell, dim >::DeleteParticleMapping ( const unsigned int & particle, coupling::interface::MDSolverInterface< LinkedCell, dim > *const mdSolverInterface )

inline

Constructor

Parameters

particle
mdSolverInterface

~DeleteParticleMapping()

template<class LinkedCell, unsigned int dim>

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

inline

Destructor

Member Function Documentation

beginCellIteration()

template<class LinkedCell, unsigned int dim>

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

inline

sets the particle counter to zero, before the iteration process begins.

endCellIteration()

template<class LinkedCell, unsigned int dim>

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

inline

empty function

getDeletedMolecule()

template<class LinkedCell, unsigned int dim>

coupling::datastructures::Molecule< dim > coupling::cellmappings::DeleteParticleMapping< LinkedCell, dim >::getDeletedMolecule ( ) const

inline

returns a copy of the deleted molecule.

Returns

_deletedMoleculeCopy

handleCell()

template<class LinkedCell, unsigned int dim>

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

inline

This function saves a copy of particle that has to be deleted, then deletes the molecule from MD simulation. It does nothiung, if the particle is already deleted.

Parameters

cell

---

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

• coupling/cell-mappings/DeleteParticleMapping.h