Chaste  Release::3.4
PlaneBoundaryCondition.hpp
1 /*
2 
3 Copyright (c) 2005-2016, University of Oxford.
4 All rights reserved.
5 
6 University of Oxford means the Chancellor, Masters and Scholars of the
7 University of Oxford, having an administrative office at Wellington
8 Square, Oxford OX1 2JD, UK.
9 
10 This file is part of Chaste.
11 
12 Redistribution and use in source and binary forms, with or without
13 modification, 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 
23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 OF 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 
41 #include "Debug.hpp"
42 
43 #include "ChasteSerialization.hpp"
44 #include <boost/serialization/base_object.hpp>
45 #include <boost/serialization/vector.hpp>
46 
53 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM=ELEMENT_DIM>
55 {
56 private:
57 
61  c_vector<double, SPACE_DIM> mPointOnPlane;
62 
66  c_vector<double, SPACE_DIM> mNormalToPlane;
67 
73 
82  template<class Archive>
83  void serialize(Archive & archive, const unsigned int version)
84  {
85  archive & boost::serialization::base_object<AbstractCellPopulationBoundaryCondition<ELEMENT_DIM, SPACE_DIM> >(*this);
86  //archive & mUseJiggledNodesOnPlane;
87  }
88 
89 public:
90 
99  c_vector<double, SPACE_DIM> point,
100  c_vector<double, SPACE_DIM> normal);
101 
105  const c_vector<double, SPACE_DIM>& rGetPointOnPlane() const;
106 
110  const c_vector<double, SPACE_DIM>& rGetNormalToPlane() const;
111 
117  void SetUseJiggledNodesOnPlane(bool useJiggledNodesOnPlane);
118 
121 
129  void ImposeBoundaryCondition(const std::map<Node<SPACE_DIM>*, c_vector<double, SPACE_DIM> >& rOldLocations);
130 
139 
146  void OutputCellPopulationBoundaryConditionParameters(out_stream& rParamsFile);
147 };
148 
151 
152 namespace boost
153 {
154 namespace serialization
155 {
159 template<class Archive, unsigned ELEMENT_DIM, unsigned SPACE_DIM>
160 inline void save_construct_data(
161  Archive & ar, const PlaneBoundaryCondition<ELEMENT_DIM, SPACE_DIM>* t, const unsigned int file_version)
162 {
163  // Save data required to construct instance
164  const AbstractCellPopulation<ELEMENT_DIM, SPACE_DIM>* const p_cell_population = t->GetCellPopulation();
165  ar << p_cell_population;
166 
167  // Archive c_vectors one component at a time
168  c_vector<double, SPACE_DIM> point = t->rGetPointOnPlane();
169  for (unsigned i=0; i<SPACE_DIM; i++)
170  {
171  ar << point[i];
172  }
173  c_vector<double, SPACE_DIM> normal = t->rGetNormalToPlane();
174  for (unsigned i=0; i<SPACE_DIM; i++)
175  {
176  ar << normal[i];
177  }
178 }
179 
183 template<class Archive, unsigned ELEMENT_DIM, unsigned SPACE_DIM>
184 inline void load_construct_data(
185  Archive & ar, PlaneBoundaryCondition<ELEMENT_DIM, SPACE_DIM>* t, const unsigned int file_version)
186 {
187  // Retrieve data from archive required to construct new instance
189  ar >> p_cell_population;
190 
191  // Archive c_vectors one component at a time
192  c_vector<double, SPACE_DIM> point;
193  for (unsigned i=0; i<SPACE_DIM; i++)
194  {
195  ar >> point[i];
196  }
197  c_vector<double, SPACE_DIM> normal;
198  for (unsigned i=0; i<SPACE_DIM; i++)
199  {
200  ar >> normal[i];
201  }
202 
203  // Invoke inplace constructor to initialise instance
204  ::new(t)PlaneBoundaryCondition<ELEMENT_DIM, SPACE_DIM>(p_cell_population, point, normal);
205 }
206 }
207 } // namespace ...
208 
209 #endif /*PLANEBOUNDARYCONDITION_HPP_*/
c_vector< double, SPACE_DIM > mPointOnPlane
const AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > * GetCellPopulation() const
Definition: Node.hpp:58
void serialize(Archive &archive, const unsigned int version)
void ImposeBoundaryCondition(const std::map< Node< SPACE_DIM > *, c_vector< double, SPACE_DIM > > &rOldLocations)
#define EXPORT_TEMPLATE_CLASS_ALL_DIMS(CLASS)
void OutputCellPopulationBoundaryConditionParameters(out_stream &rParamsFile)
friend class boost::serialization::access
c_vector< double, SPACE_DIM > mNormalToPlane
PlaneBoundaryCondition(AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *pCellPopulation, c_vector< double, SPACE_DIM > point, c_vector< double, SPACE_DIM > normal)
void SetUseJiggledNodesOnPlane(bool useJiggledNodesOnPlane)
const c_vector< double, SPACE_DIM > & rGetNormalToPlane() const
const c_vector< double, SPACE_DIM > & rGetPointOnPlane() const