NumLib::IntegrationGaussLegendrePyramid Class Reference

Detailed Description

Gauss-Legendre quadrature rule for pyramid.

Definition at line 15 of file IntegrationGaussLegendrePyramid.h.

#include <IntegrationGaussLegendrePyramid.h>

Public Member Functions
	IntegrationGaussLegendrePyramid (unsigned const order=2)
void	setIntegrationOrder (unsigned const order)
	Change the integration order.
unsigned	getIntegrationOrder () const
	return current integration order.
unsigned	getNumberOfPoints () const
	return the number of sampling points
MathLib::WeightedPoint	getWeightedPoint (unsigned const igp) const

Static Public Member Functions
static MathLib::WeightedPoint	getWeightedPoint (unsigned const order, unsigned const igp)
template<typename Method>
static MathLib::WeightedPoint	getWeightedPoint (unsigned const igp)
static unsigned	getNumberOfPoints (unsigned const order)

Private Attributes
unsigned	_order
unsigned	_n_sampl_pt {0}

Constructor & Destructor Documentation

IntegrationGaussLegendrePyramid()

NumLib::IntegrationGaussLegendrePyramid::IntegrationGaussLegendrePyramid ( unsigned const order = 2 )

inlineexplicit

Construct this object with the given integration order

Parameters

order

integration order (default 2)

Definition at line 23 of file IntegrationGaussLegendrePyramid.h.

        : _order(order)
    {
        this->setIntegrationOrder(order);
    }

References _order, and setIntegrationOrder().

Member Function Documentation

getIntegrationOrder()

unsigned NumLib::IntegrationGaussLegendrePyramid::getIntegrationOrder ( ) const

inline

return current integration order.

Definition at line 37 of file IntegrationGaussLegendrePyramid.h.

{ return _order; }

References _order.

Referenced by getWeightedPoint().

getNumberOfPoints() [1/2]

unsigned NumLib::IntegrationGaussLegendrePyramid::getNumberOfPoints ( ) const

inline

return the number of sampling points

Definition at line 39 of file IntegrationGaussLegendrePyramid.h.

{ return _n_sampl_pt; }

References _n_sampl_pt.

Referenced by setIntegrationOrder().

getNumberOfPoints() [2/2]

unsigned NumLib::IntegrationGaussLegendrePyramid::getNumberOfPoints ( unsigned const order )

inlinestatic

get the number of integration points

Parameters

order

the number of integration points

Returns

the number of points

Definition at line 92 of file IntegrationGaussLegendrePyramid.h.

    {
        // For the case of order = 4, it
        // causes `assertion `rank == num_nodes' failed`
        // in the SVD decomposition in the least square extrapolation.
        // Therefore for the case of order = 4, the rule of order 3 is used.
        switch (order)
        {
            case 1:
                return MathLib::GaussLegendrePyramid<1>::NPoints;
            case 2:
                return MathLib::GaussLegendrePyramid<2>::NPoints;
            case 3:
                return MathLib::GaussLegendrePyramid<3>::NPoints;
            case 4:
                return MathLib::GaussLegendrePyramid<3>::NPoints;
        }
        OGS_FATAL("Integration order {:d} not implemented for pyramids.",
                  order);
    }

References MathLib::GaussLegendrePyramid< ORDER >::NPoints, and OGS_FATAL.

getWeightedPoint() [1/3]

template<typename Method>

MathLib::WeightedPoint NumLib::IntegrationGaussLegendrePyramid::getWeightedPoint ( unsigned const igp )

inlinestatic

Definition at line 81 of file IntegrationGaussLegendrePyramid.h.

    {
        return MathLib::WeightedPoint(Method::X[igp], Method::W[igp]);
    }

getWeightedPoint() [2/3]

MathLib::WeightedPoint NumLib::IntegrationGaussLegendrePyramid::getWeightedPoint ( unsigned const igp ) const

inline

get coordinates of a integration point

Parameters

igp	The integration point index

Returns

a weighted point

Definition at line 46 of file IntegrationGaussLegendrePyramid.h.

    {
        return getWeightedPoint(getIntegrationOrder(), igp);
    }

References getIntegrationOrder(), and getWeightedPoint().

Referenced by getWeightedPoint(), and getWeightedPoint().

getWeightedPoint() [3/3]

MathLib::WeightedPoint NumLib::IntegrationGaussLegendrePyramid::getWeightedPoint ( unsigned const order, unsigned const igp )

inlinestatic

get coordinates of a integration point

Parameters

order	the number of integration points
igp	the sampling point id

Returns

weight

Definition at line 58 of file IntegrationGaussLegendrePyramid.h.

    {
        // For the case of order = 4, it
        // causes `assertion `rank == num_nodes' failed`
        // in the SVD decomposition in the least square extrapolation.
        // Therefore for the case of order = 4, the rule of order 3 is used.
        switch (order)
        {
            case 1:
                return getWeightedPoint<MathLib::GaussLegendrePyramid<1>>(igp);
            case 2:
                return getWeightedPoint<MathLib::GaussLegendrePyramid<2>>(igp);
            case 3:
                return getWeightedPoint<MathLib::GaussLegendrePyramid<3>>(igp);
            case 4:
                return getWeightedPoint<MathLib::GaussLegendrePyramid<3>>(igp);
        }
        OGS_FATAL("Integration order {:d} not implemented for pyramids.",
                  order);
    }

References getWeightedPoint(), and OGS_FATAL.

setIntegrationOrder()

void NumLib::IntegrationGaussLegendrePyramid::setIntegrationOrder ( unsigned const order )

inline

Change the integration order.

Definition at line 30 of file IntegrationGaussLegendrePyramid.h.

    {
        _order = order;
        _n_sampl_pt = getNumberOfPoints(_order);
    }

References _n_sampl_pt, _order, and getNumberOfPoints().

Referenced by IntegrationGaussLegendrePyramid().

Member Data Documentation

_n_sampl_pt

unsigned NumLib::IntegrationGaussLegendrePyramid::_n_sampl_pt {0}

private

Definition at line 115 of file IntegrationGaussLegendrePyramid.h.

{0};

Referenced by getNumberOfPoints(), and setIntegrationOrder().

_order

unsigned NumLib::IntegrationGaussLegendrePyramid::_order

private

Definition at line 114 of file IntegrationGaussLegendrePyramid.h.

Referenced by IntegrationGaussLegendrePyramid(), getIntegrationOrder(), and setIntegrationOrder().

---

The documentation for this class was generated from the following file:

• IntegrationGaussLegendrePyramid.h