Nektar++
Loading...
Searching...
No Matches
PyrGeom.h
Go to the documentation of this file.
1////////////////////////////////////////////////////////////////////////////////
2//
3// File: PyrGeom.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// Permission is hereby granted, free of charge, to any person obtaining a
14// copy of this software and associated documentation files (the "Software"),
15// to deal in the Software without restriction, including without limitation
16// the rights to use, copy, modify, merge, publish, distribute, sublicense,
17// and/or sell copies of the Software, and to permit persons to whom the
18// Software is furnished to do so, subject to the following conditions:
19//
20// The above copyright notice and this permission notice shall be included
21// in all copies or substantial portions of the Software.
22//
23// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
24// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
26// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
28// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
29// DEALINGS IN THE SOFTWARE.
30//
31// Description: Pyramidic geometry information.
32//
33////////////////////////////////////////////////////////////////////////////////
34
35#ifndef NEKTAR_SPATIALDOMAINS_PYRGEOM_H
36#define NEKTAR_SPATIALDOMAINS_PYRGEOM_H
37
41
43{
44
45class PyrGeom : public Geometry3D
46{
47public:
50
51 SPATIAL_DOMAINS_EXPORT static const int kNverts = 5;
52 SPATIAL_DOMAINS_EXPORT static const int kNedges = 8;
53 SPATIAL_DOMAINS_EXPORT static const int kNqfaces = 1;
54 SPATIAL_DOMAINS_EXPORT static const int kNtfaces = 4;
57 SPATIAL_DOMAINS_EXPORT static const std::string XMLElementType;
58
60 std::array<Geometry2D *, kNfaces> faces);
61 SPATIAL_DOMAINS_EXPORT ~PyrGeom() override = default;
62
63protected:
64 GeomType v_CalcGeomType() override;
66 LibUtilities::PointsKeyVector &keyTgt) override;
67 int v_GetEdgeNormalToFaceVert(const int i, const int j) const override;
68 int v_GetDir(const int faceidx, const int facedir) const override;
69 void v_Reset(CurveMap &curvedEdges, CurveMap &curvedFaces) override;
70 void v_Setup() override;
71 void v_FillGeom() override;
72
73 inline int v_GetNumVerts() const final
74 {
75 return kNverts;
76 }
77
78 inline int v_GetNumEdges() const final
79 {
80 return kNedges;
81 }
82
83 inline int v_GetNumFaces() const final
84 {
85 return kNfaces;
86 }
87
88 inline PointGeom *v_GetVertex(const int i) const final
89 {
90 return m_verts[i];
91 }
92
93 inline Geometry1D *v_GetEdge(const int i) const final
94 {
95 return static_cast<Geometry1D *>(m_edges[i]);
96 }
97
98 inline Geometry2D *v_GetFace(const int i) const final
99 {
100 return static_cast<Geometry2D *>(m_faces[i]);
101 }
102
103 inline StdRegions::Orientation v_GetEorient(const int i) const final
104 {
105 return m_eorient[i];
106 }
107
108 inline StdRegions::Orientation v_GetForient(const int i) const final
109 {
110 return m_forient[i];
111 }
112
113 std::array<PointGeom *, kNverts> m_verts;
114 std::array<SegGeom *, kNedges> m_edges;
115 std::array<Geometry2D *, kNfaces> m_faces;
116 std::array<StdRegions::Orientation, kNedges> m_eorient;
117 std::array<StdRegions::Orientation, kNfaces> m_forient;
118
119private:
120 void SetUpLocalEdges();
121 void SetUpLocalVertices();
124 void SetUpXmap();
125
126 static const unsigned int EdgeNormalToFaceVert[5][4];
127};
128
129} // namespace Nektar::SpatialDomains
130
131#endif // NEKTAR_SPATIALDOMAINS_PYRGEOM_H
#define SPATIAL_DOMAINS_EXPORT
1D geometry information
Definition Geometry1D.h:49
2D geometry information
Definition Geometry2D.h:50
3D geometry information
Definition Geometry3D.h:50
std::array< Geometry2D *, kNfaces > m_faces
Definition PyrGeom.h:115
std::array< SegGeom *, kNedges > m_edges
Definition PyrGeom.h:114
std::array< StdRegions::Orientation, kNfaces > m_forient
Definition PyrGeom.h:117
Geometry1D * v_GetEdge(const int i) const final
Returns edge i of this object.
Definition PyrGeom.h:93
GeomFactorsUniquePtr v_GenGeomFactors(LibUtilities::PointsKeyVector &keyTgt) override
Used by Expansion to generate associated GeomFactors.
Definition PyrGeom.cpp:132
static const int kNfaces
Definition PyrGeom.h:55
int v_GetNumVerts() const final
Get the number of vertices of this object.
Definition PyrGeom.h:73
int v_GetDir(const int faceidx, const int facedir) const override
Returns the element coordinate direction corresponding to a given face coordinate direction.
Definition PyrGeom.cpp:141
static const std::string XMLElementType
Definition PyrGeom.h:57
std::array< StdRegions::Orientation, kNedges > m_eorient
Definition PyrGeom.h:116
PyrGeom(int id, Geometry2D *faces[])
PointGeom * v_GetVertex(const int i) const final
Returns vertex i of this object.
Definition PyrGeom.h:88
void SetUpXmap()
Set up the m_xmap object by determining the order of each direction from derived faces.
Definition PyrGeom.cpp:704
StdRegions::Orientation v_GetForient(const int i) const final
Returns the orientation of face i with respect to the ordering of faces in the standard element.
Definition PyrGeom.h:108
static const int kNedges
Definition PyrGeom.h:52
void v_Reset(CurveMap &curvedEdges, CurveMap &curvedFaces) override
Reset this geometry object: unset the current state, zero Geometry::m_coeffs and remove allocated Geo...
Definition PyrGeom.cpp:663
static const int kNtfaces
Definition PyrGeom.h:54
static const int kNqfaces
Definition PyrGeom.h:53
static const unsigned int EdgeNormalToFaceVert[5][4]
Definition PyrGeom.h:126
int v_GetNumEdges() const final
Get the number of edges of this object.
Definition PyrGeom.h:78
GeomType v_CalcGeomType() override
Definition PyrGeom.cpp:78
static const int kNverts
Definition PyrGeom.h:51
void v_FillGeom() override
Put all quadrature information into face/edge structure and backward transform.
Definition PyrGeom.cpp:773
int v_GetNumFaces() const final
Get the number of faces of this object.
Definition PyrGeom.h:83
Geometry2D * v_GetFace(const int i) const final
Returns face i of this object.
Definition PyrGeom.h:98
static const int kNfacets
Definition PyrGeom.h:56
StdRegions::Orientation v_GetEorient(const int i) const final
Returns the orientation of edge i with respect to the ordering of edges in the standard element.
Definition PyrGeom.h:103
std::array< PointGeom *, kNverts > m_verts
Definition PyrGeom.h:113
int v_GetEdgeNormalToFaceVert(const int i, const int j) const override
Returns the standard lement edge IDs that are normal to a given face vertex.
Definition PyrGeom.cpp:157
std::vector< PointsKey > PointsKeyVector
Definition Points.h:313
unique_ptr_objpool< GeomFactors > GeomFactorsUniquePtr
Definition Geometry.h:62
std::map< int, CurveUniquePtr > CurveMap
Definition Geometry.h:71
GeomType
Indicates the type of element geometry.