Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
DivisionBiasTrackingModifier.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 DIVISIONBIASTRACKINGMODIFIER_HPP_
37#define DIVISIONBIASTRACKINGMODIFIER_HPP_
38
40#include <boost/serialization/base_object.hpp>
41
42#include "AbstractCellBasedSimulationModifier.hpp"
43
51template<unsigned DIM>
53{
54private:
55
60 c_vector<double, DIM> mDivisionBiasVector;
61
71 template<class Archive>
72 void serialize(Archive & archive, const unsigned int version)
73 {
74 archive & boost::serialization::base_object<AbstractCellBasedSimulationModifier<DIM,DIM> >(*this);
75 }
76
77public:
78
84 DivisionBiasTrackingModifier(c_vector<double, DIM> divisionBiasVector);
85
90
94 const c_vector<double, DIM>& rGetDivisionBiasVector() const;
95
103 virtual void UpdateAtEndOfTimeStep(AbstractCellPopulation<DIM,DIM>& rCellPopulation);
104
113 virtual void SetupSolve(AbstractCellPopulation<DIM,DIM>& rCellPopulation, std::string outputDirectory);
114
121 void UpdateCellData(AbstractCellPopulation<DIM,DIM>& rCellPopulation);
122
129 void OutputSimulationModifierParameters(out_stream& rParamsFile);
130};
131
134
135namespace boost
136{
137namespace serialization
138{
142template<class Archive, unsigned DIM>
143inline void save_construct_data(
144 Archive & ar, const DivisionBiasTrackingModifier<DIM>* t, const unsigned int file_version)
145{
146 // Archive c_vector one component at a time
147 c_vector<double, DIM> point = t->rGetDivisionBiasVector();
148 for (unsigned i=0; i<DIM; i++)
149 {
150 ar << point[i];
151 }
152}
153
157template<class Archive, unsigned DIM>
158inline void load_construct_data(
159 Archive & ar, DivisionBiasTrackingModifier<DIM>* t, const unsigned int file_version)
160{
161 // Retrieve c_vector one component at a time
162 c_vector<double, DIM> point;
163 for (unsigned i=0; i<DIM; i++)
164 {
165 ar >> point[i];
166 }
167
168 // Invoke inplace constructor to initialise instance
170}
171}
172} // namespace ...
173
174#endif /*DIVISIONBIASTRACKINGMODIFIER_HPP_*/
gcov doesn't like this file...
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)
virtual void UpdateAtEndOfTimeStep(AbstractCellPopulation< DIM, DIM > &rCellPopulation)
void UpdateCellData(AbstractCellPopulation< DIM, DIM > &rCellPopulation)
void serialize(Archive &archive, const unsigned int version)
void OutputSimulationModifierParameters(out_stream &rParamsFile)
const c_vector< double, DIM > & rGetDivisionBiasVector() const
friend class boost::serialization::access
virtual void SetupSolve(AbstractCellPopulation< DIM, DIM > &rCellPopulation, std::string outputDirectory)