vtkFLUENTCFFReader Class Reference

reads a dataset in Fluent CFF file format More...

#include <vtkFLUENTCFFReader.h>

Inheritance diagram for vtkFLUENTCFFReader:

Collaboration diagram for vtkFLUENTCFFReader:

Classes
struct	Cell
struct	Face
struct	ScalarDataChunk
struct	VectorDataChunk

Public Types
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.
vtkFLUENTCFFReader *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual void	SetFileName (std::string)
	Specify the file name of the Fluent case file to read.
virtual std::string	GetFileName ()
virtual vtkIdType	GetNumberOfCells ()
	Get the total number of cells.
int	GetNumberOfCellArrays ()
	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.
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)
void	DisableAllCellArrays ()
	Turn on/off all cell arrays.
void	EnableAllCellArrays ()
Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkMultiBlockDataSetAlgorithm *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkTypeBool	ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
	see vtkAlgorithm for details
vtkMultiBlockDataSet *	GetOutput ()
	Get the output data object for a port on this algorithm.
vtkMultiBlockDataSet *	GetOutput (int)
	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.
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.
vtkTypeBool	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	SetAbortExecuteAndUpdateTime ()
	Set AbortExecute Flag and update LastAbortTime.
void	UpdateProgress (double amount)
	Update the progress of the process object.
bool	CheckAbort ()
	Checks to see if this filter should abort.
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 VTK_UNBLOCKTHREADS int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.
virtual VTK_UNBLOCKTHREADS 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 VTK_UNBLOCKTHREADS 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 VTK_UNBLOCKTHREADS 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.
void	RemoveNoPriorTemporalAccessInformationKey ()
	Removes any information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() to all output ports of this vtkAlgorithm.
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.
bool	UsesGarbageCollector () const 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	SetContainerAlgorithm (vtkAlgorithm *containerAlg)
	Set/get a Container algorithm for this algorithm.
vtkAlgorithm *	GetContainerAlgorithm ()
	Set/get a Container algorithm for this algorithm.
virtual void	SetAbortOutput (bool)
	Set/Get an internal variable used to communicate between the algorithm and executive.
virtual bool	GetAbortOutput ()
	Set/Get an internal variable used to communicate between the algorithm and executive.
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.
void	SetInputArrayToProcess (const char *name, int fieldAssociation)
	Set the input data arrays that this algorithm will process.
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	SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
	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 VTK_UNBLOCKTHREADS void	Update (int port)
	Bring this algorithm's outputs up-to-date.
virtual VTK_UNBLOCKTHREADS void	Update ()
	Bring this algorithm's outputs up-to-date.
virtual void	SetReleaseDataFlag (vtkTypeBool)
	Turn release data flag on or off for all output ports.
virtual vtkTypeBool	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.
void	SetNoPriorTemporalAccessInformationKey (int key)
	Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
void	SetNoPriorTemporalAccessInformationKey ()
	Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
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)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
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.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
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.
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 vtkFLUENTCFFReader *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkFLUENTCFFReader *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm
static vtkMultiBlockDataSetAlgorithm *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkMultiBlockDataSetAlgorithm *	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 vtkInformationIntegerKey *	ABORTED ()
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 (vtkTypeBool 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 vtkTypeBool	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 Types
enum	DataState { NOT_LOADED = 0 , AVAILABLE = 1 , LOADED = 2 , ERROR = 3 }
	Enumerate. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkFLUENTCFFReader ()
	~vtkFLUENTCFFReader () override
int	RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	This is called by the superclass.
int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	This is called by the superclass.
virtual bool	OpenCaseFile (const std::string &filename)
	Open the HDF5 file structure.
virtual DataState	OpenDataFile (const std::string &filename)
virtual void	GetNumberOfCellZones ()
	Retrieve the number of cell zones.
virtual int	ParseCaseFile ()
	Reads necessary information from the .cas file.
virtual int	GetDimension ()
	Get the dimension of the file (2D/3D)
virtual void	GetNodesGlobal ()
	Get the total number of nodes/cells/faces.
virtual void	GetCellsGlobal ()
virtual void	GetFacesGlobal ()
virtual void	GetNodes ()
	Get the size and index of node per zone.
virtual void	GetCells ()
	Get the topology of cell per zone.
virtual void	GetFaces ()
	Get the topology of face per zone.
virtual void	GetPeriodicShadowFaces ()
	Get the periodic shadown faces information !!! NOT IMPLEMENTED YET !!!
virtual void	GetCellOverset ()
	Get the overset cells information !!! NOT IMPLEMENTED YET !!!
virtual void	GetCellTree ()
	Get the tree (AMR) cell topology.
virtual void	GetFaceTree ()
	Get the tree (AMR) face topology.
virtual void	GetInterfaceFaceParents ()
	Get the interface id of parent faces.
virtual void	GetNonconformalGridInterfaceFaceInformation ()
	Get the non conformal grid interface information !!! NOT IMPLEMENTED YET !!!
virtual void	CleanCells ()
	Removes unnecessary faces from the cells.
virtual void	PopulateCellNodes ()
	Reconstruct and convert the Fluent data format to the VTK format.
virtual void	PopulateCellTree ()
virtual void	PopulateTriangleCell (int i)
	Reconstruct VTK cell topology from Fluent format.
virtual void	PopulateTetraCell (int i)
virtual void	PopulateQuadCell (int i)
virtual void	PopulateHexahedronCell (int i)
virtual void	PopulatePyramidCell (int i)
virtual void	PopulateWedgeCell (int i)
virtual void	PopulatePolyhedronCell (int i)
virtual int	GetData ()
	Read and reconstruct data from .dat.h5 file.
virtual int	GetMetaData ()
	Pre-read variable name data available for selection.
Protected Member Functions inherited from vtkMultiBlockDataSetAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkMultiBlockDataSetAlgorithm ()
	~vtkMultiBlockDataSetAlgorithm () override=default
virtual int	RequestDataObject (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
	This is called by the superclass.
virtual int	RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
	This is called by the superclass.
virtual int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
	This is called by the superclass.
virtual int	RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
vtkExecutive *	CreateDefaultExecutive () override
	Create a default executive.
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.
vtkDataObject *	GetInput (int port)
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
	This is called by the superclass.
Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkAlgorithm ()
	~vtkAlgorithm () override
bool	CheckUpstreamAbort ()
	Checks to see if an upstream filter has been aborted.
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 association 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 *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkNew< vtkDataArraySelection >	CellDataArraySelection
std::string	FileName
vtkIdType	NumberOfCells = 0
int	NumberOfCellArrays = 0
std::unique_ptr< vtkInternals >	HDFImpl
vtkNew< vtkPoints >	Points
vtkNew< vtkTriangle >	Triangle
vtkNew< vtkTetra >	Tetra
vtkNew< vtkQuad >	Quad
vtkNew< vtkHexahedron >	Hexahedron
vtkNew< vtkPyramid >	Pyramid
vtkNew< vtkWedge >	Wedge
std::vector< Cell >	Cells
std::vector< Face >	Faces
std::vector< int >	CellZones
std::vector< ScalarDataChunk >	ScalarDataChunks
std::vector< VectorDataChunk >	VectorDataChunks
std::vector< std::string >	PreReadScalarData
std::vector< std::string >	PreReadVectorData
vtkTypeBool	SwapBytes = 0
int	GridDimension = 0
DataState	FileState = DataState::NOT_LOADED
int	NumberOfScalars = 0
int	NumberOfVectors = 0
Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp	LastAbortCheckTime
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
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
std::atomic< 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 vtkTimeStamp	LastAbortTime
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

reads a dataset in Fluent CFF file format

vtkFLUENTCFFReader creates an unstructured grid dataset. It reads .cas.h5 and .dat.h5 files stored in FLUENT CFF format (hdf5).

Thanks:

Original author : Arthur Piquet

This class is based on the vtkFLUENTReader class from Brian W. Dotson & Terry E. Jordan (Department of Energy, National Energy Technology Laboratory) & Douglas McCorkle (Iowa State University)

This class reads the HDF5 data in Fluent Format (face type structure) and converts it to VTK Format (cell type structure). This class could be improved for memory performance but the developer will need to rewrite entirely the structure of the class. Some piece of functionality lack in the HDF reading (overset, AMR tree, interface), no file available in order to code/test the structure.

See also

vtkFLUENTReader

Tests:

vtkFLUENTCFFReader (Tests)

Definition at line 52 of file vtkFLUENTCFFReader.h.

Member Typedef Documentation

Superclass

typedef vtkMultiBlockDataSetAlgorithm vtkFLUENTCFFReader::Superclass

Definition at line 56 of file vtkFLUENTCFFReader.h.

Member Enumeration Documentation

DataState

enum vtkFLUENTCFFReader::DataState

protected

Enumerate.

Enumerator
NOT_LOADED
AVAILABLE
LOADED
ERROR

Definition at line 156 of file vtkFLUENTCFFReader.h.

Constructor & Destructor Documentation

vtkFLUENTCFFReader()

vtkFLUENTCFFReader::vtkFLUENTCFFReader ( )

protected

~vtkFLUENTCFFReader()

vtkFLUENTCFFReader::~vtkFLUENTCFFReader ( )

overrideprotected

Member Function Documentation

New()

static vtkFLUENTCFFReader * vtkFLUENTCFFReader::New ( )

static

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool vtkFLUENTCFFReader::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 vtkMultiBlockDataSetAlgorithm.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkFLUENTCFFReader::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkMultiBlockDataSetAlgorithm.

NewInstance()

vtkFLUENTCFFReader * vtkFLUENTCFFReader::NewInstance

(

)

const

PrintSelf()

void vtkFLUENTCFFReader::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 vtkAlgorithm.

SetFileName()

virtual void vtkFLUENTCFFReader::SetFileName ( std::string  )

virtual

Specify the file name of the Fluent case file to read.

GetFileName()

virtual std::string vtkFLUENTCFFReader::GetFileName ( )

virtual

GetNumberOfCells()

virtual vtkIdType vtkFLUENTCFFReader::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. Initial value is 0.

GetNumberOfCellArrays()

int vtkFLUENTCFFReader::GetNumberOfCellArrays

(

)

Get the number of cell arrays available in the input.

GetCellArrayName()

const char * vtkFLUENTCFFReader::GetCellArrayName

(

int

index

)

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

GetCellArrayStatus()

int vtkFLUENTCFFReader::GetCellArrayStatus

(

const char *

name

)

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

SetCellArrayStatus()

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

DisableAllCellArrays()

void vtkFLUENTCFFReader::DisableAllCellArrays

(

)

Turn on/off all cell arrays.

EnableAllCellArrays()

void vtkFLUENTCFFReader::EnableAllCellArrays

(

)

RequestInformation()

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

overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkMultiBlockDataSetAlgorithm.

RequestData()

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

overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkMultiBlockDataSetAlgorithm.

OpenCaseFile()

virtual bool vtkFLUENTCFFReader::OpenCaseFile ( const std::string &  filename )

protectedvirtual

Open the HDF5 file structure.

OpenDataFile()

virtual DataState vtkFLUENTCFFReader::OpenDataFile ( const std::string &  filename )

protectedvirtual

GetNumberOfCellZones()

virtual void vtkFLUENTCFFReader::GetNumberOfCellZones ( )

protectedvirtual

Retrieve the number of cell zones.

ParseCaseFile()

virtual int vtkFLUENTCFFReader::ParseCaseFile ( )

protectedvirtual

Reads necessary information from the .cas file.

GetDimension()

virtual int vtkFLUENTCFFReader::GetDimension ( )

protectedvirtual

Get the dimension of the file (2D/3D)

GetNodesGlobal()

virtual void vtkFLUENTCFFReader::GetNodesGlobal ( )

protectedvirtual

Get the total number of nodes/cells/faces.

GetCellsGlobal()

virtual void vtkFLUENTCFFReader::GetCellsGlobal ( )

protectedvirtual

GetFacesGlobal()

virtual void vtkFLUENTCFFReader::GetFacesGlobal ( )

protectedvirtual

GetNodes()

virtual void vtkFLUENTCFFReader::GetNodes ( )

protectedvirtual

Get the size and index of node per zone.

GetCells()

virtual void vtkFLUENTCFFReader::GetCells ( )

protectedvirtual

Get the topology of cell per zone.

GetFaces()

virtual void vtkFLUENTCFFReader::GetFaces ( )

protectedvirtual

Get the topology of face per zone.

GetPeriodicShadowFaces()

virtual void vtkFLUENTCFFReader::GetPeriodicShadowFaces ( )

protectedvirtual

Get the periodic shadown faces information !!! NOT IMPLEMENTED YET !!!

GetCellOverset()

virtual void vtkFLUENTCFFReader::GetCellOverset ( )

protectedvirtual

Get the overset cells information !!! NOT IMPLEMENTED YET !!!

GetCellTree()

virtual void vtkFLUENTCFFReader::GetCellTree ( )

protectedvirtual

Get the tree (AMR) cell topology.

GetFaceTree()

virtual void vtkFLUENTCFFReader::GetFaceTree ( )

protectedvirtual

Get the tree (AMR) face topology.

GetInterfaceFaceParents()

virtual void vtkFLUENTCFFReader::GetInterfaceFaceParents ( )

protectedvirtual

Get the interface id of parent faces.

GetNonconformalGridInterfaceFaceInformation()

virtual void vtkFLUENTCFFReader::GetNonconformalGridInterfaceFaceInformation ( )

protectedvirtual

Get the non conformal grid interface information !!! NOT IMPLEMENTED YET !!!

CleanCells()

virtual void vtkFLUENTCFFReader::CleanCells ( )

protectedvirtual

Removes unnecessary faces from the cells.

PopulateCellNodes()

virtual void vtkFLUENTCFFReader::PopulateCellNodes ( )

protectedvirtual

Reconstruct and convert the Fluent data format to the VTK format.

PopulateCellTree()

virtual void vtkFLUENTCFFReader::PopulateCellTree ( )

protectedvirtual

PopulateTriangleCell()

virtual void vtkFLUENTCFFReader::PopulateTriangleCell ( int  i )

protectedvirtual

Reconstruct VTK cell topology from Fluent format.

PopulateTetraCell()

virtual void vtkFLUENTCFFReader::PopulateTetraCell ( int  i )

protectedvirtual

PopulateQuadCell()

virtual void vtkFLUENTCFFReader::PopulateQuadCell ( int  i )

protectedvirtual

PopulateHexahedronCell()

virtual void vtkFLUENTCFFReader::PopulateHexahedronCell ( int  i )

protectedvirtual

PopulatePyramidCell()

virtual void vtkFLUENTCFFReader::PopulatePyramidCell ( int  i )

protectedvirtual

PopulateWedgeCell()

virtual void vtkFLUENTCFFReader::PopulateWedgeCell ( int  i )

protectedvirtual

PopulatePolyhedronCell()

virtual void vtkFLUENTCFFReader::PopulatePolyhedronCell ( int  i )

protectedvirtual

GetData()

virtual int vtkFLUENTCFFReader::GetData ( )

protectedvirtual

Read and reconstruct data from .dat.h5 file.

GetMetaData()

virtual int vtkFLUENTCFFReader::GetMetaData ( )

protectedvirtual

Pre-read variable name data available for selection.

Member Data Documentation

CellDataArraySelection

vtkNew<vtkDataArraySelection> vtkFLUENTCFFReader::CellDataArraySelection

protected

Definition at line 284 of file vtkFLUENTCFFReader.h.

FileName

std::string vtkFLUENTCFFReader::FileName

protected

Definition at line 285 of file vtkFLUENTCFFReader.h.

NumberOfCells

vtkIdType vtkFLUENTCFFReader::NumberOfCells = 0

protected

Definition at line 286 of file vtkFLUENTCFFReader.h.

NumberOfCellArrays

int vtkFLUENTCFFReader::NumberOfCellArrays = 0

protected

Definition at line 287 of file vtkFLUENTCFFReader.h.

HDFImpl

std::unique_ptr<vtkInternals> vtkFLUENTCFFReader::HDFImpl

protected

Definition at line 290 of file vtkFLUENTCFFReader.h.

Points

vtkNew<vtkPoints> vtkFLUENTCFFReader::Points

protected

Definition at line 292 of file vtkFLUENTCFFReader.h.

Triangle

vtkNew<vtkTriangle> vtkFLUENTCFFReader::Triangle

protected

Definition at line 293 of file vtkFLUENTCFFReader.h.

Tetra

vtkNew<vtkTetra> vtkFLUENTCFFReader::Tetra

protected

Definition at line 294 of file vtkFLUENTCFFReader.h.

Quad

vtkNew<vtkQuad> vtkFLUENTCFFReader::Quad

protected

Definition at line 295 of file vtkFLUENTCFFReader.h.

Hexahedron

vtkNew<vtkHexahedron> vtkFLUENTCFFReader::Hexahedron

protected

Definition at line 296 of file vtkFLUENTCFFReader.h.

Pyramid

vtkNew<vtkPyramid> vtkFLUENTCFFReader::Pyramid

protected

Definition at line 297 of file vtkFLUENTCFFReader.h.

Wedge

vtkNew<vtkWedge> vtkFLUENTCFFReader::Wedge

protected

Definition at line 298 of file vtkFLUENTCFFReader.h.

Cells

std::vector<Cell> vtkFLUENTCFFReader::Cells

protected

Definition at line 300 of file vtkFLUENTCFFReader.h.

Faces

std::vector<Face> vtkFLUENTCFFReader::Faces

protected

Definition at line 301 of file vtkFLUENTCFFReader.h.

CellZones

std::vector<int> vtkFLUENTCFFReader::CellZones

protected

Definition at line 302 of file vtkFLUENTCFFReader.h.

ScalarDataChunks

std::vector<ScalarDataChunk> vtkFLUENTCFFReader::ScalarDataChunks

protected

Definition at line 303 of file vtkFLUENTCFFReader.h.

VectorDataChunks

std::vector<VectorDataChunk> vtkFLUENTCFFReader::VectorDataChunks

protected

Definition at line 304 of file vtkFLUENTCFFReader.h.

PreReadScalarData

std::vector<std::string> vtkFLUENTCFFReader::PreReadScalarData

protected

Definition at line 305 of file vtkFLUENTCFFReader.h.

PreReadVectorData

std::vector<std::string> vtkFLUENTCFFReader::PreReadVectorData

protected

Definition at line 306 of file vtkFLUENTCFFReader.h.

SwapBytes

vtkTypeBool vtkFLUENTCFFReader::SwapBytes = 0

protected

Definition at line 308 of file vtkFLUENTCFFReader.h.

GridDimension

int vtkFLUENTCFFReader::GridDimension = 0

protected

Definition at line 309 of file vtkFLUENTCFFReader.h.

FileState

DataState vtkFLUENTCFFReader::FileState = DataState::NOT_LOADED

protected

Definition at line 310 of file vtkFLUENTCFFReader.h.

NumberOfScalars

int vtkFLUENTCFFReader::NumberOfScalars = 0

protected

Definition at line 311 of file vtkFLUENTCFFReader.h.

NumberOfVectors

int vtkFLUENTCFFReader::NumberOfVectors = 0

protected

Definition at line 312 of file vtkFLUENTCFFReader.h.

---

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

• IO/FLUENTCFF/vtkFLUENTCFFReader.h