Loading...
Searching...
No Matches
vtkUnstructuredReader Class Reference

Reader for vtk UNSTRUCTURED_GRID legacy files. Supports single CELLS, POINTS etc. entry only. More...

#include <vtkUnstructuredReader.H>

Collaboration diagram for vtkUnstructuredReader:
Collaboration graph
[legend]

Public Types

enum  vtkDataType {
  VTK_INT , VTK_INT64 , VTK_UINT , VTK_LONG ,
  VTK_ULONG , VTK_FLOAT , VTK_DOUBLE , VTK_STRING ,
  VTK_ID
}
 Enumeration defining the vtk data types. More...
enum  vtkDataSetType { VTK_FIELD , VTK_SCALARS , VTK_VECTORS }
 Enumeration defining the vtk dataset types. More...
enum  parseMode {
  NOMODE , UNSTRUCTURED_GRID , POLYDATA , CELL_DATA ,
  POINT_DATA
}
 Enumeration defining the parse mode - type of data being read. More...

Public Member Functions

 ClassName ("vtkUnstructuredReader")
 Runtime type information.
 vtkUnstructuredReader (const objectRegistry &obr, ISstream &is)
 Construct from input stream, read all.
const string & header () const noexcept
 Header.
const string & title () const noexcept
 Title.
const string & dataType () const noexcept
 DataType.
const pointField & points () const noexcept
 Points.
pointField & points () noexcept
const cellShapeList & cells () const noexcept
 3D cells
cellShapeList & cells () noexcept
const labelList & cellMap () const noexcept
const faceList & faces () const noexcept
 2D cells (=faces)
faceList & faces () noexcept
const labelList & faceMap () const noexcept
const labelListList & lines () const noexcept
 1D cells (=open lines)
labelListList & lines () noexcept
const labelList & lineMap () const noexcept
const objectRegistry & cellData () const noexcept
 Cell based fields.
objectRegistry & cellData () noexcept
const objectRegistry & pointData () const noexcept
 Point based fields.
objectRegistry & pointData () noexcept
const objectRegistry & otherData () const noexcept
 Other fields.
objectRegistry & otherData () noexcept

Static Public Member Functions

template<class Type>
static void printFieldStats (const objectRegistry &)
 Debug: print contents of objectRegistry.

Static Public Attributes

static const Enum< vtkDataType > vtkDataTypeNames
static const Enum< vtkDataSetType > vtkDataSetTypeNames
static const Enum< parseMode > parseModeNames

Detailed Description

Reader for vtk UNSTRUCTURED_GRID legacy files. Supports single CELLS, POINTS etc. entry only.

  • all integer types (int, unsigned_int, long etc.) become Foam::label
  • all real types (float, double) become Foam::scalar
  • POINTS becomes OpenFOAM points
  • CELLS gets split into OpenFOAM
    • cells
    • faces
    • lines
  • CELL_DATA or POINT_DATA gets stored on the corresponding objectRegistry in original vtk numbering order so use e.g. faceMap() to go from entry in faces() back to vtk numbering.
Source files

Definition at line 64 of file vtkUnstructuredReader.H.

Member Enumeration Documentation

◆ vtkDataType

enum vtkDataType

Enumeration defining the vtk data types.

Enumerator
VTK_INT 
VTK_INT64 
VTK_UINT 
VTK_LONG 
VTK_ULONG 
VTK_FLOAT 
VTK_DOUBLE 
VTK_STRING 
VTK_ID 

Definition at line 73 of file vtkUnstructuredReader.H.

◆ vtkDataSetType

enum vtkDataSetType

Enumeration defining the vtk dataset types.

Enumerator
VTK_FIELD 
VTK_SCALARS 
VTK_VECTORS 

Definition at line 92 of file vtkUnstructuredReader.H.

◆ parseMode

enum parseMode

Enumeration defining the parse mode - type of data being read.

Enumerator
NOMODE 
UNSTRUCTURED_GRID 
POLYDATA 
CELL_DATA 
POINT_DATA 

Definition at line 105 of file vtkUnstructuredReader.H.

Constructor & Destructor Documentation

◆ vtkUnstructuredReader()

vtkUnstructuredReader ( const objectRegistry & obr,
ISstream & is )

Construct from input stream, read all.

Member Function Documentation

◆ ClassName()

ClassName ( "vtkUnstructuredReader" )

Runtime type information.

◆ header()

const string & header ( ) const
inlinenoexcept

Header.

Definition at line 282 of file vtkUnstructuredReader.H.

References Foam::noexcept.

◆ title()

const string & title ( ) const
inlinenoexcept

Title.

Definition at line 290 of file vtkUnstructuredReader.H.

References Foam::noexcept.

◆ dataType()

const string & dataType ( ) const
inlinenoexcept

DataType.

Definition at line 298 of file vtkUnstructuredReader.H.

References Foam::noexcept.

◆ points() [1/2]

const pointField & points ( ) const
inlinenoexcept

Points.

Definition at line 307 of file vtkUnstructuredReader.H.

References Foam::noexcept.

Referenced by VTKedgeFormat::read(), and VTKsurfaceFormat< Face >::read().

Here is the caller graph for this function:

◆ points() [2/2]

pointField & points ( )
inlinenoexcept

Definition at line 312 of file vtkUnstructuredReader.H.

References Foam::noexcept.

◆ cells() [1/2]

const cellShapeList & cells ( ) const
inlinenoexcept

3D cells

Definition at line 320 of file vtkUnstructuredReader.H.

References Foam::noexcept.

◆ cells() [2/2]

cellShapeList & cells ( )
inlinenoexcept

Definition at line 325 of file vtkUnstructuredReader.H.

References Foam::noexcept.

◆ cellMap()

const labelList & cellMap ( ) const
inlinenoexcept

Definition at line 330 of file vtkUnstructuredReader.H.

References Foam::noexcept.

◆ faces() [1/2]

const faceList & faces ( ) const
inlinenoexcept

2D cells (=faces)

Definition at line 338 of file vtkUnstructuredReader.H.

References Foam::noexcept.

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

Here is the caller graph for this function:

◆ faces() [2/2]

faceList & faces ( )
inlinenoexcept

Definition at line 343 of file vtkUnstructuredReader.H.

References Foam::noexcept.

◆ faceMap()

const labelList & faceMap ( ) const
inlinenoexcept

Definition at line 348 of file vtkUnstructuredReader.H.

References Foam::noexcept.

◆ lines() [1/2]

const labelListList & lines ( ) const
inlinenoexcept

1D cells (=open lines)

Definition at line 356 of file vtkUnstructuredReader.H.

References Foam::noexcept.

Referenced by VTKedgeFormat::read().

Here is the caller graph for this function:

◆ lines() [2/2]

labelListList & lines ( )
inlinenoexcept

Definition at line 361 of file vtkUnstructuredReader.H.

References Foam::noexcept.

◆ lineMap()

const labelList & lineMap ( ) const
inlinenoexcept

Definition at line 366 of file vtkUnstructuredReader.H.

References Foam::noexcept.

◆ cellData() [1/2]

const objectRegistry & cellData ( ) const
inlinenoexcept

Cell based fields.

Definition at line 374 of file vtkUnstructuredReader.H.

References Foam::noexcept.

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

Here is the caller graph for this function:

◆ cellData() [2/2]

objectRegistry & cellData ( )
inlinenoexcept

Definition at line 379 of file vtkUnstructuredReader.H.

References Foam::noexcept.

◆ pointData() [1/2]

const objectRegistry & pointData ( ) const
inlinenoexcept

Point based fields.

Definition at line 387 of file vtkUnstructuredReader.H.

References Foam::noexcept.

◆ pointData() [2/2]

objectRegistry & pointData ( )
inlinenoexcept

Definition at line 392 of file vtkUnstructuredReader.H.

References Foam::noexcept.

◆ otherData() [1/2]

const objectRegistry & otherData ( ) const
inlinenoexcept

Other fields.

Definition at line 400 of file vtkUnstructuredReader.H.

References Foam::noexcept.

◆ otherData() [2/2]

objectRegistry & otherData ( )
inlinenoexcept

Definition at line 405 of file vtkUnstructuredReader.H.

References Foam::noexcept.

◆ printFieldStats()

template<class Type>
void printFieldStats ( const objectRegistry & )
static

Debug: print contents of objectRegistry.

Member Data Documentation

◆ vtkDataTypeNames

const Enum<vtkDataType> vtkDataTypeNames
static

Definition at line 86 of file vtkUnstructuredReader.H.

◆ vtkDataSetTypeNames

const Enum<vtkDataSetType> vtkDataSetTypeNames
static

Definition at line 99 of file vtkUnstructuredReader.H.

◆ parseModeNames

const Enum<parseMode> parseModeNames
static

Definition at line 114 of file vtkUnstructuredReader.H.

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