Chaste  Release::2018.1
VertexElement.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 #ifndef VERTEXELEMENT_HPP_
36 #define VERTEXELEMENT_HPP_
37 
38 #include "MutableElement.hpp"
39 
40 #include "ChasteSerialization.hpp"
41 #include <boost/serialization/base_object.hpp>
42 #include <boost/serialization/vector.hpp>
43 
50 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
51 class VertexElement : public MutableElement<ELEMENT_DIM, SPACE_DIM>
52 {
53 private:
54 
58  std::vector<VertexElement<ELEMENT_DIM-1, SPACE_DIM>*> mFaces;
59 
70  std::vector<bool> mOrientations;
71 
85  template<class Archive>
86  void serialize(Archive & archive, const unsigned int version)
87  {
88  // This needs to be first so that MeshBasedCellPopulation::Validate() doesn't go mental.
89  archive & mFaces;
90  archive & mOrientations;
91  archive & boost::serialization::base_object<MutableElement<ELEMENT_DIM, SPACE_DIM> >(*this);
92  }
93 
94 public:
95 
103  VertexElement(unsigned index,
104  const std::vector<VertexElement<ELEMENT_DIM-1, SPACE_DIM>*>& rFaces,
105  const std::vector<bool>& rOrientations);
106 
116  VertexElement(unsigned index);
117 
124  VertexElement(unsigned index,
125  const std::vector<Node<SPACE_DIM>*>& rNodes);
126 
137  VertexElement(unsigned index,
138  const std::vector<VertexElement<ELEMENT_DIM-1, SPACE_DIM>*>& rFaces,
139  const std::vector<bool>& rOrientations,
140  const std::vector<Node<SPACE_DIM>*>& rNodes);
141 
145  ~VertexElement();
146 
150  unsigned GetNumFaces() const;
151 
158 
164  VertexElement<ELEMENT_DIM-1, SPACE_DIM>* GetFace(unsigned index) const;
165 
171  bool FaceIsOrientatedClockwise(unsigned index) const;
172 };
173 
174 
176 // Specialization for 1d elements //
177 // //
178 // 1d elements are just edges (lines) //
180 
185 template<unsigned SPACE_DIM>
186 class VertexElement<1, SPACE_DIM> : public MutableElement<1,SPACE_DIM>
187 {
188 public:
189 
196  VertexElement(unsigned index, const std::vector<Node<SPACE_DIM>*>& rNodes);
197 
201  unsigned GetNumFaces() const;
202 
208  VertexElement<0, SPACE_DIM>* GetFace(unsigned index) const;
209 
215  bool FaceIsOrientatedClockwise(unsigned index) const;
216 };
217 
218 #endif /*VERTEXELEMENT_HPP_*/
VertexElement(unsigned index, const std::vector< VertexElement< ELEMENT_DIM-1, SPACE_DIM > * > &rFaces, const std::vector< bool > &rOrientations)
Definition: Node.hpp:58
friend class boost::serialization::access
bool FaceIsOrientatedClockwise(unsigned index) const
std::vector< VertexElement< ELEMENT_DIM-1, SPACE_DIM > * > mFaces
unsigned GetNumFaces() const
void serialize(Archive &archive, const unsigned int version)
std::vector< bool > mOrientations
VertexElement< ELEMENT_DIM-1, SPACE_DIM > * GetFace(unsigned index) const
void AddFace(VertexElement< ELEMENT_DIM-1, SPACE_DIM > *pFace)