VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkPOpenFOAMReader Class Reference

reads a decomposed dataset in OpenFOAM format More...

#include <vtkPOpenFOAMReader.h>

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

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
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkPOpenFOAMReaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetCaseType (const int t)
 Set and get case type. More...
 
virtual caseType GetCaseType ()
 
virtual void SetController (vtkMultiProcessController *)
 Set and get the controller. More...
 
virtual vtkMultiProcessControllerGetController ()
 
- Public Member Functions inherited from vtkOpenFOAMReader
vtkOpenFOAMReaderNewInstance () const
 
int CanReadFile (const char *)
 Determine if the file can be read with this reader. More...
 
virtual void SetFileName (const char *)
 Set/Get the filename. More...
 
virtual char * GetFileName ()
 
int GetNumberOfCellArrays (void)
 Get the number of cell arrays available in the input. More...
 
int GetCellArrayStatus (const char *name)
 Get/Set whether the cell array with the given name is to be read. More...
 
void SetCellArrayStatus (const char *name, int status)
 
const char * GetCellArrayName (int index)
 Get the name of the cell array with the given index in the input. More...
 
void DisableAllCellArrays ()
 Turn on/off all cell arrays. More...
 
void EnableAllCellArrays ()
 
int GetNumberOfPointArrays (void)
 Get the number of point arrays available in the input. More...
 
int GetPointArrayStatus (const char *name)
 Get/Set whether the point array with the given name is to be read. More...
 
void SetPointArrayStatus (const char *name, int status)
 
const char * GetPointArrayName (int index)
 Get the name of the point array with the given index in the input. More...
 
void DisableAllPointArrays ()
 Turn on/off all point arrays. More...
 
void EnableAllPointArrays ()
 
int GetNumberOfLagrangianArrays (void)
 Get the number of Lagrangian arrays available in the input. More...
 
int GetLagrangianArrayStatus (const char *name)
 Get/Set whether the Lagrangian array with the given name is to be read. More...
 
void SetLagrangianArrayStatus (const char *name, int status)
 
const char * GetLagrangianArrayName (int index)
 Get the name of the Lagrangian array with the given index in the input. More...
 
void DisableAllLagrangianArrays ()
 Turn on/off all Lagrangian arrays. More...
 
void EnableAllLagrangianArrays ()
 
int GetNumberOfPatchArrays (void)
 Get the number of Patches (including Internal Mesh) available in the input. More...
 
int GetPatchArrayStatus (const char *name)
 Get/Set whether the Patch with the given name is to be read. More...
 
void SetPatchArrayStatus (const char *name, int status)
 
const char * GetPatchArrayName (int index)
 Get the name of the Patch with the given index in the input. More...
 
void DisableAllPatchArrays ()
 Turn on/off all Patches including the Internal Mesh. More...
 
void EnableAllPatchArrays ()
 
virtual void SetCreateCellToPoint (vtkTypeBool)
 Set/Get whether to create cell-to-point translated data for cell-type data. More...
 
virtual vtkTypeBool GetCreateCellToPoint ()
 
virtual void CreateCellToPointOn ()
 
virtual void CreateCellToPointOff ()
 
virtual void SetCacheMesh (vtkTypeBool)
 Set/Get whether mesh is to be cached. More...
 
virtual vtkTypeBool GetCacheMesh ()
 
virtual void CacheMeshOn ()
 
virtual void CacheMeshOff ()
 
virtual void SetDecomposePolyhedra (vtkTypeBool)
 Set/Get whether polyhedra are to be decomposed. More...
 
virtual vtkTypeBool GetDecomposePolyhedra ()
 
virtual void DecomposePolyhedraOn ()
 
virtual void DecomposePolyhedraOff ()
 
virtual void SetPositionsIsIn13Format (vtkTypeBool)
 Set/Get whether the lagrangian/positions have additional data or not. More...
 
virtual vtkTypeBool GetPositionsIsIn13Format ()
 
virtual void PositionsIsIn13FormatOn ()
 
virtual void PositionsIsIn13FormatOff ()
 
virtual void SetSkipZeroTime (bool)
 Ignore 0/ time directory, which is normally missing Lagrangian fields and may have many dictionary functionality that we cannot easily handle. More...
 
virtual bool GetSkipZeroTime ()
 
virtual void SkipZeroTimeOn ()
 
virtual void SkipZeroTimeOff ()
 
virtual void SetListTimeStepsByControlDict (vtkTypeBool)
 Determine if time directories are to be listed according to controlDict. More...
 
virtual vtkTypeBool GetListTimeStepsByControlDict ()
 
virtual void ListTimeStepsByControlDictOn ()
 
virtual void ListTimeStepsByControlDictOff ()
 
virtual void SetAddDimensionsToArrayNames (vtkTypeBool)
 Add dimensions to array names. More...
 
virtual vtkTypeBool GetAddDimensionsToArrayNames ()
 
virtual void AddDimensionsToArrayNamesOn ()
 
virtual void AddDimensionsToArrayNamesOff ()
 
virtual void SetReadZones (vtkTypeBool)
 Set/Get whether zones will be read. More...
 
virtual vtkTypeBool GetReadZones ()
 
virtual void ReadZonesOn ()
 
virtual void ReadZonesOff ()
 
virtual void SetUse64BitLabels (bool val)
 If true, labels are expected to be 64-bit, rather than 32. More...
 
virtual bool GetUse64BitLabels ()
 
virtual void Use64BitLabelsOn ()
 
virtual void Use64BitLabelsOff ()
 
virtual bool GetCopyDataToCellZones ()
 If true, data of the internal mesh are copied to the cell zones. More...
 
virtual void SetCopyDataToCellZones (bool)
 
virtual void CopyDataToCellZonesOn ()
 
virtual void CopyDataToCellZonesOff ()
 
virtual void SetUse64BitFloats (bool val)
 If true, floats are expected to be 64-bit, rather than 32. More...
 
virtual bool GetUse64BitFloats ()
 
virtual void Use64BitFloatsOn ()
 
virtual void Use64BitFloatsOff ()
 
void SetRefresh ()
 
void SetParent (vtkOpenFOAMReader *parent)
 
int MakeInformationVector (vtkInformationVector *, const vtkStdString &)
 
bool SetTimeValue (const double)
 
vtkDoubleArrayGetTimeValues ()
 
int MakeMetaDataAtTimeStep (const bool)
 
- Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm
vtkMultiBlockDataSetAlgorithmNewInstance () const
 
vtkMultiBlockDataSetGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkMultiBlockDataSetGetOutput (int)
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 see vtkAlgorithm for details More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
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)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (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 ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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 *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
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)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkPOpenFOAMReaderNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPOpenFOAMReaderSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkOpenFOAMReader
static vtkOpenFOAMReaderNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOpenFOAMReaderSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm
static vtkMultiBlockDataSetAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkMultiBlockDataSetAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPOpenFOAMReader ()
 
 ~vtkPOpenFOAMReader () override
 
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
- Protected Member Functions inherited from vtkOpenFOAMReader
 vtkOpenFOAMReader ()
 
 ~vtkOpenFOAMReader () override
 
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 () override
 
virtual int RequestDataObject (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
vtkExecutiveCreateDefaultExecutive () override
 Create a default executive. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
vtkDataObjectGetInput (int port)
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
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)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
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)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
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
vtkTypeBool AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Protected Attributes inherited from vtkOpenFOAMReader
bool Refresh
 
vtkTypeBool CreateCellToPoint
 
vtkTypeBool CacheMesh
 
vtkTypeBool DecomposePolyhedra
 
vtkTypeBool PositionsIsIn13Format
 
vtkTypeBool ReadZones
 
bool SkipZeroTime
 
vtkTypeBool ListTimeStepsByControlDict
 
vtkTypeBool AddDimensionsToArrayNames
 
bool Use64BitLabels
 
bool Use64BitFloats
 
bool CopyDataToCellZones
 
char * FileName
 
vtkCharArrayCasePath
 
vtkCollectionReaders
 
vtkDataArraySelectionPatchDataArraySelection
 
vtkDataArraySelectionCellDataArraySelection
 
vtkDataArraySelectionPointDataArraySelection
 
vtkDataArraySelectionLagrangianDataArraySelection
 
vtkMTimeType PatchSelectionMTimeOld
 
vtkMTimeType CellSelectionMTimeOld
 
vtkMTimeType PointSelectionMTimeOld
 
vtkMTimeType LagrangianSelectionMTimeOld
 
vtkStdStringFileNameOld
 
bool SkipZeroTimeOld
 
int ListTimeStepsByControlDictOld
 
int CreateCellToPointOld
 
int DecomposePolyhedraOld
 
int PositionsIsIn13FormatOld
 
int AddDimensionsToArrayNamesOld
 
int ReadZonesOld
 
bool Use64BitLabelsOld
 
bool Use64BitFloatsOld
 
vtkStringArrayLagrangianPaths
 
int NumberOfReaders
 
int CurrentReaderIndex
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

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 42 of file vtkPOpenFOAMReader.h.

Member Typedef Documentation

◆ Superclass

Definition at line 49 of file vtkPOpenFOAMReader.h.

Member Enumeration Documentation

◆ caseType

Enumerator
DECOMPOSED_CASE 
RECONSTRUCTED_CASE 

Definition at line 46 of file vtkPOpenFOAMReader.h.

Constructor & Destructor Documentation

◆ vtkPOpenFOAMReader()

vtkPOpenFOAMReader::vtkPOpenFOAMReader ( )
protected

◆ ~vtkPOpenFOAMReader()

vtkPOpenFOAMReader::~vtkPOpenFOAMReader ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkPOpenFOAMReader* vtkPOpenFOAMReader::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkPOpenFOAMReader::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkOpenFOAMReader.

◆ NewInstance()

vtkPOpenFOAMReader* vtkPOpenFOAMReader::NewInstance ( ) const

◆ PrintSelf()

void vtkPOpenFOAMReader::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

◆ SetCaseType()

void vtkPOpenFOAMReader::SetCaseType ( const int  t)

Set and get case type.

0 = decomposed case, 1 = reconstructed case.

◆ GetCaseType()

virtual caseType vtkPOpenFOAMReader::GetCaseType ( )
virtual

◆ SetController()

virtual void vtkPOpenFOAMReader::SetController ( vtkMultiProcessController )
virtual

Set and get the controller.

◆ GetController()

virtual vtkMultiProcessController* vtkPOpenFOAMReader::GetController ( )
virtual

◆ RequestInformation()

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

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkOpenFOAMReader.

◆ RequestData()

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

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: