DUNE-FEM (unstable)
LocalFunctionAdapter wrapped a class with a local evaluate method into a grid function. More...
#include <dune/fem/function/common/localfunctionadapter.hh>
Public Types | |
typedef LocalFunctionImpl | LocalFunctionImplType |
Evaluate class. | |
typedef BaseType::FunctionType | FunctionType |
type of function | |
typedef LocalFunctionAdapterTraits< LocalFunctionImplType > | Traits |
traits class | |
typedef Traits::GridPartType | GridPartType |
type of grid part | |
typedef Traits::DiscreteFunctionSpaceType | DiscreteFunctionSpaceType |
type of discrete function space | |
typedef Traits::GridType | GridType |
type of grid | |
typedef Traits::DomainFieldType | DomainFieldType |
domain type | |
typedef Traits::RangeFieldType | RangeFieldType |
range type | |
typedef Traits::DomainType | DomainType |
domain type | |
typedef Traits::RangeType | RangeType |
range type | |
typedef Traits::JacobianRangeType | JacobianRangeType |
jacobian type | |
typedef Traits::EntityType | EntityType |
type of codim 0 entity | |
typedef Traits::LocalFunctionType | LocalFunctionType |
type of local function to export | |
typedef LocalFunctionImpl::FunctionSpaceType | FunctionSpaceType |
type of function space this function belongs to | |
typedef FunctionSpaceType::HessianRangeType | HessianRangeType |
hessian type | |
typedef Mapping< DomainFieldType, RangeFieldType, DomainType, RangeType > | MappingType |
type of mapping base class | |
Public Member Functions | |
LocalFunctionAdapter (const std::string &name, LocalFunctionImplType &localFunctionImpl, const GridPartType &gridPart, unsigned int order=DiscreteFunctionSpaceType::polynomialOrder) | |
LocalFunctionAdapter (const std::string &name, const LocalFunctionImplType &localFunctionImpl, const GridPartType &gridPart, unsigned int order=DiscreteFunctionSpaceType::polynomialOrder) | |
constructor taking a const reference instance of the local function class | |
LocalFunctionAdapter (const std::string &name, LocalFunctionImplType &&localFunctionImpl, const GridPartType &gridPart, unsigned int order=DiscreteFunctionSpaceType::polynomialOrder) | |
constructor taking a r-value reference instance of the local function class | |
template<class ... Args> | |
LocalFunctionAdapter (const std::string &name, const GridPartType &gridPart, unsigned int order, Args &... args) | |
template<class ... Args> | |
LocalFunctionAdapter (const std::string &name, const GridPartType &gridPart, const std::tuple< Args &... > &args, unsigned int order=DiscreteFunctionSpaceType::polynomialOrder) | |
unsigned int | order () const |
return the order of the space | |
bool | continuous () const |
return true, probably | |
const LocalFuncStorageType & | localFunctionImpl () const |
return local function implementation | |
LocalFuncStorageType & | localFunctionImpl () |
return local function implementation | |
void | evaluate (const DomainType &global, RangeType &result) const |
evaluate function on local coordinate local | |
LocalFunctionType | localFunction (const EntityType &entity) |
obtain a local function for an entity (read-write) More... | |
const LocalFunctionType | localFunction (const EntityType &entity) const |
obtain a local function for an entity (read-write) More... | |
const std::string & | name () const |
obtain the name of the discrete function More... | |
template<class DFType > | |
DiscreteFunctionType & | operator+= (const DFType &g) |
template<class DFType > | |
DiscreteFunctionType & | operator-= (const DFType &g) |
substract all degrees of freedom from given discrete function using the dof iterators More... | |
DiscreteFunctionType & | operator*= (const RangeFieldType &scalar) |
multiply all DoFs with a scalar factor More... | |
DiscreteFunctionType & | operator/= (const RangeFieldType &scalar) |
devide all DoFs by a scalar factor More... | |
template<class ArgumentType > | |
void | initialize (const ArgumentType &arg, double time) |
initialize local function with argument and time | |
void | registerLocalFunction (LocalFunctionType *lf) const |
add LocalFunction to list of local functions | |
void | deleteLocalFunction (LocalFunctionType *lf) const |
remove LocalFunction to list of local functions | |
virtual void | operator() (const DomainType &arg, RangeType &dest) const |
application operator call evaluate More... | |
void | operator() (const DomainType &arg, RangeType &dest) const |
Application operator that applies all operators in the linear combination stack. More... | |
void | jacobian (const DomainType &x, JacobianRangeType &jacobian) const |
evaluate the Jacobian of the function More... | |
void | hessian (const DomainType &x, HessianRangeType &hessian) const |
evaluate the hessian of the function More... | |
Related Functions | |
(Note that these are not member functions.) | |
static Mapping< LocalFunctionImpl::FunctionSpaceType ::DomainFieldType, LocalFunctionImpl::FunctionSpaceType ::RangeFieldType, LocalFunctionImpl::FunctionSpaceType ::DomainType, LocalFunctionImpl::FunctionSpaceType ::RangeType > | operator+ (const Mapping< LocalFunctionImpl::FunctionSpaceType ::DomainFieldType, LocalFunctionImpl::FunctionSpaceType ::RangeFieldType, LocalFunctionImpl::FunctionSpaceType ::DomainType, LocalFunctionImpl::FunctionSpaceType ::RangeType > &a, const Mapping< LocalFunctionImpl::FunctionSpaceType ::DomainFieldType, LocalFunctionImpl::FunctionSpaceType ::RangeFieldType, LocalFunctionImpl::FunctionSpaceType ::DomainType, LocalFunctionImpl::FunctionSpaceType ::RangeType > &b) |
add two mappings More... | |
static Mapping< LocalFunctionImpl::FunctionSpaceType ::DomainFieldType, LocalFunctionImpl::FunctionSpaceType ::RangeFieldType, LocalFunctionImpl::FunctionSpaceType ::DomainType, LocalFunctionImpl::FunctionSpaceType ::RangeType > | operator- (const Mapping< LocalFunctionImpl::FunctionSpaceType ::DomainFieldType, LocalFunctionImpl::FunctionSpaceType ::RangeFieldType, LocalFunctionImpl::FunctionSpaceType ::DomainType, LocalFunctionImpl::FunctionSpaceType ::RangeType > &a, const Mapping< LocalFunctionImpl::FunctionSpaceType ::DomainFieldType, LocalFunctionImpl::FunctionSpaceType ::RangeFieldType, LocalFunctionImpl::FunctionSpaceType ::DomainType, LocalFunctionImpl::FunctionSpaceType ::RangeType > &b) |
substract two mappings More... | |
static Mapping< LocalFunctionImpl::FunctionSpaceType ::DomainFieldType, LocalFunctionImpl::FunctionSpaceType ::RangeFieldType, LocalFunctionImpl::FunctionSpaceType ::DomainType, LocalFunctionImpl::FunctionSpaceType ::RangeType > | operator* (const Mapping< LocalFunctionImpl::FunctionSpaceType ::DomainFieldType, LocalFunctionImpl::FunctionSpaceType ::RangeFieldType, LocalFunctionImpl::FunctionSpaceType ::DomainType, LocalFunctionImpl::FunctionSpaceType ::RangeType > &mapping, const LocalFunctionImpl::FunctionSpaceType ::RangeFieldType &factor) |
scale mapping with factor More... | |
static Mapping< LocalFunctionImpl::FunctionSpaceType ::DomainFieldType, LocalFunctionImpl::FunctionSpaceType ::RangeFieldType, LocalFunctionImpl::FunctionSpaceType ::DomainType, LocalFunctionImpl::FunctionSpaceType ::RangeType > | operator* (const LocalFunctionImpl::FunctionSpaceType ::RangeFieldType &factor, const Mapping< LocalFunctionImpl::FunctionSpaceType ::DomainFieldType, LocalFunctionImpl::FunctionSpaceType ::RangeFieldType, LocalFunctionImpl::FunctionSpaceType ::DomainType, LocalFunctionImpl::FunctionSpaceType ::RangeType > &mapping) |
scale mapping with factor More... | |
static Mapping< LocalFunctionImpl::FunctionSpaceType ::DomainFieldType, LocalFunctionImpl::FunctionSpaceType ::RangeFieldType, LocalFunctionImpl::FunctionSpaceType ::DomainType, LocalFunctionImpl::FunctionSpaceType ::RangeType > | operator/ (const Mapping< LocalFunctionImpl::FunctionSpaceType ::DomainFieldType, LocalFunctionImpl::FunctionSpaceType ::RangeFieldType, LocalFunctionImpl::FunctionSpaceType ::DomainType, LocalFunctionImpl::FunctionSpaceType ::RangeType > &mapping, const LocalFunctionImpl::FunctionSpaceType ::RangeFieldType &factor) |
operator / for mappings More... | |
static Mapping< LocalFunctionImpl::FunctionSpaceType ::DomainFieldType, LocalFunctionImpl::FunctionSpaceType ::RangeFieldType, LocalFunctionImpl::FunctionSpaceType ::DomainType, LocalFunctionImpl::FunctionSpaceType ::RangeType > | operator/ (const LocalFunctionImpl::FunctionSpaceType ::RangeFieldType &factor, const Mapping< LocalFunctionImpl::FunctionSpaceType ::DomainFieldType, LocalFunctionImpl::FunctionSpaceType ::RangeFieldType, LocalFunctionImpl::FunctionSpaceType ::DomainType, LocalFunctionImpl::FunctionSpaceType ::RangeType > &mapping) |
operator / for mappings More... | |
Detailed Description
class Dune::Fem::LocalFunctionAdapter< LocalFunctionImpl >
LocalFunctionAdapter wrapped a class with a local evaluate method into a grid function.
The class takes one template argument LocalFunctionImpl which holds the method evaluate(...) to evaluate the local function
template<class PointType> LocalFunctionImpl::evaluate(const PointType& x,RangeType& val)
and a method init(...)
LocalFunctionImpl::init(const EntityType& entity)
to set the entity.
It is important to know that the point x it is not necessary of type DomainType. More precisely, if the evaluate(...) is used with a caching quadrature point the type is different. Indeed floating point coordinates are not very well suited to address the cache therefore quadrature[i] return a QuadraturePointWrapper (which simply stores a reference to the quadrature and the index i).
In order to be sure that the point x is of type DomainType, you can use the function coordinate(x) which can be also called with a DomainType.
Therefore, the local implementation should be something like
template<class PointType> LocalFunctionImpl::evaluate(const PointType& x,RangeType& val) { const DomainType xDomain(coordiante(x)); // do stuff with xDomain }
to avoid type conflicts.
Required type in LocalFunctionImpl are:
FunctionSpaceType GridPartType EntityType DomainType RangeType
An instance of the LocalFunctionImpl class is passed to the constructor.
In order to adapt a lambda or a plain C++ function, you can directly use the LocalAnalyticalFunctionBinder which provides all the necessary types and methods.
Member Function Documentation
◆ hessian()
|
inlineinherited |
evaluate the hessian of the function
- Parameters
-
[in] x evaluation point [out] hessian value of the hessian in x
◆ jacobian()
|
inlineinherited |
evaluate the Jacobian of the function
- Parameters
-
[in] x evaluation point [out] jacobian value of the Jacobian in x
◆ operator()() [1/2]
|
inlinevirtualinherited |
application operator call evaluate
- Parameters
-
[in] arg argument [out] dest destination, i.e. f(arg)
◆ operator()() [2/2]
|
inlineinherited |
Application operator that applies all operators in the linear combination stack.
- Parameters
-
[in] arg argument [out] dest destination
Friends And Related Function Documentation
◆ operator*() [1/2]
|
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*() [2/2]
|
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+()
|
related |
add two mappings
- Parameters
-
[in] a mapping 1 [in] b mapping 2
- Returns
- new object mapping
◆ operator-()
|
related |
substract two mappings
- Parameters
-
[in] a mapping 1 [in] b mapping 2
- Returns
- new object mapping
◆ operator/() [1/2]
|
related |
operator / for mappings
- Parameters
-
[in] factor by which result of mapping is divided [in] mapping which is divided
- Returns
- new object mapping
◆ operator/() [2/2]
|
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
The documentation for this class was generated from the following file:
- dune/fem/function/common/localfunctionadapter.hh