vtkEnSightReader.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkEnSightReader.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.
 
=========================================================================*/
#ifndef vtkEnSightReader_h
#define vtkEnSightReader_h
 
#include "vtkGenericEnSightReader.h"
#include "vtkIOEnSightModule.h" // For export macro
 
class vtkDataSet;
class vtkDataSetCollection;
class vtkEnSightReaderCellIdsType;
class vtkIdList;
class vtkMultiBlockDataSet;
 
class VTKIOENSIGHT_EXPORT vtkEnSightReader : public vtkGenericEnSightReader
{
public:
  vtkTypeMacro(vtkEnSightReader, vtkGenericEnSightReader);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  enum ElementTypesList
  {
    POINT = 0,
    BAR2 = 1,
    BAR3 = 2,
    NSIDED = 3,
    TRIA3 = 4,
    TRIA6 = 5,
    QUAD4 = 6,
    QUAD8 = 7,
    NFACED = 8,
    TETRA4 = 9,
    TETRA10 = 10,
    PYRAMID5 = 11,
    PYRAMID13 = 12,
    HEXA8 = 13,
    HEXA20 = 14,
    PENTA6 = 15,
    PENTA15 = 16,
    NUMBER_OF_ELEMENT_TYPES = 17
  };
 
  enum VariableTypesList
  {
    SCALAR_PER_NODE = 0,
    VECTOR_PER_NODE = 1,
    TENSOR_SYMM_PER_NODE = 2,
    SCALAR_PER_ELEMENT = 3,
    VECTOR_PER_ELEMENT = 4,
    TENSOR_SYMM_PER_ELEMENT = 5,
    SCALAR_PER_MEASURED_NODE = 6,
    VECTOR_PER_MEASURED_NODE = 7,
    COMPLEX_SCALAR_PER_NODE = 8,
    COMPLEX_VECTOR_PER_NODE = 9,
    COMPLEX_SCALAR_PER_ELEMENT = 10,
    COMPLEX_VECTOR_PER_ELEMENT = 11,
    TENSOR_ASYM_PER_NODE = 12,
    TENSOR_ASYM_PER_ELEMENT = 13
  };
 
  enum SectionTypeList
  {
    COORDINATES = 0,
    BLOCK = 1,
    ELEMENT = 2
  };
 
 
  vtkGetFilePathMacro(MeasuredFileName);
 
 
  vtkGetFilePathMacro(MatchFileName);
 
protected:
  vtkEnSightReader();
  ~vtkEnSightReader() override;
 
  int RequestInformation(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
  void ClearForNewCaseFileName() override;
 
 
  vtkSetFilePathMacro(MeasuredFileName);
 
 
  vtkSetFilePathMacro(MatchFileName);
 
 
  int ReadCaseFile();
  int ReadCaseFileGeometry(char* line);
  int ReadCaseFileVariable(char* line);
  int ReadCaseFileTime(char* line);
  int ReadCaseFileFile(char* line);
 
  // set in UpdateInformation to value returned from ReadCaseFile
  int CaseFileRead;
 
  virtual int ReadGeometryFile(
    const char* fileName, int timeStep, vtkMultiBlockDataSet* output) = 0;
 
  virtual int ReadMeasuredGeometryFile(
    const char* fileName, int timeStep, vtkMultiBlockDataSet* output) = 0;
 
  int ReadVariableFiles(vtkMultiBlockDataSet* output);
 
  virtual int ReadScalarsPerNode(const char* fileName, const char* description, int timeStep,
    vtkMultiBlockDataSet* output, int measured = 0, int numberOfComponents = 1,
    int component = 0) = 0;
 
  virtual int ReadVectorsPerNode(const char* fileName, const char* description, int timeStep,
    vtkMultiBlockDataSet* output, int measured = 0) = 0;
 
  virtual int ReadAsymmetricTensorsPerNode(
    const char* fileName, const char* description, int timeStep, vtkMultiBlockDataSet* output) = 0;
 
  virtual int ReadTensorsPerNode(
    const char* fileName, const char* description, int timeStep, vtkMultiBlockDataSet* output) = 0;
 
  virtual int ReadScalarsPerElement(const char* fileName, const char* description, int timeStep,
    vtkMultiBlockDataSet* output, int numberOfComponents = 1, int component = 0) = 0;
 
  virtual int ReadVectorsPerElement(
    const char* fileName, const char* description, int timeStep, vtkMultiBlockDataSet* output) = 0;
 
  virtual int ReadAsymmetricTensorsPerElement(
    const char* fileName, const char* description, int timeStep, vtkMultiBlockDataSet* output) = 0;
 
  virtual int ReadTensorsPerElement(
    const char* fileName, const char* description, int timeStep, vtkMultiBlockDataSet* output) = 0;
 
  virtual int CreateUnstructuredGridOutput(
    int partId, char line[80], const char* name, vtkMultiBlockDataSet* output) = 0;
 
  virtual int CreateStructuredGridOutput(
    int partId, char line[80], const char* name, vtkMultiBlockDataSet* output) = 0;
 
  void AddVariableFileName(const char* fileName1, const char* fileName2 = nullptr);
 
  void AddVariableDescription(const char* description);
 
  void AddVariableType();
 
  int GetElementType(const char* line);
 
  int GetSectionType(const char* line);
 
  VTK_DEPRECATED_IN_9_1_0("Use vtkGenericEnSightReader::ReplaceWildcardsHelper instead.")
  void ReplaceWildcards(char* filename, int num);
 
  // Remove when removing the deprecated method above.
  using vtkGenericEnSightReader::ReplaceWildcards;
 
  void RemoveLeadingBlanks(char* line);
 
  // Get the vtkIdList for the given output index and cell type.
  vtkIdList* GetCellIds(int index, int cellType);
 
  void AddToBlock(vtkMultiBlockDataSet* output, unsigned int blockNo, vtkDataSet* dataset);
 
  vtkDataSet* GetDataSetFromBlock(vtkMultiBlockDataSet* output, unsigned int blockNo);
 
  void SetBlockName(vtkMultiBlockDataSet* output, unsigned int blockNo, const char* name);
 
  char* MeasuredFileName;
  char* MatchFileName; // may not actually be necessary to read this file
 
  // pointer to lists of vtkIdLists (cell ids per element type per part)
  vtkEnSightReaderCellIdsType* CellIds;
 
  // part ids of unstructured outputs
  vtkIdList* UnstructuredPartIds;
 
  int VariableMode;
 
  // pointers to lists of filenames
  char** VariableFileNames; // non-complex
  char** ComplexVariableFileNames;
 
  // array of time sets
  vtkIdList* VariableTimeSetIds;
  vtkIdList* ComplexVariableTimeSetIds;
 
  // array of file sets
  vtkIdList* VariableFileSetIds;
  vtkIdList* ComplexVariableFileSetIds;
 
  // collection of filename numbers per time set
  vtkIdListCollection* TimeSetFileNameNumbers;
  vtkIdList* TimeSetsWithFilenameNumbers;
 
  // collection of filename numbers per file set
  vtkIdListCollection* FileSetFileNameNumbers;
  vtkIdList* FileSetsWithFilenameNumbers;
 
  // collection of number of steps per file per file set
  vtkIdListCollection* FileSetNumberOfSteps;
 
  // ids of the time and file sets
  vtkIdList* TimeSetIds;
  vtkIdList* FileSets;
 
  int GeometryTimeSet;
  int GeometryFileSet;
  int MeasuredTimeSet;
  int MeasuredFileSet;
 
  float GeometryTimeValue;
  float MeasuredTimeValue;
 
  vtkTypeBool UseTimeSets;
  vtkSetMacro(UseTimeSets, vtkTypeBool);
  vtkGetMacro(UseTimeSets, vtkTypeBool);
  vtkBooleanMacro(UseTimeSets, vtkTypeBool);
 
  vtkTypeBool UseFileSets;
  vtkSetMacro(UseFileSets, vtkTypeBool);
  vtkGetMacro(UseFileSets, vtkTypeBool);
  vtkBooleanMacro(UseFileSets, vtkTypeBool);
 
  int NumberOfGeometryParts;
 
  // global list of points for measured geometry
  int NumberOfMeasuredPoints;
 
  int NumberOfNewOutputs;
  int InitialRead;
 
  int CheckOutputConsistency();
 
  double ActualTimeValue;
 
private:
  vtkEnSightReader(const vtkEnSightReader&) = delete;
  void operator=(const vtkEnSightReader&) = delete;
};
 
#endif