File-Writer for ImageData VTK .vti files. More...

#include <dune/vtk/writers/vtkimagedatawriter.hh>

Inheritance diagram for Dune::VtkImageDataWriter< GridView, DataCollector >:

Public Types
using	GridView = GridView

using	DataCollector = Vtk::StructuredDataCollector< GridView >

Public Member Functions
virtual std::string	write (std::string const &fn, std::optional< std::string > dir={}) const override
	Write the attached data to the file. More...

VtkWriterInterface &	addPointData (Function &&fct, Args &&... args)
	Attach point data to the writer. More...

VtkWriterInterface &	addCellData (Function &&fct, Args &&... args)
	Attach cell data to the writer. More...

void	setFormat (Vtk::FormatTypes format)

void	setDatatype (Vtk::DataTypes datatype)
	Sets the global datatype used for coordinates and other global float values. More...

void	setHeadertype (Vtk::DataTypes datatype)
	Sets the integer type used in binary data headers. More...

void	setCompressor (Vtk::CompressorTypes compressor, int level=-1)

Protected Types
enum	PositionTypes

using	VtkFunction = Dune::Vtk::Function< GridView >

Protected Member Functions
void	writeData (std::ofstream &out, std::vector< pos_type > &offsets, VtkFunction const &fct, PositionTypes type, std::optional< std::size_t > timestep={}) const

void	writeDataAppended (std::ofstream &out, std::vector< std::uint64_t > &blocks) const

void	writePoints (std::ofstream &out, std::vector< pos_type > &offsets, std::optional< std::size_t > timestep={}) const

void	writeAppended (std::ofstream &out, std::vector< pos_type > const &offsets) const

std::uint64_t	writeValuesAppended (std::ofstream &out, std::vector< FloatType > const &values) const

void	writeValuesAscii (std::ofstream &out, std::vector< T > const &values) const

void	writeHeader (std::ofstream &out, std::string const &type) const

std::string	getNames (std::vector< VtkFunction > const &data) const
	Return PointData/CellData attributes for the name of the first scalar/vector/tensor DataArray. More...

std::string	getEndian () const

std::string	getFileExtension () const

Vtk::FormatTypes	getFormat () const

Vtk::DataTypes	getDatatype () const

auto	comm () const

Protected Attributes
Vtk::CompressorTypes	compressor_

std::size_t const	block_size

int	compression_level

Detailed Description

template<class GridView, class DataCollector = Vtk::StructuredDataCollector<GridView>>
class Dune::VtkImageDataWriter< GridView, DataCollector >

File-Writer for ImageData VTK .vti files.

Requirement:

DataCollector must be a model of StructuredDataCollector

Member Typedef Documentation

◆ DataCollector

using Dune::VtkWriterInterface< GridView , Vtk::StructuredDataCollector< GridView > >::DataCollector = Vtk::StructuredDataCollector< GridView >

inherited

◆ GridView

using Dune::VtkWriterInterface< GridView , Vtk::StructuredDataCollector< GridView > >::GridView = GridView

inherited

◆ VtkFunction

using Dune::VtkWriterInterface< GridView , Vtk::StructuredDataCollector< GridView > >::VtkFunction = Dune::Vtk::Function<GridView>

protectedinherited

Member Enumeration Documentation

◆ PositionTypes

enum Dune::VtkWriterInterface::PositionTypes

protectedinherited

Member Function Documentation

◆ addCellData()

VtkWriterInterface& Dune::VtkWriterInterface< GridView , Vtk::StructuredDataCollector< GridView > >::addCellData	(	Function &&	fct,
		Args &&...	args
	)

inlineinherited

Attach cell data to the writer.

Attach a global function to the writer that will be evaluated at cell centers. The global function must be assignable to the function wrapper Vtk::Function. Additional argument for output datatype and number of components can be passed. See Vtk::Function Constructor for possible arguments.

Parameters

fct	A GridFunction, LocalFunction, or Dune::VTKFunction
args...	Additional arguments, like `name`, `numComponents`, `dataType` or `Vtk::FieldInfo`

◆ addPointData()

VtkWriterInterface& Dune::VtkWriterInterface< GridView , Vtk::StructuredDataCollector< GridView > >::addPointData	(	Function &&	fct,
		Args &&...	args
	)

inlineinherited

Attach point data to the writer.

Attach a global function to the writer that will be evaluated at grid points (vertices and higher order points). The global function must be assignable to the function wrapper Vtk::Function. Additional argument for output datatype and number of components can be passed. See Vtk::Function Constructor for possible arguments.

Parameters

fct	A GridFunction, LocalFunction, or Dune::VTKFunction
args...	Additional arguments, like `name`, `numComponents`, `dataType` or `Vtk::FieldInfo`

◆ comm()

auto Dune::VtkWriterInterface< GridView , Vtk::StructuredDataCollector< GridView > >::comm ( ) const

inlineprotectedinherited

◆ getDatatype()

Vtk::DataTypes Dune::VtkWriterInterface< GridView , Vtk::StructuredDataCollector< GridView > >::getDatatype ( ) const

inlineprotectedinherited

◆ getEndian()

std::string Dune::VtkWriterInterface< GridView , Vtk::StructuredDataCollector< GridView > >::getEndian ( ) const

inlineprotectedinherited

◆ getFileExtension()

std::string Dune::VtkWriterInterface< GridView , Vtk::StructuredDataCollector< GridView > >::getFileExtension ( ) const

inlineprotectedinherited

◆ getFormat()

Vtk::FormatTypes Dune::VtkWriterInterface< GridView , Vtk::StructuredDataCollector< GridView > >::getFormat ( ) const

inlineprotectedinherited

◆ getNames()

std::string Dune::VtkWriterInterface< GridView , Vtk::StructuredDataCollector< GridView > >::getNames ( std::vector< VtkFunction > const & data ) const

protectedinherited

Return PointData/CellData attributes for the name of the first scalar/vector/tensor DataArray.

◆ setCompressor()

void Dune::VtkWriterInterface< GridView , Vtk::StructuredDataCollector< GridView > >::setCompressor	(	Vtk::CompressorTypes	compressor,
		int	level = `-1`
	)

inlineinherited

Sets the compressor type used in binary data headers, Additionally a compression level can be passed with level = -1 means: default compression level. Level must be in [0-9]

◆ setDatatype()

void Dune::VtkWriterInterface< GridView , Vtk::StructuredDataCollector< GridView > >::setDatatype ( Vtk::DataTypes datatype )

inlineinherited

Sets the global datatype used for coordinates and other global float values.

◆ setFormat()

void Dune::VtkWriterInterface< GridView , Vtk::StructuredDataCollector< GridView > >::setFormat ( Vtk::FormatTypes format )

inlineinherited

◆ setHeadertype()

void Dune::VtkWriterInterface< GridView , Vtk::StructuredDataCollector< GridView > >::setHeadertype ( Vtk::DataTypes datatype )

inlineinherited

Sets the integer type used in binary data headers.

◆ write()

std::string Dune::VtkWriterInterface< GridView , Vtk::StructuredDataCollector< GridView > >::write	(	std::string const &	fn,
		std::optional< std::string >	dir = `{}`
	)		const

overridevirtualinherited

Write the attached data to the file.

Parameters

fn	Filename of the VTK file. May contain a directory and any file extension.
dir	The optional parameter specifies the directory of the partition files for parallel writes.

Returns: File name that is actually written.

Implements Dune::Vtk::FileWriter.

◆ writeAppended()

void Dune::VtkWriterInterface< GridView , Vtk::StructuredDataCollector< GridView > >::writeAppended	(	std::ofstream &	out,
		std::vector< pos_type > const &	offsets
	)		const

protectedinherited

◆ writeData()

void Dune::VtkWriterInterface< GridView , Vtk::StructuredDataCollector< GridView > >::writeData	(	std::ofstream &	out,
		std::vector< pos_type > &	offsets,
		VtkFunction const &	fct,
		PositionTypes	type,
		std::optional< std::size_t >	timestep = `{}`
	)		const

protectedinherited

◆ writeDataAppended()

void Dune::VtkWriterInterface< GridView , Vtk::StructuredDataCollector< GridView > >::writeDataAppended	(	std::ofstream &	out,
		std::vector< std::uint64_t > &	blocks
	)		const

protectedinherited

◆ writeHeader()

void Dune::VtkWriterInterface< GridView , Vtk::StructuredDataCollector< GridView > >::writeHeader	(	std::ofstream &	out,
		std::string const &	type
	)		const

protectedinherited

◆ writePoints()

void Dune::VtkWriterInterface< GridView , Vtk::StructuredDataCollector< GridView > >::writePoints	(	std::ofstream &	out,
		std::vector< pos_type > &	offsets,
		std::optional< std::size_t >	timestep = `{}`
	)		const

protectedinherited

◆ writeValuesAppended()

std::uint64_t Dune::VtkWriterInterface< GridView , Vtk::StructuredDataCollector< GridView > >::writeValuesAppended	(	std::ofstream &	out,
		std::vector< FloatType > const &	values
	)		const

protectedinherited

◆ writeValuesAscii()

void Dune::VtkWriterInterface< GridView , Vtk::StructuredDataCollector< GridView > >::writeValuesAscii	(	std::ofstream &	out,
		std::vector< T > const &	values
	)		const

protectedinherited

Member Data Documentation

◆ block_size

std::size_t const Dune::VtkWriterInterface< GridView , Vtk::StructuredDataCollector< GridView > >::block_size

protectedinherited

◆ compression_level

int Dune::VtkWriterInterface< GridView , Vtk::StructuredDataCollector< GridView > >::compression_level

protectedinherited

◆ compressor_

Vtk::CompressorTypes Dune::VtkWriterInterface< GridView , Vtk::StructuredDataCollector< GridView > >::compressor_

protectedinherited

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

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

template<class GridView, class DataCollector = Vtk::StructuredDataCollector<GridView>> class Dune::VtkImageDataWriter< GridView, DataCollector >

Member Typedef Documentation

◆ DataCollector

◆ GridView

◆ VtkFunction

Member Enumeration Documentation

◆ PositionTypes

Member Function Documentation

◆ addCellData()

◆ addPointData()

◆ comm()

◆ getDatatype()

◆ getEndian()

◆ getFileExtension()

◆ getFormat()

◆ getNames()

◆ setCompressor()

◆ setDatatype()

◆ setFormat()

◆ setHeadertype()

◆ write()

◆ writeAppended()

◆ writeData()

◆ writeDataAppended()

◆ writeHeader()

◆ writePoints()

◆ writeValuesAppended()

◆ writeValuesAscii()

Member Data Documentation

◆ block_size

◆ compression_level

◆ compressor_

template<class GridView, class DataCollector = Vtk::StructuredDataCollector<GridView>>
class Dune::VtkImageDataWriter< GridView, DataCollector >