Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
AbstractSimpleGenerationalCellCycleModel.cpp
1/*
2
3Copyright (c) 2005-2024, University of Oxford.
4All rights reserved.
5
6University of Oxford means the Chancellor, Masters and Scholars of the
7University of Oxford, having an administrative office at Wellington
8Square, Oxford OX1 2JD, UK.
9
10This file is part of Chaste.
11
12Redistribution and use in source and binary forms, with or without
13modification, are permitted provided that the following conditions are met:
14 * Redistributions of source code must retain the above copyright notice,
15 this list of conditions and the following disclaimer.
16 * Redistributions in binary form must reproduce the above copyright notice,
17 this list of conditions and the following disclaimer in the documentation
18 and/or other materials provided with the distribution.
19 * Neither the name of the University of Oxford nor the names of its
20 contributors may be used to endorse or promote products derived from this
21 software without specific prior written permission.
22
23THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33
34*/
35
36#include "AbstractSimpleGenerationalCellCycleModel.hpp"
37#include "DifferentiatedCellProliferativeType.hpp"
38#include "StemCellProliferativeType.hpp"
39#include "TransitCellProliferativeType.hpp"
40
43 mGeneration(0),
44 mMaxTransitGenerations(3) // taken from Meineke et al, 2001 (doi:10.1046/j.0960-7722.2001.00216.x)
45{
46}
47
51
54 mGeneration(rModel.mGeneration),
55 mMaxTransitGenerations(rModel.mMaxTransitGenerations)
56{
57 /*
58 * Initialize only those member variables defined in this class.
59 *
60 * The member variables mCurrentCellCyclePhase, mG1Duration,
61 * mMinimumGapDuration, mStemCellG1Duration, mTransitCellG1Duration,
62 * mSDuration, mG2Duration and mMDuration are initialized in the
63 * AbstractPhaseBasedCellCycleModel constructor.
64 *
65 * The member variables mBirthTime, mReadyToDivide and mDimension
66 * are initialized in the AbstractCellCycleModel constructor.
67 *
68 * Note that mG1Duration is (re)set as soon as InitialiseDaughterCell()
69 * is called on the new cell-cycle model.
70 */
71}
72
74{
76 if (mpCell->GetCellProliferativeType()->IsType<StemCellProliferativeType>())
77 {
78 /*
79 * Run this check first to allow for mMaxTransitGenerations = 0
80 */
81 mGeneration = 0;
82 }
84 {
85 /*
86 * This method is usually called within a CellBasedSimulation, after the CellPopulation
87 * has called CellPropertyRegistry::TakeOwnership(). This means that were we to call
88 * CellPropertyRegistry::Instance() here when setting the CellProliferativeType, we
89 * would be creating a new CellPropertyRegistry. In this case the cell proliferative
90 * type counts, as returned by AbstractCellPopulation::GetCellProliferativeTypeCount(),
91 * would be incorrect. We must therefore access the CellProliferativeType via the cell's
92 * CellPropertyCollection.
93 */
94 boost::shared_ptr<AbstractCellProperty> p_diff_type =
95 mpCell->rGetCellPropertyCollection().GetCellPropertyRegistry()->Get<DifferentiatedCellProliferativeType>();
96 mpCell->SetCellProliferativeType(p_diff_type);
97 }
99}
100
102{
103 /*
104 * If the parent cell is a stem cell then its generation was reset
105 * to zero when ResetForDivision() was called. The daughter cell's
106 * generation must therefore be incremented here.
107 */
108 if (mGeneration == 0)
109 {
110 mGeneration = 1;
111 }
112 /*
113 * In generation-based cell-cycle models, the daughter cell
114 * is always of type transit or differentiated.
115 */
116 boost::shared_ptr<AbstractCellProperty> p_transit_type =
117 mpCell->rGetCellPropertyCollection().GetCellPropertyRegistry()->Get<TransitCellProliferativeType>();
118 mpCell->SetCellProliferativeType(p_transit_type);
119
121 {
122 boost::shared_ptr<AbstractCellProperty> p_diff_type =
123 mpCell->rGetCellPropertyCollection().GetCellPropertyRegistry()->Get<DifferentiatedCellProliferativeType>();
124 mpCell->SetCellProliferativeType(p_diff_type);
125 }
127}
128
130{
131 mGeneration = generation;
132}
133
138
140{
141 mMaxTransitGenerations = maxTransitGenerations;
142}
143
148
150{
151 *rParamsFile << "\t\t\t<MaxTransitGenerations>" << mMaxTransitGenerations << "</MaxTransitGenerations>\n";
152
153 // Call method on direct parent class
155}
virtual void OutputCellCycleModelParameters(out_stream &rParamsFile)