dune-functions 2.9.0
Public Member Functions | Friends | List of all members
Dune::Functions::GridFunction< Range(Domain), ES, DerivativeTraits, bufferSize > Class Template Reference

Wrapper class for functions defined on a Grid. More...

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

Inheritance diagram for Dune::Functions::GridFunction< Range(Domain), ES, DerivativeTraits, bufferSize >:
Inheritance graph

Public Member Functions

template<class F , disableCopyMove< GridFunction, F > = 0>
 GridFunction (F &&f)
 Construct from function. More...
 
 GridFunction ()=default
 
Range operator() (const Domain &x) const
 Evaluation of wrapped function. More...
 
const EntitySet & entitySet () const
 Get associated EntitySet. More...
 

Friends

DerivativeInterface derivative (const GridFunction &t)
 Get derivative of wrapped function. More...
 
LocalFunctionInterface localFunction (const GridFunction &t)
 Get local function of wrapped function. More...
 

Detailed Description

template<class Range, class Domain, class ES, template< class > class DerivativeTraits, size_t bufferSize>
class Dune::Functions::GridFunction< Range(Domain), ES, DerivativeTraits, bufferSize >

Wrapper class for functions defined on a Grid.

Being defined on a grid means in particular that you can evaluate the function in local coordinates of a given entities of the grid. The set of the entities this function is defined on is given by an EntitySet.

This models the Concept::GridFunction<Range(Domain), EntitySet, DerivativeTraits> concept.

Constructor & Destructor Documentation

◆ GridFunction() [1/2]

template<class Range , class Domain , class ES , template< class > class DerivativeTraits, size_t bufferSize>
template<class F , disableCopyMove< GridFunction, F > = 0>
Dune::Functions::GridFunction< Range(Domain), ES, DerivativeTraits, bufferSize >::GridFunction ( F &&  f)
inline

Construct from function.

Template Parameters
FFunction type
Parameters
fFunction of type F

Requirements:

◆ GridFunction() [2/2]

template<class Range , class Domain , class ES , template< class > class DerivativeTraits, size_t bufferSize>
Dune::Functions::GridFunction< Range(Domain), ES, DerivativeTraits, bufferSize >::GridFunction ( )
default

Member Function Documentation

◆ entitySet()

template<class Range , class Domain , class ES , template< class > class DerivativeTraits, size_t bufferSize>
const EntitySet & Dune::Functions::GridFunction< Range(Domain), ES, DerivativeTraits, bufferSize >::entitySet ( ) const
inline

Get associated EntitySet.

The EntitySet is a range of grid entities the associated LocalFunction can be bound to.

◆ operator()()

template<class Range , class Domain , class ES , template< class > class DerivativeTraits, size_t bufferSize>
Range Dune::Functions::GridFunction< Range(Domain), ES, DerivativeTraits, bufferSize >::operator() ( const Domain &  x) const
inline

Evaluation of wrapped function.

Evaluate the wrapped function in global coordinates x.

Friends And Related Function Documentation

◆ derivative

template<class Range , class Domain , class ES , template< class > class DerivativeTraits, size_t bufferSize>
DerivativeInterface derivative ( const GridFunction< Range(Domain), ES, DerivativeTraits, bufferSize > &  t)
friend

Get derivative of wrapped function.

This is a free function that will be found by ADL.

The derivative is returned as GridFunction of a type specified in the GridFunctionTraits.

◆ localFunction

template<class Range , class Domain , class ES , template< class > class DerivativeTraits, size_t bufferSize>
LocalFunctionInterface localFunction ( const GridFunction< Range(Domain), ES, DerivativeTraits, bufferSize > &  t)
friend

Get local function of wrapped function.

This is a free function, to be found by ADL.

Notice that the returned LocalFunction can only be used after it has been bound to a proper local context.


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