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

Class SingleParticleGrainGen

        object --+        
                 |        
       ??.instance --+    
                     |    
GeometryPy.RndGrainGen --+
                         |
                        SingleParticleGrainGen

Grain generator which can be used in conjunction with the GougeConfigPrms and GrainRandomBoxPacker classes. Generates grains which consist of a single particle.


See Also: getGrain

Instance Methods [hide private]
 
__init__(self, minGRadius, maxGRadius)
Initialise generator.
Grain
getGrain(self, p)
Returns a grain consisting of a single particle which is copy-constructed from p.

Inherited from GeometryPy.RndGrainGen: __reduce__, getMaxGrainRadius, getMaxParticleRadius, getMinGrainRadius, getMinParticleRadius

Inherited from unreachable.instance: __new__

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

Class Variables [hide private]

Inherited from GeometryPy.RndGrainGen: __instance_size__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, minGRadius, maxGRadius)
(Constructor)

 

Initialise generator.

Parameters:
  • minGRadius (float) - minimum grain radius
  • maxGRadius (float) - maximum grain radius
Overrides: object.__init__

getGrain(self, p)

 

Returns a grain consisting of a single particle which is copy-constructed from p.

Parameters:
Returns: Grain
A grain consisting of a single particle.
Overrides: GeometryPy.RndGrainGen.getGrain