You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
300 lines
11 KiB
C++
300 lines
11 KiB
C++
/*=========================================================================
|
|
|
|
Program: Visualization Toolkit
|
|
Module: vtkTecplotReader.h
|
|
|
|
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
|
|
All rights reserved.
|
|
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
|
|
|
|
This software is distributed WITHOUT ANY WARRANTY; without even
|
|
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
|
|
PURPOSE. See the above copyright notice for more information.
|
|
|
|
=========================================================================*/
|
|
|
|
/*****************************************************************************
|
|
*
|
|
* Copyright (c) 2000 - 2009, Lawrence Livermore National Security, LLC
|
|
* Produced at the Lawrence Livermore National Laboratory
|
|
* LLNL-CODE-400124
|
|
* All rights reserved.
|
|
*
|
|
* This file was adapted from the ASCII Tecplot reader of VisIt. For details,
|
|
* see https://visit.llnl.gov/. The full copyright notice is contained in the
|
|
* file COPYRIGHT located at the root of the VisIt distribution or at
|
|
* http://www.llnl.gov/visit/copyright.html.
|
|
*
|
|
*****************************************************************************/
|
|
|
|
/**
|
|
* @class vtkTecplotReader
|
|
* @brief A concrete class to read an ASCII Tecplot file.
|
|
*
|
|
*
|
|
* vtkTecplotReader parses an ASCII Tecplot file to get a vtkMultiBlockDataSet
|
|
* object made up of several vtkDataSet objects, of which each is of type
|
|
* either vtkStructuredGrid or vtkUnstructuredGrid. Each vtkDataSet object
|
|
* maintains the geometry, topology, and some associated attributes describing
|
|
* physical properties.
|
|
*
|
|
* Tecplot treats 3D coordinates (only one or two coordinates might be
|
|
* explicitly specified in a file) as varaibles too, whose names (e.g.,
|
|
* 'X' / 'x' / 'I', 'Y' / 'y' / 'J', 'Z' / 'z' / 'K') are provided in the
|
|
* variables list (the 'VARIABLES' section). These names are then followed
|
|
* in the list by those of other traditional variables or attributes (node-
|
|
* based and / or cell-based data with the mode specified via token 'VAR
|
|
* LOCATION', to be extracted to create vtkPointData and / or vtkCellData).
|
|
* Each zone described afterwards (in the 'ZONE's section) provides the
|
|
* specific values of the aforementioned variables (including 3D coordinates),
|
|
* in the same order as indicated by the variable-names list, through either
|
|
* POINT-packing (i.e., tuple-based storage) or BLOCK-packing (component-based
|
|
* storage). In particular, the first / description line of each zone tells
|
|
* the type of all the constituent cells as the connectivity / topology
|
|
* information. In other words, the entire dataset is made up of multiple zones
|
|
* (blocks), of which each maintains a set of cells of the same type ('BRICK',
|
|
* 'TRIANGLE', 'QUADRILATERAL', 'TETRAHEDRON', and 'POINT' in Tecplot terms).
|
|
* In addition, the description line of each zone specifies the zone name,
|
|
* dimensionality information (size of each dimension for a structured zone),
|
|
* number of nodes, and number of cells. Information about the file format is
|
|
* available at http://download.tecplot.com/360/dataformat.pdf.
|
|
*
|
|
* @warning
|
|
* vtkTecplotReader is currently a simplified ASCII Tecplot reader and some
|
|
* functionalities (e.g., extraction of sections 'GEOMETRY', 'TEXT', and 'DATA
|
|
* SETAUXDATA', access to multiple time steps, in addition to the construction
|
|
* of vtkRectilinearGrid and vtkImageData objects) are not supported.
|
|
*
|
|
* @par Thanks:
|
|
* This class is a VTK implementation of VisIt's ASCII Tecplot reader.
|
|
*
|
|
* @sa
|
|
* vtkPoints vtkStructuredGrid vtkUnstructuredGrid vtkPointData vtkCellData
|
|
* vtkDataSet vtkMultiBlockDataSet
|
|
*/
|
|
|
|
#ifndef vtkTecplotReader_h
|
|
#define vtkTecplotReader_h
|
|
|
|
#include "vtkIOGeometryModule.h" // For export macro
|
|
#include "vtkMultiBlockDataSetAlgorithm.h"
|
|
|
|
#include <vector> // STL Header; Required for vector
|
|
#include <string> // STL Header; Required for string
|
|
|
|
class vtkPoints;
|
|
class vtkCellData;
|
|
class vtkPointData;
|
|
class vtkCallbackCommand;
|
|
class vtkUnstructuredGrid;
|
|
class vtkMultiBlockDataSet;
|
|
class vtkDataArraySelection;
|
|
class vtkTecplotReaderInternal;
|
|
|
|
class VTKIOGEOMETRY_EXPORT vtkTecplotReader : public vtkMultiBlockDataSetAlgorithm
|
|
{
|
|
public:
|
|
static vtkTecplotReader * New();
|
|
vtkTypeMacro( vtkTecplotReader, vtkMultiBlockDataSetAlgorithm );
|
|
void PrintSelf( ostream & os, vtkIndent indent );
|
|
|
|
//@{
|
|
/**
|
|
* Get the number of all variables (including 3D coordinates).
|
|
*/
|
|
vtkGetMacro( NumberOfVariables, int );
|
|
//@}
|
|
|
|
/**
|
|
* Specify a Tecplot ASCII file for data loading.
|
|
*/
|
|
void SetFileName( const char * fileName );
|
|
|
|
/**
|
|
* Get the Tecplot data title.
|
|
*/
|
|
const char * GetDataTitle();
|
|
|
|
/**
|
|
* Get the number of blocks (i.e., zones in Tecplot terms).
|
|
*/
|
|
int GetNumberOfBlocks();
|
|
|
|
/**
|
|
* Get the name of a block specified by a zero-based index. NULL is returned
|
|
* for an invalid block index.
|
|
*/
|
|
const char * GetBlockName( int blockIdx );
|
|
|
|
/**
|
|
* Get the number of standard data attributes (node-based and cell-based),
|
|
* excluding 3D coordinates.
|
|
*/
|
|
int GetNumberOfDataAttributes();
|
|
|
|
/**
|
|
* Get the name of a zero-based data attribute (not 3D coordinates). NULL is
|
|
* returned for an invalid attribute index.
|
|
*/
|
|
const char * GetDataAttributeName( int attrIndx );
|
|
|
|
/**
|
|
* Get the type (0 for node-based and 1 for cell-based) of a specified data
|
|
* attribute (not 3D coordinates). -1 is returned for an invalid attribute
|
|
* name.
|
|
*/
|
|
int IsDataAttributeCellBased( const char * attrName );
|
|
|
|
/**
|
|
* Get the type (0 for node-based and 1 for cell-based) of a specified data
|
|
* attribute (not 3D coordinates). -1 is returned for an invalid attribute
|
|
* index.
|
|
*/
|
|
int IsDataAttributeCellBased( int attrIndx );
|
|
|
|
/**
|
|
* Get the number of all data attributes (point data and cell data).
|
|
*/
|
|
int GetNumberOfDataArrays();
|
|
|
|
/**
|
|
* Get the name of a data array specified by the zero-based index (arrayIdx).
|
|
*/
|
|
const char * GetDataArrayName( int arrayIdx );
|
|
|
|
/**
|
|
* Get the status of a specific data array (0: un-selected; 1: selected).
|
|
*/
|
|
int GetDataArrayStatus( const char * arayName );
|
|
|
|
/**
|
|
* Set the status of a specific data array (0: de-select; 1: select) specified
|
|
* by the name.
|
|
*/
|
|
void SetDataArrayStatus( const char * arayName, int bChecked );
|
|
|
|
protected:
|
|
vtkTecplotReader();
|
|
~vtkTecplotReader();
|
|
|
|
virtual int FillOutputPortInformation( int port, vtkInformation * info );
|
|
virtual int RequestInformation( vtkInformation * request,
|
|
vtkInformationVector ** inputVector,
|
|
vtkInformationVector * outputVector );
|
|
virtual int RequestData
|
|
( vtkInformation *, vtkInformationVector **, vtkInformationVector * );
|
|
|
|
/**
|
|
* A callback function registered with the selection observer.
|
|
*/
|
|
static void SelectionModifiedCallback
|
|
( vtkObject *, unsigned long, void * tpReader, void * );
|
|
|
|
/**
|
|
* This function initializes the context. Note that the Tecplot file name
|
|
* must NOT be addressed (either specified or inited) in this function. It
|
|
* is addressed in constructor, destructor, and SetTecplotFile() only.
|
|
*/
|
|
void Init();
|
|
|
|
/**
|
|
* Get the data arrays list from the tecplot file header.
|
|
*/
|
|
void GetDataArraysList();
|
|
|
|
/**
|
|
* This function, the data loading engine, parses the Tecplot file to fill
|
|
* a vtkMultiBlockDataSet object.
|
|
*/
|
|
void ReadFile( vtkMultiBlockDataSet * multZone);
|
|
|
|
/**
|
|
* This function extracts each variable array from a block-packing (component-
|
|
* based) zone and collects the 3D point coordinates in addition to data
|
|
* attributes (node-based and / or cell-based). Note that Tecplot treats 3D
|
|
* coordinates as variables too, though three special ones.
|
|
*/
|
|
void GetArraysFromBlockPackingZone( int numNodes, int numCells,
|
|
vtkPoints * theNodes, vtkPointData * nodeData, vtkCellData * cellData );
|
|
|
|
/**
|
|
* This function extracts each variable array from a point-packing (tuple-
|
|
* based) zone and collects the 3D point coordbinates in addition to data
|
|
* attributes (node-based and / or cell-based). Note that Tecplot treats 3D
|
|
* coordinates as variables too, though three special ones. A point-packing
|
|
* zone does not contain any cell data at all, instead it is supposed to
|
|
* contain point data only, if any.
|
|
*/
|
|
void GetArraysFromPointPackingZone
|
|
( int numNodes, vtkPoints * theNodes, vtkPointData * nodeData );
|
|
|
|
/**
|
|
* This function creates a vtkStructuredGrid object made up of a set of
|
|
* points and the associated attributes (node-based and / or cell-based)
|
|
* extracted from a block-packing (i.e., component-based) zone. This
|
|
* vtkStructuredGrid is then inserted, with a specified zone name, to a
|
|
* vtkMultiBlockDataSet object.
|
|
*/
|
|
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 attributes (node-based and / or cell-based)
|
|
* extracted from a point-packing (i.e., tuple-based) zone. This
|
|
* vtkStructuredGrid is then inserted, with a specified zone name, to a
|
|
* vtkMultiBlockDataSet object.
|
|
*/
|
|
void GetStructuredGridFromPointPackingZone( int iDimSize, int jDimSize,
|
|
int kDimSize, int zoneIndx, const char * zoneName,
|
|
vtkMultiBlockDataSet * multZone );
|
|
|
|
/**
|
|
* This function creates a vtkUnstructuredGrid object made up of a set of
|
|
* points and the associated attributes (node-based and / or cell-based)
|
|
* extracted from a block-packing (i.e., component-based) zone. This
|
|
* vtkUnstructuredGrid is then inserted, with a specified zone name, to a
|
|
* vtkMultiBlockDataSet object.
|
|
*/
|
|
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 attributes (node-based and / or cell-based)
|
|
* extracted from a point-packing (i.e., tuple-based) zone. This
|
|
* vtkUnstructuredGrid is then inserted, with a specified zone name, to a
|
|
* vtkMultiBlockDataSet object.
|
|
*/
|
|
void GetUnstructuredGridFromPointPackingZone( int numNodes, int numCells,
|
|
const char * cellType,int zoneIndx, const char * zoneName,
|
|
vtkMultiBlockDataSet * multZone );
|
|
|
|
/**
|
|
* This function fills an allocated vtkUnstructuredGrid object with numberCells
|
|
* cells of type cellTypeStr to define the grid topology.
|
|
*/
|
|
void GetUnstructuredGridCells( int numberCells, const char * cellTypeStr,
|
|
vtkUnstructuredGrid * unstrctGrid );
|
|
|
|
int NumberOfVariables;
|
|
char * FileName;
|
|
vtkCallbackCommand * SelectionObserver;
|
|
vtkDataArraySelection * DataArraySelection;
|
|
vtkTecplotReaderInternal * Internal;
|
|
|
|
std::string DataTitle;
|
|
std::vector< int > CellBased;
|
|
std::vector< std::string > ZoneNames;
|
|
std::vector< std::string > Variables;
|
|
|
|
private:
|
|
|
|
vtkTecplotReader( const vtkTecplotReader & ) VTK_DELETE_FUNCTION;
|
|
void operator = ( const vtkTecplotReader & ) VTK_DELETE_FUNCTION;
|
|
};
|
|
|
|
#endif
|