Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
FixedVertexBasedDivisionRule.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 FIXEDVERTEXBASEDDIVISIONRULE_HPP_
37#define FIXEDVERTEXBASEDDIVISIONRULE_HPP_
38
40#include <boost/serialization/base_object.hpp>
41#include <boost/serialization/vector.hpp>
42
43#include "AbstractVertexBasedDivisionRule.hpp"
44#include "VertexBasedCellPopulation.hpp"
45
46// Forward declaration prevents circular include chain
47template<unsigned SPACE_DIM> class VertexBasedCellPopulation;
48template<unsigned SPACE_DIM> class AbstractVertexBasedDivisionRule;
49
56template<unsigned SPACE_DIM>
58{
59private:
60
65 c_vector<double, SPACE_DIM> mDivisionVector;
66
67 friend class boost::serialization::access;
74 template<class Archive>
75 void serialize(Archive & archive, const unsigned int version)
76 {
77 archive & boost::serialization::base_object<AbstractVertexBasedDivisionRule<SPACE_DIM> >(*this);
78 }
79
80public:
81
87 FixedVertexBasedDivisionRule(c_vector<double, SPACE_DIM>& rDivisionVector);
88
93 {
94 }
95
99 const c_vector<double, SPACE_DIM>& rGetDivisionVector() const;
100
108 virtual c_vector<double, SPACE_DIM> CalculateCellDivisionVector(CellPtr pParentCell,
109 VertexBasedCellPopulation<SPACE_DIM>& rCellPopulation);
110};
111
114
115namespace boost
116{
117namespace serialization
118{
122template<class Archive, unsigned SPACE_DIM>
123inline void save_construct_data(
124 Archive & ar, const FixedVertexBasedDivisionRule<SPACE_DIM>* t, const unsigned int file_version)
125{
126 // Archive c_vector one component at a time
127 c_vector<double, SPACE_DIM> vector = t->rGetDivisionVector();
128 for (unsigned i=0; i<SPACE_DIM; i++)
129 {
130 ar << vector[i];
131 }
132}
133
137template<class Archive, unsigned SPACE_DIM>
138inline void load_construct_data(
139 Archive & ar, FixedVertexBasedDivisionRule<SPACE_DIM>* t, const unsigned int file_version)
140{
141 // Archive c_vector one component at a time
142 c_vector<double, SPACE_DIM> vector;
143 for (unsigned i=0; i<SPACE_DIM; i++)
144 {
145 ar >> vector[i];
146 }
147
148 // Invoke inplace constructor to initialise instance
150}
151}
152} // namespace ...
153
154#endif // FIXEDVERTEXBASEDDIVISIONRULE_HPP_
gcov doesn't like this file...
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)
void serialize(Archive &archive, const unsigned int version)
virtual c_vector< double, SPACE_DIM > CalculateCellDivisionVector(CellPtr pParentCell, VertexBasedCellPopulation< SPACE_DIM > &rCellPopulation)
c_vector< double, SPACE_DIM > mDivisionVector
const c_vector< double, SPACE_DIM > & rGetDivisionVector() const