Base class for shape geometry information. More...

#include <Geometry.h>

Inheritance diagram for Nektar::SpatialDomains::Geometry:

Public Member Functions
	Geometry ()
	Default constructor. More...

	Geometry (int coordim)
	Constructor when supplied a coordinate dimension. More...

virtual	~Geometry ()
	Default destructor. More...

int	GetCoordim () const
	Return the coordinate dimension of this object (i.e. the dimension of the space in which this object is embedded). More...

void	SetCoordim (int coordim)
	Sets the coordinate dimension of this object (i.e. the dimension of the space in which this object is embedded). More...

GeomFactorsSharedPtr	GetGeomFactors ()
	Get the geometric factors for this object, generating them if required. More...

GeomFactorsSharedPtr	GetRefGeomFactors (const Array< OneD, const LibUtilities::BasisSharedPtr > &tbasis)

GeomFactorsSharedPtr	GetMetricInfo ()
	Get the geometric factors for this object. More...

LibUtilities::ShapeType	GetShapeType (void)
	Get the geometric shape type of this object. More...

int	GetGlobalID (void) const
	Get the ID of this object. More...

void	SetGlobalID (int globalid)
	Set the ID of this object. More...

int	GetVid (int i) const
	Get the ID of vertex `i` of this object. More...

int	GetEid (int i) const
	Get the ID of edge `i` of this object. More...

int	GetFid (int i) const
	Get the ID of face `i` of this object. More...

int	GetTid (int i) const
	Get the ID of trace `i` of this object. More...

PointGeomSharedPtr	GetVertex (int i) const
	Returns vertex `i` of this object. More...

Geometry1DSharedPtr	GetEdge (int i) const
	Returns edge `i` of this object. More...

Geometry2DSharedPtr	GetFace (int i) const
	Returns face `i` of this object. More...

StdRegions::Orientation	GetEorient (const int i) const
	Returns the orientation of edge `i` with respect to the ordering of edges in the standard element. More...

StdRegions::Orientation	GetForient (const int i) const
	Returns the orientation of face `i` with respect to the ordering of faces in the standard element. More...

int	GetNumVerts () const
	Get the number of vertices of this object. More...

int	GetNumEdges () const
	Get the number of edges of this object. More...

int	GetNumFaces () const
	Get the number of faces of this object. More...

int	GetShapeDim () const
	Get the object's shape dimension. More...

StdRegions::StdExpansionSharedPtr	GetXmap () const
	Return the mapping object Geometry::m_xmap that represents the coordinate transformation from standard element to physical element. More...

const Array< OneD, const NekDouble > &	GetCoeffs (const int i) const
	Return the coefficients of the transformation Geometry::m_xmap in coordinate direction `i`. More...

void	FillGeom ()
	Populate the coordinate mapping Geometry::m_coeffs information from any children geometry elements. More...

std::array< NekDouble, 6 >	GetBoundingBox ()
	Generates the bounding box for the element. More...

void	ClearBoundingBox ()

bool	ContainsPoint (const Array< OneD, const NekDouble > &gloCoord, NekDouble tol=0.0)
	Determine whether an element contains a particular Cartesian coordinate \((x,y,z)\). More...

bool	ContainsPoint (const Array< OneD, const NekDouble > &gloCoord, Array< OneD, NekDouble > &locCoord, NekDouble tol)
	Determine whether an element contains a particular Cartesian coordinate \((x,y,z)\). More...

bool	ContainsPoint (const Array< OneD, const NekDouble > &gloCoord, Array< OneD, NekDouble > &locCoord, NekDouble tol, NekDouble &dist)
	Determine whether an element contains a particular Cartesian coordinate \(\vec{x} = (x,y,z)\). More...

NekDouble	GetLocCoords (const Array< OneD, const NekDouble > &coords, Array< OneD, NekDouble > &Lcoords)
	Determine the local collapsed coordinates that correspond to a given Cartesian coordinate for this geometry object. More...

NekDouble	GetCoord (const int i, const Array< OneD, const NekDouble > &Lcoord)
	Given local collapsed coordinate `Lcoord`, return the value of physical coordinate in direction `i`. More...

int	PreliminaryCheck (const Array< OneD, const NekDouble > &gloCoord)
	A fast and robust check if a given global coord is outside of a deformed element. For regular elements, this check is unnecessary. More...

bool	MinMaxCheck (const Array< OneD, const NekDouble > &gloCoord)
	Check if given global coord is within the BoundingBox of the element. More...

bool	ClampLocCoords (Array< OneD, NekDouble > &locCoord, NekDouble tol=std::numeric_limits< NekDouble >::epsilon())
	Clamp local coords to be within standard regions [-1, 1]^dim. More...

NekDouble	FindDistance (const Array< OneD, const NekDouble > &xs, Array< OneD, NekDouble > &xi)

int	GetVertexEdgeMap (int i, int j) const
	Returns the standard element edge IDs that are connected to a given vertex. More...

int	GetVertexFaceMap (int i, int j) const
	Returns the standard element face IDs that are connected to a given vertex. More...

int	GetEdgeFaceMap (int i, int j) const
	Returns the standard element edge IDs that are connected to a given face. More...

int	GetEdgeNormalToFaceVert (int i, int j) const
	Returns the standard lement edge IDs that are normal to a given face vertex. More...

int	GetDir (const int i, const int j=0) const
	Returns the element coordinate direction corresponding to a given face coordinate direction. More...

void	Reset (CurveMap &curvedEdges, CurveMap &curvedFaces)
	Reset this geometry object: unset the current state, zero Geometry::m_coeffs and remove allocated GeomFactors. More...

void	ResetNonRecursive (CurveMap &curvedEdges, CurveMap &curvedFaces)
	Reset this geometry object non-recursively: unset the current state, zero Geometry::m_coeffs and remove allocated GeomFactors. More...

void	Setup ()

void	GenGeomFactors ()
	Handles generation of geometry factors. More...

Protected Member Functions
virtual PointGeomSharedPtr	v_GetVertex (int i) const =0

virtual Geometry1DSharedPtr	v_GetEdge (int i) const
	Returns edge `i` of this object. More...

virtual Geometry2DSharedPtr	v_GetFace (int i) const
	Returns face `i` of this object. More...

virtual StdRegions::Orientation	v_GetEorient (const int i) const
	Returns the orientation of edge `i` with respect to the ordering of edges in the standard element. More...

virtual StdRegions::Orientation	v_GetForient (const int i) const
	Returns the orientation of face `i` with respect to the ordering of faces in the standard element. More...

virtual int	v_GetNumVerts () const
	Get the number of vertices of this object. More...

virtual int	v_GetNumEdges () const
	Get the number of edges of this object. More...

virtual int	v_GetNumFaces () const
	Get the number of faces of this object. More...

virtual int	v_GetShapeDim () const
	Get the object's shape dimension. More...

virtual StdRegions::StdExpansionSharedPtr	v_GetXmap () const
	Return the mapping object Geometry::m_xmap that represents the coordinate transformation from standard element to physical element. More...

virtual void	v_FillGeom ()
	Populate the coordinate mapping Geometry::m_coeffs information from any children geometry elements. More...

virtual bool	v_ContainsPoint (const Array< OneD, const NekDouble > &gloCoord, Array< OneD, NekDouble > &locCoord, NekDouble tol, NekDouble &dist)
	Determine whether an element contains a particular Cartesian coordinate \(\vec{x} = (x,y,z)\). More...

virtual int	v_AllLeftCheck (const Array< OneD, const NekDouble > &gloCoord)

virtual NekDouble	v_GetCoord (const int i, const Array< OneD, const NekDouble > &Lcoord)
	Given local collapsed coordinate `Lcoord`, return the value of physical coordinate in direction `i`. More...

virtual NekDouble	v_GetLocCoords (const Array< OneD, const NekDouble > &coords, Array< OneD, NekDouble > &Lcoords)
	Determine the local collapsed coordinates that correspond to a given Cartesian coordinate for this geometry object. More...

virtual NekDouble	v_FindDistance (const Array< OneD, const NekDouble > &xs, Array< OneD, NekDouble > &xi)

virtual int	v_GetVertexEdgeMap (int i, int j) const
	Returns the standard element edge IDs that are connected to a given vertex. More...

virtual int	v_GetVertexFaceMap (int i, int j) const
	Returns the standard element face IDs that are connected to a given vertex. More...

virtual int	v_GetEdgeFaceMap (int i, int j) const
	Returns the standard element edge IDs that are connected to a given face. More...

virtual int	v_GetEdgeNormalToFaceVert (const int i, const int j) const
	Returns the standard lement edge IDs that are normal to a given face vertex. More...

virtual int	v_GetDir (const int faceidx, const int facedir) const
	Returns the element coordinate direction corresponding to a given face coordinate direction. More...

virtual void	v_Reset (CurveMap &curvedEdges, CurveMap &curvedFaces)
	Reset this geometry object: unset the current state, zero Geometry::m_coeffs and remove allocated GeomFactors. More...

virtual void	v_Setup ()

virtual void	v_GenGeomFactors ()=0

void	SetUpCoeffs (const int nCoeffs)
	Initialise the Geometry::m_coeffs array. More...

virtual void	v_CalculateInverseIsoParam ()

Static Protected Member Functions
static GeomFactorsSharedPtr	ValidateRegGeomFactor (GeomFactorsSharedPtr geomFactor)
	Check to see if a geometric factor has already been created that contains the same regular information. More...

Protected Attributes
int	m_coordim
	Coordinate dimension of this geometry object. More...

GeomFactorsSharedPtr	m_geomFactors
	Geometric factors. More...

GeomState	m_geomFactorsState
	State of the geometric factors. More...

StdRegions::StdExpansionSharedPtr	m_xmap
	\(\chi\) mapping containing isoparametric transformation. More...

GeomState	m_state
	Enumeration to dictate whether coefficients are filled. More...

bool	m_setupState
	Wether or not the setup routines have been run. More...

GeomType	m_geomType
	Type of geometry. More...

LibUtilities::ShapeType	m_shapeType
	Type of shape. More...

int	m_globalID
	Global ID. More...

Array< OneD, Array< OneD, NekDouble > >	m_coeffs
	Array containing expansion coefficients of `m_xmap`. More...

Array< OneD, NekDouble >	m_boundingBox
	Array containing bounding box. More...

Array< OneD, Array< OneD, NekDouble > >	m_isoParameter

Array< OneD, Array< OneD, NekDouble > >	m_invIsoParam

int	m_straightEdge

Static Protected Attributes
static GeomFactorsVector	m_regGeomFactorsManager

Detailed Description

Base class for shape geometry information.

Definition at line 78 of file Geometry.h.

Constructor & Destructor Documentation

◆ Geometry() [1/2]

Nektar::SpatialDomains::Geometry::Geometry ( )

Default constructor.

Definition at line 50 of file Geometry.cpp.

    : m_coordim(0), m_geomFactorsState(eNotFilled), m_state(eNotFilled),
      m_setupState(false), m_shapeType(LibUtilities::eNoShapeType),
      m_globalID(-1), m_straightEdge(0)
{
}

◆ Geometry() [2/2]

Nektar::SpatialDomains::Geometry::Geometry ( int coordim )

Constructor when supplied a coordinate dimension.

Definition at line 60 of file Geometry.cpp.

    : m_coordim(coordim), m_geomFactorsState(eNotFilled), m_state(eNotFilled),
      m_setupState(false), m_shapeType(LibUtilities::eNoShapeType),
      m_globalID(-1), m_straightEdge(0)
{
}

◆ ~Geometry()

Nektar::SpatialDomains::Geometry::~Geometry ( )

virtual

Default destructor.

Definition at line 70 of file Geometry.cpp.

71{

72}

Member Function Documentation

◆ ClampLocCoords()

bool Nektar::SpatialDomains::Geometry::ClampLocCoords	(	Array< OneD, NekDouble > &	locCoord,
		NekDouble	tol = `std::numeric_limits<NekDouble>::epsilon()`
	)

Clamp local coords to be within standard regions [-1, 1]^dim.

Parameters

Lcoords Corresponding local coordinates

Definition at line 561 of file Geometry.cpp.

{
    // Validation checks
    ASSERTL1(locCoord.size() >= GetShapeDim(),
             "Expects local coordinates to be same or "
             "larger than shape dimension.");
 
    // If out of range clamp locCoord to be within [-1,1]^dim
    // since any larger value will be very oscillatory if
    // called by 'returnNearestElmt' option in
    // ExpList::GetExpIndex
    bool clamp = false;
    for (int i = 0; i < GetShapeDim(); ++i)
    {
        if (!std::isfinite(locCoord[i]))
        {
            locCoord[i] = 0.;
            clamp       = true;
        }
        else if (locCoord[i] < -(1. + tol))
        {
            locCoord[i] = -(1. + tol);
            clamp       = true;
        }
        else if (locCoord[i] > (1. + tol))
        {
            locCoord[i] = 1. + tol;
            clamp       = true;
        }
    }
    return clamp;
}

References ASSERTL1, and GetShapeDim().

Referenced by Nektar::SpatialDomains::Geometry2D::NewtonIterationForLocCoord(), Nektar::SpatialDomains::Geometry3D::NewtonIterationForLocCoord(), v_ContainsPoint(), Nektar::SpatialDomains::Geometry2D::v_FindDistance(), Nektar::SpatialDomains::SegGeom::v_FindDistance(), Nektar::SpatialDomains::Geometry2D::v_GetLocCoords(), and Nektar::SpatialDomains::Geometry3D::v_GetLocCoords().

◆ ClearBoundingBox()

void Nektar::SpatialDomains::Geometry::ClearBoundingBox ( )

Definition at line 496 of file Geometry.cpp.

{
    m_boundingBox = {};
}

References m_boundingBox.

◆ ContainsPoint() [1/3]

bool Nektar::SpatialDomains::Geometry::ContainsPoint	(	const Array< OneD, const NekDouble > &	gloCoord,
		Array< OneD, NekDouble > &	locCoord,
		NekDouble	tol
	)

inline

Determine whether an element contains a particular Cartesian coordinate \((x,y,z)\).

See also: Geometry::ContainsPoint

Definition at line 482 of file Geometry.h.

{
    NekDouble dist;
    return v_ContainsPoint(gloCoord, locCoord, tol, dist);
}

References v_ContainsPoint().

◆ ContainsPoint() [2/3]

bool Nektar::SpatialDomains::Geometry::ContainsPoint	(	const Array< OneD, const NekDouble > &	gloCoord,
		Array< OneD, NekDouble > &	locCoord,
		NekDouble	tol,
		NekDouble &	dist
	)

inline

Determine whether an element contains a particular Cartesian coordinate \(\vec{x} = (x,y,z)\).

For curvilinear and non-affine elements (i.e. where the Jacobian varies as a function of the standard element coordinates), this is a non-linear optimisation problem that requires the use of a Newton iteration. Note therefore that this can be an expensive operation.

The parameter tol which is by default 0, can be used to expand the coordinate range of the standard element from \([-1,1]^d\) to \([-1-\epsilon,1+\epsilon\) to handle challenging edge cases. The function also returns the local coordinates corresponding to gloCoord that can be used to speed up subsequent searches.

Parameters

gloCoord	The coordinate \( (x,y,z) \).
locCoord	On exit, this is the local coordinate \(\vec{\xi}\) such that \(\chi(\vec{\xi}) = \vec{x}\).
tol	The tolerance used to dictate the bounding box of the standard coordinates \(\vec{\xi}\).
dist	On exit, returns the minimum distance between `gloCoord` and the quadrature points inside the element.

Returns: true if the coordinate gloCoord is contained in the element; false otherwise.

See also: Geometry::GetLocCoords.

Definition at line 518 of file Geometry.h.

{
    return v_ContainsPoint(gloCoord, locCoord, tol, dist);
}

References v_ContainsPoint().

◆ ContainsPoint() [3/3]

bool Nektar::SpatialDomains::Geometry::ContainsPoint	(	const Array< OneD, const NekDouble > &	gloCoord,
		NekDouble	tol = `0.0`
	)

inline

Determine whether an element contains a particular Cartesian coordinate \((x,y,z)\).

See also: Geometry::ContainsPoint

Definition at line 468 of file Geometry.h.

{
    Array<OneD, NekDouble> locCoord(GetCoordim(), 0.0);
    NekDouble dist;
    return v_ContainsPoint(gloCoord, locCoord, tol, dist);
}

References GetCoordim(), and v_ContainsPoint().

◆ FillGeom()

void Nektar::SpatialDomains::Geometry::FillGeom ( )

inline

Populate the coordinate mapping Geometry::m_coeffs information from any children geometry elements.

See also: v_FillGeom()

Definition at line 457 of file Geometry.h.

{
    v_FillGeom();
}

References v_FillGeom().

◆ FindDistance()

NekDouble Nektar::SpatialDomains::Geometry::FindDistance	(	const Array< OneD, const NekDouble > &	xs,
		Array< OneD, NekDouble > &	xi
	)

inline

Definition at line 561 of file Geometry.h.

{
    return v_FindDistance(xs, xi);
}

References v_FindDistance().

◆ GenGeomFactors()

void Nektar::SpatialDomains::Geometry::GenGeomFactors ( )

inline

Handles generation of geometry factors.

Generate the geometric factors (i.e. derivatives of \(\chi\)) and related metrics.

See also: SpatialDomains::GeomFactors

Definition at line 693 of file Geometry.h.

{
    return v_GenGeomFactors();
}

References v_GenGeomFactors().

Referenced by GetGeomFactors().

◆ GetBoundingBox()

std::array< NekDouble, 6 > Nektar::SpatialDomains::Geometry::GetBoundingBox ( )

Generates the bounding box for the element.

For regular elements, the vertices are sufficient to define the extent of the bounding box. For non-regular elements, the extremes of the quadrature point coordinates are used. A 10% margin is added around this computed region to account for convex hull elements where the true extent of the element may extend slightly beyond the quadrature points.

Definition at line 422 of file Geometry.cpp.

{
    if (m_boundingBox.size() == 6)
    {
        return {{m_boundingBox[0], m_boundingBox[1], m_boundingBox[2],
                 m_boundingBox[3], m_boundingBox[4], m_boundingBox[5]}};
    }
    // NekDouble minx, miny, minz, maxx, maxy, maxz;
    Array<OneD, NekDouble> min(3), max(3);
 
    // Always get vertexes min/max
    PointGeomSharedPtr p = GetVertex(0);
    Array<OneD, NekDouble> x(3, 0.0);
    p->GetCoords(x[0], x[1], x[2]);
    for (int j = 0; j < 3; ++j)
    {
        min[j] = x[j];
        max[j] = x[j];
    }
    for (int i = 1; i < GetNumVerts(); ++i)
    {
        p = GetVertex(i);
        p->GetCoords(x[0], x[1], x[2]);
        for (int j = 0; j < 3; ++j)
        {
            min[j] = (x[j] < min[j] ? x[j] : min[j]);
            max[j] = (x[j] > max[j] ? x[j] : max[j]);
        }
    }
    // If element is deformed loop over quadrature points
    NekDouble marginFactor = NekConstants::kGeomFactorsTol;
    if (GetGeomFactors()->GetGtype() != eRegular)
    {
        marginFactor = 0.1;
        const int nq = GetXmap()->GetTotPoints();
        Array<OneD, Array<OneD, NekDouble>> xvec(3);
        for (int j = 0; j < 3; ++j)
        {
            xvec[j] = Array<OneD, NekDouble>(nq, 0.0);
        }
        for (int j = 0; j < GetCoordim(); ++j)
        {
            GetXmap()->BwdTrans(m_coeffs[j], xvec[j]);
        }
        for (int j = 0; j < 3; ++j)
        {
            for (int i = 0; i < nq; ++i)
            {
                min[j] = (xvec[j][i] < min[j] ? xvec[j][i] : min[j]);
                max[j] = (xvec[j][i] > max[j] ? xvec[j][i] : max[j]);
            }
        }
    }
    // Add margin to bounding box, in order to
    // return the nearest element
    for (int j = 0; j < 3; ++j)
    {
        NekDouble margin =
            marginFactor * (max[j] - min[j]) + NekConstants::kFindDistanceMin;
        min[j] -= margin;
        max[j] += margin;
    }
 
    // save bounding box
    m_boundingBox = Array<OneD, NekDouble>(6);
    for (int j = 0; j < 3; ++j)
    {
        m_boundingBox[j]     = min[j];
        m_boundingBox[j + 3] = max[j];
    }
    // Return bounding box
    return {{min[0], min[1], min[2], max[0], max[1], max[2]}};
}

References Nektar::SpatialDomains::eRegular, GetCoordim(), GetGeomFactors(), GetNumVerts(), GetVertex(), GetXmap(), Nektar::NekConstants::kFindDistanceMin, Nektar::NekConstants::kGeomFactorsTol, m_boundingBox, m_coeffs, and CellMLToNektar.cellml_metadata::p.

Referenced by MinMaxCheck().

◆ GetCoeffs()

const Array< OneD, const NekDouble > & Nektar::SpatialDomains::Geometry::GetCoeffs ( const int i ) const

inline

Return the coefficients of the transformation Geometry::m_xmap in coordinate direction i.

Definition at line 445 of file Geometry.h.

{
    return m_coeffs[i];
}

References m_coeffs.

◆ GetCoord()

NekDouble Nektar::SpatialDomains::Geometry::GetCoord	(	const int	i,
		const Array< OneD, const NekDouble > &	Lcoord
	)

inline

Given local collapsed coordinate Lcoord, return the value of physical coordinate in direction i.

Definition at line 555 of file Geometry.h.

{
    return v_GetCoord(i, Lcoord);
}

References v_GetCoord().

Referenced by Nektar::SpatialDomains::Geometry2D::v_FindDistance(), and Nektar::SpatialDomains::SegGeom::v_FindDistance().

◆ GetCoordim()

int Nektar::SpatialDomains::Geometry::GetCoordim ( ) const

inline

Return the coordinate dimension of this object (i.e. the dimension of the space in which this object is embedded).

Definition at line 284 of file Geometry.h.

{
    return m_coordim;
}

References m_coordim.

Referenced by Nektar::SpatialDomains::MeshGraph::CheckRange(), ContainsPoint(), GetBoundingBox(), and Nektar::SpatialDomains::SegGeom::v_FindDistance().

◆ GetDir()

int Nektar::SpatialDomains::Geometry::GetDir	(	const int	i,
		const int	j = `0`
	)		const

inline

Returns the element coordinate direction corresponding to a given face coordinate direction.

Definition at line 658 of file Geometry.h.

{
    return v_GetDir(faceidx, facedir);
}

References v_GetDir().

◆ GetEdge()

Geometry1DSharedPtr Nektar::SpatialDomains::Geometry::GetEdge ( int i ) const

inline

Returns edge i of this object.

Definition at line 366 of file Geometry.h.

{
    return v_GetEdge(i);
}

References v_GetEdge().

Referenced by GetEid(), Nektar::SpatialDomains::HexGeom::SetUpLocalEdges(), Nektar::SpatialDomains::PrismGeom::SetUpLocalEdges(), Nektar::SpatialDomains::PyrGeom::SetUpLocalEdges(), and Nektar::SpatialDomains::TetGeom::SetUpLocalEdges().

◆ GetEdgeFaceMap()

int Nektar::SpatialDomains::Geometry::GetEdgeFaceMap	(	int	i,
		int	j
	)		const

inline

Returns the standard element edge IDs that are connected to a given face.

For example, on a prism, edge 0 is connnected to faces 0 and 1; GetEdgeFaceMap(0,j) would therefore return the values 0 and 1 respectively. We assume that j runs between 0 and 1 inclusive, since every face is connected to precisely two faces for all 3D elements.

This function is used in the construction of the low-energy preconditioner.

Parameters

i	The edge to query connectivity for.
j	The local face index between 0 and 1 connected to this element.

See also: MultiRegions::PreconditionerLowEnergy

Definition at line 627 of file Geometry.h.

{
    return v_GetEdgeFaceMap(i, j);
}

References v_GetEdgeFaceMap().

◆ GetEdgeNormalToFaceVert()

int Nektar::SpatialDomains::Geometry::GetEdgeNormalToFaceVert	(	int	i,
		int	j
	)		const

inline

Returns the standard lement edge IDs that are normal to a given face vertex.

For example, on a hexahedron, on face 0 at vertices 0,1,2,3 the edges normal to that face are 4,5,6,7, ; so GetEdgeNormalToFaceVert(0,j) would therefore return the values 4, 5, 6 and 7 respectively. We assume that j runs between 0 and 3 inclusive on a quadrilateral face and between 0 and 2 inclusive on a triangular face.

This is used to help set up a length scale normal to an face

Parameters

i	The face to query for the normal edge
j	The local vertex index between 0 and nverts on this face

Definition at line 649 of file Geometry.h.

{
    return v_GetEdgeNormalToFaceVert(i, j);
}

References v_GetEdgeNormalToFaceVert().

◆ GetEid()

int Nektar::SpatialDomains::Geometry::GetEid ( int i ) const

Get the ID of edge i of this object.

Definition at line 143 of file Geometry.cpp.

{
    return GetEdge(i)->GetGlobalID();
}

References GetEdge().

Referenced by GetTid(), Nektar::SpatialDomains::HexGeom::SetUpLocalEdges(), Nektar::SpatialDomains::PrismGeom::SetUpLocalEdges(), Nektar::SpatialDomains::PyrGeom::SetUpLocalEdges(), and Nektar::SpatialDomains::TetGeom::SetUpLocalEdges().

◆ GetEorient()

StdRegions::Orientation Nektar::SpatialDomains::Geometry::GetEorient ( const int i ) const

inline

Returns the orientation of edge i with respect to the ordering of edges in the standard element.

Definition at line 383 of file Geometry.h.

{
    return v_GetEorient(i);
}

References v_GetEorient().

◆ GetFace()

Geometry2DSharedPtr Nektar::SpatialDomains::Geometry::GetFace ( int i ) const

inline

Returns face i of this object.

Definition at line 374 of file Geometry.h.

{
    return v_GetFace(i);
}

References v_GetFace().

Referenced by GetFid().

◆ GetFid()

int Nektar::SpatialDomains::Geometry::GetFid ( int i ) const

Get the ID of face i of this object.

Definition at line 151 of file Geometry.cpp.

{
    return GetFace(i)->GetGlobalID();
}

References GetFace().

Referenced by GetTid().

◆ GetForient()

StdRegions::Orientation Nektar::SpatialDomains::Geometry::GetForient ( const int i ) const

inline

Returns the orientation of face i with respect to the ordering of faces in the standard element.

Definition at line 392 of file Geometry.h.

{
    return v_GetForient(i);
}

References v_GetForient().

◆ GetGeomFactors()

GeomFactorsSharedPtr Nektar::SpatialDomains::Geometry::GetGeomFactors ( )

inline

Get the geometric factors for this object, generating them if required.

Definition at line 302 of file Geometry.h.

{
    GenGeomFactors();
    return ValidateRegGeomFactor(m_geomFactors);
}

References GenGeomFactors(), m_geomFactors, and ValidateRegGeomFactor().

Referenced by GetBoundingBox().

◆ GetGlobalID()

int Nektar::SpatialDomains::Geometry::GetGlobalID ( void ) const

inline

Get the ID of this object.

Definition at line 327 of file Geometry.h.

{
    return m_globalID;
}

References m_globalID.

◆ GetLocCoords()

NekDouble Nektar::SpatialDomains::Geometry::GetLocCoords	(	const Array< OneD, const NekDouble > &	coords,
		Array< OneD, NekDouble > &	Lcoords
	)

inline

Determine the local collapsed coordinates that correspond to a given Cartesian coordinate for this geometry object.

For curvilinear and non-affine elements (i.e. where the Jacobian varies as a function of the standard element coordinates), this is a non-linear optimisation problem that requires the use of a Newton iteration. Note therefore that this can be an expensive operation.

Note that, clearly, the provided Cartesian coordinate lie outside the element. The function therefore returns the minimum distance from some position in the element to . Lcoords will also be constrained to fit within the range \([-1,1]^d\) where \( d \) is the dimension of the element.

Parameters

coords	Input Cartesian global coordinates
Lcoords	Corresponding local coordinates

Returns: Distance between obtained coordinates and provided ones.

Definition at line 545 of file Geometry.h.

{
    return v_GetLocCoords(coords, Lcoords);
}

References v_GetLocCoords().

Referenced by v_ContainsPoint(), Nektar::SpatialDomains::Geometry2D::v_FindDistance(), and Nektar::SpatialDomains::SegGeom::v_FindDistance().

◆ GetMetricInfo()

GeomFactorsSharedPtr Nektar::SpatialDomains::Geometry::GetMetricInfo ( )

inline

Get the geometric factors for this object.

Definition at line 311 of file Geometry.h.

{
    return m_geomFactors;
}

References m_geomFactors.

Referenced by PreliminaryCheck(), v_ContainsPoint(), Nektar::SpatialDomains::Geometry1D::v_GetLocCoords(), Nektar::SpatialDomains::Geometry2D::v_GetLocCoords(), and Nektar::SpatialDomains::Geometry3D::v_GetLocCoords().

◆ GetNumEdges()

int Nektar::SpatialDomains::Geometry::GetNumEdges ( ) const

inline

Get the number of edges of this object.

Definition at line 408 of file Geometry.h.

{
    return v_GetNumEdges();
}

References v_GetNumEdges().

◆ GetNumFaces()

int Nektar::SpatialDomains::Geometry::GetNumFaces ( ) const

inline

Get the number of faces of this object.

Definition at line 416 of file Geometry.h.

{
    return v_GetNumFaces();
}

References v_GetNumFaces().

◆ GetNumVerts()

int Nektar::SpatialDomains::Geometry::GetNumVerts ( ) const

inline

Get the number of vertices of this object.

Definition at line 400 of file Geometry.h.

{
    return v_GetNumVerts();
}

References v_GetNumVerts().

Referenced by Nektar::SpatialDomains::MeshGraph::CheckRange(), and GetBoundingBox().

◆ GetRefGeomFactors()

GeomFactorsSharedPtr Nektar::SpatialDomains::Geometry::GetRefGeomFactors ( const Array< OneD, const LibUtilities::BasisSharedPtr > & tbasis )

◆ GetShapeDim()

int Nektar::SpatialDomains::Geometry::GetShapeDim ( ) const

inline

Get the object's shape dimension.

For example, a segment is one dimensional and quadrilateral is two dimensional.

Definition at line 427 of file Geometry.h.

{
    return v_GetShapeDim();
}

References v_GetShapeDim().

Referenced by ClampLocCoords(), GetTid(), and v_ContainsPoint().

◆ GetShapeType()

LibUtilities::ShapeType Nektar::SpatialDomains::Geometry::GetShapeType ( void )

inline

Get the geometric shape type of this object.

Definition at line 319 of file Geometry.h.

{
    return m_shapeType;
}

References m_shapeType.

Referenced by Nektar::SpatialDomains::MeshGraph::CheckRange().

◆ GetTid()

int Nektar::SpatialDomains::Geometry::GetTid ( int i ) const

inline

Get the ID of trace i of this object.

The trace element is the facet one dimension lower than the object; for example, a quadrilateral has four trace segments forming its boundary.

Definition at line 346 of file Geometry.h.

{
    const int nDim = GetShapeDim();
    return nDim == 1   ? GetVid(i)
           : nDim == 2 ? GetEid(i)
           : nDim == 3 ? GetFid(i)
                       : 0;
}

References GetEid(), GetFid(), GetShapeDim(), and GetVid().

◆ GetVertex()

PointGeomSharedPtr Nektar::SpatialDomains::Geometry::GetVertex ( int i ) const

inline

Returns vertex i of this object.

Definition at line 358 of file Geometry.h.

{
    return v_GetVertex(i);
}

References v_GetVertex().

◆ GetVertexEdgeMap()

int Nektar::SpatialDomains::Geometry::GetVertexEdgeMap	(	int	i,
		int	j
	)		const

inline

Returns the standard element edge IDs that are connected to a given vertex.

For example, on a prism, vertex 0 is connnected to edges 0, 3, and 4; GetVertexEdgeMap(0,j) would therefore return the values 0, 1 and 4 respectively. We assume that j runs between 0 and 2 inclusive, which is true for every 3D element asides from the pyramid.

This function is used in the construction of the low-energy preconditioner.

Parameters

i	The vertex to query connectivity for.
j	The local edge index between 0 and 2 connected to this element.

Todo:: Expand to work with pyramid elements.

See also: MultiRegions::PreconditionerLowEnergy

Definition at line 584 of file Geometry.h.

{
    return v_GetVertexEdgeMap(i, j);
}

References v_GetVertexEdgeMap().

◆ GetVertexFaceMap()

int Nektar::SpatialDomains::Geometry::GetVertexFaceMap	(	int	i,
		int	j
	)		const

inline

Returns the standard element face IDs that are connected to a given vertex.

For example, on a hexahedron, vertex 0 is connnected to faces 0, 1, and 4; GetVertexFaceMap(0,j) would therefore return the values 0, 1 and 4 respectively. We assume that j runs between 0 and 2 inclusive, which is true for every 3D element asides from the pyramid.

This is used in the construction of the low-energy preconditioner.

Parameters

i	The vertex to query connectivity for.
j	The local face index between 0 and 2 connected to this element.

Todo:: Expand to work with pyramid elements.

See also: MultiRegions::PreconditionerLowEnergy

Definition at line 606 of file Geometry.h.

{
    return v_GetVertexFaceMap(i, j);
}

References v_GetVertexFaceMap().

◆ GetVid()

int Nektar::SpatialDomains::Geometry::GetVid ( int i ) const

Get the ID of vertex i of this object.

Definition at line 135 of file Geometry.cpp.

{
    return GetVertex(i)->GetGlobalID();
}

References GetVertex().

◆ GetXmap()

StdRegions::StdExpansionSharedPtr Nektar::SpatialDomains::Geometry::GetXmap ( ) const

inline

Return the mapping object Geometry::m_xmap that represents the coordinate transformation from standard element to physical element.

Definition at line 436 of file Geometry.h.

{
    return v_GetXmap();
}

References v_GetXmap().

◆ MinMaxCheck()

bool Nektar::SpatialDomains::Geometry::MinMaxCheck ( const Array< OneD, const NekDouble > & gloCoord )

Check if given global coord is within the BoundingBox of the element.

Parameters

coords Input Cartesian global coordinates

Returns: True if within distance or False otherwise.

Definition at line 538 of file Geometry.cpp.

{
    // Validation checks
    ASSERTL1(gloCoord.size() >= m_coordim,
             "Expects number of global coordinates supplied to be greater than "
             "or equal to the mesh dimension.");
 
    std::array<NekDouble, 6> minMax = GetBoundingBox();
    for (int i = 0; i < m_coordim; ++i)
    {
        if ((gloCoord[i] < minMax[i]) || (gloCoord[i] > minMax[i + 3]))
        {
            return false;
        }
    }
    return true;
}

References ASSERTL1, GetBoundingBox(), and m_coordim.

Referenced by PreliminaryCheck().

◆ PreliminaryCheck()

int Nektar::SpatialDomains::Geometry::PreliminaryCheck ( const Array< OneD, const NekDouble > & gloCoord )

A fast and robust check if a given global coord is outside of a deformed element. For regular elements, this check is unnecessary.

Parameters

coords Input Cartesian global coordinates

Returns: 1 is inside of the element. 0 maybe inside -1 outside of the element

Definition at line 512 of file Geometry.cpp.

{
    // bounding box check
    if (!MinMaxCheck(gloCoord))
    {
        return -1;
    }
 
    // regular element check
    if (GetMetricInfo()->GetGtype() == eRegular)
    {
        return 0;
    }
 
    // All left check for straight edges/plane surfaces
    return v_AllLeftCheck(gloCoord);
}

References Nektar::SpatialDomains::eRegular, GetMetricInfo(), MinMaxCheck(), and v_AllLeftCheck().

Referenced by v_ContainsPoint().

◆ Reset()

void Nektar::SpatialDomains::Geometry::Reset	(	CurveMap &	curvedEdges,
		CurveMap &	curvedFaces
	)

inline

Reset this geometry object: unset the current state, zero Geometry::m_coeffs and remove allocated GeomFactors.

Definition at line 667 of file Geometry.h.

{
    v_Reset(curvedEdges, curvedFaces);
}

References v_Reset().

◆ ResetNonRecursive()

void Nektar::SpatialDomains::Geometry::ResetNonRecursive	(	CurveMap &	curvedEdges,
		CurveMap &	curvedFaces
	)

inline

Reset this geometry object non-recursively: unset the current state, zero Geometry::m_coeffs and remove allocated GeomFactors.

Definition at line 676 of file Geometry.h.

{
    Geometry::v_Reset(curvedEdges, curvedFaces);
}

References v_Reset().

◆ SetCoordim()

void Nektar::SpatialDomains::Geometry::SetCoordim ( int coordim )

inline

Sets the coordinate dimension of this object (i.e. the dimension of the space in which this object is embedded).

Definition at line 293 of file Geometry.h.

{
    m_coordim = dim;
}

References m_coordim.

◆ SetGlobalID()

void Nektar::SpatialDomains::Geometry::SetGlobalID ( int globalid )

inline

Set the ID of this object.

Definition at line 335 of file Geometry.h.

{
    m_globalID = globalid;
}

References m_globalID.

◆ Setup()

void Nektar::SpatialDomains::Geometry::Setup ( )

inline

Definition at line 682 of file Geometry.h.

{
    v_Setup();
}

References v_Setup().

◆ SetUpCoeffs()

void Nektar::SpatialDomains::Geometry::SetUpCoeffs ( const int nCoeffs )

inlineprotected

Initialise the Geometry::m_coeffs array.

Definition at line 701 of file Geometry.h.

{
    m_coeffs = Array<OneD, Array<OneD, NekDouble>>(m_coordim);
 
    for (int i = 0; i < m_coordim; ++i)
    {
        m_coeffs[i] = Array<OneD, NekDouble>(nCoeffs, 0.0);
    }
}

References m_coeffs, and m_coordim.

◆ v_AllLeftCheck()

int Nektar::SpatialDomains::Geometry::v_AllLeftCheck ( const Array< OneD, const NekDouble > & gloCoord )

protectedvirtual

Reimplemented in Nektar::SpatialDomains::Geometry2D, and Nektar::SpatialDomains::Geometry3D.

Definition at line 234 of file Geometry.cpp.

{
    return 0;
}

Referenced by PreliminaryCheck().

◆ v_CalculateInverseIsoParam()

void Nektar::SpatialDomains::Geometry::v_CalculateInverseIsoParam ( )

protectedvirtual

Reimplemented in Nektar::SpatialDomains::Geometry2D, and Nektar::SpatialDomains::Geometry3D.

Definition at line 240 of file Geometry.cpp.

{
    NEKERROR(ErrorUtil::efatal,
             "This function is only valid for shape type geometries");
}

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

◆ v_ContainsPoint()

bool Nektar::SpatialDomains::Geometry::v_ContainsPoint	(	const Array< OneD, const NekDouble > &	gloCoord,
		Array< OneD, NekDouble > &	locCoord,
		NekDouble	tol,
		NekDouble &	dist
	)

protectedvirtual

Determine whether an element contains a particular Cartesian coordinate \(\vec{x} = (x,y,z)\).

For curvilinear and non-affine elements (i.e. where the Jacobian varies as a function of the standard element coordinates), this is a non-linear optimisation problem that requires the use of a Newton iteration. Note therefore that this can be an expensive operation.

The parameter tol which is by default 0, can be used to expand the coordinate range of the standard element from \([-1,1]^d\) to \([-1-\epsilon,1+\epsilon\) to handle challenging edge cases. The function also returns the local coordinates corresponding to gloCoord that can be used to speed up subsequent searches.

Parameters

gloCoord	The coordinate \( (x,y,z) \).
locCoord	On exit, this is the local coordinate \(\vec{\xi}\) such that \(\chi(\vec{\xi}) = \vec{x}\).
tol	The tolerance used to dictate the bounding box of the standard coordinates \(\vec{\xi}\).
dist	On exit, returns the minimum distance between `gloCoord` and the quadrature points inside the element.

Returns: true if the coordinate gloCoord is contained in the element; false otherwise.

See also: Geometry::GetLocCoords. dist is assigned value for curved elements

Reimplemented in Nektar::SpatialDomains::Geometry0D.

Definition at line 260 of file Geometry.cpp.

{
    int inside = PreliminaryCheck(gloCoord);
    if (inside == -1)
    {
        dist = std::numeric_limits<double>::max();
        return false;
    }
    dist = GetLocCoords(gloCoord, locCoord);
    if (inside == 1)
    {
        dist = 0.;
        return true;
    }
    else
    {
        Array<OneD, NekDouble> eta(GetShapeDim(), 0.);
        m_xmap->LocCoordToLocCollapsed(locCoord, eta);
        if (ClampLocCoords(eta, tol))
        {
            if (GetMetricInfo()->GetGtype() == eRegular)
            {
                dist = std::numeric_limits<double>::max();
            }
            return false;
        }
        return 3 != m_coordim ||
               (LibUtilities::eTriangle != m_shapeType &&
                LibUtilities::eQuadrilateral != m_shapeType) ||
               dist <= tol;
    }
}

References ClampLocCoords(), Nektar::LibUtilities::eQuadrilateral, Nektar::SpatialDomains::eRegular, Nektar::LibUtilities::eTriangle, GetLocCoords(), GetMetricInfo(), GetShapeDim(), m_coordim, m_shapeType, m_xmap, and PreliminaryCheck().

Referenced by ContainsPoint().

◆ v_FillGeom()

void Nektar::SpatialDomains::Geometry::v_FillGeom ( )

protectedvirtual

Populate the coordinate mapping Geometry::m_coeffs information from any children geometry elements.

See also: v_FillGeom()

Reimplemented in Nektar::SpatialDomains::Geometry3D, Nektar::SpatialDomains::QuadGeom, Nektar::SpatialDomains::SegGeom, and Nektar::SpatialDomains::TriGeom.

Definition at line 386 of file Geometry.cpp.

{
    NEKERROR(ErrorUtil::efatal,
             "This function is only valid for expansion type geometries");
}

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

Referenced by FillGeom(), Nektar::SpatialDomains::Geometry1D::v_GetLocCoords(), and Nektar::SpatialDomains::Geometry2D::v_GetLocCoords().

◆ v_FindDistance()

NekDouble Nektar::SpatialDomains::Geometry::v_FindDistance	(	const Array< OneD, const NekDouble > &	xs,
		Array< OneD, NekDouble > &	xi
	)

protectedvirtual

Reimplemented in Nektar::SpatialDomains::Geometry2D, and Nektar::SpatialDomains::SegGeom.

Definition at line 295 of file Geometry.cpp.

{
    NEKERROR(ErrorUtil::efatal,
             "This function has not been defined for this geometry");
    return false;
}

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

Referenced by FindDistance().

◆ v_GenGeomFactors()

virtual void Nektar::SpatialDomains::Geometry::v_GenGeomFactors ( )

protectedpure virtual

Implemented in Nektar::SpatialDomains::HexGeom, Nektar::SpatialDomains::PointGeom, Nektar::SpatialDomains::PrismGeom, Nektar::SpatialDomains::PyrGeom, Nektar::SpatialDomains::QuadGeom, Nektar::SpatialDomains::SegGeom, Nektar::SpatialDomains::TetGeom, and Nektar::SpatialDomains::TriGeom.

Referenced by GenGeomFactors().

◆ v_GetCoord()

NekDouble Nektar::SpatialDomains::Geometry::v_GetCoord	(	const int	i,
		const Array< OneD, const NekDouble > &	Lcoord
	)

protectedvirtual

Given local collapsed coordinate Lcoord, return the value of physical coordinate in direction i.

Reimplemented in Nektar::SpatialDomains::Geometry3D, Nektar::SpatialDomains::QuadGeom, Nektar::SpatialDomains::SegGeom, and Nektar::SpatialDomains::TriGeom.

Definition at line 362 of file Geometry.cpp.

{
    NEKERROR(ErrorUtil::efatal,
             "This function is only valid for expansion type geometries");
    return 0.0;
}

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

Referenced by GetCoord().

◆ v_GetDir()

int Nektar::SpatialDomains::Geometry::v_GetDir	(	const int	i,
		const int	j
	)		const

protectedvirtual

Returns the element coordinate direction corresponding to a given face coordinate direction.

Reimplemented in Nektar::SpatialDomains::HexGeom, Nektar::SpatialDomains::PrismGeom, Nektar::SpatialDomains::PyrGeom, Nektar::SpatialDomains::QuadGeom, Nektar::SpatialDomains::TetGeom, and Nektar::SpatialDomains::TriGeom.

Definition at line 351 of file Geometry.cpp.

{
    NEKERROR(ErrorUtil::efatal,
             "This function has not been defined for this geometry");
    return 0;
}

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

Referenced by GetDir().

◆ v_GetEdge()

Geometry1DSharedPtr Nektar::SpatialDomains::Geometry::v_GetEdge ( int i ) const

protectedvirtual

Returns edge i of this object.

Reimplemented in Nektar::SpatialDomains::Geometry2D, and Nektar::SpatialDomains::Geometry3D.

Definition at line 159 of file Geometry.cpp.

{
    NEKERROR(ErrorUtil::efatal,
             "This function is only valid for shape type geometries");
    return Geometry1DSharedPtr();
}

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

Referenced by GetEdge().

◆ v_GetEdgeFaceMap()

int Nektar::SpatialDomains::Geometry::v_GetEdgeFaceMap	(	int	i,
		int	j
	)		const

protectedvirtual

Returns the standard element edge IDs that are connected to a given face.

For example, on a prism, edge 0 is connnected to faces 0 and 1; GetEdgeFaceMap(0,j) would therefore return the values 0 and 1 respectively. We assume that j runs between 0 and 1 inclusive, since every face is connected to precisely two faces for all 3D elements.

This function is used in the construction of the low-energy preconditioner.

Parameters

i	The edge to query connectivity for.
j	The local face index between 0 and 1 connected to this element.

See also: MultiRegions::PreconditionerLowEnergy

Reimplemented in Nektar::SpatialDomains::HexGeom, Nektar::SpatialDomains::PrismGeom, and Nektar::SpatialDomains::TetGeom.

Definition at line 329 of file Geometry.cpp.

{
    NEKERROR(ErrorUtil::efatal,
             "This function has not been defined for this geometry");
    return 0;
}

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

Referenced by GetEdgeFaceMap().

◆ v_GetEdgeNormalToFaceVert()

int Nektar::SpatialDomains::Geometry::v_GetEdgeNormalToFaceVert	(	const int	i,
		const int	j
	)		const

protectedvirtual

Returns the standard lement edge IDs that are normal to a given face vertex.

For example, on a hexahedron, on face 0 at vertices 0,1,2,3 the edges normal to that face are 4,5,6,7, ; so GetEdgeNormalToFaceVert(0,j) would therefore return the values 4, 5, 6 and 7 respectively. We assume that j runs between 0 and 3 inclusive on a quadrilateral face and between 0 and 2 inclusive on a triangular face.

This is used to help set up a length scale normal to an face

Parameters

i	The face to query for the normal edge
j	The local vertex index between 0 and nverts on this face

Reimplemented in Nektar::SpatialDomains::HexGeom, Nektar::SpatialDomains::PrismGeom, Nektar::SpatialDomains::PyrGeom, and Nektar::SpatialDomains::TetGeom.

Definition at line 340 of file Geometry.cpp.

{
    NEKERROR(ErrorUtil::efatal,
             "This function has not been defined for this geometry");
    return 0;
}

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

Referenced by GetEdgeNormalToFaceVert().

◆ v_GetEorient()

StdRegions::Orientation Nektar::SpatialDomains::Geometry::v_GetEorient ( const int i ) const

protectedvirtual

Returns the orientation of edge i with respect to the ordering of edges in the standard element.

Reimplemented in Nektar::SpatialDomains::Geometry2D, and Nektar::SpatialDomains::Geometry3D.

Definition at line 189 of file Geometry.cpp.

{
    NEKERROR(ErrorUtil::efatal,
             "This function is not valid for this geometry.");
    return StdRegions::eForwards;
}

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

Referenced by GetEorient().

◆ v_GetFace()

Geometry2DSharedPtr Nektar::SpatialDomains::Geometry::v_GetFace ( int i ) const

protectedvirtual

Returns face i of this object.

Reimplemented in Nektar::SpatialDomains::Geometry3D.

Definition at line 169 of file Geometry.cpp.

{
    NEKERROR(ErrorUtil::efatal,
             "This function is only valid for shape type geometries");
    return Geometry2DSharedPtr();
}

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

Referenced by GetFace().

◆ v_GetForient()

StdRegions::Orientation Nektar::SpatialDomains::Geometry::v_GetForient ( const int i ) const

protectedvirtual

Returns the orientation of face i with respect to the ordering of faces in the standard element.

Reimplemented in Nektar::SpatialDomains::Geometry3D.

Definition at line 200 of file Geometry.cpp.

{
    NEKERROR(ErrorUtil::efatal,
             "This function is not valid for this geometry.");
    return StdRegions::eFwd;
}

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

Referenced by GetForient().

◆ v_GetLocCoords()

NekDouble Nektar::SpatialDomains::Geometry::v_GetLocCoords	(	const Array< OneD, const NekDouble > &	coords,
		Array< OneD, NekDouble > &	Lcoords
	)

protectedvirtual

Determine the local collapsed coordinates that correspond to a given Cartesian coordinate for this geometry object.

For curvilinear and non-affine elements (i.e. where the Jacobian varies as a function of the standard element coordinates), this is a non-linear optimisation problem that requires the use of a Newton iteration. Note therefore that this can be an expensive operation.

Note that, clearly, the provided Cartesian coordinate lie outside the element. The function therefore returns the minimum distance from some position in the element to . Lcoords will also be constrained to fit within the range \([-1,1]^d\) where \( d \) is the dimension of the element.

Parameters

coords	Input Cartesian global coordinates
Lcoords	Corresponding local coordinates

Returns: Distance between obtained coordinates and provided ones.

Reimplemented in Nektar::SpatialDomains::Geometry1D, Nektar::SpatialDomains::Geometry2D, and Nektar::SpatialDomains::Geometry3D.

Definition at line 374 of file Geometry.cpp.

{
    NEKERROR(ErrorUtil::efatal,
             "This function is only valid for expansion type geometries");
    return 0.0;
}

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

Referenced by GetLocCoords().

◆ v_GetNumEdges()

int Nektar::SpatialDomains::Geometry::v_GetNumEdges ( ) const

protectedvirtual

Get the number of edges of this object.

Reimplemented in Nektar::SpatialDomains::Geometry2D, and Nektar::SpatialDomains::Geometry3D.

Definition at line 211 of file Geometry.cpp.

{
    return 0;
}

Referenced by GetNumEdges().

◆ v_GetNumFaces()

int Nektar::SpatialDomains::Geometry::v_GetNumFaces ( ) const

protectedvirtual

Get the number of faces of this object.

Reimplemented in Nektar::SpatialDomains::Geometry3D.

Definition at line 219 of file Geometry.cpp.

{
    return 0;
}

Referenced by GetNumFaces().

◆ v_GetNumVerts()

int Nektar::SpatialDomains::Geometry::v_GetNumVerts ( ) const

protectedvirtual

Get the number of vertices of this object.

Reimplemented in Nektar::SpatialDomains::Geometry2D, Nektar::SpatialDomains::Geometry3D, and Nektar::SpatialDomains::SegGeom.

Definition at line 179 of file Geometry.cpp.

{
    NEKERROR(ErrorUtil::efatal,
             "This function is only valid for shape type geometries");
    return 0;
}

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

Referenced by GetNumVerts().

◆ v_GetShapeDim()

int Nektar::SpatialDomains::Geometry::v_GetShapeDim ( ) const

protectedvirtual

Get the object's shape dimension.

For example, a segment is one dimensional and quadrilateral is two dimensional.

Reimplemented in Nektar::SpatialDomains::Geometry0D, Nektar::SpatialDomains::Geometry1D, Nektar::SpatialDomains::Geometry2D, and Nektar::SpatialDomains::Geometry3D.

Definition at line 227 of file Geometry.cpp.

{
    NEKERROR(ErrorUtil::efatal,
             "This function is only valid for shape type geometries");
    return 0;
}

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

Referenced by GetShapeDim().

◆ v_GetVertex()

virtual PointGeomSharedPtr Nektar::SpatialDomains::Geometry::v_GetVertex ( int i ) const

protectedpure virtual

Implemented in Nektar::SpatialDomains::SegGeom, Nektar::SpatialDomains::Geometry2D, Nektar::SpatialDomains::Geometry3D, and Nektar::SpatialDomains::PointGeom.

Referenced by GetVertex().

◆ v_GetVertexEdgeMap()

int Nektar::SpatialDomains::Geometry::v_GetVertexEdgeMap	(	int	i,
		int	j
	)		const

protectedvirtual

Returns the standard element edge IDs that are connected to a given vertex.

For example, on a prism, vertex 0 is connnected to edges 0, 3, and 4; GetVertexEdgeMap(0,j) would therefore return the values 0, 1 and 4 respectively. We assume that j runs between 0 and 2 inclusive, which is true for every 3D element asides from the pyramid.

This function is used in the construction of the low-energy preconditioner.

Parameters

i	The vertex to query connectivity for.
j	The local edge index between 0 and 2 connected to this element.

Todo:: Expand to work with pyramid elements.

See also: MultiRegions::PreconditionerLowEnergy

Reimplemented in Nektar::SpatialDomains::HexGeom, Nektar::SpatialDomains::PrismGeom, and Nektar::SpatialDomains::TetGeom.

Definition at line 307 of file Geometry.cpp.

{
    NEKERROR(ErrorUtil::efatal,
             "This function has not been defined for this geometry");
    return 0;
}

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

Referenced by GetVertexEdgeMap().

◆ v_GetVertexFaceMap()

int Nektar::SpatialDomains::Geometry::v_GetVertexFaceMap	(	int	i,
		int	j
	)		const

protectedvirtual

Returns the standard element face IDs that are connected to a given vertex.

For example, on a hexahedron, vertex 0 is connnected to faces 0, 1, and 4; GetVertexFaceMap(0,j) would therefore return the values 0, 1 and 4 respectively. We assume that j runs between 0 and 2 inclusive, which is true for every 3D element asides from the pyramid.

This is used in the construction of the low-energy preconditioner.

Parameters

i	The vertex to query connectivity for.
j	The local face index between 0 and 2 connected to this element.

Todo:: Expand to work with pyramid elements.

See also: MultiRegions::PreconditionerLowEnergy

Reimplemented in Nektar::SpatialDomains::HexGeom, Nektar::SpatialDomains::PrismGeom, and Nektar::SpatialDomains::TetGeom.

Definition at line 318 of file Geometry.cpp.

{
    NEKERROR(ErrorUtil::efatal,
             "This function has not been defined for this geometry");
    return 0;
}

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

Referenced by GetVertexFaceMap().

◆ v_GetXmap()

StdRegions::StdExpansionSharedPtr Nektar::SpatialDomains::Geometry::v_GetXmap ( ) const

protectedvirtual

Return the mapping object Geometry::m_xmap that represents the coordinate transformation from standard element to physical element.

Definition at line 249 of file Geometry.cpp.

{
    return m_xmap;
}

References m_xmap.

Referenced by GetXmap().

◆ v_Reset()

void Nektar::SpatialDomains::Geometry::v_Reset	(	CurveMap &	curvedEdges,
		CurveMap &	curvedFaces
	)

protectedvirtual

Reset this geometry object: unset the current state, zero Geometry::m_coeffs and remove allocated GeomFactors.

Reimplemented in Nektar::SpatialDomains::HexGeom, Nektar::SpatialDomains::PrismGeom, Nektar::SpatialDomains::PyrGeom, Nektar::SpatialDomains::QuadGeom, Nektar::SpatialDomains::SegGeom, Nektar::SpatialDomains::TetGeom, and Nektar::SpatialDomains::TriGeom.

Definition at line 395 of file Geometry.cpp.

{
 
    // Reset state
    m_state            = eNotFilled;
    m_geomFactorsState = eNotFilled;
 
    // Junk geometric factors
    m_geomFactors = GeomFactorsSharedPtr();
}

References Nektar::SpatialDomains::eNotFilled, m_geomFactors, m_geomFactorsState, and m_state.

Referenced by Reset(), ResetNonRecursive(), Nektar::SpatialDomains::HexGeom::v_Reset(), Nektar::SpatialDomains::PrismGeom::v_Reset(), Nektar::SpatialDomains::PyrGeom::v_Reset(), Nektar::SpatialDomains::QuadGeom::v_Reset(), Nektar::SpatialDomains::SegGeom::v_Reset(), Nektar::SpatialDomains::TetGeom::v_Reset(), and Nektar::SpatialDomains::TriGeom::v_Reset().

◆ v_Setup()

void Nektar::SpatialDomains::Geometry::v_Setup ( )

protectedvirtual

Reimplemented in Nektar::SpatialDomains::HexGeom, Nektar::SpatialDomains::PrismGeom, Nektar::SpatialDomains::PyrGeom, Nektar::SpatialDomains::QuadGeom, Nektar::SpatialDomains::SegGeom, Nektar::SpatialDomains::TetGeom, and Nektar::SpatialDomains::TriGeom.

Definition at line 407 of file Geometry.cpp.

{
    NEKERROR(ErrorUtil::efatal,
             "This function is only valid for expansion type geometries");
}

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

Referenced by Setup().

◆ ValidateRegGeomFactor()

GeomFactorsSharedPtr Nektar::SpatialDomains::Geometry::ValidateRegGeomFactor ( GeomFactorsSharedPtr geomFactor )

staticprotected

Check to see if a geometric factor has already been created that contains the same regular information.

The principle behind this is that many regular (i.e. constant Jacobian) elements have identicial geometric factors. Memory may therefore be reduced by storing only the unique factors.

Parameters

geomFactor The GeomFactor to check.

Returns: Either the cached GeomFactor or geomFactor.

Todo:: Currently this method is disabled since the lookup is very expensive.

Todo:: should this '#if 0' statement be removed?

Definition at line 88 of file Geometry.cpp.

{
    GeomFactorsSharedPtr returnval = geomFactor;
 
/// \todo should this '#if 0' statement be removed?
#if 0
    bool found = false;
    if (geomFactor->GetGtype() == eRegular)
    {
        for (GeomFactorsVectorIter iter = m_regGeomFactorsManager.begin();
             iter != m_regGeomFactorsManager.end();
             ++iter)
        {
            if (**iter == *geomFactor)
            {
                returnval = *iter;
                found = true;
                break;
            }
        }
 
        if (!found)
        {
            m_regGeomFactorsManager.push_back(geomFactor);
            returnval = geomFactor;
        }
    }
#endif
    return returnval;
}

References Nektar::SpatialDomains::eRegular, and m_regGeomFactorsManager.

Referenced by GetGeomFactors().

Member Data Documentation

◆ m_boundingBox

Array<OneD, NekDouble> Nektar::SpatialDomains::Geometry::m_boundingBox

protected

Array containing bounding box.

Definition at line 209 of file Geometry.h.

Referenced by ClearBoundingBox(), and GetBoundingBox().

◆ m_coeffs

Array<OneD, Array<OneD, NekDouble> > Nektar::SpatialDomains::Geometry::m_coeffs

protected

Array containing expansion coefficients of m_xmap.

Definition at line 207 of file Geometry.h.

◆ m_coordim

int Nektar::SpatialDomains::Geometry::m_coordim

protected

Coordinate dimension of this geometry object.

Definition at line 189 of file Geometry.h.

◆ m_geomFactors

GeomFactorsSharedPtr Nektar::SpatialDomains::Geometry::m_geomFactors

protected

Geometric factors.

Definition at line 191 of file Geometry.h.

◆ m_geomFactorsState

GeomState Nektar::SpatialDomains::Geometry::m_geomFactorsState

protected

State of the geometric factors.

Definition at line 193 of file Geometry.h.

Referenced by Nektar::SpatialDomains::HexGeom::v_GenGeomFactors(), Nektar::SpatialDomains::PrismGeom::v_GenGeomFactors(), Nektar::SpatialDomains::PyrGeom::v_GenGeomFactors(), Nektar::SpatialDomains::QuadGeom::v_GenGeomFactors(), Nektar::SpatialDomains::SegGeom::v_GenGeomFactors(), Nektar::SpatialDomains::TetGeom::v_GenGeomFactors(), Nektar::SpatialDomains::TriGeom::v_GenGeomFactors(), and v_Reset().

◆ m_geomType

GeomType Nektar::SpatialDomains::Geometry::m_geomType

protected

Type of geometry.

Definition at line 201 of file Geometry.h.

◆ m_globalID

int Nektar::SpatialDomains::Geometry::m_globalID

protected

Global ID.

Definition at line 205 of file Geometry.h.

◆ m_invIsoParam

Array<OneD, Array<OneD, NekDouble> > Nektar::SpatialDomains::Geometry::m_invIsoParam

protected

Definition at line 211 of file Geometry.h.

Referenced by Nektar::SpatialDomains::Geometry2D::v_CalculateInverseIsoParam(), Nektar::SpatialDomains::Geometry3D::v_CalculateInverseIsoParam(), Nektar::SpatialDomains::Geometry2D::v_GetLocCoords(), and Nektar::SpatialDomains::Geometry3D::v_GetLocCoords().

◆ m_isoParameter

Array<OneD, Array<OneD, NekDouble> > Nektar::SpatialDomains::Geometry::m_isoParameter

protected

Definition at line 210 of file Geometry.h.

◆ m_regGeomFactorsManager

GeomFactorsVector Nektar::SpatialDomains::Geometry::m_regGeomFactorsManager

staticprotected

Definition at line 186 of file Geometry.h.

Referenced by ValidateRegGeomFactor().

◆ m_setupState

bool Nektar::SpatialDomains::Geometry::m_setupState

protected

Wether or not the setup routines have been run.

Definition at line 199 of file Geometry.h.

◆ m_shapeType

LibUtilities::ShapeType Nektar::SpatialDomains::Geometry::m_shapeType

protected

Type of shape.

Definition at line 203 of file Geometry.h.

Referenced by GetShapeType(), Nektar::SpatialDomains::HexGeom::HexGeom(), Nektar::SpatialDomains::PointGeom::PointGeom(), Nektar::SpatialDomains::PrismGeom::PrismGeom(), Nektar::SpatialDomains::PyrGeom::PyrGeom(), Nektar::SpatialDomains::QuadGeom::QuadGeom(), Nektar::SpatialDomains::SegGeom::SegGeom(), Nektar::SpatialDomains::TetGeom::TetGeom(), Nektar::SpatialDomains::TriGeom::TriGeom(), and v_ContainsPoint().

◆ m_state

GeomState Nektar::SpatialDomains::Geometry::m_state

protected

Enumeration to dictate whether coefficients are filled.

Definition at line 197 of file Geometry.h.

Referenced by Nektar::SpatialDomains::SegGeom::SegGeom(), Nektar::SpatialDomains::Geometry3D::v_FillGeom(), Nektar::SpatialDomains::QuadGeom::v_FillGeom(), Nektar::SpatialDomains::SegGeom::v_FillGeom(), Nektar::SpatialDomains::TriGeom::v_FillGeom(), Nektar::SpatialDomains::Geometry3D::v_GetCoord(), Nektar::SpatialDomains::QuadGeom::v_GetCoord(), Nektar::SpatialDomains::SegGeom::v_GetCoord(), Nektar::SpatialDomains::TriGeom::v_GetCoord(), and v_Reset().

◆ m_straightEdge

int Nektar::SpatialDomains::Geometry::m_straightEdge

protected

Definition at line 212 of file Geometry.h.

◆ m_xmap

StdRegions::StdExpansionSharedPtr Nektar::SpatialDomains::Geometry::m_xmap

protected

\(\chi\) mapping containing isoparametric transformation.

Definition at line 195 of file Geometry.h.

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Geometry() [1/2]

◆ Geometry() [2/2]

◆ ~Geometry()

Member Function Documentation

◆ ClampLocCoords()

◆ ClearBoundingBox()

◆ ContainsPoint() [1/3]

◆ ContainsPoint() [2/3]

◆ ContainsPoint() [3/3]

◆ FillGeom()

◆ FindDistance()

◆ GenGeomFactors()

◆ GetBoundingBox()

◆ GetCoeffs()

◆ GetCoord()

◆ GetCoordim()

◆ GetDir()

◆ GetEdge()

◆ GetEdgeFaceMap()

◆ GetEdgeNormalToFaceVert()

◆ GetEid()

◆ GetEorient()

◆ GetFace()

◆ GetFid()

◆ GetForient()

◆ GetGeomFactors()

◆ GetGlobalID()

◆ GetLocCoords()

◆ GetMetricInfo()

◆ GetNumEdges()

◆ GetNumFaces()

◆ GetNumVerts()

◆ GetRefGeomFactors()

◆ GetShapeDim()

◆ GetShapeType()

◆ GetTid()

◆ GetVertex()

◆ GetVertexEdgeMap()

◆ GetVertexFaceMap()

◆ GetVid()

◆ GetXmap()

◆ MinMaxCheck()

◆ PreliminaryCheck()

◆ Reset()

◆ ResetNonRecursive()

◆ SetCoordim()

◆ SetGlobalID()

◆ Setup()

◆ SetUpCoeffs()

◆ v_AllLeftCheck()

◆ v_CalculateInverseIsoParam()

◆ v_ContainsPoint()

◆ v_FillGeom()

◆ v_FindDistance()

◆ v_GenGeomFactors()

◆ v_GetCoord()

◆ v_GetDir()

◆ v_GetEdge()

◆ v_GetEdgeFaceMap()

◆ v_GetEdgeNormalToFaceVert()

◆ v_GetEorient()

◆ v_GetFace()

◆ v_GetForient()

◆ v_GetLocCoords()

◆ v_GetNumEdges()

◆ v_GetNumFaces()

◆ v_GetNumVerts()

◆ v_GetShapeDim()

◆ v_GetVertex()

◆ v_GetVertexEdgeMap()

◆ v_GetVertexFaceMap()

◆ v_GetXmap()

◆ v_Reset()