reads a decomposed dataset in OpenFOAM format More...

#include <vtkPOpenFOAMReader.h>

Inheritance diagram for vtkPOpenFOAMReader:

Collaboration diagram for vtkPOpenFOAMReader:

Public Types
enum	caseType { DECOMPOSED_CASE = 0, RECONSTRUCTED_CASE = 1 }

typedef vtkOpenFOAMReader	Superclass

Public Types inherited from vtkOpenFOAMReader
typedef vtkMultiBlockDataSetAlgorithm	Superclass

Public Types inherited from vtkMultiBlockDataSetAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
typedef vtkObject	Superclass

enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkPOpenFOAMReader *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)


void	SetCaseType (const int t)

virtual caseType	GetCaseType ()


virtual void	SetController (vtkMultiProcessController *)

virtual vtkMultiProcessController *	GetController ()

Public Member Functions inherited from vtkOpenFOAMReader
vtkOpenFOAMReader *	NewInstance () const

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 ()

Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm
vtkMultiBlockDataSetAlgorithm *	NewInstance () const

vtkMultiBlockDataSet *	GetOutput ()

vtkMultiBlockDataSet *	GetOutput (int)

void	SetInputData (vtkDataObject *)

void	SetInputData (int, vtkDataObject *)

virtual int	ProcessRequest (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const

int	HasExecutive ()

vtkExecutive *	GetExecutive ()

virtual void	SetExecutive (vtkExecutive *executive)

virtual int	ModifyRequest (vtkInformation *request, int when)

vtkInformation *	GetInputPortInformation (int port)

vtkInformation *	GetOutputPortInformation (int port)

int	GetNumberOfInputPorts ()

int	GetNumberOfOutputPorts ()

void	UpdateProgress (double amount)

vtkInformation *	GetInputArrayInformation (int idx)

void	RemoveAllInputs ()

vtkDataObject *	GetOutputDataObject (int port)

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	RemoveInputConnection (int port, int idx)

virtual void	RemoveAllInputConnections (int port)

int	GetNumberOfInputConnections (int port)

int	GetTotalNumberOfInputConnections ()

vtkAlgorithmOutput *	GetInputConnection (int port, int index)

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)

vtkAlgorithm *	GetInputAlgorithm (int port, int index)

vtkExecutive *	GetInputExecutive (int port, int index)

vtkInformation *	GetInputInformation (int port, int index)

vtkInformation *	GetOutputInformation (int port)

virtual void	UpdateInformation ()

virtual void	UpdateDataObject ()

virtual void	PropagateUpdateExtent ()

virtual void	UpdateWholeExtent ()

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)

int	SetUpdateExtentToWholeExtent (int port)

int	SetUpdateExtentToWholeExtent ()

void	SetUpdateExtent (int port, int extent[6])

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, unsigned long *mtime)

virtual vtkInformation *	GetInformation ()

virtual void	SetInformation (vtkInformation *)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

virtual void	SetAbortExecute (int)

virtual int	GetAbortExecute ()

virtual void	AbortExecuteOn ()

virtual void	AbortExecuteOff ()

virtual void	SetProgress (double)

virtual double	GetProgress ()

void	SetProgressText (const char *ptext)

virtual char *	GetProgressText ()

virtual unsigned long	GetErrorCode ()

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)

vtkDataObject *	GetInputDataObject (int port, int connection)

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	SetInputConnection (vtkAlgorithmOutput *input)

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	AddInputConnection (vtkAlgorithmOutput *input)

virtual void	SetInputDataObject (int port, vtkDataObject *data)

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)

vtkAlgorithmOutput *	GetOutputPort ()

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive ()

vtkInformation *	GetInputInformation ()

virtual void	Update (int port)

virtual void	Update ()

virtual void	SetReleaseDataFlag (int)

virtual int	GetReleaseDataFlag ()

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)

void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int extent[6])

int *	GetUpdateExtent ()

int *	GetUpdateExtent (int port)

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int extent[6])

void	GetUpdateExtent (int port, int extent[6])

int	GetUpdatePiece ()

int	GetUpdatePiece (int port)

int	GetUpdateNumberOfPieces ()

int	GetUpdateNumberOfPieces (int port)

int	GetUpdateGhostLevel ()

int	GetUpdateGhostLevel (int port)

void	SetProgressObserver (vtkProgressObserver *)

virtual vtkProgressObserver *	GetProgressObserver ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkPOpenFOAMReader *	New ()

static int	IsTypeOf (const char *type)

static vtkPOpenFOAMReader *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkOpenFOAMReader
static vtkOpenFOAMReader *	New ()

static int	IsTypeOf (const char *type)

static vtkOpenFOAMReader *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm
static vtkMultiBlockDataSetAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkMultiBlockDataSetAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkPOpenFOAMReader ()

	~vtkPOpenFOAMReader ()

int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )

int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )

Protected Member Functions inherited from vtkOpenFOAMReader
	vtkOpenFOAMReader ()

	~vtkOpenFOAMReader ()

void	CreateCasePath (vtkStdString &, vtkStdString &)

void	SetTimeInformation (vtkInformationVector , vtkDoubleArray )

void	CreateCharArrayFromString (vtkCharArray , const char , vtkStdString &)

void	UpdateStatus ()

void	UpdateProgress (double)

Protected Member Functions inherited from vtkMultiBlockDataSetAlgorithm
	vtkMultiBlockDataSetAlgorithm ()

	~vtkMultiBlockDataSetAlgorithm ()

virtual vtkExecutive *	CreateDefaultExecutive ()

virtual int	FillOutputPortInformation (int port, vtkInformation *info)

virtual int	FillInputPortInformation (int port, vtkInformation *info)

vtkDataObject *	GetInput (int port)

virtual int	RequestDataObject (vtkInformation , vtkInformationVector , vtkInformationVector )

virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )

Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()

	~vtkAlgorithm ()

virtual void	SetNumberOfInputPorts (int n)

virtual void	SetNumberOfOutputPorts (int n)

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	SetNumberOfInputConnections (int port, int n)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)

int	GetInputArrayAssociation (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)

void	SetInputDataInternal (int port, vtkDataObject *input)

void	AddInputDataInternal (int port, vtkDataObject *input)

virtual void	SetErrorCode (unsigned long)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Protected Attributes inherited from vtkOpenFOAMReader
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

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

reads a decomposed dataset in OpenFOAM format

vtkPOpenFOAMReader creates a multiblock dataset. It reads parallel-decomposed 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:: This class was developed by Takuya Oshima at Niigata University, Japan (oshim.nosp@m.a@en.nosp@m.g.nii.nosp@m.gata.nosp@m.-u.ac.nosp@m..jp).

Tests:: vtkPOpenFOAMReader (Tests)

Definition at line 41 of file vtkPOpenFOAMReader.h.

Member Typedef Documentation

typedef vtkOpenFOAMReader vtkPOpenFOAMReader::Superclass

Definition at line 48 of file vtkPOpenFOAMReader.h.

Member Enumeration Documentation

enum vtkPOpenFOAMReader::caseType

Enumerator
DECOMPOSED_CASE
RECONSTRUCTED_CASE

Definition at line 45 of file vtkPOpenFOAMReader.h.

Constructor & Destructor Documentation

vtkPOpenFOAMReader::vtkPOpenFOAMReader ( )

protected

vtkPOpenFOAMReader::~vtkPOpenFOAMReader ( )

protected

Member Function Documentation

static vtkPOpenFOAMReader* vtkPOpenFOAMReader::New ( )

static

static int vtkPOpenFOAMReader::IsTypeOf ( const char * type )

static

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

static vtkPOpenFOAMReader* vtkPOpenFOAMReader::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkPOpenFOAMReader::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkOpenFOAMReader.

vtkPOpenFOAMReader* vtkPOpenFOAMReader::NewInstance ( ) const

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

void vtkPOpenFOAMReader::SetCaseType ( const int t )

Set and get case type. 0 = decomposed case, 1 = reconstructed case.

virtual caseType vtkPOpenFOAMReader::GetCaseType ( )

virtual

Set and get case type. 0 = decomposed case, 1 = reconstructed case.

virtual void vtkPOpenFOAMReader::SetController ( vtkMultiProcessController * )

virtual

Set and get the controller.

virtual vtkMultiProcessController* vtkPOpenFOAMReader::GetController ( )

virtual

Set and get the controller.

int vtkPOpenFOAMReader::RequestInformation	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)

protectedvirtual

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

Reimplemented from vtkOpenFOAMReader.

int vtkPOpenFOAMReader::RequestData	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)

protectedvirtual

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

Reimplemented from vtkOpenFOAMReader.

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

dox/IO/Parallel/vtkPOpenFOAMReader.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation