Chaste  Release::2018.1
ChasteNodesList.hpp
1 /*
2 
3 Copyright (c) 2005-2018, 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 
37 #ifndef CHASTENODESLIST_HPP_
38 #define CHASTENODESLIST_HPP_
39 
40 #include "ChasteSerialization.hpp"
41 #include <boost/serialization/base_object.hpp>
42 
43 #include "AbstractChasteRegion.hpp"
44 #include "Node.hpp"
45 #include "ChastePoint.hpp"
46 
47 #include <vector>
48 using namespace std;
53 template <unsigned SPACE_DIM>
54 class ChasteNodesList : public AbstractChasteRegion<SPACE_DIM>
55 {
57  friend class boost::serialization::access;
64  template<class Archive>
65  void serialize(Archive & archive, const unsigned int version)
66  {
67  archive & boost::serialization::base_object<AbstractChasteRegion<SPACE_DIM> >(*this);
68  }
69 
70 private:
71 
73  std::vector< Node<SPACE_DIM>*> mListOfNodes;
74 
76  bool mOwnNodes;
77 
78 public:
79 
86  ChasteNodesList(const std::vector<Node<SPACE_DIM>*> rNodesList,
87  bool ownNodes=false);
88 
92  ~ChasteNodesList();
93 
95  const std::vector< Node<SPACE_DIM>*>& rGetNodesList() const;
96 
102  bool DoesContain(const ChastePoint<SPACE_DIM>& rPointToCheck) const;
103 
107  unsigned GetSize() const;
108 };
109 
110 // Declare identifier for the serializer
113 
114 namespace boost
115 {
116 namespace serialization
117 {
118 
119 template<class Archive, unsigned SPACE_DIM>
120 inline void save_construct_data(
121  Archive & ar, const ChasteNodesList<SPACE_DIM> * t, const unsigned int file_version)
122 {
123  const std::vector<Node<SPACE_DIM>*>& node_list = t->rGetNodesList();
124 
125  // Archive the size first
126  unsigned size = t->GetSize();
127  ar & size;
128 
129  // The ChastePoints have to be at unique addresses, otherwise Boost thinks that the first archive is sufficient
130  std::vector <ChastePoint<SPACE_DIM>* > point_list;
131 
132  for (unsigned i = 0; i < node_list.size(); i++)
133  {
134  c_vector<double, SPACE_DIM> loc = node_list[i]->rGetLocation();
135  point_list.push_back(new ChastePoint<SPACE_DIM>(loc));
136  ar & point_list[i];
137  unsigned index = node_list[i]->GetIndex();
138  ar & index;
139  }
140 
141  // Clean memory
142  for (unsigned i = 0; i < point_list.size(); i++)
143  {
144  delete point_list[i];
145  }
146 }
147 
152 template<class Archive, unsigned SPACE_DIM>
153 inline void load_construct_data(
154  Archive & ar, ChasteNodesList<SPACE_DIM> * t, const unsigned int file_version)
155 {
156  // Unarchive the size first
157  unsigned size;
158  ar & size;
159 
160  // Rebuild the node list based on the unarchived points and indices
161  std::vector<Node<SPACE_DIM>* > node_list;
162  for (unsigned i = 0; i < size; i++)
163  {
164  ChastePoint<SPACE_DIM>* p_point;
165  unsigned index;
166  ar & p_point;
167  ar & index;
168 
169  Node<SPACE_DIM>* p_node = new Node<SPACE_DIM>( index, *(p_point));
170  node_list.push_back(p_node);
171 
172  delete p_point; // not needed any longer
173  }
174 
175  ::new(t)ChasteNodesList<SPACE_DIM>(node_list, true);
176 }
177 }
178 } // namespace ...
179 
180 #endif /*CHASTENODESLIST_HPP_*/
Definition: Node.hpp:58
void serialize(Archive &archive, const unsigned int version)
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)
const std::vector< Node< SPACE_DIM > * > & rGetNodesList() const
unsigned GetSize() const
gcov doesn't like this file...
std::vector< Node< SPACE_DIM > * > mListOfNodes