McMd::CellTag Class Reference

Detailed Description

Location of the pointer to a particular Atom in a CellList.

A CellList contains a array of CellTag objects, which are indexed by Atom Id, and an array of Cell objects, each of which stores pointers of all Atoms in one cell. Each CellTag contains the information necessary to locate a particular Atom within the CellList, to allow fast deletion of a specified Atom from its Cell.

The CellTag class is used only by the CellList class.

Definition at line 27 of file CellTag.h.

#include <CellTag.h>

Public Member Functions
	CellTag ()
	Default constructor. More...
void	clear ()
	Set CellTag to empty/unused state. More...

Public Attributes
int	cellId
	Cell index of Cell containing associated Atom. More...
int	cellPos
	Array index of Atom pointer in a Cell::part_ array. More...

Static Public Attributes
static const int	NullIndex = -1
	Null (unknown) value for cellId and cellPos. More...

Constructor & Destructor Documentation

McMd::CellTag::CellTag ( )

inline

Default constructor.

Definition at line 42 of file CellTag.h.

References clear().

Member Function Documentation

void McMd::CellTag::clear ( )

inline

Set CellTag to empty/unused state.

Definition at line 46 of file CellTag.h.

References NullIndex.

Referenced by CellTag().

Member Data Documentation

const int McMd::CellTag::NullIndex = -1

static

Null (unknown) value for cellId and cellPos.

Definition at line 33 of file CellTag.h.

Referenced by clear().

int McMd::CellTag::cellId

Cell index of Cell containing associated Atom.

Definition at line 36 of file CellTag.h.

Referenced by McMd::Cell::addAtom(), McMd::Cell::deleteAtom(), McMd::CellList::deleteAtom(), and McMd::CellList::updateAtomCell().

int McMd::CellTag::cellPos

Array index of Atom pointer in a Cell::part_ array.

Definition at line 39 of file CellTag.h.

Referenced by McMd::Cell::addAtom(), and McMd::Cell::deleteAtom().

---

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

• CellTag.h