reads a dataset in OpenFOAM format More...

#include <vtkOpenFOAMReader.h>

Inheritance diagram for vtkOpenFOAMReader:

Collaboration diagram for vtkOpenFOAMReader:

Public Types
typedef vtkMultiBlockDataSetAlgorithm	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkOpenFOAMReader *	NewInstance () const
void	PrintSelf (ostream &, vtkIndent)
int	CanReadFile (const char *)
void	SetRefresh ()
void	SetParent (vtkOpenFOAMReader *parent)
int	MakeInformationVector (vtkInformationVector *, const vtkStdString &)
bool	SetTimeValue (const double)
vtkDoubleArray *	GetTimeValues ()
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 vtkOpenFOAMReader *	New ()
static int	IsTypeOf (const char *type)
static vtkOpenFOAMReader *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	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
vtkCharArray *	CasePath
vtkCollection *	Readers
vtkDataArraySelection *	PatchDataArraySelection
vtkDataArraySelection *	CellDataArraySelection
vtkDataArraySelection *	PointDataArraySelection
vtkDataArraySelection *	LagrangianDataArraySelection
unsigned long int	PatchSelectionMTimeOld
unsigned long int	CellSelectionMTimeOld
unsigned long int	PointSelectionMTimeOld
unsigned long int	LagrangianSelectionMTimeOld
vtkStdString *	FileNameOld
int	ListTimeStepsByControlDictOld
int	CreateCellToPointOld
int	DecomposePolyhedraOld
int	PositionsIsIn13FormatOld
int	AddDimensionsToArrayNamesOld
int	ReadZonesOld
vtkStringArray *	LagrangianPaths
int	NumberOfReaders
int	CurrentReaderIndex
Friends
class	vtkOpenFOAMReaderPrivate

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.nosp@m..jor.nosp@m.dan@s.nosp@m.a.ne.nosp@m.tl.do.nosp@m.e.go.nosp@m.v). 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 (sarit.nosp@m.h@ro.nosp@m.cketm.nosp@m.ail..nosp@m.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 (oshim.nosp@m.a@en.nosp@m.g.nii.nosp@m.gata.nosp@m.-u.ac.nosp@m..jp).

Tests:: vtkOpenFOAMReader (Tests)

Definition at line 58 of file vtkOpenFOAMReader.h.

Member Typedef Documentation

typedef vtkMultiBlockDataSetAlgorithm vtkOpenFOAMReader::Superclass

Reimplemented from vtkMultiBlockDataSetAlgorithm.

Reimplemented in vtkPOpenFOAMReader.

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

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 ( vtkObjectBase * o ) [static]

Reimplemented from vtkMultiBlockDataSetAlgorithm.

Reimplemented in vtkPOpenFOAMReader.

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

Reimplemented from vtkMultiBlockDataSetAlgorithm.

Reimplemented in vtkPOpenFOAMReader.

vtkOpenFOAMReader* vtkOpenFOAMReader::NewInstance ( ) const

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 76 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 82 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 84 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 90 of file vtkOpenFOAMReader.h.

void vtkOpenFOAMReader::DisableAllCellArrays ( ) [inline]

Turn on/off all cell arrays.

Definition at line 96 of file vtkOpenFOAMReader.h.

void vtkOpenFOAMReader::EnableAllCellArrays ( ) [inline]

Turn on/off all cell arrays.

Definition at line 98 of file vtkOpenFOAMReader.h.

int vtkOpenFOAMReader::GetNumberOfPointArrays ( void ) [inline]

Get the number of point arrays available in the input.

Definition at line 104 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 110 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 112 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 119 of file vtkOpenFOAMReader.h.

void vtkOpenFOAMReader::DisableAllPointArrays ( ) [inline]

Turn on/off all point arrays.

Definition at line 125 of file vtkOpenFOAMReader.h.

void vtkOpenFOAMReader::EnableAllPointArrays ( ) [inline]

Turn on/off all point arrays.

Definition at line 127 of file vtkOpenFOAMReader.h.

int vtkOpenFOAMReader::GetNumberOfLagrangianArrays ( void ) [inline]

Get the number of Lagrangian arrays available in the input.

Definition at line 133 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 141 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 144 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 152 of file vtkOpenFOAMReader.h.

void vtkOpenFOAMReader::DisableAllLagrangianArrays ( ) [inline]

Turn on/off all Lagrangian arrays.

Definition at line 159 of file vtkOpenFOAMReader.h.

void vtkOpenFOAMReader::EnableAllLagrangianArrays ( ) [inline]

Turn on/off all Lagrangian arrays.

Definition at line 161 of file vtkOpenFOAMReader.h.

int vtkOpenFOAMReader::GetNumberOfPatchArrays ( void ) [inline]

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

Definition at line 168 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 174 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 176 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 183 of file vtkOpenFOAMReader.h.

void vtkOpenFOAMReader::DisableAllPatchArrays ( ) [inline]

Turn on/off all Patches including the Internal Mesh.

Definition at line 189 of file vtkOpenFOAMReader.h.

void vtkOpenFOAMReader::EnableAllPatchArrays ( ) [inline]

Turn on/off all Patches including the Internal Mesh.

Definition at line 191 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 247 of file vtkOpenFOAMReader.h.

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

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