A mapping from one vector space into another This class describes a general mapping from the domain vector space into the range vector space. It can also be used to construct linear combinations of mappings. More...

#include <dune/fem/operator/common/mapping.hh>

Inheritance diagram for Dune::Fem::Mapping< DFieldType, RFieldType, DType, RType >:

Public Types
typedef DType	DomainType
	domain vector space (for usage in derived classes) This can either be for example a discrete function (in case of operators) or a FieldVector (in case of discrete functions)

typedef RType	RangeType
	range vector space (for usage in derived classes) This can either be for example a discrete function (in case of operators) or a FieldVector (in case of discrete functions)

typedef DFieldType	DomainFieldType
	type of field the domain vector space, i.e. double

typedef RFieldType	RangeFieldType
	type of field the range vector space, i.e. double

Public Member Functions
	Mapping ()
	create Mappiung with empty linear combination

virtual	~Mapping ()
	delete linear combination if necessary

MappingType &	operator= (const MappingType &mapping)
	assignment of mapping mapping

void	operator() (const DomainType &arg, RangeType &dest) const
	Application operator that applies all operators in the linear combination stack.

Protected Types
typedef Mapping< DFieldType, RFieldType, DType, RType >	MappingType
	type of mapping

Friends
struct	MappingOperators

Related Symbols
(Note that these are not member symbols.)
template<class DFieldType , class RFieldType , class DType , class RType >
static Mapping< DFieldType, RFieldType, DType, RType >	operator+ (const Mapping< DFieldType, RFieldType, DType, RType > &a, const Mapping< DFieldType, RFieldType, DType, RType > &b)
	add two mappings

template<class DFieldType , class RFieldType , class DType , class RType >
static Mapping< DFieldType, RFieldType, DType, RType >	operator- (const Mapping< DFieldType, RFieldType, DType, RType > &a, const Mapping< DFieldType, RFieldType, DType, RType > &b)
	substract two mappings

template<class DFieldType , class RFieldType , class DType , class RType >
static Mapping< DFieldType, RFieldType, DType, RType >	operator* (const Mapping< DFieldType, RFieldType, DType, RType > &mapping, const RFieldType &factor)
	scale mapping with factor

template<class DFieldType , class RFieldType , class DType , class RType >
static Mapping< DFieldType, RFieldType, DType, RType >	operator* (const RFieldType &factor, const Mapping< DFieldType, RFieldType, DType, RType > &mapping)
	scale mapping with factor

template<class DFieldType , class RFieldType , class DType , class RType >
static Mapping< DFieldType, RFieldType, DType, RType >	operator/ (const Mapping< DFieldType, RFieldType, DType, RType > &mapping, const RFieldType &factor)
	operator / for mappings

template<class DFieldType , class RFieldType , class DType , class RType >
static Mapping< DFieldType, RFieldType, DType, RType >	operator/ (const RFieldType &factor, const Mapping< DFieldType, RFieldType, DType, RType > &mapping)
	operator / for mappings

Detailed Description

template<typename DFieldType, typename RFieldType, class DType, class RType>
class Dune::Fem::Mapping< DFieldType, RFieldType, DType, RType >

A mapping from one vector space into another This class describes a general mapping from the domain vector space into the range vector space. It can also be used to construct linear combinations of mappings.

This two-sided character has the following consequence: when you address an object of type mapping or any of its descendants through a reference or pointer of type Mapping, the linear combination defined for that mapping is evaluated. On the other hand, if you address through a reference of the type of any of its descendants (notably Operator and Function), you'll get the functionality specific for that type.

Note: The Domain type and Range type must have operator *=, operator +=, and operator -= (e.g. FieldVector and DiscreteFunction fit that interface).

Member Typedef Documentation

◆ DomainFieldType

template<typename DFieldType , typename RFieldType , class DType , class RType >

typedef DFieldType Dune::Fem::Mapping< DFieldType, RFieldType, DType, RType >::DomainFieldType

type of field the domain vector space, i.e. double

◆ DomainType

template<typename DFieldType , typename RFieldType , class DType , class RType >

typedef DType Dune::Fem::Mapping< DFieldType, RFieldType, DType, RType >::DomainType

domain vector space (for usage in derived classes) This can either be for example a discrete function (in case of operators) or a FieldVector (in case of discrete functions)

◆ MappingType

template<typename DFieldType , typename RFieldType , class DType , class RType >

typedef Mapping<DFieldType,RFieldType,DType,RType> Dune::Fem::Mapping< DFieldType, RFieldType, DType, RType >::MappingType

protected

type of mapping

◆ RangeFieldType

template<typename DFieldType , typename RFieldType , class DType , class RType >

typedef RFieldType Dune::Fem::Mapping< DFieldType, RFieldType, DType, RType >::RangeFieldType

type of field the range vector space, i.e. double

◆ RangeType

template<typename DFieldType , typename RFieldType , class DType , class RType >

typedef RType Dune::Fem::Mapping< DFieldType, RFieldType, DType, RType >::RangeType

range vector space (for usage in derived classes) This can either be for example a discrete function (in case of operators) or a FieldVector (in case of discrete functions)

Constructor & Destructor Documentation

◆ Mapping()

template<typename DFieldType , typename RFieldType , class DType , class RType >

Dune::Fem::Mapping< DFieldType, RFieldType, DType, RType >::Mapping ( )

inline

create Mappiung with empty linear combination

◆ ~Mapping()

template<typename DFieldType , typename RFieldType , class DType , class RType >

virtual Dune::Fem::Mapping< DFieldType, RFieldType, DType, RType >::~Mapping ( )

inlinevirtual

delete linear combination if necessary

Member Function Documentation

◆ operator()()

template<typename DFieldType , typename RFieldType , class DType , class RType >

void Dune::Fem::Mapping< DFieldType, RFieldType, DType, RType >::operator()	(	const DomainType &	arg,
		RangeType &	dest
	)		const

inline

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

Parameters

[in]	arg	argument
[out]	dest	destination

◆ operator=()

template<typename DFieldType , typename RFieldType , class DType , class RType >

MappingType & Dune::Fem::Mapping< DFieldType, RFieldType, DType, RType >::operator= ( const MappingType & mapping )

inline

assignment of mapping mapping

Parameters

[in] mapping which is copied

Returns: reference to mapping

Friends And Related Symbol Documentation

◆ MappingOperators

template<typename DFieldType , typename RFieldType , class DType , class RType >

friend struct MappingOperators

friend

◆ operator*() [1/2]

template<class DFieldType , class RFieldType , class DType , class RType >

static Mapping< DFieldType, RFieldType, DType, RType > operator*	(	const Mapping< DFieldType, RFieldType, DType, RType > &	mapping,
		const RFieldType &	factor
	)

Parameters

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

Returns: new object mapping

◆ operator*() [2/2]

template<class DFieldType , class RFieldType , class DType , class RType >

static Mapping< DFieldType, RFieldType, DType, RType > operator*	(	const RFieldType &	factor,
		const Mapping< DFieldType, RFieldType, DType, RType > &	mapping
	)

Parameters

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

Returns: new object mapping

◆ operator+()

template<class DFieldType , class RFieldType , class DType , class RType >

static Mapping< DFieldType, RFieldType, DType, RType > operator+	(	const Mapping< DFieldType, RFieldType, DType, RType > &	a,
		const Mapping< DFieldType, RFieldType, DType, RType > &	b
	)

Parameters

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

Returns: new object mapping

◆ operator-()

template<class DFieldType , class RFieldType , class DType , class RType >

static Mapping< DFieldType, RFieldType, DType, RType > operator-	(	const Mapping< DFieldType, RFieldType, DType, RType > &	a,
		const Mapping< DFieldType, RFieldType, DType, RType > &	b
	)

Parameters

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

Returns: new object mapping

◆ operator/() [1/2]

template<class DFieldType , class RFieldType , class DType , class RType >

static Mapping< DFieldType, RFieldType, DType, RType > operator/	(	const Mapping< DFieldType, RFieldType, DType, RType > &	mapping,
		const RFieldType &	factor
	)

Parameters

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

Returns: new object mapping

◆ operator/() [2/2]

template<class DFieldType , class RFieldType , class DType , class RType >

static Mapping< DFieldType, RFieldType, DType, RType > operator/	(	const RFieldType &	factor,
		const Mapping< DFieldType, RFieldType, DType, RType > &	mapping
	)

Parameters

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

Returns: new object mapping

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

mapping.hh

Public Types

Public Member Functions

Protected Types

Friends

Related Symbols

Detailed Description

Member Typedef Documentation

◆ DomainFieldType

◆ DomainType

◆ MappingType

◆ RangeFieldType

◆ RangeType

Constructor & Destructor Documentation

◆ Mapping()

◆ ~Mapping()

Member Function Documentation

◆ operator()()

◆ operator=()

Friends And Related Symbol Documentation

◆ MappingOperators

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator+()

◆ operator-()

◆ operator/() [1/2]

◆ operator/() [2/2]