SBNeighborSearchParticleSystem#

See also

SAMSON SDK: SBSNeighborSearchParticleSystem

class samson.SBNeighborSearchParticleSystem#

Bases: SBNeighborSearch

Base class for neighbor-search algorithms operating on particle systems.

This class supports neighbor-list management and neighborhood queries by atom index, atom pointer, spherical region, or axis-aligned interval box.

areNeighbors(*args, **kwargs)#

Overloaded function.

  1. areNeighbors(self: samson.SBNeighborSearchParticleSystem, i: int, j: int) -> bool

Returns True if particles with indices i and j are neighbors.

  1. areNeighbors(self: samson.SBNeighborSearchParticleSystem, atomI: samson.SBAtom, atomJ: samson.SBAtom) -> bool

Returns True if atomI and atomJ are neighbors.

getNeighborVector(self: samson.SBNeighborSearchParticleSystem, i: int) → list[samson.SBAtom]#

Returns neighbors of the i-th particle as a Python list of atoms.

getNeighbors(*args, **kwargs)#

Overloaded function.

  1. getNeighbors(self: samson.SBNeighborSearchParticleSystem, position: samson.SBPhysicalVector3, radius: samson.SBQuantity.unitsSI) -> list[samson.SBAtom]

Returns atoms within radius of position.

  1. getNeighbors(self: samson.SBNeighborSearchParticleSystem, box: samson.SBPhysicalIAVector3) -> list[samson.SBAtom]

Returns atoms inside an axis-aligned interval box.

initializeNeighborLists(self: samson.SBNeighborSearchParticleSystem) → None#

Initializes neighbor lists.

updateNeighborLists(self: samson.SBNeighborSearchParticleSystem) → None#

Updates neighbor lists.