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
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 61 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 70 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 78 of file Basis.h.

References operator=().

            {
            }

BasisKey() [3/3]

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

inlineprivate

Definition at line 198 of file Basis.h.

References Nektar::ErrorUtil::efatal, Nektar::LibUtilities::eNoBasisType, NEKERROR, Nektar::LibUtilities::NullBasisKey(), and Nektar::LibUtilities::NullPointsKey().

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

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 860 of file Foundations/Basis.cpp.

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

Referenced by export_Basis(), and SameExp().

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

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 833 of file Foundations/Basis.cpp.

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

Referenced by SameExp().

        {
            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;
        }

GetBasisType()

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

inline

Return type of expansion basis.

Definition at line 144 of file Basis.h.

References m_basistype.

Referenced by Nektar::LibUtilities::Basis::CalculateInterpMatrix(), Nektar::MultiRegions::ExpList1D::ExpList1D(), Nektar::MultiRegions::ExpList2D::ExpList2D(), Nektar::MultiRegions::ExpList3D::ExpList3D(), export_Basis(), Nektar::CoupledLinearNS::GenPressureExp(), Nektar::LibUtilities::InterpCoeff1D(), Nektar::LibUtilities::InterpCoeff2D(), Nektar::LibUtilities::operator<<(), Nektar::SpatialDomains::MeshGraph::SetExpansionsToEvenlySpacedPoints(), Nektar::SpatialDomains::MeshGraph::SetExpansionsToPointOrder(), Nektar::SpatialDomains::MeshGraph::SetExpansionsToPolyOrder(), Nektar::StdRegions::StdPyrExp::StdPyrExp(), and Nektar::LibUtilities::Transposition::Transposition().

            {
                return m_basistype;
            }

GetNumModes()

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

inline

Returns the order of the basis.

Definition at line 86 of file Basis.h.

References m_nummodes.

Referenced by Nektar::LibUtilities::Basis::CalculateInterpMatrix(), Nektar::MultiRegions::ExpList1D::ExpList1D(), Nektar::MultiRegions::ExpList2D::ExpList2D(), Nektar::MultiRegions::ExpList3D::ExpList3D(), export_Basis(), Nektar::LibUtilities::Basis::GenBasis(), Nektar::CoupledLinearNS::GenPressureExp(), Nektar::LibUtilities::InterpCoeff1D(), Nektar::LibUtilities::InterpCoeff2D(), Nektar::LibUtilities::InterpCoeff3D(), Nektar::LibUtilities::operator<<(), Nektar::LibUtilities::operator==(), Nektar::SpatialDomains::MeshGraph::SetExpansionsToEvenlySpacedPoints(), Nektar::SpatialDomains::MeshGraph::SetExpansionsToPointOrder(), Nektar::SpatialDomains::MeshGraph::SetExpansionsToPolyOrder(), 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().

            {
                return m_nummodes;
            }

GetNumPoints()

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

inline

Return points order at which basis is defined.

Definition at line 133 of file Basis.h.

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

Referenced by Nektar::MultiRegions::ExpList1D::ExpList1D(), Nektar::MultiRegions::ExpList2D::ExpList2D(), Nektar::MultiRegions::ExpList3D::ExpList3D(), export_Basis(), Nektar::SpatialDomains::MeshGraph::SetExpansionsToPolyOrder(), Nektar::LibUtilities::Transposition::Transposition(), Nektar::GlobalMapping::UpdateGeometry(), Nektar::LocalRegions::TetExp::v_ComputeFaceNormal(), Nektar::LocalRegions::PrismExp::v_ComputeFaceNormal(), Nektar::LocalRegions::PyrExp::v_ComputeFaceNormal(), Nektar::LocalRegions::HexExp::v_ComputeFaceNormal(), and Nektar::MultiRegions::ExpList2D::v_GetNormals().

            {
                return m_pointsKey.GetNumPoints();
            }

GetPointsKey()

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

inline

Return distribution of points.

Definition at line 150 of file Basis.h.

References m_pointsKey.

Referenced by Nektar::MultiRegions::ExpList2D::ExpList2D(), export_Basis(), Nektar::LibUtilities::Basis::GenBasis(), Nektar::CoupledLinearNS::GenPressureExp(), Nektar::LibUtilities::Basis::GetI(), Nektar::LibUtilities::Interp1D(), Nektar::LibUtilities::Interp2D(), Nektar::LibUtilities::Interp3D(), Nektar::LibUtilities::operator<(), Nektar::LibUtilities::operator<<(), Nektar::LibUtilities::operator==(), Nektar::LibUtilities::PhysGalerkinProject1D(), Nektar::LibUtilities::PhysGalerkinProject2D(), Nektar::LibUtilities::PhysGalerkinProject3D(), Nektar::LocalRegions::TetExp::v_ComputeFaceNormal(), Nektar::LocalRegions::PrismExp::v_ComputeFaceNormal(), Nektar::LocalRegions::PyrExp::v_ComputeFaceNormal(), Nektar::LocalRegions::HexExp::v_ComputeFaceNormal(), and Nektar::MultiRegions::ExpList2D::v_GetNormals().

            {
                return m_pointsKey;
            }

GetPointsType()

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

inline

Return type of quadrature.

Definition at line 156 of file Basis.h.

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

Referenced by Nektar::MultiRegions::ExpList1D::ExpList1D(), Nektar::MultiRegions::ExpList2D::ExpList2D(), export_Basis(), Nektar::SpatialDomains::MeshGraph::SetExpansionsToPointOrder(), Nektar::SpatialDomains::MeshGraph::SetExpansionsToPolyOrder(), and Nektar::GlobalMapping::UpdateGeometry().

            {
                return m_pointsKey.GetPointsType();
            }

GetTotNumModes()

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

inline

Todo:

Generalise to arbitrary polynomials

Definition at line 92 of file Basis.h.

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::eLegendre, Nektar::LibUtilities::eModified_A, Nektar::LibUtilities::eModified_B, Nektar::LibUtilities::eModified_C, Nektar::LibUtilities::eModifiedPyr_C, Nektar::LibUtilities::eMonomial, 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().

            {
                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;
            }

GetTotNumPoints()

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

inline

Definition at line 138 of file Basis.h.

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

Referenced by export_Basis().

            {
                return m_pointsKey.GetTotNumPoints();
            }

operator=()

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

default

Assignment operator.

Referenced by ~BasisKey().

SameExp()

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

inline

Determine if basis expansion x matches this.

Definition at line 168 of file Basis.h.

References Collocation(), ExactIprodInt(), Nektar::lhs, LIB_UTILITIES_EXPORT, m_basistype, m_nummodes, operator!=, Nektar::LibUtilities::BasisKey::opLess::operator()(), operator<, operator==, and Nektar::rhs.

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

SamePoints()

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

inline

Determine if quadrature of expansion x matches this.

Definition at line 162 of file Basis.h.

References m_pointsKey.

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

Friends And Related Function Documentation

operator!= [1/3]

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

friend

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

Referenced by SameExp().

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

operator!= [2/3]

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

friend

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

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

operator!= [3/3]

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

friend

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

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

operator<

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

friend

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

Referenced by Nektar::LibUtilities::Basis::Basis(), and SameExp().

        {
            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 871 of file Foundations/Basis.cpp.

Referenced by SameExp().

        {
            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 879 of file Foundations/Basis.cpp.

        {
            return (*x == y);
        }

operator== [3/3]

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

friend

Definition at line 885 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 194 of file Basis.h.

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

m_nummodes

int Nektar::LibUtilities::BasisKey::m_nummodes

protected

Expansion order.

Definition at line 193 of file Basis.h.

Referenced by GetNumModes(), GetTotNumModes(), Nektar::LibUtilities::operator<(), and SameExp().

m_pointsKey

PointsKey Nektar::LibUtilities::BasisKey::m_pointsKey

protected

Points specification.

Definition at line 195 of file Basis.h.

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