vtkMFIXReader Class Reference

#include <vtkMFIXReader.h>

Inheritance diagram for vtkMFIXReader:

Inheritance graph
[legend]
Collaboration diagram for vtkMFIXReader:

Collaboration graph
[legend]

List of all members.


Detailed Description

reads a dataset in MFIX file format

vtkMFIXReader creates an unstructured grid dataset. It reads a restart file and a set of sp files. The restart file contains the mesh information. MFIX meshes are either cylindrical or rectilinear, but this reader will convert them to an unstructured grid. The sp files contain transient data for the cells. Each sp file has one or more variables stored inside it.

Thanks:
Thanks to Phil Nicoletti and Brian Dotson at the National Energy Technology Laboratory who developed this class. Please address all comments to Brian Dotson (brian.dotson@netl.doe.gov)
See also:
vtkGAMBITReader

Definition at line 51 of file vtkMFIXReader.h.


Public Types

typedef
vtkUnstructuredGridAlgorithm 
Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
int GetNumberOfCellArrays (void)
const char * GetCellArrayName (int index)
void GetCellDataRange (int cellComp, int index, float *min, float *max)
virtual void SetFileName (const char *)
virtual char * GetFileName ()
virtual int GetNumberOfCells ()
virtual int GetNumberOfPoints ()
virtual int GetNumberOfCellFields ()
virtual void SetTimeStep (int)
virtual int GetTimeStep ()
virtual int GetNumberOfTimeSteps ()
virtual int * GetTimeStepRange ()
virtual void GetTimeStepRange (int &, int &)
virtual void GetTimeStepRange (int[2])
virtual void SetTimeStepRange (int, int)
void SetTimeStepRange (int[2])
int GetCellArrayStatus (const char *name)
void SetCellArrayStatus (const char *name, int status)
void DisableAllCellArrays ()
void EnableAllCellArrays ()

Static Public Member Functions

static vtkMFIXReaderNew ()
static int IsTypeOf (const char *type)
static vtkMFIXReaderSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkMFIXReader ()
 ~vtkMFIXReader ()
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Protected Attributes

char * FileName
int RequestInformationFlag
int MakeMeshFlag
int NumberOfPoints
int NumberOfCells
int NumberOfCellFields
vtkIntArrayVectorLength
vtkFloatArrayMinimum
vtkFloatArrayMaximum
vtkDataArraySelectionCellDataArraySelection
int TimeStep
int ActualTimeStep
int CurrentTimeStep
int NumberOfTimeSteps
int * TimeSteps
int TimeStepRange [2]
int TimeStepWasReadOnce
vtkFloatArray ** CellDataArray
vtkPointsPoints
vtkUnstructuredGridMesh
vtkHexahedronAHexahedron
vtkWedgeAWedge
vtkQuadAQuad
vtkIntArrayFlag
vtkDoubleArrayDx
vtkDoubleArrayDy
vtkDoubleArrayDz
vtkIntArrayNMax
vtkDoubleArrayC
vtkIntArrayTempI
vtkDoubleArrayTempD
vtkIntArraySpxFileExists
char FileExtension [15]
char DataBuffer [513]
char Version [120]
float VersionNumber
int DimensionIc
int DimensionBc
int DimensionC
int DimensionIs
double Ce
double Cf
double Phi
double PhiW
double DeltaTime
double XMinimum
char RunName [256]
vtkStringArrayVariableNames
vtkIntArrayVariableComponents
int IMinimum1
int JMinimum1
int KMinimum1
int IMaximum
int JMaximum
int KMaximum
int IMaximum1
int JMaximum1
int KMaximum1
int IMaximum2
int JMaximum2
int KMaximum2
int IJMaximum2
int IJKMaximum2
int MMAX
int NumberOfSPXFilesUsed
double XLength
double YLength
double ZLength
int NumberOfScalars
int NumberOfReactionRates
bool BkEpsilon
char CoordinateSystem [17]
char Units [17]
int MaximumTimestep
int SPXRecordsPerTimestep
vtkIntArraySPXToNVarTable
vtkIntArrayVariableToSkipTable
vtkIntArrayVariableTimesteps
vtkIntArrayVariableTimestepTable
vtkIntArrayvariableIndexToSPX
vtkIntArrayVariableIndexToSPX
vtkIntArraySPXTimestepIndexTable

Member Typedef Documentation

Reimplemented from vtkUnstructuredGridAlgorithm.

Definition at line 55 of file vtkMFIXReader.h.


Constructor & Destructor Documentation

vtkMFIXReader::vtkMFIXReader (  )  [protected]

vtkMFIXReader::~vtkMFIXReader (  )  [protected]


Member Function Documentation

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

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

Reimplemented from vtkUnstructuredGridAlgorithm.

virtual const char* vtkMFIXReader::GetClassName (  )  [virtual]

Reimplemented from vtkUnstructuredGridAlgorithm.

static int vtkMFIXReader::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 vtkMFIXReader::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.

static vtkMFIXReader* vtkMFIXReader::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkUnstructuredGridAlgorithm.

void vtkMFIXReader::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 vtkMFIXReader::SetFileName ( const char *   )  [virtual]

Specify the file name of the MFIX Restart data file to read.

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

Specify the file name of the MFIX Restart data file to read.

virtual int vtkMFIXReader::GetNumberOfCells (  )  [virtual]

Get the total number of cells. The number of cells is only valid after a successful read of the data file is performed.

virtual int vtkMFIXReader::GetNumberOfPoints (  )  [virtual]

Get the total number of nodes. The number of nodes is only valid after a successful read of the data file is performed.

virtual int vtkMFIXReader::GetNumberOfCellFields (  )  [virtual]

Get the number of data components at the nodes and cells.

virtual void vtkMFIXReader::SetTimeStep ( int   )  [virtual]

Which TimeStep to read.

virtual int vtkMFIXReader::GetTimeStep (  )  [virtual]

Which TimeStep to read.

virtual int vtkMFIXReader::GetNumberOfTimeSteps (  )  [virtual]

Returns the number of timesteps.

virtual int* vtkMFIXReader::GetTimeStepRange (  )  [virtual]

Which TimeStepRange to read

virtual void vtkMFIXReader::GetTimeStepRange ( int &  ,
int &   
) [virtual]

Which TimeStepRange to read

virtual void vtkMFIXReader::GetTimeStepRange ( int  [2]  )  [virtual]

Which TimeStepRange to read

virtual void vtkMFIXReader::SetTimeStepRange ( int  ,
int   
) [virtual]

Which TimeStepRange to read

void vtkMFIXReader::SetTimeStepRange ( int  [2]  ) 

Which TimeStepRange to read

int vtkMFIXReader::GetNumberOfCellArrays ( void   ) 

Get the number of cell arrays available in the input.

const char* vtkMFIXReader::GetCellArrayName ( int  index  ) 

Get the name of the cell array with the given index in the input.

int vtkMFIXReader::GetCellArrayStatus ( const char *  name  ) 

Get/Set whether the cell array with the given name is to be read.

void vtkMFIXReader::SetCellArrayStatus ( const char *  name,
int  status 
)

Get/Set whether the cell array with the given name is to be read.

void vtkMFIXReader::DisableAllCellArrays (  ) 

Turn on/off all cell arrays.

void vtkMFIXReader::EnableAllCellArrays (  ) 

Turn on/off all cell arrays.

void vtkMFIXReader::GetCellDataRange ( int  cellComp,
int  index,
float *  min,
float *  max 
)

Get the range of cell data.

int vtkMFIXReader::RequestInformation ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [protected, virtual]

Reimplemented from vtkUnstructuredGridAlgorithm.

int vtkMFIXReader::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.


Member Data Documentation

char* vtkMFIXReader::FileName [protected]

Definition at line 131 of file vtkMFIXReader.h.

Definition at line 132 of file vtkMFIXReader.h.

int vtkMFIXReader::MakeMeshFlag [protected]

Definition at line 133 of file vtkMFIXReader.h.

Definition at line 134 of file vtkMFIXReader.h.

Definition at line 135 of file vtkMFIXReader.h.

Definition at line 136 of file vtkMFIXReader.h.

Definition at line 137 of file vtkMFIXReader.h.

Definition at line 138 of file vtkMFIXReader.h.

Definition at line 139 of file vtkMFIXReader.h.

Definition at line 140 of file vtkMFIXReader.h.

int vtkMFIXReader::TimeStep [protected]

Definition at line 141 of file vtkMFIXReader.h.

Definition at line 142 of file vtkMFIXReader.h.

Definition at line 143 of file vtkMFIXReader.h.

Definition at line 144 of file vtkMFIXReader.h.

int* vtkMFIXReader::TimeSteps [protected]

Definition at line 145 of file vtkMFIXReader.h.

int vtkMFIXReader::TimeStepRange[2] [protected]

Definition at line 146 of file vtkMFIXReader.h.

Definition at line 147 of file vtkMFIXReader.h.

Definition at line 153 of file vtkMFIXReader.h.

Definition at line 155 of file vtkMFIXReader.h.

Definition at line 156 of file vtkMFIXReader.h.

Definition at line 157 of file vtkMFIXReader.h.

Definition at line 158 of file vtkMFIXReader.h.

Definition at line 159 of file vtkMFIXReader.h.

Definition at line 160 of file vtkMFIXReader.h.

Definition at line 161 of file vtkMFIXReader.h.

Definition at line 162 of file vtkMFIXReader.h.

Definition at line 163 of file vtkMFIXReader.h.

Definition at line 164 of file vtkMFIXReader.h.

Definition at line 165 of file vtkMFIXReader.h.

Definition at line 166 of file vtkMFIXReader.h.

Definition at line 167 of file vtkMFIXReader.h.

Definition at line 168 of file vtkMFIXReader.h.

char vtkMFIXReader::FileExtension[15] [protected]

Definition at line 171 of file vtkMFIXReader.h.

char vtkMFIXReader::DataBuffer[513] [protected]

Definition at line 172 of file vtkMFIXReader.h.

char vtkMFIXReader::Version[120] [protected]

Definition at line 173 of file vtkMFIXReader.h.

float vtkMFIXReader::VersionNumber [protected]

Definition at line 174 of file vtkMFIXReader.h.

int vtkMFIXReader::DimensionIc [protected]

Definition at line 175 of file vtkMFIXReader.h.

int vtkMFIXReader::DimensionBc [protected]

Definition at line 176 of file vtkMFIXReader.h.

int vtkMFIXReader::DimensionC [protected]

Definition at line 177 of file vtkMFIXReader.h.

int vtkMFIXReader::DimensionIs [protected]

Definition at line 178 of file vtkMFIXReader.h.

double vtkMFIXReader::Ce [protected]

Definition at line 179 of file vtkMFIXReader.h.

double vtkMFIXReader::Cf [protected]

Definition at line 180 of file vtkMFIXReader.h.

double vtkMFIXReader::Phi [protected]

Definition at line 181 of file vtkMFIXReader.h.

double vtkMFIXReader::PhiW [protected]

Definition at line 182 of file vtkMFIXReader.h.

double vtkMFIXReader::DeltaTime [protected]

Definition at line 183 of file vtkMFIXReader.h.

double vtkMFIXReader::XMinimum [protected]

Definition at line 184 of file vtkMFIXReader.h.

char vtkMFIXReader::RunName[256] [protected]

Definition at line 185 of file vtkMFIXReader.h.

Definition at line 186 of file vtkMFIXReader.h.

Definition at line 187 of file vtkMFIXReader.h.

int vtkMFIXReader::IMinimum1 [protected]

Definition at line 188 of file vtkMFIXReader.h.

int vtkMFIXReader::JMinimum1 [protected]

Definition at line 189 of file vtkMFIXReader.h.

int vtkMFIXReader::KMinimum1 [protected]

Definition at line 190 of file vtkMFIXReader.h.

int vtkMFIXReader::IMaximum [protected]

Definition at line 191 of file vtkMFIXReader.h.

int vtkMFIXReader::JMaximum [protected]

Definition at line 192 of file vtkMFIXReader.h.

int vtkMFIXReader::KMaximum [protected]

Definition at line 193 of file vtkMFIXReader.h.

int vtkMFIXReader::IMaximum1 [protected]

Definition at line 194 of file vtkMFIXReader.h.

int vtkMFIXReader::JMaximum1 [protected]

Definition at line 195 of file vtkMFIXReader.h.

int vtkMFIXReader::KMaximum1 [protected]

Definition at line 196 of file vtkMFIXReader.h.

int vtkMFIXReader::IMaximum2 [protected]

Definition at line 197 of file vtkMFIXReader.h.

int vtkMFIXReader::JMaximum2 [protected]

Definition at line 198 of file vtkMFIXReader.h.

int vtkMFIXReader::KMaximum2 [protected]

Definition at line 199 of file vtkMFIXReader.h.

int vtkMFIXReader::IJMaximum2 [protected]

Definition at line 200 of file vtkMFIXReader.h.

int vtkMFIXReader::IJKMaximum2 [protected]

Definition at line 201 of file vtkMFIXReader.h.

int vtkMFIXReader::MMAX [protected]

Definition at line 202 of file vtkMFIXReader.h.

Definition at line 203 of file vtkMFIXReader.h.

double vtkMFIXReader::XLength [protected]

Definition at line 204 of file vtkMFIXReader.h.

double vtkMFIXReader::YLength [protected]

Definition at line 205 of file vtkMFIXReader.h.

double vtkMFIXReader::ZLength [protected]

Definition at line 206 of file vtkMFIXReader.h.

Definition at line 207 of file vtkMFIXReader.h.

Definition at line 208 of file vtkMFIXReader.h.

bool vtkMFIXReader::BkEpsilon [protected]

Definition at line 209 of file vtkMFIXReader.h.

char vtkMFIXReader::CoordinateSystem[17] [protected]

Definition at line 210 of file vtkMFIXReader.h.

char vtkMFIXReader::Units[17] [protected]

Definition at line 211 of file vtkMFIXReader.h.

Definition at line 217 of file vtkMFIXReader.h.

Definition at line 218 of file vtkMFIXReader.h.

Definition at line 220 of file vtkMFIXReader.h.

Definition at line 221 of file vtkMFIXReader.h.

Definition at line 224 of file vtkMFIXReader.h.

Definition at line 225 of file vtkMFIXReader.h.

Definition at line 230 of file vtkMFIXReader.h.

Definition at line 232 of file vtkMFIXReader.h.

Definition at line 234 of file vtkMFIXReader.h.


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

Generated on Wed Aug 24 11:48:15 2011 for VTK by  doxygen 1.5.6