Chaste  Release::3.4
SloughingCellKiller.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 SLOUGHINGCELLKILLER_HPP_
37 #define SLOUGHINGCELLKILLER_HPP_
38 
39 #include "AbstractCellKiller.hpp"
40 
41 #include "ChasteSerialization.hpp"
42 #include <boost/serialization/base_object.hpp>
43 
50 template<unsigned DIM>
52 {
53 private:
54 
57 
62  double mSloughHeight;
63 
68  double mSloughWidth;
69 
78  template<class Archive>
79  void serialize(Archive & archive, const unsigned int version)
80  {
81  archive & boost::serialization::base_object<AbstractCellKiller<DIM> >(*this);
82  }
83 
84 public:
85 
95  double sloughHeight,
96  bool sloughSides = false,
97  double sloughWidth = 10.0);
98 
102  virtual ~SloughingCellKiller(){};
103 
107  bool GetSloughSides() const;
108 
112  double GetSloughHeight() const;
113 
117  double GetSloughWidth() const;
118 
123 
132  void OutputCellKillerParameters(out_stream& rParamsFile);
133 };
134 
137 
138 namespace boost
139 {
140 namespace serialization
141 {
145 template<class Archive, unsigned DIM>
146 inline void save_construct_data(
147  Archive & ar, const SloughingCellKiller<DIM> * t, const unsigned int file_version)
148 {
149  // Save data required to construct instance
150  const AbstractCellPopulation<DIM>* const p_crypt = t->GetCellPopulation();
151  ar << p_crypt;
152  bool slough_sides = t->GetSloughSides();
153  ar << slough_sides;
154  double slough_height = t->GetSloughHeight();
155  ar << slough_height;
156  double slough_width = t->GetSloughWidth();
157  ar << slough_width;
158 }
159 
163 template<class Archive, unsigned DIM>
164 inline void load_construct_data(
165  Archive & ar, SloughingCellKiller<DIM> * t, const unsigned int file_version)
166 {
167  // Retrieve data from archive required to construct new instance
169  ar >> p_crypt;
170  bool slough_sides;
171  ar >> slough_sides;
172  double slough_height;
173  ar >> slough_height;
174  double slough_width;
175  ar >> slough_width;
176 
177  // Invoke inplace constructor to initialise instance
178  ::new(t)SloughingCellKiller<DIM>(p_crypt, slough_height, slough_sides, slough_width);
179 }
180 }
181 } // namespace ...
182 
183 #endif /*SLOUGHINGCELLKILLER_HPP_*/
void OutputCellKillerParameters(out_stream &rParamsFile)
const AbstractCellPopulation< SPACE_DIM > * GetCellPopulation() const
virtual void CheckAndLabelCellsForApoptosisOrDeath()
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)
friend class boost::serialization::access
double GetSloughWidth() const
double GetSloughHeight() const
void serialize(Archive &archive, const unsigned int version)
SloughingCellKiller(AbstractCellPopulation< DIM > *pCrypt, double sloughHeight, bool sloughSides=false, double sloughWidth=10.0)