foamVtkCore.H File Reference
Include dependency graph for foamVtkCore.H:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces

namespace  Foam::vtk
 Namespace for handling VTK input/output.
 
namespace  Foam
 Namespace for OpenFOAM.
 
namespace  Foam::vtk::legacy
 Namespace for legacy VTK output constants and functions.
 

Enumerations

enum  OutputContext : uint8_t { INLINE , HEADER , APPEND }
 The context when outputting a VTK file (XML or legacy). More...
 
enum class  formatType : uint8_t {
  INLINE_ASCII = 0 , INLINE_BASE64 = 0x01 , APPEND_BASE64 = 0x11 , APPEND_BINARY = 0x12 ,
  LEGACY_ASCII = 0x20 , LEGACY_BINARY = 0x22
}
 The output format type for file contents. More...
 
enum  cellType : uint8_t {
  VTK_EMPTY_CELL = 0 , VTK_VERTEX = 1 , VTK_POLY_VERTEX = 2 , VTK_LINE = 3 ,
  VTK_POLY_LINE = 4 , VTK_TRIANGLE = 5 , VTK_TRIANGLE_STRIP = 6 , VTK_POLYGON = 7 ,
  VTK_PIXEL = 8 , VTK_QUAD = 9 , VTK_TETRA = 10 , VTK_VOXEL = 11 ,
  VTK_HEXAHEDRON = 12 , VTK_WEDGE = 13 , VTK_PYRAMID = 14 , VTK_PENTAGONAL_PRISM = 15 ,
  VTK_HEXAGONAL_PRISM = 16 , VTK_POLYHEDRON = 42
}
 Equivalent to enumeration in "vtkCellType.h" (should be uint8_t) More...
 
enum class  fileTag : uint8_t {
  VTK_FILE , DATA_ARRAY , BLOCK , PIECE ,
  DATA_SET , POINTS , CELLS , POLYS ,
  VERTS , LINES , CELL_DATA , POINT_DATA ,
  FIELD_DATA , POLY_DATA , UNSTRUCTURED_GRID , MULTI_BLOCK
}
 Some common XML tags for vtk files. More...
 
enum class  fileAttr : uint8_t {
  OFFSET , NUMBER_OF_COMPONENTS , NUMBER_OF_TUPLES , NUMBER_OF_POINTS ,
  NUMBER_OF_CELLS , NUMBER_OF_POLYS , NUMBER_OF_VERTS , NUMBER_OF_LINES
}
 Some common XML attributes for vtk files. More...
 
enum class  dataArrayAttr : uint8_t {
  POINTS , OFFSETS , CONNECTIVITY , TYPES ,
  FACES , FACEOFFSETS
}
 Some common names for XML DataArray entries. More...
 

Functions

bool isAppend (enum formatType fmt) noexcept
 Test for vtk append format (xml) More...
 
bool isLegacy (enum formatType fmt) noexcept
 Test for vtk legacy format. More...
 

Variables

const Foam::Enum< fileTag > fileExtension
 File extension (without ".") for some vtk XML file content types. More...
 
const Foam::Enum< fileTag > fileContentVersions
 Version string for some vtk XML file content types. More...
 
const Foam::Enum< fileTag > fileTagNames
 Strings corresponding to the vtk XML tags. More...
 
const Foam::Enum< fileAttr > fileAttrNames
 Strings corresponding to the vtk XML attributes. More...
 
const Foam::Enum< dataArrayAttr > dataArrayAttrNames
 Strings corresponding to the vtk XML DataArray attributes. More...
 
const word fileExtension
 Legacy file extension ("vtk") More...
 
const Foam::Enum< vtk::fileTag > contentNames
 Legacy content names (POLYDATA, UNSTRUCTURED_GRID) More...
 
const Foam::Enum< vtk::fileTag > fileTagNames
 Legacy file tags (eg, LINES, CELL_DATA, POINT_DATA, ...) More...
 
const Foam::Enum< dataArrayAttr > dataArrayAttrNames
 Legacy attributes (eg, OFFSETS) More...
 

Detailed Description

Original source file foamVtkCore.H

Definition in file foamVtkCore.H.