dune-fem 2.8.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Attributes | List of all members
Dune::Fem::Integrator< Quadrature > Class Template Reference

integrator for arbitrary functions providing evaluate More...

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

Public Types

typedef Quadrature QuadratureType
 type of quadrature to use
 
typedef QuadratureType::EntityType EntityType
 type of the entity
 

Public Member Functions

 Integrator (unsigned int order)
 constructor
 
template<class Function >
void integrateAdd (const EntityType &entity, const Function &function, typename Function ::RangeType &ret) const
 add the integral over an entity to a variable
 
template<class Function >
void integrate (const EntityType &entity, const Function &function, typename Function ::RangeType &ret) const
 integrate a function over an entity
 

Protected Attributes

const int order_
 

Detailed Description

template<class Quadrature>
class Dune::Fem::Integrator< Quadrature >

integrator for arbitrary functions providing evaluate

Parameters
Quadraturequadrature to use (either ElementQuadrature or CachingQuadrature)

Member Typedef Documentation

◆ EntityType

template<class Quadrature >
typedef QuadratureType::EntityType Dune::Fem::Integrator< Quadrature >::EntityType

type of the entity

◆ QuadratureType

template<class Quadrature >
typedef Quadrature Dune::Fem::Integrator< Quadrature >::QuadratureType

type of quadrature to use

Constructor & Destructor Documentation

◆ Integrator()

template<class Quadrature >
Dune::Fem::Integrator< Quadrature >::Integrator ( unsigned int  order)
inlineexplicit

constructor

Parameters
[in]orderpolynomial order for which the used quadrature shall be exact

Member Function Documentation

◆ integrate()

template<class Quadrature >
template<class Function >
void Dune::Fem::Integrator< Quadrature >::integrate ( const EntityType entity,
const Function function,
typename Function ::RangeType &  ret 
) const
inline

integrate a function over an entity

The function needs to have an evaluate method supporting wrapped quadrature points. The declaration should look as follows:

template< class Point >
evaluate( Point &x, RangeType &ret );
Note
The RangeType should be compatible with a Dune FieldVector.
Parameters
[in]entityentity to integrate over
[in]functionfunction to integrate
[out]retvalue of the integral

◆ integrateAdd()

template<class Quadrature >
template<class Function >
void Dune::Fem::Integrator< Quadrature >::integrateAdd ( const EntityType entity,
const Function function,
typename Function ::RangeType &  ret 
) const
inline

add the integral over an entity to a variable

The function needs to have an evaluate method supporting wrapped quadrature points. The declaration should look as follows:

template< class Point >
evaluate( Point &x, RangeType &ret );
Note
The RangeType should be compatible with a Dune FieldVector.
Parameters
[in]entityentity to integrate over
[in]functionfunction to integrate
retvariable to which the value of the integral is added

Member Data Documentation

◆ order_

template<class Quadrature >
const int Dune::Fem::Integrator< Quadrature >::order_
protected

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