Nektar::LibUtilities::PointsKey Class Reference

Defines a specification for a set of points. More...

#include <Points.h>

Classes
struct	opLess

Public Member Functions
	PointsKey (void)
	Default constructor.
	PointsKey (const size_t &numpoints, const PointsType &pointstype, const NekDouble factor=NekConstants::kNekUnsetDouble)
	Constructor defining the number and distribution of points.
virtual	~PointsKey ()
	Destructor.
	PointsKey (const PointsKey &key)=default
	Copy constructor.
PointsKey &	operator= (const PointsKey &key)=default
size_t	GetNumPoints () const
PointsType	GetPointsType () const
NekDouble	GetFactor () const
bool	operator== (const PointsKey &key)
bool	operator== (const PointsKey *y)
bool	operator!= (const PointsKey &y)
bool	operator!= (const PointsKey *y)
size_t	GetPointsDim () const
size_t	GetTotNumPoints () const
PointsKey	GetEquivalentPointsKey (const PointsType ptype)

Static Public Member Functions
static void	GetEffectiveQuadRange (const LibUtilities::PointsKey &pkey, int &q_begin, int &q_end)
	offset the m_nq_begin and m_nq_end according to the points type
static int	GetDegreeOfExactness (const PointsType ptype, const int npt)
	Get degree of exactness for quadrature points.

Protected Attributes
size_t	m_numpoints
	number of the points (as appropriately defined for PointsType)
PointsType	m_pointstype
	Type of Points.
NekDouble	m_factor
	optional factor

Friends
bool	operator== (const PointsKey &lhs, const PointsKey &rhs)
bool	operator< (const PointsKey &lhs, const PointsKey &rhs)
bool	opLess::operator() (const PointsKey &lhs, const PointsKey &rhs) const

Detailed Description

Defines a specification for a set of points.

Specification for a set of points. This includes the total number of points, as well as their distribution.

Definition at line 49 of file Points.h.

Constructor & Destructor Documentation

PointsKey() [1/3]

Nektar::LibUtilities::PointsKey::PointsKey ( void  )

inline

Default constructor.

Definition at line 62 of file Points.h.

        : m_numpoints(0), m_pointstype(eNoPointsType),
          m_factor(NekConstants::kNekUnsetDouble)
    {
    }

Referenced by GetEquivalentPointsKey().

PointsKey() [2/3]

Nektar::LibUtilities::PointsKey::PointsKey ( const size_t &  numpoints, const PointsType &  pointstype, const NekDouble  factor = NekConstants::kNekUnsetDouble  )

inline

Constructor defining the number and distribution of points.

Definition at line 69 of file Points.h.

        : m_numpoints(numpoints), m_pointstype(pointstype), m_factor(factor)
    {
    }

~PointsKey()

virtual Nektar::LibUtilities::PointsKey::~PointsKey ( )

inlinevirtual

Destructor.

Definition at line 76 of file Points.h.

    {
    }

PointsKey() [3/3]

Nektar::LibUtilities::PointsKey::PointsKey ( const PointsKey &  key )

default

Copy constructor.

Member Function Documentation

GetDegreeOfExactness()

static int Nektar::LibUtilities::PointsKey::GetDegreeOfExactness ( const PointsType  ptype, const int  npt  )

inlinestatic

Get degree of exactness for quadrature points.

Definition at line 245 of file Points.h.

    {
        switch (ptype)
        {
            case eGaussGaussLegendre:
            case eGaussGaussChebyshev:
            {
                return 2 * npt - 1;
            }
            case eGaussLegendreWithMP:
            {
                return 2 * (npt - 2) - 1;
            }
            case eGaussLegendreWithM:
            {
                return 2 * (npt - 1) - 1;
            }
            case eGaussRadauMLegendre:
            case eGaussRadauPLegendre:
            case eGaussRadauMChebyshev:
            case eGaussRadauMAlpha0Beta1:
            case eGaussRadauMAlpha0Beta2:
            case eGaussRadauMAlpha1Beta0:
            case eGaussRadauMAlpha2Beta0:
            {
                return 2 * npt - 2;
            }
            case eGaussLobattoLegendre:
            case eGaussLobattoChebyshev:
            {
                return 2 * npt - 3;
            }
            case eGaussKronrodLegendre:
            {
                return 3 * (npt - 1) / 2 + 1;
            }
            case eGaussRadauKronrodMLegendre:
            case eGaussRadauKronrodMAlpha1Beta0:
            {
                return 3 * (npt - 2) / 2; // not for sure
            }
            case eGaussLobattoKronrodLegendre:
            {
                return 3 * (npt - 3) / 2; // not for sure
            }
            default:
                break; // make it happy
        }
        return npt;
    }

References Nektar::LibUtilities::eGaussGaussChebyshev, Nektar::LibUtilities::eGaussGaussLegendre, Nektar::LibUtilities::eGaussLegendreWithM, Nektar::LibUtilities::eGaussLegendreWithMP, Nektar::LibUtilities::eGaussLobattoChebyshev, Nektar::LibUtilities::eGaussLobattoKronrodLegendre, Nektar::LibUtilities::eGaussLobattoLegendre, Nektar::LibUtilities::eGaussRadauKronrodMAlpha1Beta0, Nektar::LibUtilities::eGaussRadauKronrodMLegendre, Nektar::LibUtilities::eGaussRadauMAlpha0Beta1, Nektar::LibUtilities::eGaussRadauMChebyshev, Nektar::LibUtilities::eGaussRadauMLegendre, and Nektar::LibUtilities::eGaussRadauPLegendre.

Referenced by GetEquivalentPointsKey().

GetEffectiveQuadRange()

static void Nektar::LibUtilities::PointsKey::GetEffectiveQuadRange ( const LibUtilities::PointsKey &  pkey, int &  q_begin, int &  q_end  )

inlinestatic

offset the m_nq_begin and m_nq_end according to the points type

Definition at line 219 of file Points.h.

    {
        switch (pkey.GetPointsType())
        {
            case LibUtilities::eGaussLegendreWithM:
            {
                q_begin = 1;
                q_end   = pkey.GetNumPoints();
            }
            break;
            case LibUtilities::eGaussLegendreWithMP:
            {
                q_begin = 1;
                q_end   = pkey.GetNumPoints() - 1;
            }
            break;
            default:
            {
                q_begin = 0;
                q_end   = pkey.GetNumPoints();
            }
        }
    }

References Nektar::LibUtilities::eGaussLegendreWithM, Nektar::LibUtilities::eGaussLegendreWithMP, GetNumPoints(), and GetPointsType().

Referenced by Nektar::LocalRegions::GetTraceQuadRange(), Nektar::MultiRegions::LocTraceToTraceMap::InterpLocEdgesToTrace(), Nektar::MultiRegions::LocTraceToTraceMap::InterpLocEdgesToTraceTranspose(), Nektar::MultiRegions::LocTraceToTraceMap::InterpLocFacesToTrace(), Nektar::MultiRegions::LocTraceToTraceMap::InterpLocFacesToTraceTranspose(), Nektar::MultiRegions::LocTraceToTraceMap::InterpTraceToLocEdges(), and Nektar::MultiRegions::LocTraceToTraceMap::InterpTraceToLocFaces().

GetEquivalentPointsKey()

PointsKey Nektar::LibUtilities::PointsKey::GetEquivalentPointsKey

(

const PointsType

ptype

)

Definition at line 92 of file Foundations/Points.cpp.

{
    auto required_degree = GetDegreeOfExactness(m_pointstype, m_numpoints);
    int npoints          = 2;
    while (GetDegreeOfExactness(ptype, npoints) < required_degree)
    {
        ++npoints;
    }
    return PointsKey(npoints, ptype);
}

References GetDegreeOfExactness(), m_numpoints, m_pointstype, and PointsKey().

GetFactor()

NekDouble Nektar::LibUtilities::PointsKey::GetFactor ( ) const

inline

Definition at line 95 of file Points.h.

    {
        return m_factor;
    }

References m_factor.

Referenced by Nektar::LibUtilities::BLPoints::v_CalculatePoints().

GetNumPoints()

size_t Nektar::LibUtilities::PointsKey::GetNumPoints ( ) const

inline

Definition at line 85 of file Points.h.

    {
        return m_numpoints;
    }

References m_numpoints.

Referenced by Nektar::MultiRegions::LocTraceToTraceMap::CalcLocTracePhysToTraceIDMap_2D(), Nektar::MultiRegions::LocTraceToTraceMap::CalcLocTracePhysToTraceIDMap_3D(), Nektar::LibUtilities::GaussPoints::CalculateGalerkinProjectionMatrix(), Nektar::LibUtilities::FourierPoints::CalculateInterpMatrix(), Nektar::LibUtilities::GaussPoints::CalculateInterpMatrix(), Nektar::LibUtilities::PolyEPoints::CalculateInterpMatrix(), Nektar::LibUtilities::FourierPoints::CreateMatrix(), Nektar::LibUtilities::GaussPoints::CreateMatrix(), export_Points(), GetEffectiveQuadRange(), Nektar::LibUtilities::BasisKey::GetNumPoints(), Nektar::LibUtilities::Points< DataT >::GetNumPoints(), Nektar::LibUtilities::Interp1D(), Nektar::LibUtilities::Interp1D(), Nektar::LibUtilities::Interp2D(), Nektar::LibUtilities::Interp3D(), Nektar::MultiRegions::LocTraceToTraceMap::InterpLocEdgesToTrace(), Nektar::MultiRegions::LocTraceToTraceMap::InterpLocEdgesToTraceTranspose(), Nektar::MultiRegions::LocTraceToTraceMap::InterpLocFacesToTrace(), Nektar::MultiRegions::LocTraceToTraceMap::InterpLocFacesToTraceTranspose(), Nektar::MultiRegions::LocTraceToTraceMap::InterpTraceToLocEdges(), Nektar::MultiRegions::LocTraceToTraceMap::InterpTraceToLocFaces(), Nektar::MultiRegions::LocTraceToTraceMap::LocTraceToTraceMap(), Nektar::LibUtilities::operator<<(), Nektar::LibUtilities::PhysGalerkinProject1D(), Nektar::LibUtilities::PhysGalerkinProject1D(), Nektar::LibUtilities::PhysGalerkinProject2D(), Nektar::LibUtilities::PhysGalerkinProject3D(), Nektar::LibUtilities::GaussPoints::v_CalculateDerivMatrix(), Nektar::LibUtilities::PolyEPoints::v_CalculateDerivMatrix(), Nektar::LibUtilities::FourierPoints::v_CalculateDerivMatrix(), Nektar::LibUtilities::GaussPoints::v_CalculatePoints(), Nektar::LibUtilities::PolyEPoints::v_CalculatePoints(), Nektar::LibUtilities::BLPoints::v_CalculatePoints(), Nektar::LibUtilities::FourierPoints::v_CalculatePoints(), Nektar::LibUtilities::FourierSingleModePoints::v_CalculatePoints(), Nektar::LibUtilities::PolyEPoints::v_CalculateWeights(), Nektar::LibUtilities::FourierPoints::v_CalculateWeights(), Nektar::LibUtilities::FourierSingleModePoints::v_CalculateWeights(), Nektar::LocalRegions::QuadExp::v_ComputeTraceNormal(), Nektar::LocalRegions::TriExp::v_ComputeTraceNormal(), and Nektar::LibUtilities::PolyEPoints::v_GetI().

GetPointsDim()

size_t Nektar::LibUtilities::PointsKey::GetPointsDim ( ) const

inline

Definition at line 128 of file Points.h.

    {
        size_t dimpoints = 1;
 
        switch (m_pointstype)
        {
            case eNodalTriElec:
            case eNodalTriFekete:
            case eNodalTriEvenlySpaced:
            case eNodalTriSPI:
            case eNodalQuadElec:
                dimpoints = 2;
                break;
 
            case eNodalTetElec:
            case eNodalTetEvenlySpaced:
            case eNodalPrismEvenlySpaced:
            case eNodalPrismElec:
            case eNodalHexElec:
                dimpoints = 3;
                break;
 
            default:
                break;
        }
 
        return dimpoints;
    }

References Nektar::LibUtilities::eNodalHexElec, Nektar::LibUtilities::eNodalPrismElec, Nektar::LibUtilities::eNodalPrismEvenlySpaced, Nektar::LibUtilities::eNodalQuadElec, Nektar::LibUtilities::eNodalTetElec, Nektar::LibUtilities::eNodalTetEvenlySpaced, Nektar::LibUtilities::eNodalTriElec, Nektar::LibUtilities::eNodalTriEvenlySpaced, Nektar::LibUtilities::eNodalTriFekete, Nektar::LibUtilities::eNodalTriSPI, and m_pointstype.

Referenced by export_Points(), Nektar::LibUtilities::Basis::GetI(), Nektar::LibUtilities::Points< DataT >::GetPointsDim(), Nektar::LibUtilities::FourierPoints::v_GetI(), Nektar::LibUtilities::GaussPoints::v_GetI(), Nektar::LibUtilities::NodalPrismElec::v_GetI(), Nektar::LibUtilities::NodalPrismEvenlySpaced::v_GetI(), Nektar::LibUtilities::NodalTetElec::v_GetI(), Nektar::LibUtilities::NodalTetEvenlySpaced::v_GetI(), Nektar::LibUtilities::NodalTriElec::v_GetI(), Nektar::LibUtilities::NodalTriEvenlySpaced::v_GetI(), Nektar::LibUtilities::NodalTriFekete::v_GetI(), and Nektar::LibUtilities::PolyEPoints::v_GetI().

GetPointsType()

PointsType Nektar::LibUtilities::PointsKey::GetPointsType ( ) const

inline

Definition at line 90 of file Points.h.

    {
        return m_pointstype;
    }

References m_pointstype.

Referenced by Nektar::LibUtilities::GaussPoints::CalculateInterpMatrix(), export_Points(), GetEffectiveQuadRange(), Nektar::LibUtilities::BasisKey::GetPointsType(), Nektar::LibUtilities::Points< DataT >::GetPointsType(), Nektar::MultiRegions::LocTraceToTraceMap::LocTraceToTraceMap(), Nektar::StdRegions::StdNodalPrismExp::ModalToNodal(), Nektar::StdRegions::StdNodalTetExp::ModalToNodal(), Nektar::StdRegions::StdNodalTriExp::ModalToNodal(), Nektar::StdRegions::StdNodalPrismExp::NodalToModal(), Nektar::StdRegions::StdNodalTetExp::NodalToModal(), Nektar::StdRegions::StdNodalPrismExp::NodalToModalTranspose(), Nektar::StdRegions::StdNodalTetExp::NodalToModalTranspose(), Nektar::StdRegions::StdNodalTriExp::NodalToModalTranspose(), Nektar::LibUtilities::operator<<(), Nektar::LibUtilities::GaussPoints::v_CalculateDerivMatrix(), Nektar::LibUtilities::GaussPoints::v_CalculatePoints(), Nektar::LibUtilities::BLPoints::v_CalculatePoints(), Nektar::LocalRegions::NodalPrismExp::v_CreateStdMatrix(), Nektar::LocalRegions::NodalTetExp::v_CreateStdMatrix(), Nektar::LocalRegions::NodalTriExp::v_CreateStdMatrix(), Nektar::StdRegions::StdExpansion::v_FwdTrans(), Nektar::LocalRegions::Expansion::v_FwdTrans(), Nektar::LocalRegions::NodalPrismExp::v_GetLinStdExp(), Nektar::LocalRegions::NodalTetExp::v_GetLinStdExp(), Nektar::LocalRegions::NodalTriExp::v_GetLinStdExp(), Nektar::LocalRegions::NodalPrismExp::v_GetStdExp(), Nektar::LocalRegions::NodalTetExp::v_GetStdExp(), Nektar::LocalRegions::NodalTriExp::v_GetStdExp(), and Nektar::StdRegions::StdNodalTriExp::v_NodalToModal().

GetTotNumPoints()

size_t Nektar::LibUtilities::PointsKey::GetTotNumPoints ( ) const

inline

Definition at line 158 of file Points.h.

    {
        size_t totpoints = m_numpoints;
 
        switch (m_pointstype)
        {
            case eNodalTriElec:
            case eNodalTriFekete:
            case eNodalTriEvenlySpaced:
                totpoints = m_numpoints * (m_numpoints + 1) / 2;
                break;
            case eNodalTriSPI:
                NEKERROR(ErrorUtil::efatal,
                         "This method cannot be implemented");
                break;
 
            case eNodalQuadElec:
                totpoints = m_numpoints * m_numpoints;
                break;
 
            case eNodalTetElec:
            case eNodalTetEvenlySpaced:
                totpoints =
                    m_numpoints * (m_numpoints + 1) * (m_numpoints + 2) / 6;
                break;
            case eNodalTetSPI:
                NEKERROR(ErrorUtil::efatal,
                         "This method cannot be implemented");
                break;
 
            case eNodalPrismEvenlySpaced:
            case eNodalPrismElec:
                totpoints = m_numpoints * m_numpoints * (m_numpoints + 1) / 2;
                break;
            case eNodalPrismSPI:
                NEKERROR(ErrorUtil::efatal,
                         "This method cannot be implemented");
                break;
 
            case eNodalHexElec:
                totpoints = m_numpoints * m_numpoints * m_numpoints;
                break;
 
            default:
                break;
        }
 
        return totpoints;
    }

References Nektar::ErrorUtil::efatal, Nektar::LibUtilities::eNodalHexElec, Nektar::LibUtilities::eNodalPrismElec, Nektar::LibUtilities::eNodalPrismEvenlySpaced, Nektar::LibUtilities::eNodalPrismSPI, Nektar::LibUtilities::eNodalQuadElec, Nektar::LibUtilities::eNodalTetElec, Nektar::LibUtilities::eNodalTetEvenlySpaced, Nektar::LibUtilities::eNodalTetSPI, Nektar::LibUtilities::eNodalTriElec, Nektar::LibUtilities::eNodalTriEvenlySpaced, Nektar::LibUtilities::eNodalTriFekete, Nektar::LibUtilities::eNodalTriSPI, m_numpoints, m_pointstype, and NEKERROR.

Referenced by export_Points(), Nektar::LibUtilities::BasisKey::GetTotNumPoints(), Nektar::LibUtilities::Points< DataT >::GetTotNumPoints(), Nektar::LibUtilities::GaussPoints::v_CalculateDerivMatrix(), Nektar::LibUtilities::NodalTetElec::v_CalculatePoints(), Nektar::LibUtilities::NodalTriElec::v_CalculatePoints(), and Nektar::LibUtilities::NodalTriFekete::v_CalculatePoints().

operator!=() [1/2]

bool Nektar::LibUtilities::PointsKey::operator!= ( const PointsKey &  y )

inline

Definition at line 117 of file Points.h.

    {
        return (!(*this == y));
    }

operator!=() [2/2]

bool Nektar::LibUtilities::PointsKey::operator!= ( const PointsKey *  y )

inline

Definition at line 122 of file Points.h.

    {
        return (!(*this == *y));
    }

operator=()

PointsKey & Nektar::LibUtilities::PointsKey::operator= ( const PointsKey &  key )

default

operator==() [1/2]

bool Nektar::LibUtilities::PointsKey::operator== ( const PointsKey &  key )

inline

Definition at line 100 of file Points.h.

    {
 
        if (fabs(m_factor - key.m_factor) < NekConstants::kNekZeroTol)
        {
            return (m_numpoints == key.m_numpoints &&
                    m_pointstype == key.m_pointstype);
        }
 
        return false;
    }

References Nektar::NekConstants::kNekZeroTol, m_factor, m_numpoints, and m_pointstype.

operator==() [2/2]

bool Nektar::LibUtilities::PointsKey::operator== ( const PointsKey *  y )

inline

Definition at line 112 of file Points.h.

    {
        return (*this == *y);
    }

Friends And Related Symbol Documentation

operator<

bool operator< ( const PointsKey &  lhs, const PointsKey &  rhs  )

friend

Definition at line 51 of file Foundations/Points.cpp.

{
    if (lhs.m_pointstype < rhs.m_pointstype)
    {
        return true;
    }
 
    if (lhs.m_pointstype > rhs.m_pointstype)
    {
        return false;
    }
 
    if (lhs.m_numpoints < rhs.m_numpoints)
    {
        return true;
    }
 
    if (lhs.m_numpoints > rhs.m_numpoints)
    {
        return false;
    }
 
    if (lhs.m_factor < rhs.m_factor)
    {
        return true;
    }
 
    if (lhs.m_factor > rhs.m_factor)
    {
        return false;
    }
 
    return false;
}

operator==

bool operator== ( const PointsKey &  lhs, const PointsKey &  rhs  )

friend

Definition at line 45 of file Foundations/Points.cpp.

{
    return (lhs.m_numpoints == rhs.m_numpoints &&
            lhs.m_pointstype == rhs.m_pointstype);
}

opLess::operator()

bool opLess::operator() ( const PointsKey &  lhs, const PointsKey &  rhs  ) const

friend

Member Data Documentation

m_factor

NekDouble Nektar::LibUtilities::PointsKey::m_factor

protected

optional factor

Definition at line 301 of file Points.h.

Referenced by GetFactor(), and operator==().

m_numpoints

size_t Nektar::LibUtilities::PointsKey::m_numpoints

protected

number of the points (as appropriately defined for PointsType)

Definition at line 298 of file Points.h.

Referenced by GetEquivalentPointsKey(), GetNumPoints(), GetTotNumPoints(), and operator==().

m_pointstype

PointsType Nektar::LibUtilities::PointsKey::m_pointstype

protected

Type of Points.

Definition at line 300 of file Points.h.

Referenced by GetEquivalentPointsKey(), GetPointsDim(), GetPointsType(), GetTotNumPoints(), Nektar::LibUtilities::PointsKey::opLess::operator()(), and operator==().