Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
PlaneBasedCellKiller.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 PLANEBASEDCELLKILLER_HPP_
37#define PLANEBASEDCELLKILLER_HPP_
38
39#include "AbstractCellKiller.hpp"
40
42#include <boost/serialization/base_object.hpp>
43#include <boost/serialization/vector.hpp>
44
50template<unsigned DIM>
52{
53private:
54
58 c_vector<double, DIM> mPointOnPlane;
59
63 c_vector<double, DIM> mNormalToPlane;
64
73 template<class Archive>
74 void serialize(Archive & archive, const unsigned int version)
75 {
76 archive & boost::serialization::base_object<AbstractCellKiller<DIM> >(*this);
77 }
78
79public:
80
89 c_vector<double, DIM> point,
90 c_vector<double, DIM> normal);
91
95 const c_vector<double, DIM>& rGetPointOnPlane() const;
96
100 const c_vector<double, DIM>& rGetNormalToPlane() const;
101
106
112 void OutputCellKillerParameters(out_stream& rParamsFile);
113};
114
117
118namespace boost
119{
120namespace serialization
121{
125template<class Archive, unsigned DIM>
126inline void save_construct_data(
127 Archive & ar, const PlaneBasedCellKiller<DIM> * t, const unsigned int file_version)
128{
129 // Save data required to construct instance
130 const AbstractCellPopulation<DIM>* const p_cell_population = t->GetCellPopulation();
131 ar << p_cell_population;
132
133 // Archive c_vectors one component at a time
134 c_vector<double, DIM> point = t->rGetPointOnPlane();
135 for (unsigned i=0; i<DIM; i++)
136 {
137 ar << point[i];
138 }
139 c_vector<double, DIM> normal = t->rGetNormalToPlane();
140 for (unsigned i=0; i<DIM; i++)
141 {
142 ar << normal[i];
143 }
144}
145
149template<class Archive, unsigned DIM>
150inline void load_construct_data(
151 Archive & ar, PlaneBasedCellKiller<DIM> * t, const unsigned int file_version)
152{
153 // Retrieve data from archive required to construct new instance
154 AbstractCellPopulation<DIM>* p_cell_population;
155 ar >> p_cell_population;
156
157 // Archive c_vectors one component at a time
158 c_vector<double, DIM> point;
159 for (unsigned i=0; i<DIM; i++)
160 {
161 ar >> point[i];
162 }
163 c_vector<double, DIM> normal;
164 for (unsigned i=0; i<DIM; i++)
165 {
166 ar >> normal[i];
167 }
168
169 // Invoke inplace constructor to initialise instance
170 ::new(t)PlaneBasedCellKiller<DIM>(p_cell_population, point, normal);
171}
172}
173} // namespace ...
174
175#endif /*PLANEBASEDCELLKILLER_HPP_*/
gcov doesn't like this file...
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)
void serialize(Archive &archive, const unsigned int version)
void OutputCellKillerParameters(out_stream &rParamsFile)
const c_vector< double, DIM > & rGetNormalToPlane() const
c_vector< double, DIM > mNormalToPlane
const c_vector< double, DIM > & rGetPointOnPlane() const
friend class boost::serialization::access
c_vector< double, DIM > mPointOnPlane
virtual void CheckAndLabelCellsForApoptosisOrDeath()