vtkPIOReader.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright (c) 2021, Triad National Security, LLC
// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-LANL-Triad-USGov
#ifndef vtkPIOReader_h
#define vtkPIOReader_h
 
#include "vtkIOPIOModule.h" // For export macro
#include "vtkMultiBlockDataSetAlgorithm.h"
#include "vtkStdString.h" // for vtkStdString
 
VTK_ABI_NAMESPACE_BEGIN
class vtkCallbackCommand;
class vtkDataArraySelection;
class vtkFloatArray;
class vtkInformation;
class vtkMultiBlockDataSet;
class vtkMultiProcessController;
class vtkStringArray;
 
class PIOAdaptor;
class PIO_DATA;
 
class VTKIOPIO_EXPORT vtkPIOReader : public vtkMultiBlockDataSetAlgorithm
{
public:
  static vtkPIOReader* New();
  vtkTypeMacro(vtkPIOReader, vtkMultiBlockDataSetAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  vtkSetFilePathMacro(FileName);
  vtkGetFilePathMacro(FileName);
 
 
  vtkSetMacro(CurrentTimeStep, int);
  vtkGetMacro(CurrentTimeStep, int);
 
 
  vtkGetMacro(HyperTreeGrid, bool);
  vtkSetMacro(HyperTreeGrid, bool);
 
 
  vtkSetMacro(Tracers, bool);
  vtkGetMacro(Tracers, bool);
 
 
  vtkSetMacro(Float64, bool);
  vtkGetMacro(Float64, bool);
 
 
  vtkMultiBlockDataSet* GetOutput();
  vtkMultiBlockDataSet* GetOutput(int index);
 
 
  int GetNumberOfCellArrays();
  const char* GetCellArrayName(int index);
  int GetCellArrayStatus(const char* name);
  void SetCellArrayStatus(const char* name, int status);
  void DisableAllCellArrays();
  void EnableAllCellArrays();
  vtkGetObjectMacro(CellDataArraySelection, vtkDataArraySelection);
 
 
  int GetNumberOfTimeDataArrays() const;
  const char* GetTimeDataArray(int idx) const;
  vtkGetObjectMacro(TimeDataStringArray, vtkStringArray);
 
 
  vtkGetStringMacro(ActiveTimeDataArrayName);
  vtkSetStringMacro(ActiveTimeDataArrayName);
 
protected:
  vtkPIOReader();
  ~vtkPIOReader() override;
 
  char* FileName; // First field part file giving path
 
  int Rank;      // Number of this processor
  int TotalRank; // Number of processors
 
  PIOAdaptor* pioAdaptor; // Adapts data format to VTK
 
  int NumberOfVariables; // Number of variables to display
 
  int NumberOfTimeSteps; // Temporal domain
  double* TimeSteps;     // Times available for request
  int CurrentTimeStep;   // Time currently displayed
 
  bool HyperTreeGrid; // Create HTG rather than UnstructuredGrid
  bool Tracers;       // Create UnstructuredGrid for tracer info
  bool Float64;       // Load variable data as 64 bit float
 
  // Controls initializing and querrying MPI
  void SetController(vtkMultiProcessController*);
  vtkMultiProcessController* Controller;
 
  // Selected field of interest
  vtkDataArraySelection* CellDataArraySelection;
 
  // Time array selection
  vtkStringArray* TimeDataStringArray;
 
  // Active index of array used for time. If no time array is used, value should be -1.
  char* ActiveTimeDataArrayName;
  vtkStdString CurrentTimeDataArrayName;
 
  // Observer to modify this object when array selections are modified
  vtkCallbackCommand* SelectionObserver;
 
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int RequestInformation(
    vtkInformation*, vtkInformationVector** inVector, vtkInformationVector*) override;
 
  static void SelectionModifiedCallback(
    vtkObject* caller, unsigned long eid, void* clientdata, void* calldata);
 
private:
  vtkPIOReader(const vtkPIOReader&) = delete;
  void operator=(const vtkPIOReader&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif