Chaste  Release::3.4
Alarcon2004OxygenBasedCellCycleOdeSystem.hpp
1 /*
2 
3 Copyright (c) 2005-2016, 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 #ifndef _ALARCON2004OXYGENBASEDCELLCYCLEODESYSTEM_HPP_
37 #define _ALARCON2004OXYGENBASEDCELLCYCLEODESYSTEM_HPP_
38 
39 #include "ChasteSerialization.hpp"
40 #include <boost/serialization/base_object.hpp>
41 
42 #include <cmath>
43 
44 #include "AbstractOdeSystem.hpp"
45 
60 {
61 private:
62 
68  double ma1;
70  double ma2;
72  double ma3;
74  double ma4;
76  double mb3;
78  double mb4;
80  double mc1;
82  double mc2;
84  double md1;
86  double md2;
88  double mJ3;
90  double mJ4;
92  double mEta;
94  double mMstar;
96  double mB;
98  double mxThreshold;
100  double myThreshold;
101 
104 
107 
108  friend class boost::serialization::access;
115  template<class Archive>
116  void serialize(Archive & archive, const unsigned int version)
117  {
118  archive & boost::serialization::base_object<AbstractOdeSystem>(*this);
119  }
120 
121 public:
122 
130  Alarcon2004OxygenBasedCellCycleOdeSystem(double oxygenConcentration,
131  bool isLabelled,
132  std::vector<double> stateVariables=std::vector<double>());
133 
138 
142  void Init();
143 
154  void EvaluateYDerivatives(double time, const std::vector<double>& rY, std::vector<double>& rDY);
155 
164  bool CalculateStoppingEvent(double time, const std::vector<double>& rY);
165 
171  void SetIsLabelled(bool isLabelled);
172 
176  bool IsLabelled() const;
177 
181  double GetOxygenConcentration() const;
182 };
183 
184 // Declare identifier for the serializer
187 
188 namespace boost
189 {
190 namespace serialization
191 {
195 template<class Archive>
196 inline void save_construct_data(
197  Archive & ar, const Alarcon2004OxygenBasedCellCycleOdeSystem * t, const unsigned int file_version)
198 {
199  // Save data required to construct instance
200  const double oxygen_concentration = t->GetOxygenConcentration();
201  ar & oxygen_concentration;
202 
203  const bool is_labelled = t->IsLabelled();
204  ar & is_labelled;
205 
206  const std::vector<double> state_variables = t->rGetConstStateVariables();
207  ar & state_variables;
208 }
209 
213 template<class Archive>
214 inline void load_construct_data(
215  Archive & ar, Alarcon2004OxygenBasedCellCycleOdeSystem * t, const unsigned int file_version)
216 {
217  // Retrieve data from archive required to construct new instance
218  double oxygen_concentration;
219  ar & oxygen_concentration;
220 
221  bool is_labelled;
222  ar & is_labelled;
223 
224  std::vector<double> state_variables;
225  ar & state_variables;
226 
227  // Invoke inplace constructor to initialise instance
228  ::new(t)Alarcon2004OxygenBasedCellCycleOdeSystem(oxygen_concentration, is_labelled, state_variables);
229 }
230 }
231 } // namespace ...
232 
233 #endif /*_ALARCON2004OXYGENBASEDCELLCYCLEODESYSTEM_HPP_*/
const std::vector< double > & rGetConstStateVariables() const
void EvaluateYDerivatives(double time, const std::vector< double > &rY, std::vector< double > &rDY)
#define CHASTE_CLASS_EXPORT(T)
bool CalculateStoppingEvent(double time, const std::vector< double > &rY)
Alarcon2004OxygenBasedCellCycleOdeSystem(double oxygenConcentration, bool isLabelled, std::vector< double > stateVariables=std::vector< double >())
void serialize(Archive &archive, const unsigned int version)