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

reads a dataset in MFIX file format More...

#include <vtkMFIXReader.h>

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

Public Types

typedef vtkUnstructuredGridAlgorithm Superclass
 
- Public Types inherited from vtkUnstructuredGridAlgorithm
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...
 
vtkMFIXReaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int GetNumberOfCellArrays (void)
 Get the number of cell arrays available in the input. More...
 
const char * GetCellArrayName (int index)
 Get the name of the cell array with the given index in the input. More...
 
void GetCellDataRange (int cellComp, float *min, float *max)
 Get the range of cell data. More...
 
virtual void SetFileName (const char *)
 Specify the file name of the MFIX Restart data file to read. More...
 
virtual char * GetFileName ()
 Specify the file name of the MFIX Restart data file to read. More...
 
virtual int GetNumberOfCells ()
 Get the total number of cells. More...
 
virtual int GetNumberOfPoints ()
 Get the total number of nodes. More...
 
virtual int GetNumberOfCellFields ()
 Get the number of data components at the nodes and cells. More...
 
virtual void SetTimeStep (int)
 Which TimeStep to read. More...
 
virtual int GetTimeStep ()
 Which TimeStep to read. More...
 
virtual int GetNumberOfTimeSteps ()
 Returns the number of timesteps. More...
 
virtual intGetTimeStepRange ()
 Which TimeStepRange to read. More...
 
virtual void GetTimeStepRange (int &, int &)
 Which TimeStepRange to read. More...
 
virtual void GetTimeStepRange (int[2])
 Which TimeStepRange to read. More...
 
virtual void SetTimeStepRange (int, int)
 Which TimeStepRange to read. More...
 
void SetTimeStepRange (int[2])
 Which TimeStepRange to read. 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)
 Get/Set whether the cell array with the given name is to be read. More...
 
void DisableAllCellArrays ()
 Turn on/off all cell arrays. More...
 
void EnableAllCellArrays ()
 Turn on/off all cell arrays. More...
 
- Public Member Functions inherited from vtkUnstructuredGridAlgorithm
vtkUnstructuredGridAlgorithmNewInstance () const
 
int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details More...
 
vtkDataObjectGetInput (int port)
 
vtkDataObjectGetInput ()
 
vtkUnstructuredGridGetUnstructuredGridInput (int port)
 
vtkUnstructuredGridGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkUnstructuredGridGetOutput (int)
 Get the output data object for a port on this algorithm. More...
 
virtual void SetOutput (vtkDataObject *d)
 Get the output data object for a port on this algorithm. More...
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (int, vtkDataObject *)
 Assign a data object as input. 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...
 
int 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...
 
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 UpdateProgress (double amount)
 Update the progress of the process object. More...
 
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 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 int 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 int 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 vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void SetProgress (double)
 Set/Get the execution progress of a process object. More...
 
virtual double GetProgress ()
 Set/Get the execution progress of a process object. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state. More...
 
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)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports. More...
 
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)
 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...
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
- 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...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- 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...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkMFIXReaderNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkMFIXReaderSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkUnstructuredGridAlgorithm
static vtkUnstructuredGridAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkUnstructuredGridAlgorithmSafeDownCast (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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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
 
 vtkMFIXReader ()
 
 ~vtkMFIXReader () override
 
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
- Protected Member Functions inherited from vtkUnstructuredGridAlgorithm
 vtkUnstructuredGridAlgorithm ()
 
 ~vtkUnstructuredGridAlgorithm () override
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. 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...
 
- 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...
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. 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)
 
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)
 Filters that have multiple connections on one port can use this signature. More...
 
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)
 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, 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)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
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)
 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, 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)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

char * FileName
 
int RequestInformationFlag
 
int MakeMeshFlag
 
int NumberOfPoints
 
int NumberOfCells
 
int NumberOfCellFields
 
vtkIntArrayVectorLength
 
vtkFloatArrayMinimum
 
vtkFloatArrayMaximum
 
vtkDataArraySelectionCellDataArraySelection
 
int TimeStep
 
int ActualTimeStep
 
int CurrentTimeStep
 
int NumberOfTimeSteps
 
intTimeSteps
 
int TimeStepRange [2]
 
int TimeStepWasReadOnce
 
vtkFloatArray ** CellDataArray
 
vtkPointsPoints
 
vtkUnstructuredGridMesh
 
vtkHexahedronAHexahedron
 
vtkWedgeAWedge
 
vtkQuadAQuad
 
vtkIntArrayFlag
 
vtkDoubleArrayDx
 
vtkDoubleArrayDy
 
vtkDoubleArrayDz
 
vtkIntArrayNMax
 
vtkDoubleArrayC
 
vtkIntArrayTempI
 
vtkDoubleArrayTempD
 
vtkIntArraySpxFileExists
 
char FileExtension [15]
 
char DataBuffer [513]
 
char Version [120]
 
float VersionNumber
 
int DimensionIc
 
int DimensionBc
 
int DimensionC
 
int DimensionIs
 
double Ce
 
double Cf
 
double Phi
 
double PhiW
 
double DeltaTime
 
double XMinimum
 
char RunName [256]
 
vtkStringArrayVariableNames
 
vtkIntArrayVariableComponents
 
int IMinimum1
 
int JMinimum1
 
int KMinimum1
 
int IMaximum
 
int JMaximum
 
int KMaximum
 
int IMaximum1
 
int JMaximum1
 
int KMaximum1
 
int IMaximum2
 
int JMaximum2
 
int KMaximum2
 
int IJMaximum2
 
int IJKMaximum2
 
int MMAX
 
int NumberOfSPXFilesUsed
 
double XLength
 
double YLength
 
double ZLength
 
int NumberOfScalars
 
int NumberOfReactionRates
 
bool BkEpsilon
 
char CoordinateSystem [17]
 
char Units [17]
 
int MaximumTimestep
 
int SPXRecordsPerTimestep
 
vtkIntArraySPXToNVarTable
 
vtkIntArrayVariableToSkipTable
 
vtkIntArrayVariableTimesteps
 
vtkIntArrayVariableTimestepTable
 
vtkIntArrayvariableIndexToSPX
 
vtkIntArrayVariableIndexToSPX
 
vtkIntArraySPXTimestepIndexTable
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

reads a dataset in MFIX file format

vtkMFIXReader creates an unstructured grid dataset. It reads a restart file and a set of sp files. The restart file contains the mesh information. MFIX meshes are either cylindrical or rectilinear, but this reader will convert them to an unstructured grid. The sp files contain transient data for the cells. Each sp file has one or more variables stored inside it.

Thanks:
Thanks to Phil Nicoletti and Brian Dotson at the National Energy Technology Laboratory who developed this class. Please address all comments to Brian Dotson (brian.nosp@m..dot.nosp@m.son@n.nosp@m.etl..nosp@m.doe.g.nosp@m.ov)
See also
vtkGAMBITReader
Tests:
vtkMFIXReader (Tests)

Definition at line 56 of file vtkMFIXReader.h.

Member Typedef Documentation

Definition at line 60 of file vtkMFIXReader.h.

Constructor & Destructor Documentation

vtkMFIXReader::vtkMFIXReader ( )
protected
vtkMFIXReader::~vtkMFIXReader ( )
overrideprotected

Member Function Documentation

static vtkMFIXReader* vtkMFIXReader::New ( )
static
static vtkTypeBool vtkMFIXReader::IsTypeOf ( const char *  type)
static
virtual vtkTypeBool vtkMFIXReader::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 vtkUnstructuredGridAlgorithm.

static vtkMFIXReader* vtkMFIXReader::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkMFIXReader::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkUnstructuredGridAlgorithm.

vtkMFIXReader* vtkMFIXReader::NewInstance ( ) const
void vtkMFIXReader::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 vtkUnstructuredGridAlgorithm.

virtual void vtkMFIXReader::SetFileName ( const char *  )
virtual

Specify the file name of the MFIX Restart data file to read.

virtual char* vtkMFIXReader::GetFileName ( )
virtual

Specify the file name of the MFIX Restart data file to read.

virtual int vtkMFIXReader::GetNumberOfCells ( )
virtual

Get the total number of cells.

The number of cells is only valid after a successful read of the data file is performed.

virtual int vtkMFIXReader::GetNumberOfPoints ( )
virtual

Get the total number of nodes.

The number of nodes is only valid after a successful read of the data file is performed.

virtual int vtkMFIXReader::GetNumberOfCellFields ( )
virtual

Get the number of data components at the nodes and cells.

virtual void vtkMFIXReader::SetTimeStep ( int  )
virtual

Which TimeStep to read.

virtual int vtkMFIXReader::GetTimeStep ( )
virtual

Which TimeStep to read.

virtual int vtkMFIXReader::GetNumberOfTimeSteps ( )
virtual

Returns the number of timesteps.

virtual int* vtkMFIXReader::GetTimeStepRange ( )
virtual

Which TimeStepRange to read.

virtual void vtkMFIXReader::GetTimeStepRange ( int ,
int  
)
virtual

Which TimeStepRange to read.

virtual void vtkMFIXReader::GetTimeStepRange ( int  [2])
virtual

Which TimeStepRange to read.

virtual void vtkMFIXReader::SetTimeStepRange ( int  ,
int   
)
virtual

Which TimeStepRange to read.

void vtkMFIXReader::SetTimeStepRange ( int  [2])

Which TimeStepRange to read.

int vtkMFIXReader::GetNumberOfCellArrays ( void  )

Get the number of cell arrays available in the input.

const char* vtkMFIXReader::GetCellArrayName ( int  index)

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

int vtkMFIXReader::GetCellArrayStatus ( const char *  name)

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

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

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

void vtkMFIXReader::DisableAllCellArrays ( )

Turn on/off all cell arrays.

void vtkMFIXReader::EnableAllCellArrays ( )

Turn on/off all cell arrays.

void vtkMFIXReader::GetCellDataRange ( int  cellComp,
float min,
float max 
)

Get the range of cell data.

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

Reimplemented from vtkUnstructuredGridAlgorithm.

int vtkMFIXReader::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkUnstructuredGridAlgorithm.

Member Data Documentation

char* vtkMFIXReader::FileName
protected

Definition at line 162 of file vtkMFIXReader.h.

int vtkMFIXReader::RequestInformationFlag
protected

Definition at line 163 of file vtkMFIXReader.h.

int vtkMFIXReader::MakeMeshFlag
protected

Definition at line 164 of file vtkMFIXReader.h.

int vtkMFIXReader::NumberOfPoints
protected

Definition at line 165 of file vtkMFIXReader.h.

int vtkMFIXReader::NumberOfCells
protected

Definition at line 166 of file vtkMFIXReader.h.

int vtkMFIXReader::NumberOfCellFields
protected

Definition at line 167 of file vtkMFIXReader.h.

vtkIntArray* vtkMFIXReader::VectorLength
protected

Definition at line 168 of file vtkMFIXReader.h.

vtkFloatArray* vtkMFIXReader::Minimum
protected

Definition at line 169 of file vtkMFIXReader.h.

vtkFloatArray* vtkMFIXReader::Maximum
protected

Definition at line 170 of file vtkMFIXReader.h.

vtkDataArraySelection* vtkMFIXReader::CellDataArraySelection
protected

Definition at line 171 of file vtkMFIXReader.h.

int vtkMFIXReader::TimeStep
protected

Definition at line 172 of file vtkMFIXReader.h.

int vtkMFIXReader::ActualTimeStep
protected

Definition at line 173 of file vtkMFIXReader.h.

int vtkMFIXReader::CurrentTimeStep
protected

Definition at line 174 of file vtkMFIXReader.h.

int vtkMFIXReader::NumberOfTimeSteps
protected

Definition at line 175 of file vtkMFIXReader.h.

int* vtkMFIXReader::TimeSteps
protected

Definition at line 176 of file vtkMFIXReader.h.

int vtkMFIXReader::TimeStepRange[2]
protected

Definition at line 177 of file vtkMFIXReader.h.

int vtkMFIXReader::TimeStepWasReadOnce
protected

Definition at line 178 of file vtkMFIXReader.h.

vtkFloatArray** vtkMFIXReader::CellDataArray
protected

Definition at line 184 of file vtkMFIXReader.h.

vtkPoints* vtkMFIXReader::Points
protected

Definition at line 186 of file vtkMFIXReader.h.

vtkUnstructuredGrid* vtkMFIXReader::Mesh
protected

Definition at line 187 of file vtkMFIXReader.h.

vtkHexahedron* vtkMFIXReader::AHexahedron
protected

Definition at line 188 of file vtkMFIXReader.h.

vtkWedge* vtkMFIXReader::AWedge
protected

Definition at line 189 of file vtkMFIXReader.h.

vtkQuad* vtkMFIXReader::AQuad
protected

Definition at line 190 of file vtkMFIXReader.h.

vtkIntArray* vtkMFIXReader::Flag
protected

Definition at line 191 of file vtkMFIXReader.h.

vtkDoubleArray* vtkMFIXReader::Dx
protected

Definition at line 192 of file vtkMFIXReader.h.

vtkDoubleArray* vtkMFIXReader::Dy
protected

Definition at line 193 of file vtkMFIXReader.h.

vtkDoubleArray* vtkMFIXReader::Dz
protected

Definition at line 194 of file vtkMFIXReader.h.

vtkIntArray* vtkMFIXReader::NMax
protected

Definition at line 195 of file vtkMFIXReader.h.

vtkDoubleArray* vtkMFIXReader::C
protected

Definition at line 196 of file vtkMFIXReader.h.

vtkIntArray* vtkMFIXReader::TempI
protected

Definition at line 197 of file vtkMFIXReader.h.

vtkDoubleArray* vtkMFIXReader::TempD
protected

Definition at line 198 of file vtkMFIXReader.h.

vtkIntArray* vtkMFIXReader::SpxFileExists
protected

Definition at line 199 of file vtkMFIXReader.h.

char vtkMFIXReader::FileExtension[15]
protected

Definition at line 202 of file vtkMFIXReader.h.

char vtkMFIXReader::DataBuffer[513]
protected

Definition at line 203 of file vtkMFIXReader.h.

char vtkMFIXReader::Version[120]
protected

Definition at line 204 of file vtkMFIXReader.h.

float vtkMFIXReader::VersionNumber
protected

Definition at line 205 of file vtkMFIXReader.h.

int vtkMFIXReader::DimensionIc
protected

Definition at line 206 of file vtkMFIXReader.h.

int vtkMFIXReader::DimensionBc
protected

Definition at line 207 of file vtkMFIXReader.h.

int vtkMFIXReader::DimensionC
protected

Definition at line 208 of file vtkMFIXReader.h.

int vtkMFIXReader::DimensionIs
protected

Definition at line 209 of file vtkMFIXReader.h.

double vtkMFIXReader::Ce
protected

Definition at line 210 of file vtkMFIXReader.h.

double vtkMFIXReader::Cf
protected

Definition at line 211 of file vtkMFIXReader.h.

double vtkMFIXReader::Phi
protected

Definition at line 212 of file vtkMFIXReader.h.

double vtkMFIXReader::PhiW
protected

Definition at line 213 of file vtkMFIXReader.h.

double vtkMFIXReader::DeltaTime
protected

Definition at line 214 of file vtkMFIXReader.h.

double vtkMFIXReader::XMinimum
protected

Definition at line 215 of file vtkMFIXReader.h.

char vtkMFIXReader::RunName[256]
protected

Definition at line 216 of file vtkMFIXReader.h.

vtkStringArray* vtkMFIXReader::VariableNames
protected

Definition at line 217 of file vtkMFIXReader.h.

vtkIntArray* vtkMFIXReader::VariableComponents
protected

Definition at line 218 of file vtkMFIXReader.h.

int vtkMFIXReader::IMinimum1
protected

Definition at line 219 of file vtkMFIXReader.h.

int vtkMFIXReader::JMinimum1
protected

Definition at line 220 of file vtkMFIXReader.h.

int vtkMFIXReader::KMinimum1
protected

Definition at line 221 of file vtkMFIXReader.h.

int vtkMFIXReader::IMaximum
protected

Definition at line 222 of file vtkMFIXReader.h.

int vtkMFIXReader::JMaximum
protected

Definition at line 223 of file vtkMFIXReader.h.

int vtkMFIXReader::KMaximum
protected

Definition at line 224 of file vtkMFIXReader.h.

int vtkMFIXReader::IMaximum1
protected

Definition at line 225 of file vtkMFIXReader.h.

int vtkMFIXReader::JMaximum1
protected

Definition at line 226 of file vtkMFIXReader.h.

int vtkMFIXReader::KMaximum1
protected

Definition at line 227 of file vtkMFIXReader.h.

int vtkMFIXReader::IMaximum2
protected

Definition at line 228 of file vtkMFIXReader.h.

int vtkMFIXReader::JMaximum2
protected

Definition at line 229 of file vtkMFIXReader.h.

int vtkMFIXReader::KMaximum2
protected

Definition at line 230 of file vtkMFIXReader.h.

int vtkMFIXReader::IJMaximum2
protected

Definition at line 231 of file vtkMFIXReader.h.

int vtkMFIXReader::IJKMaximum2
protected

Definition at line 232 of file vtkMFIXReader.h.

int vtkMFIXReader::MMAX
protected

Definition at line 233 of file vtkMFIXReader.h.

int vtkMFIXReader::NumberOfSPXFilesUsed
protected

Definition at line 234 of file vtkMFIXReader.h.

double vtkMFIXReader::XLength
protected

Definition at line 235 of file vtkMFIXReader.h.

double vtkMFIXReader::YLength
protected

Definition at line 236 of file vtkMFIXReader.h.

double vtkMFIXReader::ZLength
protected

Definition at line 237 of file vtkMFIXReader.h.

int vtkMFIXReader::NumberOfScalars
protected

Definition at line 238 of file vtkMFIXReader.h.

int vtkMFIXReader::NumberOfReactionRates
protected

Definition at line 239 of file vtkMFIXReader.h.

bool vtkMFIXReader::BkEpsilon
protected

Definition at line 240 of file vtkMFIXReader.h.

char vtkMFIXReader::CoordinateSystem[17]
protected

Definition at line 241 of file vtkMFIXReader.h.

char vtkMFIXReader::Units[17]
protected

Definition at line 242 of file vtkMFIXReader.h.

int vtkMFIXReader::MaximumTimestep
protected

Definition at line 248 of file vtkMFIXReader.h.

int vtkMFIXReader::SPXRecordsPerTimestep
protected

Definition at line 249 of file vtkMFIXReader.h.

vtkIntArray* vtkMFIXReader::SPXToNVarTable
protected

Definition at line 251 of file vtkMFIXReader.h.

vtkIntArray* vtkMFIXReader::VariableToSkipTable
protected

Definition at line 252 of file vtkMFIXReader.h.

vtkIntArray* vtkMFIXReader::VariableTimesteps
protected

Definition at line 255 of file vtkMFIXReader.h.

vtkIntArray* vtkMFIXReader::VariableTimestepTable
protected

Definition at line 256 of file vtkMFIXReader.h.

vtkIntArray* vtkMFIXReader::variableIndexToSPX
protected

Definition at line 261 of file vtkMFIXReader.h.

vtkIntArray* vtkMFIXReader::VariableIndexToSPX
protected

Definition at line 263 of file vtkMFIXReader.h.

vtkIntArray* vtkMFIXReader::SPXTimestepIndexTable
protected

Definition at line 265 of file vtkMFIXReader.h.


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