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

VTM Writer class. More...

#include <VTKVTMWriter.hpp>

Public Member Functions

 VTKVTMWriter (string filePath)
 Build the VTM Writer. More...
 
void write () const
 Triggers the file output.
 
void addDataSet (std::vector< string > const &blockPath, string const &dataSetName, string const &filePath) const
 Add a dataset block to the VTM file. More...
 

Detailed Description

VTM Writer class.

a VTM file is the root file for one time step. It will contain path to all the component of the mesh (Surfaces, Volumes, Wells etc.).

Definition at line 30 of file VTKVTMWriter.hpp.

Constructor & Destructor Documentation

◆ VTKVTMWriter()

geos::vtk::VTKVTMWriter::VTKVTMWriter ( string  filePath)
explicit

Build the VTM Writer.

Parameters
[in]filePathpath to the file

Member Function Documentation

◆ addDataSet()

void geos::vtk::VTKVTMWriter::addDataSet ( std::vector< string > const &  blockPath,
string const &  dataSetName,
string const &  filePath 
) const

Add a dataset block to the VTM file.

Parameters
[in]blockPathpath consisting of intermediate block names that will be created on demand
[in]dataSetNamename of the dataset (leaf level in the multi-block tree)
[in]filePathpath to the dataset file

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