Chaste  Release::2018.1
AbstractElement.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 #ifndef ABSTRACTELEMENT_HPP_
37 #define ABSTRACTELEMENT_HPP_
38 
39 #include <vector>
40 
41 #include "UblasVectorInclude.hpp"
42 #include "Node.hpp"
43 #include "ElementAttributes.hpp"
44 
45 /*
46  * When creating an element within a mesh one needs to specify its global index.
47  * If the element is not used within a mesh the following constant is used instead.
48  */
49 const unsigned INDEX_IS_NOT_USED=0;
50 
54 template <unsigned ELEMENT_DIM, unsigned SPACE_DIM>
56 {
57 protected:
58 
60  std::vector<Node<SPACE_DIM>*> mNodes;
61 
63  unsigned mIndex;
64 
69  bool mIsDeleted;
70 
72  bool mOwnership;
73 
76 
81 
82 public:
83 
90  AbstractElement(unsigned index, const std::vector<Node<SPACE_DIM>*>& rNodes);
91 
97  AbstractElement(unsigned index=INDEX_IS_NOT_USED);
98 
103  virtual ~AbstractElement();
104 
111  virtual void UpdateNode(const unsigned& rIndex, Node<SPACE_DIM>* pNode)=0;
112 
119  void ReplaceNode(Node<SPACE_DIM>* pOldNode, Node<SPACE_DIM>* pNewNode);
120 
125  virtual void MarkAsDeleted()=0;
126 
130  virtual void RegisterWithNodes()=0;
131 
140  double GetNodeLocation(unsigned localIndex, unsigned dimension) const;
141 
148  c_vector<double, SPACE_DIM> GetNodeLocation(unsigned localIndex) const;
149 
157  unsigned GetNodeGlobalIndex(unsigned localIndex) const;
158 
165  Node<SPACE_DIM>* GetNode(unsigned localIndex) const;
166 
170  unsigned GetNumNodes() const;
171 
177  void AddNode(Node<SPACE_DIM>* pNode);
178 
184  bool IsDeleted() const;
185 
189  unsigned GetIndex() const;
190 
196  void SetIndex(unsigned index);
197 
201  bool GetOwnership() const;
202 
208  void SetOwnership(bool ownership);
209 
215  void SetAttribute(double attribute);
216 
220  double GetAttribute();
221 
228  unsigned GetUnsignedAttribute();
229 
235  void AddElementAttribute(double attribute);
236 
240  std::vector<double>& rGetElementAttributes();
241 
245  unsigned GetNumElementAttributes();
246 };
247 
248 #endif /*ABSTRACTELEMENT_HPP_*/
void SetAttribute(double attribute)
ElementAttributes< ELEMENT_DIM, SPACE_DIM > * mpElementAttributes
void AddElementAttribute(double attribute)
Definition: Node.hpp:58
unsigned GetNodeGlobalIndex(unsigned localIndex) const
void SetIndex(unsigned index)
void ReplaceNode(Node< SPACE_DIM > *pOldNode, Node< SPACE_DIM > *pNewNode)
void SetOwnership(bool ownership)
unsigned GetNumElementAttributes()
bool IsDeleted() const
Node< SPACE_DIM > * GetNode(unsigned localIndex) const
AbstractElement(unsigned index, const std::vector< Node< SPACE_DIM > * > &rNodes)
bool GetOwnership() const
std::vector< Node< SPACE_DIM > * > mNodes
void ConstructElementAttributes()
std::vector< double > & rGetElementAttributes()
virtual void MarkAsDeleted()=0
unsigned GetNumNodes() const
virtual ~AbstractElement()
unsigned GetUnsignedAttribute()
unsigned GetIndex() const
void AddNode(Node< SPACE_DIM > *pNode)
virtual void RegisterWithNodes()=0
double GetNodeLocation(unsigned localIndex, unsigned dimension) const
virtual void UpdateNode(const unsigned &rIndex, Node< SPACE_DIM > *pNode)=0