Dune::Fem::Function< FunctionSpaceImp, FunctionImp > Class Template Reference

Abstract class representing a function. More...

#include <dune/fem/function/common/function.hh>

Public Types
typedef FunctionSpaceImp	FunctionSpaceType
	type of function space this function belongs to
typedef FunctionImp	FunctionType
	type of the implementation (Barton-Nackman)
typedef FunctionSpaceType::DomainFieldType	DomainFieldType
	field type of domain
typedef FunctionSpaceType::RangeFieldType	RangeFieldType
	field type of range
typedef FunctionSpaceType::DomainType	DomainType
	domain type
typedef FunctionSpaceType::RangeType	RangeType
	range type
typedef FunctionSpaceType::JacobianRangeType	JacobianRangeType
	jacobian type
typedef FunctionSpaceType::HessianRangeType	HessianRangeType
	hessian type
typedef Mapping< DomainFieldType, RangeFieldType, DomainType, RangeType >	MappingType
	type of mapping base class

Public Member Functions
virtual	~Function ()
	destructor
virtual void	operator() (const DomainType &arg, RangeType &dest) const
	application operator call evaluate More...
void	evaluate (const DomainType &x, RangeType &value) const
	evaluate the function More...
void	jacobian (const DomainType &x, JacobianRangeType &jacobian) const
	evaluate the Jacobian of the function More...
void	hessian (const DomainType &x, HessianRangeType &hessian) const
	evaluate the hessian of the function More...
void	operator() (const DomainType &arg, RangeType &dest) const
	Application operator that applies all operators in the linear combination stack. More...

Protected Member Functions
	Function ()=default
	default constructor

Related Functions
(Note that these are not member functions.)
static Mapping< FunctionSpaceImp ::DomainFieldType, FunctionSpaceImp ::RangeFieldType, FunctionSpaceImp ::DomainType, FunctionSpaceImp ::RangeType >	operator+ (const Mapping< FunctionSpaceImp ::DomainFieldType, FunctionSpaceImp ::RangeFieldType, FunctionSpaceImp ::DomainType, FunctionSpaceImp ::RangeType > &a, const Mapping< FunctionSpaceImp ::DomainFieldType, FunctionSpaceImp ::RangeFieldType, FunctionSpaceImp ::DomainType, FunctionSpaceImp ::RangeType > &b)
	add two mappings More...
static Mapping< FunctionSpaceImp ::DomainFieldType, FunctionSpaceImp ::RangeFieldType, FunctionSpaceImp ::DomainType, FunctionSpaceImp ::RangeType >	operator- (const Mapping< FunctionSpaceImp ::DomainFieldType, FunctionSpaceImp ::RangeFieldType, FunctionSpaceImp ::DomainType, FunctionSpaceImp ::RangeType > &a, const Mapping< FunctionSpaceImp ::DomainFieldType, FunctionSpaceImp ::RangeFieldType, FunctionSpaceImp ::DomainType, FunctionSpaceImp ::RangeType > &b)
	substract two mappings More...
static Mapping< FunctionSpaceImp ::DomainFieldType, FunctionSpaceImp ::RangeFieldType, FunctionSpaceImp ::DomainType, FunctionSpaceImp ::RangeType >	operator* (const Mapping< FunctionSpaceImp ::DomainFieldType, FunctionSpaceImp ::RangeFieldType, FunctionSpaceImp ::DomainType, FunctionSpaceImp ::RangeType > &mapping, const FunctionSpaceImp ::RangeFieldType &factor)
	scale mapping with factor More...
static Mapping< FunctionSpaceImp ::DomainFieldType, FunctionSpaceImp ::RangeFieldType, FunctionSpaceImp ::DomainType, FunctionSpaceImp ::RangeType >	operator* (const FunctionSpaceImp ::RangeFieldType &factor, const Mapping< FunctionSpaceImp ::DomainFieldType, FunctionSpaceImp ::RangeFieldType, FunctionSpaceImp ::DomainType, FunctionSpaceImp ::RangeType > &mapping)
	scale mapping with factor More...
static Mapping< FunctionSpaceImp ::DomainFieldType, FunctionSpaceImp ::RangeFieldType, FunctionSpaceImp ::DomainType, FunctionSpaceImp ::RangeType >	operator/ (const Mapping< FunctionSpaceImp ::DomainFieldType, FunctionSpaceImp ::RangeFieldType, FunctionSpaceImp ::DomainType, FunctionSpaceImp ::RangeType > &mapping, const FunctionSpaceImp ::RangeFieldType &factor)
	operator / for mappings More...
static Mapping< FunctionSpaceImp ::DomainFieldType, FunctionSpaceImp ::RangeFieldType, FunctionSpaceImp ::DomainType, FunctionSpaceImp ::RangeType >	operator/ (const FunctionSpaceImp ::RangeFieldType &factor, const Mapping< FunctionSpaceImp ::DomainFieldType, FunctionSpaceImp ::RangeFieldType, FunctionSpaceImp ::DomainType, FunctionSpaceImp ::RangeType > &mapping)
	operator / for mappings More...

Detailed Description

template<class FunctionSpaceImp, class FunctionImp>
class Dune::Fem::Function< FunctionSpaceImp, FunctionImp >

Abstract class representing a function.

Template parameters are:

• FunctionSpaceImp type of the function space where the function belongs to.

• FunctionImp type of the implemented function (Barton-Nackman)

  An interface class:

Member Function Documentation

evaluate()

template<class FunctionSpaceImp , class FunctionImp >

void Dune::Fem::Function< FunctionSpaceImp, FunctionImp >::evaluate ( const DomainType &  x, RangeType &  value  ) const

inline

evaluate the function

Parameters

[in]	x	evaluation point
[out]	value	value of the function in x

References CHECK_AND_CALL_INTERFACE_IMPLEMENTATION, and Dune::Fem::Function< FunctionSpaceImp, FunctionImp >::evaluate().

Referenced by Dune::Fem::Function< FunctionSpaceImp, FunctionImp >::evaluate(), Dune::Fem::Integrator< Quadrature >::integrateAdd(), and Dune::Fem::Function< FunctionSpaceImp, FunctionImp >::operator()().

hessian()

template<class FunctionSpaceImp , class FunctionImp >

void Dune::Fem::Function< FunctionSpaceImp, FunctionImp >::hessian ( const DomainType &  x, HessianRangeType &  hessian  ) const

inline

evaluate the hessian of the function

Parameters

[in]	x	evaluation point
[out]	hessian	value of the hessian in x

References CHECK_AND_CALL_INTERFACE_IMPLEMENTATION, and Dune::Fem::Function< FunctionSpaceImp, FunctionImp >::hessian().

Referenced by Dune::Fem::Function< FunctionSpaceImp, FunctionImp >::hessian().

jacobian()

template<class FunctionSpaceImp , class FunctionImp >

void Dune::Fem::Function< FunctionSpaceImp, FunctionImp >::jacobian ( const DomainType &  x, JacobianRangeType &  jacobian  ) const

inline

evaluate the Jacobian of the function

Parameters

[in]	x	evaluation point
[out]	jacobian	value of the Jacobian in x

References CHECK_AND_CALL_INTERFACE_IMPLEMENTATION, and Dune::Fem::Function< FunctionSpaceImp, FunctionImp >::jacobian().

Referenced by Dune::Fem::Function< FunctionSpaceImp, FunctionImp >::jacobian().

operator()() [1/2]

template<class FunctionSpaceImp , class FunctionImp >

virtual void Dune::Fem::Function< FunctionSpaceImp, FunctionImp >::operator() ( const DomainType &  arg, RangeType &  dest  ) const

inlinevirtual

application operator call evaluate

Parameters

[in]	arg	argument
[out]	dest	destination, i.e. f(arg)

References Dune::Fem::Function< FunctionSpaceImp, FunctionImp >::evaluate().

operator()() [2/2]

void Dune::Fem::Mapping< FunctionSpaceImp ::DomainFieldType , FunctionSpaceImp ::RangeFieldType , FunctionSpaceImp ::DomainType , FunctionSpaceImp ::RangeType >::operator() ( const DomainType &  arg, RangeType &  dest  ) const

inlineinherited

Application operator that applies all operators in the linear combination stack.

Parameters

[in]	arg	argument
[out]	dest	destination

Friends And Related Function Documentation

operator*() [1/2]

static Mapping< FunctionSpaceImp ::DomainFieldType , FunctionSpaceImp ::RangeFieldType , FunctionSpaceImp ::DomainType , FunctionSpaceImp ::RangeType > operator* ( const FunctionSpaceImp ::RangeFieldType &  factor, const Mapping< FunctionSpaceImp ::DomainFieldType , FunctionSpaceImp ::RangeFieldType , FunctionSpaceImp ::DomainType , FunctionSpaceImp ::RangeType > &  mapping  )

related

scale mapping with factor

Parameters

[in]	factor	factor with which mapping is scaled
[in]	mapping	Mapping which is scaled

Returns

new object mapping

operator*() [2/2]

static Mapping< FunctionSpaceImp ::DomainFieldType , FunctionSpaceImp ::RangeFieldType , FunctionSpaceImp ::DomainType , FunctionSpaceImp ::RangeType > operator* ( const Mapping< FunctionSpaceImp ::DomainFieldType , FunctionSpaceImp ::RangeFieldType , FunctionSpaceImp ::DomainType , FunctionSpaceImp ::RangeType > &  mapping, const FunctionSpaceImp ::RangeFieldType &  factor  )

related

scale mapping with factor

Parameters

[in]	mapping	Mapping which is scaled
[in]	factor	factor with which mapping is scaled

Returns

new object mapping

operator+()

static Mapping< FunctionSpaceImp ::DomainFieldType , FunctionSpaceImp ::RangeFieldType , FunctionSpaceImp ::DomainType , FunctionSpaceImp ::RangeType > operator+ ( const Mapping< FunctionSpaceImp ::DomainFieldType , FunctionSpaceImp ::RangeFieldType , FunctionSpaceImp ::DomainType , FunctionSpaceImp ::RangeType > &  a, const Mapping< FunctionSpaceImp ::DomainFieldType , FunctionSpaceImp ::RangeFieldType , FunctionSpaceImp ::DomainType , FunctionSpaceImp ::RangeType > &  b  )

related

add two mappings

Parameters

[in]	a	mapping 1
[in]	b	mapping 2

Returns

new object mapping

operator-()

static Mapping< FunctionSpaceImp ::DomainFieldType , FunctionSpaceImp ::RangeFieldType , FunctionSpaceImp ::DomainType , FunctionSpaceImp ::RangeType > operator- ( const Mapping< FunctionSpaceImp ::DomainFieldType , FunctionSpaceImp ::RangeFieldType , FunctionSpaceImp ::DomainType , FunctionSpaceImp ::RangeType > &  a, const Mapping< FunctionSpaceImp ::DomainFieldType , FunctionSpaceImp ::RangeFieldType , FunctionSpaceImp ::DomainType , FunctionSpaceImp ::RangeType > &  b  )

related

substract two mappings

Parameters

[in]	a	mapping 1
[in]	b	mapping 2

Returns

new object mapping

operator/() [1/2]

static Mapping< FunctionSpaceImp ::DomainFieldType , FunctionSpaceImp ::RangeFieldType , FunctionSpaceImp ::DomainType , FunctionSpaceImp ::RangeType > operator/ ( const FunctionSpaceImp ::RangeFieldType &  factor, const Mapping< FunctionSpaceImp ::DomainFieldType , FunctionSpaceImp ::RangeFieldType , FunctionSpaceImp ::DomainType , FunctionSpaceImp ::RangeType > &  mapping  )

related

operator / for mappings

Parameters

[in]	factor	by which result of mapping is divided
[in]	mapping	which is divided

Returns

new object mapping

operator/() [2/2]

static Mapping< FunctionSpaceImp ::DomainFieldType , FunctionSpaceImp ::RangeFieldType , FunctionSpaceImp ::DomainType , FunctionSpaceImp ::RangeType > operator/ ( const Mapping< FunctionSpaceImp ::DomainFieldType , FunctionSpaceImp ::RangeFieldType , FunctionSpaceImp ::DomainType , FunctionSpaceImp ::RangeType > &  mapping, const FunctionSpaceImp ::RangeFieldType &  factor  )

related

operator / for mappings

Parameters

[in]	mapping	mapping which is divided
[in]	factor	f factor by which result of mapping is divided

Returns

new object mapping

---

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

• dune/fem/function/common/function.hh