CellCycleModelOdeSolver< CELL_CYCLE_MODEL, ODE_SOLVER > Class Template Reference

#include <CellCycleModelOdeSolver.hpp>

Inherits AbstractCellCycleModelOdeSolver, and boost::noncopyable.

Collaboration diagram for CellCycleModelOdeSolver< CELL_CYCLE_MODEL, ODE_SOLVER >:

Public Member Functions
bool	IsSetUp ()
void	Initialise ()
virtual bool	IsAdaptive ()
Static Public Member Functions
static boost::shared_ptr < CellCycleModelOdeSolver < CELL_CYCLE_MODEL, ODE_SOLVER > >	Instance ()
Private Member Functions
	CellCycleModelOdeSolver ()
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)
Static Private Attributes
static boost::shared_ptr < CellCycleModelOdeSolver < CELL_CYCLE_MODEL, ODE_SOLVER > >	mpInstance
Friends
class	boost::serialization::access

Detailed Description

template<class CELL_CYCLE_MODEL, class ODE_SOLVER>
class CellCycleModelOdeSolver< CELL_CYCLE_MODEL, ODE_SOLVER >

A concrete implementation of AbstractCellCycleModelOdeSolver, that uses templates to provide an implementation for any pair of cell-cycle model and ODE solver classes.

All ODE-based cell-cycle model developers need to do is set mpOdeSolver in their constructor: mpOdeSolver = CellCycleModelOdeSolver<CELL_CYCLE_MODEL, ODE_SOLVER>::Instance();

This class contains all the machinery to make it a singleton, hence providing exactly one instance per pair of values of the template parameters.

Definition at line 58 of file CellCycleModelOdeSolver.hpp.

Constructor & Destructor Documentation

template<class CELL_CYCLE_MODEL , class ODE_SOLVER >

CellCycleModelOdeSolver< CELL_CYCLE_MODEL, ODE_SOLVER >::CellCycleModelOdeSolver ( ) [inline, private]

Default constructor. Not user accessible; to obtain an instance of this class use the Instance method.

The semantics of shared_ptr are different from normal pointers; we don't care if a second instance is constructed when loading an archive, since archiving the shared_ptr will ensure that the 'singleton' is correctly serialized. Thus, here we do not require an assertion that mpInstance is NULL, as we do in the constructors of the SimulationTime singleton class.

Definition at line 108 of file CellCycleModelOdeSolver.hpp.

Member Function Documentation

template<class CELL_CYCLE_MODEL , class ODE_SOLVER >

void CellCycleModelOdeSolver< CELL_CYCLE_MODEL, ODE_SOLVER >::Initialise ( void ) [inline, virtual]

Initialise the ODE solver.

Implements AbstractCellCycleModelOdeSolver.

Definition at line 137 of file CellCycleModelOdeSolver.hpp.

References AbstractCellCycleModelOdeSolver::mpOdeSolver.

template<class CELL_CYCLE_MODEL , class ODE_SOLVER >

boost::shared_ptr< CellCycleModelOdeSolver< CELL_CYCLE_MODEL, ODE_SOLVER > > CellCycleModelOdeSolver< CELL_CYCLE_MODEL, ODE_SOLVER >::Instance ( ) [inline, static]

Returns:: a pointer to the singleton instance, creating it if necessary.

Definition at line 121 of file CellCycleModelOdeSolver.hpp.

References CellCycleModelOdeSolver< CELL_CYCLE_MODEL, ODE_SOLVER >::mpInstance.

template<class CELL_CYCLE_MODEL , class ODE_SOLVER >

bool CellCycleModelOdeSolver< CELL_CYCLE_MODEL, ODE_SOLVER >::IsAdaptive ( ) [inline, virtual]

Returns:: true iff this is an adaptive solver such as CVODE for which it is safe to set the 'timestep' to be the outer simulation timestep, because the ODE solver will use this as its maximum, not actual, timestep.

By default calls the base class version; it is defined here so that specializations can override it.

Reimplemented from AbstractCellCycleModelOdeSolver.

Definition at line 152 of file CellCycleModelOdeSolver.hpp.

template<class CELL_CYCLE_MODEL , class ODE_SOLVER >

bool CellCycleModelOdeSolver< CELL_CYCLE_MODEL, ODE_SOLVER >::IsSetUp ( ) [inline, virtual]

Returns:: whether the instance in existence and fully set up.

Implements AbstractCellCycleModelOdeSolver.

Definition at line 131 of file CellCycleModelOdeSolver.hpp.

References AbstractCellCycleModelOdeSolver::mpOdeSolver.

template<class CELL_CYCLE_MODEL , class ODE_SOLVER >

template<class Archive >

void CellCycleModelOdeSolver< CELL_CYCLE_MODEL, ODE_SOLVER >::serialize	(	Archive &	archive,
		const unsigned int	version
	)			`[inline, private]`

Archive the cell-cycle model, never used directly - boost uses this.

Parameters:

	archive	the archive
	version	the current version of this class

Reimplemented from AbstractCellCycleModelOdeSolver.

Definition at line 76 of file CellCycleModelOdeSolver.hpp.

References CellCycleModelOdeSolver< CELL_CYCLE_MODEL, ODE_SOLVER >::mpInstance.

Friends And Related Function Documentation

template<class CELL_CYCLE_MODEL , class ODE_SOLVER >

friend class boost::serialization::access [friend]

Needed for serialization.

Reimplemented from AbstractCellCycleModelOdeSolver.

Definition at line 68 of file CellCycleModelOdeSolver.hpp.

Member Data Documentation

template<class CELL_CYCLE_MODEL , class ODE_SOLVER >

boost::shared_ptr< CellCycleModelOdeSolver< CELL_CYCLE_MODEL, ODE_SOLVER > > CellCycleModelOdeSolver< CELL_CYCLE_MODEL, ODE_SOLVER >::mpInstance [inline, static, private]

The single instance of this class, for this ODE_SOLVER.

Definition of the instance static member.

Definition at line 62 of file CellCycleModelOdeSolver.hpp.

Referenced by CellCycleModelOdeSolver< CELL_CYCLE_MODEL, BackwardEulerIvpOdeSolver >::Instance(), CellCycleModelOdeSolver< CELL_CYCLE_MODEL, ODE_SOLVER >::Instance(), CellCycleModelOdeSolver< CELL_CYCLE_MODEL, BackwardEulerIvpOdeSolver >::serialize(), and CellCycleModelOdeSolver< CELL_CYCLE_MODEL, ODE_SOLVER >::serialize().

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