VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
vtkPOpenFOAMReader Class Reference

reads a decomposed dataset in OpenFOAM format More...

#include <vtkPOpenFOAMReader.h>

Inheritance diagram for vtkPOpenFOAMReader:
[legend]
Collaboration diagram for vtkPOpenFOAMReader:
[legend]

List of all members.

Public Types

enum  caseType { DECOMPOSED_CASE = 0, RECONSTRUCTED_CASE = 1 }
typedef vtkOpenFOAMReader Superclass
- Public Types inherited from vtkOpenFOAMReader
- Public Types inherited from vtkMultiBlockDataSetAlgorithm
- Public Types inherited from vtkAlgorithm
- Public Types inherited from vtkObject

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void SetCaseType (const int t)
virtual caseType GetCaseType ()
virtual void SetController (vtkMultiProcessController *)
virtual vtkMultiProcessControllerGetController ()
- Public Member Functions inherited from vtkOpenFOAMReader
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 ()
- Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm
vtkMultiBlockDataSetGetOutput ()
vtkMultiBlockDataSetGetOutput (int)
void SetInput (vtkDataObject *)
void SetInput (int, vtkDataObject *)
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
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)
vtkDataObjectGetInputDataObject (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)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char 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)
vtkCommandGetCommand (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)
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 &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkPOpenFOAMReaderNew ()
static int IsTypeOf (const char *type)
static vtkPOpenFOAMReaderSafeDownCast (vtkObject *o)

Protected Member Functions

 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 vtkExecutiveCreateDefaultExecutive ()
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual int FillInputPortInformation (int port, vtkInformation *info)
vtkDataObjectGetInput (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)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *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 &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Additional Inherited Members

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

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

Definition at line 37 of file vtkPOpenFOAMReader.h.


Member Typedef Documentation

Reimplemented from vtkOpenFOAMReader.

Definition at line 44 of file vtkPOpenFOAMReader.h.


Member Enumeration Documentation

Enumerator:
DECOMPOSED_CASE 
RECONSTRUCTED_CASE 

Definition at line 41 of file vtkPOpenFOAMReader.h.


Constructor & Destructor Documentation

vtkPOpenFOAMReader::vtkPOpenFOAMReader ( )
protected
vtkPOpenFOAMReader::~vtkPOpenFOAMReader ( )
protected

Member Function Documentation

static vtkPOpenFOAMReader* vtkPOpenFOAMReader::New ( )
static

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

Reimplemented from vtkOpenFOAMReader.

virtual const char* vtkPOpenFOAMReader::GetClassName ( )
virtual

Reimplemented from vtkOpenFOAMReader.

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

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 ( vtkObject o)
static

Reimplemented from vtkOpenFOAMReader.

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 case type. 0 = decomposed case, 1 = reconstructed case.

virtual vtkMultiProcessController* vtkPOpenFOAMReader::GetController ( )
virtual

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

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: