Dune Core Modules (unstable)

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>

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. 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.
 
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.
 
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.
 
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. More...
 

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
GridViewGrid 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
vtkWriterWriter object used to write the individual time step data files
rankProcess number in a multi-process setting
sizeTotal number of processes

Member Function Documentation

◆ addCellData()

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
vThe container with the values of the grid function for each cell
nameA name to identify the grid function
ncompsNumber of components (default is 1)

◆ addVertexData()

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
vThe container with the values of the grid function for each vertex
nameA name to identify the grid function
ncompsNumber of components (default is 1)

◆ 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
timeThe time(step) for the data to be written.
typeVTK output type.

The documentation for this class was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.80.0 (Mar 27, 23:31, 2024)