vtkMPASReader.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkMPASReader.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
/*=========================================================================

Copyright (c) 2002-2005 Los Alamos National Laboratory

This software and ancillary information known as vtk_ext (and herein
called "SOFTWARE") is made available under the terms described below.
The SOFTWARE has been approved for release with associated LA_CC
Number 99-44, granted by Los Alamos National Laboratory in July 1999.

Unless otherwise indicated, this SOFTWARE has been authored by an
employee or employees of the University of California, operator of the
Los Alamos National Laboratory under Contract No. W-7405-ENG-36 with
the United States Department of Energy.

The United States Government has rights to use, reproduce, and
distribute this SOFTWARE.  The public may copy, distribute, prepare
derivative works and publicly display this SOFTWARE without charge,
provided that this Notice and any statement of authorship are
reproduced on all copies.

Neither the U. S. Government, the University of California, nor the
Advanced Computing Laboratory makes any warranty, either express or
implied, nor assumes any liability or responsibility for the use of
this SOFTWARE.

If SOFTWARE is modified to produce derivative works, such modified
SOFTWARE should be clearly marked, so as not to confuse it with the
version available from Los Alamos National Laboratory.

=========================================================================*/
#ifndef vtkMPASReader_h
#define vtkMPASReader_h

#include "vtkIONetCDFModule.h" // For export macro
#include "vtkUnstructuredGridAlgorithm.h"

#include <string> // for std::string

class vtkCallbackCommand;
class vtkDataArraySelection;
class vtkDoubleArray;
class vtkStdString;
class vtkStringArray;

class NcVar;
class NcDim;

class VTKIONETCDF_EXPORT vtkMPASReader : public vtkUnstructuredGridAlgorithm
{
 public:
  static vtkMPASReader *New();
  vtkTypeMacro(vtkMPASReader,vtkUnstructuredGridAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent);


  vtkSetStringMacro(FileName);
  vtkGetStringMacro(FileName);


  vtkGetMacro(MaximumCells, int);


  vtkGetMacro(MaximumPoints, int);


  virtual int GetNumberOfCellVars();
  virtual int GetNumberOfPointVars();


  vtkUnstructuredGrid *GetOutput();
  vtkUnstructuredGrid *GetOutput(int index);


  vtkSetMacro(UseDimensionedArrayNames, bool)
  vtkGetMacro(UseDimensionedArrayNames, bool)
  vtkBooleanMacro(UseDimensionedArrayNames, bool)


  int GetNumberOfPointArrays();
  const char* GetPointArrayName(int index);
  int GetPointArrayStatus(const char* name);
  void SetPointArrayStatus(const char* name, int status);
  void DisableAllPointArrays();
  void EnableAllPointArrays();

  int GetNumberOfCellArrays();
  const char* GetCellArrayName(int index);
  int GetCellArrayStatus(const char* name);
  void SetCellArrayStatus(const char* name, int status);
  void DisableAllCellArrays();
  void EnableAllCellArrays();


  int GetNumberOfDimensions();
  std::string GetDimensionName(int idx);
  vtkStringArray* GetAllDimensions();
  int GetDimensionCurrentIndex(const std::string &dim);
  void SetDimensionCurrentIndex(const std::string &dim, int idx);
  int GetDimensionSize(const std::string &dim);


  vtkSetMacro(VerticalDimension, std::string)
  vtkGetMacro(VerticalDimension, std::string)


  void SetVerticalLevel(int level);
  int GetVerticalLevel();

  vtkGetVector2Macro(VerticalLevelRange, int)

  vtkSetMacro(LayerThickness, int)
  vtkGetMacro(LayerThickness, int)
  vtkGetVector2Macro(LayerThicknessRange, int)

  void SetCenterLon(int val);
  vtkGetVector2Macro(CenterLonRange, int)

  vtkSetMacro(ProjectLatLon, bool)
  vtkGetMacro(ProjectLatLon, bool)

  vtkSetMacro(IsAtmosphere, bool)
  vtkGetMacro(IsAtmosphere, bool)

  vtkSetMacro(IsZeroCentered, bool)
  vtkGetMacro(IsZeroCentered, bool)

  vtkSetMacro(ShowMultilayerView, bool)
  vtkGetMacro(ShowMultilayerView, bool)

  static int CanReadFile(const char *filename);

  vtkMTimeType GetMTime();

 protected:
  vtkMPASReader();
  ~vtkMPASReader();
  void ReleaseNcData();
  void DestroyData();

  char *FileName;         // First field part file giving path

  int NumberOfTimeSteps;      // Temporal domain
  double DTime;               // The current time

  // Observer to modify this object when array selections are modified
  vtkCallbackCommand* SelectionObserver;

  int RequestData(vtkInformation *, vtkInformationVector **,
                  vtkInformationVector *);
  int RequestInformation(vtkInformation *, vtkInformationVector **,
                         vtkInformationVector *);


  static void SelectionCallback(vtkObject* caller, unsigned long eid,
                                void* clientdata, void* calldata);

  // Selected field of interest
  vtkDataArraySelection* PointDataArraySelection;
  vtkDataArraySelection* CellDataArraySelection;

  void UpdateDimensions(bool force = false);

  std::string VerticalDimension;
  int VerticalLevelRange[2];

  int LayerThickness;
  int LayerThicknessRange[2];

  int CenterLon;
  int CenterLonRange[2];

  enum GeometryType
  {
    Spherical,
    Projected,
    Planar
  };

  GeometryType Geometry;

  bool ProjectLatLon; // User option
  bool OnASphere; // Data file attribute
  bool IsAtmosphere;
  bool IsZeroCentered;
  bool ShowMultilayerView;

  bool IncludeTopography;
  bool DoBugFix;
  double CenterRad;

  bool UseDimensionedArrayNames;

  // geometry
  int MaximumNVertLevels;
  int NumberOfCells;
  int NumberOfPoints;
  int CellOffset;
  int PointOffset;
  int PointsPerCell;
  int CurrentExtraPoint;  // current extra point
  int CurrentExtraCell;   // current extra  cell
  double* PointX;      // x coord of point
  double* PointY;      // y coord of point
  double* PointZ;      // z coord of point
  int ModNumPoints;
  int ModNumCells;
  int* OrigConnections;   // original connections
  int* ModConnections;    // modified connections
  int* CellMap;           // maps from added cell to original cell #
  int* PointMap;          // maps from added point to original point #
  int* MaximumLevelPoint;      //
  int MaximumCells;           // max cells
  int MaximumPoints;          // max points

  void SetDefaults();
  int GetNcDims();
  int GetNcAtts();
  int CheckParams();
  int GetNcVars(const char* cellDimName, const char* pointDimName);
  int ReadAndOutputGrid();
  int BuildVarArrays();
  int AllocSphericalGeometry();
  int AllocProjectedGeometry();
  int AllocPlanarGeometry();
  void ShiftLonData();
  int AddMirrorPoint(int index, double dividerX, double offset);
  void FixPoints();
  int EliminateXWrap();
  void OutputPoints();
  void OutputCells();
  unsigned char GetCellType();

  bool ValidateDimensions(NcVar *var, bool silent, int ndims, ...);

  long GetCursorForDimension(const NcDim *dim);

  size_t GetCountForDimension(const NcDim *dim);

  long InitializeDimension(const NcDim *dim);

  vtkDataArray* LoadPointVarData(int variable);
  vtkDataArray* LoadCellVarData(int variable);
  vtkDataArray* LookupPointDataArray(int varIdx);
  vtkDataArray* LookupCellDataArray(int varIdx);

  void LoadTimeFieldData(vtkUnstructuredGrid *dataset);

 private:
  vtkMPASReader(const vtkMPASReader&) VTK_DELETE_FUNCTION;
  void operator=(const vtkMPASReader&) VTK_DELETE_FUNCTION;

  class Internal;
  Internal *Internals;

  static int NcTypeToVtkType(int ncType);

  vtkDataArray* CreateDataArray(int ncType);
  vtkIdType ComputeNumberOfTuples(NcVar *ncVar);

  template <typename ValueType>
  bool LoadDataArray(NcVar *ncVar, vtkDataArray *array, bool resize = true);

  template <typename ValueType>
  int LoadPointVarDataImpl(NcVar *ncVar, vtkDataArray *array);

  template <typename ValueType>
  int LoadCellVarDataImpl(NcVar *ncVar, vtkDataArray *array);
};

#endif