Loading...
Searching...
No Matches
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 output. Contains classes and functions for writing VTK file content.
namespace  Foam::vtk::legacy
 Namespace for legacy VTK output constants and functions.
namespace  Foam::vtk::Tools
 A collection of static methods to assist converting OpenFOAM data structures into VTK internal data structures.
namespace  Foam
 Namespace for OpenFOAM.

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 , HDF_FORMAT = 0x40
}
 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 {
  UNKNOWN , 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 , VTK_HDF
}
 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).
bool isLegacy (enum formatType fmt) noexcept
 Test for vtk legacy format.
bool isHDF (enum formatType fmt) noexcept
 Test for HDF format.
template<class Type>
Type copyTuple (const Type &value)
 Return a copy of the value, with components changed from OpenFOAM order to VTK order (for symmTensor).
template<class FloatType, class Type>
const FloatType * copyTuple_impl (FloatType output[], const Type &value)
 Implementation detail - not for general use!
template<class Type>
const double * copyTuple (double output[], const Type &value)
 Copy/transcribe components of OpenFOAM value to the output buffer (which must be large enough to contain all components).
template<class Type>
const float * copyTuple (float output[], const Type &value)
 Copy/transcribe components of OpenFOAM value to the output buffer (which must be large enough to contain all components).
template<class Type>
void reorderTuple (Type &value)
 Inplace component reordering of value from OpenFOAM order to VTK order.

Variables

const Foam::Enum< fileTagfileExtension
 File extension (without ".") for some vtk XML file content types.
const Foam::Enum< fileTagfileContentVersions
 Version string for some vtk XML file content types.
const Foam::Enum< fileTagfileTagNames
 Strings corresponding to the vtk XML tags.
const Foam::Enum< fileAttrfileAttrNames
 Strings corresponding to the vtk XML attributes.
const Foam::Enum< dataArrayAttrdataArrayAttrNames
 Strings corresponding to the vtk XML DataArray attributes.
const word fileExtension
 Legacy file extension ("vtk").
const Foam::Enum< vtk::fileTagcontentNames
 Legacy content names (POLYDATA, UNSTRUCTURED_GRID).
const Foam::Enum< vtk::fileTagfileTagNames
 Legacy file tags (eg, LINES, CELL_DATA, POINT_DATA, ...).
const Foam::Enum< dataArrayAttrdataArrayAttrNames
 Legacy attributes (eg, OFFSETS).

Detailed Description

Original source file foamVtkCore.H

Definition in file foamVtkCore.H.