VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
vtkNetCDFCAMReader Class Reference

Read unstructured NetCDF CAM files. More...

#include <vtkNetCDFCAMReader.h>

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

List of all members.

Public Types

typedef
vtkUnstructuredGridAlgorithm 
Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkNetCDFCAMReaderNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
void SetFileName (const char *fileName)
virtual char * GetFileName ()
void SetConnectivityFileName (const char *fileName)
virtual char * GetConnectivityFileName ()
virtual void SingleLevelOn ()
virtual void SingleLevelOff ()
virtual void SetSingleLevel (int)
virtual int GetSingleLevel ()
virtual void SetCellLayerRight (int)
virtual int GetCellLayerRight ()

Static Public Member Functions

static vtkNetCDFCAMReaderNew ()
static int IsTypeOf (const char *type)
static vtkNetCDFCAMReaderSafeDownCast (vtkObjectBase *o)
static int CanReadFile (const char *fileName)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkNetCDFCAMReader ()
 ~vtkNetCDFCAMReader ()
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
bool GetPartitioning (int piece, int numPieces, int numCellLevels, int numCellsPerLevel, int &beginCellLevel, int &endCellLevel, int &beginCell, int &endCell)

Detailed Description

Read unstructured NetCDF CAM files.

Reads in a NetCDF CAM (Community Atmospheric Model) file and produces and unstructured grid. The grid is actually unstructured in the X and Y directions and rectilinear in the Z direction with all hex cells. The reader requires 2 NetCDF files. The first is the cell connectivity file which has the quad connectivity in the plane. The other connectivity file has all of the point and field information. Currently this reader ignores time that may exist in the points file.

Tests:
vtkNetCDFCAMReader (Tests)

Definition at line 39 of file vtkNetCDFCAMReader.h.


Member Typedef Documentation

Reimplemented from vtkUnstructuredGridAlgorithm.

Definition at line 43 of file vtkNetCDFCAMReader.h.


Constructor & Destructor Documentation


Member Function Documentation

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

Reimplemented from vtkUnstructuredGridAlgorithm.

static int vtkNetCDFCAMReader::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 vtkNetCDFCAMReader::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* vtkNetCDFCAMReader::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkUnstructuredGridAlgorithm.

Reimplemented from vtkUnstructuredGridAlgorithm.

void vtkNetCDFCAMReader::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.

static int vtkNetCDFCAMReader::CanReadFile ( const char *  fileName) [static]

Returns 1 if this file can be read and 0 if the file cannot be read. Because NetCDF CAM files come in pairs and we only check one of the files, the result is not definitive. Invalid files may still return 1 although a valid file will never return 0.

void vtkNetCDFCAMReader::SetFileName ( const char *  fileName)
virtual char* vtkNetCDFCAMReader::GetFileName ( ) [virtual]
void vtkNetCDFCAMReader::SetConnectivityFileName ( const char *  fileName)
virtual char* vtkNetCDFCAMReader::GetConnectivityFileName ( ) [virtual]
virtual void vtkNetCDFCAMReader::SingleLevelOn ( ) [virtual]

Set whether or not to read a single level. A value of one indicates that only a single level will be read in. The NetCDF variables loaded will then be ones with dimensions of (time, ncols). This will result in a surface grid. Otherwise a volumetric grid will be created (if lev > 1) and the variables with dimensions of (time, lev, ncols) will be read in. By default, SingleLevel = 0.

virtual void vtkNetCDFCAMReader::SingleLevelOff ( ) [virtual]

Set whether or not to read a single level. A value of one indicates that only a single level will be read in. The NetCDF variables loaded will then be ones with dimensions of (time, ncols). This will result in a surface grid. Otherwise a volumetric grid will be created (if lev > 1) and the variables with dimensions of (time, lev, ncols) will be read in. By default, SingleLevel = 0.

virtual void vtkNetCDFCAMReader::SetSingleLevel ( int  ) [virtual]

Set whether or not to read a single level. A value of one indicates that only a single level will be read in. The NetCDF variables loaded will then be ones with dimensions of (time, ncols). This will result in a surface grid. Otherwise a volumetric grid will be created (if lev > 1) and the variables with dimensions of (time, lev, ncols) will be read in. By default, SingleLevel = 0.

virtual int vtkNetCDFCAMReader::GetSingleLevel ( ) [virtual]

Set whether or not to read a single level. A value of one indicates that only a single level will be read in. The NetCDF variables loaded will then be ones with dimensions of (time, ncols). This will result in a surface grid. Otherwise a volumetric grid will be created (if lev > 1) and the variables with dimensions of (time, lev, ncols) will be read in. By default, SingleLevel = 0.

virtual void vtkNetCDFCAMReader::SetCellLayerRight ( int  ) [virtual]

Specify which "side" of the domain to add the connecting cells at. 0 indicates left side and 1 indicates right side. The default is the right side.

Specify which "side" of the domain to add the connecting cells at. 0 indicates left side and 1 indicates right side. The default is the right side.

Reimplemented from vtkUnstructuredGridAlgorithm.

virtual int vtkNetCDFCAMReader::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.

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

Reimplemented from vtkUnstructuredGridAlgorithm.

bool vtkNetCDFCAMReader::GetPartitioning ( int  piece,
int  numPieces,
int  numCellLevels,
int  numCellsPerLevel,
int beginCellLevel,
int endCellLevel,
int beginCell,
int endCell 
) [protected]

Returns true for success. Based on the piece, number of pieces, number of levels of cells, and the number of cells per level, gives a partitioned space of levels and cells.


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