Dune::VTKSequenceWriterBase< GridView > Class Template Reference

Base class to write pvd-files which contains a list of all collected vtk-files. More...

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

Inheritance diagram for Dune::VTKSequenceWriterBase< GridView >:

Public Member Functions
	VTKSequenceWriterBase (std::shared_ptr< VTKWriter< GridView > > vtkWriter, const std::string &name, const std::string &path, const std::string &extendpath, int rank, int size)
	Set up the VTKSequenceWriterBase class.
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.
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.
void	addVertexData (const std::shared_ptr< const typename VTKWriter< GridView >::VTKFunction > &p)
	Adds a field of vertex data to the VTK file.
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.
void	write (double time, VTK::OutputType type=VTK::ascii)
	Writes VTK data for the given time,.
void	clear ()
	Clears all VTK data added to the VTK writer.
const std::vector< double > &	getTimeSteps () const
	Retrieve the current list of time steps.
void	setTimeSteps (const std::vector< double > &timesteps)
	Set the current list of time steps.

Detailed Description

template<class GridView>
class Dune::VTKSequenceWriterBase< GridView >

Base class to write pvd-files which contains a list of all collected vtk-files.

Derive from this class to write pvd-file suitable for easy visualization with The Visualization Toolkit (VTK).

Template Parameters

GridView

Grid view of the grid we are writing

Constructor & Destructor Documentation

VTKSequenceWriterBase()

template<class GridView >

Dune::VTKSequenceWriterBase< GridView >::VTKSequenceWriterBase ( std::shared_ptr< VTKWriter< GridView > >  vtkWriter, const std::string &  name, const std::string &  path, const std::string &  extendpath, int  rank, int  size  )

inlineexplicit

Set up the VTKSequenceWriterBase class.

Parameters

vtkWriter	Writer object used to write the individual time step data files
rank	Process number in a multi-process setting
size	Total number of processes

Member Function Documentation

addCellData() [1/2]

template<class GridView >

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

inline

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  )

inline

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 )

inline

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  )

inline

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 ( )

inline

Clears all VTK data added to the VTK writer.

getTimeSteps()

template<class GridView >

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

inline

Retrieve the current list of time steps.

setTimeSteps()

template<class GridView >

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

inline

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

inline

accessor for the underlying VTKWriter instance

write()

template<class GridView >

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

inline

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:

• vtksequencewriterbase.hh