Dumux::Vtk::Field< GridView > Class Template Reference

struct that can hold any field that fulfills the VTKFunction interface More...

#include <dumux/io/vtk/function.hh>

Description

template<class GridView>
class Dumux::Vtk::Field< GridView >

struct that can hold any field that fulfills the VTKFunction interface

Template Parameters

GridView

The Dune grid view type

Public Member Functions
template<typename F , class Mapper >
	Field (const GridView &gridView, const Mapper &mapper, F const &f, const std::string &name, int numComp=1, int codim=0, Dune::VTK::DataMode dm=Dune::VTK::conforming, Dumux::Vtk::Precision precision=Dumux::Vtk::Precision::float32)
std::string	name () const
	return the name of this field More...
int	ncomps () const
	return the number of components of this field More...
Dumux::Vtk::Precision	precision () const
	return the precision of this field More...
int	codim () const
	codimension of the entities on which the field values live More...
double	evaluate (int mycomp, const Element &element, const Dune::FieldVector< ctype, dim > &xi) const
	element-local evaluation of the field More...
std::shared_ptr< const Dune::VTKFunction< GridView > >	get () const
	returns the underlying vtk function More...

Constructor & Destructor Documentation

Field()

template<class GridView >

template<typename F , class Mapper >

Dumux::Vtk::Field< GridView >::Field ( const GridView &  gridView, const Mapper &  mapper, F const &  f, const std::string &  name, int  numComp = 1, int  codim = 0, Dune::VTK::DataMode  dm = Dune::VTK::conforming, Dumux::Vtk::Precision  precision = Dumux::Vtk::Precision::float32  )

inline

Member Function Documentation

codim()

template<class GridView >

int Dumux::Vtk::Field< GridView >::codim ( ) const

inline

codimension of the entities on which the field values live

evaluate()

template<class GridView >

double Dumux::Vtk::Field< GridView >::evaluate ( int  mycomp, const Element &  element, const Dune::FieldVector< ctype, dim > &  xi  ) const

inline

element-local evaluation of the field

get()

template<class GridView >

std::shared_ptr< const Dune::VTKFunction< GridView > > Dumux::Vtk::Field< GridView >::get ( ) const

inline

returns the underlying vtk function

name()

template<class GridView >

std::string Dumux::Vtk::Field< GridView >::name ( ) const

inline

return the name of this field

ncomps()

template<class GridView >

int Dumux::Vtk::Field< GridView >::ncomps ( ) const

inline

return the number of components of this field

precision()

template<class GridView >

Dumux::Vtk::Precision Dumux::Vtk::Field< GridView >::precision ( ) const

inline

return the precision of this field

---

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

• function.hh