reads a dataset in OpenFOAM format More...

#include <vtkOpenFOAMReader.h>

Inheritance diagram for vtkOpenFOAMReader:

Collaboration diagram for vtkOpenFOAMReader:

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. More...

vtkOpenFOAMReader *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

int	CanReadFile (VTK_FILEPATH const char *)
	Determine if the file can be read with this reader. More...

int	GetNumberOfCellArrays ()
	Get the number of cell arrays available in the input. More...

int	GetCellArrayStatus (const char *name)
	Get/Set whether the cell array with the given name is to be read. More...

void	SetCellArrayStatus (const char *name, int status)

const char *	GetCellArrayName (int index)
	Get the name of the cell array with the given index in the input. More...

void	DisableAllCellArrays ()
	Turn on/off all cell arrays. More...

void	EnableAllCellArrays ()

int	GetNumberOfPointArrays ()
	Get the number of point arrays available in the input. More...

int	GetPointArrayStatus (const char *name)
	Get/Set whether the point array with the given name is to be read. More...

void	SetPointArrayStatus (const char *name, int status)

const char *	GetPointArrayName (int index)
	Get the name of the point array with the given index in the input. More...

void	DisableAllPointArrays ()
	Turn on/off all point arrays. More...

void	EnableAllPointArrays ()

int	GetNumberOfLagrangianArrays ()
	Get the number of Lagrangian arrays available in the input. More...

int	GetLagrangianArrayStatus (const char *name)
	Get/Set whether the Lagrangian array with the given name is to be read. More...

void	SetLagrangianArrayStatus (const char *name, int status)

const char *	GetLagrangianArrayName (int index)
	Get the name of the Lagrangian array with the given index in the input. More...

void	DisableAllLagrangianArrays ()
	Turn on/off all Lagrangian arrays. More...

void	EnableAllLagrangianArrays ()

int	GetNumberOfPatchArrays ()
	Get the number of Patches (including Internal Mesh) available in the input. More...

int	GetPatchArrayStatus (const char *name)
	Get/Set whether the Patch with the given name is to be read. More...

void	SetPatchArrayStatus (const char *name, int status)

const char *	GetPatchArrayName (int index)
	Get the name of the Patch with the given index in the input. More...

void	DisableAllPatchArrays ()
	Turn on/off all Patches including the Internal Mesh. More...

void	EnableAllPatchArrays ()

void	SetRefresh ()

void	SetParent (vtkOpenFOAMReader *parent)

int	MakeInformationVector (vtkInformationVector , const vtkStdString &procDirName, vtkStringArray timeNames=nullptr, vtkDoubleArray *timeValues=nullptr)

double	GetTimeValue () const

bool	SetTimeValue (double)

vtkStringArray *	GetTimeNames ()

vtkDoubleArray *	GetTimeValues ()

int	MakeMetaDataAtTimeStep (bool)


	vtkSetFilePathMacro (FileName)
	Set/Get the filename. More...

	vtkGetFilePathMacro (FileName)
	Set/Get the filename. More...


virtual void	SetCreateCellToPoint (vtkTypeBool)
	Set/Get whether to create cell-to-point translated data for cell-type data. More...

virtual vtkTypeBool	GetCreateCellToPoint ()
	Set/Get whether to create cell-to-point translated data for cell-type data. More...

virtual void	CreateCellToPointOn ()
	Set/Get whether to create cell-to-point translated data for cell-type data. More...

virtual void	CreateCellToPointOff ()
	Set/Get whether to create cell-to-point translated data for cell-type data. More...


virtual void	SetSizeAverageCellToPoint (vtkTypeBool)
	Set/Get whether to weigh cell to point averaging by size of cells (only meaningful when CreateCellToPoint is true) More...

virtual vtkTypeBool	GetSizeAverageCellToPoint ()
	Set/Get whether to weigh cell to point averaging by size of cells (only meaningful when CreateCellToPoint is true) More...

virtual void	SizeAverageCellToPointOn ()
	Set/Get whether to weigh cell to point averaging by size of cells (only meaningful when CreateCellToPoint is true) More...

virtual void	SizeAverageCellToPointOff ()
	Set/Get whether to weigh cell to point averaging by size of cells (only meaningful when CreateCellToPoint is true) More...


virtual void	SetCacheMesh (vtkTypeBool)
	Set/Get whether mesh is to be cached. More...

virtual vtkTypeBool	GetCacheMesh ()
	Set/Get whether mesh is to be cached. More...

virtual void	CacheMeshOn ()
	Set/Get whether mesh is to be cached. More...

virtual void	CacheMeshOff ()
	Set/Get whether mesh is to be cached. More...


virtual void	SetPositionsIsIn13Format (vtkTypeBool)
	Set/Get whether the lagrangian/positions have additional data or not. More...

virtual vtkTypeBool	GetPositionsIsIn13Format ()
	Set/Get whether the lagrangian/positions have additional data or not. More...

virtual void	PositionsIsIn13FormatOn ()
	Set/Get whether the lagrangian/positions have additional data or not. More...

virtual void	PositionsIsIn13FormatOff ()
	Set/Get whether the lagrangian/positions have additional data or not. More...


virtual void	SetSkipZeroTime (bool)
	Ignore 0/ time directory, which is normally missing Lagrangian fields and may have many dictionary functionality that we cannot easily handle. More...

virtual bool	GetSkipZeroTime ()
	Ignore 0/ time directory, which is normally missing Lagrangian fields and may have many dictionary functionality that we cannot easily handle. More...

virtual void	SkipZeroTimeOn ()
	Ignore 0/ time directory, which is normally missing Lagrangian fields and may have many dictionary functionality that we cannot easily handle. More...

virtual void	SkipZeroTimeOff ()
	Ignore 0/ time directory, which is normally missing Lagrangian fields and may have many dictionary functionality that we cannot easily handle. More...


virtual void	SetListTimeStepsByControlDict (vtkTypeBool)
	Determine if time directories are to be listed according to controlDict. More...

virtual vtkTypeBool	GetListTimeStepsByControlDict ()
	Determine if time directories are to be listed according to controlDict. More...

virtual void	ListTimeStepsByControlDictOn ()
	Determine if time directories are to be listed according to controlDict. More...

virtual void	ListTimeStepsByControlDictOff ()
	Determine if time directories are to be listed according to controlDict. More...


virtual void	SetAddDimensionsToArrayNames (vtkTypeBool)
	Add dimensions to array names. More...

virtual vtkTypeBool	GetAddDimensionsToArrayNames ()
	Add dimensions to array names. More...

virtual void	AddDimensionsToArrayNamesOn ()
	Add dimensions to array names. More...

virtual void	AddDimensionsToArrayNamesOff ()
	Add dimensions to array names. More...


virtual void	SetReadZones (vtkTypeBool)
	Set/Get whether zones will be read. More...

virtual vtkTypeBool	GetReadZones ()
	Set/Get whether zones will be read. More...

virtual void	ReadZonesOn ()
	Set/Get whether zones will be read. More...

virtual void	ReadZonesOff ()
	Set/Get whether zones will be read. More...


virtual void	SetUse64BitLabels (bool val)
	If true, labels are expected to be 64-bit, rather than 32. More...

virtual bool	GetUse64BitLabels ()
	If true, labels are expected to be 64-bit, rather than 32. More...

virtual void	Use64BitLabelsOn ()
	If true, labels are expected to be 64-bit, rather than 32. More...

virtual void	Use64BitLabelsOff ()
	If true, labels are expected to be 64-bit, rather than 32. More...


virtual bool	GetCopyDataToCellZones ()
	If true, data of the internal mesh are copied to the cell zones. More...

virtual void	SetCopyDataToCellZones (bool)
	If true, data of the internal mesh are copied to the cell zones. More...

virtual void	CopyDataToCellZonesOn ()
	If true, data of the internal mesh are copied to the cell zones. More...

virtual void	CopyDataToCellZonesOff ()
	If true, data of the internal mesh are copied to the cell zones. More...


virtual void	SetUse64BitFloats (bool val)
	If true, floats are expected to be 64-bit, rather than 32. More...

virtual bool	GetUse64BitFloats ()
	If true, floats are expected to be 64-bit, rather than 32. More...

virtual void	Use64BitFloatsOn ()
	If true, floats are expected to be 64-bit, rather than 32. More...

virtual void	Use64BitFloatsOff ()
	If true, floats are expected to be 64-bit, rather than 32. More...

Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm
vtkMultiBlockDataSetAlgorithm *	NewInstance () const

vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override
	see vtkAlgorithm for details More...

vtkMultiBlockDataSet *	GetOutput ()
	Get the output data object for a port on this algorithm. More...

vtkMultiBlockDataSet *	GetOutput (int)
	Get the output data object for a port on this algorithm. More...

void	SetInputData (vtkDataObject *)
	Assign a data object as input. More...

void	SetInputData (int, vtkDataObject *)
	Assign a data object as input. More...

Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const

vtkTypeBool	HasExecutive ()
	Check whether this algorithm has an assigned executive. More...

vtkExecutive *	GetExecutive ()
	Get this algorithm's executive. More...

virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive. More...

vtkTypeBool	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped. More...

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
	A special version of ProcessRequest meant specifically for the pipeline modified time request. More...

virtual int	ModifyRequest (vtkInformation *request, int when)
	This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...

vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port. More...

vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port. More...

int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm. More...

int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm. More...

void	SetAbortExecuteAndUpdateTime ()
	Set AbortExecute Flag and update LastAbortTime. More...

void	UpdateProgress (double amount)
	Update the progress of the process object. More...

bool	CheckAbort ()
	Checks to see if this filter should abort. More...

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	String based versions of SetInputArrayToProcess(). More...

vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm. More...

void	RemoveAllInputs ()
	Remove all the input data. More...

vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port. More...

vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection. More...

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index. More...

virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx. More...

virtual void	RemoveAllInputConnections (int port)
	Removes all input connections. More...

virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index. More...

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port. More...

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm. More...

vtkAlgorithmOutput *	GetOutputPort ()

int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port. More...

int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm. More...

vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port. More...

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. More...

vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair. More...

vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0). More...

vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection. More...

vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0) More...

vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection. More...

vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0) More...

vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port. More...

virtual vtkTypeBool	Update (int port, vtkInformationVector *requests)
	This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...

virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port. More...

virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port. More...

virtual int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port. More...

virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port. More...

virtual void	UpdateInformation ()
	Bring the algorithm's information up-to-date. More...

virtual void	UpdateDataObject ()
	Create output object(s). More...

virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream. More...

virtual void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date. More...

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...

void	RemoveNoPriorTemporalAccessInformationKey ()
	Removes any information key `vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS()` to all output ports of this `vtkAlgorithm`. More...

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm. More...

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm. More...

bool	UsesGarbageCollector () const override
	Participate in garbage collection. More...

virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object. More...

virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object. More...

virtual double	GetProgress ()
	Get the execution progress of a process object. More...

void	SetContainerAlgorithm (vtkAlgorithm *containerAlg)
	Set/get a Container algorithm for this algorithm. More...

vtkAlgorithm *	GetContainerAlgorithm ()
	Set/get a Container algorithm for this algorithm. More...

virtual void	SetAbortOutput (bool)
	Set/Get an internal variable used to communicate between the algorithm and executive. More...

virtual bool	GetAbortOutput ()
	Set/Get an internal variable used to communicate between the algorithm and executive. More...

void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called. More...

virtual double	GetProgressShift ()
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called. More...

virtual double	GetProgressScale ()
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called. More...

void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state. More...

virtual char *	GetProgressText ()
	Set the current text message associated with the progress state. More...

virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file. More...

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index. More...

virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index. More...

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index. More...

virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index. More...

virtual void	Update (int port)
	Bring this algorithm's outputs up-to-date. More...

virtual void	Update ()
	Bring this algorithm's outputs up-to-date. More...

virtual void	SetReleaseDataFlag (vtkTypeBool)
	Turn release data flag on or off for all output ports. More...

virtual vtkTypeBool	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports. More...

void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports. More...

void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports. More...

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...

int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents. More...

int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents. More...

int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents. More...

void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...

virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...

void	SetNoPriorTemporalAccessInformationKey (int key)
	Set to all output ports of this algorithm the information key `vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS()`. More...

void	SetNoPriorTemporalAccessInformationKey ()
	Set to all output ports of this algorithm the information key `vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS()`. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output. More...

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes. More...

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

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). More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkOpenFOAMReader *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkOpenFOAMReader *	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. More...

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. More...

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...

static vtkInformationIntegerKey *	ABORTED ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static 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). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

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. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkOpenFOAMReader ()

	~vtkOpenFOAMReader () override

int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	This is called by the superclass. More...

int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	This is called by the superclass. More...

void	CreateCasePath (vtkStdString &, vtkStdString &)

void	SetTimeInformation (vtkInformationVector , vtkDoubleArray )

void	CreateCharArrayFromString (vtkCharArray , const char , vtkStdString &)

void	UpdateStatus ()

void	UpdateProgress (double)

Protected Member Functions inherited from vtkMultiBlockDataSetAlgorithm
	vtkMultiBlockDataSetAlgorithm ()

	~vtkMultiBlockDataSetAlgorithm () override=default

virtual int	RequestDataObject (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called by the superclass. More...

virtual int	RequestUpdateTime (vtkInformation , vtkInformationVector , vtkInformationVector )

vtkExecutive *	CreateDefaultExecutive () override
	Create a default executive. More...

int	FillOutputPortInformation (int port, vtkInformation *info) override
	Fill the output port information objects for this algorithm. More...

int	FillInputPortInformation (int port, vtkInformation *info) override
	Fill the input port information objects for this algorithm. More...

vtkDataObject *	GetInput (int port)

virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called by the superclass. More...

Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()

	~vtkAlgorithm () override

bool	CheckUpstreamAbort ()
	Checks to see if an upstream filter has been aborted. More...

virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm. More...

virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm. More...

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
	Get the association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...

void	ReportReferences (vtkGarbageCollector *) override

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port. More...

virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port. More...

void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input. More...

void	AddInputDataInternal (int port, vtkDataObject *input)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

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. More...

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. More...

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature. More...

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. More...

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. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature. More...

virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file. More...

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
bool	Refresh

vtkTypeBool	CreateCellToPoint

vtkTypeBool	SizeAverageCellToPoint = false

vtkTypeBool	CacheMesh

vtkTypeBool	DecomposePolyhedra

vtkTypeBool	PositionsIsIn13Format

vtkTypeBool	ReadZones

bool	SkipZeroTime

vtkTypeBool	ListTimeStepsByControlDict

vtkTypeBool	AddDimensionsToArrayNames

bool	Use64BitLabels

bool	Use64BitFloats

bool	CopyDataToCellZones

char *	FileName

vtkCharArray *	CasePath

vtkCollection *	Readers

vtkDataArraySelection *	PatchDataArraySelection

vtkDataArraySelection *	CellDataArraySelection

vtkDataArraySelection *	PointDataArraySelection

vtkDataArraySelection *	LagrangianDataArraySelection

vtkMTimeType	PatchSelectionMTimeOld

vtkMTimeType	CellSelectionMTimeOld

vtkMTimeType	PointSelectionMTimeOld

vtkMTimeType	LagrangianSelectionMTimeOld

vtkStdString *	FileNameOld

bool	SkipZeroTimeOld

int	ListTimeStepsByControlDictOld

int	CreateCellToPointOld

int	DecomposePolyhedraOld

int	PositionsIsIn13FormatOld

int	AddDimensionsToArrayNamesOld

int	ReadZonesOld

bool	Use64BitLabelsOld

bool	Use64BitFloatsOld

vtkStringArray *	LagrangianPaths

int	NumberOfReaders

int	CurrentReaderIndex

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. More...

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

Friends
class	vtkOpenFOAMReaderPrivate

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 OpenFOAM format

vtkOpenFOAMReader creates a multiblock dataset. It reads mesh information and time dependent data. The polyMesh folders contain mesh information. The time folders contain transient data for the cells. Each folder can contain any number of data files.

Thanks:: Thanks to 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) of SAIC at the National Energy Technology Laboratory who originally developed this class.

Takuya Oshima of Niigata University, Japan (oshim.nosp@m.a@en.nosp@m.g.nii.nosp@m.gata.nosp@m.-u.ac.nosp@m..jp) provided the major bulk of improvements (rewrite) that made the reader truly functional and included the following features: Token-based FoamFile format lexer/parser, performance/stability/compatibility enhancements, gzipped file support, lagrangian field support, variable timestep support, builtin cell-to-point filter, pointField support, polyhedron decomposition support, multiregion support, parallelization support for decomposed cases in conjunction with vtkPOpenFOAMReader etc.

Philippose Rajan (sarit.nosp@m.h@ro.nosp@m.cketm.nosp@m.ail..nosp@m.com) added GUI-based selection of mesh regions and fields available in the case, minor bug fixes, strict memory allocation checks,

Mark Olesen (OpenCFD Ltd.) www.openfoam.com has provided various bugfixes, improvements, cleanup

Tests:: vtkOpenFOAMReader (Tests)

Definition at line 54 of file vtkOpenFOAMReader.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMultiBlockDataSetAlgorithm vtkOpenFOAMReader::Superclass

Definition at line 61 of file vtkOpenFOAMReader.h.

Constructor & Destructor Documentation

◆ vtkOpenFOAMReader()

vtkOpenFOAMReader::vtkOpenFOAMReader ( )

protected

◆ ~vtkOpenFOAMReader()

vtkOpenFOAMReader::~vtkOpenFOAMReader ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkOpenFOAMReader* vtkOpenFOAMReader::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

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

Reimplemented in vtkPOpenFOAMReader.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkOpenFOAMReader::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkMultiBlockDataSetAlgorithm.

Reimplemented in vtkPOpenFOAMReader.

◆ NewInstance()

vtkOpenFOAMReader* vtkOpenFOAMReader::NewInstance ( ) const

◆ PrintSelf()

void vtkOpenFOAMReader::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 vtkMultiBlockDataSetAlgorithm.

Reimplemented in vtkPOpenFOAMReader.

◆ CanReadFile()

int vtkOpenFOAMReader::CanReadFile ( VTK_FILEPATH const char * )

Determine if the file can be read with this reader.

◆ vtkSetFilePathMacro()

vtkOpenFOAMReader::vtkSetFilePathMacro ( FileName )

Set/Get the filename.

◆ vtkGetFilePathMacro()

vtkOpenFOAMReader::vtkGetFilePathMacro ( FileName )

Set/Get the filename.

◆ GetNumberOfCellArrays()

int vtkOpenFOAMReader::GetNumberOfCellArrays ( )

inline

Get the number of cell arrays available in the input.

Definition at line 80 of file vtkOpenFOAMReader.h.

◆ GetCellArrayStatus()

int vtkOpenFOAMReader::GetCellArrayStatus ( const char * name )

inline

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

Definition at line 89 of file vtkOpenFOAMReader.h.

◆ SetCellArrayStatus()

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

inline

Definition at line 93 of file vtkOpenFOAMReader.h.

◆ GetCellArrayName()

const char* vtkOpenFOAMReader::GetCellArrayName ( int index )

inline

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

Definition at line 102 of file vtkOpenFOAMReader.h.

◆ DisableAllCellArrays()

void vtkOpenFOAMReader::DisableAllCellArrays ( )

inline

Turn on/off all cell arrays.

Definition at line 110 of file vtkOpenFOAMReader.h.

◆ EnableAllCellArrays()

void vtkOpenFOAMReader::EnableAllCellArrays ( )

inline

Definition at line 111 of file vtkOpenFOAMReader.h.

◆ GetNumberOfPointArrays()

int vtkOpenFOAMReader::GetNumberOfPointArrays ( )

inline

Get the number of point arrays available in the input.

Definition at line 116 of file vtkOpenFOAMReader.h.

◆ GetPointArrayStatus()

int vtkOpenFOAMReader::GetPointArrayStatus ( const char * name )

inline

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

Definition at line 125 of file vtkOpenFOAMReader.h.

◆ SetPointArrayStatus()

void vtkOpenFOAMReader::SetPointArrayStatus	(	const char *	name,
		int	status
	)

inline

Definition at line 129 of file vtkOpenFOAMReader.h.

◆ GetPointArrayName()

const char* vtkOpenFOAMReader::GetPointArrayName ( int index )

inline

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

Definition at line 138 of file vtkOpenFOAMReader.h.

◆ DisableAllPointArrays()

void vtkOpenFOAMReader::DisableAllPointArrays ( )

inline

Turn on/off all point arrays.

Definition at line 146 of file vtkOpenFOAMReader.h.

◆ EnableAllPointArrays()

void vtkOpenFOAMReader::EnableAllPointArrays ( )

inline

Definition at line 147 of file vtkOpenFOAMReader.h.

◆ GetNumberOfLagrangianArrays()

int vtkOpenFOAMReader::GetNumberOfLagrangianArrays ( )

inline

Get the number of Lagrangian arrays available in the input.

Definition at line 152 of file vtkOpenFOAMReader.h.

◆ GetLagrangianArrayStatus()

int vtkOpenFOAMReader::GetLagrangianArrayStatus ( const char * name )

inline

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

Definition at line 161 of file vtkOpenFOAMReader.h.

◆ SetLagrangianArrayStatus()

void vtkOpenFOAMReader::SetLagrangianArrayStatus	(	const char *	name,
		int	status
	)

inline

Definition at line 165 of file vtkOpenFOAMReader.h.

◆ GetLagrangianArrayName()

const char* vtkOpenFOAMReader::GetLagrangianArrayName ( int index )

inline

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

Definition at line 174 of file vtkOpenFOAMReader.h.

◆ DisableAllLagrangianArrays()

void vtkOpenFOAMReader::DisableAllLagrangianArrays ( )

inline

Turn on/off all Lagrangian arrays.

Definition at line 182 of file vtkOpenFOAMReader.h.

◆ EnableAllLagrangianArrays()

void vtkOpenFOAMReader::EnableAllLagrangianArrays ( )

inline

Definition at line 186 of file vtkOpenFOAMReader.h.

◆ GetNumberOfPatchArrays()

int vtkOpenFOAMReader::GetNumberOfPatchArrays ( )

inline

Get the number of Patches (including Internal Mesh) available in the input.

Definition at line 194 of file vtkOpenFOAMReader.h.

◆ GetPatchArrayStatus()

int vtkOpenFOAMReader::GetPatchArrayStatus ( const char * name )

inline

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

Definition at line 203 of file vtkOpenFOAMReader.h.

◆ SetPatchArrayStatus()

void vtkOpenFOAMReader::SetPatchArrayStatus	(	const char *	name,
		int	status
	)

inline

Definition at line 207 of file vtkOpenFOAMReader.h.

◆ GetPatchArrayName()

const char* vtkOpenFOAMReader::GetPatchArrayName ( int index )

inline

Get the name of the Patch with the given index in the input.

Definition at line 216 of file vtkOpenFOAMReader.h.

◆ DisableAllPatchArrays()

void vtkOpenFOAMReader::DisableAllPatchArrays ( )

inline

Turn on/off all Patches including the Internal Mesh.

Definition at line 224 of file vtkOpenFOAMReader.h.

◆ EnableAllPatchArrays()

void vtkOpenFOAMReader::EnableAllPatchArrays ( )

inline

Definition at line 225 of file vtkOpenFOAMReader.h.

◆ SetCreateCellToPoint()

virtual void vtkOpenFOAMReader::SetCreateCellToPoint ( vtkTypeBool )

virtual

Set/Get whether to create cell-to-point translated data for cell-type data.

◆ GetCreateCellToPoint()

virtual vtkTypeBool vtkOpenFOAMReader::GetCreateCellToPoint ( )

virtual

Set/Get whether to create cell-to-point translated data for cell-type data.

◆ CreateCellToPointOn()

virtual void vtkOpenFOAMReader::CreateCellToPointOn ( )

virtual

Set/Get whether to create cell-to-point translated data for cell-type data.

◆ CreateCellToPointOff()

virtual void vtkOpenFOAMReader::CreateCellToPointOff ( )

virtual

Set/Get whether to create cell-to-point translated data for cell-type data.

◆ SetSizeAverageCellToPoint()

virtual void vtkOpenFOAMReader::SetSizeAverageCellToPoint ( vtkTypeBool )

virtual

Set/Get whether to weigh cell to point averaging by size of cells (only meaningful when CreateCellToPoint is true)

See also: CreateCellToPoint

◆ GetSizeAverageCellToPoint()

virtual vtkTypeBool vtkOpenFOAMReader::GetSizeAverageCellToPoint ( )

virtual

Set/Get whether to weigh cell to point averaging by size of cells (only meaningful when CreateCellToPoint is true)

See also: CreateCellToPoint

◆ SizeAverageCellToPointOn()

virtual void vtkOpenFOAMReader::SizeAverageCellToPointOn ( )

virtual

Set/Get whether to weigh cell to point averaging by size of cells (only meaningful when CreateCellToPoint is true)

See also: CreateCellToPoint

◆ SizeAverageCellToPointOff()

virtual void vtkOpenFOAMReader::SizeAverageCellToPointOff ( )

virtual

Set/Get whether to weigh cell to point averaging by size of cells (only meaningful when CreateCellToPoint is true)

See also: CreateCellToPoint

◆ SetCacheMesh()

virtual void vtkOpenFOAMReader::SetCacheMesh ( vtkTypeBool )

virtual

Set/Get whether mesh is to be cached.

◆ GetCacheMesh()

virtual vtkTypeBool vtkOpenFOAMReader::GetCacheMesh ( )

virtual

Set/Get whether mesh is to be cached.

◆ CacheMeshOn()

virtual void vtkOpenFOAMReader::CacheMeshOn ( )

virtual

Set/Get whether mesh is to be cached.

◆ CacheMeshOff()

virtual void vtkOpenFOAMReader::CacheMeshOff ( )

virtual

Set/Get whether mesh is to be cached.

◆ SetPositionsIsIn13Format()

virtual void vtkOpenFOAMReader::SetPositionsIsIn13Format ( vtkTypeBool )

virtual

Set/Get whether the lagrangian/positions have additional data or not.

For historical reasons, PositionsIsIn13Format is used to denote that the positions only have x,y,z value and the cell of the enclosing cell. In OpenFOAM 1.4-2.4, positions included facei and stepFraction information.

◆ GetPositionsIsIn13Format()

virtual vtkTypeBool vtkOpenFOAMReader::GetPositionsIsIn13Format ( )

virtual

Set/Get whether the lagrangian/positions have additional data or not.

For historical reasons, PositionsIsIn13Format is used to denote that the positions only have x,y,z value and the cell of the enclosing cell. In OpenFOAM 1.4-2.4, positions included facei and stepFraction information.

◆ PositionsIsIn13FormatOn()

virtual void vtkOpenFOAMReader::PositionsIsIn13FormatOn ( )

virtual

Set/Get whether the lagrangian/positions have additional data or not.

For historical reasons, PositionsIsIn13Format is used to denote that the positions only have x,y,z value and the cell of the enclosing cell. In OpenFOAM 1.4-2.4, positions included facei and stepFraction information.

◆ PositionsIsIn13FormatOff()

virtual void vtkOpenFOAMReader::PositionsIsIn13FormatOff ( )

virtual

Set/Get whether the lagrangian/positions have additional data or not.

For historical reasons, PositionsIsIn13Format is used to denote that the positions only have x,y,z value and the cell of the enclosing cell. In OpenFOAM 1.4-2.4, positions included facei and stepFraction information.

◆ SetSkipZeroTime()

virtual void vtkOpenFOAMReader::SetSkipZeroTime ( bool )

virtual

Ignore 0/ time directory, which is normally missing Lagrangian fields and may have many dictionary functionality that we cannot easily handle.

◆ GetSkipZeroTime()

virtual bool vtkOpenFOAMReader::GetSkipZeroTime ( )

virtual

Ignore 0/ time directory, which is normally missing Lagrangian fields and may have many dictionary functionality that we cannot easily handle.

◆ SkipZeroTimeOn()

virtual void vtkOpenFOAMReader::SkipZeroTimeOn ( )

virtual

Ignore 0/ time directory, which is normally missing Lagrangian fields and may have many dictionary functionality that we cannot easily handle.

◆ SkipZeroTimeOff()

virtual void vtkOpenFOAMReader::SkipZeroTimeOff ( )

virtual

Ignore 0/ time directory, which is normally missing Lagrangian fields and may have many dictionary functionality that we cannot easily handle.

◆ SetListTimeStepsByControlDict()

virtual void vtkOpenFOAMReader::SetListTimeStepsByControlDict ( vtkTypeBool )

virtual

Determine if time directories are to be listed according to controlDict.

◆ GetListTimeStepsByControlDict()

virtual vtkTypeBool vtkOpenFOAMReader::GetListTimeStepsByControlDict ( )

virtual

Determine if time directories are to be listed according to controlDict.

◆ ListTimeStepsByControlDictOn()

virtual void vtkOpenFOAMReader::ListTimeStepsByControlDictOn ( )

virtual

Determine if time directories are to be listed according to controlDict.

◆ ListTimeStepsByControlDictOff()

virtual void vtkOpenFOAMReader::ListTimeStepsByControlDictOff ( )

virtual

Determine if time directories are to be listed according to controlDict.

◆ SetAddDimensionsToArrayNames()

virtual void vtkOpenFOAMReader::SetAddDimensionsToArrayNames ( vtkTypeBool )

virtual

Add dimensions to array names.

◆ GetAddDimensionsToArrayNames()

virtual vtkTypeBool vtkOpenFOAMReader::GetAddDimensionsToArrayNames ( )

virtual

Add dimensions to array names.

◆ AddDimensionsToArrayNamesOn()

virtual void vtkOpenFOAMReader::AddDimensionsToArrayNamesOn ( )

virtual

Add dimensions to array names.

◆ AddDimensionsToArrayNamesOff()

virtual void vtkOpenFOAMReader::AddDimensionsToArrayNamesOff ( )

virtual

Add dimensions to array names.

◆ SetReadZones()

virtual void vtkOpenFOAMReader::SetReadZones ( vtkTypeBool )

virtual

Set/Get whether zones will be read.

◆ GetReadZones()

virtual vtkTypeBool vtkOpenFOAMReader::GetReadZones ( )

virtual

Set/Get whether zones will be read.

◆ ReadZonesOn()

virtual void vtkOpenFOAMReader::ReadZonesOn ( )

virtual

Set/Get whether zones will be read.

◆ ReadZonesOff()

virtual void vtkOpenFOAMReader::ReadZonesOff ( )

virtual

Set/Get whether zones will be read.

◆ SetUse64BitLabels()

virtual void vtkOpenFOAMReader::SetUse64BitLabels ( bool val )

virtual

If true, labels are expected to be 64-bit, rather than 32.

◆ GetUse64BitLabels()

virtual bool vtkOpenFOAMReader::GetUse64BitLabels ( )

virtual

If true, labels are expected to be 64-bit, rather than 32.

◆ Use64BitLabelsOn()

virtual void vtkOpenFOAMReader::Use64BitLabelsOn ( )

virtual

If true, labels are expected to be 64-bit, rather than 32.

◆ Use64BitLabelsOff()

virtual void vtkOpenFOAMReader::Use64BitLabelsOff ( )

virtual

If true, labels are expected to be 64-bit, rather than 32.

◆ GetCopyDataToCellZones()

virtual bool vtkOpenFOAMReader::GetCopyDataToCellZones ( )

virtual

If true, data of the internal mesh are copied to the cell zones.

Default is false.

◆ SetCopyDataToCellZones()

virtual void vtkOpenFOAMReader::SetCopyDataToCellZones ( bool )

virtual

If true, data of the internal mesh are copied to the cell zones.

Default is false.

◆ CopyDataToCellZonesOn()

virtual void vtkOpenFOAMReader::CopyDataToCellZonesOn ( )

virtual

If true, data of the internal mesh are copied to the cell zones.

Default is false.

◆ CopyDataToCellZonesOff()

virtual void vtkOpenFOAMReader::CopyDataToCellZonesOff ( )

virtual

If true, data of the internal mesh are copied to the cell zones.

Default is false.

◆ SetUse64BitFloats()

virtual void vtkOpenFOAMReader::SetUse64BitFloats ( bool val )

virtual

If true, floats are expected to be 64-bit, rather than 32.

Note that vtkFloatArrays may still be used in the output if this is true. This flag is only used to ensure that binary data is correctly parsed.

◆ GetUse64BitFloats()

virtual bool vtkOpenFOAMReader::GetUse64BitFloats ( )

virtual

If true, floats are expected to be 64-bit, rather than 32.

Note that vtkFloatArrays may still be used in the output if this is true. This flag is only used to ensure that binary data is correctly parsed.

◆ Use64BitFloatsOn()

virtual void vtkOpenFOAMReader::Use64BitFloatsOn ( )

virtual

If true, floats are expected to be 64-bit, rather than 32.

Note that vtkFloatArrays may still be used in the output if this is true. This flag is only used to ensure that binary data is correctly parsed.

◆ Use64BitFloatsOff()

virtual void vtkOpenFOAMReader::Use64BitFloatsOff ( )

virtual

If true, floats are expected to be 64-bit, rather than 32.

Note that vtkFloatArrays may still be used in the output if this is true. This flag is only used to ensure that binary data is correctly parsed.

◆ SetRefresh()

void vtkOpenFOAMReader::SetRefresh ( )

inline

Definition at line 338 of file vtkOpenFOAMReader.h.

◆ SetParent()

void vtkOpenFOAMReader::SetParent ( vtkOpenFOAMReader * parent )

inline

Definition at line 344 of file vtkOpenFOAMReader.h.

◆ MakeInformationVector()

int vtkOpenFOAMReader::MakeInformationVector	(	vtkInformationVector *	,
		const vtkStdString &	procDirName,
		vtkStringArray *	timeNames = `nullptr`,
		vtkDoubleArray *	timeValues = `nullptr`
	)

◆ GetTimeValue()

double vtkOpenFOAMReader::GetTimeValue ( ) const

◆ SetTimeValue()

bool vtkOpenFOAMReader::SetTimeValue ( double )

◆ GetTimeNames()

vtkStringArray* vtkOpenFOAMReader::GetTimeNames ( )

◆ GetTimeValues()

vtkDoubleArray* vtkOpenFOAMReader::GetTimeValues ( )

◆ MakeMetaDataAtTimeStep()

int vtkOpenFOAMReader::MakeMetaDataAtTimeStep ( bool )

◆ RequestInformation()

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

overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkMultiBlockDataSetAlgorithm.

Reimplemented in vtkPOpenFOAMReader.

◆ RequestData()

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

overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkMultiBlockDataSetAlgorithm.

Reimplemented in vtkPOpenFOAMReader.

◆ CreateCasePath()

void vtkOpenFOAMReader::CreateCasePath	(	vtkStdString &	,
		vtkStdString &
	)

protected

◆ SetTimeInformation()

void vtkOpenFOAMReader::SetTimeInformation	(	vtkInformationVector *	,
		vtkDoubleArray *
	)

protected

◆ CreateCharArrayFromString()

void vtkOpenFOAMReader::CreateCharArrayFromString	(	vtkCharArray *	,
		const char *	,
		vtkStdString &
	)

protected

◆ UpdateStatus()

void vtkOpenFOAMReader::UpdateStatus ( )

protected

◆ UpdateProgress()

void vtkOpenFOAMReader::UpdateProgress ( double )

protected

Friends And Related Function Documentation

◆ vtkOpenFOAMReaderPrivate

friend class vtkOpenFOAMReaderPrivate

friend

Definition at line 58 of file vtkOpenFOAMReader.h.

Member Data Documentation

◆ Refresh

bool vtkOpenFOAMReader::Refresh

protected

Definition at line 358 of file vtkOpenFOAMReader.h.

◆ CreateCellToPoint

vtkTypeBool vtkOpenFOAMReader::CreateCellToPoint

protected

Definition at line 361 of file vtkOpenFOAMReader.h.

◆ SizeAverageCellToPoint

vtkTypeBool vtkOpenFOAMReader::SizeAverageCellToPoint = false

protected

Definition at line 364 of file vtkOpenFOAMReader.h.

◆ CacheMesh

vtkTypeBool vtkOpenFOAMReader::CacheMesh

protected

Definition at line 367 of file vtkOpenFOAMReader.h.

◆ DecomposePolyhedra

vtkTypeBool vtkOpenFOAMReader::DecomposePolyhedra

protected

Definition at line 370 of file vtkOpenFOAMReader.h.

◆ PositionsIsIn13Format

vtkTypeBool vtkOpenFOAMReader::PositionsIsIn13Format

protected

Definition at line 373 of file vtkOpenFOAMReader.h.

◆ ReadZones

vtkTypeBool vtkOpenFOAMReader::ReadZones

protected

Definition at line 376 of file vtkOpenFOAMReader.h.

◆ SkipZeroTime

bool vtkOpenFOAMReader::SkipZeroTime

protected

Definition at line 379 of file vtkOpenFOAMReader.h.

◆ ListTimeStepsByControlDict

vtkTypeBool vtkOpenFOAMReader::ListTimeStepsByControlDict

protected

Definition at line 382 of file vtkOpenFOAMReader.h.

◆ AddDimensionsToArrayNames

vtkTypeBool vtkOpenFOAMReader::AddDimensionsToArrayNames

protected

Definition at line 385 of file vtkOpenFOAMReader.h.

◆ Use64BitLabels

bool vtkOpenFOAMReader::Use64BitLabels

protected

Definition at line 388 of file vtkOpenFOAMReader.h.

◆ Use64BitFloats

bool vtkOpenFOAMReader::Use64BitFloats

protected

Definition at line 393 of file vtkOpenFOAMReader.h.

◆ CopyDataToCellZones

bool vtkOpenFOAMReader::CopyDataToCellZones

protected

Definition at line 396 of file vtkOpenFOAMReader.h.

◆ FileName

char* vtkOpenFOAMReader::FileName

protected

Definition at line 398 of file vtkOpenFOAMReader.h.

◆ CasePath

vtkCharArray* vtkOpenFOAMReader::CasePath

protected

Definition at line 399 of file vtkOpenFOAMReader.h.

◆ Readers

vtkCollection* vtkOpenFOAMReader::Readers

protected

Definition at line 400 of file vtkOpenFOAMReader.h.

◆ PatchDataArraySelection

vtkDataArraySelection* vtkOpenFOAMReader::PatchDataArraySelection

protected

Definition at line 403 of file vtkOpenFOAMReader.h.

◆ CellDataArraySelection

vtkDataArraySelection* vtkOpenFOAMReader::CellDataArraySelection

protected

Definition at line 404 of file vtkOpenFOAMReader.h.

◆ PointDataArraySelection

vtkDataArraySelection* vtkOpenFOAMReader::PointDataArraySelection

protected

Definition at line 405 of file vtkOpenFOAMReader.h.

◆ LagrangianDataArraySelection

vtkDataArraySelection* vtkOpenFOAMReader::LagrangianDataArraySelection

protected

Definition at line 406 of file vtkOpenFOAMReader.h.

◆ PatchSelectionMTimeOld

vtkMTimeType vtkOpenFOAMReader::PatchSelectionMTimeOld

protected

Definition at line 409 of file vtkOpenFOAMReader.h.

◆ CellSelectionMTimeOld

vtkMTimeType vtkOpenFOAMReader::CellSelectionMTimeOld

protected

Definition at line 410 of file vtkOpenFOAMReader.h.

◆ PointSelectionMTimeOld

vtkMTimeType vtkOpenFOAMReader::PointSelectionMTimeOld

protected

Definition at line 411 of file vtkOpenFOAMReader.h.

◆ LagrangianSelectionMTimeOld

vtkMTimeType vtkOpenFOAMReader::LagrangianSelectionMTimeOld

protected

Definition at line 412 of file vtkOpenFOAMReader.h.

◆ FileNameOld

vtkStdString* vtkOpenFOAMReader::FileNameOld

protected

Definition at line 415 of file vtkOpenFOAMReader.h.

◆ SkipZeroTimeOld

bool vtkOpenFOAMReader::SkipZeroTimeOld

protected

Definition at line 416 of file vtkOpenFOAMReader.h.

◆ ListTimeStepsByControlDictOld

int vtkOpenFOAMReader::ListTimeStepsByControlDictOld

protected

Definition at line 417 of file vtkOpenFOAMReader.h.

◆ CreateCellToPointOld

int vtkOpenFOAMReader::CreateCellToPointOld

protected

Definition at line 418 of file vtkOpenFOAMReader.h.

◆ DecomposePolyhedraOld

int vtkOpenFOAMReader::DecomposePolyhedraOld

protected

Definition at line 419 of file vtkOpenFOAMReader.h.

◆ PositionsIsIn13FormatOld

int vtkOpenFOAMReader::PositionsIsIn13FormatOld

protected

Definition at line 420 of file vtkOpenFOAMReader.h.

◆ AddDimensionsToArrayNamesOld

int vtkOpenFOAMReader::AddDimensionsToArrayNamesOld

protected

Definition at line 421 of file vtkOpenFOAMReader.h.

◆ ReadZonesOld

int vtkOpenFOAMReader::ReadZonesOld

protected

Definition at line 422 of file vtkOpenFOAMReader.h.

◆ Use64BitLabelsOld

bool vtkOpenFOAMReader::Use64BitLabelsOld

protected

Definition at line 423 of file vtkOpenFOAMReader.h.

◆ Use64BitFloatsOld

bool vtkOpenFOAMReader::Use64BitFloatsOld

protected

Definition at line 424 of file vtkOpenFOAMReader.h.

◆ LagrangianPaths

vtkStringArray* vtkOpenFOAMReader::LagrangianPaths

protected

Definition at line 427 of file vtkOpenFOAMReader.h.

◆ NumberOfReaders

int vtkOpenFOAMReader::NumberOfReaders

protected

Definition at line 430 of file vtkOpenFOAMReader.h.

◆ CurrentReaderIndex

int vtkOpenFOAMReader::CurrentReaderIndex

protected

Definition at line 432 of file vtkOpenFOAMReader.h.

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

IO/Geometry/vtkOpenFOAMReader.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkOpenFOAMReader()

◆ ~vtkOpenFOAMReader()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ CanReadFile()

◆ vtkSetFilePathMacro()

◆ vtkGetFilePathMacro()

◆ GetNumberOfCellArrays()

◆ GetCellArrayStatus()

◆ SetCellArrayStatus()

◆ GetCellArrayName()

◆ DisableAllCellArrays()

◆ EnableAllCellArrays()

◆ GetNumberOfPointArrays()

◆ GetPointArrayStatus()

◆ SetPointArrayStatus()

◆ GetPointArrayName()

◆ DisableAllPointArrays()

◆ EnableAllPointArrays()

◆ GetNumberOfLagrangianArrays()

◆ GetLagrangianArrayStatus()

◆ SetLagrangianArrayStatus()

◆ GetLagrangianArrayName()

◆ DisableAllLagrangianArrays()

◆ EnableAllLagrangianArrays()

◆ GetNumberOfPatchArrays()

◆ GetPatchArrayStatus()

◆ SetPatchArrayStatus()

◆ GetPatchArrayName()

◆ DisableAllPatchArrays()

◆ EnableAllPatchArrays()

◆ SetCreateCellToPoint()

◆ GetCreateCellToPoint()

◆ CreateCellToPointOn()

◆ CreateCellToPointOff()

◆ SetSizeAverageCellToPoint()

◆ GetSizeAverageCellToPoint()

◆ SizeAverageCellToPointOn()

◆ SizeAverageCellToPointOff()

◆ SetCacheMesh()

◆ GetCacheMesh()

◆ CacheMeshOn()

◆ CacheMeshOff()

◆ SetPositionsIsIn13Format()

◆ GetPositionsIsIn13Format()

◆ PositionsIsIn13FormatOn()

◆ PositionsIsIn13FormatOff()

◆ SetSkipZeroTime()

◆ GetSkipZeroTime()

◆ SkipZeroTimeOn()

◆ SkipZeroTimeOff()

◆ SetListTimeStepsByControlDict()

◆ GetListTimeStepsByControlDict()

◆ ListTimeStepsByControlDictOn()

◆ ListTimeStepsByControlDictOff()

◆ SetAddDimensionsToArrayNames()

◆ GetAddDimensionsToArrayNames()

◆ AddDimensionsToArrayNamesOn()

◆ AddDimensionsToArrayNamesOff()

◆ SetReadZones()

◆ GetReadZones()

◆ ReadZonesOn()

◆ ReadZonesOff()