ParticleSystemPBC¶
See also
SAMSON API: SBSNeighborSearchParticleSystemPBC
- 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.
- getMemoryFootprint(self: samson.Core.Reference.ReferenceTarget) int ¶
Returns the memory footprint
- getNeighborVector(self: samson.Simulation.NeighborSearch.ParticleSystemPBC, i: int) std::vector<SBMStructuralModelNodeParticle*, std::allocator<SBMStructuralModelNodeParticle*> > ¶
Returns indexer of all structural particles which are neighbors for i-th particle
- getNeighbors(*args, **kwargs)¶
Overloaded function.
getNeighbors(self: samson.Simulation.NeighborSearch.ParticleSystemPBC, position: samson.DataModel.Type.vector3, radius: samson.DataModel.Quantity.unitsSI) -> std::vector<SBMStructuralModelNodeParticle*, std::allocator<SBMStructuralModelNodeParticle*> >
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.ParticleSystemPBC, box: samson.DataModel.Type.intervalVector3) -> std::vector<SBMStructuralModelNodeParticle*, std::allocator<SBMStructuralModelNodeParticle*> >
Returns indexer of all structural particles inside the box
- initializeNeighborLists(self: samson.Simulation.NeighborSearch.ParticleSystemPBC) None ¶
Initializes the neighbor list
- updateNeighborLists(self: samson.Simulation.NeighborSearch.ParticleSystemPBC) None ¶
Updates the neighbor list