Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
RandomCellKiller.hpp
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#ifndef RANDOMCELLKILLER_HPP_
37#define RANDOMCELLKILLER_HPP_
38
39#include "AbstractCellKiller.hpp"
40#include "RandomNumberGenerator.hpp"
41
43#include <boost/serialization/base_object.hpp>
44
45
62template<unsigned DIM>
64{
65private:
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
91public:
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
130namespace boost
131{
132namespace serialization
133{
137template<class Archive, unsigned DIM>
138inline 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
151template<class Archive, unsigned DIM>
152inline 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_*/
gcov doesn't like this file...
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)
double GetDeathProbabilityInAnHour() const
void OutputCellKillerParameters(out_stream &rParamsFile)
void CheckAndLabelCellsForApoptosisOrDeath()
void serialize(Archive &archive, const unsigned int version)
friend class boost::serialization::access
void CheckAndLabelSingleCellForApoptosis(CellPtr pCell)
static RandomNumberGenerator * Instance()
SerializableSingleton< SINGLETON_CLASS > * GetSerializationWrapper() const