vtkPLOT3DReader Class Reference

#include <vtkPLOT3DReader.h>

Inheritance diagram for vtkPLOT3DReader:

[legend]

Collaboration diagram for vtkPLOT3DReader:

[legend]

List of all members.

Detailed Description

read PLOT3D data files

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

The reader can generate additional scalars and vectors (or "functions") from this information. To use vtkPLOT3DReader, 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 120 - temperature 130 - enthalpy 140 - internal energy 144 - kinetic energy 153 - velocity magnitude 163 - stagnation energy 170 - entropy 184 - swirl.

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

(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) 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:: vtkStructuredGridSource vtkStructuredGrid

Examples:: vtkPLOT3DReader (Examples)

Tests:: vtkPLOT3DReader (Tests)

Definition at line 91 of file vtkPLOT3DReader.h.


Public Types
enum	{ FILE_BIG_ENDIAN = 0, FILE_LITTLE_ENDIAN = 1 }
typedef vtkStructuredGridSource	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetOutput (int idx, vtkStructuredGrid *output)
virtual int	CanReadBinaryFile (const char *fname)

void	SetFileName (const char *name)
const char *	GetFileName ()
virtual void	SetXYZFileName (const char *)
virtual char *	GetXYZFileName ()

virtual void	SetQFileName (const char *)
virtual char *	GetQFileName ()

virtual void	SetFunctionFileName (const char *)
virtual char *	GetFunctionFileName ()

int	GetNumberOfOutputs ()
int	GetNumberOfGrids ()

virtual void	SetBinaryFile (int)
virtual int	GetBinaryFile ()
virtual void	BinaryFileOn ()
virtual void	BinaryFileOff ()

virtual void	SetMultiGrid (int)
virtual int	GetMultiGrid ()
virtual void	MultiGridOn ()
virtual void	MultiGridOff ()

virtual void	SetHasByteCount (int)
virtual int	GetHasByteCount ()
virtual void	HasByteCountOn ()
virtual void	HasByteCountOff ()

virtual void	SetIBlanking (int)
virtual int	GetIBlanking ()
virtual void	IBlankingOn ()
virtual void	IBlankingOff ()

virtual void	SetTwoDimensionalGeometry (int)
virtual int	GetTwoDimensionalGeometry ()
virtual void	TwoDimensionalGeometryOn ()
virtual void	TwoDimensionalGeometryOff ()

virtual void	SetForceRead (int)
virtual int	GetForceRead ()
virtual void	ForceReadOn ()
virtual void	ForceReadOff ()

virtual void	SetDoNotReduceNumberOfOutputs (int)
virtual int	GetDoNotReduceNumberOfOutputs ()
virtual void	DoNotReduceNumberOfOutputsOn ()
virtual void	DoNotReduceNumberOfOutputsOff ()

void	SetByteOrderToBigEndian ()
void	SetByteOrderToLittleEndian ()
virtual void	SetByteOrder (int)
virtual int	GetByteOrder ()
const char *	GetByteOrderAsString ()

virtual void	SetR (double)
virtual double	GetR ()

virtual void	SetGamma (double)
virtual double	GetGamma ()

virtual void	SetUvinf (double)
virtual double	GetUvinf ()

virtual void	SetVvinf (double)
virtual double	GetVvinf ()

virtual void	SetWvinf (double)
virtual double	GetWvinf ()

void	SetScalarFunctionNumber (int num)
virtual int	GetScalarFunctionNumber ()

void	SetVectorFunctionNumber (int num)
virtual int	GetVectorFunctionNumber ()

void	AddFunction (int functionNumber)
void	RemoveFunction (int)
void	RemoveAllFunctions ()
Static Public Member Functions
static vtkPLOT3DReader *	New ()
static int	IsTypeOf (const char *type)
static vtkPLOT3DReader *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkPLOT3DReader ()
	~vtkPLOT3DReader ()
void	ExecuteInformation ()
void	Execute ()
int	CheckFile (FILE &fp, const char fname)
int	CheckGeometryFile (FILE *&xyzFp)
int	CheckSolutionFile (FILE *&qFp)
int	CheckFunctionFile (FILE *&fFp)
void	SkipByteCount (FILE *fp)
int	ReadIntBlock (FILE fp, int n, int block)
int	ReadFloatBlock (FILE fp, int n, float block)
int	GetNumberOfOutputsInternal (FILE *xyzFp, int verify=1)
int	ReadGeometryHeader (FILE *fp)
int	ReadQHeader (FILE *fp)
int	ReadFunctionHeader (FILE fp, vtkIdList &counts)
void	CalculateFileSize (FILE *fp)
long	EstimateSize (int ni, int nj, int nk)
void	AssignAttribute (int fNumber, vtkStructuredGrid *output, int attributeType)
void	MapFunction (int fNumber, vtkStructuredGrid *output)
void	ComputeTemperature (vtkStructuredGrid *output)
void	ComputePressure (vtkStructuredGrid *output)
void	ComputeEnthalpy (vtkStructuredGrid *output)
void	ComputeKineticEnergy (vtkStructuredGrid *output)
void	ComputeVelocityMagnitude (vtkStructuredGrid *output)
void	ComputeEntropy (vtkStructuredGrid *output)
void	ComputeSwirl (vtkStructuredGrid *output)
void	ComputeVelocity (vtkStructuredGrid *output)
void	ComputeVorticity (vtkStructuredGrid *output)
void	ComputePressureGradient (vtkStructuredGrid *output)
void	ClearGeometryCache ()
void	ReadIntBlockV (char *buf, int n, int block)
void	SkipByteCountV (char **buf)
Protected Attributes
char *	XYZFileName
char *	QFileName
char *	FunctionFileName
int	BinaryFile
int	HasByteCount
int	TwoDimensionalGeometry
int	MultiGrid
int	ForceRead
int	ByteOrder
int	IBlanking
int	DoNotReduceNumberOfOutputs
long	FileSize
double	R
double	Gamma
double	Uvinf
double	Vvinf
double	Wvinf
vtkIntArray *	FunctionList
int	ScalarFunctionNumber
int	VectorFunctionNumber
vtkFloatArray **	PointCache
vtkUnsignedCharArray **	IBlankCache

Member Typedef Documentation

typedef vtkStructuredGridSource vtkPLOT3DReader::Superclass

Reimplemented from vtkStructuredGridSource.

Definition at line 95 of file vtkPLOT3DReader.h.

Member Enumeration Documentation

anonymous enum

Enumerator:

FILE_BIG_ENDIAN
FILE_LITTLE_ENDIAN

Definition at line 264 of file vtkPLOT3DReader.h.

Constructor & Destructor Documentation

vtkPLOT3DReader::vtkPLOT3DReader ( ) [protected]

vtkPLOT3DReader::~vtkPLOT3DReader ( ) [protected]

Member Function Documentation

static vtkPLOT3DReader* vtkPLOT3DReader::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkAlgorithm.

virtual const char* vtkPLOT3DReader::GetClassName ( ) [virtual]

Reimplemented from vtkStructuredGridSource.

static int vtkPLOT3DReader::IsTypeOf ( const char * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkStructuredGridSource.

virtual int vtkPLOT3DReader::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkStructuredGridSource.

static vtkPLOT3DReader* vtkPLOT3DReader::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkStructuredGridSource.

void vtkPLOT3DReader::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

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

void vtkPLOT3DReader::SetFileName ( const char * name ) [inline]

Set/Get the PLOT3D geometry filename.

Definition at line 100 of file vtkPLOT3DReader.h.

const char* vtkPLOT3DReader::GetFileName ( ) [inline]

Set/Get the PLOT3D geometry filename.

Definition at line 101 of file vtkPLOT3DReader.h.

virtual void vtkPLOT3DReader::SetXYZFileName ( const char * ) [virtual]

Set/Get the PLOT3D geometry filename.

virtual char* vtkPLOT3DReader::GetXYZFileName ( ) [virtual]

Set/Get the PLOT3D geometry filename.

virtual void vtkPLOT3DReader::SetQFileName ( const char * ) [virtual]

Set/Get the PLOT3D solution filename.

virtual char* vtkPLOT3DReader::GetQFileName ( ) [virtual]

Set/Get the PLOT3D solution filename.

virtual void vtkPLOT3DReader::SetFunctionFileName ( const char * ) [virtual]

Set/Get the PLOT3D Function Filename (optional)

virtual char* vtkPLOT3DReader::GetFunctionFileName ( ) [virtual]

Set/Get the PLOT3D Function Filename (optional)

int vtkPLOT3DReader::GetNumberOfOutputs ( ) [virtual]

This returns the number of outputs this reader will produce. This number is equal to the number of grids in the current file. This method has to be called before getting any output if the number of outputs will be greater than 1 (the first output is always the same). Note that every time this method is invoked, the header file is opened and part of the header is read.

Reimplemented from vtkSource.

int vtkPLOT3DReader::GetNumberOfGrids ( ) [inline]

This returns the number of outputs this reader will produce. This number is equal to the number of grids in the current file. This method has to be called before getting any output if the number of outputs will be greater than 1 (the first output is always the same). Note that every time this method is invoked, the header file is opened and part of the header is read.

Definition at line 126 of file vtkPLOT3DReader.h.

void vtkPLOT3DReader::SetOutput	(	int	idx,
		vtkStructuredGrid *	output
	)

Replace an output.

virtual void vtkPLOT3DReader::SetBinaryFile ( int ) [virtual]

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

virtual int vtkPLOT3DReader::GetBinaryFile ( ) [virtual]

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

virtual void vtkPLOT3DReader::BinaryFileOn ( ) [virtual]

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

virtual void vtkPLOT3DReader::BinaryFileOff ( ) [virtual]

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

virtual void vtkPLOT3DReader::SetMultiGrid ( int ) [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.

virtual int vtkPLOT3DReader::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.

virtual void vtkPLOT3DReader::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.

virtual void vtkPLOT3DReader::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.

virtual void vtkPLOT3DReader::SetHasByteCount ( int ) [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.

virtual int vtkPLOT3DReader::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.

virtual void vtkPLOT3DReader::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.

virtual void vtkPLOT3DReader::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.

virtual void vtkPLOT3DReader::SetIBlanking ( int ) [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.

virtual int vtkPLOT3DReader::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.

virtual void vtkPLOT3DReader::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.

virtual void vtkPLOT3DReader::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.

virtual void vtkPLOT3DReader::SetTwoDimensionalGeometry ( int ) [virtual]

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

virtual int vtkPLOT3DReader::GetTwoDimensionalGeometry ( ) [virtual]

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

virtual void vtkPLOT3DReader::TwoDimensionalGeometryOn ( ) [virtual]

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

virtual void vtkPLOT3DReader::TwoDimensionalGeometryOff ( ) [virtual]

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

virtual void vtkPLOT3DReader::SetForceRead ( int ) [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.

virtual int vtkPLOT3DReader::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.

virtual void vtkPLOT3DReader::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.

virtual void vtkPLOT3DReader::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.

virtual void vtkPLOT3DReader::SetDoNotReduceNumberOfOutputs ( int ) [virtual]

If this is on, the reader will never reduce the number of outputs after reading a file with n grids and producing n outputs. If the file read afterwards contains fewer grids, the extra outputs will be empty. This option can be used by application which rely on the initial number of outputs not shrinking.

virtual int vtkPLOT3DReader::GetDoNotReduceNumberOfOutputs ( ) [virtual]

If this is on, the reader will never reduce the number of outputs after reading a file with n grids and producing n outputs. If the file read afterwards contains fewer grids, the extra outputs will be empty. This option can be used by application which rely on the initial number of outputs not shrinking.

virtual void vtkPLOT3DReader::DoNotReduceNumberOfOutputsOn ( ) [virtual]

If this is on, the reader will never reduce the number of outputs after reading a file with n grids and producing n outputs. If the file read afterwards contains fewer grids, the extra outputs will be empty. This option can be used by application which rely on the initial number of outputs not shrinking.

virtual void vtkPLOT3DReader::DoNotReduceNumberOfOutputsOff ( ) [virtual]

If this is on, the reader will never reduce the number of outputs after reading a file with n grids and producing n outputs. If the file read afterwards contains fewer grids, the extra outputs will be empty. This option can be used by application which rely on the initial number of outputs not shrinking.

void vtkPLOT3DReader::SetByteOrderToBigEndian ( )