dune-fem  2.4.1-rc
Public Types | Public Member Functions | Protected Attributes | List of all members
Dune::Fem::IntegrationPointList< FieldImp, dim, IntegrationTraits > Class Template Reference

actual interface class for integration point lists More...

#include </local/tomalk/somewhere/tmp/dune-fem/dune/fem/quadrature/quadrature.hh>

Inheritance diagram for Dune::Fem::IntegrationPointList< FieldImp, dim, IntegrationTraits >:
Inheritance graph

Public Types

enum  { dimension = dim }
 
enum  { codimension = 0 }
 to be revised, look at caching quad More...
 
typedef FieldImp FieldType
 
typedef Traits::IntegrationPointListType IntegrationPointListType
 type of integration point list implementation More...
 
typedef IntegrationPointListType::CoordinateType CoordinateType
 type of coordinate More...
 
typedef QuadraturePointWrapper< ThisTypeQuadraturePointWrapperType
 

Public Member Functions

 IntegrationPointList (const GeometryType &geometryType, int order)
 create a quadrature for a given geometry type and order More...
 
 IntegrationPointList (const GeometryType &geometryType, const GeometryType &elementGeometry, int order)
 create a quadrature for a given geometry type and order More...
 
 IntegrationPointList (const IntegrationPointListType &ipList)
 create an integration point list from an implementation More...
 
 IntegrationPointList (const IntegrationPointList &org)
 copy constructor 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...
 

Protected Attributes

const IntegrationPointListTypeipList_
 

Detailed Description

template<typename FieldImp, int dim, template< class, int > class IntegrationTraits>
class Dune::Fem::IntegrationPointList< FieldImp, dim, IntegrationTraits >

actual interface class for integration point lists

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

template<typename FieldImp, int dim, template< class, int > class IntegrationTraits>
typedef IntegrationPointListType :: CoordinateType Dune::Fem::IntegrationPointList< FieldImp, dim, IntegrationTraits >::CoordinateType

type of coordinate

template<typename FieldImp, int dim, template< class, int > class IntegrationTraits>
typedef FieldImp Dune::Fem::IntegrationPointList< FieldImp, dim, IntegrationTraits >::FieldType
template<typename FieldImp, int dim, template< class, int > class IntegrationTraits>
typedef Traits :: IntegrationPointListType Dune::Fem::IntegrationPointList< FieldImp, dim, IntegrationTraits >::IntegrationPointListType

type of integration point list implementation

template<typename FieldImp, int dim, template< class, int > class IntegrationTraits>
typedef QuadraturePointWrapper< ThisType > Dune::Fem::IntegrationPointList< FieldImp, dim, IntegrationTraits >::QuadraturePointWrapperType

Member Enumeration Documentation

template<typename FieldImp, int dim, template< class, int > class IntegrationTraits>
anonymous enum
Enumerator
dimension 
template<typename FieldImp, int dim, template< class, int > class IntegrationTraits>
anonymous enum

to be revised, look at caching quad

Enumerator
codimension 

Constructor & Destructor Documentation

template<typename FieldImp, int dim, template< class, int > class IntegrationTraits>
Dune::Fem::IntegrationPointList< FieldImp, dim, IntegrationTraits >::IntegrationPointList ( const GeometryType &  geometryType,
int  order 
)
inline

create a quadrature for a given geometry type 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]orderorder of the requested quadrature
template<typename FieldImp, int dim, template< class, int > class IntegrationTraits>
Dune::Fem::IntegrationPointList< FieldImp, dim, IntegrationTraits >::IntegrationPointList ( const GeometryType &  geometryType,
const GeometryType &  elementGeometry,
int  order 
)
inline

create a quadrature for a given geometry type 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]orderorder of the requested quadrature
template<typename FieldImp, int dim, template< class, int > class IntegrationTraits>
Dune::Fem::IntegrationPointList< FieldImp, dim, IntegrationTraits >::IntegrationPointList ( const IntegrationPointListType ipList)
inline

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
template<typename FieldImp, int dim, template< class, int > class IntegrationTraits>
Dune::Fem::IntegrationPointList< FieldImp, dim, IntegrationTraits >::IntegrationPointList ( const IntegrationPointList< FieldImp, dim, IntegrationTraits > &  org)
inline

copy constructor

Parameters
[in]orgintegration point list to be copied

Member Function Documentation

template<typename FieldImp, int dim, template< class, int > class IntegrationTraits>
GeometryType Dune::Fem::IntegrationPointList< FieldImp, dim, IntegrationTraits >::geometryType ( ) const
inline

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

Referenced by Dune::Fem::QuadratureStorageRegistry::registerQuadrature().

template<typename FieldImp, int dim, template< class, int > class IntegrationTraits>
size_t Dune::Fem::IntegrationPointList< FieldImp, dim, IntegrationTraits >::id ( ) const
inline

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

Referenced by Dune::Fem::QuadratureStorageRegistry::registerQuadrature(), and Dune::Fem::CachingShapeFunctionSet< ShapeFunctionSet >::~CachingShapeFunctionSet().

template<typename FieldImp, int dim, template< class, int > class IntegrationTraits>
const IntegrationPointListType& Dune::Fem::IntegrationPointList< FieldImp, dim, IntegrationTraits >::ipList ( ) const
inline

obtain a reference the actual implementation

Returns
a reference to the implementation of this integration point list
template<typename FieldImp, int dim, template< class, int > class IntegrationTraits>
int Dune::Fem::IntegrationPointList< FieldImp, dim, IntegrationTraits >::nop ( ) const
inline
template<typename FieldImp, int dim, template< class, int > class IntegrationTraits>
const QuadraturePointWrapperType Dune::Fem::IntegrationPointList< FieldImp, dim, IntegrationTraits >::operator[] ( unsigned int  i) const
inline
template<typename FieldImp, int dim, template< class, int > class IntegrationTraits>
int Dune::Fem::IntegrationPointList< FieldImp, dim, IntegrationTraits >::order ( ) const
inline

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
template<typename FieldImp, int dim, template< class, int > class IntegrationTraits>
const CoordinateType& Dune::Fem::IntegrationPointList< FieldImp, dim, IntegrationTraits >::point ( size_t  i) const
inline

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

Referenced by Dune::Fem::LocalAverageHelper::applyQuadrature(), Dune::Fem::QuadraturePointWrapper< Quadrature >::coordinate(), Dune::Fem::Integrator< Quadrature >::integrateAdd(), and Dune::Fem::CachingShapeFunctionSet< ShapeFunctionSet >::jacobianCache().

Member Data Documentation

template<typename FieldImp, int dim, template< class, int > class IntegrationTraits>
const IntegrationPointListType& Dune::Fem::IntegrationPointList< FieldImp, dim, IntegrationTraits >::ipList_
protected

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