vtkERFReader.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkERFReader_h
#define vtkERFReader_h

#include "vtkIOERFModule.h" // For export macro
#include "vtkNew.h"         // For vtkNew
#include "vtkPartitionedDataSetCollectionAlgorithm.h"
#include "vtkSmartPointer.h" // For smart pointer

#include <map>    // for std::map
#include <vector> // for std::vector

VTK_ABI_NAMESPACE_BEGIN

class vtkDataAssembly;
class vtkDataArraySelection;
class vtkIntArray;
class vtkUnsignedCharArray;
class vtkCellArray;
class vtkUnstructuredGrid;

class VTKIOERF_EXPORT vtkERFReader : public vtkPartitionedDataSetCollectionAlgorithm
{
public:
  static vtkERFReader* New();
  vtkTypeMacro(vtkERFReader, vtkPartitionedDataSetCollectionAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  typedef int64_t hid_t;


  vtkSetMacro(FileName, std::string);
  vtkGetMacro(FileName, std::string);


  vtkGetNewMacro(StagesSelection, vtkDataArraySelection);
  vtkGetNewMacro(VariablesSelection, vtkDataArraySelection);
  vtkGetNewMacro(BlocksSelection, vtkDataArraySelection);


  void EnableAllVariables();
  void EnableAllBlocks();


  void SetVariablesStatus(const char* name, int status);
  void SetStagesStatus(const char* name, int status);
  void SetBlocksStatus(const char* name, int status);

  std::string GetStage() const;

protected:
  vtkERFReader();
  ~vtkERFReader() override;

  int RequestInformation(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;

  int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;

private:
  vtkERFReader(const vtkERFReader&) = delete;
  void operator=(const vtkERFReader&) = delete;

  bool IsValidERFDataset(const hid_t& fileId) const;

  bool ExtractTemporalData(const hid_t& rootIdx);

  void AddTemporalInformation(vtkInformation* info);

  void AddTemporalInformationAsFieldData(vtkPartitionedDataSetCollection* pdc);

  int TraverseStage(vtkPartitionedDataSetCollection* pdc);

  void AppendConstantGroupData(vtkPartitionedDataSetCollection* pdc, hid_t fileId);

  void AppendSinglestateGroupData(hid_t fileId);


  void AppendMandatoryBlock(vtkPartitionedDataSetCollection* output, const hid_t& fileId);
  void AppendSystemBlock(vtkPartitionedDataSetCollection* output, const hid_t& fileId);
  void AppendERFHeaderBlock(vtkPartitionedDataSetCollection* output, const hid_t& fileId);

  void AppendSinglestateBlock(const hid_t& fileId);

  void AppendFieldDataByName(
    vtkPartitionedDataSetCollection* pdc, const hid_t& id, const std::string& name);


  void BuildMesh(const hid_t& fileId);
  void AppendPoints(
    vtkUnstructuredGrid* output, const std::string& nodeAttributePath, const hid_t& fileId);
  void AppendCells(
    vtkUnstructuredGrid* output, const std::string& shellAttributePath, const hid_t& fileId);

  void AppendMeshs(vtkPartitionedDataSetCollection* pdc, vtkDataAssembly* hierarchy,
    int& streamNodeId, int& meshNodeId, int& meshStartId);

  int GetTimeValuesIndex();


  std::string GetAttributeValueAsStr(const hid_t& erfIdx, const std::string& attributeName) const;
  int GetAttributeValueAsInt(const hid_t& erfIdx, const std::string& attributeName) const;


  bool IsCellSupported(int ndim, int npelem);
  bool Is0DCellSupported(int npelem);
  bool Is1DCellSupported(int npelem);
  bool Is2DCellSupported(int npelem);
  bool Is3DCellSupported(int npelem);

  void FillCellsByType(vtkCellArray* cellArray, vtkUnsignedCharArray* cellType, hid_t shellDataType,
    hid_t arrayId, vtkIntArray* entid, int numberOfDimensions, int numberOfIndicePerCell,
    int numberOfCell);


  void Fill0DCellType(vtkCellArray* cellArray, vtkUnsignedCharArray* cellTypes, vtkIntArray* entid,
    const std::vector<int>& resData, int numberOfIndicePerCell, int numberOfCell);
  void Fill1DCellType(vtkCellArray* cellArray, vtkUnsignedCharArray* cellTypes, vtkIntArray* entid,
    const std::vector<int>& resData, int numberOfIndicePerCell, int numberOfCell);
  void Fill2DCellType(vtkCellArray* cellArray, vtkUnsignedCharArray* cellTypes, vtkIntArray* entid,
    const std::vector<int>& resData, int numberOfIndicePerCell, int numberOfCell);
  void Fill3DCellType(vtkCellArray* cellArray, vtkUnsignedCharArray* cellTypes, vtkIntArray* entid,
    const std::vector<int>& resData, int numberOfIndicePerCell, int numberOfCell);

  std::string FileName;
  std::string CurrentName;

  vtkNew<vtkDataArraySelection> StagesSelection;
  vtkNew<vtkDataArraySelection> VariablesSelection;
  vtkNew<vtkDataArraySelection> BlocksSelection;
  vtkNew<vtkDataArraySelection> ConstantGroupSelection;
  vtkNew<vtkDataArraySelection> MultistateGroupSelection;
  vtkNew<vtkDataArraySelection> SinglestateGroupSelection;

  std::vector<int> States;
  std::vector<double> TimeValues;
  double TimeRanges[2] = { 0.0, 0.0 };
  double CurrentTimeValue = 0.0;

  std::map<std::string, vtkSmartPointer<vtkUnstructuredGrid>> MeshPoints;
  std::map<std::string, vtkSmartPointer<vtkUnstructuredGrid>> Meshs;
};

VTK_ABI_NAMESPACE_END
#endif