Dune Core Modules (2.8.0)

Function implementations

Concrete function implementations. More...

Classes

class  Dune::Functions::Polynomial< K >
 A scalar polynomial implementation. More...
 
class  Dune::Functions::TrigonometricFunction< K, sinFactor, cosFactor >
 A linear combination of trigonomic functions. More...
 
class  Dune::Functions::CallableFunctionWrapper< F >
 Wrap a Dune::VirtualFunction into a callable object. More...
 
class  Dune::Functions::DifferentiableFunctionFromCallables< Range(Domain), DerivativeTraits, F >
 Wrap a list of callable objects as derivative sequence modelling Concept::DifferentiableFunction<Range(Domain), DerivativeTraits> More...
 
class  Dune::Functions::DifferentiableFunctionFromCallables< Range(Domain), DerivativeTraits, F, DF, Derivatives... >
 Wrap a list of callable objects as derivative sequence modelling Concept::DifferentiableFunction<Range(Domain), DerivativeTraits> More...
 
class  Dune::Functions::AnalyticGridViewFunction< Range(Domain), GV, F, DerivativeTraits >
 Class wrapping any differentiable function as grid function. More...
 
class  Dune::Functions::DiscreteGlobalBasisFunction< B, V, NTRE, R >
 A grid function induced by a global basis and a coefficient vector. More...
 

Functions

template<class K , int sinFactor, int cosFactor>
TrigonometricFunction< K, -cosFactor, sinFactor > Dune::Functions::derivative (const TrigonometricFunction< K, sinFactor, cosFactor > &f)
 Obtain derivative of TrigonometricFunction function.
 
template<class F >
CallableFunctionWrapper< F > Dune::Functions::callable (const F &f)
 Create a callable object from some Dune::VirtualFunction. More...
 
template<class F >
CallableFunctionWrapper< F > Dune::Functions::callable (const std::shared_ptr< F > &fp)
 Create a callable object from std::shared_ptr<F> More...
 
template<class Signature , template< class > class DerivativeTraits, class... F>
DifferentiableFunctionFromCallables< Signature, DerivativeTraits, F... > Dune::Functions::makeDifferentiableFunctionFromCallables (const SignatureTag< Signature, DerivativeTraits > &signatureTag, F &&... f)
 Create a DifferentiableFunction from callables. More...
 
template<typename... TT>
void Dune::Functions::localFunction (DiscreteGlobalBasisFunction< TT... > &&t)=delete
 Construction of local functions from a temporary DiscreteGlobalBasisFunction (forbidden) More...
 

Detailed Description

Concrete function implementations.

Function Documentation

◆ callable() [1/2]

template<class F >
CallableFunctionWrapper< F > Dune::Functions::callable ( const F &  f)

Create a callable object from some Dune::VirtualFunction.

Template Parameters
FFunction type derived from Dune::VirtualFunction
Parameters
fThe function to be wrapper

The returned object will only be valid as long f is valid. You can e.g. do the following:

// Create some F derived from VirtualFunction<D,R>
F f;
// store callable directly
auto fc = callable(f);
// store callable through default wrapper
std::function<R(D)> stdF = callable(f)
CallableFunctionWrapper< F > callable(const F &f)
Create a callable object from some Dune::VirtualFunction.
Definition: callable.hh:105

◆ callable() [2/2]

template<class F >
CallableFunctionWrapper< F > Dune::Functions::callable ( const std::shared_ptr< F > &  fp)

Create a callable object from std::shared_ptr<F>

Template Parameters
FFunction type derived from Dune::VirtualFunction
Parameters
fpstd::shared_ptr<F> to the function to be wrapper

The returned object will share ownership of fp using a std::shared_ptr. You can e.g. do the following:

// Create some F derived from VirtualFunction<D,R>
auto f = make_shared<F>();
// store callable directly
auto f1 = callable(f);
// store callable through default wrapper
std::function<R(D)> f2 = callable(f)
// Create some F derived from VirtualFunction<D,R> and only store
// it in the callable wrapper
auto f3 = callable(make_shared<F>());

◆ localFunction()

template<typename... TT>
void Dune::Functions::localFunction ( DiscreteGlobalBasisFunction< TT... > &&  t)
delete

Construction of local functions from a temporary DiscreteGlobalBasisFunction (forbidden)

Since a DiscreteGlobalBasisFunction::LocalFunction stores a reference to the global DiscreteGlobalBasisFunction its life time is bound to the latter. Hence construction from a temporary DiscreteGlobalBasisFunction would lead to a dangling reference and is thus forbidden/deleted.

References Dune::Functions::istlVectorBackend().

◆ makeDifferentiableFunctionFromCallables()

template<class Signature , template< class > class DerivativeTraits, class... F>
DifferentiableFunctionFromCallables< Signature, DerivativeTraits, F... > Dune::Functions::makeDifferentiableFunctionFromCallables ( const SignatureTag< Signature, DerivativeTraits > &  signatureTag,
F &&...  f 
)

Create a DifferentiableFunction from callables.

This will return a wrapper modelling the DifferentiableFunction interface where the evaluation of the function and its derivatives are implemented by the given callable objects.

Parameters
signatureTagA dummy parameter to pass the signature and derivative traits
fCallable objects implementing the evaluation of the function and its derivatives
Returns
Object modelling DifferentiableFunction interface
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.111.3 (Nov 21, 23:30, 2024)