Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
VertexElement.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#ifndef VERTEXELEMENT_HPP_
36#define VERTEXELEMENT_HPP_
37
38#include "MutableElement.hpp"
39
41#include <boost/serialization/base_object.hpp>
42#include <boost/serialization/vector.hpp>
43
44
51template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
52class VertexElement : public MutableElement<ELEMENT_DIM, SPACE_DIM>
53{
54private:
55
59 std::vector<VertexElement<ELEMENT_DIM-1, SPACE_DIM>*> mFaces;
60
71 std::vector<bool> mOrientations;
72
86 template<class Archive>
87 void serialize(Archive & archive, const unsigned int version)
88 {
89 // This needs to be first so that MeshBasedCellPopulation::Validate() doesn't go mental.
90 archive & mFaces;
91 archive & mOrientations;
92 archive & boost::serialization::base_object<MutableElement<ELEMENT_DIM, SPACE_DIM> >(*this);
93 }
94
95public:
96
104 VertexElement(unsigned index,
105 const std::vector<VertexElement<ELEMENT_DIM-1, SPACE_DIM>*>& rFaces,
106 const std::vector<bool>& rOrientations);
107
117 VertexElement(unsigned index);
118
125 VertexElement(unsigned index,
126 const std::vector<Node<SPACE_DIM>*>& rNodes);
127
138 VertexElement(unsigned index,
139 const std::vector<VertexElement<ELEMENT_DIM-1, SPACE_DIM>*>& rFaces,
140 const std::vector<bool>& rOrientations,
141 const std::vector<Node<SPACE_DIM>*>& rNodes);
142
147
151 unsigned GetNumFaces() const;
152
159
165 VertexElement<ELEMENT_DIM-1, SPACE_DIM>* GetFace(unsigned index) const;
166
172 bool FaceIsOrientatedClockwise(unsigned index) const;
173};
174
175
177// Specialization for 1d elements //
178// //
179// 1d elements are just edges (lines) //
181
186template<unsigned SPACE_DIM>
187class VertexElement<1, SPACE_DIM> : public MutableElement<1,SPACE_DIM>
188{
189public:
190
197 VertexElement(unsigned index, const std::vector<Node<SPACE_DIM>*>& rNodes);
198
202 unsigned GetNumFaces() const;
203
209 VertexElement<0, SPACE_DIM>* GetFace(unsigned index) const;
210
216 bool FaceIsOrientatedClockwise(unsigned index) const;
217};
218
219#endif /*VERTEXELEMENT_HPP_*/
Definition Node.hpp:59
VertexElement< ELEMENT_DIM-1, SPACE_DIM > * GetFace(unsigned index) const
std::vector< bool > mOrientations
void serialize(Archive &archive, const unsigned int version)
void AddFace(VertexElement< ELEMENT_DIM-1, SPACE_DIM > *pFace)
std::vector< VertexElement< ELEMENT_DIM-1, SPACE_DIM > * > mFaces
friend class boost::serialization::access
bool FaceIsOrientatedClockwise(unsigned index) const
unsigned GetNumFaces() const