vtkPGenericIOMultiBlockReader.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkPGenericIOMultiBlockReader_h
#define vtkPGenericIOMultiBlockReader_h
 
#include "vtkMultiBlockDataSetAlgorithm.h"
#include "vtkPVVTKExtensionsCosmoToolsModule.h" // For export macro
 
#include <set> // For std::set
 
class vtkCallbackCommand;
class vtkDataArraySelection;
class vtkMultiProcessController;
class vtkStringArray;
class vtkIdList;
class vtkUnstructuredGrid;
class vtkInformationDoubleKey;
 
// GenericIO forward declarations
namespace gio
{
class GenericIOReader;
}
 
class VTKPVVTKEXTENSIONSCOSMOTOOLS_EXPORT vtkPGenericIOMultiBlockReader
  : public vtkMultiBlockDataSetAlgorithm
{
public:
  enum IOType
  {
    IOTYPEMPI,
    IOTYPEPOSIX
  };
 
  enum BlockAssignment
  {
    ROUND_ROBIN,
    RCB
  };
 
  static vtkPGenericIOMultiBlockReader* New();
  vtkTypeMacro(vtkPGenericIOMultiBlockReader, vtkMultiBlockDataSetAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  vtkSetStringMacro(XAxisVariableName);
  vtkGetStringMacro(XAxisVariableName);
 
 
  vtkSetStringMacro(YAxisVariableName);
  vtkGetStringMacro(YAxisVariableName);
 
 
  vtkSetStringMacro(ZAxisVariableName);
  vtkGetStringMacro(ZAxisVariableName);
 
 
  vtkSetStringMacro(FileName);
  vtkGetStringMacro(FileName);
 
 
  vtkSetMacro(GenericIOType, int);
  vtkGetMacro(GenericIOType, int);
 
 
  vtkSetMacro(BlockAssignment, int);
  vtkGetMacro(BlockAssignment, int);
 
 
  vtkGetObjectMacro(ArrayList, vtkStringArray);
 
 
  vtkGetObjectMacro(PointDataArraySelection, vtkDataArraySelection);
 
 
  vtkGetMacro(Controller, vtkMultiProcessController*);
  vtkSetMacro(Controller, vtkMultiProcessController*);
 
  int GetNumberOfPointArrays();
 
  const char* GetPointArrayName(int i);
 
  int GetPointArrayStatus(const char* name);
 
  void SetPointArrayStatus(const char* name, int status);
 
 
  vtkSetStringMacro(HaloIdVariableName);
  vtkGetStringMacro(HaloIdVariableName);
 
  vtkIdType GetRequestedHaloId(vtkIdType i);
 
  vtkIdType GetNumberOfRequestedHaloIds();
 
  void SetNumberOfRequestedHaloIds(vtkIdType numIds);
 
  void AddRequestedHaloId(vtkIdType haloId);
 
  void ClearRequestedHaloIds();
 
  void SetRequestedHaloId(vtkIdType i, vtkIdType haloId);
 
protected:
  vtkPGenericIOMultiBlockReader();
  ~vtkPGenericIOMultiBlockReader();
 
  char* XAxisVariableName;
  char* YAxisVariableName;
  char* ZAxisVariableName;
  char* HaloIdVariableName;
 
  char* FileName;
  int GenericIOType;
  int BlockAssignment;
 
  bool BuildMetaData;
 
  vtkMultiProcessController* Controller;
 
  vtkStringArray* ArrayList;
  vtkDataArraySelection* PointDataArraySelection;
  vtkIdList* HaloList;
  vtkCallbackCommand* SelectionObserver;
 
  gio::GenericIOReader* Reader;
 
  gio::GenericIOReader* GetInternalReader();
 
  bool ReaderParametersChanged();
 
  void LoadMetaData();
 
  void LoadRawVariableDataForBlock(const std::string& varName, int blockId);
 
  void LoadRawDataForBlock(int blockId);
 
  void GetPointFromRawData(int xType, void* xBuffer, int yType, void* yBuffer, int zType,
    void* zBuffer, vtkIdType id, double point[3]);
 
  void LoadCoordinatesForBlock(
    vtkUnstructuredGrid* grid, std::set<vtkIdType>& pointsInSelectedHalos, int blockId);
 
  void LoadDataArraysForBlock(
    vtkUnstructuredGrid* grid, const std::set<vtkIdType>& pointsInSelectedHalos, int blockId);
 
  vtkUnstructuredGrid* LoadBlock(int blockId);
 
  static void SelectionModifiedCallback(
    vtkObject* caller, unsigned long eid, void* clientdata, void* calldata);
 
  // Pipeline methods
  virtual int RequestInformation(vtkInformation*, vtkInformationVector**, vtkInformationVector*);
  virtual int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*);
 
private:
  vtkPGenericIOMultiBlockReader(const vtkPGenericIOMultiBlockReader&) = delete;
  void operator=(const vtkPGenericIOMultiBlockReader&) = delete;
  // Internal helper class
  class vtkGenericIOMultiBlockMetaData;
  vtkGenericIOMultiBlockMetaData* MetaData;
};
 
#endif