Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Prism.h
Go to the documentation of this file.
1 ////////////////////////////////////////////////////////////////////////////////
2 //
3 // File: Prism.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 prism object.
33 //
34 ////////////////////////////////////////////////////////////////////////////////
35 
36 #ifndef NEKMESHUTILS_MESHELEMENTS_PRISM
37 #define NEKMESHUTILS_MESHELEMENTS_PRISM
38 
41 
42 namespace Nektar
43 {
44 namespace NekMeshUtils
45 {
46 /**
47  * @brief A 3-dimensional five-faced element (2 triangles, 3
48  * quadrilaterals).
49  */
50 class Prism : public Element
51 {
52 public:
53  /// Creates an instance of this class
55  std::vector<NodeSharedPtr> pNodeList,
56  std::vector<int> pTagList)
57  {
58  return boost::shared_ptr<Element>(
59  new Prism(pConf, pNodeList, pTagList));
60  }
61  /// Element type
63 
65  std::vector<NodeSharedPtr> pNodeList,
66  std::vector<int> pTagList);
67  NEKMESHUTILS_EXPORT Prism(const Prism &pSrc);
69  {
70  }
71 
73  int coordDim);
75  std::vector<NodeSharedPtr> &nodeList) const;
77  int edgeId, EdgeSharedPtr edge);
78  NEKMESHUTILS_EXPORT virtual void MakeOrder(
79  int order,
82  int coordDim,
83  int &id,
84  bool justConfig = false);
85 
86  NEKMESHUTILS_EXPORT static unsigned int GetNumNodes(ElmtConfig pConf);
87  NEKMESHUTILS_EXPORT virtual int GetFaceVertex(int i, int j)
88  {
89  return m_faceIds[i][j];
90  }
91 
92  /**
93  * Orientation of prism; unchanged = 0; clockwise = 1;
94  * counter-clockwise = 2. This is set by OrientPrism.
95  */
96  unsigned int m_orientation;
97 
98 protected:
99  void OrientPrism();
100 
101 private:
102  static int m_faceIds[5][4];
103 };
104 }
105 }
106 
107 #endif
Basic information about an element.
Definition: ElementConfig.h:50
virtual NEKMESHUTILS_EXPORT int GetFaceVertex(int i, int j)
Returns the local index of vertex j of face i.
Definition: Prism.h:87
unsigned int m_orientation
Definition: Prism.h:96
static LibUtilities::ShapeType m_type
Element type.
Definition: Prism.h:62
A 3-dimensional five-faced element (2 triangles, 3 quadrilaterals).
Definition: Prism.h:50
static int m_faceIds[5][4]
Vertex IDs that make up prism faces.
Definition: Prism.h:102
virtual NEKMESHUTILS_EXPORT SpatialDomains::GeometrySharedPtr GetGeom(int coordDim)
Generate a Nektar++ geometry object for this element.
Definition: Prism.cpp:246
void OrientPrism()
Orient prism to align degenerate vertices.
Definition: Prism.cpp:522
virtual NEKMESHUTILS_EXPORT void GetCurvedNodes(std::vector< NodeSharedPtr > &nodeList) const
get list of volume interior nodes
Definition: Prism.cpp:353
virtual NEKMESHUTILS_EXPORT StdRegions::Orientation GetEdgeOrient(int edgeId, EdgeSharedPtr edge)
Get the edge orientation of edge with respect to the local element, which lies at edge index edgeId...
Definition: Prism.cpp:261
static ElementSharedPtr create(ElmtConfig pConf, std::vector< NodeSharedPtr > pNodeList, std::vector< int > pTagList)
Creates an instance of this class.
Definition: Prism.h:54
static NEKMESHUTILS_EXPORT unsigned int GetNumNodes(ElmtConfig pConf)
Return the number of nodes defining a prism.
Definition: Prism.cpp:234
boost::shared_ptr< Edge > EdgeSharedPtr
Shared pointer to an edge.
Definition: Edge.h:135
NEKMESHUTILS_EXPORT Prism(ElmtConfig pConf, std::vector< NodeSharedPtr > pNodeList, std::vector< int > pTagList)
Create a prism element.
Definition: Prism.cpp:64
#define NEKMESHUTILS_EXPORT
boost::shared_ptr< Element > ElementSharedPtr
Definition: Edge.h:49
virtual NEKMESHUTILS_EXPORT ~Prism()
Definition: Prism.h:68
virtual NEKMESHUTILS_EXPORT void MakeOrder(int order, SpatialDomains::GeometrySharedPtr geom, LibUtilities::PointsType pType, int coordDim, int &id, bool justConfig=false)
Insert interior (i.e. volume) points into this element to make the geometry an order order representa...
Definition: Prism.cpp:284
boost::shared_ptr< Geometry > GeometrySharedPtr
Definition: Geometry.h:53
Base class for element definitions.
Definition: Element.h:59