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. More...
	PointsKey (const int &numpoints, const PointsType &pointstype, const NekDouble factor=NekConstants::kNekUnsetDouble)
	Constructor defining the number and distribution of points. More...
virtual	~PointsKey ()
	Destructor. More...
	PointsKey (const PointsKey &key)
	Copy constructor. More...
PointsKey &	operator= (const PointsKey &key)
unsigned int	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)
unsigned int	GetPointsDim () const
unsigned int	GetTotNumPoints () const

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

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 59 of file Points.h.

Constructor & Destructor Documentation

PointsKey() [1/3]

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

inline

Default constructor.

Definition at line 71 of file Points.h.

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

PointsKey() [2/3]

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

inline

Constructor defining the number and distribution of points.

Definition at line 79 of file Points.h.

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

~PointsKey()

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

inlinevirtual

Destructor.

Definition at line 88 of file Points.h.

                {
            }

PointsKey() [3/3]

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

inline

Copy constructor.

Definition at line 93 of file Points.h.

            {
                *this = key; // defer to assignment operator
            }

Member Function Documentation

GetFactor()

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

inline

Definition at line 117 of file Points.h.

References m_factor.

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

            {
                return m_factor;
            }

GetNumPoints()

unsigned int Nektar::LibUtilities::PointsKey::GetNumPoints ( ) const

inline

Definition at line 107 of file Points.h.

References m_numpoints.

Referenced by Nektar::LibUtilities::PolyEPoints::CalculateDerivMatrix(), Nektar::LibUtilities::FourierPoints::CalculateDerivMatrix(), Nektar::LibUtilities::GaussPoints::CalculateDerivMatrix(), Nektar::LibUtilities::GaussPoints::CalculateGalerkinProjectionMatrix(), Nektar::LibUtilities::PolyEPoints::CalculateInterpMatrix(), Nektar::LibUtilities::FourierPoints::CalculateInterpMatrix(), Nektar::LibUtilities::GaussPoints::CalculateInterpMatrix(), Nektar::LibUtilities::PolyEPoints::CalculatePoints(), Nektar::LibUtilities::FourierPoints::CalculatePoints(), Nektar::LibUtilities::FourierSingleModePoints::CalculatePoints(), Nektar::LibUtilities::BLPoints::CalculatePoints(), Nektar::LibUtilities::GaussPoints::CalculatePoints(), Nektar::LibUtilities::PolyEPoints::CalculateWeights(), Nektar::LibUtilities::FourierPoints::CalculateWeights(), Nektar::LibUtilities::FourierSingleModePoints::CalculateWeights(), Nektar::LibUtilities::FourierSingleModePoints::CreateMatrix(), Nektar::LibUtilities::BLPoints::CreateMatrix(), Nektar::LibUtilities::FourierPoints::CreateMatrix(), Nektar::LibUtilities::GaussPoints::CreateMatrix(), export_Points(), Nektar::LibUtilities::PolyEPoints::GetI(), Nektar::LibUtilities::BasisKey::GetNumPoints(), Nektar::LibUtilities::Interp1D(), Nektar::LibUtilities::Interp2D(), Nektar::LibUtilities::Interp3D(), Nektar::MultiRegions::LocTraceToTraceMap::InterpLocEdgesToTrace(), Nektar::MultiRegions::LocTraceToTraceMap::InterpLocFacesToTrace(), Nektar::LibUtilities::operator<<(), Nektar::LibUtilities::PhysGalerkinProject1D(), Nektar::LibUtilities::PhysGalerkinProject2D(), Nektar::LibUtilities::PhysGalerkinProject3D(), Nektar::MultiRegions::LocTraceToTraceMap::Setup2D(), Nektar::MultiRegions::LocTraceToTraceMap::Setup3D(), Nektar::LocalRegions::QuadExp::v_ComputeEdgeNormal(), Nektar::LocalRegions::TriExp::v_ComputeEdgeNormal(), and Nektar::LocalRegions::NodalTriExp::v_ComputeEdgeNormal().

            {
                return m_numpoints;
            }

GetPointsDim()

unsigned int Nektar::LibUtilities::PointsKey::GetPointsDim ( ) const

inline

Definition at line 150 of file Points.h.

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 Nektar::LibUtilities::Points< NekDouble >::CalculateDerivMatrix(), Nektar::LibUtilities::Points< NekDouble >::CalculatePoints(), export_Points(), Nektar::LibUtilities::FourierSingleModePoints::GetI(), Nektar::LibUtilities::FourierPoints::GetI(), Nektar::LibUtilities::GaussPoints::GetI(), Nektar::LibUtilities::BLPoints::GetI(), Nektar::LibUtilities::NodalTetElec::GetI(), Nektar::LibUtilities::NodalTriElec::GetI(), Nektar::LibUtilities::PolyEPoints::GetI(), Nektar::LibUtilities::NodalPrismElec::GetI(), Nektar::LibUtilities::NodalTriEvenlySpaced::GetI(), Nektar::LibUtilities::NodalPrismEvenlySpaced::GetI(), Nektar::LibUtilities::NodalTriFekete::GetI(), Nektar::LibUtilities::NodalTetEvenlySpaced::GetI(), Nektar::LibUtilities::Basis::GetI(), Nektar::NekMeshUtils::Line::MakeOrder(), Nektar::NekMeshUtils::Tetrahedron::MakeOrder(), Nektar::NekMeshUtils::Quadrilateral::MakeOrder(), Nektar::NekMeshUtils::Prism::MakeOrder(), Nektar::NekMeshUtils::Triangle::MakeOrder(), Nektar::NekMeshUtils::Hexahedron::MakeOrder(), and Nektar::NekMeshUtils::Face::MakeOrder().

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

GetPointsType()

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

inline

Definition at line 112 of file Points.h.

References m_pointstype.

Referenced by Nektar::LibUtilities::GaussPoints::CalculateDerivMatrix(), Nektar::LibUtilities::GaussPoints::CalculateInterpMatrix(), Nektar::LibUtilities::BLPoints::CalculatePoints(), Nektar::LibUtilities::GaussPoints::CalculatePoints(), Nektar::LocalRegions::NodalTriExp::CreateStdMatrix(), export_Points(), Nektar::LocalRegions::NodalTriExp::FwdTrans(), Nektar::LibUtilities::BasisKey::GetPointsType(), Nektar::StdRegions::StdNodalPrismExp::ModalToNodal(), Nektar::StdRegions::StdNodalTetExp::ModalToNodal(), Nektar::StdRegions::StdNodalTriExp::ModalToNodal(), Nektar::StdRegions::StdNodalTetExp::NodalToModal(), Nektar::StdRegions::StdNodalPrismExp::NodalToModal(), Nektar::StdRegions::StdNodalTriExp::NodalToModal(), Nektar::StdRegions::StdNodalTetExp::NodalToModalTranspose(), Nektar::StdRegions::StdNodalPrismExp::NodalToModalTranspose(), Nektar::StdRegions::StdNodalTriExp::NodalToModalTranspose(), Nektar::LibUtilities::operator<<(), Nektar::MultiRegions::LocTraceToTraceMap::Setup2D(), Nektar::MultiRegions::LocTraceToTraceMap::Setup3D(), Nektar::StdRegions::StdNodalTetExp::v_FwdTrans(), Nektar::StdRegions::StdNodalPrismExp::v_FwdTrans(), Nektar::StdRegions::StdNodalTriExp::v_FwdTrans(), Nektar::LocalRegions::NodalTriExp::v_GetLinStdExp(), and Nektar::LocalRegions::NodalTriExp::v_GetStdExp().

            {
                return m_pointstype;
            }

GetTotNumPoints()

unsigned int Nektar::LibUtilities::PointsKey::GetTotNumPoints ( ) const

inline

Definition at line 180 of file Points.h.

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, Nektar::lhs, LIB_UTILITIES_EXPORT, m_numpoints, m_pointstype, NEKERROR, Nektar::LibUtilities::PointsKey::opLess::operator()(), operator<, operator==(), and Nektar::rhs.

Referenced by Nektar::LibUtilities::GaussPoints::CalculateDerivMatrix(), Nektar::LibUtilities::Points< NekDouble >::CalculateDerivMatrix(), Nektar::LibUtilities::NodalTriElec::CalculatePoints(), Nektar::LibUtilities::NodalTriFekete::CalculatePoints(), Nektar::LibUtilities::NodalTetElec::CalculatePoints(), Nektar::LibUtilities::Points< NekDouble >::CalculatePoints(), Nektar::LibUtilities::Points< NekDouble >::CalculateWeights(), export_Points(), and Nektar::LibUtilities::BasisKey::GetTotNumPoints().

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

operator!=() [1/2]

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

inline

Definition at line 139 of file Points.h.

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

operator!=() [2/2]

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

inline

Definition at line 144 of file Points.h.

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

operator=()

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

inline

Definition at line 98 of file Points.h.

References m_factor, m_numpoints, and m_pointstype.

            {
                m_numpoints  = key.m_numpoints;
                m_pointstype = key.m_pointstype;
                m_factor     = key.m_factor;

                return *this;
            }

operator==() [1/2]

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

inline

Definition at line 122 of file Points.h.

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

Referenced by GetTotNumPoints().

            {

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

                return false;
            }

operator==() [2/2]

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

inline

Definition at line 134 of file Points.h.

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

Friends And Related Function Documentation

operator<

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

friend

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

Referenced by GetTotNumPoints().

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

            return false;
        }

operator==

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

friend

Definition at line 48 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 236 of file Points.h.

Referenced by GetFactor(), Nektar::LibUtilities::operator<(), operator=(), and operator==().

m_numpoints

unsigned int Nektar::LibUtilities::PointsKey::m_numpoints

protected

number of the points (as appropriately defined for PointsType)

Definition at line 234 of file Points.h.

Referenced by GetNumPoints(), GetTotNumPoints(), Nektar::LibUtilities::operator<(), operator=(), Nektar::LibUtilities::operator==(), and operator==().

m_pointstype

PointsType Nektar::LibUtilities::PointsKey::m_pointstype

protected

Type of Points.

Definition at line 235 of file Points.h.

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