Lattice Microbes 2.5
This is for whole cell modeling
Loading...
Searching...
No Matches
lm::me::MESolver Class Referenceabstract

An abstract base class for all Master Equation solvers, this is essentially a representation of "the simulation instance". More...

#include <MESolver.h>

Inheritance diagram for lm::me::MESolver:
[legend]

Public Member Functions

 MESolver ()
 Create the MESolver.
virtual ~MESolver ()
virtual void initialize (unsigned int replicate, map< string, string > *parameters, ResourceAllocator::ComputeResources *resources)=0
 Initialize the simulation.
virtual bool needsReactionModel ()=0
 Tells whether the solver needs a reaction model.
virtual bool needsDiffusionModel ()=0
 Tells whether the solver needs a reaction model.
virtual void generateTrajectory ()=0
 Actually run the simulation.

Detailed Description

An abstract base class for all Master Equation solvers, this is essentially a representation of "the simulation instance".

Constructor & Destructor Documentation

◆ MESolver()

lm::me::MESolver::MESolver ( )

Create the MESolver.

◆ ~MESolver()

lm::me::MESolver::~MESolver ( )
virtual

Member Function Documentation

◆ generateTrajectory()

virtual void lm::me::MESolver::generateTrajectory ( )
pure virtual

◆ initialize()

virtual void lm::me::MESolver::initialize ( unsigned int replicate,
map< string, string > * parameters,
ResourceAllocator::ComputeResources * resources )
pure virtual

Initialize the simulation.

Parameters
replicateReplicate number out of total replicates
parametersA map of all the parameters for the simulation
Alist of resources assigned to the simulation

Implemented in CMESolver, lm::cme::CMESolver, 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:

◆ needsDiffusionModel()

virtual bool lm::me::MESolver::needsDiffusionModel ( )
pure virtual

◆ needsReactionModel()

virtual bool lm::me::MESolver::needsReactionModel ( )
pure virtual

The documentation for this class was generated from the following files:
  • /data2/LM_zls_github/Lattice-Microbes/src/me/MESolver.h
  • /data2/LM_zls_github/Lattice-Microbes/src/me/MESolver.cpp