Dune::Vtk::LocalFunction< GridView > Class Template Reference

A Vtk::LocalFunction is a function-like object that can be bound to a grid element an that provides an evaluate method with a component argument. More...

#include <dune/vtk/localfunction.hh>

Public Member Functions
template<class LF , disableCopyMove< Self, LF > = 0, HasBind< LF, Entity > = true>
	LocalFunction (LF &&lf)
	Construct the Vtk::LocalFunction from any function object that has a bind(element) method.
	LocalFunction (std::shared_ptr< VTKFunction< GridView > const > const &lf)
	Construct a Vtk::LocalFunction from a legacy VTKFunction.
	LocalFunction ()=default
void	bind (Entity const &entity)
	Bind the function to the grid entity.
void	unbind ()
	Unbind from the currently bound entity.
RangeProxy	operator() (LocalCoordinate const &xi) const
	Return a proxy object to access the components of the range vector.
double	evaluate (int c, LocalCoordinate const &xi) const
	Evaluate the cth component of the Range value at local coordinate xi
void	setComponents (std::vector< int > components)

Detailed Description

template<class GridView>
class Dune::Vtk::LocalFunction< GridView >

A Vtk::LocalFunction is a function-like object that can be bound to a grid element an that provides an evaluate method with a component argument.

Stores internally a Vtk::LocalFunctionInterface object for the concrete evaluation.

Constructor & Destructor Documentation

LocalFunction() [1/3]

template<class GridView >

template<class LF , disableCopyMove< Self, LF > = 0, HasBind< LF, Entity > = true>

Dune::Vtk::LocalFunction< GridView >::LocalFunction ( LF &&  lf )

inlineexplicit

Construct the Vtk::LocalFunction from any function object that has a bind(element) method.

LocalFunction() [2/3]

template<class GridView >

Dune::Vtk::LocalFunction< GridView >::LocalFunction ( std::shared_ptr< VTKFunction< GridView > const > const &  lf )

inlineexplicit

Construct a Vtk::LocalFunction from a legacy VTKFunction.

LocalFunction() [3/3]

template<class GridView >

Dune::Vtk::LocalFunction< GridView >::LocalFunction ( )

default

Allow the default construction of a Vtk::LocalFunction. After construction, the LocalFunction is in an invalid state.

Member Function Documentation

bind()

template<class GridView >

void Dune::Vtk::LocalFunction< GridView >::bind ( Entity const &  entity )

inline

Bind the function to the grid entity.

evaluate()

template<class GridView >

double Dune::Vtk::LocalFunction< GridView >::evaluate ( int  c, LocalCoordinate const &  xi  ) const

inline

Evaluate the cth component of the Range value at local coordinate xi

operator()()

template<class GridView >

RangeProxy Dune::Vtk::LocalFunction< GridView >::operator() ( LocalCoordinate const &  xi ) const

inline

Return a proxy object to access the components of the range vector.

setComponents()

template<class GridView >

void Dune::Vtk::LocalFunction< GridView >::setComponents ( std::vector< int >  components )

inline

unbind()

template<class GridView >

void Dune::Vtk::LocalFunction< GridView >::unbind ( )

inline

Unbind from the currently bound entity.

---

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

• localfunction.hh