ParticleSystemPBC

class samson.Simulation.NeighborSearch.ParticleSystemPBC

Bases: samson.Simulation.NeighborSearch.NeighborSearch

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

SAMSON API: SBSNeighborSearchParticleSystemPBC

getMemoryFootprint(self: samson.Core.Reference.ReferenceTarget) → int

Returns the memory footprint

getNeighborIndexer(self: samson.Simulation.NeighborSearch.ParticleSystemPBC, i: int) → samson.DataModel.DataGraph.NodeIndexer

Returns indexer of all structural particles which are neighbors for i-th particle

getNeighbors(*args, **kwargs)

Overloaded function.

1. getNeighbors(self: samson.Simulation.NeighborSearch.ParticleSystemPBC, position: samson.DataModel.Type.vector3, radius: samson.DataModel.Quantity.unitsSI) -> samson.DataModel.DataGraph.NodeIndexer

Returns indexer of all structural particles that are at a distance smaller than or equal to radius from the specified position

2. getNeighbors(self: samson.Simulation.NeighborSearch.ParticleSystemPBC, box: samson.DataModel.Type.intervalVector3) -> samson.DataModel.DataGraph.NodeIndexer

Returns indexer of all structural particles inside the box

initializeNeighborLists(self: samson.Simulation.NeighborSearch.ParticleSystemPBC) → None

sprint(self: samson.Simulation.NeighborSearch.ParticleSystemPBC, offset: int=0) → None

Prints some debugging information

updateNeighborLists(self: samson.Simulation.NeighborSearch.ParticleSystemPBC) → None