reads a dataset in Fluent file format More...

#include <vtkFLUENTReader.h>

Inheritance diagram for vtkFLUENTReader:

Collaboration diagram for vtkFLUENTReader:

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.
vtkFLUENTReader *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
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.
vtkMTimeType	GetMTime () override
	Get the last modified time of this filter.

	vtkSetFilePathMacro (FileName)
	Specify the file name of the Fluent file to read.
	vtkGetFilePathMacro (FileName)
	Specify the file name of the Fluent file to read.

virtual vtkIdType	GetNumberOfCells ()
	Get the total number of cells.

virtual bool	GetCacheData ()
	Get/Set if the filter should cache the data (i.e.
virtual void	SetCacheData (bool)
	Get/Set if the filter should cache the data (i.e.
virtual void	CacheDataOn ()
	Get/Set if the filter should cache the data (i.e.
virtual void	CacheDataOff ()
	Get/Set if the filter should cache the data (i.e.

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.

vtkDataArraySelection *	GetZoneSectionSelection ()
	Zone section selection, to determine which zone sections are loaded.

void	SetDataByteOrderToBigEndian ()
	These methods should be used instead of the SwapBytes methods.
void	SetDataByteOrderToLittleEndian ()
	These methods should be used instead of the SwapBytes methods.
int	GetDataByteOrder ()
	These methods should be used instead of the SwapBytes methods.
void	SetDataByteOrder (int)
	These methods should be used instead of the SwapBytes methods.
const char *	GetDataByteOrderAsString ()
	These methods should be used instead of the SwapBytes methods.
Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm
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
vtkAlgorithm *	NewInstance () const
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.
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.
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.
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.
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 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 vtkFLUENTReader *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkFLUENTReader *	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 Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkFLUENTReader ()
	~vtkFLUENTReader () 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 char *filename)
virtual bool	OpenDataFile (const char *filename)
virtual int	GetCaseChunk ()
virtual int	GetCaseIndex ()
virtual void	LoadVariableNames ()
virtual int	GetDataIndex ()
virtual int	GetDataChunk ()
virtual void	GetSpeciesVariableNames ()
virtual int	GetDimension ()
virtual void	GetLittleEndianFlag ()
virtual void	GetNodesAscii ()
virtual void	GetNodesSinglePrecision ()
virtual void	GetNodesDoublePrecision ()
virtual void	GetCellsAscii ()
virtual void	GetCellsBinary ()
virtual bool	GetFacesAscii ()
virtual void	GetFacesBinary ()
virtual void	GetPeriodicShadowFacesAscii ()
virtual void	GetPeriodicShadowFacesBinary ()
virtual void	GetCellTreeAscii ()
virtual void	GetCellTreeBinary ()
virtual void	GetFaceTreeAscii ()
virtual void	GetFaceTreeBinary ()
virtual void	GetInterfaceFaceParentsAscii ()
virtual void	GetInterfaceFaceParentsBinary ()
virtual void	GetNonconformalGridInterfaceFaceInformationAscii ()
virtual void	GetNonconformalGridInterfaceFaceInformationBinary ()
virtual void	GetPartitionInfo ()
virtual void	CleanCells ()
virtual void	PopulateCellNodes ()
virtual int	GetCaseBufferInt (int ptr)
virtual float	GetCaseBufferFloat (int ptr)
virtual double	GetCaseBufferDouble (int ptr)
virtual void	PopulateTriangleCell (size_t cellIdx)
virtual void	PopulateTetraCell (size_t cellIdx)
virtual void	PopulateQuadCell (size_t cellIdx)
virtual void	PopulateHexahedronCell (size_t cellIdx)
virtual void	PopulatePyramidCell (size_t cellIdx)
virtual void	PopulateWedgeCell (size_t cellIdx)
virtual void	PopulatePolyhedronCell (size_t cellIdx)
virtual int	GetDataBufferInt (int ptr)
virtual float	GetDataBufferFloat (int ptr)
virtual double	GetDataBufferDouble (int ptr)
virtual void	GetData (int dataType)
virtual bool	ParallelCheckCell (int vtkNotUsed(i))
virtual void	ReadZone ()
virtual bool	ParseCaseFile ()
virtual void	ParseDataFile ()

virtual void	SetSwapBytes (vtkTypeBool)
	Set/Get the byte swapping to explicitly swap the bytes of a file.
vtkTypeBool	GetSwapBytes ()
	Set/Get the byte swapping to explicitly swap the bytes of a file.
virtual void	SwapBytesOn ()
	Set/Get the byte swapping to explicitly swap the bytes of a file.
virtual void	SwapBytesOff ()
	Set/Get the byte swapping to explicitly swap the bytes of a file.
Protected Member Functions inherited from vtkMultiBlockDataSetAlgorithm
	vtkMultiBlockDataSetAlgorithm ()
	~vtkMultiBlockDataSetAlgorithm () override=default
virtual int	RequestDataObject (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called by the superclass.
virtual int	RequestUpdateTime (vtkInformation , vtkInformationVector , vtkInformationVector )
vtkExecutive *	CreateDefaultExecutive () override
int	FillOutputPortInformation (int port, vtkInformation *info) override
int	FillInputPortInformation (int port, vtkInformation *info) override
vtkDataObject *	GetInput (int port)
virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called by the superclass.
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	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
enum vtkAlgorithm::DesiredOutputPrecision	RemoveNoPriorTemporalAccessInformationKey
std::atomic< vtkTypeBool >	AbortExecute
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
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

Detailed Description

reads a dataset in Fluent file format

vtkFLUENTReader creates an unstructured grid multiblock dataset. It reads .cas (with associated .dat) and .msh files stored in FLUENT native format. When multiple zone sections are defined in the file they are provided in separate blocks. Each zone section can be unselected so that it won't be part of the outputted multiblock dataset.

Keep in mind that all intermediate structures are cached by default to avoid re-parsing the file when the zone selections change. If you wish to avoid caching to lower memory usage at the expense of IO performances, you can set CacheData to false.

Because of zone sections interdependency in the FLUENT format, some unselected zone sections may still need to be read from the file, even if they are not part of the outputted multiblock. Here is the general file parsing logic:

If any cell zone is enabled, the whole file needs to be read
Otherwise, only the necessary zones are read (nodes, faces, data arrays,...) Therefore, unselecting a zone will not always improve the file's reading time, but will lower the output' size.

Thanks:: Thanks to Brian W. Dotson & Terry E. Jordan (Department of Energy, National Energy Technology Laboratory) & Douglas McCorkle (Iowa State University) 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) & Terry Jordan (terry.nosp@m..jor.nosp@m.dan@s.nosp@m.a.ne.nosp@m.tl.do.nosp@m.e.go.nosp@m.v) & Doug McCorkle (mccdo.nosp@m.@ias.nosp@m.tate..nosp@m.edu)

See also: vtkGAMBITReader

Tests:: vtkFLUENTReader (Tests)

Definition at line 63 of file vtkFLUENTReader.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMultiBlockDataSetAlgorithm vtkFLUENTReader::Superclass

Definition at line 67 of file vtkFLUENTReader.h.

Constructor & Destructor Documentation

◆ vtkFLUENTReader()

vtkFLUENTReader::vtkFLUENTReader ( )

protected

◆ ~vtkFLUENTReader()

vtkFLUENTReader::~vtkFLUENTReader ( )

overrideprotected

Member Function Documentation

◆ New()

vtkFLUENTReader * vtkFLUENTReader::New ( )

static

◆ IsTypeOf()

vtkTypeBool vtkFLUENTReader::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkFLUENTReader::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()

vtkFLUENTReader * vtkFLUENTReader::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkFLUENTReader::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkMultiBlockDataSetAlgorithm.

◆ NewInstance()

vtkFLUENTReader * vtkFLUENTReader::NewInstance ( ) const

◆ PrintSelf()

void vtkFLUENTReader::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.

◆ vtkSetFilePathMacro()

vtkFLUENTReader::vtkSetFilePathMacro ( FileName )

Specify the file name of the Fluent file to read.

◆ vtkGetFilePathMacro()

vtkFLUENTReader::vtkGetFilePathMacro ( FileName )

Specify the file name of the Fluent file to read.

◆ GetNumberOfCells()

virtual vtkIdType vtkFLUENTReader::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.

◆ GetCacheData()

virtual bool vtkFLUENTReader::GetCacheData ( )

virtual

Get/Set if the filter should cache the data (i.e.

keep the intermediate structures in memory to avoid re-parsing the file). Defaults is true

◆ SetCacheData()

virtual void vtkFLUENTReader::SetCacheData ( bool )

virtual

Get/Set if the filter should cache the data (i.e.

keep the intermediate structures in memory to avoid re-parsing the file). Defaults is true

◆ CacheDataOn()

virtual void vtkFLUENTReader::CacheDataOn ( )

virtual

Get/Set if the filter should cache the data (i.e.

keep the intermediate structures in memory to avoid re-parsing the file). Defaults is true

◆ CacheDataOff()

virtual void vtkFLUENTReader::CacheDataOff ( )

virtual

Get/Set if the filter should cache the data (i.e.

keep the intermediate structures in memory to avoid re-parsing the file). Defaults is true

◆ GetNumberOfCellArrays()

int vtkFLUENTReader::GetNumberOfCellArrays ( )

Get the number of cell arrays available in the input.

◆ GetCellArrayName()

const char * vtkFLUENTReader::GetCellArrayName ( int index )

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

◆ GetCellArrayStatus()

int vtkFLUENTReader::GetCellArrayStatus ( const char * name )

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

◆ SetCellArrayStatus()

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

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

◆ DisableAllCellArrays()

void vtkFLUENTReader::DisableAllCellArrays ( )

Turn on/off all cell arrays.

◆ EnableAllCellArrays()

void vtkFLUENTReader::EnableAllCellArrays ( )

Turn on/off all cell arrays.

◆ GetZoneSectionSelection()

vtkDataArraySelection * vtkFLUENTReader::GetZoneSectionSelection ( )

Zone section selection, to determine which zone sections are loaded.