Dune::LocalFiniteElement< LBT > Class Template Reference

Type erasure class storing a local finite element. More...

#include <dune/localfunctions/common/localfiniteelement.hh>

Public Member Functions
	LocalFiniteElement ()=default
	Default constructor. More...
template<class LFEImpl , Dune::disableCopyMove< LocalFiniteElement, LFEImpl > = 0>
	LocalFiniteElement (LFEImpl &&lfe)
	Construct from implementation. More...
	LocalFiniteElement (const LocalFiniteElement &other)
	Copy constructor. More...
	LocalFiniteElement (LocalFiniteElement &&other)=default
	Move constructor. More...
LocalFiniteElement &	operator= (const LocalFiniteElement &rhs)
	Copy assignment. More...
LocalFiniteElement &	operator= (LocalFiniteElement &&other)=default
	Move assignment. More...
	operator bool () const
	Check if the LocalFiniteElement is not empty. More...
const Traits::LocalBasisType &	localBasis () const
	Access the LocalBasis of the stored local finite element. More...
const Traits::LocalCoefficientsType &	localCoefficients () const
	Access the LocalCoefficients of the stored local finite element. More...
const Traits::LocalInterpolationType &	localInterpolation () const
	Access the LocalInterpolation of the stored local finite element. More...
unsigned int	size () const
	Get the number of basis functions of the stored local finite element. More...
const GeometryType &	type () const
	Get the GeometryType of the stored local finite element. More...

Detailed Description

template<class LBT>
class Dune::LocalFiniteElement< LBT >

Type erasure class storing a local finite element.

Template Parameters

LBT	A LocalBasisTraits class encoding the local basis signature.

In the flavor of std::function this class implements a type erased wrapper around local finite element implementations. One can either construct the wrapper directly with the local finite element that should be stored or construct and empty wrapper and assign it later. The type erasure is internally implemented using LocalFiniteElementVirtualInterface and LocalFiniteElementVirtualImp. In contrast to these, the LocalFiniteElement provides value-semantics and encapsulates dynamic memory management.

Constructor & Destructor Documentation

LocalFiniteElement() [1/4]

template<class LBT >

Dune::LocalFiniteElement< LBT >::LocalFiniteElement ( )

default

Default constructor.

The constructed wrapper is empty and can later be filled with a local finite element using the assignment operators.

LocalFiniteElement() [2/4]

template<class LBT >

template<class LFEImpl , Dune::disableCopyMove< LocalFiniteElement, LFEImpl > = 0>

Dune::LocalFiniteElement< LBT >::LocalFiniteElement ( LFEImpl &&  lfe )

inline

Construct from implementation.

Template Parameters

LFEImpl

LocalFiniteElement implementation type

Parameters

lfe	LocalFiniteElement implementation

Construct a LocalFiniteElement wrapper storing a copy of the given local finite element object.

LocalFiniteElement() [3/4]

template<class LBT >

Dune::LocalFiniteElement< LBT >::LocalFiniteElement ( const LocalFiniteElement< LBT > &  other )

inline

Copy constructor.

Parameters

other

The LocalFiniteElement to copy from

Depending of the state of the argument, the newly constructed LocalFiniteElement will either be empty or contain a copy of the local finite element stored in the LocalFiniteElement passed as constructor argument.

LocalFiniteElement() [4/4]

template<class LBT >

Dune::LocalFiniteElement< LBT >::LocalFiniteElement ( LocalFiniteElement< LBT > &&  other )

default

Move constructor.

Parameters

other

The LocalFiniteElement to move from

Depending of the state of the argument, the newly constructed LocalFiniteElement will either be empty or contain the local finite element that was originally stored in the LocalFiniteElement passed as constructor argument.

Member Function Documentation

localBasis()

template<class LBT >

const Traits::LocalBasisType & Dune::LocalFiniteElement< LBT >::localBasis ( ) const

inline

Access the LocalBasis of the stored local finite element.

Calling this method if the LocalFiniteElement is empty will invoke undefined behavior.

localCoefficients()

template<class LBT >

const Traits::LocalCoefficientsType & Dune::LocalFiniteElement< LBT >::localCoefficients ( ) const

inline

Access the LocalCoefficients of the stored local finite element.

Calling this method if the LocalFiniteElement is empty will invoke undefined behavior.

localInterpolation()

template<class LBT >

const Traits::LocalInterpolationType & Dune::LocalFiniteElement< LBT >::localInterpolation ( ) const

inline

Access the LocalInterpolation of the stored local finite element.

Calling this method if the LocalFiniteElement is empty will invoke undefined behavior.

operator bool()

template<class LBT >

Dune::LocalFiniteElement< LBT >::operator bool ( ) const

inline

Check if the LocalFiniteElement is not empty.

This method returns false if *this is empty and true otherwise

operator=() [1/2]

template<class LBT >

LocalFiniteElement & Dune::LocalFiniteElement< LBT >::operator= ( const LocalFiniteElement< LBT > &  rhs )

inline

Copy assignment.

Parameters

rhs	The LocalFiniteElement to assign from

This will first remove the stored local finite element. Then, depending of the state of the argument, *this will either be set to empty state or store a copy of the local finite element stored in the LocalFiniteElement passed as right hand side.

References Dune::LocalFiniteElement< LBT >::size(), and Dune::LocalFiniteElement< LBT >::type().

operator=() [2/2]

template<class LBT >

LocalFiniteElement & Dune::LocalFiniteElement< LBT >::operator= ( LocalFiniteElement< LBT > &&  other )

default

Move assignment.

Parameters

rhs	The LocalFiniteElement to assign from

This will first remove the stored local finite element. Then, depending of the state of the argument, *this will either be set to empty state or take over the local finite element stored in the LocalFiniteElement passed as right hand side. In any case the latter will be empty afterwards.

size()

template<class LBT >

unsigned int Dune::LocalFiniteElement< LBT >::size ( ) const

inline

Get the number of basis functions of the stored local finite element.

The result of this method is unspecified if the LocalFiniteElement is empty.

Referenced by Dune::LocalFiniteElement< LBT >::operator=().

type()

template<class LBT >

const GeometryType & Dune::LocalFiniteElement< LBT >::type ( ) const

inline

Get the GeometryType of the stored local finite element.

The result of this method is unspecified if the LocalFiniteElement is empty.

Referenced by Dune::LocalFiniteElement< LBT >::operator=().

---

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

• dune/localfunctions/common/localfiniteelement.hh