3.2-git
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Public Types | Public Member Functions | List of all members
Dumux::Vtk::VectorP1VTKFunction< GridView, Mapper, F > Struct Template Reference

a VTK function that supports both scalar and vector values for each vertex More...

#include <dumux/io/vtkfunction.hh>

Inheritance diagram for Dumux::Vtk::VectorP1VTKFunction< GridView, Mapper, F >:
Inheritance graph

Description

template<typename GridView, typename Mapper, typename F>
struct Dumux::Vtk::VectorP1VTKFunction< GridView, Mapper, F >

a VTK function that supports both scalar and vector values for each vertex

Template Parameters
GridViewThe Dune grid view type
MapperThe type used for mapping vertices to indices in the field
FThe field type (either vector of scalars or vectors)

Public Types

enum  { dim = GridView::dimension }
 
using ctype = typename GridView::ctype
 
using Element = typename GridView::template Codim< 0 >::Entity
 

Public Member Functions

int ncomps () const final
 return number of components More...
 
std::string name () const final
 get name More...
 
double evaluate (int mycomp, const Element &e, const Dune::FieldVector< ctype, dim > &xi) const final
 evaluate More...
 
 VectorP1VTKFunction (const GridView &gridView, const Mapper &mapper, const F &field, const std::string &name, int nComps, Dumux::Vtk::Precision precision=Dumux::Vtk::Precision::float32)
 Constructor. More...
 

Member Typedef Documentation

◆ ctype

template<typename GridView , typename Mapper , typename F >
using Dumux::Vtk::VectorP1VTKFunction< GridView, Mapper, F >::ctype = typename GridView::ctype

◆ Element

template<typename GridView , typename Mapper , typename F >
using Dumux::Vtk::VectorP1VTKFunction< GridView, Mapper, F >::Element = typename GridView::template Codim<0>::Entity

Member Enumeration Documentation

◆ anonymous enum

template<typename GridView , typename Mapper , typename F >
anonymous enum
Enumerator
dim 

Constructor & Destructor Documentation

◆ VectorP1VTKFunction()

template<typename GridView , typename Mapper , typename F >
Dumux::Vtk::VectorP1VTKFunction< GridView, Mapper, F >::VectorP1VTKFunction ( const GridView &  gridView,
const Mapper &  mapper,
const F &  field,
const std::string &  name,
int  nComps,
Dumux::Vtk::Precision  precision = Dumux::Vtk::Precision::float32 
)
inline

Constructor.

Member Function Documentation

◆ evaluate()

template<typename GridView , typename Mapper , typename F >
double Dumux::Vtk::VectorP1VTKFunction< GridView, Mapper, F >::evaluate ( int  mycomp,
const Element e,
const Dune::FieldVector< ctype, dim > &  xi 
) const
inlinefinal

evaluate

◆ name()

template<typename GridView , typename Mapper , typename F >
std::string Dumux::Vtk::VectorP1VTKFunction< GridView, Mapper, F >::name ( ) const
inlinefinal

get name

◆ ncomps()

template<typename GridView , typename Mapper , typename F >
int Dumux::Vtk::VectorP1VTKFunction< GridView, Mapper, F >::ncomps ( ) const
inlinefinal

return number of components


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