Writer for the ouput of grid functions in the vtk format. More...

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

Inheritance diagram for Dune::VTKSequenceWriter< GridView >:

Public Member Functions
	VTKSequenceWriter (std::shared_ptr< VTKWriter< GridView > > vtkWriter, const std::string &name)
	Constructor with a given VTKWriter or SubsamplingVTKWriter. More...

	VTKSequenceWriter (std::shared_ptr< VTKWriter< GridView > > vtkWriter, const std::string &name, const std::string &path, const std::string &extendpath)
	Constructor with a given VTKWriter or SubsamplingVTKWriter. More...

	VTKSequenceWriter (const GridView &gridView, const std::string &name, const std::string &path, const std::string &extendpath, VTK::DataMode dm=VTK::conforming)
	Constructor creating its own VTKWriter object. More...

const std::shared_ptr< VTKWriter< GridView > > &	vtkWriter () const

void	addCellData (const std::shared_ptr< const typename VTKWriter< GridView >::VTKFunction > &p)
	Adds a field of cell data to the VTK file. More...

template<class V >
void	addCellData (const V &v, const std::string &name, int ncomps=1)
	Adds a field of cell data to the VTK file. More...

void	addVertexData (const std::shared_ptr< const typename VTKWriter< GridView >::VTKFunction > &p)
	Adds a field of vertex data to the VTK file. More...

template<class V >
void	addVertexData (const V &v, const std::string &name, int ncomps=1)
	Adds a field of vertex data to the VTK file. More...

void	write (double time, VTK::OutputType type=VTK::ascii)
	Writes VTK data for the given time,. More...

void	clear ()
	Clears all VTK data added to the VTK writer. More...

const std::vector< double > &	getTimeSteps () const
	Retrieve the current list of time steps. More...

void	setTimeSteps (const std::vector< double > &timesteps)
	Set the current list of time steps. More...

Detailed Description

template<class GridView>
class Dune::VTKSequenceWriter< GridView >

Writer for the ouput of grid functions in the vtk format.

Writes arbitrary grid functions (living on cells or vertices of a grid) to a file suitable for easy visualization with The Visualization Toolkit (VTK).

Constructor & Destructor Documentation

◆ VTKSequenceWriter() [1/3]

template<class GridView >

Dune::VTKSequenceWriter< GridView >::VTKSequenceWriter	(	std::shared_ptr< VTKWriter< GridView > >	vtkWriter,
		const std::string &	name
	)

inline

Constructor with a given VTKWriter or SubsamplingVTKWriter.

At each time step, the VTKSequenceWriter writes the grid and data currently attached to the vtkWriter object. All calls to the addCellData and addVertexData methods of the VTKSequenceWriter class are forwarded to the vtkWriter, but we propose that you call the corresponding methods on the vtkWriter directly.

Parameters

name	Base name of the output files. This should not contain any directory part and not filename extensions. It will be used both for each processes piece as well as the parallel collection file.

◆ VTKSequenceWriter() [2/3]

template<class GridView >

Dune::VTKSequenceWriter< GridView >::VTKSequenceWriter	(	std::shared_ptr< VTKWriter< GridView > >	vtkWriter,
		const std::string &	name,
		const std::string &	path,
		const std::string &	extendpath
	)

inline

Constructor with a given VTKWriter or SubsamplingVTKWriter.

At each time step, the VTKSequenceWriter writes the grid and data currently attached to the vtkWriter object. All calls to the addCellData and addVertexData methods of the VTKSequenceWriter class are forwarded to the vtkWriter, but we propose that you call the corresponding methods on the vtkWriter directly.

Parameters

name	Base name of the output files. This should not contain any directory part and not filename extensions. It will be used both for each processes piece as well as the parallel collection file.
path	Directory where to put the parallel collection (.pvtu/.pvtp) files. If it is relative, it is taken relative to the current directory.
extendpath	Directory where to put the piece files (.vtu/.vtp) of this process. If it is relative, it is taken relative to the directory denoted by path.

◆ VTKSequenceWriter() [3/3]

template<class GridView >

Dune::VTKSequenceWriter< GridView >::VTKSequenceWriter	(	const GridView &	gridView,
		const std::string &	name,
		const std::string &	path,
		const std::string &	extendpath,
		VTK::DataMode	dm = `VTK::conforming`
	)

inlineexplicit

Constructor creating its own VTKWriter object.

At each time step, the VTKSequenceWriter writes the grid and data currently attached to the vtkWriter object. All calls to the addCellData and addVertexData methods of the VTKSequenceWriter class are forwarded to the vtkWriter.

Member Function Documentation

◆ addCellData() [1/2]

template<class GridView >

void Dune::VTKSequenceWriterBase< GridView >::addCellData ( const std::shared_ptr< const typename VTKWriter< GridView >::VTKFunction > & p )

inlineinherited

Adds a field of cell data to the VTK file.

◆ addCellData() [2/2]

template<class GridView >

template<class V >

void Dune::VTKSequenceWriterBase< GridView >::addCellData	(	const V &	v,
		const std::string &	name,
		int	ncomps = `1`
	)

inlineinherited

Adds a field of cell data to the VTK file.

Parameters

v	The container with the values of the grid function for each cell
name	A name to identify the grid function
ncomps	Number of components (default is 1)

◆ addVertexData() [1/2]

template<class GridView >

void Dune::VTKSequenceWriterBase< GridView >::addVertexData ( const std::shared_ptr< const typename VTKWriter< GridView >::VTKFunction > & p )

inlineinherited

Adds a field of vertex data to the VTK file.

◆ addVertexData() [2/2]

template<class GridView >

template<class V >

void Dune::VTKSequenceWriterBase< GridView >::addVertexData	(	const V &	v,
		const std::string &	name,
		int	ncomps = `1`
	)

inlineinherited

Adds a field of vertex data to the VTK file.

Parameters

v	The container with the values of the grid function for each vertex
name	A name to identify the grid function
ncomps	Number of components (default is 1)

◆ clear()

template<class GridView >

void Dune::VTKSequenceWriterBase< GridView >::clear ( )

inlineinherited

Clears all VTK data added to the VTK writer.

◆ getTimeSteps()

template<class GridView >

const std::vector< double > & Dune::VTKSequenceWriterBase< GridView >::getTimeSteps ( ) const

inlineinherited

Retrieve the current list of time steps.

◆ setTimeSteps()

template<class GridView >

void Dune::VTKSequenceWriterBase< GridView >::setTimeSteps ( const std::vector< double > & timesteps )

inlineinherited

Set the current list of time steps.

Note: This makes it possible to serialize the sequence writers state. Can be used to continue writing a VTK sequence after a restart of the program.

◆ vtkWriter()

template<class GridView >

const std::shared_ptr< VTKWriter< GridView > > & Dune::VTKSequenceWriterBase< GridView >::vtkWriter ( ) const

inlineinherited

accessor for the underlying VTKWriter instance

◆ write()

template<class GridView >

void Dune::VTKSequenceWriterBase< GridView >::write	(	double	time,
		VTK::OutputType	type = `VTK::ascii`
	)

inlineinherited

Writes VTK data for the given time,.

Parameters

time	The time(step) for the data to be written.
type	VTK output type.

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

vtksequencewriter.hh

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ VTKSequenceWriter() [1/3]

◆ VTKSequenceWriter() [2/3]

◆ VTKSequenceWriter() [3/3]

Member Function Documentation

◆ addCellData() [1/2]

◆ addCellData() [2/2]

◆ addVertexData() [1/2]

◆ addVertexData() [2/2]

◆ clear()

◆ getTimeSteps()

◆ setTimeSteps()

◆ vtkWriter()

◆ write()