Dune::ACFem::GridFunctionWrapper< FunctionImp, GridPart > Class Template Reference

A special version of Fem::GridFunctionAdapter which stores a copy to the function, not a reference. More...

#include <dune/acfem/functions/gridfunctionwrapper.hh>

Collaboration diagram for Dune::ACFem::GridFunctionWrapper< FunctionImp, GridPart >:

Public Types
typedef AdapterType::DiscreteFunctionSpaceType	DiscreteFunctionSpaceType
	type of discrete function space
typedef DiscreteFunctionSpaceType::GridType	GridType
	type of grid
typedef DiscreteFunctionSpaceType::DomainFieldType	DomainFieldType
	domain type (from function space)
typedef DiscreteFunctionSpaceType::RangeFieldType	RangeFieldType
	range type (from function space)
typedef DiscreteFunctionSpaceType::DomainType	DomainType
	domain type (from function space)
typedef DiscreteFunctionSpaceType::RangeType	RangeType
	range type (from function space)
typedef DiscreteFunctionSpaceType::JacobianRangeType	JacobianRangeType
	jacobian type (from function space)
typedef DiscreteFunctionSpaceType::HessianRangeType	HessianRangeType
	hessian type (from function space)
typedef AdapterType::EntityType	EntityType
	type of codim 0 entity
typedef LocalFunction	LocalFunctionType
	type of local function to export
typedef GridFunctionWrapper< FunctionImp, GridPart >	ExpressionType
	The type of the underlying expression.

Public Member Functions
void	evaluate (const DomainType &global, RangeType &result) const
	evaluate the function More...
void	jacobian (const DomainType &global, JacobianRangeType &result) const
	evaluate the Jacobian of the function More...
void	hessian (const DomainType &global, HessianRangeType &result) const
	evaluate the Hessian of the function More...
const LocalFunctionType	localFunction (const EntityType &entity) const
	cons More...
LocalFunctionType	localFunction (const EntityType &entity)
const DiscreteFunctionSpaceType &	space () const
void	setName (const std::string &newName)
	Supply a descriptive name for the function. More...
const std::string &	name () const
	Return a descriptive name for the function. More...
const std::string &	expressionName () const
	Return a lengthy descriptive name for the underlying algebraic expression.
const ExpressionType &	expression () const
	Return a const reference to the underlying expression.
ExpressionType &	expression ()
	Return a mutable reference to the underlying expression.
ExpressionType	operator* () const
	Return a copy from of the underlying expression.

Detailed Description

template<class FunctionImp, class GridPart>
class Dune::ACFem::GridFunctionWrapper< FunctionImp, GridPart >

A special version of Fem::GridFunctionAdapter which stores a copy to the function, not a reference.

Primarily useful to wrap functions which do not store a state.

Member Function Documentation

evaluate()

template<class FunctionImp , class GridPart >

void Dune::ACFem::GridFunctionWrapper< FunctionImp, GridPart >::evaluate ( const DomainType &  global, RangeType &  result  ) const

inline

evaluate the function

Parameters

[in]	global	evaluation point
[out]	result	value of the function in x

References Dune::ACFem::GridFunctionAdapter< FunctionImp, GridPartImp >::evaluate().

hessian()

template<class FunctionImp , class GridPart >

void Dune::ACFem::GridFunctionWrapper< FunctionImp, GridPart >::hessian ( const DomainType &  global, HessianRangeType &  result  ) const

inline

evaluate the Hessian of the function

Parameters

[in]	global	evaluation point
[out]	result	value of the Hessian in x

References Dune::ACFem::GridFunctionAdapter< FunctionImp, GridPartImp >::hessian().

jacobian()

template<class FunctionImp , class GridPart >

void Dune::ACFem::GridFunctionWrapper< FunctionImp, GridPart >::jacobian ( const DomainType &  global, JacobianRangeType &  result  ) const

inline

evaluate the Jacobian of the function

Parameters

[in]	global	evaluation point
[out]	result	value of the Jacobian in x

References Dune::ACFem::GridFunctionAdapter< FunctionImp, GridPartImp >::jacobian().

localFunction() [1/2]

template<class FunctionImp , class GridPart >

LocalFunctionType Dune::ACFem::GridFunctionWrapper< FunctionImp, GridPart >::localFunction ( const EntityType &  entity )

inline

localFunction() [2/2]

template<class FunctionImp , class GridPart >

const LocalFunctionType Dune::ACFem::GridFunctionWrapper< FunctionImp, GridPart >::localFunction ( const EntityType &  entity ) const

inline

cons

cons

name()

const std::string & Dune::ACFem::GridFunctionExpression< FunctionImp::FunctionSpaceType , GridFunctionWrapper< FunctionImp, GridPart > , ExpressionTemplate >::name ( ) const

inlineinherited

Return a descriptive name for the function.

If set by setName(), return that user-supplied name. Otherwise return a (lengthy) auto-generated name describing the underlying algebraic expression.

setName()

void Dune::ACFem::GridFunctionExpression< FunctionImp::FunctionSpaceType , GridFunctionWrapper< FunctionImp, GridPart > , ExpressionTemplate >::setName ( const std::string &  newName )

inlineinherited

Supply a descriptive name for the function.

This name will also be stored in the VTK files. It should be a "valid variable name".

space()

template<class FunctionImp , class GridPart >

const DiscreteFunctionSpaceType & Dune::ACFem::GridFunctionWrapper< FunctionImp, GridPart >::space ( ) const

inline

References Dune::ACFem::GridFunctionAdapter< FunctionImp, GridPartImp >::space().

---

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

• dune/acfem/functions/gridfunctionwrapper.hh