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) More... | |
| 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) More... | |
| typedef DFieldType | DomainFieldType |
| type of field the domain vector space, i.e. double More... | |
| typedef RFieldType | RangeFieldType |
| type of field the range vector space, i.e. double More... | |
Public Member Functions | |
| Mapping () | |
| create Mappiung with empty linear combination More... | |
| virtual | ~Mapping () |
| delete linear combination if necessary More... | |
| MappingType & | operator= (const MappingType &mapping) |
| assignment of mapping mapping More... | |
| void | operator() (const DomainType &arg, RangeType &dest) const |
| Application operator that applies all operators in the linear combination stack. More... | |
Protected Types | |
| typedef Mapping< DFieldType, RFieldType, DType, RType > | MappingType |
| type of mapping More... | |
Related Functions | |
(Note that these are not member functions.) | |
| 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 More... | |
| 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 More... | |
| 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 More... | |
| 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 More... | |
| 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 More... | |
| 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 More... | |
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 >
|
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 >
|
inline |
create Mappiung with empty linear combination
◆ ~Mapping()
template<typename DFieldType , typename RFieldType , class DType , class RType >
|
inlinevirtual |
delete linear combination if necessary
Member Function Documentation
◆ operator()()
template<typename DFieldType , typename RFieldType , class DType , class RType >
|
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 >
|
inline |
assignment of mapping mapping
- Parameters
-
[in] mapping which is copied
- Returns
- reference to mapping
Friends And Related Function Documentation
◆ operator*() [1/2]
template<class DFieldType , class RFieldType , class DType , class RType >
|
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*() [2/2]
template<class DFieldType , class RFieldType , class DType , class RType >
|
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+()
template<class DFieldType , class RFieldType , class DType , class RType >
|
related |
add two mappings
- Parameters
-
[in] a mapping 1 [in] b mapping 2
- Returns
- new object mapping
◆ operator-()
template<class DFieldType , class RFieldType , class DType , class RType >
|
related |
substract two mappings
- 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 >
|
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
◆ operator/() [2/2]
template<class DFieldType , class RFieldType , class DType , class RType >
|
related |
operator / for mappings
- 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:
