Chaste Commit::1fd4e48e3990e67db148bc1bc4cf6991a0049d0c
|
#include <BernoulliTrialCellCycleModel.hpp>
Protected Member Functions | |
BernoulliTrialCellCycleModel (const BernoulliTrialCellCycleModel &rModel) | |
Protected Member Functions inherited from AbstractCellCycleModel | |
AbstractCellCycleModel (const AbstractCellCycleModel &rModel) | |
Protected Attributes | |
double | mDivisionProbability |
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.
The class includes two parameters: the first, mDivisionProbability, defines the probability of dividing per hour; the second, mMinimumDivisionAge, defines a minimum age at which cells may divide.
Definition at line 50 of file BernoulliTrialCellCycleModel.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 46 of file BernoulliTrialCellCycleModel.cpp.
BernoulliTrialCellCycleModel::BernoulliTrialCellCycleModel | ( | ) |
Constructor.
Definition at line 39 of file BernoulliTrialCellCycleModel.cpp.
Referenced by CreateCellCycleModel().
|
virtual |
Overridden builder method to create new instances of the cell-cycle model.
Implements AbstractCellCycleModel.
Definition at line 81 of file BernoulliTrialCellCycleModel.cpp.
References BernoulliTrialCellCycleModel().
|
virtual |
Overridden GetAverageStemCellCycleTime() method.
Implements AbstractCellCycleModel.
Definition at line 111 of file BernoulliTrialCellCycleModel.cpp.
References mDivisionProbability.
|
virtual |
Overridden GetAverageTransitCellCycleTime() method.
Implements AbstractCellCycleModel.
Definition at line 106 of file BernoulliTrialCellCycleModel.cpp.
References mDivisionProbability.
double BernoulliTrialCellCycleModel::GetDivisionProbability | ( | ) |
Get mDivisionProbability.
Definition at line 91 of file BernoulliTrialCellCycleModel.cpp.
References mDivisionProbability.
double BernoulliTrialCellCycleModel::GetMinimumDivisionAge | ( | ) |
Get mMinimumDivisionAge.
Definition at line 101 of file BernoulliTrialCellCycleModel.cpp.
References mMinimumDivisionAge.
|
virtual |
Overridden OutputCellCycleModelParameters() method.
rParamsFile | the file stream to which the parameters are output |
Implements AbstractCellCycleModel.
Definition at line 116 of file BernoulliTrialCellCycleModel.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 59 of file BernoulliTrialCellCycleModel.cpp.
References AbstractCellCycleModel::GetAge(), SimulationTime::GetTimeStep(), SimulationTime::Instance(), RandomNumberGenerator::Instance(), mDivisionProbability, 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 62 of file BernoulliTrialCellCycleModel.hpp.
References SerializableSingleton< SINGLETON_CLASS >::GetSerializationWrapper(), RandomNumberGenerator::Instance(), mDivisionProbability, and mMinimumDivisionAge.
void BernoulliTrialCellCycleModel::SetDivisionProbability | ( | double | divisionProbability | ) |
Set the value of mDivisionProbability.
divisionProbability | the new value of mDivisionProbability |
Definition at line 86 of file BernoulliTrialCellCycleModel.cpp.
References mDivisionProbability.
void BernoulliTrialCellCycleModel::SetMinimumDivisionAge | ( | double | minimumDivisionAge | ) |
Set the value of mMinimumDivisionAge.
minimumDivisionAge | the new value of mMinimumDivisionAge |
Definition at line 96 of file BernoulliTrialCellCycleModel.cpp.
References mMinimumDivisionAge.
|
friend |
Definition at line 54 of file BernoulliTrialCellCycleModel.hpp.
|
protected |
Probability of dividing per hour. Defaults to 0.1.
Definition at line 79 of file BernoulliTrialCellCycleModel.hpp.
Referenced by GetAverageStemCellCycleTime(), GetAverageTransitCellCycleTime(), GetDivisionProbability(), OutputCellCycleModelParameters(), ReadyToDivide(), serialize(), and SetDivisionProbability().
|
protected |
Minimum age of a cell at which it may divide. Defaults to 1 hour.
Definition at line 85 of file BernoulliTrialCellCycleModel.hpp.
Referenced by GetMinimumDivisionAge(), OutputCellCycleModelParameters(), ReadyToDivide(), serialize(), and SetMinimumDivisionAge().