dune-vtk 2.12
Loading...
Searching...
No Matches
Dune::Vtk::Function< GridView > Class Template Reference

#include <dune/vtk/function.hh>

Inheritance diagram for Dune::Vtk::Function< GridView >:
Inheritance graph

Public Member Functions

Impl::RangeProxy< GridFunction, 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 coordinate x
 
std::string const & name () const
 Return a name associated with the function.
 
void setName (std::string name)
 Set the function name.
 
int numComponents () const
 Return the number of components of the Range as it is written to the file.
 
const std::vector< int > & components () const
 Return the components vector.
 
void setComponents (std::vector< int > components)
 Set the components of the Range to visualize.
 
void setComponents (int ncomps)
 Set the number of components of the Range and generate component range [0...ncomps)
 
Vtk::DataTypes dataType () const
 Return the VTK Datatype associated with the functions range type.
 
void setDataType (Vtk::DataTypes type)
 Set the data-type for the components.
 
Vtk::RangeTypes rangeType () const
 The category of the range, SCALAR, VECTOR, TENSOR, or UNSPECIFIED.
 
void setRangeType (Vtk::RangeTypes type, std::size_t ncomp=1)
 Set the category of the range, SCALAR, VECTOR, TENSOR, or UNSPECIFIED.
 
void setFieldInfo (const Vtk::FieldInfo &info)
 Set all the parameters from a FieldInfo object.
 

Member Function Documentation

◆ components()

template<class GridView , class ComponentMapper = DefaultComponentMapper>
const std::vector< int > & Dune::Vtk::GridFunction< GridView, ComponentMapper >::components ( ) const
inlineinherited

Return the components vector.

◆ dataType()

template<class GridView , class ComponentMapper = DefaultComponentMapper>
Vtk::DataTypes Dune::Vtk::GridFunction< GridView, ComponentMapper >::dataType ( ) const
inlineinherited

Return the VTK Datatype associated with the functions range type.

◆ evaluate()

template<class GridView , class ComponentMapper = DefaultComponentMapper>
double Dune::Vtk::GridFunction< GridView, ComponentMapper >::evaluate ( int  i,
Domain const &  x 
) const
inlineinherited

Evaluate the ith component of the Range value at coordinate x

◆ name()

template<class GridView , class ComponentMapper = DefaultComponentMapper>
std::string const & Dune::Vtk::GridFunction< GridView, ComponentMapper >::name ( ) const
inlineinherited

Return a name associated with the function.

◆ numComponents()

template<class GridView , class ComponentMapper = DefaultComponentMapper>
int Dune::Vtk::GridFunction< GridView, ComponentMapper >::numComponents ( ) const
inlineinherited

Return the number of components of the Range as it is written to the file.

◆ operator()()

template<class GridView , class ComponentMapper = DefaultComponentMapper>
Impl::RangeProxy< GridFunction, Domain > Dune::Vtk::GridFunction< GridView, ComponentMapper >::operator() ( Domain const &  x) const
inlineinherited

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

◆ rangeType()

template<class GridView , class ComponentMapper = DefaultComponentMapper>
Vtk::RangeTypes Dune::Vtk::GridFunction< GridView, ComponentMapper >::rangeType ( ) const
inlineinherited

The category of the range, SCALAR, VECTOR, TENSOR, or UNSPECIFIED.

◆ setComponents() [1/2]

template<class GridView , class ComponentMapper = DefaultComponentMapper>
void Dune::Vtk::GridFunction< GridView, ComponentMapper >::setComponents ( int  ncomps)
inlineinherited

Set the number of components of the Range and generate component range [0...ncomps)

◆ setComponents() [2/2]

template<class GridView , class ComponentMapper = DefaultComponentMapper>
void Dune::Vtk::GridFunction< GridView, ComponentMapper >::setComponents ( std::vector< int >  components)
inlineinherited

Set the components of the Range to visualize.

◆ setDataType()

template<class GridView , class ComponentMapper = DefaultComponentMapper>
void Dune::Vtk::GridFunction< GridView, ComponentMapper >::setDataType ( Vtk::DataTypes  type)
inlineinherited

Set the data-type for the components.

◆ setFieldInfo()

template<class GridView , class ComponentMapper = DefaultComponentMapper>
void Dune::Vtk::GridFunction< GridView, ComponentMapper >::setFieldInfo ( const Vtk::FieldInfo &  info)
inlineinherited

Set all the parameters from a FieldInfo object.

◆ setName()

template<class GridView , class ComponentMapper = DefaultComponentMapper>
void Dune::Vtk::GridFunction< GridView, ComponentMapper >::setName ( std::string  name)
inlineinherited

Set the function name.

◆ setRangeType()

template<class GridView , class ComponentMapper = DefaultComponentMapper>
void Dune::Vtk::GridFunction< GridView, ComponentMapper >::setRangeType ( Vtk::RangeTypes  type,
std::size_t  ncomp = 1 
)
inlineinherited

Set the category of the range, SCALAR, VECTOR, TENSOR, or UNSPECIFIED.


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