VTM Writer class. More...

Public Member Functions
	VTKVTMWriter (string filePath)
	Build the VTM Writer. More...

void	save () const
	Triggers the file output.

void	addBlock (string const &blockName) const
	Add a block to the VTM file. More...

void	addSubBlock (string const &blockName, string const &subBlockName) const
	Add a subblock to the VTM file. More...

void	addDataToSubBlock (string const &blockName, string const &subBlockName, string const &filePath, int mpiRank) const
	Add data to the subblock `subBlockName`. 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 29 of file VTKVTMWriter.hpp.

Constructor & Destructor Documentation

geosx::vtk::VTKVTMWriter::VTKVTMWriter ( string filePath )

explicit

Build the VTM Writer.

Parameters

[in] filePath path to the file

void geosx::vtk::VTKVTMWriter::addBlock ( string const & blockName ) const

Add a block to the VTM file.

The first level of block is for the ElementRegion (blockName can be CellElementRegion, FaceElementRegion or WellElementREgion)

Parameters

[in] blockName Name of the block

void geosx::vtk::VTKVTMWriter::addDataToSubBlock	(	string const &	blockName,
		string const &	subBlockName,
		string const &	filePath,
		int	mpiRank
	)		const

Add data to the subblock subBlockName.

The final level : paths to the vtu file per rank

Parameters

[in]	blockName	Name of the parent block
[in]	subBlockName	Name of the subBlock (usually the name of the Region)
[in]	filePath	path to the vtu file containing the unstructured mesh
[in]	mpiRank	the mpi rank.

void geosx::vtk::VTKVTMWriter::addSubBlock	(	string const &	blockName,
		string const &	subBlockName
	)		const

Add a subblock to the VTM file.

The second level of block is for the different Regions

Parameters

[in]	blockName	Name of the parent block
[in]	subBlockName	Name of the subBlock (usually the name of the Region)

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