#include <LabelDependentBernoulliTrialCellCycleModel.hpp>

Inheritance diagram for LabelDependentBernoulliTrialCellCycleModel:

Collaboration diagram for LabelDependentBernoulliTrialCellCycleModel:

Public Member Functions
	LabelDependentBernoulliTrialCellCycleModel ()

virtual bool	ReadyToDivide ()

AbstractCellCycleModel *	CreateCellCycleModel ()

void	SetDivisionProbability (double divisionProbability)

double	GetLabelledDivisionProbability ()

void	SetLabelledDivisionProbability (double labelledDivisionProbability)

double	GetDivisionProbability ()

void	SetMinimumDivisionAge (double minimumDivisionAge)

double	GetMinimumDivisionAge ()

double	GetAverageTransitCellCycleTime ()

double	GetAverageStemCellCycleTime ()

virtual void	OutputCellCycleModelParameters (out_stream &rParamsFile)

Public Member Functions inherited from AbstractCellCycleModel
	AbstractCellCycleModel ()

virtual	~AbstractCellCycleModel ()

void	SetCell (CellPtr pCell)

virtual void	Initialise ()

virtual void	InitialiseDaughterCell ()

CellPtr	GetCell ()

virtual void	SetBirthTime (double birthTime)

void	SetDimension (unsigned dimension)

unsigned	GetDimension () const

double	GetBirthTime () const

double	GetAge ()

virtual void	ResetForDivision ()

virtual bool	CanCellTerminallyDifferentiate ()

void	OutputCellCycleModelInfo (out_stream &rParamsFile)

Public Member Functions inherited from Identifiable
virtual	~Identifiable ()

std::string	GetIdentifier () const

Protected Member Functions
	LabelDependentBernoulliTrialCellCycleModel (const LabelDependentBernoulliTrialCellCycleModel &rModel)

Protected Member Functions inherited from AbstractCellCycleModel
	AbstractCellCycleModel (const AbstractCellCycleModel &rModel)

Protected Attributes
double	mDivisionProbability

double	mLabelledDivisionProbability

double	mMinimumDivisionAge

Protected Attributes inherited from AbstractCellCycleModel
CellPtr	mpCell

double	mBirthTime

bool	mReadyToDivide

unsigned	mDimension

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

Friends
class	boost::serialization::access

Detailed Description

Simple cell-cycle model where mature non-differentiated cells have a specified probability of dividing per hour, which depends on whether they are laballed.

The class includes three parameters: the first, mDivisionProbability, defines the probability of dividing per hour for unlabelled cells; the second, mLabelledDivisonProbability, defines the probability of dividing per hour for labelled cells; and the third, mMinimumDivisionAge, defines a minimum age at which any cells may divide.

Definition at line 51 of file LabelDependentBernoulliTrialCellCycleModel.hpp.

Constructor & Destructor Documentation

◆ LabelDependentBernoulliTrialCellCycleModel() [1/2]

LabelDependentBernoulliTrialCellCycleModel::LabelDependentBernoulliTrialCellCycleModel ( const LabelDependentBernoulliTrialCellCycleModel & rModel )

protected

Protected copy-constructor for use by CreateCellCycleModel.

The only way for external code to create a copy of a cell cycle model is by calling that method, to ensure that a model of the correct subclass is created. This copy-constructor helps subclasses to ensure that all member variables are correctly copied when this happens.

This method is called by child classes to set member variables for a daughter cell upon cell division. Note that the parent cell cycle model will have had ResetForDivision() called just before CreateCellCycleModel() is called, so performing an exact copy of the parent is suitable behaviour. Any daughter-cell-specific initialisation can be done in InitialiseDaughterCell().

Parameters

rModel the cell cycle model to copy.

Definition at line 48 of file LabelDependentBernoulliTrialCellCycleModel.cpp.

◆ LabelDependentBernoulliTrialCellCycleModel() [2/2]

LabelDependentBernoulliTrialCellCycleModel::LabelDependentBernoulliTrialCellCycleModel ( )

Constructor.

Definition at line 40 of file LabelDependentBernoulliTrialCellCycleModel.cpp.

Referenced by CreateCellCycleModel().

Member Function Documentation

◆ CreateCellCycleModel()

AbstractCellCycleModel * LabelDependentBernoulliTrialCellCycleModel::CreateCellCycleModel ( )

virtual

Overridden builder method to create new instances of the cell-cycle model.

Returns: new cell-cycle model

Implements AbstractCellCycleModel.

Definition at line 89 of file LabelDependentBernoulliTrialCellCycleModel.cpp.

References LabelDependentBernoulliTrialCellCycleModel().

◆ GetAverageStemCellCycleTime()

double LabelDependentBernoulliTrialCellCycleModel::GetAverageStemCellCycleTime ( )

virtual

Overridden GetAverageStemCellCycleTime() method.

Returns: the average cell cycle time for cells of stem proliferative type

Implements AbstractCellCycleModel.

Definition at line 129 of file LabelDependentBernoulliTrialCellCycleModel.cpp.

References mDivisionProbability.

◆ GetAverageTransitCellCycleTime()

double LabelDependentBernoulliTrialCellCycleModel::GetAverageTransitCellCycleTime ( )

virtual

Overridden GetAverageTransitCellCycleTime() method.

Returns: the average cell cycle time for cells of transit proliferative type

Implements AbstractCellCycleModel.

Definition at line 124 of file LabelDependentBernoulliTrialCellCycleModel.cpp.

References mDivisionProbability.

◆ GetDivisionProbability()

double LabelDependentBernoulliTrialCellCycleModel::GetDivisionProbability ( )

Get mDivisionProbability.

Returns: mDivisionProbability

Definition at line 99 of file LabelDependentBernoulliTrialCellCycleModel.cpp.

References mDivisionProbability.

◆ GetLabelledDivisionProbability()

double LabelDependentBernoulliTrialCellCycleModel::GetLabelledDivisionProbability ( )

Get mLabelledDivisionProbability.

Returns: mLabelledDivisionProbability

Definition at line 109 of file LabelDependentBernoulliTrialCellCycleModel.cpp.

References mLabelledDivisionProbability.

◆ GetMinimumDivisionAge()

double LabelDependentBernoulliTrialCellCycleModel::GetMinimumDivisionAge ( )

Get mMinimumDivisionAge.

Returns: mMinimumDivisionAge

Definition at line 119 of file LabelDependentBernoulliTrialCellCycleModel.cpp.

References mMinimumDivisionAge.

◆ OutputCellCycleModelParameters()

void LabelDependentBernoulliTrialCellCycleModel::OutputCellCycleModelParameters ( out_stream & rParamsFile )

virtual

Overridden OutputCellCycleModelParameters() method.

Parameters

rParamsFile the file stream to which the parameters are output

Implements AbstractCellCycleModel.

Definition at line 134 of file LabelDependentBernoulliTrialCellCycleModel.cpp.

References mDivisionProbability, mMinimumDivisionAge, and AbstractCellCycleModel::OutputCellCycleModelParameters().

◆ ReadyToDivide()

bool LabelDependentBernoulliTrialCellCycleModel::ReadyToDivide ( )

virtual

Overridden ReadyToDivide() method.

If the cell's age is greater than mMinimumDivisionAge, then we draw a uniform random number r ~ U[0,1]. If r < mDivisionProbability*dt, where dt is the simulation time step, then the cell is ready to divide and we return true. Otherwise, the cell is not yet ready to divide and we return false.