Package esys :: Package lsm :: Package geometry :: Module GeometryPy :: Class SimpleSphereNeighbours
[hide private]
[frames] | no frames]

Class SimpleSphereNeighbours

 object --+    
          |    
??.instance --+
              |
             SimpleSphereNeighbours

Discovers pairs of spheres which are closer than a specified threshold distance.

Instance Methods [hide private]
 
__init__(...)
Construct the neighbour-finding object.
SsNeighbourParticleIdPairIterator
__iter__(...)
Iterator for enumerating sequence of all ParticleIdPair<esys.lsm.LsmPy.ParticleIdPair> neighbours discovered during getNeighbours calls.
 
__len__(...)
 
__reduce__(...)
helper for pickle
ParticleIdPairVector<esys.lsm.LsmPy.ParticleIdPairVector>
getNeighbours(...)
Returns a sequence of ParticleIdPair<esys.lsm.LsmPy.ParticleIdPair> objects which indicate neighbouring pairs of particles.
int
getNumIdPairs(...)
Returns the total number of neighbouring pairs of spheres found during calls to the getNeighbours method.
int
getNumSpheres(...)
Returns the number of spheres which have been added to this neighbour finder via the getNeighbours method.

Inherited from unreachable.instance: __new__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  __instance_size__ = 168
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(...)
(Constructor)

 

Construct the neighbour-finding object.

Parameters:
  • maxDist (float) - Threshhold distance governing which spheres are determined to be neighbours.
  • bBox (BoundingBox) - Initial box for look-up grid. Also indicates locations of fixed circular boundaries.
  • circDimList (list of 3 boolean elements) - Default tag given to the connections.
Overrides: object.__init__

__iter__(...)

 

Iterator for enumerating sequence of all ParticleIdPair<esys.lsm.LsmPy.ParticleIdPair> neighbours discovered during getNeighbours calls.

Returns: SsNeighbourParticleIdPairIterator
Iterator for enumerating sequence of ParticleIdPair<esys.lsm.LsmPy.ParticleIdPair> objects.

__reduce__(...)

 

helper for pickle

Overrides: object.__reduce__
(inherited documentation)

getNeighbours(...)

 

Returns a sequence of ParticleIdPair<esys.lsm.LsmPy.ParticleIdPair> objects which indicate neighbouring pairs of particles. Only returns pairs of id's from particles within the specified sequence.

Parameters:
Returns: ParticleIdPairVector<esys.lsm.LsmPy.ParticleIdPairVector>
Sequence of id pairs indicating spheres which are closer than the threshold distance.

getNumIdPairs(...)

 

Returns the total number of neighbouring pairs of spheres found during calls to the getNeighbours method.

Returns: int
number of ParticleIdPair objects in this collection.

getNumSpheres(...)

 

Returns the number of spheres which have been added to this neighbour finder via the getNeighbours method.

Returns: int
The number of spheres added to this neighbour finder.