Base class for element definitions. More...

#include <Element.h>

Inheritance diagram for Nektar::NekMeshUtils::Element:

Public Member Functions
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 bool	HasBoundaryLinks ()
	Is this element connected to a boundary. 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...

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

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

NEKMESHUTILS_EXPORT bool	IsDeformed ()
	Determines whether an element is deformed by inspecting whether there are any edge, face or volume interior nodes. More...

NEKMESHUTILS_EXPORT std::pair< Node, Node >	GetBoundingBox ()
	Returns the approximate bounding box of this element based on the coordinates of all vertices, edges and faces of the element. Note that this does not robustly take into account the curvature of the element. 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...

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

NEKMESHUTILS_EXPORT void	Print ()

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

Public Attributes
CADObjectSharedPtr	m_parentCAD

Protected Attributes
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

Base class for element definitions.

An element is defined by a list of vertices, edges and faces (depending on the dimension of the problem). This base class provides the underlying structure.

Definition at line 60 of file Element.h.

Constructor & Destructor Documentation

◆ Element()

Nektar::NekMeshUtils::Element::Element	(	ElmtConfig	pConf,
		unsigned int	pNumNodes,
		unsigned int	pGotNodes
	)

Definition at line 50 of file Element.cpp.

References Nektar::NekMeshUtils::ElmtConfig::m_e.

     : m_conf(pConf), m_curveType(LibUtilities::ePolyEvenlySpaced), m_geom()
 {
     if (pNumNodes != pGotNodes)
     {
         cerr << "Number of modes mismatch for type " << pConf.m_e
              << "! Should be " << pNumNodes << " but got " << pGotNodes
              << " nodes." << endl;
         abort();
     }
 }

Member Function Documentation

◆ GetBoundaryLink()

NEKMESHUTILS_EXPORT int Nektar::NekMeshUtils::Element::GetBoundaryLink ( int i )

inline

Get the location of the boundary face/edge i for this element.

Definition at line 240 of file Element.h.

References m_boundaryLinks.

     {
         std::map<int, int>::iterator it = m_boundaryLinks.find(i);
         if (it == m_boundaryLinks.end())
         {
             return -1;
         }
         else
         {
             return it->second;
         }
     }

◆ GetBoundingBox()

NEKMESHUTILS_EXPORT std::pair<Node, Node> Nektar::NekMeshUtils::Element::GetBoundingBox ( )

inline

Returns the approximate bounding box of this element based on the coordinates of all vertices, edges and faces of the element. Note that this does not robustly take into account the curvature of the element.

Definition at line 326 of file Element.h.

References m_edge, m_face, m_vertex, and SWAP_NODE.

     {
 #define SWAP_NODE(a)                                            \
         lower.m_x = std::min(lower.m_x, a->m_x);                  \
         lower.m_y = std::min(lower.m_y, a->m_y);                  \
         lower.m_z = std::min(lower.m_z, a->m_z);                  \
         upper.m_x = std::max(upper.m_x, a->m_x);                  \
         upper.m_y = std::max(upper.m_y, a->m_y);                  \
         upper.m_z = std::max(upper.m_z, a->m_z);
 
         Node lower(*m_vertex[0]), upper(*m_vertex[0]);
 
         for (int i = 1; i < m_vertex.size(); ++i)
         {
             SWAP_NODE(m_vertex[i])
         }
         for (auto &edge : m_edge)
         {
             for (auto &edgeNode : edge->m_edgeNodes)
             {
                 SWAP_NODE(edgeNode);
             }
         }
         for (auto &face : m_face)
         {
             for (auto &faceNode : face->m_faceNodes)
             {
                 SWAP_NODE(faceNode);
             }
         }
 
         return std::make_pair(lower, upper);
 #undef SWAP_NODE
     }

◆ GetConf()

NEKMESHUTILS_EXPORT ElmtConfig Nektar::NekMeshUtils::Element::GetConf ( ) const

inline

Returns the configuration of the element.

Definition at line 82 of file Element.h.

References m_conf.

     {
         return m_conf;
     }

◆ GetCurvedNodes()

virtual NEKMESHUTILS_EXPORT void Nektar::NekMeshUtils::Element::GetCurvedNodes ( std::vector< NodeSharedPtr > & nodeList ) const

inlinevirtual

get list of volume interior nodes

Reimplemented in Nektar::NekMeshUtils::Triangle, Nektar::NekMeshUtils::Prism, Nektar::NekMeshUtils::Quadrilateral, Nektar::NekMeshUtils::Tetrahedron, and Nektar::NekMeshUtils::Line.

Definition at line 265 of file Element.h.

References Nektar::ErrorUtil::efatal, GetXmlCurveString(), NEKERROR, and NEKMESHUTILS_EXPORT.

Referenced by GetXmlCurveString().

     {
         boost::ignore_unused(nodeList);
         NEKERROR(ErrorUtil::efatal,
                  "This function should be implemented at a shape level.");
     }

◆ GetCurveType()

NEKMESHUTILS_EXPORT LibUtilities::PointsType Nektar::NekMeshUtils::Element::GetCurveType ( ) const

inline

Definition at line 139 of file Element.h.

References m_curveType.

     {
         return m_curveType;
     }

◆ GetDim()

NEKMESHUTILS_EXPORT unsigned int Nektar::NekMeshUtils::Element::GetDim ( ) const

inline

Returns the expansion dimension of the element.

Definition at line 77 of file Element.h.

References m_dim.

     {
         return m_dim;
     }

◆ GetEdge()

NEKMESHUTILS_EXPORT EdgeSharedPtr Nektar::NekMeshUtils::Element::GetEdge ( unsigned int i ) const

inline

Access an edge.

Definition at line 106 of file Element.h.

References m_edge.

     {
         return m_edge[i];
     }

◆ GetEdgeCount()

NEKMESHUTILS_EXPORT unsigned int Nektar::NekMeshUtils::Element::GetEdgeCount ( ) const

inline

Returns the number of edges.

Definition at line 161 of file Element.h.

References m_edge.

     {
         return m_edge.size();
     }

◆ GetEdgeLink()

NEKMESHUTILS_EXPORT EdgeSharedPtr Nektar::NekMeshUtils::Element::GetEdgeLink ( )

inline

Get correspondence between this element and an edge.

Definition at line 218 of file Element.h.

References m_edgeLink.

     {
         return m_edgeLink;
     }

◆ GetEdgeList()

NEKMESHUTILS_EXPORT std::vector<EdgeSharedPtr> Nektar::NekMeshUtils::Element::GetEdgeList ( ) const

inline

Access the list of edges.

Definition at line 121 of file Element.h.

References m_edge.

     {
         return m_edge;
     }

◆ GetEdgeOrient()

virtual NEKMESHUTILS_EXPORT StdRegions::Orientation Nektar::NekMeshUtils::Element::GetEdgeOrient	(	int	edgeId,
		EdgeSharedPtr	edge
	)

inlinevirtual

Get the edge orientation of edge with respect to the local element, which lies at edge index edgeId.

Reimplemented in Nektar::NekMeshUtils::Hexahedron, Nektar::NekMeshUtils::Triangle, Nektar::NekMeshUtils::Prism, Nektar::NekMeshUtils::Quadrilateral, and Nektar::NekMeshUtils::Tetrahedron.

Definition at line 395 of file Element.h.

References Nektar::ErrorUtil::efatal, Nektar::StdRegions::eNoOrientation, and NEKERROR.

     {
         boost::ignore_unused(edgeId, edge);
         NEKERROR(ErrorUtil::efatal,
                  "This function should be implemented at a shape level.");
         return StdRegions::eNoOrientation;
     }

◆ GetFace()

NEKMESHUTILS_EXPORT FaceSharedPtr Nektar::NekMeshUtils::Element::GetFace ( unsigned int i ) const

inline

Access a face.

Definition at line 111 of file Element.h.

References m_face.

     {
         return m_face[i];
     }

◆ GetFaceCount()

NEKMESHUTILS_EXPORT unsigned int Nektar::NekMeshUtils::Element::GetFaceCount ( ) const

inline

Returns the number of faces.

Definition at line 166 of file Element.h.

References m_face.

     {
         return m_face.size();
     }

◆ GetFaceLink()

NEKMESHUTILS_EXPORT FaceSharedPtr Nektar::NekMeshUtils::Element::GetFaceLink ( )

inline

Get correspondence between this element and a face.

Definition at line 229 of file Element.h.

References m_faceLink.

     {
         return m_faceLink;
     }

◆ GetFaceList()

NEKMESHUTILS_EXPORT std::vector<FaceSharedPtr> Nektar::NekMeshUtils::Element::GetFaceList ( ) const

inline

Access the list of faces.

Definition at line 126 of file Element.h.

References m_face.

     {
         return m_face;
     }

◆ GetFaceVertex()

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

inlinevirtual

Returns the local index of vertex j of face i.

Reimplemented in Nektar::NekMeshUtils::Hexahedron, Nektar::NekMeshUtils::Prism, Nektar::NekMeshUtils::Tetrahedron, and Nektar::NekMeshUtils::Pyramid.

Definition at line 407 of file Element.h.

References Nektar::ErrorUtil::efatal, and NEKERROR.

     {
         boost::ignore_unused(i, j);
         NEKERROR(ErrorUtil::efatal,
                  "This function should be implemented at a shape level.");
         return 0;
     }

◆ GetGeom()

virtual NEKMESHUTILS_EXPORT SpatialDomains::GeometrySharedPtr Nektar::NekMeshUtils::Element::GetGeom ( int coordDim )

inlinevirtual

Generate a Nektar++ geometry object for this element.

Reimplemented in Nektar::NekMeshUtils::Hexahedron, Nektar::NekMeshUtils::Line, Nektar::NekMeshUtils::Triangle, Nektar::NekMeshUtils::Prism, Nektar::NekMeshUtils::Quadrilateral, Nektar::NekMeshUtils::Tetrahedron, and Nektar::NekMeshUtils::Pyramid.

Definition at line 277 of file Element.h.

References Nektar::ErrorUtil::efatal, GetMaxOrder(), NEKERROR, and NEKMESHUTILS_EXPORT.

     {
         boost::ignore_unused(coordDim);
         NEKERROR(ErrorUtil::efatal,
                  "This function should be implemented at a shape level.");
         return std::shared_ptr<SpatialDomains::Geometry>();
     }

◆ GetId()

NEKMESHUTILS_EXPORT unsigned int Nektar::NekMeshUtils::Element::GetId ( ) const

inline

Returns the ID of the element (or associated edge or face for boundary elements).

Definition at line 68 of file Element.h.

References m_edgeLink, m_faceLink, and m_id.

     {
         if (m_faceLink.get() != 0)
             return m_faceLink->m_id;
         if (m_edgeLink.get() != 0)
             return m_edgeLink->m_id;
         return m_id;
     }

◆ GetMaxOrder()

int Nektar::NekMeshUtils::Element::GetMaxOrder ( )

Obtain the order of an element by looking at edges.

Definition at line 135 of file Element.cpp.

References m_edge.

Referenced by GetGeom().

 {
     int i, ret = 1;
 
     for (i = 0; i < m_edge.size(); ++i)
     {
         int edgeOrder = m_edge[i]->GetNodeCount() - 1;
         if (edgeOrder > ret)
         {
             ret = edgeOrder;
         }
     }
 
     return ret;
 }

◆ GetNodeCount()

unsigned int Nektar::NekMeshUtils::Element::GetNodeCount ( )

Returns the total number of nodes (vertices, edge nodes and face nodes and volume nodes).

Definition at line 151 of file Element.cpp.

References m_dim, m_edge, m_face, m_vertex, and m_volumeNodes.

Referenced by SetCurveType().

 {
     unsigned int n = m_volumeNodes.size();
     if (m_dim == 1)
     {
         n += 2;
     }
     else if (m_dim == 2)
     {
         for (int i = 0; i < m_edge.size(); ++i)
         {
             n += m_edge[i]->GetNodeCount();
         }
         n -= m_vertex.size();
     }
     else
     {
         for (int i = 0; i < m_face.size(); ++i)
         {
             n += m_face[i]->GetNodeCount();
         }
         for (int i = 0; i < m_edge.size(); ++i)
         {
             n -= m_edge[i]->GetNodeCount();
         }
         n += m_vertex.size();
         std::cerr << "Not supported." << std::endl;
         exit(1);
     }
     return n;
 }

◆ GetShapeType()

NEKMESHUTILS_EXPORT LibUtilities::ShapeType Nektar::NekMeshUtils::Element::GetShapeType ( void ) const

inline

returns the shapetype

Definition at line 87 of file Element.h.

References m_conf, and Nektar::NekMeshUtils::ElmtConfig::m_e.

     {
         return m_conf.m_e;
     }

◆ GetTag()

NEKMESHUTILS_EXPORT std::string Nektar::NekMeshUtils::Element::GetTag ( ) const

inline

Returns the tag which defines the element shape.

Definition at line 92 of file Element.h.

References m_edgeLink, m_faceLink, and m_tag.

     {
         if (m_faceLink.get() != 0)
             return "F";
         if (m_edgeLink.get() != 0)
             return "E";
         return m_tag;
     }

◆ GetTagList()

NEKMESHUTILS_EXPORT std::vector<int> Nektar::NekMeshUtils::Element::GetTagList ( ) const

inline

Access the list of tags associated with this element.

Definition at line 151 of file Element.h.

References m_taglist.

     {
         return m_taglist;
     }

◆ GetVertex()

NEKMESHUTILS_EXPORT NodeSharedPtr Nektar::NekMeshUtils::Element::GetVertex ( unsigned int i ) const

inline

Access a vertex node.

Definition at line 101 of file Element.h.

References m_vertex.

Referenced by Nektar::Utilities::InputNek::Process().

     {
         return m_vertex[i];
     }

◆ GetVertexCount()

NEKMESHUTILS_EXPORT unsigned int Nektar::NekMeshUtils::Element::GetVertexCount ( ) const

inline

Returns the number of vertices.

Definition at line 156 of file Element.h.

References m_vertex.

     {
         return m_vertex.size();
     }

◆ GetVertexList()

NEKMESHUTILS_EXPORT std::vector<NodeSharedPtr> Nektar::NekMeshUtils::Element::GetVertexList ( ) const

inline

Access the list of vertex nodes.

Definition at line 116 of file Element.h.

References m_vertex.

     {
         return m_vertex;
     }

◆ GetVolumeNodes()

NEKMESHUTILS_EXPORT std::vector<NodeSharedPtr> Nektar::NekMeshUtils::Element::GetVolumeNodes ( ) const

inline

Access the list of volume nodes.

Definition at line 131 of file Element.h.

References m_volumeNodes.

     {
         return m_volumeNodes;
     }

◆ GetXmlCurveString()

string Nektar::NekMeshUtils::Element::GetXmlCurveString ( )

Generates a string listing the coordinates of all nodes associated with this element.

Definition at line 210 of file Element.cpp.

References GetCurvedNodes().

Referenced by GetCurvedNodes().

 {
     // Temporary node list for reordering
     std::vector<NodeSharedPtr> nodeList;
 
     GetCurvedNodes(nodeList);
 
     // Finally generate the XML string corresponding to our new
     // node reordering.
     std::stringstream s;
     std::string str;
     for (int k = 0; k < nodeList.size(); ++k)
     {
         s << std::scientific << std::setprecision(8) << "    "
           << nodeList[k]->m_x << "  " << nodeList[k]->m_y << "  "
           << nodeList[k]->m_z << "    ";
     }
     return s.str();
 }

◆ GetXmlString()

string Nektar::NekMeshUtils::Element::GetXmlString ( )

virtual

Generate a list of vertices (1D), edges (2D), or faces (3D).

Definition at line 183 of file Element.cpp.

References m_dim, m_edge, m_face, and m_vertex.

Referenced by SetTagList().

 {
     std::stringstream s;
     switch (m_dim)
     {
         case 1:
             for (int j = 0; j < m_vertex.size(); ++j)
             {
                 s << std::setw(5) << m_vertex[j]->m_id << " ";
             }
             break;
         case 2:
             for (int j = 0; j < m_edge.size(); ++j)
             {
                 s << std::setw(5) << m_edge[j]->m_id << " ";
             }
             break;
         case 3:
             for (int j = 0; j < m_face.size(); ++j)
             {
                 s << std::setw(5) << m_face[j]->m_id << " ";
             }
             break;
     }
     return s.str();
 }

◆ HasBoundaryLinks()

NEKMESHUTILS_EXPORT bool Nektar::NekMeshUtils::Element::HasBoundaryLinks ( )

inline

Is this element connected to a boundary.

Definition at line 253 of file Element.h.

References m_boundaryLinks.

     {
         return m_boundaryLinks.size() > 0;
     }

◆ IsDeformed()

NEKMESHUTILS_EXPORT bool Nektar::NekMeshUtils::Element::IsDeformed ( )

inline

Determines whether an element is deformed by inspecting whether there are any edge, face or volume interior nodes.

Definition at line 295 of file Element.h.

References m_edge, m_face, and m_volumeNodes.

     {
         if (m_volumeNodes.size() > 0)
         {
             return true;
         }
 
         for (auto &edge : m_edge)
         {
             if (edge->m_edgeNodes.size() > 0)
             {
                 return true;
             }
         }
 
         for (auto &face : m_face)
         {
             if (face->m_faceNodes.size() > 0)
             {
                 return true;
             }
         }
 
         return false;
     }

◆ MakeOrder()

virtual NEKMESHUTILS_EXPORT void Nektar::NekMeshUtils::Element::MakeOrder	(	int	order,
		SpatialDomains::GeometrySharedPtr	geom,
		LibUtilities::PointsType	edgeType,
		int	coordDim,
		int &	id,
		bool	justConfig = `false`
	)

inlinevirtual

Insert interior (i.e. volume) points into this element to make the geometry an order order representation.

Parameters

order	The desired polynomial order.
geom	The geometry object used to describe the curvature mapping.
edgeType	The points distribution to use on the volume.
coordDim	The coordinate (i.e. space) dimension.
id	Counter which should be incremented to supply consistent vertex IDs.
justConfig	If true, then the configuration Element::m_conf will be updated but no nodes will be generated. This is used when considering boundary elements, which just require copying of face or edge interior nodes.

Reimplemented in Nektar::NekMeshUtils::Hexahedron, Nektar::NekMeshUtils::Triangle, Nektar::NekMeshUtils::Prism, Nektar::NekMeshUtils::Quadrilateral, Nektar::NekMeshUtils::Tetrahedron, and Nektar::NekMeshUtils::Line.

Definition at line 378 of file Element.h.

References Nektar::ErrorUtil::efatal, and NEKERROR.

     {
         boost::ignore_unused(order, geom, edgeType, coordDim, id, justConfig);
         NEKERROR(ErrorUtil::efatal,
                  "This function should be implemented at a shape level.");
     }

◆ Normal()

virtual NEKMESHUTILS_EXPORT Array<OneD, NekDouble> Nektar::NekMeshUtils::Element::Normal ( bool inward = false )

inlinevirtual

returns the normal to the element

Reimplemented in Nektar::NekMeshUtils::Triangle.

Definition at line 446 of file Element.h.

References Nektar::ErrorUtil::efatal, and NEKERROR.

     {
         boost::ignore_unused(inward);
         NEKERROR(ErrorUtil::efatal,
                  "This function should be implemented at a shape level.");
         return Array<OneD, NekDouble>();
     }

◆ Print()

NEKMESHUTILS_EXPORT void Nektar::NekMeshUtils::Element::Print ( )

inline

Definition at line 415 of file Element.h.

References m_edge, m_face, and m_vertex.

     {
         int i, j;
         for (i = 0; i < m_vertex.size(); ++i)
         {
             std::cout << m_vertex[i]->m_x << " " << m_vertex[i]->m_y << " "
                       << m_vertex[i]->m_z << std::endl;
         }
         for (i = 0; i < m_edge.size(); ++i)
         {
             for (j = 0; j < m_edge[i]->m_edgeNodes.size(); ++j)
             {
                 NodeSharedPtr n = m_edge[i]->m_edgeNodes[j];
                 std::cout << n->m_x << " " << n->m_y << " " << n->m_z
                           << std::endl;
             }
         }
         for (i = 0; i < m_face.size(); ++i)
         {
             for (j = 0; j < m_face[i]->m_faceNodes.size(); ++j)
             {
                 NodeSharedPtr n = m_face[i]->m_faceNodes[j];
                 std::cout << n->m_x << " " << n->m_y << " " << n->m_z
                           << std::endl;
             }
         }
     }

◆ SetBoundaryLink()

NEKMESHUTILS_EXPORT void Nektar::NekMeshUtils::Element::SetBoundaryLink	(	int	i,
		int	j
	)

inline

Set a correspondence between edge or face i and its representative boundary element m->element[expDim-1][j].

Definition at line 235 of file Element.h.

References m_boundaryLinks.

     {
         m_boundaryLinks[i] = j;
     }

◆ SetCurveType()

NEKMESHUTILS_EXPORT void Nektar::NekMeshUtils::Element::SetCurveType ( LibUtilities::PointsType cT )

inline

Definition at line 143 of file Element.h.

References GetNodeCount(), m_curveType, and NEKMESHUTILS_EXPORT.

     {
         m_curveType = cT;
     }

◆ SetEdge()

void Nektar::NekMeshUtils::Element::SetEdge	(	unsigned int	p,
		EdgeSharedPtr	pNew,
		bool	descend = `true`
	)

Replace an edge in the element.

When an edge is replaced, the element faces are also searched and the corresponding face edges are updated to maintain consistency.

Parameters

p	Index of the edge to replace.
pNew	New edge.
descend	If true, we loop over faces and replace the corresponding face edge with `pNew`.

Definition at line 108 of file Element.cpp.

References m_edge, m_face, and CellMLToNektar.cellml_metadata::p.

Referenced by SetId().

 {
     EdgeSharedPtr vOld = m_edge[p];
     m_edge[p] = pNew;
 
     if (!descend)
     {
         return;
     }
 
     for (unsigned int i = 0; i < m_face.size(); ++i)
     {
         for (unsigned int j = 0; j < m_face[i]->m_edgeList.size(); ++j)
         {
             if (m_face[i]->m_edgeList[j] == vOld)
             {
                 m_face[i]->m_edgeList[j] = pNew;
             }
         }
     }
 }

◆ SetEdgeLink()

NEKMESHUTILS_EXPORT void Nektar::NekMeshUtils::Element::SetEdgeLink ( EdgeSharedPtr pLink )

inline

Set a correspondence between this element and an edge (2D boundary element).

Definition at line 213 of file Element.h.

References m_edgeLink.

     {
         m_edgeLink = pLink;
     }

◆ SetFace()

void Nektar::NekMeshUtils::Element::SetFace	(	unsigned int	p,
		FaceSharedPtr	pNew
	)

Replace a face in the element.

When a face is replaced, no other consistency checks are required.

Parameters

p	Index of the face to replace.
pNew	New face.

Definition at line 130 of file Element.cpp.

References m_face, and CellMLToNektar.cellml_metadata::p.

Referenced by SetId().

 {
     m_face[p] = pNew;
 }

◆ SetFaceLink()

NEKMESHUTILS_EXPORT void Nektar::NekMeshUtils::Element::SetFaceLink ( FaceSharedPtr pLink )

inline

Set a correspondence between this element and a face (3D boundary element).

Definition at line 224 of file Element.h.

References m_faceLink.

     {
         m_faceLink = pLink;
     }

◆ SetId()

NEKMESHUTILS_EXPORT void Nektar::NekMeshUtils::Element::SetId ( unsigned int p )

inline

Change the ID of the element.

Definition at line 171 of file Element.h.

References m_id, NEKMESHUTILS_EXPORT, CellMLToNektar.cellml_metadata::p, SetEdge(), SetFace(), and SetVertex().

     {
         m_id = p;
     }

◆ SetTagList()

NEKMESHUTILS_EXPORT void Nektar::NekMeshUtils::Element::SetTagList ( const std::vector< int > & tags )

inline

Set the list of tags associated with this element.

Definition at line 258 of file Element.h.

References GetXmlString(), m_taglist, and NEKMESHUTILS_EXPORT.

     {
         m_taglist = tags;
     }

◆ SetVertex()

void Nektar::NekMeshUtils::Element::SetVertex	(	unsigned int	p,
		NodeSharedPtr	pNew,
		bool	descend = `true`
	)

Replace a vertex in the element.

When a vertex is replaced, the element edges and faces are also searched and the corresponding edge/face nodes are updated to maintain consistency.

Parameters

p	Index of the vertex to replace.
pNew	New vertex.
descend	If true, we loop over edges and faces and replace the corresponding vertices with `pNew`.

Definition at line 63 of file Element.cpp.

References m_edge, m_face, m_vertex, and CellMLToNektar.cellml_metadata::p.

Referenced by SetId().

 {
     NodeSharedPtr vOld = m_vertex[p];
     m_vertex[p] = pNew;
 
     if (!descend)
     {
         return;
     }
 
     for (unsigned int i = 0; i < m_edge.size(); ++i)
     {
         if (m_edge[i]->m_n1 == vOld)
         {
             m_edge[i]->m_n1 = pNew;
         }
         else if (m_edge[i]->m_n2 == vOld)
         {
             m_edge[i]->m_n2 = pNew;
         }
     }
     for (unsigned int i = 0; i < m_face.size(); ++i)
     {
         // Replace vertices in faces
         for (unsigned int j = 0; j < m_face[i]->m_vertexList.size(); ++j)
         {
             if (m_face[i]->m_vertexList[j] == vOld)
             {
                 m_face[i]->m_vertexList[j] = pNew;
             }
         }
         for (unsigned int j = 0; j < m_face[i]->m_edgeList.size(); ++j)
         {
             if (m_face[i]->m_edgeList[j]->m_n1 == vOld)
             {
                 m_face[i]->m_edgeList[j]->m_n1 = pNew;
             }
             else if (m_face[i]->m_edgeList[j]->m_n2 == vOld)
             {
                 m_face[i]->m_edgeList[j]->m_n2 = pNew;
             }
         }
     }
 }

◆ SetVolumeNodes()

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

inline

Definition at line 135 of file Element.h.

References m_volumeNodes.

     {
         m_volumeNodes = nodes;
     }

Member Data Documentation

◆ m_boundaryLinks

std::map<int, int> Nektar::NekMeshUtils::Element::m_boundaryLinks

protected

Array mapping faces/edges to the location of the appropriate boundary elements in m->element.

Definition at line 483 of file Element.h.

Referenced by GetBoundaryLink(), HasBoundaryLinks(), and SetBoundaryLink().

◆ m_conf

ElmtConfig Nektar::NekMeshUtils::Element::m_conf

protected

Contains configuration of the element.

Definition at line 462 of file Element.h.

◆ m_curveType

LibUtilities::PointsType Nektar::NekMeshUtils::Element::m_curveType

protected

Volume curve type.

Definition at line 476 of file Element.h.

Referenced by GetCurveType(), Nektar::NekMeshUtils::Line::GetGeom(), Nektar::NekMeshUtils::Line::MakeOrder(), Nektar::NekMeshUtils::Tetrahedron::MakeOrder(), Nektar::NekMeshUtils::Quadrilateral::MakeOrder(), Nektar::NekMeshUtils::Prism::MakeOrder(), Nektar::NekMeshUtils::Triangle::MakeOrder(), Nektar::NekMeshUtils::Hexahedron::MakeOrder(), SetCurveType(), and Nektar::NekMeshUtils::Triangle::Triangle().

◆ m_dim

unsigned int Nektar::NekMeshUtils::Element::m_dim

protected

Dimension of the element.

Definition at line 460 of file Element.h.

Referenced by GetDim(), GetNodeCount(), GetXmlString(), Nektar::NekMeshUtils::Hexahedron::Hexahedron(), Nektar::NekMeshUtils::Line::Line(), Nektar::NekMeshUtils::Point::Point(), Nektar::NekMeshUtils::Prism::Prism(), Nektar::NekMeshUtils::Pyramid::Pyramid(), Nektar::NekMeshUtils::Quadrilateral::Quadrilateral(), Nektar::NekMeshUtils::Tetrahedron::Tetrahedron(), and Nektar::NekMeshUtils::Triangle::Triangle().

◆ m_edge

std::vector<EdgeSharedPtr> Nektar::NekMeshUtils::Element::m_edge

protected

List of element edges.

Definition at line 470 of file Element.h.

◆ m_edgeLink

EdgeSharedPtr Nektar::NekMeshUtils::Element::m_edgeLink

protected

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

Definition at line 478 of file Element.h.

Referenced by GetEdgeLink(), GetId(), GetTag(), and SetEdgeLink().

◆ m_face

std::vector<FaceSharedPtr> Nektar::NekMeshUtils::Element::m_face

protected

◆ m_faceLink

FaceSharedPtr Nektar::NekMeshUtils::Element::m_faceLink

protected

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

Definition at line 480 of file Element.h.

Referenced by GetFaceLink(), GetId(), GetTag(), and SetFaceLink().

◆ m_geom

SpatialDomains::GeometrySharedPtr Nektar::NekMeshUtils::Element::m_geom

protected

Nektar++ geometry object for this element.

Definition at line 485 of file Element.h.

Referenced by Nektar::NekMeshUtils::Pyramid::GetGeom().

◆ m_id

unsigned int Nektar::NekMeshUtils::Element::m_id

protected

ID of the element.

Definition at line 458 of file Element.h.

Referenced by Nektar::NekMeshUtils::Prism::GetCurvedNodes(), Nektar::NekMeshUtils::Tetrahedron::GetCurvedNodes(), Nektar::NekMeshUtils::Pyramid::GetGeom(), Nektar::NekMeshUtils::Tetrahedron::GetGeom(), Nektar::NekMeshUtils::Quadrilateral::GetGeom(), Nektar::NekMeshUtils::Prism::GetGeom(), Nektar::NekMeshUtils::Line::GetGeom(), Nektar::NekMeshUtils::Triangle::GetGeom(), Nektar::NekMeshUtils::Hexahedron::GetGeom(), GetId(), Nektar::NekMeshUtils::Tetrahedron::OrientTet(), and SetId().

◆ m_parentCAD

CADObjectSharedPtr Nektar::NekMeshUtils::Element::m_parentCAD

Definition at line 454 of file Element.h.

Referenced by Nektar::NekMeshUtils::Triangle::Normal().

◆ m_tag

std::string Nektar::NekMeshUtils::Element::m_tag

protected

Tag character describing the element.

Definition at line 464 of file Element.h.

Referenced by GetTag(), Nektar::NekMeshUtils::Hexahedron::Hexahedron(), Nektar::NekMeshUtils::Line::Line(), Nektar::NekMeshUtils::Point::Point(), Nektar::NekMeshUtils::Prism::Prism(), Nektar::NekMeshUtils::Pyramid::Pyramid(), Nektar::NekMeshUtils::Quadrilateral::Quadrilateral(), Nektar::NekMeshUtils::Tetrahedron::Tetrahedron(), and Nektar::NekMeshUtils::Triangle::Triangle().

◆ m_taglist

std::vector<int> Nektar::NekMeshUtils::Element::m_taglist

protected

List of integers specifying properties of the element.

Definition at line 466 of file Element.h.

Referenced by GetTagList(), Nektar::NekMeshUtils::Hexahedron::Hexahedron(), Nektar::NekMeshUtils::Line::Line(), Nektar::NekMeshUtils::Point::Point(), Nektar::NekMeshUtils::Prism::Prism(), Nektar::NekMeshUtils::Pyramid::Pyramid(), Nektar::NekMeshUtils::Quadrilateral::Quadrilateral(), SetTagList(), Nektar::NekMeshUtils::Tetrahedron::Tetrahedron(), and Nektar::NekMeshUtils::Triangle::Triangle().

◆ m_vertex

std::vector<NodeSharedPtr> Nektar::NekMeshUtils::Element::m_vertex

protected

List of element vertex nodes.

Definition at line 468 of file Element.h.

◆ m_volumeNodes

std::vector<NodeSharedPtr> Nektar::NekMeshUtils::Element::m_volumeNodes

protected

List of element volume nodes.

Definition at line 474 of file Element.h.

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Element()

Member Function Documentation

◆ GetBoundaryLink()

◆ GetBoundingBox()

◆ GetConf()

◆ GetCurvedNodes()

◆ GetCurveType()

◆ GetDim()

◆ GetEdge()

◆ GetEdgeCount()

◆ GetEdgeLink()

◆ GetEdgeList()

◆ GetEdgeOrient()

◆ GetFace()

◆ GetFaceCount()

◆ GetFaceLink()

◆ GetFaceList()

◆ GetFaceVertex()

◆ GetGeom()

◆ GetId()

◆ GetMaxOrder()

◆ GetNodeCount()

◆ GetShapeType()

◆ GetTag()

◆ GetTagList()

◆ GetVertex()

◆ GetVertexCount()

◆ GetVertexList()

◆ GetVolumeNodes()

◆ GetXmlCurveString()

◆ GetXmlString()

◆ HasBoundaryLinks()

◆ IsDeformed()

◆ MakeOrder()

◆ Normal()

◆ Print()

◆ SetBoundaryLink()

◆ SetCurveType()

◆ SetEdge()

◆ SetEdgeLink()

◆ SetFace()

◆ SetFaceLink()

◆ SetId()

◆ SetTagList()

◆ SetVertex()

◆ SetVolumeNodes()

Member Data Documentation

◆ m_boundaryLinks

◆ m_conf

◆ m_curveType

◆ m_dim

◆ m_edge

◆ m_edgeLink

◆ m_face

◆ m_faceLink

◆ m_geom

◆ m_id

◆ m_parentCAD

◆ m_tag

◆ m_taglist

◆ m_vertex

◆ m_volumeNodes