VTK  9.2.6
vtkMPASReader.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkMPASReader.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 =========================================================================*/
15 /*=========================================================================
16 
17 Copyright (c) 2002-2005 Los Alamos National Laboratory
18 
19 This software and ancillary information known as vtk_ext (and herein
20 called "SOFTWARE") is made available under the terms described below.
21 The SOFTWARE has been approved for release with associated LA_CC
22 Number 99-44, granted by Los Alamos National Laboratory in July 1999.
23 
24 Unless otherwise indicated, this SOFTWARE has been authored by an
25 employee or employees of the University of California, operator of the
26 Los Alamos National Laboratory under Contract No. W-7405-ENG-36 with
27 the United States Department of Energy.
28 
29 The United States Government has rights to use, reproduce, and
30 distribute this SOFTWARE. The public may copy, distribute, prepare
31 derivative works and publicly display this SOFTWARE without charge,
32 provided that this Notice and any statement of authorship are
33 reproduced on all copies.
34 
35 Neither the U. S. Government, the University of California, nor the
36 Advanced Computing Laboratory makes any warranty, either express or
37 implied, nor assumes any liability or responsibility for the use of
38 this SOFTWARE.
39 
40 If SOFTWARE is modified to produce derivative works, such modified
41 SOFTWARE should be clearly marked, so as not to confuse it with the
42 version available from Los Alamos National Laboratory.
43 
44 =========================================================================*/
80 #ifndef vtkMPASReader_h
81 #define vtkMPASReader_h
82 
83 #include "vtkIONetCDFModule.h" // For export macro
85 
86 #include <string> // for std::string
87 
88 class vtkCallbackCommand;
90 class vtkDoubleArray;
91 class vtkStdString;
92 class vtkStringArray;
93 
94 class VTKIONETCDF_EXPORT vtkMPASReader : public vtkUnstructuredGridAlgorithm
95 {
96 public:
97  static vtkMPASReader* New();
99  void PrintSelf(ostream& os, vtkIndent indent) override;
100 
102 
105  vtkSetFilePathMacro(FileName);
106  vtkGetFilePathMacro(FileName);
108 
110 
113  vtkGetMacro(MaximumCells, int);
115 
117 
120  vtkGetMacro(MaximumPoints, int);
122 
124 
127  virtual int GetNumberOfCellVars();
128  virtual int GetNumberOfPointVars();
130 
132 
136  vtkUnstructuredGrid* GetOutput(int idx);
138 
140 
146  vtkSetMacro(UseDimensionedArrayNames, bool);
147  vtkGetMacro(UseDimensionedArrayNames, bool);
148  vtkBooleanMacro(UseDimensionedArrayNames, bool);
150 
152 
157  int GetNumberOfPointArrays();
158  const char* GetPointArrayName(int index);
159  int GetPointArrayStatus(const char* name);
160  void SetPointArrayStatus(const char* name, int status);
161  void DisableAllPointArrays();
162  void EnableAllPointArrays();
164 
165  int GetNumberOfCellArrays();
166  const char* GetCellArrayName(int index);
167  int GetCellArrayStatus(const char* name);
168  void SetCellArrayStatus(const char* name, int status);
169  void DisableAllCellArrays();
170  void EnableAllCellArrays();
171 
173 
181  vtkIdType GetNumberOfDimensions();
182  std::string GetDimensionName(int idx);
183  vtkStringArray* GetAllDimensions();
184  int GetDimensionCurrentIndex(const std::string& dim);
185  void SetDimensionCurrentIndex(const std::string& dim, int idx);
186  int GetDimensionSize(const std::string& dim);
188 
190 
194  vtkSetMacro(VerticalDimension, std::string);
195  vtkGetMacro(VerticalDimension, std::string);
197 
199 
203  void SetVerticalLevel(int level);
204  int GetVerticalLevel();
206 
207  vtkGetVector2Macro(VerticalLevelRange, int);
208 
209  vtkSetMacro(LayerThickness, int);
210  vtkGetMacro(LayerThickness, int);
211  vtkGetVector2Macro(LayerThicknessRange, int);
212 
213  void SetCenterLon(int val);
214  vtkGetVector2Macro(CenterLonRange, int);
215 
216  vtkSetMacro(ProjectLatLon, bool);
217  vtkGetMacro(ProjectLatLon, bool);
218 
219  vtkSetMacro(IsAtmosphere, bool);
220  vtkGetMacro(IsAtmosphere, bool);
221 
222  vtkSetMacro(IsZeroCentered, bool);
223  vtkGetMacro(IsZeroCentered, bool);
224 
225  vtkSetMacro(ShowMultilayerView, bool);
226  vtkGetMacro(ShowMultilayerView, bool);
227 
231  static int CanReadFile(VTK_FILEPATH const char* filename);
232 
233  vtkMTimeType GetMTime() override;
234 
235 protected:
236  vtkMPASReader();
237  ~vtkMPASReader() override;
238  void ReleaseNcData();
239  void DestroyData();
240 
241  char* FileName; // First field part file giving path
242 
243  size_t NumberOfTimeSteps; // Temporal domain
244  double DTime; // The current time
245 
246  // Observer to modify this object when array selections are modified
248 
251 
252  static void SelectionCallback(
253  vtkObject* caller, unsigned long eid, void* clientdata, void* calldata);
254 
255  // Selected field of interest
258 
263  void UpdateDimensions(bool force = false);
264 
266  int VerticalLevelRange[2];
267 
269  int LayerThicknessRange[2];
270 
272  int CenterLonRange[2];
273 
275  {
278  Planar
279  };
280 
282 
283  bool ProjectLatLon; // User option
284  bool OnASphere; // Data file attribute
288 
290  bool DoBugFix;
291  double CenterRad;
292 
294 
295  // geometry
300  size_t PointOffset;
302  size_t CurrentExtraPoint; // current extra point
303  size_t CurrentExtraCell; // current extra cell
304  double* PointX; // x coord of point
305  double* PointY; // y coord of point
306  double* PointZ; // z coord of point
307  size_t ModNumPoints;
308  size_t ModNumCells;
309  int* OrigConnections; // original connections
310  int* ModConnections; // modified connections
311  size_t* CellMap; // maps from added cell to original cell #
312  size_t* PointMap; // maps from added point to original point #
314  int MaximumCells; // max cells
315  int MaximumPoints; // max points
316 
317  void SetDefaults();
318  int GetNcDims();
319  int GetNcAtts();
320  int CheckParams();
321  int GetNcVars(const char* cellDimName, const char* pointDimName);
322  int ReadAndOutputGrid();
323  int BuildVarArrays();
324  int AllocSphericalGeometry();
325  int AllocProjectedGeometry();
326  int AllocPlanarGeometry();
327  void ShiftLonData();
328  int AddMirrorPoint(int index, double dividerX, double offset);
329  void FixPoints();
330  int EliminateXWrap();
331  void OutputPoints();
332  void OutputCells();
333  unsigned char GetCellType();
334 
335  vtkDataArray* LoadPointVarData(int variable);
336  vtkDataArray* LoadCellVarData(int variable);
337  vtkDataArray* LookupPointDataArray(int varIdx);
338  vtkDataArray* LookupCellDataArray(int varIdx);
339 
348  void LoadTimeFieldData(vtkUnstructuredGrid* dataset);
349 
350 private:
351  vtkMPASReader(const vtkMPASReader&) = delete;
352  void operator=(const vtkMPASReader&) = delete;
353 
354  class Internal;
355  Internal* Internals;
356 };
357 
358 #endif
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:38
GeometryType Geometry
virtual int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
This is called by the superclass.
size_t PointsPerCell
size_t ModNumPoints
abstract base class for most VTK objects
Definition: vtkObject.h:62
Store vtkAlgorithm input/output information.
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287
size_t * CellMap
size_t NumberOfTimeSteps
static vtkUnstructuredGridAlgorithm * New()
size_t PointOffset
double * PointZ
a vtkAbstractArray subclass for strings
bool IncludeTopography
virtual int RequestInformation(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
size_t CurrentExtraPoint
int * OrigConnections
int vtkIdType
Definition: vtkType.h:332
vtkDataArraySelection * PointDataArraySelection
Read an MPAS netCDF file.
Definition: vtkMPASReader.h:94
dynamic, self-adjusting array of double
double * PointX
bool UseDimensionedArrayNames
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
supports function callbacks
double * PointY
a simple class to control print indentation
Definition: vtkIndent.h:39
Store on/off settings for data arrays, etc.
dataset represents arbitrary combinations of all possible cell types
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:55
virtual vtkMTimeType GetMTime()
Return this object's modified time.
size_t NumberOfPoints
size_t CurrentExtraCell
Superclass for algorithms that produce only unstructured grid as output.
std::string VerticalDimension
int GetCellType(const Ioss::ElementTopology *topology)
Returns VTK celltype for a Ioss topology element.
#define VTK_FILEPATH
size_t MaximumNVertLevels
vtkCallbackCommand * SelectionObserver
Store zero or more vtkInformation instances.
int * MaximumLevelPoint
vtkUnstructuredGrid * GetOutput()
Get the output data object for a port on this algorithm.
int * ModConnections
size_t ModNumCells
vtkDataArraySelection * CellDataArraySelection
size_t NumberOfCells
size_t * PointMap
bool ShowMultilayerView