Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
|
#include <LabelDependentBernoulliTrialCellCycleModel.hpp>
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 |
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.
|
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().
rModel | the cell cycle model to copy. |
Definition at line 48 of file LabelDependentBernoulliTrialCellCycleModel.cpp.
LabelDependentBernoulliTrialCellCycleModel::LabelDependentBernoulliTrialCellCycleModel | ( | ) |
Constructor.
Definition at line 40 of file LabelDependentBernoulliTrialCellCycleModel.cpp.
Referenced by CreateCellCycleModel().
|
virtual |
Overridden builder method to create new instances of the cell-cycle model.
Implements AbstractCellCycleModel.
Definition at line 89 of file LabelDependentBernoulliTrialCellCycleModel.cpp.
References LabelDependentBernoulliTrialCellCycleModel().
|
virtual |
Overridden GetAverageStemCellCycleTime() method.
Implements AbstractCellCycleModel.
Definition at line 129 of file LabelDependentBernoulliTrialCellCycleModel.cpp.
References mDivisionProbability.
|
virtual |
Overridden GetAverageTransitCellCycleTime() method.
Implements AbstractCellCycleModel.
Definition at line 124 of file LabelDependentBernoulliTrialCellCycleModel.cpp.
References mDivisionProbability.
double LabelDependentBernoulliTrialCellCycleModel::GetDivisionProbability | ( | ) |
Get mDivisionProbability.
Definition at line 99 of file LabelDependentBernoulliTrialCellCycleModel.cpp.
References mDivisionProbability.
double LabelDependentBernoulliTrialCellCycleModel::GetLabelledDivisionProbability | ( | ) |
Get mLabelledDivisionProbability.
Definition at line 109 of file LabelDependentBernoulliTrialCellCycleModel.cpp.
References mLabelledDivisionProbability.
double LabelDependentBernoulliTrialCellCycleModel::GetMinimumDivisionAge | ( | ) |
Get mMinimumDivisionAge.
Definition at line 119 of file LabelDependentBernoulliTrialCellCycleModel.cpp.
References mMinimumDivisionAge.
|
virtual |
Overridden OutputCellCycleModelParameters() method.
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().
|
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.
Implements AbstractCellCycleModel.
Definition at line 62 of file LabelDependentBernoulliTrialCellCycleModel.cpp.
References AbstractCellCycleModel::GetAge(), SimulationTime::GetTimeStep(), SimulationTime::Instance(), RandomNumberGenerator::Instance(), mDivisionProbability, mLabelledDivisionProbability, mMinimumDivisionAge, AbstractCellCycleModel::mpCell, AbstractCellCycleModel::mReadyToDivide, and RandomNumberGenerator::ranf().
|
inlineprivate |
Boost Serialization method for archiving/checkpointing
archive | The boost archive. |
version | The current version of this class. |
Definition at line 63 of file LabelDependentBernoulliTrialCellCycleModel.hpp.
References SerializableSingleton< SINGLETON_CLASS >::GetSerializationWrapper(), RandomNumberGenerator::Instance(), mDivisionProbability, mLabelledDivisionProbability, and mMinimumDivisionAge.
void LabelDependentBernoulliTrialCellCycleModel::SetDivisionProbability | ( | double | divisionProbability | ) |
Set the value of mDivisionProbability.
divisionProbability | the new value of mDivisionProbability |
Definition at line 94 of file LabelDependentBernoulliTrialCellCycleModel.cpp.
References mDivisionProbability.
void LabelDependentBernoulliTrialCellCycleModel::SetLabelledDivisionProbability | ( | double | labelledDivisionProbability | ) |
Set the value of mLabelledDivisionProbability.
labelledDivisionProbability | the new value of mLabelledDivisionProbability |
Definition at line 104 of file LabelDependentBernoulliTrialCellCycleModel.cpp.
References mLabelledDivisionProbability.
void LabelDependentBernoulliTrialCellCycleModel::SetMinimumDivisionAge | ( | double | minimumDivisionAge | ) |
Set the value of mMinimumDivisionAge.
minimumDivisionAge | the new value of mMinimumDivisionAge |
Definition at line 114 of file LabelDependentBernoulliTrialCellCycleModel.cpp.
References mMinimumDivisionAge.
|
friend |
Definition at line 55 of file LabelDependentBernoulliTrialCellCycleModel.hpp.
|
protected |
Probability of dividing per hour for unlabelled cells. Defaults to 0.1.
Definition at line 81 of file LabelDependentBernoulliTrialCellCycleModel.hpp.
Referenced by GetAverageStemCellCycleTime(), GetAverageTransitCellCycleTime(), GetDivisionProbability(), OutputCellCycleModelParameters(), ReadyToDivide(), serialize(), and SetDivisionProbability().
|
protected |
Probability of dividing per hour for labelled cells. Defaults to 0.1.
Definition at line 87 of file LabelDependentBernoulliTrialCellCycleModel.hpp.
Referenced by GetLabelledDivisionProbability(), ReadyToDivide(), serialize(), and SetLabelledDivisionProbability().
|
protected |
Minimum age of a cell at which it may divide. Defaults to 1 hour.
Definition at line 93 of file LabelDependentBernoulliTrialCellCycleModel.hpp.
Referenced by GetMinimumDivisionAge(), OutputCellCycleModelParameters(), ReadyToDivide(), serialize(), and SetMinimumDivisionAge().