Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
PlaneBoundaryCondition.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 PLANEBOUNDARYCONDITION_HPP_
37#define PLANEBOUNDARYCONDITION_HPP_
38
39#include "AbstractCellPopulationBoundaryCondition.hpp"
40
42#include <boost/serialization/base_object.hpp>
43#include <boost/serialization/vector.hpp>
44
51template<unsigned ELEMENT_DIM, unsigned SPACE_DIM=ELEMENT_DIM>
53{
54private:
55
59 c_vector<double, SPACE_DIM> mPointOnPlane;
60
64 c_vector<double, SPACE_DIM> mNormalToPlane;
65
71
80 template<class Archive>
81 void serialize(Archive & archive, const unsigned int version)
82 {
83 archive & boost::serialization::base_object<AbstractCellPopulationBoundaryCondition<ELEMENT_DIM, SPACE_DIM> >(*this);
84 //archive & mUseJiggledNodesOnPlane;
85 }
86
87public:
88
97 c_vector<double, SPACE_DIM> point,
98 c_vector<double, SPACE_DIM> normal);
99
103 const c_vector<double, SPACE_DIM>& rGetPointOnPlane() const;
104
108 const c_vector<double, SPACE_DIM>& rGetNormalToPlane() const;
109
115 void SetUseJiggledNodesOnPlane(bool useJiggledNodesOnPlane);
116
119
127 void ImposeBoundaryCondition(const std::map<Node<SPACE_DIM>*, c_vector<double, SPACE_DIM> >& rOldLocations);
128
137
144 void OutputCellPopulationBoundaryConditionParameters(out_stream& rParamsFile);
145};
146
149
150namespace boost
151{
152namespace serialization
153{
157template<class Archive, unsigned ELEMENT_DIM, unsigned SPACE_DIM>
158inline void save_construct_data(
159 Archive & ar, const PlaneBoundaryCondition<ELEMENT_DIM, SPACE_DIM>* t, const unsigned int file_version)
160{
161 // Save data required to construct instance
162 const AbstractCellPopulation<ELEMENT_DIM, SPACE_DIM>* const p_cell_population = t->GetCellPopulation();
163 ar << p_cell_population;
164
165 // Archive c_vectors one component at a time
166 c_vector<double, SPACE_DIM> point = t->rGetPointOnPlane();
167 for (unsigned i=0; i<SPACE_DIM; i++)
168 {
169 ar << point[i];
170 }
171 c_vector<double, SPACE_DIM> normal = t->rGetNormalToPlane();
172 for (unsigned i=0; i<SPACE_DIM; i++)
173 {
174 ar << normal[i];
175 }
176}
177
181template<class Archive, unsigned ELEMENT_DIM, unsigned SPACE_DIM>
182inline void load_construct_data(
183 Archive & ar, PlaneBoundaryCondition<ELEMENT_DIM, SPACE_DIM>* t, const unsigned int file_version)
184{
185 // Retrieve data from archive required to construct new instance
187 ar >> p_cell_population;
188
189 // Archive c_vectors one component at a time
190 c_vector<double, SPACE_DIM> point;
191 for (unsigned i=0; i<SPACE_DIM; i++)
192 {
193 ar >> point[i];
194 }
195 c_vector<double, SPACE_DIM> normal;
196 for (unsigned i=0; i<SPACE_DIM; i++)
197 {
198 ar >> normal[i];
199 }
200
201 // Invoke inplace constructor to initialise instance
202 ::new(t)PlaneBoundaryCondition<ELEMENT_DIM, SPACE_DIM>(p_cell_population, point, normal);
203}
204}
205} // namespace ...
206
207#endif /*PLANEBOUNDARYCONDITION_HPP_*/
gcov doesn't like this file...
#define EXPORT_TEMPLATE_CLASS_ALL_DIMS(CLASS)
Definition Node.hpp:59
const c_vector< double, SPACE_DIM > & rGetNormalToPlane() const
void ImposeBoundaryCondition(const std::map< Node< SPACE_DIM > *, c_vector< double, SPACE_DIM > > &rOldLocations)
void OutputCellPopulationBoundaryConditionParameters(out_stream &rParamsFile)
void serialize(Archive &archive, const unsigned int version)
c_vector< double, SPACE_DIM > mPointOnPlane
c_vector< double, SPACE_DIM > mNormalToPlane
friend class boost::serialization::access
const c_vector< double, SPACE_DIM > & rGetPointOnPlane() const
void SetUseJiggledNodesOnPlane(bool useJiggledNodesOnPlane)