vtkOpenFOAMReader Class Reference

#include <vtkOpenFOAMReader.h>

Inheritance diagram for vtkOpenFOAMReader:

[legend]

Collaboration diagram for vtkOpenFOAMReader:

[legend]

List of all members.

---

Detailed Description

reads a dataset in OpenFOAM format

vtkOpenFOAMReader creates an multiblock dataset. It reads a controlDict file, mesh information, and time dependent data. The controlDict file contains timestep information. 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)

Definition at line 53 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 &os, vtkIndent indent)
int	GetNumberOfCellArrays (void)
const char *	GetCellArrayName (int index)
virtual void	SetFileName (const char *)
virtual char *	GetFileName ()
virtual int	GetNumberOfTimeSteps ()
virtual void	SetTimeStep (int)
virtual int	GetTimeStep ()
virtual int *	GetTimeStepRange ()
virtual void	GetTimeStepRange (int &, int &)
virtual void	GetTimeStepRange (int[2])
int	GetCellArrayStatus (const char *name)
void	SetCellArrayStatus (const char *name, int status)
void	DisableAllCellArrays ()
void	EnableAllCellArrays ()
Static Public Member Functions
static vtkOpenFOAMReader *	New ()
static int	IsTypeOf (const char *type)
static vtkOpenFOAMReader *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkOpenFOAMReader ()
	~vtkOpenFOAMReader ()
int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
int	RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

---

Member Typedef Documentation

typedef vtkMultiBlockDataSetAlgorithm vtkOpenFOAMReader::Superclass

Reimplemented from vtkMultiBlockDataSetAlgorithm.

Definition at line 57 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.

virtual const char* vtkOpenFOAMReader::GetClassName

(

)

[virtual]

Reimplemented from vtkMultiBlockDataSetAlgorithm.

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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkMultiBlockDataSetAlgorithm.

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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkMultiBlockDataSetAlgorithm.

static vtkOpenFOAMReader* vtkOpenFOAMReader::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkMultiBlockDataSetAlgorithm.

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.

virtual void vtkOpenFOAMReader::SetFileName

(

const char *

)

[virtual]

Set/Get the filename.

virtual char* vtkOpenFOAMReader::GetFileName

(

)

[virtual]

Set/Get the filename.

virtual int vtkOpenFOAMReader::GetNumberOfTimeSteps

(

)

[virtual]

Returns the number of timesteps.

virtual void vtkOpenFOAMReader::SetTimeStep

(

int

)

[virtual]

Set/Get the current timestep.

virtual int vtkOpenFOAMReader::GetTimeStep

(

)

[virtual]

Set/Get the current timestep.

virtual int* vtkOpenFOAMReader::GetTimeStepRange

(

)

[virtual]

Get the timesteprange. Filled during RequestInformation.

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

Get the timesteprange. Filled during RequestInformation.

virtual void vtkOpenFOAMReader::GetTimeStepRange

(

int

[2]

)

[virtual]

Get the timesteprange. Filled during RequestInformation.

int vtkOpenFOAMReader::GetNumberOfCellArrays

(

void

)

Get the number of cell arrays available in the input.

int vtkOpenFOAMReader::GetCellArrayStatus

(

const char *

name

)

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

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

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

const char* vtkOpenFOAMReader::GetCellArrayName

(

int

index

)

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

void vtkOpenFOAMReader::DisableAllCellArrays

(

)

Turn on/off all cell arrays.

void vtkOpenFOAMReader::EnableAllCellArrays

(

)

Turn on/off all cell arrays.

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

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

Reimplemented from vtkMultiBlockDataSetAlgorithm.

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

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

Reimplemented from vtkMultiBlockDataSetAlgorithm.

---

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

• dox/IO/vtkOpenFOAMReader.h