Class SBSNeighborSearchPositionGrid

ClassList > SBSNeighborSearchPositionGrid

More...

• #include <SBSNeighborSearchPositionGrid.hpp>

Inherits the following classes: SBSNeighborSearch

Classes

Type	Name
class	GridCell
class	GridKey
class	GridKeyComparator
class	GridKeyFunctor

Public Attributes

Type	Name
SBQuantity::squareLength *	cutoffDistanceSquared
SBHashMap< GridKey, GridCell *, GridKeyFunctor, GridKeyComparator > *	grid
SBVector< GridKey > *	gridKeyVector
SBIndexer< unsigned int > *	indexIndexer The set of indices the neighbor search algorithm is applied to.
SBQuantity::inverseLength *	inverseCutoffDistance
SBBuffer< SBVector< unsigned int > * > *	neighborVectorBuffer The buffer containing the neighbor lists associated to each index.
SBBuffer< SBPosition3 > *	positionBuffer The buffer containing the positions.

Public Functions

Type	Name
	SBSNeighborSearchPositionGrid (const SBVector< SBPosition3 > & positionVector, const SBQuantity::length & cutoffDistance) Constructs a neighbor search grid.
virtual void	getNeighbors (SBVector< unsigned int > & neighborVector, const SBPosition3 & position, const SBQuantity::length & radius) const Returns all atoms that are at a distance smaller than or equal to radius from the specifiedposition .
virtual bool	hasNeighbors (const SBPosition3 & position, const SBQuantity::length & radius) const Returns true if there are neighbors within radius ofposition .
virtual	~SBSNeighborSearchPositionGrid () Destroys the neighbor search grid.

Public Functions inherited from SBSNeighborSearch

See SBSNeighborSearch

Type	Name
virtual void	print (unsigned int offset=0) const Prints debugging information.
virtual	~SBSNeighborSearch ()

Public Functions inherited from SBCReferenceTarget

See SBCReferenceTarget

Type	Name
	SBCReferenceTarget ()
unsigned int	getMemoryFootprint () const
void	printReferencesToOwners () const
virtual	~SBCReferenceTarget ()

Protected Attributes inherited from SBCReferenceTarget

See SBCReferenceTarget

Type	Name
SBCReferenceTargetData *	dataPointer

Protected Functions inherited from SBSNeighborSearch

See SBSNeighborSearch

Type	Name
	SBSNeighborSearch ()

Protected Functions inherited from SBCReferenceTarget

See SBCReferenceTarget

Type	Name
	SBCReferenceTarget (SBCReferenceTargetData * dataPointer)
void	removeAllReferenceOwners ()

Detailed Description

This class is the base class of neighbor search algorithms.

Short name: SBPositionGrid

Public Attributes Documentation

variable cutoffDistanceSquared

SBQuantity::squareLength* cutoffDistanceSquared;

---

variable grid

SBHashMap<GridKey, GridCell*, GridKeyFunctor, GridKeyComparator>* grid;

---

variable gridKeyVector

SBVector<GridKey>* gridKeyVector;

---

variable indexIndexer

The set of indices the neighbor search algorithm is applied to.

SBIndexer<unsigned int>* indexIndexer;

---

variable inverseCutoffDistance

SBQuantity::inverseLength* inverseCutoffDistance;

---

variable neighborVectorBuffer

The buffer containing the neighbor lists associated to each index.

SBBuffer<SBVector<unsigned int>*>* neighborVectorBuffer;

---

variable positionBuffer

The buffer containing the positions.

SBBuffer<SBPosition3>* positionBuffer;

---

Public Functions Documentation

function SBSNeighborSearchPositionGrid

Constructs a neighbor search grid.

SBSNeighborSearchPositionGrid::SBSNeighborSearchPositionGrid (
    const SBVector< SBPosition3 > & positionVector,
    const SBQuantity::length & cutoffDistance
) 

---

function getNeighbors

Returns all atoms that are at a distance smaller than or equal to radius from the specifiedposition .

virtual void SBSNeighborSearchPositionGrid::getNeighbors (
    SBVector< unsigned int > & neighborVector,
    const SBPosition3 & position,
    const SBQuantity::length & radius
) const

---

function hasNeighbors

Returns true if there are neighbors within radius ofposition .

virtual bool SBSNeighborSearchPositionGrid::hasNeighbors (
    const SBPosition3 & position,
    const SBQuantity::length & radius
) const

---

function ~SBSNeighborSearchPositionGrid

Destroys the neighbor search grid.

virtual SBSNeighborSearchPositionGrid::~SBSNeighborSearchPositionGrid () 

---