Chaste  Release::3.4
RandomCellKiller.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 RANDOMCELLKILLER_HPP_
37 #define RANDOMCELLKILLER_HPP_
38 
39 #include "AbstractCellKiller.hpp"
40 #include "RandomNumberGenerator.hpp"
41 
42 #include "ChasteSerialization.hpp"
43 #include <boost/serialization/base_object.hpp>
44 
45 
62 template<unsigned DIM>
64 {
65 private:
66 
72 
81  template<class Archive>
82  void serialize(Archive & archive, const unsigned int version)
83  {
84  archive & boost::serialization::base_object<AbstractCellKiller<DIM> >(*this);
85 
86  // Make sure the random number generator is also archived
88  archive & p_rng_wrapper;
89  }
90 
91 public:
92 
99  RandomCellKiller(AbstractCellPopulation<DIM>* pCellPopulation, double probabilityOfDeathInAnHour);
100 
104  double GetDeathProbabilityInAnHour() const;
105 
111  void CheckAndLabelSingleCellForApoptosis(CellPtr pCell);
112 
118 
124  void OutputCellKillerParameters(out_stream& rParamsFile);
125 };
126 
129 
130 namespace boost
131 {
132 namespace serialization
133 {
137 template<class Archive, unsigned DIM>
138 inline void save_construct_data(
139  Archive & ar, const RandomCellKiller<DIM> * t, const unsigned int file_version)
140 {
141  // Save data required to construct instance
142  const AbstractCellPopulation<DIM>* const p_cell_population = t->GetCellPopulation();
143  ar << p_cell_population;
144  double prob = t->GetDeathProbabilityInAnHour();
145  ar << prob;
146 }
147 
151 template<class Archive, unsigned DIM>
152 inline void load_construct_data(
153  Archive & ar, RandomCellKiller<DIM> * t, const unsigned int file_version)
154 {
155  // Retrieve data from archive required to construct new instance
156  AbstractCellPopulation<DIM>* p_cell_population;
157  ar >> p_cell_population;
158  double prob;
159  ar >> prob;
160 
161  // Invoke inplace constructor to initialise instance
162  ::new(t)RandomCellKiller<DIM>(p_cell_population, prob);
163 }
164 }
165 } // namespace ...
166 
167 #endif /*RANDOMCELLKILLER_HPP_*/
double mProbabilityOfDeathInAnHour
void serialize(Archive &archive, const unsigned int version)
double GetDeathProbabilityInAnHour() const
void OutputCellKillerParameters(out_stream &rParamsFile)
RandomCellKiller(AbstractCellPopulation< DIM > *pCellPopulation, double probabilityOfDeathInAnHour)
const AbstractCellPopulation< SPACE_DIM > * GetCellPopulation() const
void CheckAndLabelSingleCellForApoptosis(CellPtr pCell)
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)
friend class boost::serialization::access
static RandomNumberGenerator * Instance()
void CheckAndLabelCellsForApoptosisOrDeath()
SerializableSingleton< SINGLETON_CLASS > * GetSerializationWrapper() const