SBMStructuralModelGrid Class Reference
This class describes a grid-based neighbor search algorithm that can be applied to structural particles (atoms or pseudo-atoms). More...
Destructor | |
| SBMStructuralModelGrid (const SBNodeIndexer &nodeIndexer, const SBQuantity::length &cutoffDistance) | |
| Constructs a neighbor search grid. More... | |
| virtual | ~SBMStructuralModelGrid () |
| Destroys the neighbor search grid. | |
Neighbor lists | |
| virtual void | update () |
| Updates the grid and neighbor lists. | |
| SBIndexer< SBStructuralParticle * > const * | getNeighborIndexer (unsigned int i) const |
Returns the neighbor indexer of structural particle i. | |
| SBIndexer< SBStructuralParticle * > const * | getNeighborIndexer (SBStructuralParticle *structuralParticle) const |
Returns the neighbor indexer of structural particle structuralParticle. | |
Neighbor search | |
| virtual void | getNeighbors (SBIndexer< SBStructuralParticle *> &neighborIndexer, const SBPosition3 &position, const SBQuantity::length &radius) const |
Appends to neighborIndexer all structural particles that are at a distance smaller than or equal to radius from the specified position. | |
| virtual void | getNeighbors (SBIndexer< SBStructuralParticle *> &neighborIndexer, const SBIAPosition3 &box) const |
Appends to neighborIndexer all structural particles inside the box. | |
Debugging | |
| virtual void | print (unsigned int offset=0) const |
| Prints debugging information. | |
Additional Inherited Members | |
 Public Member Functions inherited from SBCReferenceTarget | |
| SBCReferenceTarget () | |
| virtual | ~SBCReferenceTarget () |
| unsigned int | getMemoryFootprint () const |
| void | printReferencesToOwners () const |
Detailed Description
This class may be used by developers to perform neighbor search between structural particles (i.e. atoms or pseudo-atoms). Internally, the neighbor search algorithm uses a grid to efficiently determine neighbors.
Constructor & Destructor Documentation
◆ SBMStructuralModelGrid()
| SBMStructuralModelGrid::SBMStructuralModelGrid | ( | const SBNodeIndexer & | nodeIndexer, |
| const SBQuantity::length & | c | ||
| ) |
This constructor initializes the neighbor search algorithm. After the grid is constructed, neighbor lists are available and can be retrieved using the getNeighborIndexer functions.