NeighborSearch¶
This library defines Neighbor Search algorithms.
SAMSON API: The SBSNeighborSearch Library
-
class
samson.Simulation.NeighborSearch.
NeighborSearch
¶ Bases:
samson.Core.Reference.SBCReferenceTarget
This class is the base class of neighbor search algorithms.
SAMSON API: SBSNeighborSearch
-
getMemoryFootprint
(self: samson.Core.Reference.SBCReferenceTarget) → int¶ Returns the memory footprint
-
sprint
(self: samson.Simulation.NeighborSearch.NeighborSearch, offset: int=0) → None¶ Prints some debugging information
-
__eq__
¶ Return self==value.
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
__ne__
¶ Return self!=value.
-
-
class
samson.Simulation.NeighborSearch.
ParticleSystem
¶ Bases:
samson.Simulation.NeighborSearch.NeighborSearch
This class is the base class of neighbor search algorithms that can be applied to particle systems.
SAMSON API: SBSNeighborSearchParticleSystem
-
getMemoryFootprint
(self: samson.Core.Reference.SBCReferenceTarget) → int¶ Returns the memory footprint
-
getNeighborIndexer
(self: samson.Simulation.NeighborSearch.ParticleSystem, 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.ParticleSystem, 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.ParticleSystem, box: samson.DataModel.Type.intervalVector3) -> samson.DataModel.DataGraph.NodeIndexer
Returns indexer of all structural particles inside the box
-
initializeNeighborLists
(self: samson.Simulation.NeighborSearch.ParticleSystem) → None¶
-
sprint
(self: samson.Simulation.NeighborSearch.ParticleSystem, offset: int=0) → None¶ Prints some debugging information
-
updateNeighborLists
(self: samson.Simulation.NeighborSearch.ParticleSystem) → None¶
-
__eq__
¶ Return self==value.
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
__ne__
¶ Return self!=value.
-
-
class
samson.Simulation.NeighborSearch.
ParticleSystemGrid
(self: samson.Simulation.NeighborSearch.ParticleSystemGrid, particleSystem: samson.Modeling.DynamicalModel.ParticleSystem, cutoffDistance: samson.DataModel.Quantity.unitsSI) → None¶ Bases:
samson.Simulation.NeighborSearch.ParticleSystem
This class describes a grid-based neighbor search algorithm that can be applied to particle systems.
SAMSON API: SBSNeighborSearchParticleSystemGrid
-
getMemoryFootprint
(self: samson.Core.Reference.SBCReferenceTarget) → int¶ Returns the memory footprint
-
getNeighborIndexer
(self: samson.Simulation.NeighborSearch.ParticleSystem, 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.ParticleSystemGrid, 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.ParticleSystemGrid, box: samson.DataModel.Type.intervalVector3) -> samson.DataModel.DataGraph.NodeIndexer
Returns indexer of all structural particles inside the box
-
initializeNeighborLists
(self: samson.Simulation.NeighborSearch.ParticleSystemGrid) → None¶
-
sprint
(self: samson.Simulation.NeighborSearch.ParticleSystemGrid, offset: int=0) → None¶ Prints some debugging information
-
updateNeighborLists
(self: samson.Simulation.NeighborSearch.ParticleSystemGrid) → None¶
-
__eq__
¶ Return self==value.
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
__ne__
¶ Return self!=value.
-
-
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.
SAMSON API: SBSNeighborSearchParticleSystemGridPBC
-
getMemoryFootprint
(self: samson.Core.Reference.SBCReferenceTarget) → 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¶
-
sprint
(self: samson.Simulation.NeighborSearch.ParticleSystemGridPBC, offset: int=0) → None¶ Prints some debugging information
-
updateNeighborLists
(self: samson.Simulation.NeighborSearch.ParticleSystemGridPBC) → None¶
-
__eq__
¶ Return self==value.
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
__ne__
¶ Return self!=value.
-
-
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.SBCReferenceTarget) → 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.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
- 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¶
-
__eq__
¶ Return self==value.
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
__ne__
¶ Return self!=value.
-