dune-grid  3.0-git
Public Types | Public Member Functions | List of all members
Dune::VTK::FieldInfo Class Reference

Descriptor struct for VTK fields. More...

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

Public Types

enum  Type { Type::scalar, Type::vector, Type::tensor }
 VTK data type. More...
 

Public Member Functions

 FieldInfo (std::string name, Type type, std::size_t size)
 Create a FieldInfo instance with the given name, type and size. More...
 
std::string name () const
 The name of the data field. More...
 
Type type () const
 The type of the data field. More...
 
std::size_t size () const
 The number of components in the data field. More...
 

Detailed Description

Descriptor struct for VTK fields.

This struct provides general information about a data field to be written to a VTK file.

It currently stores the data type and the number of components as well as the name of the field.

Member Enumeration Documentation

◆ Type

VTK data type.

Enumerator
scalar 

scalar field (may also be multi-component, but is treated as a simply array by ParaView

vector 

vector-valued field (always 3D, will be padded if necessary)

tensor 

tensor field (always 3x3)

Constructor & Destructor Documentation

◆ FieldInfo()

Dune::VTK::FieldInfo::FieldInfo ( std::string  name,
Type  type,
std::size_t  size 
)
inline

Create a FieldInfo instance with the given name, type and size.

Member Function Documentation

◆ name()

std::string Dune::VTK::FieldInfo::name ( ) const
inline

The name of the data field.

◆ size()

std::size_t Dune::VTK::FieldInfo::size ( ) const
inline

The number of components in the data field.

◆ type()

Type Dune::VTK::FieldInfo::type ( ) const
inline

The type of the data field.


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