DUNE PDELab (2.8)
Dump a .vtu/.vtp files contents to a stream. More...
#include <dune/grid/io/file/vtk/pvtuwriter.hh>
Public Member Functions | |
PVTUWriter (std::ostream &stream_, FileType fileType_) | |
create a PVTUWriter object More... | |
~PVTUWriter () | |
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 | beginMain (unsigned ghostLevel=0) |
start the main PPolyData/PUnstructuredGrid section More... | |
void | endMain () |
finish the main PolyData/UnstructuredGrid section | |
void | addArray (const std::string &name, unsigned ncomps, Precision prec) |
Add an array to the output file. More... | |
void | addPiece (const std::string &filename) |
Add a serial piece to the output file. | |
Detailed Description
Dump a .vtu/.vtp files contents to a stream.
This will help generating a .vtu/.vtp file. Typical use is like this:
Constructor & Destructor Documentation
◆ PVTUWriter()
|
inline |
create a PVTUWriter object
- Parameters
-
stream_ Stream to write to. 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
◆ addArray()
|
inline |
Add an array to the output file.
- Template Parameters
-
T The datatype of the array.
- Parameters
-
name Name of the array. ncomps Number of components in each vector of the array. prec The output precision of the data array
References Dune::VTK::toString().
Referenced by Dune::VTK::VTKFunctionWriter< Func >::addArray(), Dune::VTK::CoordinatesWriter< Cell >::addArray(), Dune::VTK::ConformingConnectivityWriter< IteratorFactory >::addArray(), Dune::VTK::NonConformingConnectivityWriter< Cell >::addArray(), Dune::VTK::OffsetsWriter< Cell >::addArray(), Dune::VTK::TypesWriter< Cell >::addArray(), and Dune::VTK::SkeletonFunctionWriter< Func >::addArray().
◆ 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().
◆ beginMain()
|
inline |
start the main PPolyData/PUnstructuredGrid section
- Parameters
-
ghostLevel Set the GhostLevel attribute
Between the call to this method and to endMain(), there should be calls to add the actual data:
- (optional) beginCellData()/endCellData(),
- (optional) beginPointData()/endPointData(),
- beginPoints()/endPoints(),
- one or more calls to addPiece()
◆ 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().
◆ 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" and it must have 3 components.
The documentation for this class was generated from the following file:
- dune/grid/io/file/vtk/pvtuwriter.hh