Chaste  Release::2018.1
ExponentialG1GenerationalCellCycleModel.cpp
1 /*
2 
3 Copyright (c) 2005-2018, University of Oxford.
4 All rights reserved.
5 
6 University of Oxford means the Chancellor, Masters and Scholars of the
7 University of Oxford, having an administrative office at Wellington
8 Square, Oxford OX1 2JD, UK.
9 
10 This file is part of Chaste.
11 
12 Redistribution and use in source and binary forms, with or without
13 modification, 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 
23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 
34 */
35 
36 #include "ExponentialG1GenerationalCellCycleModel.hpp"
37 #include "Exception.hpp"
38 #include "StemCellProliferativeType.hpp"
39 #include "TransitCellProliferativeType.hpp"
40 #include "DifferentiatedCellProliferativeType.hpp"
41 
44  mRate(1.0/mTransitCellG1Duration)
45 {
46 }
47 
50  mRate(rModel.mRate)
51 {
52  /*
53  * Initialize only the member variable defined in this class.
54  *
55  * The member variables mCurrentCellCyclePhase, mG1Duration,
56  * mMinimumGapDuration, mStemCellG1Duration, mTransitCellG1Duration,
57  * mSDuration, mG2Duration and mMDuration are initialized in the
58  * AbstractPhaseBasedCellCycleModel constructor.
59  *
60  * The member variables mBirthTime, mReadyToDivide and mDimension
61  * are initialized in the AbstractCellCycleModel constructor.
62  *
63  * Note that mG1Duration is (re)set as soon as InitialiseDaughterCell()
64  * is called on the new cell-cycle model.
65  */
66 }
67 
69 {
71 }
72 
74 {
76 
77  if (mpCell->GetCellProliferativeType()->IsType<StemCellProliferativeType>()
78  || mpCell->GetCellProliferativeType()->IsType<TransitCellProliferativeType>() )
79  {
80  // Generate an exponential random number with mScale
82  }
83  else if (mpCell->GetCellProliferativeType()->IsType<DifferentiatedCellProliferativeType>())
84  {
85  mG1Duration = DBL_MAX;
86  }
87  else
88  {
90  }
91 }
92 
94 {
95  return mRate;
96 }
97 
99 {
100  mRate = rate;
101 
102  // These are now set to the average value of the G1Duration
103  SetTransitCellG1Duration(1.0/rate);
104  SetStemCellG1Duration(1.0/rate);
105 }
106 
108 {
109  assert(stemCellG1Duration > 0.0);
110  mStemCellG1Duration = stemCellG1Duration;
111 
112  mRate = 1.0/stemCellG1Duration;
113 }
114 
116 {
117  assert(transitCellG1Duration > 0.0);
118  mTransitCellG1Duration = transitCellG1Duration;
119 
120  mRate = 1.0/transitCellG1Duration;
121 }
122 
124 {
125  *rParamsFile << "\t\t\t<Rate>" << mRate << "</Rate>\n";
126 
127  // Call method on direct parent class
129 }
130 
131 // Serialization for Boost >= 1.36
virtual void SetTransitCellG1Duration(double transitCellG1Duration)
virtual void OutputCellCycleModelParameters(out_stream &rParamsFile)
virtual void OutputCellCycleModelParameters(out_stream &rParamsFile)
#define NEVER_REACHED
Definition: Exception.hpp:206
static RandomNumberGenerator * Instance()
virtual void SetStemCellG1Duration(double stemCellG1Duration)
#define CHASTE_CLASS_EXPORT(T)
double ExponentialRandomDeviate(double scale)