GEOSX
Public Member Functions | List of all members
geos::vtk::VTKPVDWriter Class Reference

VTK PVD Writer class. More...

#include <VTKPVDWriter.hpp>

Public Member Functions

 VTKPVDWriter (string fileName)
 Constructor. More...
 
void setFileName (string fileName)
 Set the output file name. More...
 
void save () const
 Triggers the file output.
 
void addData (real64 time, string const &filePath) const
 Add a dataset associated to a time-step. More...
 
void reinitData () const
 Removes all the datasets accumulated.
 

Detailed Description

VTK PVD Writer class.

the PVD file is the root file, it contains the reference to all the VTM files (one VTM file per output time-step). This file is meant to be open with paraview.

Definition at line 31 of file VTKPVDWriter.hpp.

Constructor & Destructor Documentation

◆ VTKPVDWriter()

geos::vtk::VTKPVDWriter::VTKPVDWriter ( string  fileName)
explicit

Constructor.

Parameters
[in]fileNamethe file name (with extension)

Member Function Documentation

◆ addData()

void geos::vtk::VTKPVDWriter::addData ( real64  time,
string const &  filePath 
) const

Add a dataset associated to a time-step.

Parameters
[in]timethe time step
[in]filePathpath to the file associated with the time-step

◆ setFileName()

void geos::vtk::VTKPVDWriter::setFileName ( string  fileName)

Set the output file name.

Parameters
fileNamethe file name (with extension)

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