Module gengeo :: Class HexAggregateInsertGenerator2DRand

[hide private]
[frames] | no frames]

# Class HexAggregateInsertGenerator2DRand

           object --+
                    |
          ??.instance --+
                        |
             AGenerator2D --+
                            |
            InsertGenerator2D --+
                                |
    HexAggregateInsertGenerator2D --+
                                    |
                                   HexAggregateInsertGenerator2DRand

A particle packing algorithm for filling 2D spaces with hexagonal aggregates of particles

Instance Methods | [hide private]

void

__init__(...) Initialises a particle packer in preparation for filling a 2D space with hexagonal aggregates whose radii are in the specified range. |

__str__(...) str(x) |

Inherited from `InsertGenerator2D`: `generatePacking`, `setOldSeeding` Inherited from `AGenerator2D`: `__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 2D space with hexagonal aggregates whose radii are in the specified range. The algorithm consists of three stages: 1) the AVolume2D is packed with particles of a specified radius range; 2) each particle is replaced with a hexagonal grain of particles of equal size; 3) for each hexagonal grain, one of the particles within the grain is removed with a specified probability, `removeProb`

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
  - `removeProb` (double) - the probability that one particle is removed from a hexagonal grain during packing
Returns: void
Overrides: object.__init__

### __str__(...)
(Informal representation operator)

str(x)

Overrides: object.__str__
  (inherited documentation)