read PLOT3D data files More...

#include <vtkMultiBlockPLOT3DReader.h>

Inheritance diagram for vtkMultiBlockPLOT3DReader:

Collaboration diagram for vtkMultiBlockPLOT3DReader:

Public Types
enum	{ FILE_BIG_ENDIAN = 0 , FILE_LITTLE_ENDIAN = 1 }

typedef vtkParallelReader	Superclass

Public Types inherited from vtkParallelReader
typedef vtkReaderAlgorithm	Superclass

Public Types inherited from vtkReaderAlgorithm
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.

vtkMultiBlockPLOT3DReader *	NewInstance () const

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

virtual int	CanReadBinaryFile (VTK_FILEPATH const char *fname)
	Return 1 if the reader can read the given file name.

void	AddFunctionName (const std::string &name)


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	SetFileName (VTK_FILEPATH const char *name)
	Set/Get the PLOT3D geometry filename.

VTK_FILEPATH const char *	GetFileName ()
	Set/Get the PLOT3D geometry filename.

VTK_FILEPATH const char *	GetFileName (int i)
	Set/Get the PLOT3D geometry filename.

virtual void	SetXYZFileName (VTK_FILEPATH const char *)
	Set/Get the PLOT3D geometry filename.

	vtkGetFilePathMacro (XYZFileName)
	Set/Get the PLOT3D geometry filename.


void	SetQFileName (VTK_FILEPATH const char *name)
	Set/Get the PLOT3D solution filename.

VTK_FILEPATH const char *	GetQFileName ()
	Set/Get the PLOT3D solution filename.


	vtkSetFilePathMacro (FunctionFileName)
	Set/Get the PLOT3D function filename.

	vtkGetFilePathMacro (FunctionFileName)
	Set/Get the PLOT3D function filename.


virtual void	SetAutoDetectFormat (vtkTypeBool)
	When this option is turned on, the reader will try to figure out the values of various options such as byte order, byte count etc.

virtual vtkTypeBool	GetAutoDetectFormat ()
	When this option is turned on, the reader will try to figure out the values of various options such as byte order, byte count etc.

virtual void	AutoDetectFormatOn ()
	When this option is turned on, the reader will try to figure out the values of various options such as byte order, byte count etc.

virtual void	AutoDetectFormatOff ()
	When this option is turned on, the reader will try to figure out the values of various options such as byte order, byte count etc.


virtual void	SetBinaryFile (vtkTypeBool)
	Is the file to be read written in binary format (as opposed to ascii).

virtual vtkTypeBool	GetBinaryFile ()
	Is the file to be read written in binary format (as opposed to ascii).

virtual void	BinaryFileOn ()
	Is the file to be read written in binary format (as opposed to ascii).

virtual void	BinaryFileOff ()
	Is the file to be read written in binary format (as opposed to ascii).


virtual void	SetMultiGrid (vtkTypeBool)
	Does the file to be read contain information about number of grids.

virtual vtkTypeBool	GetMultiGrid ()
	Does the file to be read contain information about number of grids.

virtual void	MultiGridOn ()
	Does the file to be read contain information about number of grids.

virtual void	MultiGridOff ()
	Does the file to be read contain information about number of grids.


virtual void	SetHasByteCount (vtkTypeBool)
	Were the arrays written with leading and trailing byte counts ? Usually, files written by a fortran program will contain these byte counts whereas the ones written by C/C++ won't.

virtual vtkTypeBool	GetHasByteCount ()
	Were the arrays written with leading and trailing byte counts ? Usually, files written by a fortran program will contain these byte counts whereas the ones written by C/C++ won't.

virtual void	HasByteCountOn ()
	Were the arrays written with leading and trailing byte counts ? Usually, files written by a fortran program will contain these byte counts whereas the ones written by C/C++ won't.

virtual void	HasByteCountOff ()
	Were the arrays written with leading and trailing byte counts ? Usually, files written by a fortran program will contain these byte counts whereas the ones written by C/C++ won't.


virtual void	SetIBlanking (vtkTypeBool)
	Is there iblanking (point visibility) information in the file.

virtual vtkTypeBool	GetIBlanking ()
	Is there iblanking (point visibility) information in the file.

virtual void	IBlankingOn ()
	Is there iblanking (point visibility) information in the file.

virtual void	IBlankingOff ()
	Is there iblanking (point visibility) information in the file.


virtual void	SetTwoDimensionalGeometry (vtkTypeBool)
	If only two-dimensional data was written to the file, turn this on.

virtual vtkTypeBool	GetTwoDimensionalGeometry ()
	If only two-dimensional data was written to the file, turn this on.

virtual void	TwoDimensionalGeometryOn ()
	If only two-dimensional data was written to the file, turn this on.

virtual void	TwoDimensionalGeometryOff ()
	If only two-dimensional data was written to the file, turn this on.


virtual void	SetDoublePrecision (vtkTypeBool)
	Is this file in double precision or single precision.

virtual vtkTypeBool	GetDoublePrecision ()
	Is this file in double precision or single precision.

virtual void	DoublePrecisionOn ()
	Is this file in double precision or single precision.

virtual void	DoublePrecisionOff ()
	Is this file in double precision or single precision.


virtual void	SetForceRead (vtkTypeBool)
	Try to read a binary file even if the file length seems to be inconsistent with the header information.

virtual vtkTypeBool	GetForceRead ()
	Try to read a binary file even if the file length seems to be inconsistent with the header information.

virtual void	ForceReadOn ()
	Try to read a binary file even if the file length seems to be inconsistent with the header information.

virtual void	ForceReadOff ()
	Try to read a binary file even if the file length seems to be inconsistent with the header information.


void	SetByteOrderToBigEndian ()
	Set the byte order of the file (remember, more Unix workstations write big endian whereas PCs write little endian).

void	SetByteOrderToLittleEndian ()
	Set the byte order of the file (remember, more Unix workstations write big endian whereas PCs write little endian).

virtual void	SetByteOrder (int)
	Set the byte order of the file (remember, more Unix workstations write big endian whereas PCs write little endian).

virtual int	GetByteOrder ()
	Set the byte order of the file (remember, more Unix workstations write big endian whereas PCs write little endian).

const char *	GetByteOrderAsString ()
	Set the byte order of the file (remember, more Unix workstations write big endian whereas PCs write little endian).


virtual void	SetR (double)
	Set/Get the gas constant.

virtual double	GetR ()
	Set/Get the gas constant.


virtual void	SetGamma (double)
	Set/Get the ratio of specific heats.

virtual double	GetGamma ()
	Set/Get the ratio of specific heats.


virtual void	SetPreserveIntermediateFunctions (bool)
	When set to true (default), the reader will preserve intermediate computed quantities that were not explicitly requested e.g.

virtual bool	GetPreserveIntermediateFunctions ()
	When set to true (default), the reader will preserve intermediate computed quantities that were not explicitly requested e.g.

virtual void	PreserveIntermediateFunctionsOn ()
	When set to true (default), the reader will preserve intermediate computed quantities that were not explicitly requested e.g.

virtual void	PreserveIntermediateFunctionsOff ()
	When set to true (default), the reader will preserve intermediate computed quantities that were not explicitly requested e.g.

void	SetScalarFunctionNumber (int num)
	Specify the scalar function to extract.

virtual int	GetScalarFunctionNumber ()
	When set to true (default), the reader will preserve intermediate computed quantities that were not explicitly requested e.g.


void	SetVectorFunctionNumber (int num)
	Specify the vector function to extract.

virtual int	GetVectorFunctionNumber ()
	Specify the vector function to extract.


void	AddFunction (int functionNumber)
	Specify additional functions to read.

void	RemoveFunction (int)
	Specify additional functions to read.

void	RemoveAllFunctions ()
	Specify additional functions to read.


void	SetController (vtkMultiProcessController *c)
	Set/Get the communicator object (we'll use global World controller if you don't set a different one).

virtual vtkMultiProcessController *	GetController ()
	Set/Get the communicator object (we'll use global World controller if you don't set a different one).


int	ReadMetaData (vtkInformation *metadata) override
	These methods have to be overwritten from superclass because Plot3D actually uses the XYZ file to read these.

int	ReadMesh (int piece, int npieces, int nghosts, int timestep, vtkDataObject *output) override
	These methods have to be overwritten from superclass because Plot3D actually uses the XYZ file to read these.

int	ReadPoints (int piece, int npieces, int nghosts, int timestep, vtkDataObject *output) override
	These methods have to be overwritten from superclass because Plot3D actually uses the XYZ file to read these.

int	ReadArrays (int piece, int npieces, int nghosts, int timestep, vtkDataObject *output) override
	These methods have to be overwritten from superclass because Plot3D actually uses the XYZ file to read these.

Public Member Functions inherited from vtkParallelReader
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkParallelReader *	NewInstance () const

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

void	AddFileName (VTK_FILEPATH const char *fname)
	Add a filename to be read.

void	ClearFileNames ()
	Removes all filenames stored by the reader.

int	GetNumberOfFileNames () const
	Returns the number of filenames stored by the reader.

VTK_FILEPATH const char *	GetFileName (int i) const
	Returns a particular filename stored by the reader.

VTK_FILEPATH const char *	GetCurrentFileName () const
	Returns the filename that was last loaded by the reader.

Public Member Functions inherited from vtkReaderAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkReaderAlgorithm *	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 inInfo, vtkInformationVector outInfo) override
	Overridden to call appropriate handle pipeline request from executive.

virtual vtkDataObject *	CreateOutput (vtkDataObject *currentOutput)
	This can be overridden by a subclass to create an output that is determined by the file being read.

virtual int	ReadMetaData (vtkInformation *metadata)=0
	Provide meta-data for the pipeline.

virtual int	ReadTimeDependentMetaData (int, vtkInformation *)
	Provide meta-data for the pipeline.

virtual int	ReadMesh (int piece, int npieces, int nghosts, int timestep, vtkDataObject *output)=0
	Read the mesh (connectivity) for a given set of data partitioning, number of ghost levels and time step (index).

virtual int	ReadPoints (int piece, int npieces, int nghosts, int timestep, vtkDataObject *output)=0
	Read the points.

virtual int	ReadArrays (int piece, int npieces, int nghosts, int timestep, vtkDataObject *output)=0
	Read all the arrays (point, cell, field etc.).

Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkAlgorithm *	NewInstance () const

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

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

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

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

virtual vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inInfo, vtkInformationVector outInfo)
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.

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

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

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

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

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

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

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

void	SetProgress (double)
	`SetProgress` is deprecated.

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

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

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

void	RemoveAllInputs ()
	Remove all the input data.

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

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

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

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

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

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

virtual void	SetInputDataObject (vtkDataObject *data)

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

virtual void	AddInputDataObject (vtkDataObject *data)

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

vtkAlgorithmOutput *	GetOutputPort ()

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

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

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

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.

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

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

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

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

void	Register (vtkObjectBase *o) override
	Participate in garbage collection.

void	UnRegister (vtkObjectBase *o) override
	Participate in garbage collection.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

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

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

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

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

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

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

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

void	InitializeObjectBase ()

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

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

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

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

void	SetReferenceCount (int)
	Sets the reference count.

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

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

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

Static Public Member Functions
static vtkMultiBlockPLOT3DReader *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkMultiBlockPLOT3DReader *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkParallelReader
static vtkTypeBool	IsTypeOf (const char *type)

static vtkParallelReader *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkReaderAlgorithm
static vtkTypeBool	IsTypeOf (const char *type)

static vtkReaderAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements.

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.

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

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

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

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

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

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

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

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

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

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

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

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

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkMultiBlockPLOT3DReader ()

	~vtkMultiBlockPLOT3DReader () override

vtkDataArray *	CreateFloatArray ()

int	CheckFile (FILE &fp, const char fname)

int	CheckGeometryFile (FILE *&xyzFp)

int	CheckFunctionFile (FILE *&fFp)

int	GetByteCountSize ()

int	SkipByteCount (FILE *fp)

int	ReadIntBlock (FILE fp, int n, int block)

vtkIdType	ReadValues (FILE fp, int n, vtkDataArray scalar)

virtual int	ReadIntScalar (void vfp, int extent[6], int wextent[6], vtkDataArray scalar, vtkTypeUInt64 offset, const vtkMultiBlockPLOT3DReaderRecord &currentRecord)

virtual int	ReadScalar (void vfp, int extent[6], int wextent[6], vtkDataArray scalar, vtkTypeUInt64 offset, const vtkMultiBlockPLOT3DReaderRecord &currentRecord)

virtual int	ReadVector (void vfp, int extent[6], int wextent[6], int numDims, vtkDataArray vector, vtkTypeUInt64 offset, const vtkMultiBlockPLOT3DReaderRecord &currentRecord)

virtual int	OpenFileForDataRead (void &fp, const char fname)

virtual void	CloseFile (void *fp)

int	GetNumberOfBlocksInternal (FILE *xyzFp, int allocate)

int	ReadGeometryHeader (FILE *fp)

int	ReadQHeader (FILE *fp, bool checkGrid, int &nq, int &nqc, int &overflow)

int	ReadFunctionHeader (FILE fp, int nFunctions)

void	CalculateFileSize (FILE *fp)

int	AutoDetectionCheck (FILE *fp)

void	AssignAttribute (int fNumber, vtkStructuredGrid *output, int attributeType)

void	MapFunction (int fNumber, vtkStructuredGrid *output)

vtkDataArray *	NewFloatArray ()

void	ClearGeometryCache ()

double	GetGamma (vtkIdType idx, vtkDataArray *gamma)

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


double	GetTimeValue (const std::string &fname) override
	Overridden from superclass to do actual reading.

int	ReadMesh (const std::string &fname, int piece, int npieces, int nghosts, vtkDataObject *output) override
	Overridden from superclass to do actual reading.

int	ReadPoints (const std::string &fname, int piece, int npieces, int nghosts, vtkDataObject *output) override
	Overridden from superclass to do actual reading.

int	ReadArrays (const std::string &fname, int piece, int npieces, int nghosts, vtkDataObject *output) override
	Overridden from superclass to do actual reading.


vtkDataArray *	ComputeTemperature (vtkStructuredGrid *output)
	Each of these methods compute a derived quantity.

vtkDataArray *	ComputePressure (vtkStructuredGrid *output)
	Each of these methods compute a derived quantity.

vtkDataArray *	ComputeEnthalpy (vtkStructuredGrid *output)
	Each of these methods compute a derived quantity.

vtkDataArray *	ComputeKineticEnergy (vtkStructuredGrid *output)
	Each of these methods compute a derived quantity.

vtkDataArray *	ComputeVelocityMagnitude (vtkStructuredGrid *output)
	Each of these methods compute a derived quantity.

vtkDataArray *	ComputeEntropy (vtkStructuredGrid *output)
	Each of these methods compute a derived quantity.

vtkDataArray *	ComputeSwirl (vtkStructuredGrid *output)
	Each of these methods compute a derived quantity.

vtkDataArray *	ComputeVelocity (vtkStructuredGrid *output)
	Each of these methods compute a derived quantity.

vtkDataArray *	ComputeVorticity (vtkStructuredGrid *output)
	Each of these methods compute a derived quantity.

vtkDataArray *	ComputePressureGradient (vtkStructuredGrid *output)
	Each of these methods compute a derived quantity.

vtkDataArray *	ComputePressureCoefficient (vtkStructuredGrid *output)
	Each of these methods compute a derived quantity.

vtkDataArray *	ComputeMachNumber (vtkStructuredGrid *output)
	Each of these methods compute a derived quantity.

vtkDataArray *	ComputeSoundSpeed (vtkStructuredGrid *output)
	Each of these methods compute a derived quantity.

vtkDataArray *	ComputeVorticityMagnitude (vtkStructuredGrid *output)
	Each of these methods compute a derived quantity.

vtkDataArray *	ComputeStrainRate (vtkStructuredGrid *output)
	Each of these methods compute a derived quantity.

Protected Member Functions inherited from vtkParallelReader
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkParallelReader ()

	~vtkParallelReader () override

virtual double	GetTimeValue (const std::string &fname)
	A subclass can override this method to provide an actual time value for a given file (this method is called for each filename stored by the reader).

virtual int	ReadMesh (const std::string &fname, int piece, int npieces, int nghosts, vtkDataObject *output)=0
	A method that needs to be override by the subclass to provide the mesh (topology).

virtual int	ReadPoints (const std::string &fname, int piece, int npieces, int nghosts, vtkDataObject *output)=0
	A method that needs to be override by the subclass to provide the point coordinates.

virtual int	ReadArrays (const std::string &fname, int piece, int npieces, int nghosts, vtkDataObject *output)=0
	A method that needs to be override by the subclass to provide data arrays.

Protected Member Functions inherited from vtkReaderAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkReaderAlgorithm ()

	~vtkReaderAlgorithm () override

Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAlgorithm ()

	~vtkAlgorithm () override

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

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

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

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

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

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

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

virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive.

void	ReportReferences (vtkGarbageCollector *) override

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

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

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

void	AddInputDataInternal (int port, vtkDataObject *input)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

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

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

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
char *	XYZFileName

char *	QFileName

char *	FunctionFileName

vtkTypeBool	BinaryFile

vtkTypeBool	HasByteCount

vtkTypeBool	TwoDimensionalGeometry

vtkTypeBool	MultiGrid

vtkTypeBool	ForceRead

int	ByteOrder

vtkTypeBool	IBlanking

vtkTypeBool	DoublePrecision

vtkTypeBool	AutoDetectFormat

int	ExecutedGhostLevels

size_t	FileSize

double	R

double	Gamma

double	GammaInf

bool	PreserveIntermediateFunctions

std::vector< std::string >	FunctionNames

vtkIntArray *	FunctionList

int	ScalarFunctionNumber

int	VectorFunctionNumber

vtkMultiBlockPLOT3DReaderInternals *	Internal

vtkMultiProcessController *	Controller

Protected Attributes inherited from vtkParallelReader
int	CurrentFileIndex

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode
	The error code contains a possible error that occurred while reading or writing the file.

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	Functors::ComputeFunctor

class	Functors::ComputeTemperatureFunctor

class	Functors::ComputePressureFunctor

class	Functors::ComputePressureCoefficientFunctor

class	Functors::ComputeMachNumberFunctor

class	Functors::ComputeSoundSpeedFunctor

class	Functors::ComputeEnthalpyFunctor

class	Functors::ComputeKinecticEnergyFunctor

class	Functors::ComputeVelocityMagnitudeFunctor

class	Functors::ComputeEntropyFunctor

class	Functors::ComputeSwirlFunctor

class	Functors::ComputeVelocityFunctor

class	Functors::ComputeVorticityMagnitudeFunctor

class	Functors::ComputePressureGradientFunctor

class	Functors::ComputeVorticityFunctor

class	Functors::ComputeStrainRateFunctor

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
vtkTypeBool	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

read PLOT3D data files

vtkMultiBlockPLOT3DReader is a reader object that reads PLOT3D formatted files and generates structured grid(s) on output. PLOT3D is a computer graphics program designed to visualize the grids and solutions of computational fluid dynamics. This reader also supports the variant of the PLOT3D format used by NASA's OVERFLOW CFD software, including full support for all Q variables. Please see the "PLOT3D User's Manual" available from NASA Ames Research Center, Moffett Field CA.

PLOT3D files consist of a grid file (also known as XYZ file), an optional solution file (also known as a Q file), and an optional function file that contains user created data (currently unsupported). The Q file contains solution information as follows: the four parameters free stream mach number (Fsmach), angle of attack (Alpha), Reynolds number (Re), and total integration time (Time). This information is stored in an array called Properties in the FieldData of each output (tuple 0: fsmach, tuple 1: alpha, tuple 2: re, tuple 3: time). In addition, the solution file contains the flow density (scalar), flow momentum (vector), and flow energy (scalar).

This reader supports a limited form of time series data which are stored as a series of Q files. Using the AddFileName() method provided by the superclass, one can define a file series. For other cases, for example where the XYZ or function files vary over time, use vtkPlot3DMetaReader.

The reader can generate additional scalars and vectors (or "functions") from this information. To use vtkMultiBlockPLOT3DReader, you must specify the particular function number for the scalar and vector you want to visualize. This implementation of the reader provides the following functions. The scalar functions are: -1 - don't read or compute any scalars 100 - density 110 - pressure 111 - pressure coefficient (requires Overflow file with Gamma) 112 - mach number (requires Overflow file with Gamma) 113 - sounds speed (requires Overflow file with Gamma) 120 - temperature 130 - enthalpy 140 - internal energy 144 - kinetic energy 153 - velocity magnitude 163 - stagnation energy 170 - entropy 184 - swirl 211 - vorticity magnitude

The vector functions are: -1 - don't read or compute any vectors 200 - velocity 201 - vorticity 202 - momentum 210 - pressure gradient. 212 - strain rate

(Other functions are described in the PLOT3D spec, but only those listed are implemented here.) Note that by default, this reader creates the density scalar (100), stagnation energy (163) and momentum vector (202) as output. (These are just read in from the solution file.) Please note that the validity of computation is a function of this class's gas constants (R, Gamma) and the equations used. They may not be suitable for your computational domain.

Additionally, you can read other data and associate it as a vtkDataArray into the output's point attribute data. Use the method AddFunction() to list all the functions that you'd like to read. AddFunction() accepts an integer parameter that defines the function number.

See also: vtkMultiBlockDataSet vtkStructuredGrid vtkPlot3DMetaReader

Online Examples:

PseudoVolumeRendering

Definition at line 233 of file vtkMultiBlockPLOT3DReader.h.

Member Typedef Documentation

◆ Superclass

typedef vtkParallelReader vtkMultiBlockPLOT3DReader::Superclass

Definition at line 254 of file vtkMultiBlockPLOT3DReader.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
FILE_BIG_ENDIAN
FILE_LITTLE_ENDIAN

Definition at line 481 of file vtkMultiBlockPLOT3DReader.h.

Constructor & Destructor Documentation

◆ vtkMultiBlockPLOT3DReader()

vtkMultiBlockPLOT3DReader::vtkMultiBlockPLOT3DReader ( )

protected

◆ ~vtkMultiBlockPLOT3DReader()

vtkMultiBlockPLOT3DReader::~vtkMultiBlockPLOT3DReader ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkMultiBlockPLOT3DReader * vtkMultiBlockPLOT3DReader::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

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

Reimplemented in vtkMPIMultiBlockPLOT3DReader.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkMultiBlockPLOT3DReader::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkParallelReader.

Reimplemented in vtkMPIMultiBlockPLOT3DReader.

◆ NewInstance()

vtkMultiBlockPLOT3DReader * vtkMultiBlockPLOT3DReader::NewInstance ( ) const

◆ PrintSelf()

void vtkMultiBlockPLOT3DReader::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 vtkParallelReader.

◆ GetOutput() [1/2]

vtkMultiBlockDataSet * vtkMultiBlockPLOT3DReader::GetOutput ( )

Get the output data object for a port on this algorithm.

◆ GetOutput() [2/2]

vtkMultiBlockDataSet * vtkMultiBlockPLOT3DReader::GetOutput ( int )

Get the output data object for a port on this algorithm.

◆ SetFileName()

void vtkMultiBlockPLOT3DReader::SetFileName ( VTK_FILEPATH const char * name )

inline

Set/Get the PLOT3D geometry filename.

Definition at line 269 of file vtkMultiBlockPLOT3DReader.h.

◆ GetFileName() [1/2]

VTK_FILEPATH const char * vtkMultiBlockPLOT3DReader::GetFileName ( )

inline

Set/Get the PLOT3D geometry filename.

Definition at line 270 of file vtkMultiBlockPLOT3DReader.h.

◆ GetFileName() [2/2]

VTK_FILEPATH const char * vtkMultiBlockPLOT3DReader::GetFileName ( int i )

inline

Set/Get the PLOT3D geometry filename.

Definition at line 271 of file vtkMultiBlockPLOT3DReader.h.

◆ SetXYZFileName()

virtual void vtkMultiBlockPLOT3DReader::SetXYZFileName ( VTK_FILEPATH const char * )

virtual

Set/Get the PLOT3D geometry filename.

◆ vtkGetFilePathMacro() [1/2]

vtkMultiBlockPLOT3DReader::vtkGetFilePathMacro ( XYZFileName )

Set/Get the PLOT3D geometry filename.

◆ SetQFileName()

void vtkMultiBlockPLOT3DReader::SetQFileName ( VTK_FILEPATH const char * name )

Set/Get the PLOT3D solution filename.

This adds a filename using the superclass' AddFileName() method. To read a series of q files, use the AddFileName() interface directly to add multiple q filenames in the appropriate order. If the files are of Overflow format, the reader will read the time values from the files. Otherwise, it will use an integer sequence. Use a meta reader to support time values for non-Overflow file sequences.

◆ GetQFileName()

VTK_FILEPATH const char * vtkMultiBlockPLOT3DReader::GetQFileName ( )

Set/Get the PLOT3D solution filename.

This adds a filename using the superclass' AddFileName() method. To read a series of q files, use the AddFileName() interface directly to add multiple q filenames in the appropriate order. If the files are of Overflow format, the reader will read the time values from the files. Otherwise, it will use an integer sequence. Use a meta reader to support time values for non-Overflow file sequences.

◆ vtkSetFilePathMacro()

vtkMultiBlockPLOT3DReader::vtkSetFilePathMacro ( FunctionFileName )

Set/Get the PLOT3D function filename.

◆ vtkGetFilePathMacro() [2/2]

vtkMultiBlockPLOT3DReader::vtkGetFilePathMacro ( FunctionFileName )

Set/Get the PLOT3D function filename.

◆ SetAutoDetectFormat()

virtual void vtkMultiBlockPLOT3DReader::SetAutoDetectFormat ( vtkTypeBool )

virtual

When this option is turned on, the reader will try to figure out the values of various options such as byte order, byte count etc.

automatically. This options works only for binary files. When it is turned on, the reader should be able to read most Plot3D files automatically. The default is OFF for backwards compatibility reasons. For binary files, it is strongly recommended that you turn on AutoDetectFormat and leave the other file format related options untouched.

◆ GetAutoDetectFormat()

virtual vtkTypeBool vtkMultiBlockPLOT3DReader::GetAutoDetectFormat ( )

virtual

When this option is turned on, the reader will try to figure out the values of various options such as byte order, byte count etc.

automatically. This options works only for binary files. When it is turned on, the reader should be able to read most Plot3D files automatically. The default is OFF for backwards compatibility reasons. For binary files, it is strongly recommended that you turn on AutoDetectFormat and leave the other file format related options untouched.

◆ AutoDetectFormatOn()

virtual void vtkMultiBlockPLOT3DReader::AutoDetectFormatOn ( )

virtual

When this option is turned on, the reader will try to figure out the values of various options such as byte order, byte count etc.

automatically. This options works only for binary files. When it is turned on, the reader should be able to read most Plot3D files automatically. The default is OFF for backwards compatibility reasons. For binary files, it is strongly recommended that you turn on AutoDetectFormat and leave the other file format related options untouched.

◆ AutoDetectFormatOff()

virtual void vtkMultiBlockPLOT3DReader::AutoDetectFormatOff ( )

virtual

When this option is turned on, the reader will try to figure out the values of various options such as byte order, byte count etc.

automatically. This options works only for binary files. When it is turned on, the reader should be able to read most Plot3D files automatically. The default is OFF for backwards compatibility reasons. For binary files, it is strongly recommended that you turn on AutoDetectFormat and leave the other file format related options untouched.

◆ SetBinaryFile()

virtual void vtkMultiBlockPLOT3DReader::SetBinaryFile ( vtkTypeBool )

virtual

Is the file to be read written in binary format (as opposed to ascii).

◆ GetBinaryFile()

virtual vtkTypeBool vtkMultiBlockPLOT3DReader::GetBinaryFile ( )

virtual

Is the file to be read written in binary format (as opposed to ascii).

◆ BinaryFileOn()

virtual void vtkMultiBlockPLOT3DReader::BinaryFileOn ( )

virtual

Is the file to be read written in binary format (as opposed to ascii).

◆ BinaryFileOff()

virtual void vtkMultiBlockPLOT3DReader::BinaryFileOff ( )

virtual

Is the file to be read written in binary format (as opposed to ascii).

◆ SetMultiGrid()

virtual void vtkMultiBlockPLOT3DReader::SetMultiGrid ( vtkTypeBool )

virtual

Does the file to be read contain information about number of grids.

In some PLOT3D files, the first value contains the number of grids (even if there is only 1). If reading such a file, set this to true.

◆ GetMultiGrid()

virtual vtkTypeBool vtkMultiBlockPLOT3DReader::GetMultiGrid ( )

virtual

Does the file to be read contain information about number of grids.

In some PLOT3D files, the first value contains the number of grids (even if there is only 1). If reading such a file, set this to true.

◆ MultiGridOn()

virtual void vtkMultiBlockPLOT3DReader::MultiGridOn ( )

virtual

Does the file to be read contain information about number of grids.

In some PLOT3D files, the first value contains the number of grids (even if there is only 1). If reading such a file, set this to true.

◆ MultiGridOff()

virtual void vtkMultiBlockPLOT3DReader::MultiGridOff ( )

virtual

Does the file to be read contain information about number of grids.

In some PLOT3D files, the first value contains the number of grids (even if there is only 1). If reading such a file, set this to true.

◆ SetHasByteCount()

virtual void vtkMultiBlockPLOT3DReader::SetHasByteCount ( vtkTypeBool )

virtual

Were the arrays written with leading and trailing byte counts ? Usually, files written by a fortran program will contain these byte counts whereas the ones written by C/C++ won't.

◆ GetHasByteCount()

virtual vtkTypeBool vtkMultiBlockPLOT3DReader::GetHasByteCount ( )

virtual

Were the arrays written with leading and trailing byte counts ? Usually, files written by a fortran program will contain these byte counts whereas the ones written by C/C++ won't.

◆ HasByteCountOn()

virtual void vtkMultiBlockPLOT3DReader::HasByteCountOn ( )

virtual

Were the arrays written with leading and trailing byte counts ? Usually, files written by a fortran program will contain these byte counts whereas the ones written by C/C++ won't.

◆ HasByteCountOff()

virtual void vtkMultiBlockPLOT3DReader::HasByteCountOff ( )

virtual

Were the arrays written with leading and trailing byte counts ? Usually, files written by a fortran program will contain these byte counts whereas the ones written by C/C++ won't.

◆ SetIBlanking()

virtual void vtkMultiBlockPLOT3DReader::SetIBlanking ( vtkTypeBool )

virtual

Is there iblanking (point visibility) information in the file.

If there is iblanking arrays, these will be read and assigned to the PointVisibility array of the output.

◆ GetIBlanking()

virtual vtkTypeBool vtkMultiBlockPLOT3DReader::GetIBlanking ( )

virtual

Is there iblanking (point visibility) information in the file.

If there is iblanking arrays, these will be read and assigned to the PointVisibility array of the output.

◆ IBlankingOn()

virtual void vtkMultiBlockPLOT3DReader::IBlankingOn ( )

virtual

Is there iblanking (point visibility) information in the file.

If there is iblanking arrays, these will be read and assigned to the PointVisibility array of the output.

◆ IBlankingOff()

virtual void vtkMultiBlockPLOT3DReader::IBlankingOff ( )

virtual

Is there iblanking (point visibility) information in the file.

If there is iblanking arrays, these will be read and assigned to the PointVisibility array of the output.

◆ SetTwoDimensionalGeometry()

virtual void vtkMultiBlockPLOT3DReader::SetTwoDimensionalGeometry ( vtkTypeBool )

virtual

If only two-dimensional data was written to the file, turn this on.

◆ GetTwoDimensionalGeometry()

virtual vtkTypeBool vtkMultiBlockPLOT3DReader::GetTwoDimensionalGeometry ( )

virtual

If only two-dimensional data was written to the file, turn this on.

◆ TwoDimensionalGeometryOn()

virtual void vtkMultiBlockPLOT3DReader::TwoDimensionalGeometryOn ( )

virtual

If only two-dimensional data was written to the file, turn this on.

◆ TwoDimensionalGeometryOff()

virtual void vtkMultiBlockPLOT3DReader::TwoDimensionalGeometryOff ( )

virtual

If only two-dimensional data was written to the file, turn this on.

◆ SetDoublePrecision()

virtual void vtkMultiBlockPLOT3DReader::SetDoublePrecision ( vtkTypeBool )

virtual

Is this file in double precision or single precision.

This only matters for binary files. Default is single.

◆ GetDoublePrecision()

virtual vtkTypeBool vtkMultiBlockPLOT3DReader::GetDoublePrecision ( )

virtual

Is this file in double precision or single precision.

This only matters for binary files. Default is single.

◆ DoublePrecisionOn()

virtual void vtkMultiBlockPLOT3DReader::DoublePrecisionOn ( )

virtual

Is this file in double precision or single precision.

This only matters for binary files. Default is single.

◆ DoublePrecisionOff()

virtual void vtkMultiBlockPLOT3DReader::DoublePrecisionOff ( )

virtual

Is this file in double precision or single precision.

This only matters for binary files. Default is single.

◆ SetForceRead()

virtual void vtkMultiBlockPLOT3DReader::SetForceRead ( vtkTypeBool )

virtual

Try to read a binary file even if the file length seems to be inconsistent with the header information.

Use this with caution, if the file length is not the same as calculated from the header. either the file is corrupt or the settings are wrong.

◆ GetForceRead()

virtual vtkTypeBool vtkMultiBlockPLOT3DReader::GetForceRead ( )

virtual

Try to read a binary file even if the file length seems to be inconsistent with the header information.

Use this with caution, if the file length is not the same as calculated from the header. either the file is corrupt or the settings are wrong.

◆ ForceReadOn()

virtual void vtkMultiBlockPLOT3DReader::ForceReadOn ( )

virtual

Try to read a binary file even if the file length seems to be inconsistent with the header information.

Use this with caution, if the file length is not the same as calculated from the header. either the file is corrupt or the settings are wrong.

◆ ForceReadOff()

virtual void vtkMultiBlockPLOT3DReader::ForceReadOff ( )

virtual

Try to read a binary file even if the file length seems to be inconsistent with the header information.

Use this with caution, if the file length is not the same as calculated from the header. either the file is corrupt or the settings are wrong.

◆ SetByteOrderToBigEndian()

void vtkMultiBlockPLOT3DReader::SetByteOrderToBigEndian ( )

Set the byte order of the file (remember, more Unix workstations write big endian whereas PCs write little endian).

Default is big endian (since most older PLOT3D files were written by workstations).

◆ SetByteOrderToLittleEndian()

void vtkMultiBlockPLOT3DReader::SetByteOrderToLittleEndian ( )

Set the byte order of the file (remember, more Unix workstations write big endian whereas PCs write little endian).

Default is big endian (since most older PLOT3D files were written by workstations).

◆ SetByteOrder()

virtual void vtkMultiBlockPLOT3DReader::SetByteOrder ( int )

virtual

Set the byte order of the file (remember, more Unix workstations write big endian whereas PCs write little endian).

Default is big endian (since most older PLOT3D files were written by workstations).

◆ GetByteOrder()

virtual int vtkMultiBlockPLOT3DReader::GetByteOrder ( )

virtual

Set the byte order of the file (remember, more Unix workstations write big endian whereas PCs write little endian).

Default is big endian (since most older PLOT3D files were written by workstations).

◆ GetByteOrderAsString()

const char * vtkMultiBlockPLOT3DReader::GetByteOrderAsString ( )

Set the byte order of the file (remember, more Unix workstations write big endian whereas PCs write little endian).

Default is big endian (since most older PLOT3D files were written by workstations).

◆ SetR()

virtual void vtkMultiBlockPLOT3DReader::SetR ( double )

virtual

Set/Get the gas constant.

Default is 1.0.

◆ GetR()

virtual double vtkMultiBlockPLOT3DReader::GetR ( )

virtual

Set/Get the gas constant.

Default is 1.0.

◆ SetGamma()

virtual void vtkMultiBlockPLOT3DReader::SetGamma ( double )

virtual

Set/Get the ratio of specific heats.

Default is 1.4.

◆ GetGamma() [1/2]

virtual double vtkMultiBlockPLOT3DReader::GetGamma ( )

virtual

Set/Get the ratio of specific heats.

Default is 1.4.

◆ SetPreserveIntermediateFunctions()

virtual void vtkMultiBlockPLOT3DReader::SetPreserveIntermediateFunctions ( bool )

virtual

When set to true (default), the reader will preserve intermediate computed quantities that were not explicitly requested e.g.

if VelocityMagnitude is enabled, but not Velocity, the reader still needs to compute Velocity. If PreserveIntermediateFunctions if false, then the output will not have Velocity array, only the requested VelocityMagnitude. This is useful to avoid using up memory for arrays that are not relevant for the analysis.

◆ GetPreserveIntermediateFunctions()

virtual bool vtkMultiBlockPLOT3DReader::GetPreserveIntermediateFunctions ( )

virtual

When set to true (default), the reader will preserve intermediate computed quantities that were not explicitly requested e.g.

if VelocityMagnitude is enabled, but not Velocity, the reader still needs to compute Velocity. If PreserveIntermediateFunctions if false, then the output will not have Velocity array, only the requested VelocityMagnitude. This is useful to avoid using up memory for arrays that are not relevant for the analysis.

◆ PreserveIntermediateFunctionsOn()

virtual void vtkMultiBlockPLOT3DReader::PreserveIntermediateFunctionsOn ( )

virtual

When set to true (default), the reader will preserve intermediate computed quantities that were not explicitly requested e.g.

if VelocityMagnitude is enabled, but not Velocity, the reader still needs to compute Velocity. If PreserveIntermediateFunctions if false, then the output will not have Velocity array, only the requested VelocityMagnitude. This is useful to avoid using up memory for arrays that are not relevant for the analysis.

◆ PreserveIntermediateFunctionsOff()

virtual void vtkMultiBlockPLOT3DReader::PreserveIntermediateFunctionsOff ( )

virtual

When set to true (default), the reader will preserve intermediate computed quantities that were not explicitly requested e.g.

if VelocityMagnitude is enabled, but not Velocity, the reader still needs to compute Velocity. If PreserveIntermediateFunctions if false, then the output will not have Velocity array, only the requested VelocityMagnitude. This is useful to avoid using up memory for arrays that are not relevant for the analysis.

◆ SetScalarFunctionNumber()

void vtkMultiBlockPLOT3DReader::SetScalarFunctionNumber ( int num )

Specify the scalar function to extract.

If ==(-1), then no scalar function is extracted.

◆ GetScalarFunctionNumber()

virtual int vtkMultiBlockPLOT3DReader::GetScalarFunctionNumber ( )

virtual

When set to true (default), the reader will preserve intermediate computed quantities that were not explicitly requested e.g.

if VelocityMagnitude is enabled, but not Velocity, the reader still needs to compute Velocity. If PreserveIntermediateFunctions if false, then the output will not have Velocity array, only the requested VelocityMagnitude. This is useful to avoid using up memory for arrays that are not relevant for the analysis.

◆ SetVectorFunctionNumber()

void vtkMultiBlockPLOT3DReader::SetVectorFunctionNumber ( int num )

Specify the vector function to extract.

If ==(-1), then no vector function is extracted.

◆ GetVectorFunctionNumber()

virtual int vtkMultiBlockPLOT3DReader::GetVectorFunctionNumber ( )

virtual

Specify the vector function to extract.

If ==(-1), then no vector function is extracted.

◆ AddFunction()

void vtkMultiBlockPLOT3DReader::AddFunction ( int functionNumber )

Specify additional functions to read.

These are placed into the point data as data arrays. Later on they can be used by labeling them as scalars, etc.

◆ RemoveFunction()

void vtkMultiBlockPLOT3DReader::RemoveFunction ( int )

Specify additional functions to read.

These are placed into the point data as data arrays. Later on they can be used by labeling them as scalars, etc.

◆ RemoveAllFunctions()

void vtkMultiBlockPLOT3DReader::RemoveAllFunctions ( )

Specify additional functions to read.

These are placed into the point data as data arrays. Later on they can be used by labeling them as scalars, etc.

◆ CanReadBinaryFile()

virtual int vtkMultiBlockPLOT3DReader::CanReadBinaryFile ( VTK_FILEPATH const char * fname )

virtual

Return 1 if the reader can read the given file name.

Only meaningful for binary files.

◆ SetController()

void vtkMultiBlockPLOT3DReader::SetController ( vtkMultiProcessController * c )

Set/Get the communicator object (we'll use global World controller if you don't set a different one).

◆ GetController()

virtual vtkMultiProcessController * vtkMultiBlockPLOT3DReader::GetController ( )

virtual

Set/Get the communicator object (we'll use global World controller if you don't set a different one).

◆ AddFunctionName()

void vtkMultiBlockPLOT3DReader::AddFunctionName ( const std::string & name )

inline

Definition at line 479 of file vtkMultiBlockPLOT3DReader.h.

◆ ReadMetaData()

int vtkMultiBlockPLOT3DReader::ReadMetaData ( vtkInformation * metadata )

overridevirtual

These methods have to be overwritten from superclass because Plot3D actually uses the XYZ file to read these.

This is not recognized by the superclass which returns an error when a filename (Q filename) is not set.

Reimplemented from vtkParallelReader.

◆ ReadMesh() [1/2]

int vtkMultiBlockPLOT3DReader::ReadMesh	(	int	piece,
		int	npieces,
		int	nghosts,
		int	timestep,
		vtkDataObject *	output
	)

overridevirtual

These methods have to be overwritten from superclass because Plot3D actually uses the XYZ file to read these.

This is not recognized by the superclass which returns an error when a filename (Q filename) is not set.

Reimplemented from vtkParallelReader.

◆ ReadPoints() [1/2]

int vtkMultiBlockPLOT3DReader::ReadPoints	(	int	piece,
		int	npieces,
		int	nghosts,
		int	timestep,
		vtkDataObject *	output
	)

overridevirtual

These methods have to be overwritten from superclass because Plot3D actually uses the XYZ file to read these.

This is not recognized by the superclass which returns an error when a filename (Q filename) is not set.

Reimplemented from vtkParallelReader.

◆ ReadArrays() [1/2]

int vtkMultiBlockPLOT3DReader::ReadArrays	(	int	piece,
		int	npieces,
		int	nghosts,
		int	timestep,
		vtkDataObject *	output
	)

overridevirtual

These methods have to be overwritten from superclass because Plot3D actually uses the XYZ file to read these.

This is not recognized by the superclass which returns an error when a filename (Q filename) is not set.

Reimplemented from vtkParallelReader.

◆ GetTimeValue()

double vtkMultiBlockPLOT3DReader::GetTimeValue ( const std::string & fname )

overrideprotectedvirtual

Overridden from superclass to do actual reading.

Reimplemented from vtkParallelReader.

◆ ReadMesh() [2/2]

int vtkMultiBlockPLOT3DReader::ReadMesh	(	const std::string &	fname,
		int	piece,
		int	npieces,
		int	nghosts,
		vtkDataObject *	output
	)

overrideprotectedvirtual

Overridden from superclass to do actual reading.

Implements vtkParallelReader.

◆ ReadPoints() [2/2]

int vtkMultiBlockPLOT3DReader::ReadPoints	(	const std::string &	fname,
		int	piece,
		int	npieces,
		int	nghosts,
		vtkDataObject *	output
	)

overrideprotectedvirtual

Overridden from superclass to do actual reading.

Implements vtkParallelReader.

◆ ReadArrays() [2/2]

int vtkMultiBlockPLOT3DReader::ReadArrays	(	const std::string &	fname,
		int	piece,
		int	npieces,
		int	nghosts,
		vtkDataObject *	output
	)

overrideprotectedvirtual

Overridden from superclass to do actual reading.

Implements vtkParallelReader.

◆ CreateFloatArray()

vtkDataArray * vtkMultiBlockPLOT3DReader::CreateFloatArray ( )

protected

◆ CheckFile()

int vtkMultiBlockPLOT3DReader::CheckFile	(	FILE *&	fp,
		const char *	fname
	)

protected

◆ CheckGeometryFile()

int vtkMultiBlockPLOT3DReader::CheckGeometryFile ( FILE *& xyzFp )

protected

◆ CheckFunctionFile()

int vtkMultiBlockPLOT3DReader::CheckFunctionFile ( FILE *& fFp )

protected

◆ GetByteCountSize()

int vtkMultiBlockPLOT3DReader::GetByteCountSize ( )

protected

◆ SkipByteCount()

int vtkMultiBlockPLOT3DReader::SkipByteCount ( FILE * fp )

protected

◆ ReadIntBlock()

int vtkMultiBlockPLOT3DReader::ReadIntBlock	(	FILE *	fp,
		int	n,
		int *	block
	)

protected

◆ ReadValues()

vtkIdType vtkMultiBlockPLOT3DReader::ReadValues	(	FILE *	fp,
		int	n,
		vtkDataArray *	scalar
	)

protected

◆ ReadIntScalar()

virtual int vtkMultiBlockPLOT3DReader::ReadIntScalar	(	void *	vfp,
		int	extent[6],
		int	wextent[6],
		vtkDataArray *	scalar,
		vtkTypeUInt64	offset,
		const vtkMultiBlockPLOT3DReaderRecord &	currentRecord
	)

protectedvirtual

Reimplemented in vtkMPIMultiBlockPLOT3DReader.

◆ ReadScalar()

virtual int vtkMultiBlockPLOT3DReader::ReadScalar	(	void *	vfp,
		int	extent[6],
		int	wextent[6],
		vtkDataArray *	scalar,
		vtkTypeUInt64	offset,
		const vtkMultiBlockPLOT3DReaderRecord &	currentRecord
	)

protectedvirtual

Reimplemented in vtkMPIMultiBlockPLOT3DReader.

◆ ReadVector()

virtual int vtkMultiBlockPLOT3DReader::ReadVector	(	void *	vfp,
		int	extent[6],
		int	wextent[6],
		int	numDims,
		vtkDataArray *	vector,
		vtkTypeUInt64	offset,
		const vtkMultiBlockPLOT3DReaderRecord &	currentRecord
	)

protectedvirtual

Reimplemented in vtkMPIMultiBlockPLOT3DReader.

◆ OpenFileForDataRead()

virtual int vtkMultiBlockPLOT3DReader::OpenFileForDataRead	(	void *&	fp,
		const char *	fname
	)

protectedvirtual

Reimplemented in vtkMPIMultiBlockPLOT3DReader.

◆ CloseFile()

virtual void vtkMultiBlockPLOT3DReader::CloseFile ( void * fp )

protectedvirtual

Reimplemented in vtkMPIMultiBlockPLOT3DReader.

◆ GetNumberOfBlocksInternal()

int vtkMultiBlockPLOT3DReader::GetNumberOfBlocksInternal	(	FILE *	xyzFp,
		int	allocate
	)

protected

◆ ReadGeometryHeader()

int vtkMultiBlockPLOT3DReader::ReadGeometryHeader ( FILE * fp )

protected

◆ ReadQHeader()

int vtkMultiBlockPLOT3DReader::ReadQHeader	(	FILE *	fp,
		bool	checkGrid,
		int &	nq,
		int &	nqc,
		int &	overflow
	)

protected

◆ ReadFunctionHeader()

int vtkMultiBlockPLOT3DReader::ReadFunctionHeader	(	FILE *	fp,
		int *	nFunctions
	)

protected

◆ CalculateFileSize()

void vtkMultiBlockPLOT3DReader::CalculateFileSize ( FILE * fp )

protected

◆ AutoDetectionCheck()

int vtkMultiBlockPLOT3DReader::AutoDetectionCheck ( FILE * fp )

protected

◆ AssignAttribute()

void vtkMultiBlockPLOT3DReader::AssignAttribute	(	int	fNumber,
		vtkStructuredGrid *	output,
		int	attributeType
	)

protected

◆ MapFunction()

void vtkMultiBlockPLOT3DReader::MapFunction	(	int	fNumber,
		vtkStructuredGrid *	output
	)

protected