DUNE PDELab (git)

Dune::Functions::ComposedGridFunction< OF, IF > Class Template Reference

Composition of grid functions with another function. More...

#include <dune/functions/gridfunctions/composedgridfunction.hh>

Public Member Functions

template<class OFT , class... IFT, disableCopyMove< ComposedGridFunction, OFT > = 0, std::enable_if_t<(sizeof...(IFT) > 0), int > = 0>
 ComposedGridFunction (OFT &&outerFunction, IFT &&... innerFunctions)
 Create ComposedGridFunction. More...
 
Range operator() (const Domain &x) const
 Evaluation of the composed grid function in coordinates x
 
const EntitySet & entitySet () const
 Return the EntitySet associated to this composed grid-function. More...
 

Friends

Traits::DerivativeInterface derivative (const ComposedGridFunction &t)
 Not implemented.
 
LocalFunction localFunction (const ComposedGridFunction &cgf)
 Create a local-function of this composed grid-function. More...
 

Related Functions

(Note that these are not member functions.)

template<class OF , class... IF>
auto makeComposedGridFunction (OF &&outerFunction, IF &&... innerFunction)
 Create a ComposedGridFunction that composes grid-functions with another function. More...
 

Detailed Description

template<class OF, class... IF>
class Dune::Functions::ComposedGridFunction< OF, IF >

Composition of grid functions with another function.

For given inner grid functions g0, ..., gn and an outer function f this creates a grid function representing f(g0(x), ..., gn(x)). The only assumption made, is that the range types of the inner functions can be passed to the outer ones, and that all grid functions are defined on the same EntitySet.

Notice that all functions are captured by value. To store references you can pass std::ref().

Template Parameters
OFType of outer function. std::reference_wrapper is supported.
IFTypes of inner outer functions. std::reference_wrapper is supported.

Constructor & Destructor Documentation

◆ ComposedGridFunction()

template<class OF , class... IF>
template<class OFT , class... IFT, disableCopyMove< ComposedGridFunction, OFT > = 0, std::enable_if_t<(sizeof...(IFT) > 0), int > = 0>
Dune::Functions::ComposedGridFunction< OF, IF >::ComposedGridFunction ( OFT &&  outerFunction,
IFT &&...  innerFunctions 
)
inline

Create ComposedGridFunction.

Outer and inner functions will be captured by value. To store references you can pass std::ref().

Parameters
outerFunctionThe outer function to be composed with the grid functions.
innerFunctionsThe inner grid functions

Member Function Documentation

◆ entitySet()

template<class OF , class... IF>
const EntitySet & Dune::Functions::ComposedGridFunction< OF, IF >::entitySet ( ) const
inline

Return the EntitySet associated to this composed grid-function.

It is implicitly assumed that all inner-functions can be bound to the same set of entities. Thus, the EntitySet is either of the EntitySets of the inner-function, e.g., the one from the first inner-function.

Requirements:

  • Number of inner-functions > 0

References Dune::resolveRef().

Friends And Related Function Documentation

◆ localFunction

template<class OF , class... IF>
LocalFunction localFunction ( const ComposedGridFunction< OF, IF > &  cgf)
friend

Create a local-function of this composed grid-function.

The LocalFunction is defined by composition of the outer-function with the corresponding local-functions of the inner-functions.


The documentation for this class was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.111.3 (Nov 24, 23:30, 2024)