Foam::vtk::legacy Namespace Reference

Namespace for legacy VTK output constants and functions. More...

Functions

void fileHeader (std::ostream &os, const std::string &title, bool binary)
 Emit header for legacy file (vtk DataFile Version 2.0) More...
 
void fileHeader (vtk::formatter &fmt, const std::string &title, const std::string &contentType)
 Emit header for legacy file, with "ASCII" or "BINARY" depending on the formatter type. More...
 
void fileHeader (vtk::formatter &fmt, const std::string &title, vtk::fileTag contentType)
 Emit header for legacy file, with "ASCII" or "BINARY" depending on the formatter type. More...
 
template<vtk::fileTag ContentType>
void fileHeader (vtk::formatter &fmt, const std::string &title)
 Emit header for legacy file, with "ASCII" or "BINARY" depending on the formatter type. More...
 
void beginPoints (std::ostream &os, label nPoints)
 Emit header for POINTS (with trailing newline). More...
 
void beginVerts (std::ostream &os, label nVerts, label nConnectivity=-1)
 Emit header for VERTICES (with trailing newline). More...
 
void beginLines (std::ostream &os, label nLines, label nConnectivity=-1)
 Emit header for LINES (with trailing newline). More...
 
void beginPolys (std::ostream &os, label nPolys, label nConnectivity)
 Emit header for POLYGONS (with trailing newline). More...
 
void fieldData (vtk::formatter &fmt, label nFields)
 Emit "FIELD FieldData <n>". More...
 
void beginFieldData (vtk::formatter &fmt, label nFields)
 Emit legacy FIELD FieldData nFields. More...
 
void beginCellData (vtk::formatter &fmt, label nCells, label nFields)
 Emit legacy CELL_DATA nCells, FIELD FieldData nFields. More...
 
void beginPointData (vtk::formatter &fmt, label nPoints, label nFields)
 Emit legacy POINT_DATA nPoints, FIELD FieldData nFields. More...
 
void writeTimeValue (vtk::formatter &fmt, scalar timeValue)
 Emit "TimeValue" for a FIELD entry (name as per Catalyst output) More...
 
template<direction nComp>
void floatField (vtk::formatter &fmt, const word &name, const label nEntries)
 Start output of float field with the specified name. More...
 
template<direction nComp>
void doubleField (vtk::formatter &fmt, const word &name, const label nEntries)
 Start output of double field with the specified name. More...
 
template<direction nComp>
void intField (vtk::formatter &fmt, const word &name, const label nEntries)
 Start output of int field with the specified name. More...
 

Variables

const word fileExtension
 Legacy file extension ("vtk") More...
 
const Foam::Enum< vtk::fileTagcontentNames
 Legacy content names (POLYDATA, UNSTRUCTURED_GRID) More...
 
const Foam::Enum< vtk::fileTagfileTagNames
 Legacy file tags (eg, LINES, CELL_DATA, POINT_DATA, ...) More...
 
const Foam::Enum< dataArrayAttrdataArrayAttrNames
 Legacy attributes (eg, OFFSETS) More...
 

Detailed Description

Namespace for legacy VTK output constants and functions.

Source files

Function Documentation

◆ fileHeader() [1/4]

void Foam::vtk::legacy::fileHeader ( std::ostream &  os,
const std::string &  title,
bool  binary 
)

Emit header for legacy file (vtk DataFile Version 2.0)

Writes "ASCII" or "BINARY" depending on specified type.

Referenced by fileHeader().

Here is the caller graph for this function:

◆ fileHeader() [2/4]

void Foam::vtk::legacy::fileHeader ( vtk::formatter fmt,
const std::string &  title,
const std::string &  contentType 
)

Emit header for legacy file, with "ASCII" or "BINARY" depending on the formatter type.

If the contentType is non-empty, it is used for "DATASET" line.

◆ fileHeader() [3/4]

void fileHeader ( vtk::formatter fmt,
const std::string &  title,
vtk::fileTag  contentType 
)
inline

Emit header for legacy file, with "ASCII" or "BINARY" depending on the formatter type.

Includes "DATASET" with the specified dataset type.

Definition at line 24 of file foamVtkOutputI.H.

References contentNames, and fileHeader().

Here is the call graph for this function:

◆ fileHeader() [4/4]

void fileHeader ( vtk::formatter fmt,
const std::string &  title 
)
inline

Emit header for legacy file, with "ASCII" or "BINARY" depending on the formatter type.

Includes "DATASET" of the templated dataset type.

Definition at line 36 of file foamVtkOutputI.H.

References contentNames, and fileHeader().

Here is the call graph for this function:

◆ beginPoints()

void beginPoints ( std::ostream &  os,
label  nPoints 
)
inline

Emit header for POINTS (with trailing newline).

Definition at line 45 of file foamVtkOutputI.H.

References Foam::vtk::fileTagNames, Foam::nl, and nPoints.

Referenced by VTKsurfaceFormatCore::writeHeader().

Here is the caller graph for this function:

◆ beginVerts()

void beginVerts ( std::ostream &  os,
label  nVerts,
label  nConnectivity = -1 
)
inline

Emit header for VERTICES (with trailing newline).

The nConnectivity is the sum of all connectivity points used, but without additional space for the size prefixes. The additional prefix sizes are added internally.

Note
With nConnectivity <= 0, assume one point per element

Definition at line 55 of file foamVtkOutputI.H.

References Foam::vtk::fileTagNames, and Foam::nl.

◆ beginLines()

void beginLines ( std::ostream &  os,
label  nLines,
label  nConnectivity = -1 
)
inline

Emit header for LINES (with trailing newline).

The nConnectivity is the sum of all connectivity points used, but without additional space for the size prefixes. The additional prefix sizes are added internally.

Note
With nConnectivity <= 0, assume two points per element

Definition at line 73 of file foamVtkOutputI.H.

References Foam::vtk::fileTagNames, and Foam::nl.

◆ beginPolys()

void beginPolys ( std::ostream &  os,
label  nPolys,
label  nConnectivity 
)
inline

Emit header for POLYGONS (with trailing newline).

The nConnectivity is the sum of all connectivity points used, but without additional space for the size prefixes. The additional prefix sizes are added internally.

Definition at line 91 of file foamVtkOutputI.H.

References Foam::vtk::fileTagNames, and Foam::nl.

Referenced by VTKsurfaceFormat< Face >::write().

Here is the caller graph for this function:

◆ fieldData()

void fieldData ( vtk::formatter fmt,
label  nFields 
)
inline

Emit "FIELD FieldData <n>".

Definition at line 105 of file foamVtkOutputI.H.

References Foam::nl, and formatter::os().

Referenced by beginCellData(), beginFieldData(), and beginPointData().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ beginFieldData()

void beginFieldData ( vtk::formatter fmt,
label  nFields 
)
inline

Emit legacy FIELD FieldData nFields.

Definition at line 116 of file foamVtkOutputI.H.

References fieldData().

Here is the call graph for this function:

◆ beginCellData()

void beginCellData ( vtk::formatter fmt,
label  nCells,
label  nFields 
)
inline

Emit legacy CELL_DATA nCells, FIELD FieldData nFields.

Definition at line 126 of file foamVtkOutputI.H.

References fieldData(), Foam::vtk::fileTagNames, Foam::nl, and formatter::os().

Referenced by VTKsurfaceFormatCore::writeCellData().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ beginPointData()

void beginPointData ( vtk::formatter fmt,
label  nPoints,
label  nFields 
)
inline

Emit legacy POINT_DATA nPoints, FIELD FieldData nFields.

Definition at line 141 of file foamVtkOutputI.H.

References fieldData(), Foam::vtk::fileTagNames, Foam::nl, nPoints, formatter::os(), and Foam::expressions::POINT_DATA.

Here is the call graph for this function:

◆ writeTimeValue()

void writeTimeValue ( vtk::formatter fmt,
scalar  timeValue 
)
inline

Emit "TimeValue" for a FIELD entry (name as per Catalyst output)

Definition at line 156 of file foamVtkOutputI.H.

◆ floatField()

void floatField ( vtk::formatter fmt,
const word name,
const label  nEntries 
)
inline

Start output of float field with the specified name.

Definition at line 183 of file foamVtkOutputI.H.

References Foam::nl, and formatter::os().

Here is the call graph for this function:

◆ doubleField()

void doubleField ( vtk::formatter fmt,
const word name,
const label  nEntries 
)
inline

Start output of double field with the specified name.

Definition at line 169 of file foamVtkOutputI.H.

References Foam::nl, and formatter::os().

Here is the call graph for this function:

◆ intField()

void intField ( vtk::formatter fmt,
const word name,
const label  nEntries 
)
inline

Start output of int field with the specified name.

Definition at line 197 of file foamVtkOutputI.H.

References Foam::nl, and formatter::os().

Here is the call graph for this function:

Variable Documentation

◆ fileExtension

const word fileExtension

Legacy file extension ("vtk")

Referenced by outputOptions::ext().

◆ contentNames

const Foam::Enum<vtk::fileTag> contentNames

Legacy content names (POLYDATA, UNSTRUCTURED_GRID)

Referenced by fileHeader().

◆ fileTagNames

const Foam::Enum<vtk::fileTag> fileTagNames

Legacy file tags (eg, LINES, CELL_DATA, POINT_DATA, ...)

◆ dataArrayAttrNames

const Foam::Enum<dataArrayAttr> dataArrayAttrNames

Legacy attributes (eg, OFFSETS)