Chaste  Release::3.4
DeltaNotchSrnModel Class Reference

#include <DeltaNotchSrnModel.hpp>

+ Inheritance diagram for DeltaNotchSrnModel:
+ Collaboration diagram for DeltaNotchSrnModel:

Public Member Functions

 DeltaNotchSrnModel (boost::shared_ptr< AbstractCellCycleModelOdeSolver > pOdeSolver=boost::shared_ptr< AbstractCellCycleModelOdeSolver >())
 
AbstractSrnModelCreateSrnModel ()
 
void Initialise ()
 
void SimulateToCurrentTime ()
 
void UpdateDeltaNotch ()
 
double GetNotch ()
 
double GetDelta ()
 
double GetMeanNeighbouringDelta ()
 
void OutputSrnModelParameters (out_stream &rParamsFile)
 
- Public Member Functions inherited from AbstractOdeSrnModel
 AbstractOdeSrnModel (unsigned stateSize, boost::shared_ptr< AbstractCellCycleModelOdeSolver > pOdeSolver=boost::shared_ptr< AbstractCellCycleModelOdeSolver >())
 
virtual ~AbstractOdeSrnModel ()
 
virtual void ResetForDivision ()
 
void SetFinishedRunningOdes (bool finishedRunningOdes)
 
void SetInitialConditions (std::vector< double > initialConditions)
 
const std::vector< double > & GetStateVariables ()
 
- Public Member Functions inherited from AbstractSrnModel
 AbstractSrnModel ()
 
virtual ~AbstractSrnModel ()
 
void SetCell (CellPtr pCell)
 
virtual void InitialiseDaughterCell ()
 
CellPtr GetCell ()
 
void SetSimulatedToTime (double simulatedToTime)
 
double GetSimulatedToTime ()
 
void OutputSrnModelInfo (out_stream &rParamsFile)
 
- Public Member Functions inherited from Identifiable
virtual ~Identifiable ()
 
std::string GetIdentifier () const
 
- Public Member Functions inherited from CellCycleModelOdeHandler
 CellCycleModelOdeHandler (double lastTime=SimulationTime::Instance() ->GetTime(), boost::shared_ptr< AbstractCellCycleModelOdeSolver > pOdeSolver=boost::shared_ptr< AbstractCellCycleModelOdeSolver >())
 
virtual ~CellCycleModelOdeHandler ()
 
AbstractOdeSystemGetOdeSystem () const
 
void SetOdeSystem (AbstractOdeSystem *pOdeSystem)
 
const boost::shared_ptr
< AbstractCellCycleModelOdeSolver
GetOdeSolver () const
 
void SetLastTime (double lastTime)
 
double GetDt ()
 
void SetDt (double timeStep)
 
void SetStateVariables (const std::vector< double > &rStateVariables)
 

Private Member Functions

template<class Archive >
void serialize (Archive &archive, const unsigned int version)
 

Friends

class boost::serialization::access
 

Additional Inherited Members

- Protected Member Functions inherited from AbstractOdeSrnModel
void Initialise (AbstractOdeSystem *pOdeSystem)
 
AbstractSrnModelCreateSrnModel (AbstractOdeSrnModel *pModel)
 
- Protected Member Functions inherited from CellCycleModelOdeHandler
bool SolveOdeToTime (double currentTime)
 
virtual void AdjustOdeParameters (double currentTime)
 
- Protected Attributes inherited from AbstractOdeSrnModel
bool mFinishedRunningOdes
 
std::vector< doublemInitialConditions
 
unsigned mStateSize
 
- Protected Attributes inherited from AbstractSrnModel
CellPtr mpCell
 
double mSimulatedToTime
 
- Protected Attributes inherited from CellCycleModelOdeHandler
double mDt
 
AbstractOdeSystemmpOdeSystem
 
boost::shared_ptr
< AbstractCellCycleModelOdeSolver
mpOdeSolver
 
double mLastTime
 

Detailed Description

A subclass of AbstractOdeSrnModel that includes a Delta-Notch ODE system in the sub-cellular reaction network.

Todo:
#2752 document this class more thoroughly here

Definition at line 50 of file DeltaNotchSrnModel.hpp.

Constructor & Destructor Documentation

DeltaNotchSrnModel::DeltaNotchSrnModel ( boost::shared_ptr< AbstractCellCycleModelOdeSolver pOdeSolver = boost::shared_ptr<AbstractCellCycleModelOdeSolver>())

Default constructor calls base class.

Parameters
pOdeSolverAn optional pointer to a cell-cycle model ODE solver object (allows the use of different ODE solvers)

Definition at line 39 of file DeltaNotchSrnModel.cpp.

References CellCycleModelOdeSolver< CELL_CYCLE_MODEL, ODE_SOLVER >::Instance(), CellCycleModelOdeHandler::mpOdeSolver, and CellCycleModelOdeHandler::SetDt().

Referenced by CreateSrnModel().

Member Function Documentation

AbstractSrnModel * DeltaNotchSrnModel::CreateSrnModel ( )
virtual

Overridden builder method to create new copies of this SRN model.

Returns
a copy of the current SRN model.

Implements AbstractSrnModel.

Definition at line 57 of file DeltaNotchSrnModel.cpp.

References AbstractSrnModel::CreateSrnModel(), DeltaNotchSrnModel(), CellCycleModelOdeHandler::mpOdeSolver, and CellCycleModelOdeHandler::SetOdeSystem().

double DeltaNotchSrnModel::GetDelta ( )
double DeltaNotchSrnModel::GetMeanNeighbouringDelta ( )
Returns
the current level of Delta neighbouring the cell.

Definition at line 106 of file DeltaNotchSrnModel.cpp.

References AbstractParameterisedSystem< VECTOR >::GetParameter(), and CellCycleModelOdeHandler::mpOdeSystem.

double DeltaNotchSrnModel::GetNotch ( )
void DeltaNotchSrnModel::Initialise ( void  )
virtual

Initialise the cell-cycle model at the start of a simulation.

This overridden method sets up a new Delta-Notch ODE system.

Reimplemented from AbstractSrnModel.

Definition at line 78 of file DeltaNotchSrnModel.cpp.

References AbstractSrnModel::Initialise().

void DeltaNotchSrnModel::OutputSrnModelParameters ( out_stream &  rParamsFile)
virtual

Output cell-cycle model parameters to file.

Parameters
rParamsFilethe file stream to which the parameters are output

Reimplemented from AbstractOdeSrnModel.

Definition at line 113 of file DeltaNotchSrnModel.cpp.

References AbstractOdeSrnModel::OutputSrnModelParameters().

template<class Archive >
void DeltaNotchSrnModel::serialize ( Archive &  archive,
const unsigned int  version 
)
inlineprivate

Archive the cell-cycle model and member variables.

Parameters
archivethe archive
versionthe current version of this class

Definition at line 63 of file DeltaNotchSrnModel.hpp.

void DeltaNotchSrnModel::SimulateToCurrentTime ( )
virtual

Overridden SimulateToTime() method for custom behaviour.

Todo:
#2752 say what it does in this class

Reimplemented from AbstractOdeSrnModel.

Definition at line 69 of file DeltaNotchSrnModel.cpp.

References AbstractOdeSrnModel::SimulateToCurrentTime(), and UpdateDeltaNotch().

void DeltaNotchSrnModel::UpdateDeltaNotch ( )

Update the current levels of Delta and Notch in the cell.

Definition at line 83 of file DeltaNotchSrnModel.cpp.

References AbstractSrnModel::mpCell, CellCycleModelOdeHandler::mpOdeSystem, and AbstractParameterisedSystem< VECTOR >::SetParameter().

Referenced by SimulateToCurrentTime().

Friends And Related Function Documentation

friend class boost::serialization::access
friend

Needed for serialization.

Definition at line 55 of file DeltaNotchSrnModel.hpp.


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