geosx::vtk::VTKPolyDataWriterInterface Class Reference

Encapsulate output methods for vtk. More...

#include <VTKPolyDataWriterInterface.hpp>

Public Member Functions
	VTKPolyDataWriterInterface (string outputName)
	Constructor. More...
void	setPlotLevel (integer plotLevel)
	Sets the plot level. More...
void	setOutputMode (VTKOutputMode mode)
	Set the binary mode. More...
void	setOutputLocation (string outputDir, string outputName)
	Set the output directory name. More...
void	write (real64 time, integer cycle, DomainPartition const &domain)
	Main method of this class. Write all the files for one time step. More...

Detailed Description

Encapsulate output methods for vtk.

Definition at line 49 of file VTKPolyDataWriterInterface.hpp.

Constructor & Destructor Documentation

VTKPolyDataWriterInterface()

geosx::vtk::VTKPolyDataWriterInterface::VTKPolyDataWriterInterface ( string  outputName )

explicit

Constructor.

Parameters

[in]

outputName

folder name in which all the files will be written

Member Function Documentation

setOutputLocation()

void geosx::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 83 of file VTKPolyDataWriterInterface.hpp.

setOutputMode()

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

inline

Set the binary mode.

Parameters

[in]

mode

output mode to be set

Definition at line 73 of file VTKPolyDataWriterInterface.hpp.

setPlotLevel()

void geosx::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 64 of file VTKPolyDataWriterInterface.hpp.

write()

void geosx::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