geos::vtk::VTKPolyDataWriterInterface Class Reference

Encapsulate output methods for vtk. More...

#include <VTKPolyDataWriterInterface.hpp>

Public Member Functions
	VTKPolyDataWriterInterface (string outputName)
	Constructor. More...
void	setWriteGhostCells (bool writeGhostCells)
	Defines if the vtk outputs should contain the ghost cells. More...
void	setPlotLevel (integer plotLevel)
	Sets the plot level. More...
void	setOutputMode (VTKOutputMode mode)
	Set the binary mode. More...
void	setOutputRegionType (VTKRegionTypes regionType)
	Set the output region type. More...
void	setOutputLocation (string outputDir, string outputName)
	Set the output directory name. More...
void	setOnlyPlotSpecifiedFieldNamesFlag (integer const onlyPlotSpecifiedFieldNames)
	Set the flag to decide whether we only plot the fields specified by fieldNames, or if we also plot fields based on plotLevel. More...
void	setFieldNames (arrayView1d< string const > const &fieldNames)
	Set the names of the fields to output. More...
void	setLevelNames (arrayView1d< string const > const &levelNames)
	Set the names of the mesh levels to output. More...
void	write (real64 time, integer cycle, DomainPartition const &domain)
	Main method of this class. Write all the files for one time step. More...
void	clearData ()
	Clears the datasets accumulated in the pvd writer. More...

Detailed Description

Encapsulate output methods for vtk.

Definition at line 74 of file VTKPolyDataWriterInterface.hpp.

Constructor & Destructor Documentation

VTKPolyDataWriterInterface()

geos::vtk::VTKPolyDataWriterInterface::VTKPolyDataWriterInterface ( string  outputName )

explicit

Constructor.

Parameters

[in]

outputName

folder name in which all the files will be written

Member Function Documentation

clearData()

void geos::vtk::VTKPolyDataWriterInterface::clearData

(

)

Clears the datasets accumulated in the pvd writer.

setFieldNames()

void geos::vtk::VTKPolyDataWriterInterface::setFieldNames ( arrayView1d< string const > const &  fieldNames )

inline

Set the names of the fields to output.

Parameters

[in]

fieldNames

the fields to output

Definition at line 146 of file VTKPolyDataWriterInterface.hpp.

setLevelNames()

void geos::vtk::VTKPolyDataWriterInterface::setLevelNames ( arrayView1d< string const > const &  levelNames )

inline

Set the names of the mesh levels to output.

Parameters

[in]

levelNames

the mesh levels to output (an empty array means all levels are saved)

Definition at line 155 of file VTKPolyDataWriterInterface.hpp.

setOnlyPlotSpecifiedFieldNamesFlag()

void geos::vtk::VTKPolyDataWriterInterface::setOnlyPlotSpecifiedFieldNamesFlag ( integer const  onlyPlotSpecifiedFieldNames )

inline

Set the flag to decide whether we only plot the fields specified by fieldNames, or if we also plot fields based on plotLevel.

Parameters

[in]

onlyPlotSpecifiedFieldNames

the flag

Definition at line 137 of file VTKPolyDataWriterInterface.hpp.

setOutputLocation()

void geos::vtk::VTKPolyDataWriterInterface::setOutputLocation ( string  outputDir, string  outputName  )

inline

Set the output directory name.

Parameters

[in]	outputDir	global output directory location
[in]	outputName	name of the VTK output subdirectory and corresponding PVD file

Definition at line 126 of file VTKPolyDataWriterInterface.hpp.

setOutputMode()

void geos::vtk::VTKPolyDataWriterInterface::setOutputMode ( VTKOutputMode  mode )

inline

Set the binary mode.

Parameters

[in]

mode

output mode to be set

Definition at line 107 of file VTKPolyDataWriterInterface.hpp.

setOutputRegionType()

void geos::vtk::VTKPolyDataWriterInterface::setOutputRegionType ( VTKRegionTypes  regionType )

inline

Set the output region type.

Parameters

[in]

regionType

output region type to be set

Definition at line 116 of file VTKPolyDataWriterInterface.hpp.

setPlotLevel()

void geos::vtk::VTKPolyDataWriterInterface::setPlotLevel ( integer  plotLevel )

inline

Sets the plot level.

All fields have an associated plot level. If it is <= to plotLevel, the field will be output.

Parameters

[in]

plotLevel

the limit plotlevel

Definition at line 98 of file VTKPolyDataWriterInterface.hpp.

setWriteGhostCells()

void geos::vtk::VTKPolyDataWriterInterface::setWriteGhostCells ( bool  writeGhostCells )

inline

Defines if the vtk outputs should contain the ghost cells.

Parameters

writeGhostCells

The boolean flag.

Definition at line 87 of file VTKPolyDataWriterInterface.hpp.

write()

void geos::vtk::VTKPolyDataWriterInterface::write	(	real64	time,
		integer	cycle,
		DomainPartition const &	domain
	)

Main method of this class. Write all the files for one time step.

This method writes a .pvd file (if a previous one was created from a precedent time step, it is overwritten). The .pvd file contains relative path to every .vtm files (one vtm file per time step). This method triggers also the writing of a .vtm file. A .vtm file containts relative paths to blocks with the following hierarchy :

• CellElementRegion
  • CellElementRegion1
    • rank0
    • rank1
    • rank2
    • ...
  • CellElementRegion2
    • rank0
    • rank1
    • rank2
    • ...
  • ... -WellElementRegion
  • Well1
    • rank0
    • rank1
    • rank2
    • ...
  • Well2
    • rank0
    • rank1
    • rank2
    • ...

      Parameters

      [in]	time	the time step to be written
      [in]	cycle	the current cycle of event
      [in]	domain	the computation domain of this rank

---

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

• coreComponents/fileIO/vtk/VTKPolyDataWriterInterface.hpp