VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkMultiBlockPLOT3DReader Class Reference

read PLOT3D data files More...

#include <vtkMultiBlockPLOT3DReader.h>

Inheritance diagram for vtkMultiBlockPLOT3DReader:
[legend]
Collaboration diagram for vtkMultiBlockPLOT3DReader:
[legend]

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. More...
 
vtkMultiBlockPLOT3DReaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkMultiBlockDataSetGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkMultiBlockDataSetGetOutput (int)
 
void SetFileName (const char *name)
 Set/Get the PLOT3D geometry filename. More...
 
const char * GetFileName ()
 
const char * GetFileName (int i)
 
virtual void SetXYZFileName (const char *)
 
virtual char * GetXYZFileName ()
 
void SetQFileName (const char *name)
 Set/Get the PLOT3D solution filename. More...
 
const char * GetQFileName ()
 
virtual void SetFunctionFileName (const char *)
 Set/Get the PLOT3D function filename. More...
 
virtual char * GetFunctionFileName ()
 
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. More...
 
virtual vtkTypeBool GetAutoDetectFormat ()
 
virtual void AutoDetectFormatOn ()
 
virtual void AutoDetectFormatOff ()
 
virtual void SetBinaryFile (vtkTypeBool)
 Is the file to be read written in binary format (as opposed to ascii). More...
 
virtual vtkTypeBool GetBinaryFile ()
 
virtual void BinaryFileOn ()
 
virtual void BinaryFileOff ()
 
virtual void SetMultiGrid (vtkTypeBool)
 Does the file to be read contain information about number of grids. More...
 
virtual vtkTypeBool GetMultiGrid ()
 
virtual void MultiGridOn ()
 
virtual void MultiGridOff ()
 
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. More...
 
virtual vtkTypeBool GetHasByteCount ()
 
virtual void HasByteCountOn ()
 
virtual void HasByteCountOff ()
 
virtual void SetIBlanking (vtkTypeBool)
 Is there iblanking (point visibility) information in the file. More...
 
virtual vtkTypeBool GetIBlanking ()
 
virtual void IBlankingOn ()
 
virtual void IBlankingOff ()
 
virtual void SetTwoDimensionalGeometry (vtkTypeBool)
 If only two-dimensional data was written to the file, turn this on. More...
 
virtual vtkTypeBool GetTwoDimensionalGeometry ()
 
virtual void TwoDimensionalGeometryOn ()
 
virtual void TwoDimensionalGeometryOff ()
 
virtual void SetDoublePrecision (vtkTypeBool)
 Is this file in double precision or single precision. More...
 
virtual vtkTypeBool GetDoublePrecision ()
 
virtual void DoublePrecisionOn ()
 
virtual void DoublePrecisionOff ()
 
virtual void SetForceRead (vtkTypeBool)
 Try to read a binary file even if the file length seems to be inconsistent with the header information. More...
 
virtual vtkTypeBool GetForceRead ()
 
virtual void ForceReadOn ()
 
virtual void ForceReadOff ()
 
void SetByteOrderToBigEndian ()
 Set the byte order of the file (remember, more Unix workstations write big endian whereas PCs write little endian). More...
 
void SetByteOrderToLittleEndian ()
 
virtual void SetByteOrder (int)
 
virtual int GetByteOrder ()
 
const char * GetByteOrderAsString ()
 
virtual void SetR (double)
 Set/Get the gas constant. More...
 
virtual double GetR ()
 
virtual void SetGamma (double)
 Set/Get the ratio of specific heats. More...
 
virtual double GetGamma ()
 
virtual void SetPreserveIntermediateFunctions (bool)
 When set to true (default), the reader will preserve intermediate computed quantities that were not explicitly requested e.g. More...
 
virtual bool GetPreserveIntermediateFunctions ()
 
virtual void PreserveIntermediateFunctionsOn ()
 
virtual void PreserveIntermediateFunctionsOff ()
 
void SetScalarFunctionNumber (int num)
 Specify the scalar function to extract. More...
 
virtual int GetScalarFunctionNumber ()
 
void SetVectorFunctionNumber (int num)
 Specify the vector function to extract. More...
 
virtual int GetVectorFunctionNumber ()
 
void AddFunction (int functionNumber)
 Specify additional functions to read. More...
 
void RemoveFunction (int)
 
void RemoveAllFunctions ()
 
virtual int CanReadBinaryFile (const char *fname)
 Return 1 if the reader can read the given file name. More...
 
void SetController (vtkMultiProcessController *c)
 Set/Get the communicator object (we'll use global World controller if you don't set a different one). More...
 
virtual vtkMultiProcessControllerGetController ()
 
void AddFunctionName (const std::string &name)
 
int ReadMetaData (vtkInformation *metadata) override
 These methods have to be overwritten from superclass because Plot3D actually uses the XYZ file to read these. More...
 
int ReadMesh (int piece, int npieces, int nghosts, int timestep, vtkDataObject *output) override
 Read the mesh (connectivity) for a given set of data partitioning, number of ghost levels and time step (index). More...
 
int ReadPoints (int piece, int npieces, int nghosts, int timestep, vtkDataObject *output) override
 Read the points. More...
 
int ReadArrays (int piece, int npieces, int nghosts, int timestep, vtkDataObject *output) override
 Read all the arrays (point, cell, field etc.). More...
 
- Public Member Functions inherited from vtkParallelReader
vtkParallelReaderNewInstance () const
 
void AddFileName (const char *fname)
 Add a filename to be read. More...
 
void ClearFileNames ()
 Removes all filenames stored by the reader. More...
 
int GetNumberOfFileNames () const
 Returns the number of filenames stored by the reader. More...
 
const char * GetFileName (int i) const
 Returns a particular filename stored by the reader. More...
 
const char * GetCurrentFileName () const
 Returns the filename that was last loaded by the reader. More...
 
- Public Member Functions inherited from vtkReaderAlgorithm
vtkReaderAlgorithmNewInstance () const
 
virtual vtkDataObjectCreateOutput (vtkDataObject *currentOutput)
 This can be overridden by a subclass to create an output that is determined by the file being read. More...
 
virtual int ReadTimeDependentMetaData (int, vtkInformation *)
 Provide meta-data for the pipeline. More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
virtual vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
 Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality. 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...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
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 Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. 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 ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
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)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
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)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
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...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
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...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
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)
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
int * GetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkMultiBlockPLOT3DReaderNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkMultiBlockPLOT3DReaderSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkParallelReader
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkParallelReaderSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkReaderAlgorithm
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkReaderAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_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 vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
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 vtkObjectNew ()
 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 (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkMultiBlockPLOT3DReader ()
 
 ~vtkMultiBlockPLOT3DReader () override
 
double GetTimeValue (const std::string &fname) override
 Overridden from superclass to do actual reading. More...
 
int ReadMesh (const std::string &fname, int piece, int npieces, int nghosts, vtkDataObject *output) override
 A method that needs to be override by the subclass to provide the mesh (topology). More...
 
int ReadPoints (const std::string &fname, int piece, int npieces, int nghosts, vtkDataObject *output) override
 A method that needs to be override by the subclass to provide the point coordinates. More...
 
int ReadArrays (const std::string &fname, int piece, int npieces, int nghosts, vtkDataObject *output) override
 A method that needs to be override by the subclass to provide data arrays. More...
 
vtkDataArrayCreateFloatArray ()
 
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)
 
vtkDataArrayComputeTemperature (vtkStructuredGrid *output)
 Each of these methods compute a derived quantity. More...
 
vtkDataArrayComputePressure (vtkStructuredGrid *output)
 
vtkDataArrayComputeEnthalpy (vtkStructuredGrid *output)
 
vtkDataArrayComputeKineticEnergy (vtkStructuredGrid *output)
 
vtkDataArrayComputeVelocityMagnitude (vtkStructuredGrid *output)
 
vtkDataArrayComputeEntropy (vtkStructuredGrid *output)
 
vtkDataArrayComputeSwirl (vtkStructuredGrid *output)
 
vtkDataArrayComputeVelocity (vtkStructuredGrid *output)
 
vtkDataArrayComputeVorticity (vtkStructuredGrid *output)
 
vtkDataArrayComputePressureGradient (vtkStructuredGrid *output)
 
vtkDataArrayComputePressureCoefficient (vtkStructuredGrid *output)
 
vtkDataArrayComputeMachNumber (vtkStructuredGrid *output)
 
vtkDataArrayComputeSoundSpeed (vtkStructuredGrid *output)
 
vtkDataArrayComputeVorticityMagnitude (vtkStructuredGrid *output)
 
vtkDataArrayComputeStrainRate (vtkStructuredGrid *output)
 
vtkDataArrayNewFloatArray ()
 
void ClearGeometryCache ()
 
double GetGamma (vtkIdType idx, vtkDataArray *gamma)
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
- Protected Member Functions inherited from vtkParallelReader
 vtkParallelReader ()
 
 ~vtkParallelReader () override
 
vtkExecutiveCreateDefaultExecutive () override
 Create a default executive. More...
 
- Protected Member Functions inherited from vtkReaderAlgorithm
 vtkReaderAlgorithm ()
 
 ~vtkReaderAlgorithm () override
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 Fill the input port information objects for this algorithm. 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 assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
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)
 
vtkDataArrayGetInputArrayToProcess (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...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. 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)
 
- 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 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
 
vtkIntArrayFunctionList
 
int ScalarFunctionNumber
 
int VectorFunctionNumber
 
vtkMultiBlockPLOT3DReaderInternalsInternal
 
vtkMultiProcessControllerController
 
- Protected Attributes inherited from vtkParallelReader
int CurrentFileIndex
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- 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 vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

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

Definition at line 124 of file vtkMultiBlockPLOT3DReader.h.

Member Typedef Documentation

◆ Superclass

Definition at line 145 of file vtkMultiBlockPLOT3DReader.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
FILE_BIG_ENDIAN 
FILE_LITTLE_ENDIAN 

Definition at line 372 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  )

◆ SetFileName()

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

Set/Get the PLOT3D geometry filename.

Definition at line 160 of file vtkMultiBlockPLOT3DReader.h.

◆ GetFileName() [1/2]

const char* vtkMultiBlockPLOT3DReader::GetFileName ( )
inline

Definition at line 161 of file vtkMultiBlockPLOT3DReader.h.

◆ GetFileName() [2/2]

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

Definition at line 162 of file vtkMultiBlockPLOT3DReader.h.

◆ SetXYZFileName()

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

◆ GetXYZFileName()

virtual char* vtkMultiBlockPLOT3DReader::GetXYZFileName ( )
virtual

◆ SetQFileName()

void vtkMultiBlockPLOT3DReader::SetQFileName ( 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()

const char* vtkMultiBlockPLOT3DReader::GetQFileName ( )

◆ SetFunctionFileName()

virtual void vtkMultiBlockPLOT3DReader::SetFunctionFileName ( const char *  )
virtual

Set/Get the PLOT3D function filename.

◆ GetFunctionFileName()

virtual char* vtkMultiBlockPLOT3DReader::GetFunctionFileName ( )
virtual

◆ 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

◆ AutoDetectFormatOn()

virtual void vtkMultiBlockPLOT3DReader::AutoDetectFormatOn ( )
virtual

◆ AutoDetectFormatOff()

virtual void vtkMultiBlockPLOT3DReader::AutoDetectFormatOff ( )
virtual

◆ 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

◆ BinaryFileOn()

virtual void vtkMultiBlockPLOT3DReader::BinaryFileOn ( )
virtual

◆ BinaryFileOff()

virtual void vtkMultiBlockPLOT3DReader::BinaryFileOff ( )
virtual

◆ 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

◆ MultiGridOn()

virtual void vtkMultiBlockPLOT3DReader::MultiGridOn ( )
virtual

◆ MultiGridOff()

virtual void vtkMultiBlockPLOT3DReader::MultiGridOff ( )
virtual

◆ 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

◆ HasByteCountOn()

virtual void vtkMultiBlockPLOT3DReader::HasByteCountOn ( )
virtual

◆ HasByteCountOff()

virtual void vtkMultiBlockPLOT3DReader::HasByteCountOff ( )
virtual

◆ 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

◆ IBlankingOn()

virtual void vtkMultiBlockPLOT3DReader::IBlankingOn ( )
virtual

◆ IBlankingOff()

virtual void vtkMultiBlockPLOT3DReader::IBlankingOff ( )
virtual

◆ 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

◆ TwoDimensionalGeometryOn()

virtual void vtkMultiBlockPLOT3DReader::TwoDimensionalGeometryOn ( )
virtual

◆ TwoDimensionalGeometryOff()

virtual void vtkMultiBlockPLOT3DReader::TwoDimensionalGeometryOff ( )
virtual

◆ 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

◆ DoublePrecisionOn()

virtual void vtkMultiBlockPLOT3DReader::DoublePrecisionOn ( )
virtual

◆ DoublePrecisionOff()

virtual void vtkMultiBlockPLOT3DReader::DoublePrecisionOff ( )
virtual

◆ 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

◆ ForceReadOn()

virtual void vtkMultiBlockPLOT3DReader::ForceReadOn ( )
virtual

◆ ForceReadOff()

virtual void vtkMultiBlockPLOT3DReader::ForceReadOff ( )
virtual

◆ 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 ( )

◆ SetByteOrder()

virtual void vtkMultiBlockPLOT3DReader::SetByteOrder ( int  )
virtual

◆ GetByteOrder()

virtual int vtkMultiBlockPLOT3DReader::GetByteOrder ( )
virtual

◆ GetByteOrderAsString()

const char* vtkMultiBlockPLOT3DReader::GetByteOrderAsString ( )

◆ SetR()

virtual void vtkMultiBlockPLOT3DReader::SetR ( double  )
virtual

Set/Get the gas constant.

Default is 1.0.

◆ GetR()

virtual double vtkMultiBlockPLOT3DReader::GetR ( )
virtual

◆ 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

◆ 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

◆ PreserveIntermediateFunctionsOn()

virtual void vtkMultiBlockPLOT3DReader::PreserveIntermediateFunctionsOn ( )
virtual

◆ PreserveIntermediateFunctionsOff()

virtual void vtkMultiBlockPLOT3DReader::PreserveIntermediateFunctionsOff ( )
virtual

◆ 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

◆ 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

◆ 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  )

◆ RemoveAllFunctions()

void vtkMultiBlockPLOT3DReader::RemoveAllFunctions ( )

◆ CanReadBinaryFile()

virtual int vtkMultiBlockPLOT3DReader::CanReadBinaryFile ( 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

◆ AddFunctionName()

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

Definition at line 370 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

Read the mesh (connectivity) for a given set of data partitioning, number of ghost levels and time step (index).

The reader populates the data object passed in as the last argument. It is OK to read more than the mesh (points, arrays etc.). However, this may interfere with any caching implemented by the executive (i.e. cause more reads).

Reimplemented from vtkParallelReader.

◆ ReadPoints() [1/2]

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

Read the points.

The reader populates the input data object. This is called after ReadMesh() so the data object should already contain the mesh.

Reimplemented from vtkParallelReader.

◆ ReadArrays() [1/2]

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

Read all the arrays (point, cell, field etc.).

This is called after ReadPoints() so the data object should already contain the mesh and points.

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

A method that needs to be override by the subclass to provide the mesh (topology).

Note that the filename is passed to this method and should be used by the subclass. The subclass directly adds the structure/topology to the provided data object.

Implements vtkParallelReader.

◆ ReadPoints() [2/2]

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

A method that needs to be override by the subclass to provide the point coordinates.

Note that the filename is passed to this method and should be used by the subclass. The subclass directly adds the coordinates to the provided data object.

Implements vtkParallelReader.

◆ ReadArrays() [2/2]

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

A method that needs to be override by the subclass to provide data arrays.

Note that the filename is passed to this method and should be used by the subclass. The subclass directly adds data arrays to the provided data object.

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

◆ ComputeTemperature()

vtkDataArray* vtkMultiBlockPLOT3DReader::ComputeTemperature ( vtkStructuredGrid output)
protected

Each of these methods compute a derived quantity.

On success, the array is added to the output and a pointer to the same is returned.

◆ ComputePressure()

vtkDataArray* vtkMultiBlockPLOT3DReader::ComputePressure ( vtkStructuredGrid output)
protected

◆ ComputeEnthalpy()

vtkDataArray* vtkMultiBlockPLOT3DReader::ComputeEnthalpy ( vtkStructuredGrid output)
protected

◆ ComputeKineticEnergy()

vtkDataArray* vtkMultiBlockPLOT3DReader::ComputeKineticEnergy ( vtkStructuredGrid output)
protected

◆ ComputeVelocityMagnitude()

vtkDataArray* vtkMultiBlockPLOT3DReader::ComputeVelocityMagnitude ( vtkStructuredGrid output)
protected

◆ ComputeEntropy()

vtkDataArray* vtkMultiBlockPLOT3DReader::ComputeEntropy ( vtkStructuredGrid output)
protected

◆ ComputeSwirl()

vtkDataArray* vtkMultiBlockPLOT3DReader::ComputeSwirl ( vtkStructuredGrid output)
protected

◆ ComputeVelocity()

vtkDataArray* vtkMultiBlockPLOT3DReader::ComputeVelocity ( vtkStructuredGrid output)
protected

◆ ComputeVorticity()

vtkDataArray* vtkMultiBlockPLOT3DReader::ComputeVorticity ( vtkStructuredGrid output)
protected

◆ ComputePressureGradient()

vtkDataArray* vtkMultiBlockPLOT3DReader::ComputePressureGradient ( vtkStructuredGrid output)
protected

◆ ComputePressureCoefficient()

vtkDataArray* vtkMultiBlockPLOT3DReader::ComputePressureCoefficient ( vtkStructuredGrid output)
protected

◆ ComputeMachNumber()

vtkDataArray* vtkMultiBlockPLOT3DReader::ComputeMachNumber ( vtkStructuredGrid output)
protected

◆ ComputeSoundSpeed()

vtkDataArray* vtkMultiBlockPLOT3DReader::ComputeSoundSpeed ( vtkStructuredGrid output)
protected

◆ ComputeVorticityMagnitude()

vtkDataArray* vtkMultiBlockPLOT3DReader::ComputeVorticityMagnitude ( vtkStructuredGrid output)
protected

◆ ComputeStrainRate()

vtkDataArray* vtkMultiBlockPLOT3DReader::ComputeStrainRate ( vtkStructuredGrid output)
protected

◆ NewFloatArray()

vtkDataArray* vtkMultiBlockPLOT3DReader::NewFloatArray ( )
protected

◆ ClearGeometryCache()

void vtkMultiBlockPLOT3DReader::ClearGeometryCache ( )
protected

◆ GetGamma() [2/2]

double vtkMultiBlockPLOT3DReader::GetGamma ( vtkIdType  idx,
vtkDataArray gamma 
)
protected

◆ FillOutputPortInformation()

int vtkMultiBlockPLOT3DReader::FillOutputPortInformation ( int  port,
vtkInformation info 
)
overrideprotectedvirtual

Fill the output port information objects for this algorithm.

This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkAlgorithm.

Friends And Related Function Documentation

◆ Functors::ComputeFunctor

friend class Functors::ComputeFunctor
friend

Definition at line 126 of file vtkMultiBlockPLOT3DReader.h.

◆ Functors::ComputeTemperatureFunctor

friend class Functors::ComputeTemperatureFunctor
friend

Definition at line 127 of file vtkMultiBlockPLOT3DReader.h.

◆ Functors::ComputePressureFunctor

friend class Functors::ComputePressureFunctor
friend

Definition at line 128 of file vtkMultiBlockPLOT3DReader.h.

◆ Functors::ComputePressureCoefficientFunctor

friend class Functors::ComputePressureCoefficientFunctor
friend

Definition at line 129 of file vtkMultiBlockPLOT3DReader.h.

◆ Functors::ComputeMachNumberFunctor

friend class Functors::ComputeMachNumberFunctor
friend

Definition at line 130 of file vtkMultiBlockPLOT3DReader.h.

◆ Functors::ComputeSoundSpeedFunctor

friend class Functors::ComputeSoundSpeedFunctor
friend

Definition at line 131 of file vtkMultiBlockPLOT3DReader.h.

◆ Functors::ComputeEnthalpyFunctor

friend class Functors::ComputeEnthalpyFunctor
friend

Definition at line 132 of file vtkMultiBlockPLOT3DReader.h.

◆ Functors::ComputeKinecticEnergyFunctor

friend class Functors::ComputeKinecticEnergyFunctor
friend

Definition at line 133 of file vtkMultiBlockPLOT3DReader.h.

◆ Functors::ComputeVelocityMagnitudeFunctor

friend class Functors::ComputeVelocityMagnitudeFunctor
friend

Definition at line 134 of file vtkMultiBlockPLOT3DReader.h.

◆ Functors::ComputeEntropyFunctor

friend class Functors::ComputeEntropyFunctor
friend

Definition at line 135 of file vtkMultiBlockPLOT3DReader.h.

◆ Functors::ComputeSwirlFunctor

friend class Functors::ComputeSwirlFunctor
friend

Definition at line 136 of file vtkMultiBlockPLOT3DReader.h.

◆ Functors::ComputeVelocityFunctor

friend class Functors::ComputeVelocityFunctor
friend

Definition at line 137 of file vtkMultiBlockPLOT3DReader.h.

◆ Functors::ComputeVorticityMagnitudeFunctor

friend class Functors::ComputeVorticityMagnitudeFunctor
friend

Definition at line 138 of file vtkMultiBlockPLOT3DReader.h.

◆ Functors::ComputePressureGradientFunctor

friend class Functors::ComputePressureGradientFunctor
friend

Definition at line 139 of file vtkMultiBlockPLOT3DReader.h.

◆ Functors::ComputeVorticityFunctor

friend class Functors::ComputeVorticityFunctor
friend

Definition at line 140 of file vtkMultiBlockPLOT3DReader.h.

◆ Functors::ComputeStrainRateFunctor

friend class Functors::ComputeStrainRateFunctor
friend

Definition at line 141 of file vtkMultiBlockPLOT3DReader.h.

Member Data Documentation

◆ XYZFileName

char* vtkMultiBlockPLOT3DReader::XYZFileName
protected

Definition at line 478 of file vtkMultiBlockPLOT3DReader.h.

◆ QFileName

char* vtkMultiBlockPLOT3DReader::QFileName
protected

Definition at line 479 of file vtkMultiBlockPLOT3DReader.h.

◆ FunctionFileName

char* vtkMultiBlockPLOT3DReader::FunctionFileName
protected

Definition at line 480 of file vtkMultiBlockPLOT3DReader.h.

◆ BinaryFile

vtkTypeBool vtkMultiBlockPLOT3DReader::BinaryFile
protected

Definition at line 481 of file vtkMultiBlockPLOT3DReader.h.

◆ HasByteCount

vtkTypeBool vtkMultiBlockPLOT3DReader::HasByteCount
protected

Definition at line 482 of file vtkMultiBlockPLOT3DReader.h.

◆ TwoDimensionalGeometry

vtkTypeBool vtkMultiBlockPLOT3DReader::TwoDimensionalGeometry
protected

Definition at line 483 of file vtkMultiBlockPLOT3DReader.h.

◆ MultiGrid

vtkTypeBool vtkMultiBlockPLOT3DReader::MultiGrid
protected

Definition at line 484 of file vtkMultiBlockPLOT3DReader.h.

◆ ForceRead

vtkTypeBool vtkMultiBlockPLOT3DReader::ForceRead
protected

Definition at line 485 of file vtkMultiBlockPLOT3DReader.h.

◆ ByteOrder

int vtkMultiBlockPLOT3DReader::ByteOrder
protected

Definition at line 486 of file vtkMultiBlockPLOT3DReader.h.

◆ IBlanking

vtkTypeBool vtkMultiBlockPLOT3DReader::IBlanking
protected

Definition at line 487 of file vtkMultiBlockPLOT3DReader.h.

◆ DoublePrecision

vtkTypeBool vtkMultiBlockPLOT3DReader::DoublePrecision
protected

Definition at line 488 of file vtkMultiBlockPLOT3DReader.h.

◆ AutoDetectFormat

vtkTypeBool vtkMultiBlockPLOT3DReader::AutoDetectFormat
protected

Definition at line 489 of file vtkMultiBlockPLOT3DReader.h.

◆ ExecutedGhostLevels

int vtkMultiBlockPLOT3DReader::ExecutedGhostLevels
protected

Definition at line 491 of file vtkMultiBlockPLOT3DReader.h.

◆ FileSize

size_t vtkMultiBlockPLOT3DReader::FileSize
protected

Definition at line 493 of file vtkMultiBlockPLOT3DReader.h.

◆ R

double vtkMultiBlockPLOT3DReader::R
protected

Definition at line 496 of file vtkMultiBlockPLOT3DReader.h.

◆ Gamma

double vtkMultiBlockPLOT3DReader::Gamma
protected

Definition at line 497 of file vtkMultiBlockPLOT3DReader.h.

◆ GammaInf

double vtkMultiBlockPLOT3DReader::GammaInf
protected

Definition at line 498 of file vtkMultiBlockPLOT3DReader.h.

◆ PreserveIntermediateFunctions

bool vtkMultiBlockPLOT3DReader::PreserveIntermediateFunctions
protected

Definition at line 500 of file vtkMultiBlockPLOT3DReader.h.

◆ FunctionNames

std::vector<std::string> vtkMultiBlockPLOT3DReader::FunctionNames
protected

Definition at line 503 of file vtkMultiBlockPLOT3DReader.h.

◆ FunctionList

vtkIntArray* vtkMultiBlockPLOT3DReader::FunctionList
protected

Definition at line 506 of file vtkMultiBlockPLOT3DReader.h.

◆ ScalarFunctionNumber

int vtkMultiBlockPLOT3DReader::ScalarFunctionNumber
protected

Definition at line 508 of file vtkMultiBlockPLOT3DReader.h.

◆ VectorFunctionNumber

int vtkMultiBlockPLOT3DReader::VectorFunctionNumber
protected

Definition at line 509 of file vtkMultiBlockPLOT3DReader.h.

◆ Internal

vtkMultiBlockPLOT3DReaderInternals* vtkMultiBlockPLOT3DReader::Internal
protected

Definition at line 511 of file vtkMultiBlockPLOT3DReader.h.

◆ Controller

vtkMultiProcessController* vtkMultiBlockPLOT3DReader::Controller
protected

Definition at line 513 of file vtkMultiBlockPLOT3DReader.h.


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