vtkPNetCDFPOPReader.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 vtkPNetCDFPOPReader_h
#define vtkPNetCDFPOPReader_h
 
#include "vtkIOParallelNetCDFModule.h" // For export macro
#include "vtkRectilinearGridAlgorithm.h"
 
VTK_ABI_NAMESPACE_BEGIN
class vtkDataArraySelection;
class vtkCallbackCommand;
class vtkMPIController;
class vtkPNetCDFPOPReaderInternal;
 
class VTKIOPARALLELNETCDF_EXPORT vtkPNetCDFPOPReader : public vtkRectilinearGridAlgorithm
{
public:
  vtkTypeMacro(vtkPNetCDFPOPReader, vtkRectilinearGridAlgorithm);
  static vtkPNetCDFPOPReader* New();
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  vtkSetFilePathMacro(FileName);
  vtkGetFilePathMacro(FileName);
 
 
  vtkSetVector3Macro(Stride, int);
  vtkGetVector3Macro(Stride, int);
 
 
  virtual int GetNumberOfVariableArrays();
  virtual const char* GetVariableArrayName(int idx);
  virtual int GetVariableArrayStatus(const char* name);
  virtual void SetVariableArrayStatus(const char* name, int status);
 
  void SetReaderRanks(vtkIdList*);
 
  // Set/Get the vtkMultiProcessController which will handle communications
  // for the parallel rendering.
  vtkGetObjectMacro(Controller, vtkMPIController);
  void SetController(vtkMPIController* controller);
 
protected:
  vtkPNetCDFPOPReader();
  ~vtkPNetCDFPOPReader() override;
 
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int RequestInformation(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
 
  // Helper function for RequestData:  Reads part of the netCDF
  // file and sends sub-arrays to all ranks that need that data
  int ReadAndSend(vtkInformation* outInfo, int varID);
 
  // Returns the MPI rank of the process that should read the specified depth
  int ReaderForDepth(unsigned depth);
 
  bool IsReaderRank();
  bool IsFirstReaderRank();
 
  static void SelectionModifiedCallback(
    vtkObject* caller, unsigned long eid, void* clientdata, void* calldata);
 
  static void EventCallback(vtkObject* caller, unsigned long eid, void* clientdata, void* calldata);
 
  vtkCallbackCommand* SelectionObserver;
 
  char* FileName;
  char* OpenedFileName;
  vtkSetFilePathMacro(OpenedFileName);
 
  int NCDFFD; // netcdf file descriptor
 
  int Stride[3];
 
  vtkMPIController* Controller;
 
private:
  vtkPNetCDFPOPReader(const vtkPNetCDFPOPReader&) = delete;
  void operator=(const vtkPNetCDFPOPReader&) = delete;
 
  vtkPNetCDFPOPReaderInternal* Internals;
};
VTK_ABI_NAMESPACE_END
#endif