Lattice Microbes 2.5
This is for whole cell modeling
Loading...
Searching...
No Matches
lm::rdme::RDMESolver Class Reference

#include <RDMESolver.h>

Inheritance diagram for lm::rdme::RDMESolver:
[legend]
Collaboration diagram for lm::rdme::RDMESolver:
[legend]

Public Member Functions

 RDMESolver (RandomGenerator::Distributions neededDists)
virtual ~RDMESolver ()
virtual void setDiffusionModel (DiffusionModel *dm, const uint8_t *lattice, size_t latticeSize, const uint8_t *latticeSites, size_t latticeSitesSize)
virtual void buildDiffusionModel (const uint numberSiteTypesA, const double *DFA, const uint *RLA, lattice_size_t latticeXSize, lattice_size_t latticeYSize, lattice_size_t latticeZSize, site_size_t particlesPerSite, const unsigned int bytes_per_particle, si_dist_t latticeSpacing, const uint8_t *latticeData, const uint8_t *latticeSitesData, bool rowMajorData=true)
Public Member Functions inherited from lm::cme::CMESolver
 CMESolver (RandomGenerator::Distributions neededDists)
virtual ~CMESolver ()
virtual void initialize (unsigned int replicate, map< string, string > *parameters, ResourceAllocator::ComputeResources *resources)
 Initialize the simulation.
virtual void setReactionModel (lm::io::ReactionModel *reactionModel)
virtual void buildModel (const uint numberSpecies, const uint numberReactions, const uint *initialSpeciesCounts, const uint *reactionTypesA, const double *k, const int *S, const uint *D, const uint kCols=1)
virtual void setModelPropensityFunction (uint reaction, double(*propensityFunction)(double time, uint *speciesCounts, void *args), void *propensityFunctionArg)
virtual void setSpeciesUpperLimit (uint species, uint limit)
virtual void setSpeciesLowerLimit (uint species, uint limit)
virtual void setFptTrackingList (list< uint > speciesList)
virtual void addToParameterTrackingList (pair< string, double * >parameter)
virtual void generateTrajectory ()=0
 Actually run the simulation.
virtual void setReactionRateCME (unsigned int reactionId, double rate)
virtual void getSpeciesCountView (uint **counts, int *number)
virtual void getReactionRateConstantsView (int reactionNumber, double **rates, int *rateConstantCount)
Public Member Functions inherited from lm::me::MESolver
 MESolver ()
 Create the MESolver.
virtual ~MESolver ()
virtual bool needsReactionModel ()=0
 Tells whether the solver needs a reaction model.
virtual bool needsDiffusionModel ()=0
 Tells whether the solver needs a reaction model.

Protected Member Functions

virtual void allocateDiffusionModel (uint numberSiteTypesA, lattice_size_t latticeXSize, lattice_size_t latticeYSize, lattice_size_t latticeZSize, site_size_t particlesPerSite, unsigned int bytes_per_particle, si_dist_t latticeSpacing)
virtual void allocateLattice (lattice_size_t latticeXSize, lattice_size_t latticeYSize, lattice_size_t latticeZSize, site_size_t particlesPerSite, unsigned int bytes_per_particle, si_dist_t latticeSpacing)
virtual void setLatticeData (const uint8_t *latticeData)
virtual void setLatticeSitesData (const uint8_t *latticeSitesData)
virtual void destroyDiffusionModel ()
Protected Member Functions inherited from lm::cme::CMESolver
virtual void allocateModel (uint numberSpecies, uint numberReactions)
virtual void destroyModel ()
virtual double recordParameters (double nextRecordTime, double recordInterval, double simulationTime)
virtual void queueRecordedParameters (bool flush=false)
void updateSpeciesCounts (uint r)
bool reachedSpeciesLimit ()
virtual int hookSimulation (double time)
virtual int onBeginTrajectory ()
virtual int onEndTrajectory ()

Protected Attributes

uint numberSiteTypes
double * DF
uintRL
Latticelattice
Protected Attributes inherited from lm::cme::CMESolver
RandomGenerator::Distributions neededDists
unsigned int replicate
map< string, string > * parameters
ResourceAllocator::ComputeResourcesresources
RandomGeneratorrng
uint numberSpecies
uint numberSpeciesToTrack
uint numberReactions
uintinitialSpeciesCounts
uintspeciesCounts
uintreactionTypes
int * S
uintD
void ** propensityFunctions
void ** propensityFunctionArgs
list< PropensityArgs * > propensityArgs
uint numberSpeciesLimits
SpeciesLimitspeciesLimits
uint numberFptTrackedSpecies
FPTTrackingfptTrackedSpecies
list< TrackedParametertrackedParameters
uintnumberDependentSpecies
uint ** dependentSpecies
int ** dependentSpeciesChange
uintnumberDependentReactions
uint ** dependentReactions

Additional Inherited Members

Static Protected Member Functions inherited from lm::cme::CMESolver
static double zerothOrderPropensity (double time, uint *speciesCounts, void *pargs)
static double firstOrderPropensity (double time, uint *speciesCounts, void *pargs)
static double secondOrderPropensity (double time, uint *speciesCounts, void *pargs)
static double secondOrderSelfPropensity (double time, uint *speciesCounts, void *pargs)
static double kHillPropensity (double time, uint *speciesCounts, void *pargs)
static double kHillTransportPropensity (double time, uint *speciesCounts, void *pargs)
static double zerothOrderHeavisidePropensity (double time, uint *speciesCounts, void *pargs)
static double michaelisMentenPropensity (double time, uint *speciesCounts, void *pargs)
static double competitiveMMPropensity (double time, uint *speciesCounts, void *pargs)
static double uncompetitiveMMPropensity (double time, uint *speciesCounts, void *pargs)
static double noncompetitiveMMPropensity (double time, uint *speciesCounts, void *pargs)

Constructor & Destructor Documentation

◆ RDMESolver()

lm::rdme::RDMESolver::RDMESolver ( RandomGenerator::Distributions neededDists)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ ~RDMESolver()

lm::rdme::RDMESolver::~RDMESolver ( )
virtual
Here is the call graph for this function:

Member Function Documentation

◆ allocateDiffusionModel()

void lm::rdme::RDMESolver::allocateDiffusionModel ( uint numberSiteTypesA,
lattice_size_t latticeXSize,
lattice_size_t latticeYSize,
lattice_size_t latticeZSize,
site_size_t particlesPerSite,
unsigned int bytes_per_particle,
si_dist_t latticeSpacing )
protectedvirtual
Here is the call graph for this function:
Here is the caller graph for this function:

◆ allocateLattice()

void lm::rdme::RDMESolver::allocateLattice ( lattice_size_t latticeXSize,
lattice_size_t latticeYSize,
lattice_size_t latticeZSize,
site_size_t particlesPerSite,
unsigned int bytes_per_particle,
si_dist_t latticeSpacing )
protectedvirtual

Reimplemented in lm::MpdRdmeSolverExtended, lm::rdme::IntMpdRdmeSolver, lm::rdme::MGPUIntMpdRdmeSolver, lm::rdme::MGPUMpdRdmeSolver, lm::rdme::MpdRdmeSolver, lm::rdme::MPIMpdRdmeSolver, and MpdRdmeSolver.

Here is the caller graph for this function:

◆ buildDiffusionModel()

void lm::rdme::RDMESolver::buildDiffusionModel ( const uint numberSiteTypesA,
const double * DFA,
const uint * RLA,
lattice_size_t latticeXSize,
lattice_size_t latticeYSize,
lattice_size_t latticeZSize,
site_size_t particlesPerSite,
const unsigned int bytes_per_particle,
si_dist_t latticeSpacing,
const uint8_t * latticeData,
const uint8_t * latticeSitesData,
bool rowMajorData = true )
virtual

Reimplemented in lm::MpdRdmeSolverExtended, lm::rdme::IntMpdRdmeSolver, lm::rdme::IntMpdRdmeSolverExtended, lm::rdme::MGPUIntMpdRdmeSolver, lm::rdme::MGPUMpdRdmeSolver, lm::rdme::MpdRdmeSolver, lm::rdme::MPIMpdRdmeSolver, lm::rdme::NextSubvolumeSolver, and MpdRdmeSolver.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ destroyDiffusionModel()

void lm::rdme::RDMESolver::destroyDiffusionModel ( )
protectedvirtual

Reimplemented in lm::rdme::NextSubvolumeSolver.

Here is the caller graph for this function:

◆ setDiffusionModel()

void lm::rdme::RDMESolver::setDiffusionModel ( DiffusionModel * dm,
const uint8_t * lattice,
size_t latticeSize,
const uint8_t * latticeSites,
size_t latticeSitesSize )
virtual
Here is the call graph for this function:

◆ setLatticeData()

void lm::rdme::RDMESolver::setLatticeData ( const uint8_t * latticeData)
protectedvirtual

Reimplemented in lm::rdme::IntMpdRdmeSolver, and lm::rdme::MGPUIntMpdRdmeSolver.

Here is the caller graph for this function:

◆ setLatticeSitesData()

void lm::rdme::RDMESolver::setLatticeSitesData ( const uint8_t * latticeSitesData)
protectedvirtual
Here is the caller graph for this function:

Member Data Documentation

◆ DF

double* lm::rdme::RDMESolver::DF
protected

◆ lattice

Lattice* lm::rdme::RDMESolver::lattice
protected

◆ numberSiteTypes

uint lm::rdme::RDMESolver::numberSiteTypes
protected

◆ RL

uint* lm::rdme::RDMESolver::RL
protected

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