Documentation for vtkPLOT3DReader

vtkPLOT3DReader - read PLOT3D data files

Description:

vtkPLOT3DReader is a reader object that reads PLOT3D formatted files and generates a structured grid 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. 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). 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. The format of the function file is as follows. An integer indicating number of grids, then an integer specifying number of functions per each grid. This is followed by the (integer) dimensions of each grid in the file. Finally, for each grid, and for each function, a float value per each point in the current grid. Note: if both a function from the function file is specified, as well as a scalar from the solution file (or derived from the solution file), the function file takes precedence.

Methods:

	void vtkPLOT3DReader ()
	void vtkPLOT3DReader ()
	static vtkPLOT3DReader *New ()
	const char *GetClassName ()
	void PrintSelf (unknown & ,vtkIndent )
	void SetFileFormat (int )
	int GetFileFormat ()
	void SetXYZFileName (char *)
	char *GetXYZFileName ()
	void SetQFileName (char *)
	char *GetQFileName ()
	void SetFunctionFileName (char *)
	char *GetFunctionFileName ()
	void SetVectorFunctionFileName (char *)
	char *GetVectorFunctionFileName ()
	void SetGridNumber (int )
	int GetGridNumber ()
	void SetScalarFunctionNumber (int )
	int GetScalarFunctionNumber ()
	void SetVectorFunctionNumber (int )
	int GetVectorFunctionNumber ()
	float GetFsmach ()
	float GetAlpha ()
	float GetRe ()
	float GetTime ()
	void SetR (float )
	float GetR ()
	void SetGamma (float )
	float GetGamma ()
	void SetUvinf (float )
	float GetUvinf ()
	void SetVvinf (float )
	float GetVvinf ()
	void SetWvinf (float )
	float GetWvinf ()
	void Execute ()
	int GetFileType (unknown *)
	void MapFunction (int ,vtkPointData *)
	int ReadBinaryGrid (unknown * ,vtkStructuredGrid *)
	int ReadBinarySolution (unknown * ,vtkStructuredGrid *)
	int ReadBinaryFunctionFile (unknown * ,vtkStructuredGrid *)
	int ReadBinaryVectorFunctionFile (unknown * ,vtkStructuredGrid *)
	void ComputeDensity (vtkPointData *)
	void ComputePressure (vtkPointData *)
	void ComputeTemperature (vtkPointData *)
	void ComputeEnthalpy (vtkPointData *)
	void ComputeInternalEnergy (vtkPointData *)
	void ComputeKineticEnergy (vtkPointData *)
	void ComputeVelocityMagnitude (vtkPointData *)
	void ComputeStagnationEnergy (vtkPointData *)
	void ComputeEntropy (vtkPointData *)
	void ComputeSwirl (vtkPointData *)
	void ComputeVelocity (vtkPointData *)
	void ComputeVorticity (vtkPointData *)
	void ComputeMomentum (vtkPointData *)
	void ComputePressureGradient (vtkPointData *)

Detailed Method Descriptions:

Specify the PLOT3D file format to use

	void SetFileFormat (int )
	int GetFileFormat ()

Set/Get the PLOT3D geometry FileName.

	void SetXYZFileName (char *)
	char *GetXYZFileName ()

Set/Get the PLOT3D solution FileName.

	void SetQFileName (char *)
	char *GetQFileName ()

Set/Get the PLOT3D function FileName.

	void SetFunctionFileName (char *)
	char *GetFunctionFileName ()

Set/Get the PLOT3D vector FileName.

	void SetVectorFunctionFileName (char *)
	char *GetVectorFunctionFileName ()

Specify the grid to read.

	void SetGridNumber (int )
	int GetGridNumber ()

Specify the scalar function to extract. If ==(-1), then no scalar function is extracted.

	void SetScalarFunctionNumber (int )
	int GetScalarFunctionNumber ()

Specify the vector function to extract. If ==(-1), then no vector function is extracted.

	void SetVectorFunctionNumber (int )
	int GetVectorFunctionNumber ()

Get the free-stream mach number.

float GetFsmach ()

Get the angle of attack.

float GetAlpha ()

Get the Reynold's number.

float GetRe ()

Get the total integration time.

float GetTime ()

Set/Get the gas constant.

	void SetR (float )
	float GetR ()

Set/Get the ratio of specific heats.

	void SetGamma (float )
	float GetGamma ()

Set/Get the x-component of the free-stream velocity.

	void SetUvinf (float )
	float GetUvinf ()

Set/Get the y-component of the free-stream velocity.

	void SetVvinf (float )
	float GetVvinf ()

Set/Get the z-component of the free-stream velocity.

	void SetWvinf (float )
	float GetWvinf ()