VTK  9.0.2
vtkPNetCDFPOPReader.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtPkNetCDFPOPReader.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
31 #ifndef vtkPNetCDFPOPReader_h
32 #define vtkPNetCDFPOPReader_h
33 
34 #include "vtkIOParallelNetCDFModule.h" // For export macro
36 
38 class vtkCallbackCommand;
39 class vtkMPIController;
40 class vtkPNetCDFPOPReaderInternal;
41 
42 class VTKIOPARALLELNETCDF_EXPORT vtkPNetCDFPOPReader : public vtkRectilinearGridAlgorithm
43 {
44 public:
47  void PrintSelf(ostream& os, vtkIndent indent) override;
48 
50 
53  vtkSetStringMacro(FileName);
54  vtkGetStringMacro(FileName);
56 
58 
61  vtkSetVector3Macro(Stride, int);
62  vtkGetVector3Macro(Stride, int);
64 
66 
70  virtual const char* GetVariableArrayName(int idx);
71  virtual int GetVariableArrayStatus(const char* name);
72  virtual void SetVariableArrayStatus(const char* name, int status);
74 
80 
81  // Set/Get the vtkMultiProcessController which will handle communications
82  // for the parallel rendering.
83  vtkGetObjectMacro(Controller, vtkMPIController);
84  void SetController(vtkMPIController* controller);
85 
86 protected:
89 
91  virtual int RequestInformation(vtkInformation* request, vtkInformationVector** inputVector,
92  vtkInformationVector* outputVector) override;
93 
94  // Helper function for RequestData: Reads part of the netCDF
95  // file and sends sub-arrays to all ranks that need that data
96  int ReadAndSend(vtkInformation* outInfo, int varID);
97 
98  // Returns the MPI rank of the process that should read the specified depth
99  int ReaderForDepth(unsigned depth);
100 
101  bool IsReaderRank();
103 
105  vtkObject* caller, unsigned long eid, void* clientdata, void* calldata);
106 
107  static void EventCallback(vtkObject* caller, unsigned long eid, void* clientdata, void* calldata);
108 
110 
111  char* FileName;
113  vtkSetStringMacro(OpenedFileName);
114 
115  int NCDFFD; // netcdf file descriptor
116 
117  int Stride[3];
118 
120 
121 private:
122  vtkPNetCDFPOPReader(const vtkPNetCDFPOPReader&) = delete;
123  void operator=(const vtkPNetCDFPOPReader&) = delete;
124 
125  vtkPNetCDFPOPReaderInternal* Internals;
126 };
127 #endif
supports function callbacks
Store on/off settings for data arrays for a vtkSource.
list of point or cell ids
Definition: vtkIdList.h:31
a simple class to control print indentation
Definition: vtkIndent.h:34
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Process communication using MPI.
abstract base class for most VTK objects
Definition: vtkObject.h:63
read NetCDF files in parallel with MPI .Author Ross Miller 03.14.2011
static vtkPNetCDFPOPReader * New()
virtual int GetNumberOfVariableArrays()
Variable array selection.
vtkCallbackCommand * SelectionObserver
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
virtual int RequestInformation(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
void SetReaderRanks(vtkIdList *)
Set ranks that will actually open and read the netCDF files.
int ReadAndSend(vtkInformation *outInfo, int varID)
virtual int GetVariableArrayStatus(const char *name)
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int ReaderForDepth(unsigned depth)
static void SelectionModifiedCallback(vtkObject *caller, unsigned long eid, void *clientdata, void *calldata)
void SetController(vtkMPIController *controller)
~vtkPNetCDFPOPReader() override
virtual void SetVariableArrayStatus(const char *name, int status)
static void EventCallback(vtkObject *caller, unsigned long eid, void *clientdata, void *calldata)
vtkMPIController * Controller
virtual const char * GetVariableArrayName(int idx)
Superclass for algorithms that produce only rectilinear grid as output.
@ name
Definition: vtkX3D.h:225