vtkAMRBaseReader.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 vtkAMRBaseReader_h
#define vtkAMRBaseReader_h
 
#include "vtkIOAMRModule.h" // For export macro
#include "vtkOverlappingAMRAlgorithm.h"
#include <map>     // STL map header
#include <utility> // for STL pair
#include <vector>  // STL vector header
 
// Forward Declarations
VTK_ABI_NAMESPACE_BEGIN
class vtkOverlappingAMR;
class vtkMultiProcessController;
class vtkDataArraySelection;
class vtkCallbackCommand;
class vtkIndent;
class vtkAMRDataSetCache;
class vtkUniformGrid;
class vtkDataArray;
 
class VTKIOAMR_EXPORT vtkAMRBaseReader : public vtkOverlappingAMRAlgorithm
{
public:
  vtkTypeMacro(vtkAMRBaseReader, vtkOverlappingAMRAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  void Initialize();
 
 
  vtkSetMacro(EnableCaching, vtkTypeBool);
  vtkGetMacro(EnableCaching, vtkTypeBool);
  vtkBooleanMacro(EnableCaching, vtkTypeBool);
  bool IsCachingEnabled() const { return ((this->EnableCaching) ? true : false); }
 
 
  virtual void SetController(vtkMultiProcessController*);
  vtkGetObjectMacro(Controller, vtkMultiProcessController);
 
 
  vtkSetMacro(MaxLevel, int);
 
 
  vtkGetObjectMacro(CellDataArraySelection, vtkDataArraySelection);
  vtkGetObjectMacro(PointDataArraySelection, vtkDataArraySelection);
 
 
  int GetNumberOfPointArrays();
  int GetNumberOfCellArrays();
 
 
  const char* GetPointArrayName(int index);
  const char* GetCellArrayName(int index);
 
 
  int GetPointArrayStatus(const char* name);
  int GetCellArrayStatus(const char* name);
  void SetPointArrayStatus(const char* name, int status);
  void SetCellArrayStatus(const char* name, int status);
 
 
  vtkGetFilePathMacro(FileName);
  virtual void SetFileName(VTK_FILEPATH const char* fileName) = 0;
 
  virtual int GetNumberOfBlocks() = 0;
 
  virtual int GetNumberOfLevels() = 0;
 
protected:
  vtkAMRBaseReader();
  ~vtkAMRBaseReader() override;
 
  // Description:
  // Checks if this reader instance is attached to a communicator
  // with more than one MPI processes.
  bool IsParallel();
 
  bool IsBlockMine(int blockIdx);
 
  vtkUniformGrid* GetAMRBlock(int blockIdx);
 
  void AssignAndLoadBlocks(vtkOverlappingAMR* amrds);
 
  void LoadRequestedBlocks(vtkOverlappingAMR* amrds);
 
  void GetAMRData(int blockIdx, vtkUniformGrid* block, const char* fieldName);
 
  void GetAMRPointData(int blockIdx, vtkUniformGrid* block, const char* fieldName);
 
  void LoadPointData(int blockIdx, vtkUniformGrid* block);
 
  void LoadCellData(int blockIdx, vtkUniformGrid* block);
 
  int GetBlockProcessId(int blockIdx);
 
  void SetupBlockRequest(vtkInformation* outputInfo);
 
  virtual void ReadMetaData() = 0;
 
  virtual int GetBlockLevel(int blockIdx) = 0;
 
  virtual int FillMetaData() = 0;
 
  virtual vtkUniformGrid* GetAMRGrid(int blockIdx) = 0;
 
  virtual void GetAMRGridData(int blockIdx, vtkUniformGrid* block, const char* field) = 0;
 
  virtual void GetAMRGridPointData(int blockIdx, vtkUniformGrid* block, const char* field) = 0;
 
 
  int RequestData(vtkInformation* vtkNotUsed(request),
    vtkInformationVector** vtkNotUsed(inputVector), vtkInformationVector* outputVector) override;
  int RequestInformation(vtkInformation* rqst, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
  int FillOutputPortInformation(int port, vtkInformation* info) override;
 
  // Array selection member variables and methods
  vtkDataArraySelection* PointDataArraySelection;
  vtkDataArraySelection* CellDataArraySelection;
  vtkCallbackCommand* SelectionObserver;
 
  void InitializeArraySelections();
 
  virtual void SetUpDataArraySelections() = 0;
 
  static void SelectionModifiedCallback(
    vtkObject* caller, unsigned long eid, void* clientdata, void* calldata);
 
  bool InitialRequest;
  int MaxLevel;
  char* FileName;
  vtkMultiProcessController* Controller;
 
  vtkTypeBool EnableCaching;
  vtkAMRDataSetCache* Cache;
  int NumBlocksFromFile;
  int NumBlocksFromCache;
 
  vtkOverlappingAMR* Metadata;
  bool LoadedMetaData;
 
  std::vector<int> BlockMap;
 
private:
  vtkAMRBaseReader(const vtkAMRBaseReader&) = delete;
  void operator=(const vtkAMRBaseReader&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif /* vtkAMRBaseReader_h */