Dune::P1VTKFunction< GV, V > Class Template Reference

Take a vector and interpret it as point data for the VTKWriter. More...

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

Inheritance diagram for Dune::P1VTKFunction< GV, V >:

Public Types
typedef Base::Entity	Entity
typedef Base::ctype	ctype

Public Member Functions
int	ncomps () const override
	return number of components More...
double	evaluate (int comp, const Entity &e, const Dune::FieldVector< ctype, dim > &xi) const override
	evaluate More...
std::string	name () const override
	get name More...
VTK::Precision	precision () const override
	get output precision for the field More...
	P1VTKFunction (const GV &gv, const V &v_, const std::string &s_, int ncomps=1, int mycomp=0, VTK::Precision prec=VTK::Precision::float32)
	construct from a vector and a name More...
virtual	~P1VTKFunction ()
	destructor More...

Static Public Attributes
static constexpr int	dim

Detailed Description

template<typename GV, typename V>
class Dune::P1VTKFunction< GV, V >

Take a vector and interpret it as point data for the VTKWriter.

This class turns a generic vector containing point data into a VTKFunction. The vector must allow read access to the data via operator[]() and store the data in the order given by MultipleCodimMultipleGeomTypeMapper with a layout class that allows only vertices. Also, it must support the method size().

While the number of components of the function is always 1, the vector may represent a field with multiple components of which one may be selected.

Template Parameters

GV	Type of GridView the vector applies to.
V	Type of vector.

Member Typedef Documentation

ctype

template<typename GV , typename V >

typedef Base::ctype Dune::P1VTKFunction< GV, V >::ctype

Entity

template<typename GV , typename V >

typedef Base::Entity Dune::P1VTKFunction< GV, V >::Entity

Constructor & Destructor Documentation

P1VTKFunction()

template<typename GV , typename V >

Dune::P1VTKFunction< GV, V >::P1VTKFunction ( const GV &  gv, const V &  v_, const std::string &  s_, int  ncomps = 1, int  mycomp = 0, VTK::Precision  prec = VTK::Precision::float32  )

inline

construct from a vector and a name

Parameters

gv	GridView to operate on (used to instantiate a MultipleCodimMultipleGeomTypeMapper, otherwise no reference or copy is stored). Note that this must be the GridView the vector applies to as well as the GridView later used by the VTKWriter – i.e. we do not implicitly restrict or prolongate the data.
v_	Reference to the vector holding the data. The reference is stored internally and must be valid for as long as this functions evaluate method is used.
s_	Name of this function in the VTK file.
ncomps	Number of components of the field represented by the vector.
mycomp	Number of the field component this function is responsible for.
prec	the precision with which to output the field

~P1VTKFunction()

template<typename GV , typename V >

virtual Dune::P1VTKFunction< GV, V >::~P1VTKFunction ( )

inlinevirtual

destructor

Member Function Documentation

evaluate()

template<typename GV , typename V >

double Dune::P1VTKFunction< GV, V >::evaluate ( int  comp, const Entity &  e, const Dune::FieldVector< ctype, dim > &  xi  ) const

inlineoverridevirtual

evaluate

Implements Dune::VTKFunction< GV >.

name()

template<typename GV , typename V >

std::string Dune::P1VTKFunction< GV, V >::name ( ) const

inlineoverridevirtual

get name

Implements Dune::VTKFunction< GV >.

ncomps()

template<typename GV , typename V >

int Dune::P1VTKFunction< GV, V >::ncomps ( ) const

inlineoverridevirtual

return number of components

Implements Dune::VTKFunction< GV >.

precision()

template<typename GV , typename V >

VTK::Precision Dune::P1VTKFunction< GV, V >::precision ( ) const

inlineoverridevirtual

get output precision for the field

Reimplemented from Dune::VTKFunction< GV >.

Member Data Documentation

dim

constexpr int Dune::VTKFunction< GV >::dim

staticconstexprinherited

---

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

• function.hh