VTK  9.2.5
vtkTecplotReader.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkTecplotReader.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
15 
16 /*****************************************************************************
17  *
18  * Copyright (c) 2000 - 2009, Lawrence Livermore National Security, LLC
19  * Produced at the Lawrence Livermore National Laboratory
20  * LLNL-CODE-400124
21  * All rights reserved.
22  *
23  * This file was adapted from the ASCII Tecplot reader of VisIt. For details,
24  * see https://visit.llnl.gov/. The full copyright notice is contained in the
25  * file COPYRIGHT located at the root of the VisIt distribution or at
26  * http://www.llnl.gov/visit/copyright.html.
27  *
28  *****************************************************************************/
29 
79 #ifndef vtkTecplotReader_h
80 #define vtkTecplotReader_h
81 
82 #include "vtkIOGeometryModule.h" // For export macro
84 
85 #include <string> // STL Header; Required for string
86 #include <vector> // STL Header; Required for vector
87 
88 class vtkPoints;
89 class vtkCellData;
90 class vtkPointData;
91 class vtkCallbackCommand;
95 class vtkTecplotReaderInternal;
96 
97 class VTKIOGEOMETRY_EXPORT vtkTecplotReader : public vtkMultiBlockDataSetAlgorithm
98 {
99 public:
102  void PrintSelf(ostream& os, vtkIndent indent) override;
103 
105 
108  vtkGetMacro(NumberOfVariables, int);
110 
114  void SetFileName(VTK_FILEPATH const char* fileName);
115 
119  const char* GetDataTitle();
120 
125 
130  const char* GetBlockName(int blockIdx);
131 
137 
142  const char* GetDataAttributeName(int attrIndx);
143 
149  int IsDataAttributeCellBased(const char* attrName);
150 
156  int IsDataAttributeCellBased(int attrIndx);
157 
162 
166  const char* GetDataArrayName(int arrayIdx);
167 
171  int GetDataArrayStatus(const char* arayName);
172 
177  void SetDataArrayStatus(const char* arayName, int bChecked);
178 
179 protected:
181  ~vtkTecplotReader() override;
182 
185  vtkInformationVector* outputVector) override;
187 
191  static void SelectionModifiedCallback(vtkObject*, unsigned long, void* tpReader, void*);
192 
198  void Init();
199 
204 
210 
218  int numNodes, int numCells, vtkPoints* theNodes, vtkPointData* nodeData, vtkCellData* cellData);
219 
228  void GetArraysFromPointPackingZone(int numNodes, vtkPoints* theNodes, vtkPointData* nodeData);
229 
237  void GetStructuredGridFromBlockPackingZone(int iDimSize, int jDimSize, int kDimSize, int zoneIndx,
238  const char* zoneName, vtkMultiBlockDataSet* multZone);
239 
247  void GetStructuredGridFromPointPackingZone(int iDimSize, int jDimSize, int kDimSize, int zoneIndx,
248  const char* zoneName, vtkMultiBlockDataSet* multZone);
249 
257  void GetUnstructuredGridFromBlockPackingZone(int numNodes, int numCells, const char* cellType,
258  int zoneIndx, const char* zoneName, vtkMultiBlockDataSet* multZone);
259 
267  void GetPolyhedralGridFromBlockPackingZone(int numNodes, int numElements, int numFaces,
268  int zoneIndex, const char* zoneName, vtkMultiBlockDataSet* multZone);
269 
277  void GetPolygonalGridFromBlockPackingZone(int numNodes, int numElements, int numFaces,
278  int zoneIndex, const char* zoneName, vtkMultiBlockDataSet* multZone);
279 
284  void GetPolyhedralGridCells(int numberCells, int numFaces, vtkUnstructuredGrid* unstruct) const;
285 
290  void GetPolygonalGridCells(int numFaces, int numEdges, vtkUnstructuredGrid* unstruct) const;
291 
299  void GetUnstructuredGridFromPointPackingZone(int numNodes, int numCells, const char* cellType,
300  int zoneIndx, const char* zoneName, vtkMultiBlockDataSet* multZone);
301 
307  int numberCells, const char* cellTypeStr, vtkUnstructuredGrid* unstrctGrid);
308 
310  char* FileName;
313  vtkTecplotReaderInternal* Internal;
314 
316  std::vector<int> CellBased;
317  std::vector<std::string> ZoneNames;
318  std::vector<std::string> Variables;
319 
320 private:
321  vtkTecplotReader(const vtkTecplotReader&) = delete;
322  void operator=(const vtkTecplotReader&) = delete;
323 };
324 
325 #endif
supports function callbacks
represent and manipulate cell attribute data
Definition: vtkCellData.h:151
Store on/off settings for data arrays, etc.
a simple class to control print indentation
Definition: vtkIndent.h:119
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Superclass for algorithms that produce only vtkMultiBlockDataSet as output.
Composite dataset that organizes datasets into blocks.
abstract base class for most VTK objects
Definition: vtkObject.h:82
represent and manipulate point attribute data
Definition: vtkPointData.h:151
represent and manipulate 3D points
Definition: vtkPoints.h:149
A concrete class to read an ASCII Tecplot file.
void ReadFile(vtkMultiBlockDataSet *multZone)
This function, the data loading engine, parses the Tecplot file to fill a vtkMultiBlockDataSet object...
void Init()
This function initializes the context.
void GetArraysFromPointPackingZone(int numNodes, vtkPoints *theNodes, vtkPointData *nodeData)
This function extracts each variable array from a point-packing (tuple- based) zone and collects the ...
int GetNumberOfDataArrays()
Get the number of all data attributes (point data and cell data).
const char * GetDataTitle()
Get the Tecplot data title.
int IsDataAttributeCellBased(const char *attrName)
Get the type (0 for node-based and 1 for cell-based) of a specified data attribute (not 3D coordinate...
void GetPolyhedralGridCells(int numberCells, int numFaces, vtkUnstructuredGrid *unstruct) const
This function fills an allocated vtkUnstructuredGrid object with numberCells polyhedral cells to defi...
void GetStructuredGridFromBlockPackingZone(int iDimSize, int jDimSize, int kDimSize, int zoneIndx, const char *zoneName, vtkMultiBlockDataSet *multZone)
This function creates a vtkStructuredGrid object made up of a set of points and the associated attrib...
int IsDataAttributeCellBased(int attrIndx)
Get the type (0 for node-based and 1 for cell-based) of a specified data attribute (not 3D coordinate...
void GetPolygonalGridFromBlockPackingZone(int numNodes, int numElements, int numFaces, int zoneIndex, const char *zoneName, vtkMultiBlockDataSet *multZone)
This function creates a polygonal vtkUnstructuredGrid object made up of a set of points and the assoc...
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkDataArraySelection * DataArraySelection
const char * GetDataAttributeName(int attrIndx)
Get the name of a zero-based data attribute (not 3D coordinates).
void GetPolyhedralGridFromBlockPackingZone(int numNodes, int numElements, int numFaces, int zoneIndex, const char *zoneName, vtkMultiBlockDataSet *multZone)
This function creates a polyhedral vtkUnstructuredGrid object made up of a set of points and the asso...
void SetFileName(VTK_FILEPATH const char *fileName)
Specify a Tecplot ASCII file for data loading.
int GetNumberOfDataAttributes()
Get the number of standard data attributes (node-based and cell-based), excluding 3D coordinates.
vtkTecplotReaderInternal * Internal
std::string DataTitle
void GetUnstructuredGridFromBlockPackingZone(int numNodes, int numCells, const char *cellType, int zoneIndx, const char *zoneName, vtkMultiBlockDataSet *multZone)
This function creates a vtkUnstructuredGrid object made up of a set of points and the associated attr...
const char * GetDataArrayName(int arrayIdx)
Get the name of a data array specified by the zero-based index (arrayIdx).
vtkCallbackCommand * SelectionObserver
void GetPolygonalGridCells(int numFaces, int numEdges, vtkUnstructuredGrid *unstruct) const
This function fills an allocated vtkUnstructuredGrid object with numberCells polygonal cells to defin...
int RequestInformation(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
This is called by the superclass.
~vtkTecplotReader() override
std::vector< std::string > Variables
std::vector< std::string > ZoneNames
static void SelectionModifiedCallback(vtkObject *, unsigned long, void *tpReader, void *)
A callback function registered with the selection observer.
void SetDataArrayStatus(const char *arayName, int bChecked)
Set the status of a specific data array (0: de-select; 1: select) specified by the name.
std::vector< int > CellBased
void GetArraysFromBlockPackingZone(int numNodes, int numCells, vtkPoints *theNodes, vtkPointData *nodeData, vtkCellData *cellData)
This function extracts each variable array from a block-packing (component- based) zone and collects ...
const char * GetBlockName(int blockIdx)
Get the name of a block specified by a zero-based index.
static vtkTecplotReader * New()
void GetUnstructuredGridFromPointPackingZone(int numNodes, int numCells, const char *cellType, int zoneIndx, const char *zoneName, vtkMultiBlockDataSet *multZone)
This function creates a vtkUnstructuredGrid object made up of a set of points and the associated attr...
void GetStructuredGridFromPointPackingZone(int iDimSize, int jDimSize, int kDimSize, int zoneIndx, const char *zoneName, vtkMultiBlockDataSet *multZone)
This function creates a vtkStructuredGrid object made up of a set of points and the associated attrib...
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
int GetNumberOfBlocks()
Get the number of blocks (i.e., zones in Tecplot terms).
void GetUnstructuredGridCells(int numberCells, const char *cellTypeStr, vtkUnstructuredGrid *unstrctGrid)
This function fills an allocated vtkUnstructuredGrid object with numberCells cells of type cellTypeSt...
int FillOutputPortInformation(int port, vtkInformation *info) override
Fill the output port information objects for this algorithm.
void GetDataArraysList()
Get the data arrays list from the tecplot file header.
int GetDataArrayStatus(const char *arayName)
Get the status of a specific data array (0: un-selected; 1: selected).
dataset represents arbitrary combinations of all possible cell types
@ info
Definition: vtkX3D.h:382
@ port
Definition: vtkX3D.h:453
@ string
Definition: vtkX3D.h:496
#define VTK_FILEPATH