AMDiS 2.10
The Adaptive Multi-Dimensional Simulation Toolbox
VTKSequenceWriter< GridView > Class Template Reference

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

#include <VTKSequenceWriter.hpp>

Public Member Functions

 VTKSequenceWriter (std::shared_ptr< VTKWriter > vtkWriter)
 Set up the VTKSequenceWriter class. More...
 
template<class... Args>
 VTKSequenceWriter (GridView const &gridView, Args &&... args)
 Set up the VTKSequenceWriter class by creating a timestep writer of type VTKWriter. More...
 
std::shared_ptr< VTKWriter > const & vtkWriter () const
 accessor for the underlying VTKWriter instance
 
template<class... Args>
void addCellData (Args &&... args)
 Adds a field of cell data to the VTK file.
 
template<class... Args>
void addVertexData (Args &&... args)
 Adds a field of vertex data to the VTK file.
 
virtual void write (double time, std::string const &name, Dune::VTK::OutputType type=Dune::VTK::ascii)
 Writes VTK data for the given time,. More...
 
virtual void pwrite (double time, std::string const &name, std::string const &path, std::string const &extendpath, Dune::VTK::OutputType type=Dune::VTK::ascii)
 Writes VTK data for the given time,. More...
 

Static Protected Member Functions

static std::string seqName (std::string const &name, unsigned int count)
 
static std::string getParallelHeaderName (std::string const &name, std::string const &path, int commSize)
 

Detailed Description

template<class GridView>
class AMDiS::VTKSequenceWriter< GridView >

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

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

◆ VTKSequenceWriter() [1/2]

VTKSequenceWriter ( std::shared_ptr< VTKWriter >  vtkWriter)
inline

Set up the VTKSequenceWriter class.

Parameters
vtkWriterWriter object used to write the individual time step data files

◆ VTKSequenceWriter() [2/2]

VTKSequenceWriter ( GridView const &  gridView,
Args &&...  args 
)
inline

Set up the VTKSequenceWriter class by creating a timestep writer of type VTKWriter.

Parameters
gridViewGridView object passed to the constructor of the VTKWriter
args...Additional arguments forwarded to the VTKWriter constructor.

Member Function Documentation

◆ pwrite()

virtual void pwrite ( double  time,
std::string const &  name,
std::string const &  path,
std::string const &  extendpath,
Dune::VTK::OutputType  type = Dune::VTK::ascii 
)
inlinevirtual

Writes VTK data for the given time,.

Parameters
timeThe time(step) for the data to be written.
nameThe basename of the .pvd file (without file extension)
pathThe directory where to put the .pvd file
extendpathThe (relative) subdirectory to path, where to put the timestep files
typeVTK output type.

References Environment::mpiRank(), and Environment::mpiSize().

Referenced by VTKSequenceWriter< GridView >::write().

◆ write()

virtual void write ( double  time,
std::string const &  name,
Dune::VTK::OutputType  type = Dune::VTK::ascii 
)
inlinevirtual

Writes VTK data for the given time,.

Parameters
timeThe time(step) for the data to be written.
nameThe basename of the .pvd file (without file extension)
typeVTK output type.

References VTKSequenceWriter< GridView >::pwrite().


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