Chaste  Release::2018.1
Element.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 _ELEMENT_HPP_
38 #define _ELEMENT_HPP_
39 
40 #include "UblasMatrixInclude.hpp"
41 #include "UblasVectorInclude.hpp"
42 
43 #include <vector>
44 
45 #include "AbstractTetrahedralElement.hpp"
46 #include "Node.hpp"
47 #include "ChastePoint.hpp"
48 
52 template <unsigned ELEMENT_DIM, unsigned SPACE_DIM>
53 class Element : public AbstractTetrahedralElement<ELEMENT_DIM, SPACE_DIM>
54 {
55 public:
56 
64  Element(unsigned index, const std::vector<Node<SPACE_DIM>*>& rNodes, bool registerWithNodes=true);
65 
72  Element(const Element& rElement, const unsigned index);
73 
77  void RegisterWithNodes();
78 
83  void MarkAsDeleted();
84 
91  void UpdateNode(const unsigned& rIndex, Node<SPACE_DIM>* pNode);
92 
98  void ResetIndex(unsigned index);
99 
111  c_vector<double,SPACE_DIM+1> CalculateCircumsphere(c_matrix<double, SPACE_DIM, ELEMENT_DIM>& rJacobian,
112  c_matrix<double, ELEMENT_DIM, SPACE_DIM>& rInverseJacobian);
113 
118 
124  double CalculateQuality();
125 
129  c_vector <double, 2> CalculateMinMaxEdgeLengths();
130 
138  c_vector<double, SPACE_DIM+1> CalculateInterpolationWeights(const ChastePoint<SPACE_DIM>& rTestPoint);
139 
147  c_vector<double, SPACE_DIM+1> CalculateInterpolationWeightsWithProjection(const ChastePoint<SPACE_DIM>& rTestPoint);
148 
158  c_vector<double, SPACE_DIM> CalculateXi(const ChastePoint<SPACE_DIM>& rTestPoint);
159 
166  bool IncludesPoint(const ChastePoint<SPACE_DIM>& rTestPoint, bool strict=false);
167 };
168 
169 #endif //_ELEMENT_HPP_
c_vector< double, SPACE_DIM+1 > CalculateCircumsphere(c_matrix< double, SPACE_DIM, ELEMENT_DIM > &rJacobian, c_matrix< double, ELEMENT_DIM, SPACE_DIM > &rInverseJacobian)
Definition: Element.cpp:118
Definition: Node.hpp:58
double CalculateQuality()
Definition: Element.cpp:163
void UpdateNode(const unsigned &rIndex, Node< SPACE_DIM > *pNode)
Definition: Element.cpp:89
void ResetIndex(unsigned index)
Definition: Element.cpp:104
c_vector< double, SPACE_DIM > CalculateXi(const ChastePoint< SPACE_DIM > &rTestPoint)
Definition: Element.cpp:290
double CalculateCircumsphereVolume()
void RegisterWithNodes()
Definition: Element.cpp:65
void MarkAsDeleted()
Definition: Element.cpp:74
Element(unsigned index, const std::vector< Node< SPACE_DIM > * > &rNodes, bool registerWithNodes=true)
Definition: Element.cpp:46
bool IncludesPoint(const ChastePoint< SPACE_DIM > &rTestPoint, bool strict=false)
Definition: Element.cpp:313
c_vector< double, SPACE_DIM+1 > CalculateInterpolationWeights(const ChastePoint< SPACE_DIM > &rTestPoint)
Definition: Element.cpp:228
c_vector< double, SPACE_DIM+1 > CalculateInterpolationWeightsWithProjection(const ChastePoint< SPACE_DIM > &rTestPoint)
Definition: Element.cpp:248
c_vector< double, 2 > CalculateMinMaxEdgeLengths()
Definition: Element.cpp:203