dune-vtk 2.12
Loading...
Searching...
No Matches
Dune::Vtk::LocalFunction< Element, ComponentMapper > 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/gridfunctions/localfunction.hh>

Public Member Functions

template<class LF >
 LocalFunction (LF &&lf, std::vector< int > components)
 Constructor. Pass any type supporting the LocalOperatorInterface.
 
 LocalFunction ()=default
 Default Constructor.
 
 LocalFunction (LocalFunction &&)=default
 Move Constructor.
 
LocalFunction & operator= (LocalFunction &&)=default
 Move assignment-operator.
 
 LocalFunction (const LocalFunction &other)
 Copy constructor, clones the underlying implementation.
 
LocalFunction & operator= (const LocalFunction &other)
 Copy assignment operator, clones the underlying implementation.
 
void bind (Element const &element)
 Binds the local function to an element.
 
void unbind ()
 Unbinds function from element.
 
Impl::RangeProxy< LocalFunction, Domain > operator() (Domain const &x) const
 Return a proxy object to access the components of the range vector.
 
double evaluate (int i, Domain const &x) const
 Evaluate the ith component of the Range value at local coordinate x
 
const std::vector< int > & components () const
 Return the components vector.
 
void setComponents (std::vector< int > components)
 Use the passed components for evaluation of the range.
 

Detailed Description

template<class Element, class ComponentMapper>
class Dune::Vtk::LocalFunction< Element, ComponentMapper >

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/4]

template<class Element , class ComponentMapper >
template<class LF >
Dune::Vtk::LocalFunction< Element, ComponentMapper >::LocalFunction ( LF &&  lf,
std::vector< int >  components 
)
inline

Constructor. Pass any type supporting the LocalOperatorInterface.

◆ LocalFunction() [2/4]

template<class Element , class ComponentMapper >
Dune::Vtk::LocalFunction< Element, ComponentMapper >::LocalFunction ( )
default

Default Constructor.

◆ LocalFunction() [3/4]

template<class Element , class ComponentMapper >
Dune::Vtk::LocalFunction< Element, ComponentMapper >::LocalFunction ( LocalFunction< Element, ComponentMapper > &&  )
default

Move Constructor.

◆ LocalFunction() [4/4]

template<class Element , class ComponentMapper >
Dune::Vtk::LocalFunction< Element, ComponentMapper >::LocalFunction ( const LocalFunction< Element, ComponentMapper > &  other)
inline

Copy constructor, clones the underlying implementation.

Member Function Documentation

◆ bind()

template<class Element , class ComponentMapper >
void Dune::Vtk::LocalFunction< Element, ComponentMapper >::bind ( Element const &  element)
inline

Binds the local function to an element.

◆ components()

template<class Element , class ComponentMapper >
const std::vector< int > & Dune::Vtk::LocalFunction< Element, ComponentMapper >::components ( ) const
inline

Return the components vector.

◆ evaluate()

template<class Element , class ComponentMapper >
double Dune::Vtk::LocalFunction< Element, ComponentMapper >::evaluate ( int  i,
Domain const &  x 
) const
inline

Evaluate the ith component of the Range value at local coordinate x

◆ operator()()

template<class Element , class ComponentMapper >
Impl::RangeProxy< LocalFunction, Domain > Dune::Vtk::LocalFunction< Element, ComponentMapper >::operator() ( Domain const &  x) const
inline

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

◆ operator=() [1/2]

template<class Element , class ComponentMapper >
LocalFunction & Dune::Vtk::LocalFunction< Element, ComponentMapper >::operator= ( const LocalFunction< Element, ComponentMapper > &  other)
inline

Copy assignment operator, clones the underlying implementation.

◆ operator=() [2/2]

template<class Element , class ComponentMapper >
LocalFunction & Dune::Vtk::LocalFunction< Element, ComponentMapper >::operator= ( LocalFunction< Element, ComponentMapper > &&  )
default

Move assignment-operator.

◆ setComponents()

template<class Element , class ComponentMapper >
void Dune::Vtk::LocalFunction< Element, ComponentMapper >::setComponents ( std::vector< int >  components)
inline

Use the passed components for evaluation of the range.

◆ unbind()

template<class Element , class ComponentMapper >
void Dune::Vtk::LocalFunction< Element, ComponentMapper >::unbind ( )
inline

Unbinds function from element.


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