Class SBSNeighborSearch

ClassList > SBSNeighborSearch

This class is the base class of neighbor search algorithms. More...

• #include <SBSNeighborSearch.hpp>

Inherits the following classes: SBCReferenceTarget

Inherited by the following classes: SBSNeighborSearchParticleSystem, SBSNeighborSearchParticleSystemPBC, SBSNeighborSearchPositionGrid

Public Functions

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

Public Functions inherited from SBCReferenceTarget

See SBCReferenceTarget

Type	Name
	SBCReferenceTarget () Builds the reference target.
unsigned int	getMemoryFootprint () const Returns the memory footprint.
void	printReferencesToOwners () const Prints the references to the owners of this reference target.
virtual	~SBCReferenceTarget () Destructor.

Protected Attributes inherited from SBCReferenceTarget

See SBCReferenceTarget

Type	Name
SBCReferenceTargetData *	dataPointer A pointer to the private data.

Protected Functions

Type	Name
	SBSNeighborSearch () Protected constructor.
	SBSNeighborSearch (SBSNeighborSearchData * dataPointer) Protected constructor.

Protected Functions inherited from SBCReferenceTarget

See SBCReferenceTarget

Type	Name
	SBCReferenceTarget (SBCReferenceTargetData * dataPointer) Protected constructor.
void	removeAllReferenceOwners () Stops all the reference owners from referencing this reference target.

Detailed Description

Short name: SBNeighborSearch

Public Functions Documentation

function print

Prints debugging information.

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

Prints debugging information for the neighbor search object.

Outputs information about the object with an optional indentation offset.

Parameters:

• offset Number of spaces to indent each line of output.

---

function ~SBSNeighborSearch

Destructor.

virtual SBSNeighborSearch::~SBSNeighborSearch () 

Destroys the SBSNeighborSearch object.

Performs any necessary cleanup.

---

Protected Functions Documentation

function SBSNeighborSearch [1/2]

Protected constructor.

SBSNeighborSearch::SBSNeighborSearch () 

Constructs an SBSNeighborSearch object.

Creates a new instance of SBSNeighborSearch with default initialization.

---

function SBSNeighborSearch [2/2]

Protected constructor.

SBSNeighborSearch::SBSNeighborSearch (
    SBSNeighborSearchData * dataPointer
) 

Constructs an SBSNeighborSearch object with a data pointer.

Initializes a new instance using the provided data pointer to associate internal data.

Parameters:

• dataPointer Pointer to the internal data structure used by the neighbor search.

---