C API Documentation
Public Member Functions | Static Public Member Functions | List of all members
rr::SteadyStateSolverFactory Class Reference

Constructs new integrators. More...

#include <SteadyStateSolver.h>

Public Member Functions

SteadyStateSolverNew (std::string name, ExecutableModel *m) const
 Constructs a new solver given the name (e.g. cvode, gillespie) More...
 
void registerSteadyStateSolver (SteadyStateSolverRegistrar *i)
 Registers a new solver with the factory so that it can be constructed. More...
 
std::size_t getNumSteadyStateSolvers () const
 
std::vector< std::string > getListSteadyStateSolverNames ()
 
std::string getSteadyStateSolverName (std::size_t n) const
 
std::string getSteadyStateSolverHint (std::size_t n) const
 
std::string getSteadyStateSolverDescription (std::size_t n) const
 

Static Public Member Functions

static SteadyStateSolverFactorygetInstance ()
 Returns the singleton instance of the solver factory. More...
 

Detailed Description

Constructs new integrators.

Author
JKM, WBC

Implements the factory and singleton patterns. Constructs a new integrator given the name (e.g. cvode, gillespie) and returns a base pointer to rr::SteadyStateSolver.

Member Function Documentation

◆ getInstance()

static SteadyStateSolverFactory& rr::SteadyStateSolverFactory::getInstance ( )
static

Returns the singleton instance of the solver factory.

Author
JKM, WBC

◆ New()

SteadyStateSolver* rr::SteadyStateSolverFactory::New ( std::string  name,
ExecutableModel m 
) const

Constructs a new solver given the name (e.g. cvode, gillespie)

Author
JKM, WBC

◆ registerSteadyStateSolver()

void rr::SteadyStateSolverFactory::registerSteadyStateSolver ( SteadyStateSolverRegistrar i)

Registers a new solver with the factory so that it can be constructed.

Author
JKM, WBC

Should be called at startup for new solvers.


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