Dune Core Modules (2.4.2)

Dune::VTKSequenceWriter< GridView > Class Template Reference

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

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

Public Member Functions

 VTKSequenceWriter (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...
 
void addCellData (const shared_ptr< const typename VTKWriter< GridView >::VTKFunction > &p)
 Adds a field of cell data to the VTK file.
 
void addCellData (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 (typename VTKWriter< GridView >::VTKFunction *p)
 Adds a field of vertex data to the VTK file.
 
void addVertexData (const typename VTKWriter< GridView >::VTKFunctionPtr &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 ot=VTK::ascii)
 Writes VTK data for the given time,. 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 ( 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
nameBase 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
nameBase 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.
pathDirectory where to put the parallel collection (.pvtu/.pvtp) files. If it is relative, it is taken relative to the current directory.
extendpathDirectory 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()

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

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)

◆ write()

template<class GridView >
void Dune::VTKSequenceWriterBase< GridView >::write ( double  time,
VTK::OutputType  ot = VTK::ascii 
)
inlineinherited

Writes VTK data for the given time,.

Parameters
timeThe time(step) for the data to be written.
otVTK 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 (Apr 18, 22:30, 2024)