Module gengeo :: Class HexAggregateInsertGenerator3D

Class HexAggregateInsertGenerator3D

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

A particle packing algorithm for filling AVolume3D volumes with hexahedral aggregates of particles

Instance Methods

[hide private]

void

__init__(...)
Initialises a particle packer in preparation for filling an AVolume3D with hexahedral aggregates whose bounding sphere radii are in the specified range.

__str__(...)
str(x)

void

generatePacking(...)
Generates a particle assembly to fill the specified volume with hexahedral aggregrates whose constituent particles have the specified particle tag

generatePackingMaxVolume(...)
Fill the specified AVolume3D with particles until the accumulated particle volume exceeds the specified maxVolume.

Inherited from InsertGenerator3D: setNextTag, setOldSeeding

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]

Inherited from InsertGenerator3D: __instance_size__

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(...)
(Constructor)

Initialises a particle packer in preparation for filling an AVolume3D with hexahedral aggregates whose bounding sphere radii are in the specified range. The algorithm consists of two stages: 1) the AVolume3D is packed with particles of a specified radius range; 2) each particle is replaced with a hexahedral grain of particles of equal size

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

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 with hexahedral aggregrates whose constituent particles have the specified particle tag

Parameters:

volume (AVolume3D) - the volume to fill with particles
ntable (MNTable3D) - the neighbours table that particles are inserted into
groupID (int) - the group ID assigned to particles (default: 0)
tag (int) - the tag assigned to the generated particles (optional (default: -1))

Returns: void

Overrides: InsertGenerator3D.generatePacking

generatePackingMaxVolume(...)

Fill the specified AVolume3D with particles until the accumulated particle volume exceeds the specified maxVolume.

Parameters:

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

Overrides: InsertGenerator3D.generatePackingMaxVolume

Class HexAggregateInsertGenerator3D

__init__(...) (Constructor)

__str__(...) (Informal representation operator)

generatePacking(...)

generatePackingMaxVolume(...)

init(...)
(Constructor)

str(...)
(Informal representation operator)