vtkEnSight6BinaryReader.h 7.02 KB
Newer Older
1 2 3 4 5
/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkEnSight6BinaryReader.h

6
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 8
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9

10 11
     This software is distributed WITHOUT ANY WARRANTY; without even
     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 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
/**
 * @class   vtkEnSight6BinaryReader
 * @brief   class to read binary EnSight6 files
 *
 * vtkEnSight6BinaryReader is a class to read binary EnSight6 files into vtk.
 * Because the different parts of the EnSight data can be of various data
 * types, this reader produces multiple outputs, one per part in the input
 * file.
 * All variable information is being stored in field data.  The descriptions
 * listed in the case file are used as the array names in the field data.
 * For complex vector variables, the description is appended with _r (for the
 * array of real values) and _i (for the array if imaginary values).  Complex
 * scalar variables are stored as a single array with 2 components, real and
 * imaginary, listed in that order.
 * @warning
 * You must manually call Update on this reader and then connect the rest
 * of the pipeline because (due to the nature of the file format) it is
 * not possible to know ahead of time how many outputs you will have or
 * what types they will be.
 * This reader can only handle static EnSight datasets (both static geometry
 * and variables).
*/
37

38 39
#ifndef vtkEnSight6BinaryReader_h
#define vtkEnSight6BinaryReader_h
40

41
#include "vtkIOEnSightModule.h" // For export macro
42 43
#include "vtkEnSightReader.h"

44
class vtkMultiBlockDataSet;
45
class vtkIdTypeArray;
Andy Cedilnik's avatar
Andy Cedilnik committed
46
class vtkPoints;
47

48
class VTKIOENSIGHT_EXPORT vtkEnSight6BinaryReader : public vtkEnSightReader
49 50 51
{
public:
  static vtkEnSight6BinaryReader *New();
52
  vtkTypeMacro(vtkEnSight6BinaryReader, vtkEnSightReader);
53
  void PrintSelf(ostream& os, vtkIndent indent) override;
54

55 56
protected:
  vtkEnSight6BinaryReader();
57
  ~vtkEnSight6BinaryReader() override;
58 59 60

  // Returns 1 if successful.  Sets file size as a side action.
  int OpenFile(const char* filename);
61

62 63 64
  /**
   * Read the geometry file.  If an error occurred, 0 is returned; otherwise 1.
   */
65
  int ReadGeometryFile(const char* fileName, int timeStep,
66
                               vtkMultiBlockDataSet *output) override;
67

68 69 70 71
  /**
   * Read the measured geometry file.  If an error occurred, 0 is returned;
   * otherwise 1.
   */
72
  int ReadMeasuredGeometryFile(const char* fileName, int timeStep,
73
                                       vtkMultiBlockDataSet *output) override;
74

75 76 77 78 79
  /**
   * Read scalars per node for this dataset.  If an error occurred, 0 is
   * returned; otherwise 1.  If there will be more than one component in
   * the scalars array, we assume that 0 is the first component added to the array.
   */
80
  int ReadScalarsPerNode(const char* fileName, const char* description,
81
                                 int timeStep, vtkMultiBlockDataSet *output,
82
                                 int measured = 0, int numberOfComponents = 1,
83
                                 int component = 0) override;
84

85 86 87 88
  /**
   * Read vectors per node for this dataset.  If an error occurred, 0 is
   * returned; otherwise 1.
   */
89
  int ReadVectorsPerNode(const char* fileName, const char* description,
90
                                 int timeStep, vtkMultiBlockDataSet *output,
91
                                 int measured = 0) override;
92

93 94 95 96
  /**
   * Read tensors per node for this dataset.  If an error occurred, 0 is
   * returned; otherwise 1.
   */
97
  int ReadTensorsPerNode(const char* fileName, const char* description,
98
                                 int timeStep, vtkMultiBlockDataSet *output) override;
99

100 101 102 103 104
  /**
   * Read scalars per element for this dataset.  If an error occurred, 0 is
   * returned; otherwise 1.  If there will be more than one component in the
   * scalars array, we assume that 0 is the first component added to the array.
   */
105
  int ReadScalarsPerElement(const char* fileName,
106
                                    const char* description, int timeStep,
107
                                    vtkMultiBlockDataSet *output,
108
                                    int numberOfComponents = 1,
109
                                    int component = 0) override;
110

111 112 113 114
  /**
   * Read vectors per element for this dataset.  If an error occurred, 0 is
   * returned; otherwise 1.
   */
115
  int ReadVectorsPerElement(const char* fileName, const char* description,
116
                                    int timeStep, vtkMultiBlockDataSet *output) override;
117

118 119 120 121
  /**
   * Read tensors per element for this dataset.  If an error occurred, 0 is
   * returned; otherwise 1.
   */
122
  int ReadTensorsPerElement(const char* fileName, const char* description,
123
                                    int timeStep, vtkMultiBlockDataSet *output) override;
124

125 126 127 128
  /**
   * Read an unstructured part (partId) from the geometry file and create a
   * vtkUnstructuredGrid output.  Return 0 if EOF reached.
   */
129
  int CreateUnstructuredGridOutput(int partId,
130
                                           char line[256],
131
                                           const char* name,
132
                                           vtkMultiBlockDataSet *output) override;
133

134 135 136 137
  /**
   * Read a structured part from the geometry file and create a
   * vtkStructuredGridOutput.  Return 0 if EOF reached.
   */
138
  int CreateStructuredGridOutput(int partId,
139
                                         char line[256],
140
                                         const char* name,
141
                                         vtkMultiBlockDataSet *output) override;
142

143 144 145 146
  /**
   * Internal function to read in a line up to 80 characters.
   * Returns zero if there was an error.
   */
147 148
  int ReadLine(char result[80]);

149 150 151 152 153
  /**
   * Internal function to read in a single integer.
   * Tries to determine the byte order of this file.
   * Returns zero if there was an error.
   */
154
  int ReadIntNumber(int *result);
155

156 157 158 159
  /**
   * Internal function to read in an integer array.
   * Returns zero if there was an error.
   */
160 161
  int ReadIntArray(int *result, int numInts);

162 163 164 165
  /**
   * Internal function to read in a float array.
   * Returns zero if there was an error.
   */
166 167
  int ReadFloatArray(float *result, int numFloats);

168 169 170 171
  //@{
  /**
   * Read to the next time step in the geometry file.
   */
Amy Squillacote's avatar
Amy Squillacote committed
172
  int SkipTimeStep();
Amy Squillacote's avatar
Amy Squillacote committed
173 174
  int SkipStructuredGrid(char line[256]);
  int SkipUnstructuredGrid(char line[256]);
175
  //@}
176

177 178 179
  // global list of points for the unstructured parts of the model
  int NumberOfUnstructuredPoints;
  vtkPoints* UnstructuredPoints;
180
  vtkIdTypeArray* UnstructuredNodeIds; // matching of node ids to point ids
181

182
  int ElementIdsListed;
183 184

  // The size of the file is used to choose byte order.
185
  vtkTypeUInt64 FileSize;
186

187
  ifstream *BinaryIFile;
188
private:
189 190
  vtkEnSight6BinaryReader(const vtkEnSight6BinaryReader&) = delete;
  void operator=(const vtkEnSight6BinaryReader&) = delete;
191 192 193
};

#endif
194