Module GenGeo :: Class InsertGenerator3D

Class InsertGenerator3D

 object --+        
          |        
??.instance --+    
              |    
   AGenerator3D --+
                  |
                 InsertGenerator3D

Known Subclasses:

HexAggregateInsertGenerator3D

A particle packing algorithm for filling 3D spaces.

Instance Methods

[hide private]

void

__init__(...)
Initialises a particle packer in preparation for filling a 3D volume with particles whose radii are in the specified range.

__str__(...)
str(x)

void

generatePacking(...)
Generates a particle assembly to fill the specified volume.

generatePackingMaxVolume(...)

setNextTag(...)
Sets tag for the next particles generated

setOldSeeding(...)
Sets old seeding behavior.

Inherited from AGenerator3D: __reduce__

Inherited from unreachable.instance: __new__

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

Class Variables

[hide private]

__instance_size__ = 80

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(...)
(Constructor)

Initialises a particle packer in preparation for filling a 3D volume with particles whose radii are in the specified range. The packing will terminate after the specified number of insertion failures. The iterative solver will compute only the specified maximum number of iterations. Particles are permitted to overlap by the specified tolerance.

Parameters:

minRadius (double) - the minimum radius of particles to pack
maxRadius (double) - the maximum radius of particles to pack
insertFails (int) - the number of particle insertion failures before the packer terminates
maxIterations (int) - the maximum number of iterations of the solver
tolerance (double) - the overlap tolerance permitted
seed (bool) - randomize the random number generator if True (optional)

Returns: void

Overrides: object.__init__

str(...)
(Informal representation operator)

str(x)

Overrides: object.__str__: (inherited documentation)

generatePacking(...)

Generates a particle assembly to fill the specified volume.

Parameters:

volume (AVolume3D) - the 3D volume to fill with particles
ntable (MNTable3D) - the neighbours table particles are inserted into
groupID (int) - the group ID assigned to particles
tag (int) - the tag assigned to the generated particles (optional if not followed by list)
list (ShapeList) - the list of shapes to be inserted (optional)

Returns: void

generatePackingMaxVolume(...)

Parameters:

maxVolume (float) - the maximum cumulative volume of the inserted particles

setOldSeeding(...)

Sets old seeding behavior.

Parameters:

old (bool) - toggle between old and new seeding methods.

Class InsertGenerator3D

__init__(...) (Constructor)

__str__(...) (Informal representation operator)

generatePacking(...)

generatePackingMaxVolume(...)

setOldSeeding(...)

init(...)
(Constructor)

str(...)
(Informal representation operator)