dune-grid 2.9.0
Public Types | Public Member Functions | Static Public Attributes | List of all members
Dune::VTKFunction< GridView > Class Template Referenceabstract

A base class for grid functions with any return type and dimension. More...

#include <dune/grid/io/file/vtk/function.hh>

Inheritance diagram for Dune::VTKFunction< GridView >:
Inheritance graph

Public Types

typedef GridView::ctype ctype
 
typedef GridView::template Codim< 0 >::Entity Entity
 

Public Member Functions

virtual int ncomps () const =0
 
virtual double evaluate (int comp, const Entity &e, const Dune::FieldVector< ctype, dim > &xi) const =0
 evaluate single component comp in the entity e at local coordinates xi More...
 
virtual std::string name () const =0
 get name More...
 
virtual VTK::Precision precision () const
 get output precision for the field More...
 
virtual ~VTKFunction ()
 virtual destructor More...
 

Static Public Attributes

static constexpr int dim = GridView::dimension
 

Detailed Description

template<class GridView>
class Dune::VTKFunction< GridView >

A base class for grid functions with any return type and dimension.

Trick : use double as return type

Member Typedef Documentation

◆ ctype

template<class GridView >
typedef GridView::ctype Dune::VTKFunction< GridView >::ctype

◆ Entity

template<class GridView >
typedef GridView::template Codim<0>::Entity Dune::VTKFunction< GridView >::Entity

Constructor & Destructor Documentation

◆ ~VTKFunction()

template<class GridView >
virtual Dune::VTKFunction< GridView >::~VTKFunction ( )
inlinevirtual

virtual destructor

Member Function Documentation

◆ evaluate()

template<class GridView >
virtual double Dune::VTKFunction< GridView >::evaluate ( int  comp,
const Entity e,
const Dune::FieldVector< ctype, dim > &  xi 
) const
pure virtual

evaluate single component comp in the entity e at local coordinates xi

Evaluate the function in an entity at local coordinates.

Parameters
[in]compnumber of component to be evaluated
[in]ereference to grid entity of codimension 0
[in]xipoint in local coordinates of the reference element of e
Returns
value of the component

Implemented in Dune::P1VTKFunction< GV, V >, and Dune::P0VTKFunction< GV, V >.

◆ name()

template<class GridView >
virtual std::string Dune::VTKFunction< GridView >::name ( ) const
pure virtual

◆ ncomps()

template<class GridView >
virtual int Dune::VTKFunction< GridView >::ncomps ( ) const
pure virtual

return number of components (1 for scalar valued functions, 3 for vector valued function in 3D etc.)

Implemented in Dune::P0VTKFunction< GV, V >, and Dune::P1VTKFunction< GV, V >.

◆ precision()

template<class GridView >
virtual VTK::Precision Dune::VTKFunction< GridView >::precision ( ) const
inlinevirtual

get output precision for the field

Reimplemented in Dune::P0VTKFunction< GV, V >, and Dune::P1VTKFunction< GV, V >.

Member Data Documentation

◆ dim

template<class GridView >
constexpr int Dune::VTKFunction< GridView >::dim = GridView::dimension
staticconstexpr

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