Dune Core Modules (2.4.1)
Dump a .vtu/.vtp files contents to a stream. More...
#include <dune/grid/io/file/vtk/vtuwriter.hh>
Public Member Functions | |
VTUWriter (std::ostream &stream_, OutputType outputType, FileType fileType_) | |
create a VTUWriter object More... | |
~VTUWriter () | |
write footer | |
void | beginPointData (const std::string &scalars="", const std::string &vectors="") |
start PointData section More... | |
void | endPointData () |
finish PointData section | |
void | beginCellData (const std::string &scalars="", const std::string &vectors="") |
start CellData section More... | |
void | endCellData () |
finish CellData section | |
void | beginPoints () |
start section for the point coordinates More... | |
void | endPoints () |
finish section for the point coordinates | |
void | beginCells () |
start section for the grid cells/PolyData lines More... | |
void | endCells () |
start section for the grid cells/PolyData lines | |
void | beginMain (unsigned ncells, unsigned npoints) |
start the main PolyData/UnstructuredGrid section More... | |
void | endMain () |
finish the main PolyData/UnstructuredGrid section | |
bool | beginAppended () |
start the appended data section More... | |
void | endAppended () |
finish the appended data section | |
template<typename T > | |
DataArrayWriter< T > * | makeArrayWriter (const std::string &name, unsigned ncomps, unsigned nitems) |
aquire a DataArrayWriter More... | |
Detailed Description
Dump a .vtu/.vtp files contents to a stream.
This will help generating a .vtu/.vtp file. Typical use is like this:
The method dumpEverything() then looks something like this:
Constructor & Destructor Documentation
◆ VTUWriter()
|
inline |
create a VTUWriter object
- Parameters
-
stream_ Stream to write to. outputType How to encode data. fileType_ Whether to write PolyData (1D) or UnstructuredGrid (nD) format.
Create object and write header.
References DUNE_THROW, Dune::VTK::getEndiannessString(), Dune::VTK::polyData, and Dune::VTK::unstructuredGrid.
Member Function Documentation
◆ beginAppended()
|
inline |
start the appended data section
- Returns
- A value indicating whether the is an actual appended section required.
If this function returns true, an appended section is actually required. In this case, inbetween the call to this method and to endAppended(), there should be literally the same calls (including the same arguments) as between the calls to beginMain() and endMain(). The only exception is, that if a DataArrayWriter in the main section indicated that the calls to write could be skipped, this is not neccessarily true in the appended section also (you will have to ask the DataArrayWriter again).
If this function returns false, no appended section is required and a call to endAppeded() should immediately follow the call to this function.
References Dune::VTK::DataArrayWriterFactory::appendedEncoding(), and Dune::VTK::DataArrayWriterFactory::beginAppended().
◆ beginCellData()
|
inline |
start CellData section
- Parameters
-
scalars Name of field to which should be marked as default scalars field. If this is the empty string, don't set any default. vectors Name of field to which should be marked as default vectors field. If this is the empty string, don't set any default.
If there are no CellData fields, the call to this function may be skipped, together with the corresponding call to endCellData().
Referenced by Dune::SubsamplingVTKWriter< GridView >::writeCellData(), and Dune::VTKWriter< GridView >::writeCellData().
◆ beginCells()
|
inline |
start section for the grid cells/PolyData lines
Between the call to this method an the following call to the endCells(), there must be two or three fields written:
- "connectivity" of type Int32 with 3 components, number of items is the number of corners (that may be different from number of vertices!)
- "offsets" of type Int32 with one component, number of items is number of cells.
- for UnstructuredGrid, "types" of type UInt8 with one component, number of items is number of cells.
Referenced by Dune::SubsamplingVTKWriter< GridView >::writeGridCells(), and Dune::VTKWriter< GridView >::writeGridCells().
◆ beginMain()
|
inline |
start the main PolyData/UnstructuredGrid section
- Parameters
-
ncells Number of cells/lines. npoints Number of points.
Inbetween the call to this method and to endMain(), there should be calls to dump the actual data:
- (optional) beginCellData()/endCellData(),
- (optional) beginPointData()/endPointData(),
- beginPoints()/endPoints(),
- beginCells()/endCells(),
◆ beginPointData()
|
inline |
start PointData section
- Parameters
-
scalars Name of field to which should be marked as default scalars field. If this is the empty string, don't set any default. vectors Name of field to which should be marked as default vectors field. If this is the empty string, don't set any default.
If there are no PointData fields, the call to this function may be skipped, together with the corresponding call to endPointData().
Referenced by Dune::SubsamplingVTKWriter< GridView >::writeVertexData(), and Dune::VTKWriter< GridView >::writeVertexData().
◆ beginPoints()
|
inline |
start section for the point coordinates
Between the call to this method an the following call to the endPoints(), there must be a single field written. The name must be "Coordinates", it must have 3 components, and the number of items must be the number of points.
Referenced by Dune::SubsamplingVTKWriter< GridView >::writeGridPoints(), and Dune::VTKWriter< GridView >::writeGridPoints().
◆ makeArrayWriter()
|
inline |
aquire a DataArrayWriter
- Template Parameters
-
T Type of the data to write.
- Parameters
-
name Name of the array to write. ncomps Number of components of the vectors in the array. nitems Number of vectors in the array (number of cells/number of points/number of corners).
There should never be more than one DataArrayWriter created by the same VTUWriter around. The returned object should be freed with delete.
References Dune::VTK::DataArrayWriterFactory::make().
Referenced by Dune::VTK::VTKFunctionWriter< Func >::beginWrite(), Dune::VTK::CoordinatesWriter< Cell >::beginWrite(), Dune::VTK::ConformingConnectivityWriter< IteratorFactory >::beginWrite(), Dune::VTK::NonConformingConnectivityWriter< Cell >::beginWrite(), Dune::VTK::OffsetsWriter< Cell >::beginWrite(), Dune::VTK::TypesWriter< Cell >::beginWrite(), Dune::VTK::SkeletonFunctionWriter< Func >::beginWrite(), Dune::SubsamplingVTKWriter< GridView >::writeGridCells(), Dune::VTKWriter< GridView >::writeGridCells(), Dune::SubsamplingVTKWriter< GridView >::writeGridPoints(), and Dune::VTKWriter< GridView >::writeGridPoints().
The documentation for this class was generated from the following file:
- dune/grid/io/file/vtk/vtuwriter.hh