Class SBSNeighborSearchParticleSystem

ClassList > SBSNeighborSearchParticleSystem

More...

• #include <SBSNeighborSearchParticleSystem.hpp>

Inherits the following classes: SBSNeighborSearch

Inherited by the following classes: SBSNeighborSearchParticleSystemGrid

Public Functions

Type	Name
virtual bool	areNeighbors (unsigned int i, unsigned int j) const Returns whether atoms with indices i andj are neighbors.
virtual bool	areNeighbors (SBAtom * atomI, SBAtom * atomJ) const Returns whether atoms atomI andatomJ are neighbors.
SBVector< SBAtom * > const *	getNeighborVector (unsigned int i)
virtual void	getNeighbors (SBVector< SBAtom * > & neighborVector, const SBPosition3 & position, const SBQuantity::length & radius) const Appends to neighborVector all atoms that are at a distance smaller than or equal toradius from the specifiedposition .
virtual void	getNeighbors (SBVector< SBAtom * > & neighborVector, const SBIAPosition3 & box) const Appends to neighborVector all atoms inside thebox .
virtual void	initializeNeighborLists ()
void	onDynamicalEvent (SBDynamicalEvent * dynamicalEvent)
virtual void	print (unsigned int offset=0) override const Prints debugging information.
virtual void	updateNeighborLists ()
virtual	~SBSNeighborSearchParticleSystem ()

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

Type	Name
SBQuantity::squareLength *	cutoffDistanceSquared
SBQuantity::inverseLength *	inverseCutoffDistance
SBBuffer< SBVector< SBAtom * > * > *	neighborVectorBuffer The buffer containing the neighbor lists associated to each atom.
SBPointer< SBParticleSystem > *	particleSystem The particle system the neighbor search algorithm is attached to.

Protected Attributes inherited from SBCReferenceTarget

See SBCReferenceTarget

Type	Name
SBCReferenceTargetData *	dataPointer

Protected Functions

Type	Name
	SBSNeighborSearchParticleSystem (SBParticleSystem * p, const SBQuantity::length & cutoffDistance)

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 that can be applied to particle systems.

Short name: SBNeighborSearchParticleSystem

Public Functions Documentation

function areNeighbors [1/2]

Returns whether atoms with indices i andj are neighbors.

virtual bool SBSNeighborSearchParticleSystem::areNeighbors (
    unsigned int i,
    unsigned int j
) const

---

function areNeighbors [2/2]

Returns whether atoms atomI andatomJ are neighbors.

virtual bool SBSNeighborSearchParticleSystem::areNeighbors (
    SBAtom * atomI,
    SBAtom * atomJ
) const

---

function getNeighborVector

SBVector< SBAtom * > const * SBSNeighborSearchParticleSystem::getNeighborVector (
    unsigned int i
) 

---

function getNeighbors [1/2]

Appends to neighborVector all atoms that are at a distance smaller than or equal toradius from the specifiedposition .

virtual void SBSNeighborSearchParticleSystem::getNeighbors (
    SBVector< SBAtom * > & neighborVector,
    const SBPosition3 & position,
    const SBQuantity::length & radius
) const

---

function getNeighbors [2/2]

Appends to neighborVector all atoms inside thebox .

virtual void SBSNeighborSearchParticleSystem::getNeighbors (
    SBVector< SBAtom * > & neighborVector,
    const SBIAPosition3 & box
) const

---

function initializeNeighborLists

virtual void SBSNeighborSearchParticleSystem::initializeNeighborLists () 

---

function onDynamicalEvent

void SBSNeighborSearchParticleSystem::onDynamicalEvent (
    SBDynamicalEvent * dynamicalEvent
) 

---

function print

Prints debugging information.

virtual void SBSNeighborSearchParticleSystem::print (
    unsigned int offset=0
) override const

Implements SBSNeighborSearch::print

---

function updateNeighborLists

virtual void SBSNeighborSearchParticleSystem::updateNeighborLists () 

---

function ~SBSNeighborSearchParticleSystem

virtual SBSNeighborSearchParticleSystem::~SBSNeighborSearchParticleSystem () 

---

Protected Attributes Documentation

variable cutoffDistanceSquared

SBQuantity::squareLength* cutoffDistanceSquared;

---

variable inverseCutoffDistance

SBQuantity::inverseLength* inverseCutoffDistance;

---

variable neighborVectorBuffer

The buffer containing the neighbor lists associated to each atom.

SBBuffer<SBVector<SBAtom*>*>* neighborVectorBuffer;

---

variable particleSystem

The particle system the neighbor search algorithm is attached to.

SBPointer<SBParticleSystem>* particleSystem;

---

Protected Functions Documentation

function SBSNeighborSearchParticleSystem

SBSNeighborSearchParticleSystem::SBSNeighborSearchParticleSystem (
    SBParticleSystem * p,
    const SBQuantity::length & cutoffDistance
) 

---