vtkMFIXReader Class Reference

reads a dataset in MFIX file format More...

#include <vtkMFIXReader.h>

Inheritance diagram for vtkMFIXReader:

Collaboration diagram for vtkMFIXReader:

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.
vtkMFIXReader *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
int	GetNumberOfCellArrays (void)
	Get the number of cell arrays available in the input.
const char *	GetCellArrayName (int index)
	Get the name of the cell array with the given index in the input.
void	GetCellDataRange (int cellComp, float *min, float *max)
	Get the range of cell data.
	vtkSetFilePathMacro (FileName)
	Specify the file name of the MFIX Restart data file to read.
	vtkGetFilePathMacro (FileName)
	Specify the file name of the MFIX Restart data file to read.
virtual int	GetNumberOfCells ()
	Get the total number of cells.
virtual int	GetNumberOfPoints ()
	Get the total number of nodes.
virtual int	GetNumberOfCellFields ()
	Get the number of data components at the nodes and cells.
virtual void	SetTimeStep (int)
	Which TimeStep to read.
virtual int	GetTimeStep ()
	Which TimeStep to read.
virtual int	GetNumberOfTimeSteps ()
	Returns the number of timesteps.
virtual int *	GetTimeStepRange ()
	Which TimeStepRange to read.
virtual void	GetTimeStepRange (int &, int &)
	Which TimeStepRange to read.
virtual void	GetTimeStepRange (int[2])
	Which TimeStepRange to read.
virtual void	SetTimeStepRange (int, int)
	Which TimeStepRange to read.
void	SetTimeStepRange (int[2])
	Which TimeStepRange to read.
int	GetCellArrayStatus (const char *name)
	Get/Set whether the cell array with the given name is to be read.
void	SetCellArrayStatus (const char *name, int status)
	Get/Set whether the cell array with the given name is to be read.
void	DisableAllCellArrays ()
	Turn on/off all cell arrays.
void	EnableAllCellArrays ()
	Turn on/off all cell arrays.
Public Member Functions inherited from vtkUnstructuredGridAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkUnstructuredGridAlgorithm *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkTypeBool	ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	see vtkAlgorithm for details
vtkDataObject *	GetInput (int port)
vtkDataObject *	GetInput ()
vtkUnstructuredGrid *	GetUnstructuredGridInput (int port)
vtkUnstructuredGrid *	GetOutput ()
	Get the output data object for a port on this algorithm.
vtkUnstructuredGrid *	GetOutput (int)
	Get the output data object for a port on this algorithm.
virtual void	SetOutput (vtkDataObject *d)
	Get the output data object for a port on this algorithm.
void	SetInputData (vtkDataObject *)
	Assign a data object as input.
void	SetInputData (int, vtkDataObject *)
	Assign a data object as input.
void	AddInputData (vtkDataObject *)
	Assign a data object as input.
void	AddInputData (int, vtkDataObject *)
	Assign a data object as input.
Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkAlgorithm *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
int	HasExecutive ()
	Check whether this algorithm has an assigned executive.
vtkExecutive *	GetExecutive ()
	Get this algorithm's executive.
virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive.
virtual vtkTypeBool	ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.
vtkTypeBool	ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped.
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.
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.
vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port.
vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port.
int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm.
int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm.
void	SetProgress (double)
	SetProgress is deprecated.
void	UpdateProgress (double amount)
	Update the progress of the process object.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
	String based versions of SetInputArrayToProcess().
vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.
void	RemoveAllInputs ()
	Remove all the input data.
vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.
vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection.
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index.
virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx.
virtual void	RemoveAllInputConnections (int port)
	Removes all input connections.
virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index.
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port.
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm.
vtkAlgorithmOutput *	GetOutputPort ()
int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port.
int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm.
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.
vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair.
vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0).
vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection.
vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0)
vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection.
vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0)
vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port.
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).
virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port.
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.
virtual int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.
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.
virtual void	UpdateInformation ()
	Bring the algorithm's information up-to-date.
virtual void	UpdateDataObject ()
	Create output object(s).
virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.
virtual void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date.
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm.
virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm.
void	Register (vtkObjectBase *o) override
	Participate in garbage collection.
void	UnRegister (vtkObjectBase *o) override
	Participate in garbage collection.
virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object.
virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object.
virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object.
virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object.
virtual double	GetProgress ()
	Get the execution progress of a process object.
void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double	GetProgressShift ()
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double	GetProgressScale ()
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state.
virtual char *	GetProgressText ()
	Set the current text message associated with the progress state.
virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index.
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index.
virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index.
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index.
virtual void	Update (int port)
	Bring this algorithm's outputs up-to-date.
virtual void	Update ()
	Bring this algorithm's outputs up-to-date.
virtual void	SetReleaseDataFlag (int)
	Turn release data flag on or off for all output ports.
virtual int	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports.
void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports.
void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports.
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.
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.
int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents.
int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents.
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.
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.
void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents.
int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents.
void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
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.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
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.
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.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkMFIXReader *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkMFIXReader *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkUnstructuredGridAlgorithm
static vtkUnstructuredGridAlgorithm *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkUnstructuredGridAlgorithm *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements.
static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()
static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()
static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()
static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKey *	INPUT_PORT ()
static vtkInformationIntegerKey *	INPUT_CONNECTION ()
static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.
static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkMFIXReader ()
	~vtkMFIXReader () override
int	RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	This is called by the superclass.
Protected Member Functions inherited from vtkUnstructuredGridAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkUnstructuredGridAlgorithm ()
	~vtkUnstructuredGridAlgorithm () override
virtual int	RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
	This is called by the superclass.
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
	This is called by the superclass.
int	FillOutputPortInformation (int port, vtkInformation *info) override
	Fill the output port information objects for this algorithm.
int	FillInputPortInformation (int port, vtkInformation *info) override
	Fill the input port information objects for this algorithm.
Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkAlgorithm ()
	~vtkAlgorithm () override
virtual int	FillInputPortInformation (int port, vtkInformation *info)
	Fill the input port information objects for this algorithm.
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
	Fill the output port information objects for this algorithm.
virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm.
virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm.
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.
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.
virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive.
void	ReportReferences (vtkGarbageCollector *) override
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port.
virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port.
void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input.
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.
int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (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.
vtkDataArray *	GetInputArrayToProcess (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.
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (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.
vtkAbstractArray *	GetInputAbstractArrayToProcess (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.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.
virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file.
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.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
char *	FileName
int	RequestInformationFlag
int	MakeMeshFlag
int	NumberOfPoints
int	NumberOfCells
int	NumberOfCellFields
vtkIntArray *	VectorLength
vtkFloatArray *	Minimum
vtkFloatArray *	Maximum
vtkDataArraySelection *	CellDataArraySelection
int	TimeStep
int	ActualTimeStep
int	CurrentTimeStep
int	NumberOfTimeSteps
int *	TimeSteps
int	TimeStepRange [2]
int	TimeStepWasReadOnce
vtkFloatArray **	CellDataArray
vtkPoints *	Points
vtkUnstructuredGrid *	Mesh
vtkHexahedron *	AHexahedron
vtkWedge *	AWedge
vtkQuad *	AQuad
vtkIntArray *	Flag
vtkDoubleArray *	Dx
vtkDoubleArray *	Dy
vtkDoubleArray *	Dz
vtkIntArray *	NMax
vtkDoubleArray *	C
vtkIntArray *	TempI
vtkDoubleArray *	TempD
vtkIntArray *	SpxFileExists
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]
vtkStringArray *	VariableNames
vtkIntArray *	VariableComponents
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
vtkIntArray *	SPXToNVarTable
vtkIntArray *	VariableToSkipTable
vtkIntArray *	VariableTimesteps
vtkIntArray *	VariableTimestepTable
vtkIntArray *	variableIndexToSPX
vtkIntArray *	VariableIndexToSPX
vtkIntArray *	SPXTimestepIndexTable
Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information
double	Progress
char *	ProgressText
vtkProgressObserver *	ProgressObserver
unsigned long	ErrorCode
	The error code contains a possible error that occurred while reading or writing the file.
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
vtkTypeBool	AbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

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

Definition at line 53 of file vtkMFIXReader.h.

Member Typedef Documentation

Superclass

typedef vtkUnstructuredGridAlgorithm vtkMFIXReader::Superclass

Definition at line 57 of file vtkMFIXReader.h.

Constructor & Destructor Documentation

vtkMFIXReader()

vtkMFIXReader::vtkMFIXReader ( )

protected

~vtkMFIXReader()

vtkMFIXReader::~vtkMFIXReader ( )

overrideprotected

Member Function Documentation

New()

static vtkMFIXReader * vtkMFIXReader::New ( )

static

IsTypeOf()

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

static

IsA()

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.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkMFIXReader::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkUnstructuredGridAlgorithm.

NewInstance()

vtkMFIXReader * vtkMFIXReader::NewInstance

(

)

const

PrintSelf()

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.

vtkSetFilePathMacro()

vtkMFIXReader::vtkSetFilePathMacro

(

FileName

)

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

vtkGetFilePathMacro()

vtkMFIXReader::vtkGetFilePathMacro

(

FileName

)

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

GetNumberOfCells()

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.

GetNumberOfPoints()

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.

GetNumberOfCellFields()

virtual int vtkMFIXReader::GetNumberOfCellFields ( )

virtual

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

SetTimeStep()

virtual void vtkMFIXReader::SetTimeStep ( int  )

virtual

Which TimeStep to read.

GetTimeStep()

virtual int vtkMFIXReader::GetTimeStep ( )

virtual

Which TimeStep to read.

GetNumberOfTimeSteps()

virtual int vtkMFIXReader::GetNumberOfTimeSteps ( )

virtual

Returns the number of timesteps.

GetTimeStepRange() [1/3]

virtual int * vtkMFIXReader::GetTimeStepRange ( )

virtual

Which TimeStepRange to read.

GetTimeStepRange() [2/3]

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

virtual

Which TimeStepRange to read.

GetTimeStepRange() [3/3]

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

virtual

Which TimeStepRange to read.

SetTimeStepRange() [1/2]

virtual void vtkMFIXReader::SetTimeStepRange ( int  , int    )

virtual

Which TimeStepRange to read.

SetTimeStepRange() [2/2]

void vtkMFIXReader::SetTimeStepRange

(

int

[2]

)

Which TimeStepRange to read.

GetNumberOfCellArrays()

int vtkMFIXReader::GetNumberOfCellArrays

(

void

)

Get the number of cell arrays available in the input.

GetCellArrayName()

const char * vtkMFIXReader::GetCellArrayName

(

int

index

)

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

GetCellArrayStatus()

int vtkMFIXReader::GetCellArrayStatus

(

const char *

name

)

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

SetCellArrayStatus()

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

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

DisableAllCellArrays()

void vtkMFIXReader::DisableAllCellArrays

(

)

Turn on/off all cell arrays.

EnableAllCellArrays()

void vtkMFIXReader::EnableAllCellArrays

(

)

Turn on/off all cell arrays.

GetCellDataRange()

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

Get the range of cell data.

RequestInformation()

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

overrideprotectedvirtual

Reimplemented from vtkUnstructuredGridAlgorithm.

RequestData()

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

FileName

char* vtkMFIXReader::FileName

protected

Definition at line 157 of file vtkMFIXReader.h.

RequestInformationFlag

int vtkMFIXReader::RequestInformationFlag

protected

Definition at line 158 of file vtkMFIXReader.h.

MakeMeshFlag

int vtkMFIXReader::MakeMeshFlag

protected

Definition at line 159 of file vtkMFIXReader.h.

NumberOfPoints

int vtkMFIXReader::NumberOfPoints

protected

Definition at line 160 of file vtkMFIXReader.h.

NumberOfCells

int vtkMFIXReader::NumberOfCells

protected

Definition at line 161 of file vtkMFIXReader.h.

NumberOfCellFields

int vtkMFIXReader::NumberOfCellFields

protected

Definition at line 162 of file vtkMFIXReader.h.

VectorLength

vtkIntArray* vtkMFIXReader::VectorLength

protected

Definition at line 163 of file vtkMFIXReader.h.

Minimum

vtkFloatArray* vtkMFIXReader::Minimum

protected

Definition at line 164 of file vtkMFIXReader.h.

Maximum

vtkFloatArray* vtkMFIXReader::Maximum

protected

Definition at line 165 of file vtkMFIXReader.h.

CellDataArraySelection

vtkDataArraySelection* vtkMFIXReader::CellDataArraySelection

protected

Definition at line 166 of file vtkMFIXReader.h.

TimeStep

int vtkMFIXReader::TimeStep

protected

Definition at line 167 of file vtkMFIXReader.h.

ActualTimeStep

int vtkMFIXReader::ActualTimeStep

protected

Definition at line 168 of file vtkMFIXReader.h.

CurrentTimeStep

int vtkMFIXReader::CurrentTimeStep

protected

Definition at line 169 of file vtkMFIXReader.h.

NumberOfTimeSteps

int vtkMFIXReader::NumberOfTimeSteps

protected

Definition at line 170 of file vtkMFIXReader.h.

TimeSteps

int* vtkMFIXReader::TimeSteps

protected

Definition at line 171 of file vtkMFIXReader.h.

TimeStepRange

int vtkMFIXReader::TimeStepRange[2]

protected

Definition at line 172 of file vtkMFIXReader.h.

TimeStepWasReadOnce

int vtkMFIXReader::TimeStepWasReadOnce

protected

Definition at line 173 of file vtkMFIXReader.h.

CellDataArray

vtkFloatArray** vtkMFIXReader::CellDataArray

protected

Definition at line 179 of file vtkMFIXReader.h.

Points

vtkPoints* vtkMFIXReader::Points

protected

Definition at line 181 of file vtkMFIXReader.h.

Mesh

vtkUnstructuredGrid* vtkMFIXReader::Mesh

protected

Definition at line 182 of file vtkMFIXReader.h.

AHexahedron

vtkHexahedron* vtkMFIXReader::AHexahedron

protected

Definition at line 183 of file vtkMFIXReader.h.

AWedge

vtkWedge* vtkMFIXReader::AWedge

protected

Definition at line 184 of file vtkMFIXReader.h.

AQuad

vtkQuad* vtkMFIXReader::AQuad

protected

Definition at line 185 of file vtkMFIXReader.h.

Flag

vtkIntArray* vtkMFIXReader::Flag

protected

Definition at line 186 of file vtkMFIXReader.h.

Dx

vtkDoubleArray* vtkMFIXReader::Dx

protected

Definition at line 187 of file vtkMFIXReader.h.

Dy

vtkDoubleArray* vtkMFIXReader::Dy

protected

Definition at line 188 of file vtkMFIXReader.h.

Dz

vtkDoubleArray* vtkMFIXReader::Dz

protected

Definition at line 189 of file vtkMFIXReader.h.

NMax

vtkIntArray* vtkMFIXReader::NMax

protected

Definition at line 190 of file vtkMFIXReader.h.

C

vtkDoubleArray* vtkMFIXReader::C

protected

Definition at line 191 of file vtkMFIXReader.h.

TempI

vtkIntArray* vtkMFIXReader::TempI

protected

Definition at line 192 of file vtkMFIXReader.h.

TempD

vtkDoubleArray* vtkMFIXReader::TempD

protected

Definition at line 193 of file vtkMFIXReader.h.

SpxFileExists

vtkIntArray* vtkMFIXReader::SpxFileExists

protected

Definition at line 194 of file vtkMFIXReader.h.

FileExtension

char vtkMFIXReader::FileExtension[15]

protected

Definition at line 197 of file vtkMFIXReader.h.

DataBuffer

char vtkMFIXReader::DataBuffer[513]

protected

Definition at line 198 of file vtkMFIXReader.h.

Version

char vtkMFIXReader::Version[120]

protected

Definition at line 199 of file vtkMFIXReader.h.

VersionNumber

float vtkMFIXReader::VersionNumber

protected

Definition at line 200 of file vtkMFIXReader.h.

DimensionIc

int vtkMFIXReader::DimensionIc

protected

Definition at line 201 of file vtkMFIXReader.h.

DimensionBc

int vtkMFIXReader::DimensionBc

protected

Definition at line 202 of file vtkMFIXReader.h.

DimensionC

int vtkMFIXReader::DimensionC

protected

Definition at line 203 of file vtkMFIXReader.h.

DimensionIs

int vtkMFIXReader::DimensionIs

protected

Definition at line 204 of file vtkMFIXReader.h.

Ce

double vtkMFIXReader::Ce

protected

Definition at line 205 of file vtkMFIXReader.h.

Cf

double vtkMFIXReader::Cf

protected

Definition at line 206 of file vtkMFIXReader.h.

Phi

double vtkMFIXReader::Phi

protected

Definition at line 207 of file vtkMFIXReader.h.

PhiW

double vtkMFIXReader::PhiW

protected

Definition at line 208 of file vtkMFIXReader.h.

DeltaTime

double vtkMFIXReader::DeltaTime

protected

Definition at line 209 of file vtkMFIXReader.h.

XMinimum

double vtkMFIXReader::XMinimum

protected

Definition at line 210 of file vtkMFIXReader.h.

RunName

char vtkMFIXReader::RunName[256]

protected

Definition at line 211 of file vtkMFIXReader.h.

VariableNames

vtkStringArray* vtkMFIXReader::VariableNames

protected

Definition at line 212 of file vtkMFIXReader.h.

VariableComponents

vtkIntArray* vtkMFIXReader::VariableComponents

protected

Definition at line 213 of file vtkMFIXReader.h.

IMinimum1

int vtkMFIXReader::IMinimum1

protected

Definition at line 214 of file vtkMFIXReader.h.

JMinimum1

int vtkMFIXReader::JMinimum1

protected

Definition at line 215 of file vtkMFIXReader.h.

KMinimum1

int vtkMFIXReader::KMinimum1

protected

Definition at line 216 of file vtkMFIXReader.h.

IMaximum

int vtkMFIXReader::IMaximum

protected

Definition at line 217 of file vtkMFIXReader.h.

JMaximum

int vtkMFIXReader::JMaximum

protected

Definition at line 218 of file vtkMFIXReader.h.

KMaximum

int vtkMFIXReader::KMaximum

protected

Definition at line 219 of file vtkMFIXReader.h.

IMaximum1

int vtkMFIXReader::IMaximum1

protected

Definition at line 220 of file vtkMFIXReader.h.

JMaximum1

int vtkMFIXReader::JMaximum1

protected

Definition at line 221 of file vtkMFIXReader.h.

KMaximum1

int vtkMFIXReader::KMaximum1

protected

Definition at line 222 of file vtkMFIXReader.h.

IMaximum2

int vtkMFIXReader::IMaximum2

protected

Definition at line 223 of file vtkMFIXReader.h.

JMaximum2

int vtkMFIXReader::JMaximum2

protected

Definition at line 224 of file vtkMFIXReader.h.

KMaximum2

int vtkMFIXReader::KMaximum2

protected

Definition at line 225 of file vtkMFIXReader.h.

IJMaximum2

int vtkMFIXReader::IJMaximum2

protected

Definition at line 226 of file vtkMFIXReader.h.

IJKMaximum2

int vtkMFIXReader::IJKMaximum2

protected

Definition at line 227 of file vtkMFIXReader.h.

MMAX

int vtkMFIXReader::MMAX

protected

Definition at line 228 of file vtkMFIXReader.h.

NumberOfSPXFilesUsed

int vtkMFIXReader::NumberOfSPXFilesUsed

protected

Definition at line 229 of file vtkMFIXReader.h.

XLength

double vtkMFIXReader::XLength

protected

Definition at line 230 of file vtkMFIXReader.h.

YLength

double vtkMFIXReader::YLength

protected

Definition at line 231 of file vtkMFIXReader.h.

ZLength

double vtkMFIXReader::ZLength

protected

Definition at line 232 of file vtkMFIXReader.h.

NumberOfScalars

int vtkMFIXReader::NumberOfScalars

protected

Definition at line 233 of file vtkMFIXReader.h.

NumberOfReactionRates

int vtkMFIXReader::NumberOfReactionRates

protected

Definition at line 234 of file vtkMFIXReader.h.

BkEpsilon

bool vtkMFIXReader::BkEpsilon

protected

Definition at line 235 of file vtkMFIXReader.h.

CoordinateSystem

char vtkMFIXReader::CoordinateSystem[17]

protected

Definition at line 236 of file vtkMFIXReader.h.

Units

char vtkMFIXReader::Units[17]

protected

Definition at line 237 of file vtkMFIXReader.h.

MaximumTimestep

int vtkMFIXReader::MaximumTimestep

protected

Definition at line 243 of file vtkMFIXReader.h.

SPXRecordsPerTimestep

int vtkMFIXReader::SPXRecordsPerTimestep

protected

Definition at line 244 of file vtkMFIXReader.h.

SPXToNVarTable

vtkIntArray* vtkMFIXReader::SPXToNVarTable

protected

Definition at line 246 of file vtkMFIXReader.h.

VariableToSkipTable

vtkIntArray* vtkMFIXReader::VariableToSkipTable

protected

Definition at line 247 of file vtkMFIXReader.h.

VariableTimesteps

vtkIntArray* vtkMFIXReader::VariableTimesteps

protected

Definition at line 250 of file vtkMFIXReader.h.

VariableTimestepTable

vtkIntArray* vtkMFIXReader::VariableTimestepTable

protected

Definition at line 251 of file vtkMFIXReader.h.

variableIndexToSPX

vtkIntArray* vtkMFIXReader::variableIndexToSPX

protected

Definition at line 256 of file vtkMFIXReader.h.

VariableIndexToSPX

vtkIntArray* vtkMFIXReader::VariableIndexToSPX

protected

Definition at line 258 of file vtkMFIXReader.h.

SPXTimestepIndexTable

vtkIntArray* vtkMFIXReader::SPXTimestepIndexTable

protected

Definition at line 260 of file vtkMFIXReader.h.

---

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

• IO/Geometry/vtkMFIXReader.h