vtkPExodusIIReader.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
// SPDX-License-Identifier: BSD-3-Clause

#ifndef vtkPExodusIIReader_h
#define vtkPExodusIIReader_h

#include "vtkExodusIIReader.h"
#include "vtkIOParallelExodusModule.h" // For export macro

#include <vector> // Required for vector

VTK_ABI_NAMESPACE_BEGIN
class vtkTimerLog;
class vtkMultiProcessController;

class VTKIOPARALLELEXODUS_EXPORT vtkPExodusIIReader : public vtkExodusIIReader
{
public:
  static vtkPExodusIIReader* New();
  vtkTypeMacro(vtkPExodusIIReader, vtkExodusIIReader);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  void SetController(vtkMultiProcessController* c);
  vtkGetObjectMacro(Controller, vtkMultiProcessController);


  vtkSetFilePathMacro(FilePattern);
  vtkGetFilePathMacro(FilePattern);
  vtkSetFilePathMacro(FilePrefix);
  vtkGetFilePathMacro(FilePrefix);


  void SetFileRange(int, int);
  void SetFileRange(int* r) { this->SetFileRange(r[0], r[1]); }
  vtkGetVector2Macro(FileRange, int);

  void SetFileNames(int nfiles, const char** names);

  void SetFileName(VTK_FILEPATH const char* name) override;

  char** GetFileNames() { return this->FileNames; }

  int GetNumberOfFileNames() { return this->NumberOfFileNames; }


  vtkGetMacro(NumberOfFiles, int);

  vtkIdType GetTotalNumberOfElements() override;
  vtkIdType GetTotalNumberOfNodes() override;

  virtual void Broadcast(vtkMultiProcessController* ctrl);


  vtkGetMacro(VariableCacheSize, double);
  vtkSetMacro(VariableCacheSize, double);

protected:
  vtkPExodusIIReader();
  ~vtkPExodusIIReader() override;


  int DeterminePattern(const char* file);
  static int DetermineFileId(const char* file);

  // holds the size of the variable cache in GigaBytes
  double VariableCacheSize;

  // **KEN** Previous discussions concluded with std classes in header
  // files is bad.  Perhaps we should change ReaderList.

  vtkMultiProcessController* Controller;
  vtkIdType ProcRank;
  vtkIdType ProcSize;
  char* FilePattern;
  char* CurrentFilePattern;
  char* FilePrefix;
  char* CurrentFilePrefix;
  char* MultiFileName;
  int FileRange[2];
  int CurrentFileRange[2];
  int NumberOfFiles;
  char** FileNames;
  int NumberOfFileNames;

  std::vector<vtkExodusIIReader*> ReaderList;
  std::vector<int> NumberOfPointsPerFile;
  std::vector<int> NumberOfCellsPerFile;

  int LastCommonTimeStep;

  int Timing;
  vtkTimerLog* TimerLog;

  int RequestInformation(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;

private:
  vtkPExodusIIReader(const vtkPExodusIIReader&) = delete;
  void operator=(const vtkPExodusIIReader&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif