Module gengeo :: Class FullCircMNTable3D
[hide private]
[frames] | no frames]

Class FullCircMNTable3D

 object --+            
          |            
??.instance --+        
              |        
      MNTable3D --+    
                  |    
      CircMNTable3D --+
                      |
                     FullCircMNTable3D

A multi-group neighbours table for constructing 3D particle setups with circular boundary conditions in all three directions (X, Y and Z).

Instance Methods [hide private]
 
__init__(...)
Constructs a neighbours table with specified bounds, cell size and initial number of particle groups.
 
__str__(...)
str(x)
void
generateBonds(...)
Generates bonds between particle pairs separated by less than the specified tolerance

Inherited from CircMNTable3D: generateClusterBonds, getSumVolume, tagParticlesAlongPlane, write

Inherited from MNTable3D: GrowNGroups, __reduce__, finishBlockWriting, generateBondsTagged, generateBondsWithJointSet, generateRandomBonds, getSphereListDist, getSphereListFromGroup, initBlockWriting, insert, insertBond, insertFromRawFile, removeBonds, removeParticlesInGroup, removeParticlesInVolume, removeParticlesWithTag, removeTaggedParticles, renumberParticlesContinuous, setOutputPrecision, tagParticlesAlongJoints, tagParticlesAlongPlaneWithMask, tagParticlesInGroup, tagParticlesInSphere, tagParticlesInVolume, tagParticlesToClosest, tagParticlesToClosestAnisotropic, writeBlock, writeBondsBlocked

Inherited from unreachable.instance: __new__

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

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

Inherited from object: __class__

Method Details [hide private]

__init__(...)
(Constructor)

 

Constructs a neighbours table with specified bounds, cell size and initial number of particle groups.

Parameters:
  • minPoint (Vector3) - lower-left-front point of the particle region
  • maxPoint (Vector3) - upper-right-back point of the particle region
  • gridSize (double) - the cell size for neighbour searches
  • numGroups (unsigned int) - the initial number of groups (default: 1)
Overrides: object.__init__

__str__(...)
(Informal representation operator)

 

str(x)

Overrides: object.__str__
(inherited documentation)

generateBonds(...)

 

Generates bonds between particle pairs separated by less than the specified tolerance

Parameters:
  • groupID (int) - the group ID of particles to bond together (default: 0)
  • tolerance (double) - maximum distance separating bonded particles
  • bondID (int) - the bond ID to assign generated bonds
Returns: void
Overrides: MNTable3D.generateBonds