ParticleSystemGridPBC¶
See also
SAMSON API: SBSNeighborSearchParticleSystemGridPBC
-
class
samson.Simulation.NeighborSearch.
ParticleSystemGridPBC
(self: samson.Simulation.NeighborSearch.ParticleSystemGridPBC, particleSystem: samson.Modeling.DynamicalModel.ParticleSystem, cutoffDistance: samson.DataModel.Quantity.unitsSI) → None¶ Bases:
samson.Simulation.NeighborSearch.ParticleSystemPBC
This class describes a grid-based neighbor search algorithm that can be applied to particle systems with periodic boundary conditions.
-
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.
- getNeighbors(self: samson.Simulation.NeighborSearch.ParticleSystemGridPBC, 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
- getNeighbors(self: samson.Simulation.NeighborSearch.ParticleSystemGridPBC, box: samson.DataModel.Type.intervalVector3) -> samson.DataModel.DataGraph.NodeIndexer
Returns indexer of all structural particles inside the box
-
initializeNeighborLists
(self: samson.Simulation.NeighborSearch.ParticleSystemGridPBC) → None¶ Initializes the neighbor list
-
printDebugInfo
(self: samson.Simulation.NeighborSearch.ParticleSystemGridPBC, offset: int=0) → None¶ Prints some debugging information in stdout
-
updateNeighborLists
(self: samson.Simulation.NeighborSearch.ParticleSystemGridPBC) → None¶ Updates the neighbor list
-