Dune::VTK Namespace Reference

Classes
class	AppendedBase64DataArrayWriter
	a streaming writer for data array tags, uses appended base64 format More...
class	AppendedRawDataArrayWriter
	a streaming writer for data array tags, uses appended raw format More...
class	AsciiDataArrayWriter
	a streaming writer for data array tags, uses ASCII inline format More...
class	BasicWriter
class	BinaryDataArrayWriter
	a streaming writer for data array tags, uses binary inline format More...
class	BoundaryIterator
	iterate over the GridViews boundary intersections More...
class	ConformingConnectivityWriter
	writer for the connectivity array in conforming mode More...
class	ConformingVolumeIteratorFactory
class	ConformingVolumeWriter
class	CoordinatesWriter
	writer for the Coordinates array More...
class	Corner
	simple class representing a corner of a cell More...
class	CornerIterator
	iterate over the corners of some cell range More...
class	DataArrayWriter
	base class for data array writers More...
class	DataArrayWriterFactory
	a factory for DataArrayWriters More...
class	FieldInfo
	Descriptor struct for VTK fields. More...
class	FunctionWriterBase
	Base class for function writers. More...
class	IntersectionIndexSet
class	NakedBase64DataArrayWriter
	a streaming writer for appended data array tags, uses base64 format More...
class	NakedRawDataArrayWriter
	a streaming writer for appended data arrays, uses raw format More...
class	NonConformingBoundaryIteratorFactory
class	NonConformingBoundaryWriter
class	NonConformingConnectivityWriter
	writer for the connectivity array in nonconforming mode More...
class	NonConformingVolumeIteratorFactory
class	OffsetsWriter
	writer for the offsets array More...
class	PointIterator
	iterate over the points of some corner range More...
struct	PrintType
	determine a type to safely put another type into a stream More...
struct	PrintType< char >
struct	PrintType< signed char >
struct	PrintType< unsigned char >
class	PVTUWriter
	Dump a .vtu/.vtp files contents to a stream. More...
class	SkeletonFunctionInterface
	A prototype for VTKFunctions on the skeleton. More...
struct	SkeletonFunctionTraits
class	SkeletonFunctionWriter
	function writer for skeleton functions More...
class	TypesWriter
	writer for the types array More...
class	VTKFunctionWriter
	Base class for function writers. More...
class	VTUWriter
	Dump a .vtu/.vtp files contents to a stream. More...

Enumerations
enum	OutputType { ascii , base64 , appendedraw , appendedbase64 }
	How the bulk data should be stored in the file. More...
enum	DataMode { conforming , nonconforming }
	Whether to produce conforming or non-conforming output. More...
enum	GeometryType {   vertex = 1 , line = 3 , triangle = 5 , polygon = 7 ,   quadrilateral = 9 , tetrahedron = 10 , hexahedron = 12 , prism = 13 ,   pyramid = 14 , polyhedron = 42 }
	Type representing VTK's entity geometry types. More...
enum	FileType { polyData , unstructuredGrid }
	which type of VTK file to write More...
enum class	Precision {   int32 , uint8 , uint32 , float32 ,   float64 }
	which precision to use when writing out data to vtk files More...

Functions
GeometryType	geometryType (const Dune::GeometryType &t)
	mapping from GeometryType to VTKGeometryType
int	renumber (const Dune::GeometryType &t, int i)
	renumber VTK <-> Dune
template<typename T >
int	renumber (const T &t, int i)
	renumber VTK <-> Dune
std::string	getEndiannessString ()
	determine endianness of this C++ implementation
std::string	toString (Precision p)
	map precision to VTK type name
std::size_t	typeSize (Precision p)
	map precision to byte size

Enumeration Type Documentation

DataMode

enum Dune::VTK::DataMode

Whether to produce conforming or non-conforming output.

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

This applies to the conformity of the data; a non-conforming grid can still be written in conforming data mode, and it is quite possible for data to be non-conforming on a conforming grid.

Enumerator
conforming	Output conforming data. Neighboring elements share common vertices and thus have a common DoF on that vertex.
nonconforming	Output non-conforming data. Each element has its own set of vertices. The position of a vertex of one element will coincide with the position of the corresponding vertex on another element. This allows for multiple DoFs (one per element) on the "same" vertex.

FileType

enum Dune::VTK::FileType

which type of VTK file to write

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

Enumerator
polyData	for .vtp files (PolyData)
unstructuredGrid	for .vtu files (UnstructuredGrid)

GeometryType

enum Dune::VTK::GeometryType

Type representing VTK's entity geometry types.

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

Only the types which have a corresponding Dune::GeometryType have been included here. Dune-type names have been used, this mainly makes a difference for vtkPrism, which is known by VTK as VTK_WEDGE.

Enumerator
vertex
line
triangle
polygon
quadrilateral
tetrahedron
hexahedron
prism
pyramid
polyhedron

OutputType

enum Dune::VTK::OutputType

How the bulk data should be stored in the file.

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

Enumerator
ascii	Output to the file is in ascii.
base64	Output to the file is inline base64 binary.
appendedraw	Output is to the file is appended raw binary.
appendedbase64	Output is to the file is appended base64 binary.

Precision

enum class Dune::VTK::Precision

strong

which precision to use when writing out data to vtk files

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

Enumerator
int32
uint8
uint32
float32
float64

Function Documentation

geometryType()

GeometryType Dune::VTK::geometryType ( const Dune::GeometryType &  t )

inline

mapping from GeometryType to VTKGeometryType

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

getEndiannessString()

std::string Dune::VTK::getEndiannessString ( )

inline

determine endianness of this C++ implementation

Returns

A string suitable for the byte_order property in VTK files; either "BigEndian" or "LittleEndian".

renumber() [1/2]

int Dune::VTK::renumber ( const Dune::GeometryType &  t, int  i  )

inline

renumber VTK <-> Dune

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

Since the renumbering never does anything more complex than exchanging two indices, this method works both ways.

renumber() [2/2]

template<typename T >

int Dune::VTK::renumber	(	const T &	t,
		int	i
	)

renumber VTK <-> Dune

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

This function is just a convenience shortcut function wrapping renumber(const GeometryType&, int).

Parameters

t	Entity, Intersection or Geometry to do the renumbering in. Basically, anything with a method type() returning a GeometryType should work here.
i	Index to of corner in either Dune or VTK numbering (the result will be in the other numbering)

toString()

std::string Dune::VTK::toString ( Precision  p )

inline

map precision to VTK type name

typeSize()

std::size_t Dune::VTK::typeSize ( Precision  p )

inline

map precision to byte size