Nektar::LibUtilities::Points< DataT > Class Template Reference

Stores a set of points of datatype DataT, defined by a PointKey. More...

#include <Points.h>

Public Types
typedef DataT	DataType
typedef std::shared_ptr< NekMatrix< DataType > >	MatrixSharedPtrType

Public Member Functions
virtual	~Points ()
virtual void	Initialize (void)
unsigned int	GetPointsDim () const
unsigned int	GetNumPoints () const
unsigned int	GetTotNumPoints () const
PointsType	GetPointsType () const
const Array< OneD, const DataType > &	GetZ () const
const Array< OneD, const DataType > &	GetW () const
void	GetZW (Array< OneD, const DataType > &z, Array< OneD, const DataType > &w) const
const Array< OneD, const NekDouble > &	GetBaryWeights () const
void	GetPoints (Array< OneD, const DataType > &x) const
void	GetPoints (Array< OneD, const DataType > &x, Array< OneD, const DataType > &y) const
void	GetPoints (Array< OneD, const DataType > &x, Array< OneD, const DataType > &y, Array< OneD, const DataType > &z) const
const MatrixSharedPtrType &	GetD (Direction dir=xDir) const
virtual const MatrixSharedPtrType	GetI (const PointsKey &key)
virtual const MatrixSharedPtrType	GetI (const Array< OneD, const DataType > &x)
virtual const MatrixSharedPtrType	GetI (unsigned int, const Array< OneD, const DataType > &x)
virtual const MatrixSharedPtrType	GetI (const Array< OneD, const DataType > &x, const Array< OneD, const DataType > &y)
virtual const MatrixSharedPtrType	GetI (const Array< OneD, const DataType > &x, const Array< OneD, const DataType > &y, const Array< OneD, const DataType > &z)
virtual const MatrixSharedPtrType	GetGalerkinProjection (const PointsKey &pkey)

Protected Member Functions
virtual void	CalculatePoints ()
virtual void	CalculateWeights ()
virtual void	CalculateBaryWeights ()
	This function calculates the barycentric weights used for enhanced interpolation speed. More...
virtual void	CalculateDerivMatrix ()
	Points (const PointsKey &key)

Protected Attributes
PointsKey	m_pointsKey
	Points type for this points distributions. More...
Array< OneD, DataType >	m_points [3]
	Storage for the point locations, allowing for up to a 3D points storage. More...
Array< OneD, DataType >	m_weights
	Quadrature weights for the weights. More...
Array< OneD, DataType >	m_bcweights
	Barycentric weights. More...
MatrixSharedPtrType	m_derivmatrix [3]
	Derivative matrices. More...
NekManager< PointsKey, NekMatrix< DataType >, PointsKey::opLess >	m_InterpManager
NekManager< PointsKey, NekMatrix< DataType >, PointsKey::opLess >	m_GalerkinProjectionManager

Private Member Functions
	Points (const Points &pts)
	Points ()

Detailed Description

template<typename DataT>
class Nektar::LibUtilities::Points< DataT >

Stores a set of points of datatype DataT, defined by a PointKey.

This encapsulates a set of points, specified by a PointKey. The class stores not only the point coordinates, but also the integration weights and derivative matrix coefficients. Memory is allocated from the memory pool if in use.

Definition at line 253 of file Points.h.

Member Typedef Documentation

DataType

template<typename DataT >

typedef DataT Nektar::LibUtilities::Points< DataT >::DataType

Definition at line 256 of file Points.h.

MatrixSharedPtrType

template<typename DataT >

typedef std::shared_ptr<NekMatrix<DataType> > Nektar::LibUtilities::Points< DataT >::MatrixSharedPtrType

Definition at line 257 of file Points.h.

Constructor & Destructor Documentation

~Points()

template<typename DataT >

virtual Nektar::LibUtilities::Points< DataT >::~Points ( )

inlinevirtual

Definition at line 259 of file Points.h.

    {
    }

Points() [1/3]

template<typename DataT >

Nektar::LibUtilities::Points< DataT >::Points ( const PointsKey &  key )

inlineprotected

Definition at line 476 of file Points.h.

                                 : m_pointsKey(key)
    {
    }

Points() [2/3]

template<typename DataT >

Nektar::LibUtilities::Points< DataT >::Points ( const Points< DataT > &  pts )

inlineprivate

Definition at line 482 of file Points.h.

    {
        boost::ignore_unused(pts);
        NEKERROR(ErrorUtil::efatal,
                 "Copy Constructor for Points should not be called");
    }

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

Points() [3/3]

template<typename DataT >

Nektar::LibUtilities::Points< DataT >::Points ( )

inlineprivate

Definition at line 488 of file Points.h.

    {
        NEKERROR(ErrorUtil::efatal,
                 "Default Constructor for Points should not be called");
    }

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

Member Function Documentation

CalculateBaryWeights()

template<typename DataT >

virtual void Nektar::LibUtilities::Points< DataT >::CalculateBaryWeights ( )

inlineprotectedvirtual

This function calculates the barycentric weights used for enhanced interpolation speed.

For the points distribution \( z_i \) with \f% 1\leq z_i \leq N

Definition at line 442 of file Points.h.

    {
        const unsigned int totNumPoints = m_pointsKey.GetNumPoints();
        m_bcweights = Array<OneD, DataType>(totNumPoints, 1.0);
 
        Array<OneD, DataType> z = m_points[0];
 
        for (unsigned int i = 0; i < totNumPoints; ++i)
        {
            for (unsigned int j = 0; j < totNumPoints; ++j)
            {
                if (i == j)
                {
                    continue;
                }
 
                m_bcweights[i] *= (z[i] - z[j]);
            }
 
            m_bcweights[i] = 1.0 / m_bcweights[i];
        }
    }

References Nektar::LibUtilities::PointsKey::GetNumPoints(), Nektar::LibUtilities::Points< DataT >::m_bcweights, Nektar::LibUtilities::Points< DataT >::m_points, and Nektar::LibUtilities::Points< DataT >::m_pointsKey.

Referenced by Nektar::LibUtilities::Points< DataT >::Initialize().

CalculateDerivMatrix()

template<typename DataT >

virtual void Nektar::LibUtilities::Points< DataT >::CalculateDerivMatrix ( )

inlineprotectedvirtual

Reimplemented in Nektar::LibUtilities::PolyEPoints, Nektar::LibUtilities::NodalTriSPI, Nektar::LibUtilities::NodalTriFekete, Nektar::LibUtilities::NodalTriEvenlySpaced, Nektar::LibUtilities::NodalTriElec, Nektar::LibUtilities::NodalTetSPI, Nektar::LibUtilities::NodalTetEvenlySpaced, Nektar::LibUtilities::NodalTetElec, Nektar::LibUtilities::NodalQuadElec, Nektar::LibUtilities::NodalPrismSPI, Nektar::LibUtilities::NodalPrismEvenlySpaced, Nektar::LibUtilities::NodalPrismElec, Nektar::LibUtilities::NodalHexElec, Nektar::LibUtilities::GaussPoints, Nektar::LibUtilities::FourierSingleModePoints, Nektar::LibUtilities::FourierPoints, and Nektar::LibUtilities::BLPoints.

Definition at line 465 of file Points.h.

    {
        int totNumPoints = GetTotNumPoints();
        for (unsigned int i = 0; i < m_pointsKey.GetPointsDim(); ++i)
        {
            m_derivmatrix[i] =
                MemoryManager<NekMatrix<DataType>>::AllocateSharedPtr(
                    totNumPoints, totNumPoints);
        }
    }

References Nektar::LibUtilities::PointsKey::GetPointsDim(), Nektar::LibUtilities::Points< DataT >::GetTotNumPoints(), Nektar::LibUtilities::Points< DataT >::m_derivmatrix, and Nektar::LibUtilities::Points< DataT >::m_pointsKey.

Referenced by Nektar::LibUtilities::BLPoints::CalculateDerivMatrix(), Nektar::LibUtilities::FourierPoints::CalculateDerivMatrix(), Nektar::LibUtilities::FourierSingleModePoints::CalculateDerivMatrix(), and Nektar::LibUtilities::Points< DataT >::Initialize().

CalculatePoints()

template<typename DataT >

virtual void Nektar::LibUtilities::Points< DataT >::CalculatePoints ( )

inlineprotectedvirtual

Reimplemented in Nektar::LibUtilities::PolyEPoints, Nektar::LibUtilities::NodalTriSPI, Nektar::LibUtilities::NodalTriFekete, Nektar::LibUtilities::NodalTriEvenlySpaced, Nektar::LibUtilities::NodalTriElec, Nektar::LibUtilities::NodalTetSPI, Nektar::LibUtilities::NodalTetEvenlySpaced, Nektar::LibUtilities::NodalTetElec, Nektar::LibUtilities::NodalQuadElec, Nektar::LibUtilities::NodalPrismSPI, Nektar::LibUtilities::NodalPrismEvenlySpaced, Nektar::LibUtilities::NodalPrismElec, Nektar::LibUtilities::NodalHexElec, Nektar::LibUtilities::GaussPoints, Nektar::LibUtilities::FourierSingleModePoints, Nektar::LibUtilities::FourierPoints, and Nektar::LibUtilities::BLPoints.

Definition at line 415 of file Points.h.

    {
        unsigned int pointsDim    = GetPointsDim();
        unsigned int totNumPoints = GetTotNumPoints();
 
        for (unsigned int i = 0; i < pointsDim; ++i)
        {
            m_points[i] = Array<OneD, DataType>(totNumPoints);
        }
    }

References Nektar::LibUtilities::Points< DataT >::GetPointsDim(), Nektar::LibUtilities::Points< DataT >::GetTotNumPoints(), and Nektar::LibUtilities::Points< DataT >::m_points.

Referenced by Nektar::LibUtilities::NodalTetElec::CalculatePoints(), and Nektar::LibUtilities::Points< DataT >::Initialize().

CalculateWeights()

template<typename DataT >

virtual void Nektar::LibUtilities::Points< DataT >::CalculateWeights ( )

inlineprotectedvirtual

Reimplemented in Nektar::LibUtilities::PolyEPoints, Nektar::LibUtilities::NodalTriSPI, Nektar::LibUtilities::NodalTriFekete, Nektar::LibUtilities::NodalTriEvenlySpaced, Nektar::LibUtilities::NodalTriElec, Nektar::LibUtilities::NodalTetSPI, Nektar::LibUtilities::NodalTetEvenlySpaced, Nektar::LibUtilities::NodalTetElec, Nektar::LibUtilities::NodalQuadElec, Nektar::LibUtilities::NodalPrismSPI, Nektar::LibUtilities::NodalPrismEvenlySpaced, Nektar::LibUtilities::NodalPrismElec, Nektar::LibUtilities::NodalHexElec, Nektar::LibUtilities::GaussPoints, Nektar::LibUtilities::FourierSingleModePoints, Nektar::LibUtilities::FourierPoints, and Nektar::LibUtilities::BLPoints.

Definition at line 426 of file Points.h.

    {
        m_weights = Array<OneD, DataType>(GetTotNumPoints());
    }

References Nektar::LibUtilities::Points< DataT >::GetTotNumPoints(), and Nektar::LibUtilities::Points< DataT >::m_weights.

Referenced by Nektar::LibUtilities::Points< DataT >::Initialize().

GetBaryWeights()

template<typename DataT >

const Array<OneD, const NekDouble>& Nektar::LibUtilities::Points< DataT >::GetBaryWeights ( ) const

inline

Definition at line 308 of file Points.h.

    {
        return m_bcweights;
    }

References Nektar::LibUtilities::Points< DataT >::m_bcweights.

GetD()

template<typename DataT >

const MatrixSharedPtrType& Nektar::LibUtilities::Points< DataT >::GetD ( Direction  dir = xDir ) const

inline

Definition at line 334 of file Points.h.

    {
        return m_derivmatrix[(int)dir];
    }

References Nektar::LibUtilities::Points< DataT >::m_derivmatrix.

GetGalerkinProjection()

template<typename DataT >

virtual const MatrixSharedPtrType Nektar::LibUtilities::Points< DataT >::GetGalerkinProjection ( const PointsKey &  pkey )

inlinevirtual

Reimplemented in Nektar::LibUtilities::GaussPoints.

Definition at line 388 of file Points.h.

    {
        boost::ignore_unused(pkey);
        NEKERROR(ErrorUtil::efatal, "Method not implemented ");
        std::shared_ptr<NekMatrix<NekDouble>> returnval(
            MemoryManager<NekMatrix<NekDouble>>::AllocateSharedPtr());
        return returnval;
    }

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

GetI() [1/5]

template<typename DataT >

virtual const MatrixSharedPtrType Nektar::LibUtilities::Points< DataT >::GetI ( const Array< OneD, const DataType > &  x )

inlinevirtual

Reimplemented in Nektar::LibUtilities::PolyEPoints, Nektar::LibUtilities::GaussPoints, Nektar::LibUtilities::FourierSingleModePoints, Nektar::LibUtilities::FourierPoints, and Nektar::LibUtilities::BLPoints.

Definition at line 348 of file Points.h.

    {
        boost::ignore_unused(x);
        NEKERROR(ErrorUtil::efatal, "Method not implemented");
        std::shared_ptr<NekMatrix<NekDouble>> returnval(
            MemoryManager<NekMatrix<NekDouble>>::AllocateSharedPtr());
        return returnval;
    }

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

GetI() [2/5]

template<typename DataT >

virtual const MatrixSharedPtrType Nektar::LibUtilities::Points< DataT >::GetI ( const Array< OneD, const DataType > &  x, const Array< OneD, const DataType > &  y  )

inlinevirtual

Reimplemented in Nektar::LibUtilities::NodalTriFekete, Nektar::LibUtilities::NodalTriEvenlySpaced, and Nektar::LibUtilities::NodalTriElec.

Definition at line 367 of file Points.h.

    {
        boost::ignore_unused(x, y);
        NEKERROR(ErrorUtil::efatal, "Method not implemented");
        std::shared_ptr<NekMatrix<NekDouble>> returnval(
            MemoryManager<NekMatrix<NekDouble>>::AllocateSharedPtr());
        return returnval;
    }

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

GetI() [3/5]

template<typename DataT >

virtual const MatrixSharedPtrType Nektar::LibUtilities::Points< DataT >::GetI ( const Array< OneD, const DataType > &  x, const Array< OneD, const DataType > &  y, const Array< OneD, const DataType > &  z  )

inlinevirtual

Reimplemented in Nektar::LibUtilities::NodalTetEvenlySpaced, Nektar::LibUtilities::NodalTetElec, Nektar::LibUtilities::NodalPrismEvenlySpaced, and Nektar::LibUtilities::NodalPrismElec.

Definition at line 377 of file Points.h.

    {
        boost::ignore_unused(x, y, z);
        NEKERROR(ErrorUtil::efatal, "Method not implemented");
        std::shared_ptr<NekMatrix<NekDouble>> returnval(
            MemoryManager<NekMatrix<NekDouble>>::AllocateSharedPtr());
        return returnval;
    }

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

GetI() [4/5]

template<typename DataT >

virtual const MatrixSharedPtrType Nektar::LibUtilities::Points< DataT >::GetI ( const PointsKey &  key )

inlinevirtual

Reimplemented in Nektar::LibUtilities::PolyEPoints, Nektar::LibUtilities::NodalTriFekete, Nektar::LibUtilities::NodalTriEvenlySpaced, Nektar::LibUtilities::NodalTriElec, Nektar::LibUtilities::NodalTetEvenlySpaced, Nektar::LibUtilities::NodalTetElec, Nektar::LibUtilities::NodalPrismEvenlySpaced, Nektar::LibUtilities::NodalPrismElec, Nektar::LibUtilities::GaussPoints, Nektar::LibUtilities::FourierSingleModePoints, Nektar::LibUtilities::FourierPoints, and Nektar::LibUtilities::BLPoints.

Definition at line 339 of file Points.h.

    {
        boost::ignore_unused(key);
        NEKERROR(ErrorUtil::efatal, "Method not implemented ");
        std::shared_ptr<NekMatrix<NekDouble>> returnval(
            MemoryManager<NekMatrix<NekDouble>>::AllocateSharedPtr());
        return returnval;
    }

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

GetI() [5/5]

template<typename DataT >

virtual const MatrixSharedPtrType Nektar::LibUtilities::Points< DataT >::GetI ( unsigned int  , const Array< OneD, const DataType > &  x  )

inlinevirtual

Reimplemented in Nektar::LibUtilities::PolyEPoints, Nektar::LibUtilities::GaussPoints, Nektar::LibUtilities::FourierSingleModePoints, Nektar::LibUtilities::FourierPoints, and Nektar::LibUtilities::BLPoints.

Definition at line 357 of file Points.h.

    {
        boost::ignore_unused(x);
        NEKERROR(ErrorUtil::efatal, "Method not implemented");
        std::shared_ptr<NekMatrix<NekDouble>> returnval(
            MemoryManager<NekMatrix<NekDouble>>::AllocateSharedPtr());
        return returnval;
    }

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

GetNumPoints()

template<typename DataT >

unsigned int Nektar::LibUtilities::Points< DataT >::GetNumPoints ( ) const

inline

Definition at line 276 of file Points.h.

    {
        return m_pointsKey.GetNumPoints();
    }

References Nektar::LibUtilities::PointsKey::GetNumPoints(), and Nektar::LibUtilities::Points< DataT >::m_pointsKey.

GetPoints() [1/3]

template<typename DataT >

void Nektar::LibUtilities::Points< DataT >::GetPoints ( Array< OneD, const DataType > &  x ) const

inline

Definition at line 313 of file Points.h.

    {
        x = m_points[0];
    }

References Nektar::LibUtilities::Points< DataT >::m_points.

GetPoints() [2/3]

template<typename DataT >

void Nektar::LibUtilities::Points< DataT >::GetPoints ( Array< OneD, const DataType > &  x, Array< OneD, const DataType > &  y  ) const

inline

Definition at line 318 of file Points.h.

    {
        x = m_points[0];
        y = m_points[1];
    }

References Nektar::LibUtilities::Points< DataT >::m_points.

GetPoints() [3/3]

template<typename DataT >

void Nektar::LibUtilities::Points< DataT >::GetPoints ( Array< OneD, const DataType > &  x, Array< OneD, const DataType > &  y, Array< OneD, const DataType > &  z  ) const

inline

Definition at line 325 of file Points.h.

    {
        x = m_points[0];
        y = m_points[1];
        z = m_points[2];
    }

References Nektar::LibUtilities::Points< DataT >::m_points.

GetPointsDim()

template<typename DataT >

unsigned int Nektar::LibUtilities::Points< DataT >::GetPointsDim ( ) const

inline

Definition at line 271 of file Points.h.

    {
        return m_pointsKey.GetPointsDim();
    }

References Nektar::LibUtilities::PointsKey::GetPointsDim(), and Nektar::LibUtilities::Points< DataT >::m_pointsKey.

Referenced by Nektar::LibUtilities::Points< DataT >::CalculatePoints().

GetPointsType()

template<typename DataT >

PointsType Nektar::LibUtilities::Points< DataT >::GetPointsType ( ) const

inline

Definition at line 286 of file Points.h.

    {
        return m_pointsKey.GetPointsType();
    }

References Nektar::LibUtilities::PointsKey::GetPointsType(), and Nektar::LibUtilities::Points< DataT >::m_pointsKey.

GetTotNumPoints()

template<typename DataT >

unsigned int Nektar::LibUtilities::Points< DataT >::GetTotNumPoints ( ) const

inline

Definition at line 281 of file Points.h.

    {
        return m_pointsKey.GetTotNumPoints();
    }

References Nektar::LibUtilities::PointsKey::GetTotNumPoints(), and Nektar::LibUtilities::Points< DataT >::m_pointsKey.

Referenced by Nektar::LibUtilities::Points< DataT >::CalculateDerivMatrix(), Nektar::LibUtilities::Points< DataT >::CalculatePoints(), and Nektar::LibUtilities::Points< DataT >::CalculateWeights().

GetW()

template<typename DataT >

const Array<OneD, const DataType>& Nektar::LibUtilities::Points< DataT >::GetW ( ) const

inline

Definition at line 296 of file Points.h.

    {
        return m_weights;
    }

References Nektar::LibUtilities::Points< DataT >::m_weights.

GetZ()

template<typename DataT >

const Array<OneD, const DataType>& Nektar::LibUtilities::Points< DataT >::GetZ ( ) const

inline

Definition at line 291 of file Points.h.

    {
        return m_points[0];
    }

References Nektar::LibUtilities::Points< DataT >::m_points.

GetZW()

template<typename DataT >

void Nektar::LibUtilities::Points< DataT >::GetZW ( Array< OneD, const DataType > &  z, Array< OneD, const DataType > &  w  ) const

inline

Definition at line 301 of file Points.h.

    {
        z = m_points[0];
        w = m_weights;
    }

References Nektar::LibUtilities::Points< DataT >::m_points, and Nektar::LibUtilities::Points< DataT >::m_weights.

Initialize()

template<typename DataT >

virtual void Nektar::LibUtilities::Points< DataT >::Initialize ( void  )

inlinevirtual

Definition at line 263 of file Points.h.

    {
        CalculatePoints();
        CalculateWeights();
        CalculateBaryWeights();
        CalculateDerivMatrix();
    }

References Nektar::LibUtilities::Points< DataT >::CalculateBaryWeights(), Nektar::LibUtilities::Points< DataT >::CalculateDerivMatrix(), Nektar::LibUtilities::Points< DataT >::CalculatePoints(), and Nektar::LibUtilities::Points< DataT >::CalculateWeights().

Member Data Documentation

m_bcweights

template<typename DataT >

Array<OneD, DataType> Nektar::LibUtilities::Points< DataT >::m_bcweights

protected

Barycentric weights.

Definition at line 407 of file Points.h.

Referenced by Nektar::LibUtilities::Points< DataT >::CalculateBaryWeights(), and Nektar::LibUtilities::Points< DataT >::GetBaryWeights().

m_derivmatrix

template<typename DataT >

MatrixSharedPtrType Nektar::LibUtilities::Points< DataT >::m_derivmatrix[3]

protected

Derivative matrices.

Definition at line 409 of file Points.h.

Referenced by Nektar::LibUtilities::Points< DataT >::CalculateDerivMatrix(), and Nektar::LibUtilities::Points< DataT >::GetD().

m_GalerkinProjectionManager

template<typename DataT >

NekManager<PointsKey, NekMatrix<DataType>, PointsKey::opLess> Nektar::LibUtilities::Points< DataT >::m_GalerkinProjectionManager

protected

Definition at line 413 of file Points.h.

m_InterpManager

template<typename DataT >

NekManager<PointsKey, NekMatrix<DataType>, PointsKey::opLess> Nektar::LibUtilities::Points< DataT >::m_InterpManager

protected

Definition at line 411 of file Points.h.

m_points

template<typename DataT >

Array<OneD, DataType> Nektar::LibUtilities::Points< DataT >::m_points[3]

protected

Storage for the point locations, allowing for up to a 3D points storage.

Definition at line 403 of file Points.h.

Referenced by Nektar::LibUtilities::Points< DataT >::CalculateBaryWeights(), Nektar::LibUtilities::Points< DataT >::CalculatePoints(), Nektar::LibUtilities::Points< DataT >::GetPoints(), Nektar::LibUtilities::Points< DataT >::GetZ(), and Nektar::LibUtilities::Points< DataT >::GetZW().

m_pointsKey

template<typename DataT >

PointsKey Nektar::LibUtilities::Points< DataT >::m_pointsKey

protected

Points type for this points distributions.

Definition at line 400 of file Points.h.

Referenced by Nektar::LibUtilities::Points< DataT >::CalculateBaryWeights(), Nektar::LibUtilities::Points< DataT >::CalculateDerivMatrix(), Nektar::LibUtilities::Points< DataT >::GetNumPoints(), Nektar::LibUtilities::Points< DataT >::GetPointsDim(), Nektar::LibUtilities::Points< DataT >::GetPointsType(), and Nektar::LibUtilities::Points< DataT >::GetTotNumPoints().

m_weights

template<typename DataT >

Array<OneD, DataType> Nektar::LibUtilities::Points< DataT >::m_weights

protected

Quadrature weights for the weights.

Definition at line 405 of file Points.h.

Referenced by Nektar::LibUtilities::Points< DataT >::CalculateWeights(), Nektar::LibUtilities::Points< DataT >::GetW(), and Nektar::LibUtilities::Points< DataT >::GetZW().