CellCycleModelOdeSolver< CELL_CYCLE_MODEL, BackwardEulerIvpOdeSolver > Class Template Reference
#include <CellCycleModelOdeSolver.hpp>
Public Member Functions | |
| bool | IsSetUp () |
| void | Initialise () |
| void | Reset () |
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 |
Detailed Description
template<class CELL_CYCLE_MODEL>
class CellCycleModelOdeSolver< CELL_CYCLE_MODEL, BackwardEulerIvpOdeSolver >
Specialization for BackwardEulerIvpOdeSolver, whose constructor requires an argument.
Definition at line 146 of file CellCycleModelOdeSolver.hpp.
Constructor & Destructor Documentation
| CellCycleModelOdeSolver< CELL_CYCLE_MODEL, BackwardEulerIvpOdeSolver >::CellCycleModelOdeSolver | ( | ) | [inline, private] |
Default constructor. Not user accessible; to obtain an instance of this class use the Instance method.
Definition at line 188 of file CellCycleModelOdeSolver.hpp.
Member Function Documentation
| void CellCycleModelOdeSolver< CELL_CYCLE_MODEL, BackwardEulerIvpOdeSolver >::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 164 of file CellCycleModelOdeSolver.hpp.
References CellCycleModelOdeSolver< CELL_CYCLE_MODEL, ODE_SOLVER >::mpInstance.
| boost::shared_ptr< CellCycleModelOdeSolver< CELL_CYCLE_MODEL, BackwardEulerIvpOdeSolver > > CellCycleModelOdeSolver< CELL_CYCLE_MODEL, BackwardEulerIvpOdeSolver >::Instance | ( | ) | [inline, static] |
Return a pointer to the singleton instance, creating it if necessary.
Definition at line 194 of file CellCycleModelOdeSolver.hpp.
References CellCycleModelOdeSolver< CELL_CYCLE_MODEL, ODE_SOLVER >::mpInstance.
| bool CellCycleModelOdeSolver< CELL_CYCLE_MODEL, BackwardEulerIvpOdeSolver >::IsSetUp | ( | ) | [inline, virtual] |
Is the instance in existence and fully set up.
Implements AbstractCellCycleModelOdeSolver.
Definition at line 204 of file CellCycleModelOdeSolver.hpp.
References AbstractCellCycleModelOdeSolver::mpOdeSolver, AbstractCellCycleModelOdeSolver::mSizeOfOdeSystem, and UNSIGNED_UNSET.
| void CellCycleModelOdeSolver< CELL_CYCLE_MODEL, BackwardEulerIvpOdeSolver >::Initialise | ( | void | ) | [inline, virtual] |
Initialise the ODE solver.
Implements AbstractCellCycleModelOdeSolver.
Definition at line 210 of file CellCycleModelOdeSolver.hpp.
References EXCEPTION, AbstractCellCycleModelOdeSolver::mpOdeSolver, AbstractCellCycleModelOdeSolver::mSizeOfOdeSystem, and UNSIGNED_UNSET.
| void CellCycleModelOdeSolver< CELL_CYCLE_MODEL, BackwardEulerIvpOdeSolver >::Reset | ( | ) | [inline, virtual] |
Reset the instance.
Reimplemented from AbstractCellCycleModelOdeSolver.
Definition at line 220 of file CellCycleModelOdeSolver.hpp.
References AbstractCellCycleModelOdeSolver::mpOdeSolver, AbstractCellCycleModelOdeSolver::mSizeOfOdeSystem, and UNSIGNED_UNSET.
Friends And Related Function Documentation
friend class boost::serialization::access [friend] |
Needed for serialization.
Reimplemented from AbstractCellCycleModelOdeSolver.
Definition at line 156 of file CellCycleModelOdeSolver.hpp.
Member Data Documentation
boost::shared_ptr< CellCycleModelOdeSolver< CELL_CYCLE_MODEL, BackwardEulerIvpOdeSolver > > CellCycleModelOdeSolver< CELL_CYCLE_MODEL, BackwardEulerIvpOdeSolver >::mpInstance [inline, static, private] |
The single instance of this class, for this ODE_SOLVER.
Definition at line 150 of file CellCycleModelOdeSolver.hpp.
The documentation for this class was generated from the following file:
- cell_based/src/population/cell/cycle/CellCycleModelOdeSolver.hpp
