dune-fem 2.8-git
Public Types | Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
Dune::Fem::Quadrature< FieldImp, dim, QuadratureTraits > Class Template Reference

actual interface class for quadratures More...

#include <dune/fem/quadrature/quadrature.hh>

Inheritance diagram for Dune::Fem::Quadrature< FieldImp, dim, QuadratureTraits >:
Inheritance graph

Public Types

enum  { codimension = 0 }
 to be revised, look at caching quad More...
 
typedef FieldImp FieldType
 
typedef QuadratureTraits< FieldType, dimensionTraits
 
typedef BaseType::IntegrationPointListStorageType IntegrationPointListStorageType
 
typedef Traits::IntegrationPointListType IntegrationPointListType
 type of the implementation (this must actually be a quadrature implementation) More...
 
typedef IntegrationPointListType::CoordinateType CoordinateType
 type of local coordinate vectors More...
 
typedef Traits::QuadratureKeyType QuadratureKeyType
 type of key to identify the quadrature More...
 
enum  
 
enum  
 to be revised, look at caching quad More...
 
typedef QuadraturePointWrapper< ThisTypeQuadraturePointWrapperType
 

Public Member Functions

 Quadrature (const GeometryType &geometryType, const QuadratureKeyType &key)
 create a quadrature for a given geometry and order More...
 
 Quadrature (const GeometryType &geometryType, const GeometryType &elementGeometry, const QuadratureKeyType &key)
 create a quadrature for a given geometry and order More...
 
 Quadrature (const IntegrationPointListType &ipList)
 create an integration point list from an implementation More...
 
 Quadrature (const IntegrationPointListStorageType &ipListPtr)
 create an integration point list from an implementation More...
 
 Quadrature (const Quadrature &org)
 copy constructor More...
 
const FieldTypeweight (size_t i) const
 obtain weight of i-th integration point More...
 
const QuadraturePointWrapperType operator[] (unsigned int i) const
 
const IntegrationPointListTypeipList () const
 obtain a reference the actual implementation More...
 
int nop () const
 obtain the number of integration points More...
 
const CoordinateTypepoint (size_t i) const
 obtain coordinates of i-th integration point More...
 
size_t id () const
 obtain the identifier of the integration point list More...
 
int order () const
 obtain order of the integration point list More...
 
GeometryType geometryType () const
 obtain GeometryType for this integration point list More...
 
auto interpolationPoints (const int reqDim) const
 returns list of element interpolation points for a given face quadrature More...
 
bool isFaceInterpolationQuadrature (const size_t numShapeFunctions) const
 return true if quadrature is also a set of interpolation points for the given shape functions More...
 

Static Public Attributes

static const unsigned int dimension = dim
 

Protected Attributes

IntegrationPointListStorageType ipListPtr_
 

Detailed Description

template<class FieldImp, int dim, template< class, int > class QuadratureTraits = DefaultQuadratureTraits>
class Dune::Fem::Quadrature< FieldImp, dim, QuadratureTraits >

actual interface class for quadratures

IntegrationPointList is a proxy for the actual implementations of the integration point lists. During construction, the IntegrationPointList object is configured with an appropriate implementation object from the QuadratureProvider (monostate pattern).

The design goal is minimization of construction time. The actual implementation can be created once and reused whenever it is needed. Moreover, this layout insulates the user from all initialization and storage stuff.

Note
The difference between integration point lists and quadratures is that quadratures have weights.

Member Typedef Documentation

◆ CoordinateType

template<class FieldImp , int dim, template< class, int > class QuadratureTraits = DefaultQuadratureTraits>
typedef IntegrationPointListType::CoordinateType Dune::Fem::Quadrature< FieldImp, dim, QuadratureTraits >::CoordinateType

type of local coordinate vectors

◆ FieldType

template<class FieldImp , int dim, template< class, int > class QuadratureTraits = DefaultQuadratureTraits>
typedef FieldImp Dune::Fem::Quadrature< FieldImp, dim, QuadratureTraits >::FieldType

◆ IntegrationPointListStorageType

template<class FieldImp , int dim, template< class, int > class QuadratureTraits = DefaultQuadratureTraits>
typedef BaseType::IntegrationPointListStorageType Dune::Fem::Quadrature< FieldImp, dim, QuadratureTraits >::IntegrationPointListStorageType

◆ IntegrationPointListType

template<class FieldImp , int dim, template< class, int > class QuadratureTraits = DefaultQuadratureTraits>
typedef Traits::IntegrationPointListType Dune::Fem::Quadrature< FieldImp, dim, QuadratureTraits >::IntegrationPointListType

type of the implementation (this must actually be a quadrature implementation)

◆ QuadratureKeyType

template<class FieldImp , int dim, template< class, int > class QuadratureTraits = DefaultQuadratureTraits>
typedef Traits::QuadratureKeyType Dune::Fem::Quadrature< FieldImp, dim, QuadratureTraits >::QuadratureKeyType

type of key to identify the quadrature

◆ QuadraturePointWrapperType

typedef QuadraturePointWrapper< ThisType > Dune::Fem::IntegrationPointList< FieldImp, dim, DefaultQuadratureTraits >::QuadraturePointWrapperType
inherited

◆ Traits

template<class FieldImp , int dim, template< class, int > class QuadratureTraits = DefaultQuadratureTraits>
typedef QuadratureTraits< FieldType, dimension > Dune::Fem::Quadrature< FieldImp, dim, QuadratureTraits >::Traits

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited

◆ anonymous enum

anonymous enum
inherited

to be revised, look at caching quad

◆ anonymous enum

template<class FieldImp , int dim, template< class, int > class QuadratureTraits = DefaultQuadratureTraits>
anonymous enum

to be revised, look at caching quad

Enumerator
codimension 

Constructor & Destructor Documentation

◆ Quadrature() [1/5]

template<class FieldImp , int dim, template< class, int > class QuadratureTraits = DefaultQuadratureTraits>
Dune::Fem::Quadrature< FieldImp, dim, QuadratureTraits >::Quadrature ( const GeometryType &  geometryType,
const QuadratureKeyType key 
)
inline

create a quadrature for a given geometry and order

This constructor creates a quadrature for the specified geometry which is capable of integrating polynoms up the given order exactly.

Note
The order of the quadrature may be higher than the requested one.
Parameters
[in]geometryTypegeometry type of the requested quadrature
[in]keykey to identify the quadrature (default = order)

◆ Quadrature() [2/5]

template<class FieldImp , int dim, template< class, int > class QuadratureTraits = DefaultQuadratureTraits>
Dune::Fem::Quadrature< FieldImp, dim, QuadratureTraits >::Quadrature ( const GeometryType &  geometryType,
const GeometryType &  elementGeometry,
const QuadratureKeyType key 
)
inline

create a quadrature for a given geometry and order

This constructor creates a quadrature for the specified geometry which is capable of integrating polynoms up the given order exactly.

Note
The order of the quadrature may be higher than the requested one.
Parameters
[in]geometryTypegeometry type of the requested quadrature
[in]elementGeometrygeometry type of element that resulting quadrature is used for (in case of face quadratures)
[in]keykey to identify the quadrature (default = order)
Note
This is a specialized constructor for constructing face quadratures for UGGrid.

◆ Quadrature() [3/5]

template<class FieldImp , int dim, template< class, int > class QuadratureTraits = DefaultQuadratureTraits>
Dune::Fem::Quadrature< FieldImp, dim, QuadratureTraits >::Quadrature ( const IntegrationPointListType ipList)
inlineexplicit

create an integration point list from an implementation

This constructor creates an integration point list from a given implementation.

Note
This constructor is provided mainly for testing purposes.
Parameters
[in]ipListimplementation of the integration point list

◆ Quadrature() [4/5]

template<class FieldImp , int dim, template< class, int > class QuadratureTraits = DefaultQuadratureTraits>
Dune::Fem::Quadrature< FieldImp, dim, QuadratureTraits >::Quadrature ( const IntegrationPointListStorageType ipListPtr)
inlineexplicit

create an integration point list from an implementation

This constructor creates an integration point list from a given implementation.

Note
This constructor is provided mainly for agglomeration quadratures.
Parameters
[in]ipListPtrshared_ptr of implementation of the integration point list

◆ Quadrature() [5/5]

template<class FieldImp , int dim, template< class, int > class QuadratureTraits = DefaultQuadratureTraits>
Dune::Fem::Quadrature< FieldImp, dim, QuadratureTraits >::Quadrature ( const Quadrature< FieldImp, dim, QuadratureTraits > &  org)
inline

copy constructor

Parameters
[in]orgquadrature to be copied Copy constructor

Member Function Documentation

◆ geometryType()

GeometryType Dune::Fem::IntegrationPointList< FieldImp, dim, DefaultQuadratureTraits >::geometryType ( ) const
inlineinherited

obtain GeometryType for this integration point list

Integration point lists are specified in local coordinates, i.e., coordinates with respect to the reference element. Hence, each integration point list is only valid for one type of geometry, i.e., for one reference element. The type can be retrieved via this method.

Note
Calling this method yields a virtual function call, so do not call this method unnecessarily.
Returns
GeometryType for this integration point list

◆ id()

size_t Dune::Fem::IntegrationPointList< FieldImp, dim, DefaultQuadratureTraits >::id ( ) const
inlineinherited

obtain the identifier of the integration point list

The identifier of an integration point list must be globally unique. Even integration point lists for different dimensions must have different identifiers.

Note
Quadratures are considered distinct if they differ in one of the following points: geometry type, order, dimension or implementation.
Returns
globally unique identifier of the integration point list

◆ interpolationPoints()

auto Dune::Fem::IntegrationPointList< FieldImp, dim, DefaultQuadratureTraits >::interpolationPoints ( const int  reqDim) const
inlineinherited

returns list of element interpolation points for a given face quadrature

◆ ipList()

const IntegrationPointListType & Dune::Fem::IntegrationPointList< FieldImp, dim, DefaultQuadratureTraits >::ipList ( ) const
inlineinherited

obtain a reference the actual implementation

Returns
a reference to the implementation of this integration point list

◆ isFaceInterpolationQuadrature()

bool Dune::Fem::IntegrationPointList< FieldImp, dim, DefaultQuadratureTraits >::isFaceInterpolationQuadrature ( const size_t  numShapeFunctions) const
inlineinherited

return true if quadrature is also a set of interpolation points for the given shape functions

◆ nop()

int Dune::Fem::IntegrationPointList< FieldImp, dim, DefaultQuadratureTraits >::nop ( ) const
inlineinherited

obtain the number of integration points

Returns
number of integration points within this list

◆ operator[]()

const QuadraturePointWrapperType Dune::Fem::IntegrationPointList< FieldImp, dim, DefaultQuadratureTraits >::operator[] ( unsigned int  i) const
inlineinherited

◆ order()

int Dune::Fem::IntegrationPointList< FieldImp, dim, DefaultQuadratureTraits >::order ( ) const
inlineinherited

obtain order of the integration point list

The order of a quadrature is the maximal polynomial degree that is guaranteed to be integrated exactly by the quadrature.

In case of an integration point list, the definition of this value is left to the implementor.

Note
Calling this method yields a virtual function call, so do not call this method unnecessarily.
Returns
the order of the integration point list

◆ point()

const CoordinateType & Dune::Fem::IntegrationPointList< FieldImp, dim, DefaultQuadratureTraits >::point ( size_t  i) const
inlineinherited

obtain coordinates of i-th integration point

This method returns a reference to the coordinates of the i-th integration point for 0 <= i < nop(). The integration point is given in local coordinates, i.e., coordinates with respect to the reference element.

Parameters
[in]inumber of the integration point, 0 <= i < nop()
Returns
reference to i-th integration point

◆ weight()

template<class FieldImp , int dim, template< class, int > class QuadratureTraits = DefaultQuadratureTraits>
const FieldType & Dune::Fem::Quadrature< FieldImp, dim, QuadratureTraits >::weight ( size_t  i) const
inline

obtain weight of i-th integration point

This method returns the weight of the i-th integration point for 0 <= i < nop() within the quadrature.

Note
The integration point can be obtained via the point() method.
The quadrature weights sum up to the volume of the reference element.
Parameters
[in]inumber of the integration point, 0 <= i < nop()
Returns
weight of the i-th integration point

Member Data Documentation

◆ dimension

template<class FieldImp , int dim, template< class, int > class QuadratureTraits = DefaultQuadratureTraits>
const unsigned int Dune::Fem::Quadrature< FieldImp, dim, QuadratureTraits >::dimension = dim
static

◆ ipListPtr_


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