VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes
vtkMPASReader Class Reference

Read an MPAS netCDF file. More...

#include <vtkMPASReader.h>

Inheritance diagram for vtkMPASReader:
Inheritance graph
[legend]
Collaboration diagram for vtkMPASReader:
Collaboration graph
[legend]

List of all members.

Public Types

typedef
vtkUnstructuredGridAlgorithm 
Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkMPASReaderNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
int GetNumberOfCellArrays ()
const char * GetCellArrayName (int index)
int GetCellArrayStatus (const char *name)
void SetCellArrayStatus (const char *name, int status)
void DisableAllCellArrays ()
void EnableAllCellArrays ()
void SetVerticalLevel (int level)
virtual intGetVerticalLevelRange ()
virtual void GetVerticalLevelRange (int &, int &)
virtual void GetVerticalLevelRange (int[2])
void SetLayerThickness (int val)
virtual intGetLayerThicknessRange ()
virtual void GetLayerThicknessRange (int &, int &)
virtual void GetLayerThicknessRange (int[2])
void SetCenterLon (int val)
virtual intGetCenterLonRange ()
virtual void GetCenterLonRange (int &, int &)
virtual void GetCenterLonRange (int[2])
void SetProjectLatLon (bool val)
virtual bool GetProjectLatLon ()
void SetIsAtmosphere (bool val)
virtual bool GetIsAtmosphere ()
void SetIsZeroCentered (bool val)
virtual bool GetIsZeroCentered ()
void SetShowMultilayerView (bool val)
virtual bool GetShowMultilayerView ()
virtual void SetFileName (const char *)
virtual char * GetFileName ()
virtual int GetMaximumCells ()
virtual int GetMaximumPoints ()
virtual int GetNumberOfCellVars ()
virtual int GetNumberOfPointVars ()
vtkUnstructuredGridGetOutput ()
vtkUnstructuredGridGetOutput (int index)
int GetNumberOfPointArrays ()
const char * GetPointArrayName (int index)
int GetPointArrayStatus (const char *name)
void SetPointArrayStatus (const char *name, int status)
void DisableAllPointArrays ()
void EnableAllPointArrays ()

Static Public Member Functions

static vtkMPASReaderNew ()
static int IsTypeOf (const char *type)
static vtkMPASReaderSafeDownCast (vtkObjectBase *o)
static int CanReadFile (const char *filename)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkMPASReader ()
 ~vtkMPASReader ()
void DestroyData ()
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void SetDefaults ()
int GetNcDims ()
int CheckParams ()
int GetNcVars (const char *cellDimName, const char *pointDimName)
int ReadAndOutputGrid (bool init)
int ReadAndOutputVariableData ()
int BuildVarArrays ()
int AllocSphereGeometry ()
int AllocLatLonGeometry ()
void ShiftLonData ()
int AddMirrorPoint (int index, double dividerX)
void FixPoints ()
int EliminateXWrap ()
void OutputPoints (bool init)
void OutputCells (bool init)
unsigned char GetCellType ()
void LoadGeometryData (int var, double dTime)
int LoadPointVarData (int variable, double dTime)
int LoadCellVarData (int variable, double dTime)
int RegenerateGeometry ()

Static Protected Member Functions

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

Protected Attributes

char * FileName
vtkStdStringVariableName
intVariableType
int NumberOfTimeSteps
doubleTimeSteps
double DTime
vtkCallbackCommandSelectionObserver
bool InfoRequested
bool DataRequested
vtkDataArraySelectionPointDataArraySelection
vtkDataArraySelectionCellDataArraySelection
vtkDoubleArray ** CellVarDataArray
vtkDoubleArray ** PointVarDataArray
int VerticalLevelSelected
int VerticalLevelRange [2]
int LayerThickness
int LayerThicknessRange [2]
int CenterLon
int CenterLonRange [2]
bool ProjectLatLon
bool IsAtmosphere
bool IsZeroCentered
bool ShowMultilayerView
bool IncludeTopography
bool DoBugFix
double CenterRad
int MaximumNVertLevels
int NumberOfCells
int NumberOfPoints
int CellOffset
int PointOffset
int PointsPerCell
int CurrentExtraPoint
int CurrentExtraCell
doublePointX
doublePointY
doublePointZ
int ModNumPoints
int ModNumCells
intOrigConnections
intModConnections
intCellMap
intPointMap
intMaximumLevelPoint
int MaximumCells
int MaximumPoints
int VerticalIndex
int NumberOfCellVars
int NumberOfPointVars
doublePointVarData

Detailed Description

Read an MPAS netCDF file.

This program reads an MPAS netCDF data file to allow paraview to display a dual-grid sphere or latlon projection. Also allows display of primal-grid sphere. The variables that have time dim are available to ParaView.

Assume all variables are of interest if they have dims (Time, nCells|nVertices, nVertLevels, [nTracers]) Assume no more than 100 vars each for cell and point data Does not deal with edge data.

When using this reader, it is important that you remember to do the following:

  1. When changing a selected variable, remember to select it also in the drop down box to "color by". It doesn't color by that variable automatically.
  2. When selecting multilayer sphere view, make layer thickness around 100,000.
  3. When selecting multilayer lat/lon view, make layer thickness around 10.
  4. Always click the -Z orientation after making a switch from lat/lon to sphere, from single to multilayer or changing thickness.
  5. Be conservative on the number of changes you make before hitting Apply, since there may be bugs in this reader. Just make one change and then hit Apply.

Christine Ahrens (cahre.nosp@m.ns@l.nosp@m.anl.g.nosp@m.ov) Version 1.3

Tests:
vtkMPASReader (Tests)

Definition at line 95 of file vtkMPASReader.h.


Member Typedef Documentation

Reimplemented from vtkUnstructuredGridAlgorithm.

Definition at line 99 of file vtkMPASReader.h.


Constructor & Destructor Documentation


Member Function Documentation

static vtkMPASReader* vtkMPASReader::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkUnstructuredGridAlgorithm.

static int vtkMPASReader::IsTypeOf ( const char *  name) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkUnstructuredGridAlgorithm.

virtual int vtkMPASReader::IsA ( const char *  name) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkUnstructuredGridAlgorithm.

Reimplemented from vtkUnstructuredGridAlgorithm.

virtual vtkObjectBase* vtkMPASReader::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkUnstructuredGridAlgorithm.

Reimplemented from vtkUnstructuredGridAlgorithm.

void vtkMPASReader::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkUnstructuredGridAlgorithm.

virtual void vtkMPASReader::SetFileName ( const char *  ) [virtual]

Specify file name of MPAS data file to read.

virtual char* vtkMPASReader::GetFileName ( ) [virtual]

Specify file name of MPAS data file to read.

virtual int vtkMPASReader::GetMaximumCells ( ) [virtual]

Get the number of data cells

virtual int vtkMPASReader::GetMaximumPoints ( ) [virtual]

Get the number of points

virtual int vtkMPASReader::GetNumberOfCellVars ( ) [virtual]

Get the number of data variables at the cell centers and points

Get the number of data variables at the cell centers and points

Get the reader's output

Reimplemented from vtkUnstructuredGridAlgorithm.

Get the reader's output

Reimplemented from vtkUnstructuredGridAlgorithm.

The following methods allow selective reading of solutions fields. By default, ALL data fields on the nodes are read, but this can be modified.

const char* vtkMPASReader::GetPointArrayName ( int  index)

The following methods allow selective reading of solutions fields. By default, ALL data fields on the nodes are read, but this can be modified.

int vtkMPASReader::GetPointArrayStatus ( const char *  name)

The following methods allow selective reading of solutions fields. By default, ALL data fields on the nodes are read, but this can be modified.

void vtkMPASReader::SetPointArrayStatus ( const char *  name,
int  status 
)

The following methods allow selective reading of solutions fields. By default, ALL data fields on the nodes are read, but this can be modified.

The following methods allow selective reading of solutions fields. By default, ALL data fields on the nodes are read, but this can be modified.

The following methods allow selective reading of solutions fields. By default, ALL data fields on the nodes are read, but this can be modified.

const char* vtkMPASReader::GetCellArrayName ( int  index)
int vtkMPASReader::GetCellArrayStatus ( const char *  name)
void vtkMPASReader::SetCellArrayStatus ( const char *  name,
int  status 
)
virtual int* vtkMPASReader::GetVerticalLevelRange ( ) [virtual]
virtual void vtkMPASReader::GetVerticalLevelRange ( int ,
int  
) [virtual]
virtual void vtkMPASReader::GetVerticalLevelRange ( int  [2]) [virtual]
virtual void vtkMPASReader::GetLayerThicknessRange ( int ,
int  
) [virtual]
virtual void vtkMPASReader::GetLayerThicknessRange ( int  [2]) [virtual]
virtual int* vtkMPASReader::GetCenterLonRange ( ) [virtual]
virtual void vtkMPASReader::GetCenterLonRange ( int ,
int  
) [virtual]
virtual void vtkMPASReader::GetCenterLonRange ( int  [2]) [virtual]
void vtkMPASReader::SetProjectLatLon ( bool  val)
virtual bool vtkMPASReader::GetProjectLatLon ( ) [virtual]
void vtkMPASReader::SetIsAtmosphere ( bool  val)
virtual bool vtkMPASReader::GetIsAtmosphere ( ) [virtual]
virtual bool vtkMPASReader::GetIsZeroCentered ( ) [virtual]
virtual bool vtkMPASReader::GetShowMultilayerView ( ) [virtual]
static int vtkMPASReader::CanReadFile ( const char *  filename) [static]

Returns true if the given file can be read.

void vtkMPASReader::DestroyData ( ) [protected]
int vtkMPASReader::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

This is called by the superclass. This is the method you should override.

Reimplemented from vtkUnstructuredGridAlgorithm.

Reimplemented from vtkUnstructuredGridAlgorithm.

static void vtkMPASReader::SelectionCallback ( vtkObject caller,
unsigned long  eid,
void *  clientdata,
void *  calldata 
) [static, protected]
void vtkMPASReader::SetDefaults ( ) [protected]
int vtkMPASReader::GetNcDims ( ) [protected]
int vtkMPASReader::GetNcVars ( const char *  cellDimName,
const char *  pointDimName 
) [protected]
int vtkMPASReader::ReadAndOutputGrid ( bool  init) [protected]
void vtkMPASReader::ShiftLonData ( ) [protected]
int vtkMPASReader::AddMirrorPoint ( int  index,
double  dividerX 
) [protected]
void vtkMPASReader::FixPoints ( ) [protected]
void vtkMPASReader::OutputPoints ( bool  init) [protected]
void vtkMPASReader::OutputCells ( bool  init) [protected]
unsigned char vtkMPASReader::GetCellType ( ) [protected]
void vtkMPASReader::LoadGeometryData ( int  var,
double  dTime 
) [protected]
int vtkMPASReader::LoadPointVarData ( int  variable,
double  dTime 
) [protected]
int vtkMPASReader::LoadCellVarData ( int  variable,
double  dTime 
) [protected]

Member Data Documentation

char* vtkMPASReader::FileName [protected]

Definition at line 178 of file vtkMPASReader.h.

Definition at line 187 of file vtkMPASReader.h.

Definition at line 188 of file vtkMPASReader.h.

Definition at line 190 of file vtkMPASReader.h.

Definition at line 191 of file vtkMPASReader.h.

Definition at line 192 of file vtkMPASReader.h.

Definition at line 196 of file vtkMPASReader.h.

bool vtkMPASReader::InfoRequested [protected]

Definition at line 207 of file vtkMPASReader.h.

bool vtkMPASReader::DataRequested [protected]

Definition at line 208 of file vtkMPASReader.h.

Definition at line 213 of file vtkMPASReader.h.

Definition at line 214 of file vtkMPASReader.h.

Definition at line 216 of file vtkMPASReader.h.

Definition at line 217 of file vtkMPASReader.h.

Definition at line 219 of file vtkMPASReader.h.

Definition at line 220 of file vtkMPASReader.h.

Definition at line 222 of file vtkMPASReader.h.

Definition at line 223 of file vtkMPASReader.h.

Definition at line 225 of file vtkMPASReader.h.

Definition at line 226 of file vtkMPASReader.h.

bool vtkMPASReader::ProjectLatLon [protected]

Definition at line 228 of file vtkMPASReader.h.

bool vtkMPASReader::IsAtmosphere [protected]

Definition at line 229 of file vtkMPASReader.h.

Definition at line 230 of file vtkMPASReader.h.

Definition at line 231 of file vtkMPASReader.h.

Definition at line 233 of file vtkMPASReader.h.

bool vtkMPASReader::DoBugFix [protected]

Definition at line 234 of file vtkMPASReader.h.

Definition at line 235 of file vtkMPASReader.h.

Definition at line 239 of file vtkMPASReader.h.

Definition at line 240 of file vtkMPASReader.h.

Definition at line 241 of file vtkMPASReader.h.

Definition at line 242 of file vtkMPASReader.h.

Definition at line 243 of file vtkMPASReader.h.

Definition at line 244 of file vtkMPASReader.h.

Definition at line 245 of file vtkMPASReader.h.

Definition at line 246 of file vtkMPASReader.h.

Definition at line 247 of file vtkMPASReader.h.

Definition at line 248 of file vtkMPASReader.h.

Definition at line 249 of file vtkMPASReader.h.

Definition at line 250 of file vtkMPASReader.h.

Definition at line 251 of file vtkMPASReader.h.

Definition at line 252 of file vtkMPASReader.h.

Definition at line 253 of file vtkMPASReader.h.

Definition at line 254 of file vtkMPASReader.h.

Definition at line 255 of file vtkMPASReader.h.

Definition at line 256 of file vtkMPASReader.h.

Definition at line 257 of file vtkMPASReader.h.

Definition at line 258 of file vtkMPASReader.h.

Definition at line 259 of file vtkMPASReader.h.

Definition at line 262 of file vtkMPASReader.h.

Definition at line 263 of file vtkMPASReader.h.

Definition at line 264 of file vtkMPASReader.h.


The documentation for this class was generated from the following file: