Nektar::LibUtilities::BasisKey Class Reference

Describes the specification for a Basis. More...

#include <Basis.h>

Classes
struct	opLess

Public Member Functions
	BasisKey (const BasisType btype, const int nummodes, const PointsKey pkey)
	Constructor. More...
	BasisKey (const BasisKey &B)
	Copy constructor. More...
	~BasisKey ()
	Destructor. More...
BasisKey &	operator= (const BasisKey &)=default
	Assignment operator. More...
int	GetNumModes () const
	Returns the order of the basis. More...
int	GetTotNumModes () const
int	GetNumPoints () const
	Return points order at which basis is defined. More...
int	GetTotNumPoints () const
BasisType	GetBasisType () const
	Return type of expansion basis. More...
PointsKey	GetPointsKey () const
	Return distribution of points. More...
PointsType	GetPointsType () const
	Return type of quadrature. More...
bool	SamePoints (const BasisKey &x) const
	Determine if quadrature of expansion x matches this. More...
bool	SameExp (const BasisKey &x) const
	Determine if basis expansion x matches this. More...
bool	ExactIprodInt () const
	Determine if basis has exact integration for inner product. More...
bool	Collocation () const
	Determine if basis has collocation properties. More...

Protected Attributes
unsigned int	m_nummodes
	Expansion order. More...
BasisType	m_basistype
	Expansion type. More...
PointsKey	m_pointsKey
	Points specification. More...

Private Member Functions
	BasisKey ()

Friends
bool	operator== (const BasisKey &x, const BasisKey &y)
	Overloaded Operators. More...
bool	operator== (const BasisKey *x, const BasisKey &y)
bool	operator== (const BasisKey &x, const BasisKey *y)
bool	operator!= (const BasisKey &x, const BasisKey &y)
bool	operator!= (const BasisKey *x, const BasisKey &y)
bool	operator!= (const BasisKey &x, const BasisKey *y)
bool	operator< (const BasisKey &lhs, const BasisKey &rhs)
bool	opLess::operator() (const BasisKey &lhs, const BasisKey &rhs) const

Detailed Description

Describes the specification for a Basis.

Definition at line 49 of file Basis.h.

Constructor & Destructor Documentation

BasisKey() [1/3]

Nektar::LibUtilities::BasisKey::BasisKey ( const BasisType  btype, const int  nummodes, const PointsKey  pkey  )

inline

Constructor.

Definition at line 62 of file Basis.h.

        : m_nummodes(nummodes), m_basistype(btype), m_pointsKey(pkey)
    {
    }

BasisKey() [2/3]

Nektar::LibUtilities::BasisKey::BasisKey ( const BasisKey &  B )

inline

Copy constructor.

Definition at line 68 of file Basis.h.

        : m_nummodes(B.m_nummodes), m_basistype(B.m_basistype),
          m_pointsKey(B.m_pointsKey)
    {
    }

~BasisKey()

Nektar::LibUtilities::BasisKey::~BasisKey ( )

inline

Destructor.

Definition at line 75 of file Basis.h.

    {
    }

BasisKey() [3/3]

Nektar::LibUtilities::BasisKey::BasisKey ( )

inlineprivate

Definition at line 201 of file Basis.h.

               : m_pointsKey(NullPointsKey)
    {
        NEKERROR(ErrorUtil::efatal,
                 "Default Constructor BasisKey should never be called");
    }

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

Member Function Documentation

Collocation()

bool Nektar::LibUtilities::BasisKey::Collocation

(

)

const

Determine if basis has collocation properties.

Determine if basis has collocation property, i.e. GLL_Lagrange with Lobatto integration of appropriate order, Gauss_Lagrange with Gauss integration of appropriate order.

Definition at line 888 of file Foundations/Basis.cpp.

{
    return ((m_basistype == eGLL_Lagrange &&
             GetPointsType() == eGaussLobattoLegendre &&
             GetNumModes() == GetNumPoints()) ||
            (m_basistype == eGauss_Lagrange &&
             GetPointsType() == eGaussGaussLegendre &&
             GetNumModes() == GetNumPoints()));
}

References Nektar::LibUtilities::eGauss_Lagrange, Nektar::LibUtilities::eGaussGaussLegendre, Nektar::LibUtilities::eGaussLobattoLegendre, Nektar::LibUtilities::eGLL_Lagrange, GetNumModes(), GetNumPoints(), GetPointsType(), and m_basistype.

Referenced by Nektar::LibUtilities::Basis::Collocation(), and export_Basis().

ExactIprodInt()

bool Nektar::LibUtilities::BasisKey::ExactIprodInt

(

void

)

const

Determine if basis has exact integration for inner product.

Determine if polynomial basis can be eactly integrated with itself.

Definition at line 861 of file Foundations/Basis.cpp.

{
    bool returnval = false;
 
    switch (GetPointsType())
    {
        case eGaussGaussLegendre:
        case eGaussRadauMLegendre:
        case eGaussRadauPLegendre:
        case eGaussLobattoLegendre:
        case eGaussKronrodLegendre:
        case eGaussRadauKronrodMLegendre:
        case eGaussLobattoKronrodLegendre:
            returnval = (GetNumPoints() >= GetNumModes());
            break;
 
        default:
            break;
    }
 
    return returnval;
}

References Nektar::LibUtilities::eGaussGaussLegendre, Nektar::LibUtilities::eGaussLobattoKronrodLegendre, Nektar::LibUtilities::eGaussLobattoLegendre, Nektar::LibUtilities::eGaussRadauKronrodMLegendre, Nektar::LibUtilities::eGaussRadauMLegendre, Nektar::LibUtilities::eGaussRadauPLegendre, GetNumModes(), GetNumPoints(), and GetPointsType().

Referenced by Nektar::LibUtilities::Basis::ExactIprodInt().

GetBasisType()

BasisType Nektar::LibUtilities::BasisKey::GetBasisType ( ) const

inline

Return type of expansion basis.

Definition at line 141 of file Basis.h.

    {
        return m_basistype;
    }

References m_basistype.

Referenced by Nektar::LibUtilities::Basis::CalculateInterpMatrix(), Nektar::MultiRegions::ExpList::ExpList(), export_Basis(), Nektar::CoupledLinearNS::GenPressureExp(), Nektar::LibUtilities::Basis::GetBasisType(), Nektar::MultiRegions::ExpList::InitialiseExpVector(), Nektar::LibUtilities::InterpCoeff1D(), Nektar::LibUtilities::InterpCoeff2D(), Nektar::LibUtilities::operator<<(), Nektar::SpatialDomains::MeshGraph::SetExpansionInfoToEvenlySpacedPoints(), Nektar::SpatialDomains::MeshGraph::SetExpansionInfoToNumModes(), Nektar::SpatialDomains::MeshGraph::SetExpansionInfoToPointOrder(), Nektar::MultiRegions::GJPStabilisation::SetUpExpansionInfoMapForGJP(), Nektar::StdRegions::StdPyrExp::StdPyrExp(), and Nektar::LibUtilities::Transposition::Transposition().

GetNumModes()

int Nektar::LibUtilities::BasisKey::GetNumModes ( ) const

inline

Returns the order of the basis.

Definition at line 83 of file Basis.h.

    {
        return m_nummodes;
    }

References m_nummodes.

Referenced by Nektar::LibUtilities::Basis::CalculateInterpMatrix(), Collocation(), ExactIprodInt(), Nektar::MultiRegions::ExpList::ExpList(), export_Basis(), Nektar::LibUtilities::Basis::GenBasis(), Nektar::CoupledLinearNS::GenPressureExp(), Nektar::LibUtilities::Basis::GetNumModes(), Nektar::MultiRegions::ExpList::InitialiseExpVector(), Nektar::LibUtilities::InterpCoeff1D(), Nektar::LibUtilities::InterpCoeff2D(), Nektar::LibUtilities::InterpCoeff3D(), Nektar::LibUtilities::operator<<(), Nektar::SpatialDomains::MeshGraph::SetExpansionInfoToEvenlySpacedPoints(), Nektar::SpatialDomains::MeshGraph::SetExpansionInfoToNumModes(), Nektar::SpatialDomains::MeshGraph::SetExpansionInfoToPointOrder(), Nektar::MultiRegions::GJPStabilisation::SetUpExpansionInfoMapForGJP(), Nektar::StdRegions::StdNodalPrismExp::StdNodalPrismExp(), Nektar::StdRegions::StdNodalTetExp::StdNodalTetExp(), Nektar::StdRegions::StdPrismExp::StdPrismExp(), Nektar::StdRegions::StdPyrExp::StdPyrExp(), Nektar::StdRegions::StdTetExp::StdTetExp(), Nektar::StdRegions::StdTriExp::StdTriExp(), and Nektar::LibUtilities::Transposition::Transposition().

GetNumPoints()

int Nektar::LibUtilities::BasisKey::GetNumPoints ( ) const

inline

Return points order at which basis is defined.

Definition at line 130 of file Basis.h.

    {
        return m_pointsKey.GetNumPoints();
    }

References Nektar::LibUtilities::PointsKey::GetNumPoints(), and m_pointsKey.

Referenced by Collocation(), ExactIprodInt(), export_Basis(), Nektar::MultiRegions::ExpList::GetElmtNormalLength(), Nektar::LibUtilities::Basis::GetNumPoints(), Nektar::SpatialDomains::MeshGraph::SetExpansionInfoToNumModes(), Nektar::MultiRegions::GJPStabilisation::SetUpExpansionInfoMapForGJP(), Nektar::LibUtilities::Transposition::Transposition(), Nektar::GlobalMapping::UpdateGeometry(), Nektar::LocalRegions::HexExp::v_ComputeTraceNormal(), Nektar::LocalRegions::PrismExp::v_ComputeTraceNormal(), Nektar::LocalRegions::PyrExp::v_ComputeTraceNormal(), Nektar::LocalRegions::TetExp::v_ComputeTraceNormal(), and Nektar::MultiRegions::ExpList::v_GetNormals().

GetPointsKey()

PointsKey Nektar::LibUtilities::BasisKey::GetPointsKey ( ) const

inline

Return distribution of points.

Definition at line 147 of file Basis.h.

    {
        return m_pointsKey;
    }

References m_pointsKey.

Referenced by Nektar::MultiRegions::ExpList::ExpList(), export_Basis(), Nektar::LibUtilities::Basis::GenBasis(), Nektar::CoupledLinearNS::GenPressureExp(), Nektar::MultiRegions::ExpList::GetElmtNormalLength(), Nektar::LibUtilities::Basis::GetI(), Nektar::LibUtilities::Basis::GetPointsKey(), Nektar::MultiRegions::ExpList::InitialiseExpVector(), Nektar::LibUtilities::Interp1D(), Nektar::LibUtilities::Interp2D(), Nektar::LibUtilities::Interp3D(), Nektar::LibUtilities::operator<<(), Nektar::LibUtilities::PhysGalerkinProject1D(), Nektar::LibUtilities::PhysGalerkinProject2D(), Nektar::LibUtilities::PhysGalerkinProject3D(), Nektar::LocalRegions::HexExp::v_ComputeTraceNormal(), Nektar::LocalRegions::PrismExp::v_ComputeTraceNormal(), Nektar::LocalRegions::PyrExp::v_ComputeTraceNormal(), Nektar::LocalRegions::TetExp::v_ComputeTraceNormal(), and Nektar::MultiRegions::ExpList::v_GetNormals().

GetPointsType()

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

inline

Return type of quadrature.

Definition at line 153 of file Basis.h.

    {
        return m_pointsKey.GetPointsType();
    }

References Nektar::LibUtilities::PointsKey::GetPointsType(), and m_pointsKey.

Referenced by Collocation(), ExactIprodInt(), export_Basis(), Nektar::LibUtilities::Basis::GetPointsType(), Nektar::SpatialDomains::MeshGraph::SetExpansionInfoToNumModes(), Nektar::SpatialDomains::MeshGraph::SetExpansionInfoToPointOrder(), Nektar::MultiRegions::GJPStabilisation::SetUpExpansionInfoMapForGJP(), and Nektar::GlobalMapping::UpdateGeometry().

GetTotNumModes()

int Nektar::LibUtilities::BasisKey::GetTotNumModes ( ) const

inline

Todo:

Generalise to arbitrary polynomials

Definition at line 89 of file Basis.h.

    {
        int value = 0;
 
        switch (m_basistype)
        {
            case eOrtho_B:
            case eModified_B:
                value = m_nummodes * (m_nummodes + 1) / 2;
                break;
 
            case eModified_C:
            case eOrtho_C:
                value = m_nummodes * (m_nummodes + 1) * (m_nummodes + 2) / 6;
                break;
            case eModifiedPyr_C:
            case eOrthoPyr_C:
                value =
                    m_nummodes * (m_nummodes + 1) * (2 * m_nummodes + 1) / 6;
                break;
            case eOrtho_A:
            case eModified_A:
            case eFourier:
            case eGLL_Lagrange:
            case eGauss_Lagrange:
            case eLegendre:
            case eChebyshev:
            case eMonomial:
            case eFourierSingleMode:
            case eFourierHalfModeRe:
            case eFourierHalfModeIm:
                value = m_nummodes;
                break;
 
            default:
                NEKERROR(ErrorUtil::efatal, "Unknown basis being used");
        }
        return value;
    }

References Nektar::LibUtilities::eChebyshev, Nektar::ErrorUtil::efatal, Nektar::LibUtilities::eFourier, Nektar::LibUtilities::eFourierHalfModeIm, Nektar::LibUtilities::eFourierHalfModeRe, Nektar::LibUtilities::eFourierSingleMode, Nektar::LibUtilities::eGauss_Lagrange, Nektar::LibUtilities::eGLL_Lagrange, Nektar::LibUtilities::eModified_A, Nektar::LibUtilities::eModified_B, Nektar::LibUtilities::eModified_C, Nektar::LibUtilities::eModifiedPyr_C, Nektar::LibUtilities::eOrtho_A, Nektar::LibUtilities::eOrtho_B, Nektar::LibUtilities::eOrtho_C, Nektar::LibUtilities::eOrthoPyr_C, m_basistype, m_nummodes, and NEKERROR.

Referenced by export_Basis(), and Nektar::LibUtilities::Basis::GetTotNumModes().

GetTotNumPoints()

int Nektar::LibUtilities::BasisKey::GetTotNumPoints ( ) const

inline

Definition at line 135 of file Basis.h.

    {
        return m_pointsKey.GetTotNumPoints();
    }

References Nektar::LibUtilities::PointsKey::GetTotNumPoints(), and m_pointsKey.

Referenced by export_Basis(), and Nektar::LibUtilities::Basis::GetTotNumPoints().

operator=()

BasisKey& Nektar::LibUtilities::BasisKey::operator= ( const BasisKey &  )

default

Assignment operator.

SameExp()

bool Nektar::LibUtilities::BasisKey::SameExp ( const BasisKey &  x ) const

inline

Determine if basis expansion x matches this.

Definition at line 165 of file Basis.h.

    {
        return ((x.m_nummodes == m_nummodes) && (x.m_basistype == m_basistype));
    }

References m_basistype, and m_nummodes.

SamePoints()

bool Nektar::LibUtilities::BasisKey::SamePoints ( const BasisKey &  x ) const

inline

Determine if quadrature of expansion x matches this.

Definition at line 159 of file Basis.h.

    {
        return (x.m_pointsKey == m_pointsKey);
    }

References m_pointsKey.

Friends And Related Function Documentation

operator!= [1/3]

bool operator!= ( const BasisKey &  x, const BasisKey &  y  )

friend

Definition at line 919 of file Foundations/Basis.cpp.

{
    return (!(x == y));
}

operator!= [2/3]

bool operator!= ( const BasisKey &  x, const BasisKey *  y  )

friend

Definition at line 931 of file Foundations/Basis.cpp.

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

operator!= [3/3]

bool operator!= ( const BasisKey *  x, const BasisKey &  y  )

friend

Definition at line 925 of file Foundations/Basis.cpp.

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

operator<

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

friend

Definition at line 50 of file Foundations/Basis.cpp.

{
    PointsKey lhsPointsKey = lhs.GetPointsKey();
    PointsKey rhsPointsKey = rhs.GetPointsKey();
 
    if (lhsPointsKey < rhsPointsKey)
    {
        return true;
    }
    if (lhsPointsKey != rhsPointsKey)
    {
        return false;
    }
 
    if (lhs.m_nummodes < rhs.m_nummodes)
    {
        return true;
    }
    if (lhs.m_nummodes > rhs.m_nummodes)
    {
        return false;
    }
 
    return (lhs.m_basistype < rhs.m_basistype);
}

operator== [1/3]

bool operator== ( const BasisKey &  x, const BasisKey &  y  )

friend

Overloaded Operators.

Definition at line 899 of file Foundations/Basis.cpp.

{
    return (x.GetPointsKey() == y.GetPointsKey() &&
            x.m_basistype == y.m_basistype &&
            x.GetNumModes() == y.GetNumModes());
}

operator== [2/3]

bool operator== ( const BasisKey &  x, const BasisKey *  y  )

friend

Definition at line 913 of file Foundations/Basis.cpp.

{
    return (x == *y);
}

operator== [3/3]

bool operator== ( const BasisKey *  x, const BasisKey &  y  )

friend

Definition at line 907 of file Foundations/Basis.cpp.

{
    return (*x == y);
}

opLess::operator()

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

friend

Member Data Documentation

m_basistype

BasisType Nektar::LibUtilities::BasisKey::m_basistype

protected

Expansion type.

Definition at line 197 of file Basis.h.

Referenced by Collocation(), GetBasisType(), GetTotNumModes(), Nektar::LibUtilities::BasisKey::opLess::operator()(), and SameExp().

m_nummodes

unsigned int Nektar::LibUtilities::BasisKey::m_nummodes

protected

Expansion order.

Definition at line 196 of file Basis.h.

Referenced by GetNumModes(), GetTotNumModes(), and SameExp().

m_pointsKey

PointsKey Nektar::LibUtilities::BasisKey::m_pointsKey

protected

Points specification.

Definition at line 198 of file Basis.h.

Referenced by GetNumPoints(), GetPointsKey(), GetPointsType(), GetTotNumPoints(), and SamePoints().