A particle generator that adds particles to a particular region of a simulation.
More...
A particle generator that adds particles to a particular region of a simulation.
| def pySTDLM.Distributions.ParticleGenerator.__init__ |
( |
|
self, |
|
|
|
gen, |
|
|
|
ptype |
|
) |
| |
Constructor.
- Parameters
-
| gen | A PDF set for x,y,z that on the domain [-1,1] and range [0,1) where x is the range of interest |
| ptype | The name of the particle |
| def pySTDLM.Distributions.ParticleGenerator.addParticlesToRegion |
( |
|
self, |
|
|
|
rdmesim, |
|
|
|
region, |
|
|
|
number, |
|
|
|
directions, |
|
|
|
spatial = None |
|
) |
| |
Add a number of particles to a region based on Monte-Carlo sampling of the generator.
- Parameters
-
| self | |
| rdmesim | An RDME simulation object that has already been "discretized" |
| region | A region name of the simulation to add particles to |
| number | The number of the particle to add |
| directions | A list of the form (x,y,z) where a 0 indicates a uniform distribution in that direction and a 1 indicates the particles are sampled from the generator in that direction |
| spatial | (OPTIONAL) A definition of a subsection of the domain that this generation should occur in as a list of lists [[xl,yl,zl],[xh,yh,zh]], otherwise the generator is scaled from (0,0,0) to domain extends (w,h,d) |
| pySTDLM.Distributions.ParticleGenerator.addedLast |
| pySTDLM.Distributions.ParticleGenerator.generator |
| pySTDLM.Distributions.ParticleGenerator.particlename |
| pySTDLM.Distributions.ParticleGenerator.totalAdded |
The documentation for this class was generated from the following file:
1.8.6
