A 3-dimensional square-based pyramidic element. More...

#include <Pyramid.h>

Inheritance diagram for Nektar::NekMeshUtils::Pyramid:

Collaboration diagram for Nektar::NekMeshUtils::Pyramid:

Public Member Functions
NEKMESHUTILS_EXPORT	Pyramid (ElmtConfig pConf, std::vector< NodeSharedPtr > pNodeList, std::vector< int > pTagList)
	Create a pyramidic element. More...

NEKMESHUTILS_EXPORT	Pyramid (const Pyramid &pSrc)

virtual NEKMESHUTILS_EXPORT	~Pyramid ()

virtual NEKMESHUTILS_EXPORT SpatialDomains::GeometrySharedPtr	GetGeom (int coordDim)
	Generate a Nektar++ geometry object for this element. More...

virtual NEKMESHUTILS_EXPORT int	GetFaceVertex (int i, int j)
	Returns the local index of vertex `j` of face `i`. More...

Public Member Functions inherited from Nektar::NekMeshUtils::Element
NEKMESHUTILS_EXPORT	Element (ElmtConfig pConf, unsigned int pNumNodes, unsigned int pGotNodes)

NEKMESHUTILS_EXPORT unsigned int	GetId () const
	Returns the ID of the element (or associated edge or face for boundary elements). More...

NEKMESHUTILS_EXPORT unsigned int	GetDim () const
	Returns the expansion dimension of the element. More...

NEKMESHUTILS_EXPORT ElmtConfig	GetConf () const
	Returns the configuration of the element. More...

NEKMESHUTILS_EXPORT LibUtilities::ShapeType	GetShapeType () const
	returns the shapetype More...

NEKMESHUTILS_EXPORT std::string	GetTag () const
	Returns the tag which defines the element shape. More...

NEKMESHUTILS_EXPORT NodeSharedPtr	GetVertex (unsigned int i) const
	Access a vertex node. More...

NEKMESHUTILS_EXPORT EdgeSharedPtr	GetEdge (unsigned int i) const
	Access an edge. More...

NEKMESHUTILS_EXPORT FaceSharedPtr	GetFace (unsigned int i) const
	Access a face. More...

NEKMESHUTILS_EXPORT std::vector< NodeSharedPtr >	GetVertexList () const
	Access the list of vertex nodes. More...

NEKMESHUTILS_EXPORT std::vector< EdgeSharedPtr >	GetEdgeList () const
	Access the list of edges. More...

NEKMESHUTILS_EXPORT std::vector< FaceSharedPtr >	GetFaceList () const
	Access the list of faces. More...

NEKMESHUTILS_EXPORT std::vector< NodeSharedPtr >	GetVolumeNodes () const
	Access the list of volume nodes. More...

NEKMESHUTILS_EXPORT void	SetVolumeNodes (std::vector< NodeSharedPtr > &nodes)

NEKMESHUTILS_EXPORT LibUtilities::PointsType	GetCurveType () const

NEKMESHUTILS_EXPORT void	SetCurveType (LibUtilities::PointsType cT)

NEKMESHUTILS_EXPORT unsigned int	GetNodeCount ()
	Returns the total number of nodes (vertices, edge nodes and face nodes and volume nodes). More...

NEKMESHUTILS_EXPORT std::vector< int >	GetTagList () const
	Access the list of tags associated with this element. More...

NEKMESHUTILS_EXPORT unsigned int	GetVertexCount () const
	Returns the number of vertices. More...

NEKMESHUTILS_EXPORT unsigned int	GetEdgeCount () const
	Returns the number of edges. More...

NEKMESHUTILS_EXPORT unsigned int	GetFaceCount () const
	Returns the number of faces. More...

NEKMESHUTILS_EXPORT void	SetId (unsigned int p)
	Change the ID of the element. More...

NEKMESHUTILS_EXPORT void	SetVertex (unsigned int p, NodeSharedPtr pNew, bool descend=true)
	Replace a vertex in the element. More...

NEKMESHUTILS_EXPORT void	SetEdge (unsigned int p, EdgeSharedPtr pNew, bool descend=true)
	Replace an edge in the element. More...

NEKMESHUTILS_EXPORT void	SetFace (unsigned int p, FaceSharedPtr pNew)
	Replace a face in the element. More...

NEKMESHUTILS_EXPORT void	SetEdgeLink (EdgeSharedPtr pLink)
	Set a correspondence between this element and an edge (2D boundary element). More...

NEKMESHUTILS_EXPORT EdgeSharedPtr	GetEdgeLink ()
	Get correspondence between this element and an edge. More...

NEKMESHUTILS_EXPORT void	SetFaceLink (FaceSharedPtr pLink)
	Set a correspondence between this element and a face (3D boundary element). More...

NEKMESHUTILS_EXPORT FaceSharedPtr	GetFaceLink ()
	Get correspondence between this element and a face. More...

NEKMESHUTILS_EXPORT void	SetBoundaryLink (int i, int j)
	Set a correspondence between edge or face i and its representative boundary element m->element[expDim-1][j]. More...

NEKMESHUTILS_EXPORT int	GetBoundaryLink (int i)
	Get the location of the boundary face/edge i for this element. More...

NEKMESHUTILS_EXPORT void	SetTagList (const std::vector< int > &tags)
	Set the list of tags associated with this element. More...

virtual NEKMESHUTILS_EXPORT std::string	GetXmlString ()
	Generate a list of vertices (1D), edges (2D), or faces (3D). More...

virtual NEKMESHUTILS_EXPORT void	GetCurvedNodes (std::vector< NodeSharedPtr > &nodeList) const
	get list of volume interior nodes More...

NEKMESHUTILS_EXPORT std::string	GetXmlCurveString ()
	Generates a string listing the coordinates of all nodes associated with this element. More...

NEKMESHUTILS_EXPORT int	GetMaxOrder ()
	Obtain the order of an element by looking at edges. More...

virtual NEKMESHUTILS_EXPORT void	MakeOrder (int order, SpatialDomains::GeometrySharedPtr geom, LibUtilities::PointsType edgeType, int coordDim, int &id, bool justConfig=false)
	Insert interior (i.e. volume) points into this element to make the geometry an order `order` representation. More...

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`. More...

NEKMESHUTILS_EXPORT void	Print ()

virtual NEKMESHUTILS_EXPORT Array< OneD, NekDouble >	Normal (bool inward=false)
	returns the normal to the element More...

Static Public Member Functions
static ElementSharedPtr	create (ElmtConfig pConf, std::vector< NodeSharedPtr > pNodeList, std::vector< int > pTagList)
	Creates an instance of this class. More...

static NEKMESHUTILS_EXPORT unsigned int	GetNumNodes (ElmtConfig pConf)
	Return the number of nodes defining a pyramid. More...

Public Attributes
int	orientationMap [5]

Public Attributes inherited from Nektar::NekMeshUtils::Element
CADObjectSharedPtr	m_parentCAD

Static Public Attributes
static LibUtilities::ShapeType	type
	Element type. More...

Static Private Attributes
static int	m_faceIds [5][4]
	Vertex IDs that make up pyramid faces. More...

Additional Inherited Members
Protected Attributes inherited from Nektar::NekMeshUtils::Element
unsigned int	m_id
	ID of the element. More...

unsigned int	m_dim
	Dimension of the element. More...

ElmtConfig	m_conf
	Contains configuration of the element. More...

std::string	m_tag
	Tag character describing the element. More...

std::vector< int >	m_taglist
	List of integers specifying properties of the element. More...

std::vector< NodeSharedPtr >	m_vertex
	List of element vertex nodes. More...

std::vector< EdgeSharedPtr >	m_edge
	List of element edges. More...

std::vector< FaceSharedPtr >	m_face
	List of element faces. More...

std::vector< NodeSharedPtr >	m_volumeNodes
	List of element volume nodes. More...

LibUtilities::PointsType	m_curveType
	Volume curve type. More...

EdgeSharedPtr	m_edgeLink
	Pointer to the corresponding edge if element is a 2D boundary. More...

FaceSharedPtr	m_faceLink
	Pointer to the corresponding face if element is a 3D boundary. More...

std::map< int, int >	m_boundaryLinks
	Array mapping faces/edges to the location of the appropriate boundary elements in m->element. More...

SpatialDomains::GeometrySharedPtr	m_geom
	Nektar++ geometry object for this element. More...

Detailed Description

A 3-dimensional square-based pyramidic element.

Definition at line 49 of file Pyramid.h.

Constructor & Destructor Documentation

Nektar::NekMeshUtils::Pyramid::Pyramid	(	ElmtConfig	pConf,
		std::vector< NodeSharedPtr >	pNodeList,
		std::vector< int >	pTagList
	)

Create a pyramidic element.

Definition at line 58 of file Pyramid.cpp.

Referenced by create().

     : Element(pConf, GetNumNodes(pConf), pNodeList.size())
 {
     m_tag     = "P";
     m_dim     = 3;
     m_taglist = pTagList;
     int n     = m_conf.m_order - 1;
 
     // This edge-node map is based on Nektar++ ordering.
     map<pair<int, int>, int> edgeNodeMap;
     map<pair<int, int>, int>::iterator it;
     edgeNodeMap[pair<int, int>(1, 2)] = 6;
     edgeNodeMap[pair<int, int>(2, 3)] = 6 + n;
     edgeNodeMap[pair<int, int>(4, 3)] = 6 + 2 * n;
     edgeNodeMap[pair<int, int>(1, 4)] = 6 + 3 * n;
     edgeNodeMap[pair<int, int>(1, 5)] = 6 + 4 * n;
     edgeNodeMap[pair<int, int>(2, 5)] = 6 + 5 * n;
     edgeNodeMap[pair<int, int>(3, 5)] = 6 + 6 * n;
     edgeNodeMap[pair<int, int>(4, 5)] = 6 + 7 * n;
 
     // Add vertices
     for (int i = 0; i < 5; ++i)
     {
         m_vertex.push_back(pNodeList[i]);
     }
 
     // Create edges (with corresponding set of edge points)
     int eid = 0;
     for (it = edgeNodeMap.begin(); it != edgeNodeMap.end(); ++it)
     {
         vector<NodeSharedPtr> edgeNodes;
         if (m_conf.m_order > 1)
         {
             for (int j = it->second; j < it->second + n; ++j)
             {
                 edgeNodes.push_back(pNodeList[j - 1]);
             }
         }
         m_edge.push_back(EdgeSharedPtr(new Edge(pNodeList[it->first.first - 1],
                                                 pNodeList[it->first.second - 1],
                                                 edgeNodes,
                                                 m_conf.m_edgeCurveType)));
         m_edge.back()->m_id = eid++;
     }
 
     // Create faces
     int face_edges[5][4];
     int faceoffset = 5 + 8 * n;
     for (int j = 0; j < 5; ++j)
     {
         vector<NodeSharedPtr> faceVertices;
         vector<EdgeSharedPtr> faceEdges;
         vector<NodeSharedPtr> faceNodes;
         int nEdge = j > 0 ? 3 : 4;
 
         for (int k = 0; k < nEdge; ++k)
         {
             faceVertices.push_back(m_vertex[m_faceIds[j][k]]);
             NodeSharedPtr a = m_vertex[m_faceIds[j][k]];
             NodeSharedPtr b = m_vertex[m_faceIds[j][(k + 1) % nEdge]];
             for (unsigned int i = 0; i < m_edge.size(); ++i)
             {
                 if ((m_edge[i]->m_n1 == a && m_edge[i]->m_n2 == b) ||
                     (m_edge[i]->m_n1 == b && m_edge[i]->m_n2 == a))
                 {
                     faceEdges.push_back(m_edge[i]);
                     face_edges[j][k] = i;
                     break;
                 }
             }
         }
 
         if (m_conf.m_faceNodes)
         {
             int facenodes = j == 0 ? n * n : n * (n - 1) / 2;
             for (int i = 0; i < facenodes; ++i)
             {
                 faceNodes.push_back(pNodeList[faceoffset + i]);
             }
             faceoffset += facenodes;
         }
         m_face.push_back(FaceSharedPtr(new Face(
             faceVertices, faceNodes, faceEdges, m_conf.m_faceCurveType)));
     }
 
     // Reorder edges to align with Nektar++ order.
     vector<EdgeSharedPtr> tmp(8);
     tmp[0] = m_edge[face_edges[0][0]];
     tmp[1] = m_edge[face_edges[0][1]];
     tmp[2] = m_edge[face_edges[0][2]];
     tmp[3] = m_edge[face_edges[0][3]];
     tmp[4] = m_edge[face_edges[1][2]];
     tmp[5] = m_edge[face_edges[1][1]];
     tmp[6] = m_edge[face_edges[3][1]];
     tmp[7] = m_edge[face_edges[3][2]];
     m_edge = tmp;
 }

NEKMESHUTILS_EXPORT Nektar::NekMeshUtils::Pyramid::Pyramid ( const Pyramid & pSrc )

virtual NEKMESHUTILS_EXPORT Nektar::NekMeshUtils::Pyramid::~Pyramid ( )

inlinevirtual

Definition at line 67 of file Pyramid.h.

68 {

69 }

Member Function Documentation

static ElementSharedPtr Nektar::NekMeshUtils::Pyramid::create	(	ElmtConfig	pConf,
		std::vector< NodeSharedPtr >	pNodeList,
		std::vector< int >	pTagList
	)

inlinestatic

Creates an instance of this class.

Definition at line 53 of file Pyramid.h.

References Pyramid().

     {
         return boost::shared_ptr<Element>(
             new Pyramid(pConf, pNodeList, pTagList));
     }

virtual NEKMESHUTILS_EXPORT int Nektar::NekMeshUtils::Pyramid::GetFaceVertex	(	int	i,
		int	j
	)

inlinevirtual

Returns the local index of vertex j of face i.

Reimplemented from Nektar::NekMeshUtils::Element.

Definition at line 74 of file Pyramid.h.

References m_faceIds.

     {
         return m_faceIds[i][j];
     }

SpatialDomains::GeometrySharedPtr Nektar::NekMeshUtils::Pyramid::GetGeom ( int coordDim )

virtual

Generate a Nektar++ geometry object for this element.

Reimplemented from Nektar::NekMeshUtils::Element.

Definition at line 158 of file Pyramid.cpp.

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), Nektar::NekMeshUtils::Element::m_face, and Nektar::NekMeshUtils::Element::m_geom.

 {
     SpatialDomains::Geometry2DSharedPtr faces[5];
 
     for (int i = 0; i < 5; ++i)
     {
         faces[i] = m_face[i]->GetGeom(coordDim);
     }
 
     m_geom = MemoryManager<SpatialDomains::PyrGeom>::AllocateSharedPtr(faces);
 
     return m_geom;
 }

unsigned int Nektar::NekMeshUtils::Pyramid::GetNumNodes ( ElmtConfig pConf )

static

Return the number of nodes defining a pyramid.

Definition at line 175 of file Pyramid.cpp.

References Nektar::NekMeshUtils::ElmtConfig::m_order.

Referenced by Nektar::Utilities::InputGmsh::GetNnodes().

 {
     int n = pConf.m_order;
     return 5 + 8 * (n - 1);
 }

Member Data Documentation

int Nektar::NekMeshUtils::Pyramid::m_faceIds

staticprivate

Initial value:

= {
    {0, 1, 2, 3}, {0, 1, 4, -1}, {1, 2, 4, -1}, {3, 2, 4, -1}, {0, 3, 4, -1}
}

Vertex IDs that make up pyramid faces.

Definition at line 85 of file Pyramid.h.

Referenced by GetFaceVertex(), and Pyramid().

int Nektar::NekMeshUtils::Pyramid::orientationMap[5]

Orientation of pyramid.

Definition at line 82 of file Pyramid.h.

LibUtilities::ShapeType Nektar::NekMeshUtils::Pyramid::type

static

Initial value:

=
    GetElementFactory().RegisterCreatorFunction(
        LibUtilities::ePyramid, Pyramid::create, "Pyramid")

Element type.

Definition at line 61 of file Pyramid.h.

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation