jLM.Analysis.LatticeAnalysisMixin Class Reference

Public Member Functions
	particleStatistics (self, particleLattice=None, siteLattice=None)

Protected Attributes
	_pCount
	_sCount = Lattice.latticeStatsAll(particleLattice, siteLattice)

Member Function Documentation

particleStatistics()

jLM.Analysis.LatticeAnalysisMixin.particleStatistics	(		self,
			particleLattice = None,
			siteLattice = None )

Compute properties of the particle lattice

Dictionary keys

countBySpeciesRegion
   Particle counts for each species type for each region.

concBySpeciesRegion
   Concentration for each species type for each region.

countByRegion
   Total particle counts for each region.

concByRegion
   Total concentration for each region.
 
countBySpecies
   Total particle counts for each species.

concBySpecies
   Total concentration of each species, averaged over 
   simulation volume

count
   Total particle count

conc
   Total concentration, averaged over simulation volume

vol
   Total simulation volume 

siteCount
   Total number of subvolumes

regionVol
   Volume of each region

regionCounts
   Number of subvolumes in each region
  
Returns: 
    dict:
       Particle lattice statistics

Member Data Documentation

_pCount

jLM.Analysis.LatticeAnalysisMixin._pCount

protected

_sCount

jLM.Analysis.LatticeAnalysisMixin._sCount = Lattice.latticeStatsAll(particleLattice, siteLattice)

protected

---

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

• /data2/LM_zls_github/Lattice-Microbes/src/jlm/jLM/Analysis.py