Lattice Microbes 2.5
This is for whole cell modeling
Loading...
Searching...
No Matches
pySTDLM.Distributions.ParticleGenerator Class Reference

Public Member Functions

 __init__ (self, gen, ptype)
 addParticlesToRegion (self, rdmesim, region, number, directions, spatial=None)

Public Attributes

 generator = gen
 particlename = ptype
int totalAdded = 0
int addedLast = 0

Detailed Description

A particle generator that adds particles to a particular region of a simulation.

Args:
    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

Constructor & Destructor Documentation

◆ __init__()

pySTDLM.Distributions.ParticleGenerator.__init__ ( self,
gen,
ptype )

Member Function Documentation

◆ addParticlesToRegion()

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

Args:
    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)

Member Data Documentation

◆ addedLast

int pySTDLM.Distributions.ParticleGenerator.addedLast = 0

◆ generator

pySTDLM.Distributions.ParticleGenerator.generator = gen

◆ particlename

pySTDLM.Distributions.ParticleGenerator.particlename = ptype

◆ totalAdded

pySTDLM.Distributions.ParticleGenerator.totalAdded = 0

The documentation for this class was generated from the following file: