Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Pyramid.h
Go to the documentation of this file.
1 ////////////////////////////////////////////////////////////////////////////////
2 //
3 // File: Pyramid.h
4 //
5 // For more information, please see: http://www.nektar.info/
6 //
7 // The MIT License
8 //
9 // Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
10 // Department of Aeronautics, Imperial College London (UK), and Scientific
11 // Computing and Imaging Institute, University of Utah (USA).
12 //
13 // License for the specific language governing rights and limitations under
14 // Permission is hereby granted, free of charge, to any person obtaining a
15 // copy of this software and associated documentation files (the "Software"),
16 // to deal in the Software without restriction, including without limitation
17 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
18 // and/or sell copies of the Software, and to permit persons to whom the
19 // Software is furnished to do so, subject to the following conditions:
20 //
21 // The above copyright notice and this permission notice shall be included
22 // in all copies or substantial portions of the Software.
23 //
24 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
25 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
27 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
29 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
30 // DEALINGS IN THE SOFTWARE.
31 //
32 // Description: Mesh pyramid object.
33 //
34 ////////////////////////////////////////////////////////////////////////////////
35 
36 #ifndef NEKMESHUTILS_MESHELEMENTS_PYM
37 #define NEKMESHUTILS_MESHELEMENTS_PYM
38 
41 
42 namespace Nektar
43 {
44 namespace NekMeshUtils
45 {
46 /**
47  * @brief A 3-dimensional square-based pyramidic element
48  */
49 class Pyramid : public Element
50 {
51 public:
52  /// Creates an instance of this class
54  std::vector<NodeSharedPtr> pNodeList,
55  std::vector<int> pTagList)
56  {
57  return boost::shared_ptr<Element>(
58  new Pyramid(pConf, pNodeList, pTagList));
59  }
60  /// Element type
62 
64  std::vector<NodeSharedPtr> pNodeList,
65  std::vector<int> pTagList);
66  NEKMESHUTILS_EXPORT Pyramid(const Pyramid &pSrc);
68  {
69  }
70 
72  int coordDim);
73  NEKMESHUTILS_EXPORT static unsigned int GetNumNodes(ElmtConfig pConf);
74  NEKMESHUTILS_EXPORT virtual int GetFaceVertex(int i, int j)
75  {
76  return m_faceIds[i][j];
77  }
78 
79  /**
80  * Orientation of pyramid.
81  */
83 
84 private:
85  static int m_faceIds[5][4];
86 };
87 }
88 }
89 
90 #endif
Basic information about an element.
Definition: ElementConfig.h:50
static ElementSharedPtr create(ElmtConfig pConf, std::vector< NodeSharedPtr > pNodeList, std::vector< int > pTagList)
Creates an instance of this class.
Definition: Pyramid.h:53
virtual NEKMESHUTILS_EXPORT SpatialDomains::GeometrySharedPtr GetGeom(int coordDim)
Generate a Nektar++ geometry object for this element.
Definition: Pyramid.cpp:158
A 3-dimensional square-based pyramidic element.
Definition: Pyramid.h:49
virtual NEKMESHUTILS_EXPORT ~Pyramid()
Definition: Pyramid.h:67
virtual NEKMESHUTILS_EXPORT int GetFaceVertex(int i, int j)
Returns the local index of vertex j of face i.
Definition: Pyramid.h:74
static LibUtilities::ShapeType type
Element type.
Definition: Pyramid.h:61
#define NEKMESHUTILS_EXPORT
static NEKMESHUTILS_EXPORT unsigned int GetNumNodes(ElmtConfig pConf)
Return the number of nodes defining a pyramid.
Definition: Pyramid.cpp:175
boost::shared_ptr< Element > ElementSharedPtr
Definition: Edge.h:49
NEKMESHUTILS_EXPORT Pyramid(ElmtConfig pConf, std::vector< NodeSharedPtr > pNodeList, std::vector< int > pTagList)
Create a pyramidic element.
Definition: Pyramid.cpp:58
static int m_faceIds[5][4]
Vertex IDs that make up pyramid faces.
Definition: Pyramid.h:85
boost::shared_ptr< Geometry > GeometrySharedPtr
Definition: Geometry.h:53
Base class for element definitions.
Definition: Element.h:59