This class is the base class of neighbor search algorithms that can be applied to particle systems.

Attributes
SBQuantity::squareLength *	cutoffDistanceSquared

SBQuantity::inverseLength *	inverseCutoffDistance

SBPointer< SBParticleSystem > *	particleSystem
	The particle system the neighbor search algorithm is attached to.

Neighbor lists attributes
SBBuffer< SBVector< SBAtom * > * > *	neighborVectorBuffer
	The buffer containing the neighbor lists associated to each atom.

Destructor
virtual	~SBSNeighborSearchParticleSystem ()

Neighbor lists
virtual void	initializeNeighborLists ()

virtual void	updateNeighborLists ()

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

Neighbor search
virtual bool	areNeighbors (unsigned int i, unsigned int j) const
	Returns whether atoms with indices `i` and `j` are neighbors.

virtual bool	areNeighbors (SBAtom atomI, SBAtom atomJ) const
	Returns whether atoms `atomI` and `atomJ` are neighbors.

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 to `radius` from the specified `position`.

virtual void	getNeighbors (SBVector< SBAtom * > &neighborVector, const SBIAPosition3 &box) const
	Appends to `neighborVector` all atoms inside the `box`.

Event handling <br>
void	onDynamicalEvent (SBDynamicalEvent *dynamicalEvent)

Debugging
virtual void	print (unsigned int offset=0) const override
	Prints debugging information.

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

Additional Inherited Members
Public Member Functions inherited from SBSNeighborSearch
virtual	~SBSNeighborSearch ()

Public Member Functions inherited from SBCReferenceTarget
unsigned int	getMemoryFootprint () const

void	printReferencesToOwners () const

	SBCReferenceTarget ()

virtual	~SBCReferenceTarget ()

Protected Member Functions inherited from SBSNeighborSearch
	SBSNeighborSearch ()

Protected Member Functions inherited from SBCReferenceTarget
void	removeAllReferenceOwners ()

	SBCReferenceTarget (SBCReferenceTargetData *dataPointer)

Protected Attributes inherited from SBCReferenceTarget
SBCReferenceTargetData *	dataPointer

Member Function Documentation

◆ areNeighbors() [1/2]

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

virtual

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

virtual

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

virtual

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

virtual

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

overridevirtual

Reimplemented from SBSNeighborSearch.