vtkOpenFOAMReader Class Reference

#include <vtkOpenFOAMReader.h>

Inheritance diagram for vtkOpenFOAMReader:

Inheritance graph
[legend]
Collaboration diagram for vtkOpenFOAMReader:

Collaboration graph
[legend]

List of all members.


Detailed Description

reads a dataset in OpenFOAM format

vtkOpenFOAMReader creates a multiblock dataset. It reads mesh information and time dependent data. The polyMesh folders contain mesh information. The time folders contain transient data for the cells. Each folder can contain any number of data files.

Thanks:
Thanks to Terry Jordan of SAIC at the National Energy Technology Laboratory who developed this class. Please address all comments to Terry Jordan (terry.jordan@sa.netl.doe.gov). GUI Based selection of mesh regions and fields available in the case, minor bug fixes, strict memory allocation checks, minor performance enhancements by Philippose Rajan (sarith@rocketmail.com). Token-based FoamFile format lexer/parser, performance/stability/compatibility enhancements, gzipped file support, lagrangian field support, variable timestep support, builtin cell-to-point filter, pointField support, polyhedron decomposition support, OF 1.5 extended format support, multiregion support, old mesh format support, parallelization support for decomposed cases in conjunction with vtkPOpenFOAMReader, et. al. by Takuya Oshima of Niigata University, Japan (oshima@eng.niigata-u.ac.jp).

Definition at line 54 of file vtkOpenFOAMReader.h.


Public Types

typedef
vtkMultiBlockDataSetAlgorithm 
Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &, vtkIndent)
int CanReadFile (const char *)
void SetRefresh ()
void SetParent (vtkOpenFOAMReader *parent)
int MakeInformationVector (vtkInformationVector *, const vtkStdString &)
bool SetTimeValue (const double)
vtkDoubleArrayGetTimeValues ()
int MakeMetaDataAtTimeStep (const bool)
virtual void SetFileName (const char *)
virtual char * GetFileName ()
int GetNumberOfCellArrays (void)
int GetCellArrayStatus (const char *name)
void SetCellArrayStatus (const char *name, int status)
const char * GetCellArrayName (int index)
void DisableAllCellArrays ()
void EnableAllCellArrays ()
int GetNumberOfPointArrays (void)
int GetPointArrayStatus (const char *name)
void SetPointArrayStatus (const char *name, int status)
const char * GetPointArrayName (int index)
void DisableAllPointArrays ()
void EnableAllPointArrays ()
int GetNumberOfLagrangianArrays (void)
int GetLagrangianArrayStatus (const char *name)
void SetLagrangianArrayStatus (const char *name, int status)
const char * GetLagrangianArrayName (int index)
void DisableAllLagrangianArrays ()
void EnableAllLagrangianArrays ()
int GetNumberOfPatchArrays (void)
int GetPatchArrayStatus (const char *name)
void SetPatchArrayStatus (const char *name, int status)
const char * GetPatchArrayName (int index)
void DisableAllPatchArrays ()
void EnableAllPatchArrays ()
virtual void SetCreateCellToPoint (int)
virtual int GetCreateCellToPoint ()
virtual void CreateCellToPointOn ()
virtual void CreateCellToPointOff ()
virtual void SetCacheMesh (int)
virtual int GetCacheMesh ()
virtual void CacheMeshOn ()
virtual void CacheMeshOff ()
virtual void SetDecomposePolyhedra (int)
virtual int GetDecomposePolyhedra ()
virtual void DecomposePolyhedraOn ()
virtual void DecomposePolyhedraOff ()
virtual void SetPositionsIsIn13Format (int)
virtual int GetPositionsIsIn13Format ()
virtual void PositionsIsIn13FormatOn ()
virtual void PositionsIsIn13FormatOff ()
virtual void SetListTimeStepsByControlDict (int)
virtual int GetListTimeStepsByControlDict ()
virtual void ListTimeStepsByControlDictOn ()
virtual void ListTimeStepsByControlDictOff ()
virtual void SetAddDimensionsToArrayNames (int)
virtual int GetAddDimensionsToArrayNames ()
virtual void AddDimensionsToArrayNamesOn ()
virtual void AddDimensionsToArrayNamesOff ()
virtual void SetReadZones (int)
virtual int GetReadZones ()
virtual void ReadZonesOn ()
virtual void ReadZonesOff ()

Static Public Member Functions

static vtkOpenFOAMReaderNew ()
static int IsTypeOf (const char *type)
static vtkOpenFOAMReaderSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkOpenFOAMReader ()
 ~vtkOpenFOAMReader ()
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void CreateCasePath (vtkStdString &, vtkStdString &)
void SetTimeInformation (vtkInformationVector *, vtkDoubleArray *)
void CreateCharArrayFromString (vtkCharArray *, const char *, vtkStdString &)
void UpdateStatus ()
void UpdateProgress (double)

Protected Attributes

bool Refresh
int CreateCellToPoint
int CacheMesh
int DecomposePolyhedra
int PositionsIsIn13Format
int ReadZones
int ListTimeStepsByControlDict
int AddDimensionsToArrayNames
char * FileName
vtkCharArrayCasePath
vtkCollectionReaders
vtkDataArraySelectionPatchDataArraySelection
vtkDataArraySelectionCellDataArraySelection
vtkDataArraySelectionPointDataArraySelection
vtkDataArraySelectionLagrangianDataArraySelection
unsigned long int PatchSelectionMTimeOld
unsigned long int CellSelectionMTimeOld
unsigned long int PointSelectionMTimeOld
unsigned long int LagrangianSelectionMTimeOld
vtkStdStringFileNameOld
int ListTimeStepsByControlDictOld
int CreateCellToPointOld
int DecomposePolyhedraOld
int PositionsIsIn13FormatOld
int AddDimensionsToArrayNamesOld
int ReadZonesOld
vtkStringArrayLagrangianPaths
int NumberOfReaders
int CurrentReaderIndex

Friends

class vtkOpenFOAMReaderPrivate

Member Typedef Documentation

Reimplemented from vtkMultiBlockDataSetAlgorithm.

Reimplemented in vtkPOpenFOAMReader.

Definition at line 58 of file vtkOpenFOAMReader.h.


Constructor & Destructor Documentation

vtkOpenFOAMReader::vtkOpenFOAMReader (  )  [protected]

vtkOpenFOAMReader::~vtkOpenFOAMReader (  )  [protected]


Member Function Documentation

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

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

Reimplemented from vtkMultiBlockDataSetAlgorithm.

Reimplemented in vtkPOpenFOAMReader.

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

Reimplemented from vtkMultiBlockDataSetAlgorithm.

Reimplemented in vtkPOpenFOAMReader.

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

Reimplemented in vtkPOpenFOAMReader.

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

Reimplemented in vtkPOpenFOAMReader.

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

Reimplemented from vtkMultiBlockDataSetAlgorithm.

Reimplemented in vtkPOpenFOAMReader.

void vtkOpenFOAMReader::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 vtkMultiBlockDataSetAlgorithm.

Reimplemented in vtkPOpenFOAMReader.

int vtkOpenFOAMReader::CanReadFile ( const char *   ) 

Determine if the file can be readed with this reader.

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

Set/Get the filename.

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

Set/Get the filename.

int vtkOpenFOAMReader::GetNumberOfCellArrays ( void   )  [inline]

Get the number of cell arrays available in the input.

Definition at line 72 of file vtkOpenFOAMReader.h.

int vtkOpenFOAMReader::GetCellArrayStatus ( const char *  name  )  [inline]

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

Definition at line 78 of file vtkOpenFOAMReader.h.

void vtkOpenFOAMReader::SetCellArrayStatus ( const char *  name,
int  status 
) [inline]

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

Definition at line 80 of file vtkOpenFOAMReader.h.

const char* vtkOpenFOAMReader::GetCellArrayName ( int  index  )  [inline]

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

Definition at line 86 of file vtkOpenFOAMReader.h.

void vtkOpenFOAMReader::DisableAllCellArrays (  )  [inline]

Turn on/off all cell arrays.

Definition at line 92 of file vtkOpenFOAMReader.h.

void vtkOpenFOAMReader::EnableAllCellArrays (  )  [inline]

Turn on/off all cell arrays.

Definition at line 94 of file vtkOpenFOAMReader.h.

int vtkOpenFOAMReader::GetNumberOfPointArrays ( void   )  [inline]

Get the number of point arrays available in the input.

Definition at line 100 of file vtkOpenFOAMReader.h.

int vtkOpenFOAMReader::GetPointArrayStatus ( const char *  name  )  [inline]

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

Definition at line 106 of file vtkOpenFOAMReader.h.

void vtkOpenFOAMReader::SetPointArrayStatus ( const char *  name,
int  status 
) [inline]

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

Definition at line 108 of file vtkOpenFOAMReader.h.

const char* vtkOpenFOAMReader::GetPointArrayName ( int  index  )  [inline]

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

Definition at line 115 of file vtkOpenFOAMReader.h.

void vtkOpenFOAMReader::DisableAllPointArrays (  )  [inline]

Turn on/off all point arrays.

Definition at line 121 of file vtkOpenFOAMReader.h.

void vtkOpenFOAMReader::EnableAllPointArrays (  )  [inline]

Turn on/off all point arrays.

Definition at line 123 of file vtkOpenFOAMReader.h.

int vtkOpenFOAMReader::GetNumberOfLagrangianArrays ( void   )  [inline]

Get the number of Lagrangian arrays available in the input.

Definition at line 129 of file vtkOpenFOAMReader.h.

int vtkOpenFOAMReader::GetLagrangianArrayStatus ( const char *  name  )  [inline]

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

Definition at line 137 of file vtkOpenFOAMReader.h.

void vtkOpenFOAMReader::SetLagrangianArrayStatus ( const char *  name,
int  status 
) [inline]

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

Definition at line 140 of file vtkOpenFOAMReader.h.

const char* vtkOpenFOAMReader::GetLagrangianArrayName ( int  index  )  [inline]

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

Definition at line 148 of file vtkOpenFOAMReader.h.

void vtkOpenFOAMReader::DisableAllLagrangianArrays (  )  [inline]

Turn on/off all Lagrangian arrays.

Definition at line 155 of file vtkOpenFOAMReader.h.

void vtkOpenFOAMReader::EnableAllLagrangianArrays (  )  [inline]

Turn on/off all Lagrangian arrays.

Definition at line 157 of file vtkOpenFOAMReader.h.

int vtkOpenFOAMReader::GetNumberOfPatchArrays ( void   )  [inline]

Get the number of Patches (inlcuding Internal Mesh) available in the input.

Definition at line 164 of file vtkOpenFOAMReader.h.

int vtkOpenFOAMReader::GetPatchArrayStatus ( const char *  name  )  [inline]

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

Definition at line 170 of file vtkOpenFOAMReader.h.

void vtkOpenFOAMReader::SetPatchArrayStatus ( const char *  name,
int  status 
) [inline]

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

Definition at line 172 of file vtkOpenFOAMReader.h.

const char* vtkOpenFOAMReader::GetPatchArrayName ( int  index  )  [inline]

Get the name of the Patch with the given index in the input.

Definition at line 179 of file vtkOpenFOAMReader.h.

void vtkOpenFOAMReader::DisableAllPatchArrays (  )  [inline]

Turn on/off all Patches including the Internal Mesh.

Definition at line 185 of file vtkOpenFOAMReader.h.

void vtkOpenFOAMReader::EnableAllPatchArrays (  )  [inline]

Turn on/off all Patches including the Internal Mesh.

Definition at line 187 of file vtkOpenFOAMReader.h.

virtual void vtkOpenFOAMReader::SetCreateCellToPoint ( int   )  [virtual]

Set/Get whether to create cell-to-point translated data for cell-type data

virtual int vtkOpenFOAMReader::GetCreateCellToPoint (  )  [virtual]

Set/Get whether to create cell-to-point translated data for cell-type data

virtual void vtkOpenFOAMReader::CreateCellToPointOn (  )  [virtual]

Set/Get whether to create cell-to-point translated data for cell-type data

virtual void vtkOpenFOAMReader::CreateCellToPointOff (  )  [virtual]

Set/Get whether to create cell-to-point translated data for cell-type data

virtual void vtkOpenFOAMReader::SetCacheMesh ( int   )  [virtual]

Set/Get whether mesh is to be cached.

virtual int vtkOpenFOAMReader::GetCacheMesh (  )  [virtual]

Set/Get whether mesh is to be cached.

virtual void vtkOpenFOAMReader::CacheMeshOn (  )  [virtual]

Set/Get whether mesh is to be cached.

virtual void vtkOpenFOAMReader::CacheMeshOff (  )  [virtual]

Set/Get whether mesh is to be cached.

virtual void vtkOpenFOAMReader::SetDecomposePolyhedra ( int   )  [virtual]

Set/Get whether polyhedra are to be decomposed.

virtual int vtkOpenFOAMReader::GetDecomposePolyhedra (  )  [virtual]

Set/Get whether polyhedra are to be decomposed.

virtual void vtkOpenFOAMReader::DecomposePolyhedraOn (  )  [virtual]

Set/Get whether polyhedra are to be decomposed.

virtual void vtkOpenFOAMReader::DecomposePolyhedraOff (  )  [virtual]

Set/Get whether polyhedra are to be decomposed.

virtual void vtkOpenFOAMReader::SetPositionsIsIn13Format ( int   )  [virtual]

Set/Get whether the lagrangian/positions is in OF 1.3 format

virtual int vtkOpenFOAMReader::GetPositionsIsIn13Format (  )  [virtual]

Set/Get whether the lagrangian/positions is in OF 1.3 format

virtual void vtkOpenFOAMReader::PositionsIsIn13FormatOn (  )  [virtual]

Set/Get whether the lagrangian/positions is in OF 1.3 format

virtual void vtkOpenFOAMReader::PositionsIsIn13FormatOff (  )  [virtual]

Set/Get whether the lagrangian/positions is in OF 1.3 format

virtual void vtkOpenFOAMReader::SetListTimeStepsByControlDict ( int   )  [virtual]

Determine if time directories are to be listed according to controlDict

virtual int vtkOpenFOAMReader::GetListTimeStepsByControlDict (  )  [virtual]

Determine if time directories are to be listed according to controlDict

virtual void vtkOpenFOAMReader::ListTimeStepsByControlDictOn (  )  [virtual]

Determine if time directories are to be listed according to controlDict

virtual void vtkOpenFOAMReader::ListTimeStepsByControlDictOff (  )  [virtual]

Determine if time directories are to be listed according to controlDict

virtual void vtkOpenFOAMReader::SetAddDimensionsToArrayNames ( int   )  [virtual]

Add dimensions to array names

virtual int vtkOpenFOAMReader::GetAddDimensionsToArrayNames (  )  [virtual]

Add dimensions to array names

virtual void vtkOpenFOAMReader::AddDimensionsToArrayNamesOn (  )  [virtual]

Add dimensions to array names

virtual void vtkOpenFOAMReader::AddDimensionsToArrayNamesOff (  )  [virtual]

Add dimensions to array names

virtual void vtkOpenFOAMReader::SetReadZones ( int   )  [virtual]

Set/Get whether zones will be read.

virtual int vtkOpenFOAMReader::GetReadZones (  )  [virtual]

Set/Get whether zones will be read.

virtual void vtkOpenFOAMReader::ReadZonesOn (  )  [virtual]

Set/Get whether zones will be read.

virtual void vtkOpenFOAMReader::ReadZonesOff (  )  [virtual]

Set/Get whether zones will be read.

void vtkOpenFOAMReader::SetRefresh (  )  [inline]

Definition at line 243 of file vtkOpenFOAMReader.h.

void vtkOpenFOAMReader::SetParent ( vtkOpenFOAMReader parent  )  [inline]

Definition at line 245 of file vtkOpenFOAMReader.h.

int vtkOpenFOAMReader::MakeInformationVector ( vtkInformationVector ,
const vtkStdString  
)

bool vtkOpenFOAMReader::SetTimeValue ( const   double  ) 

vtkDoubleArray* vtkOpenFOAMReader::GetTimeValues (  ) 

int vtkOpenFOAMReader::MakeMetaDataAtTimeStep ( const   bool  ) 

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

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

Reimplemented from vtkMultiBlockDataSetAlgorithm.

Reimplemented in vtkPOpenFOAMReader.

int vtkOpenFOAMReader::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [protected, virtual]

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

Reimplemented from vtkMultiBlockDataSetAlgorithm.

Reimplemented in vtkPOpenFOAMReader.

void vtkOpenFOAMReader::CreateCasePath ( vtkStdString ,
vtkStdString  
) [protected]

void vtkOpenFOAMReader::SetTimeInformation ( vtkInformationVector ,
vtkDoubleArray  
) [protected]

void vtkOpenFOAMReader::CreateCharArrayFromString ( vtkCharArray ,
const char *  ,
vtkStdString  
) [protected]

void vtkOpenFOAMReader::UpdateStatus (  )  [protected]

void vtkOpenFOAMReader::UpdateProgress ( double  amount  )  [protected]

Update the progress of the process object. If a ProgressMethod exists, executes it. Then set the Progress ivar to amount. The parameter amount should range between (0,1).

Reimplemented from vtkAlgorithm.


Friends And Related Function Documentation

friend class vtkOpenFOAMReaderPrivate [friend]

Definition at line 254 of file vtkOpenFOAMReader.h.


Member Data Documentation

bool vtkOpenFOAMReader::Refresh [protected]

Definition at line 259 of file vtkOpenFOAMReader.h.

Definition at line 262 of file vtkOpenFOAMReader.h.

Definition at line 265 of file vtkOpenFOAMReader.h.

Definition at line 268 of file vtkOpenFOAMReader.h.

Definition at line 271 of file vtkOpenFOAMReader.h.

Definition at line 274 of file vtkOpenFOAMReader.h.

Definition at line 277 of file vtkOpenFOAMReader.h.

Definition at line 280 of file vtkOpenFOAMReader.h.

char* vtkOpenFOAMReader::FileName [protected]

Definition at line 282 of file vtkOpenFOAMReader.h.

Definition at line 283 of file vtkOpenFOAMReader.h.

Definition at line 284 of file vtkOpenFOAMReader.h.

Definition at line 287 of file vtkOpenFOAMReader.h.

Definition at line 288 of file vtkOpenFOAMReader.h.

Definition at line 289 of file vtkOpenFOAMReader.h.

Definition at line 290 of file vtkOpenFOAMReader.h.

unsigned long int vtkOpenFOAMReader::PatchSelectionMTimeOld [protected]

Definition at line 293 of file vtkOpenFOAMReader.h.

unsigned long int vtkOpenFOAMReader::CellSelectionMTimeOld [protected]

Definition at line 294 of file vtkOpenFOAMReader.h.

unsigned long int vtkOpenFOAMReader::PointSelectionMTimeOld [protected]

Definition at line 295 of file vtkOpenFOAMReader.h.

unsigned long int vtkOpenFOAMReader::LagrangianSelectionMTimeOld [protected]

Definition at line 296 of file vtkOpenFOAMReader.h.

Definition at line 299 of file vtkOpenFOAMReader.h.

Definition at line 300 of file vtkOpenFOAMReader.h.

Definition at line 301 of file vtkOpenFOAMReader.h.

Definition at line 302 of file vtkOpenFOAMReader.h.

Definition at line 303 of file vtkOpenFOAMReader.h.

Definition at line 304 of file vtkOpenFOAMReader.h.

Definition at line 305 of file vtkOpenFOAMReader.h.

Definition at line 308 of file vtkOpenFOAMReader.h.

Definition at line 311 of file vtkOpenFOAMReader.h.

Definition at line 313 of file vtkOpenFOAMReader.h.


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

Generated on Mon Sep 27 18:36:47 2010 for VTK by  doxygen 1.5.6