Chaste  Release::3.4
CellCycleModelOdeSolver< CELL_CYCLE_MODEL, BackwardEulerIvpOdeSolver > Class Template Reference

#include <CellCycleModelOdeSolver.hpp>

+ Inheritance diagram for CellCycleModelOdeSolver< CELL_CYCLE_MODEL, BackwardEulerIvpOdeSolver >:
+ Collaboration diagram for CellCycleModelOdeSolver< CELL_CYCLE_MODEL, BackwardEulerIvpOdeSolver >:

Public Member Functions

bool IsSetUp ()
 
void Initialise ()
 
void Reset ()
 
- Public Member Functions inherited from AbstractCellCycleModelOdeSolver
 AbstractCellCycleModelOdeSolver ()
 
virtual ~AbstractCellCycleModelOdeSolver ()
 
void SolveAndUpdateStateVariable (AbstractOdeSystem *pAbstractOdeSystem, double startTime, double endTime, double timeStep)
 
bool StoppingEventOccurred ()
 
double GetStoppingTime ()
 
void SetSizeOfOdeSystem (unsigned sizeOfOdeSystem)
 
unsigned GetSizeOfOdeSystem ()
 
void CheckForStoppingEvents ()
 
void SetMaxSteps (long int numSteps)
 
void SetTolerances (double relTol=1e-4, double absTol=1e-6)
 
virtual bool IsAdaptive ()
 

Static Public Member Functions

static boost::shared_ptr
< CellCycleModelOdeSolver
< CELL_CYCLE_MODEL,
BackwardEulerIvpOdeSolver > > 
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,
BackwardEulerIvpOdeSolver > > 
mpInstance
 

Friends

class boost::serialization::access
 

Additional Inherited Members

- Protected Attributes inherited from AbstractCellCycleModelOdeSolver
boost::shared_ptr
< AbstractIvpOdeSolver
mpOdeSolver
 
unsigned mSizeOfOdeSystem
 

Detailed Description

template<class CELL_CYCLE_MODEL>
class CellCycleModelOdeSolver< CELL_CYCLE_MODEL, BackwardEulerIvpOdeSolver >

Specialization for BackwardEulerIvpOdeSolver, whose constructor requires an argument.

Definition at line 163 of file CellCycleModelOdeSolver.hpp.

Constructor & Destructor Documentation

template<class CELL_CYCLE_MODEL >
CellCycleModelOdeSolver< CELL_CYCLE_MODEL, BackwardEulerIvpOdeSolver >::CellCycleModelOdeSolver ( )
private

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

Definition at line 205 of file CellCycleModelOdeSolver.hpp.

Member Function Documentation

template<class CELL_CYCLE_MODEL >
void CellCycleModelOdeSolver< CELL_CYCLE_MODEL, BackwardEulerIvpOdeSolver >::Initialise ( void  )
virtual
template<class CELL_CYCLE_MODEL >
boost::shared_ptr< CellCycleModelOdeSolver< CELL_CYCLE_MODEL, BackwardEulerIvpOdeSolver > > CellCycleModelOdeSolver< CELL_CYCLE_MODEL, BackwardEulerIvpOdeSolver >::Instance ( )
static
Returns
a pointer to the singleton instance, creating it if necessary.

Definition at line 211 of file CellCycleModelOdeSolver.hpp.

References CellCycleModelOdeSolver< CELL_CYCLE_MODEL, ODE_SOLVER >::mpInstance.

template<class CELL_CYCLE_MODEL >
bool CellCycleModelOdeSolver< CELL_CYCLE_MODEL, BackwardEulerIvpOdeSolver >::IsSetUp ( )
virtual
Returns
whether the instance in existence and fully set up.

Implements AbstractCellCycleModelOdeSolver.

Definition at line 221 of file CellCycleModelOdeSolver.hpp.

References AbstractCellCycleModelOdeSolver::mpOdeSolver, AbstractCellCycleModelOdeSolver::mSizeOfOdeSystem, and UNSIGNED_UNSET.

template<class CELL_CYCLE_MODEL >
void CellCycleModelOdeSolver< CELL_CYCLE_MODEL, BackwardEulerIvpOdeSolver >::Reset ( )
virtual
template<class CELL_CYCLE_MODEL >
template<class Archive >
void CellCycleModelOdeSolver< CELL_CYCLE_MODEL, BackwardEulerIvpOdeSolver >::serialize ( Archive &  archive,
const unsigned int  version 
)
inlineprivate

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

Parameters
archivethe archive
versionthe current version of this class

Definition at line 181 of file CellCycleModelOdeSolver.hpp.

References CellCycleModelOdeSolver< CELL_CYCLE_MODEL, ODE_SOLVER >::mpInstance.

Friends And Related Function Documentation

template<class CELL_CYCLE_MODEL >
friend class boost::serialization::access
friend

Needed for serialization.

Definition at line 173 of file CellCycleModelOdeSolver.hpp.

Member Data Documentation

template<class CELL_CYCLE_MODEL >
boost::shared_ptr< CellCycleModelOdeSolver< CELL_CYCLE_MODEL, BackwardEulerIvpOdeSolver > > CellCycleModelOdeSolver< CELL_CYCLE_MODEL, BackwardEulerIvpOdeSolver >::mpInstance
staticprivate

The single instance of this class, for this ODE_SOLVER.

Definition at line 167 of file CellCycleModelOdeSolver.hpp.


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