---

CGNS::DataArray Class Reference

#include <cgns++.h>

Inherits CGNS::Dimensioned.

Inheritance diagram for CGNS::DataArray:

[legend]List of all members.

Public Types
typedef char	CHAR_t
typedef int	INT_t
typedef float	FLOAT_t
typedef FLOAT_t	REAL4_t
typedef double	DOUBLE_t
typedef DOUBLE_t	REAL8_t
enum	Quantity {   NULL_DATA, COORDINATE_X, COORDINATE_Y, COORDINATE_Z,   COORDINATE_R, COORDINATE_THETA, COORDINATE_PHI, COORDINATE_NORMAL,   COORDINATE_TANGENTIAL, COORDINATE_XI, COORDINATE_ETA, COORDINATE_ZETA,   COORDINATE_TRANSFORM, INTERPOLANTS_DONOR, ELEMENT_CONNECTIVITY, PARENT_DATA,   POTENTIAL, STREAM_FUNCTION, DENSITY, PRESSURE,   TEMPERATURE, ENERGY_INTERNAL, ENTHALPY, ENTROPY,   ENTROPY_APPROX, DENSITY_STAGNATION, PRESSURE_STAGNATION, TEMPERATURE_STAGNATION,   ENERGY_STAGNATION, ENTHALPY_STAGNATION, ENERGY_STAGNATION_DENSITY, VELOCITY_X,   VELOCITY_Y, VELOCITY_Z, VELOCITY_R, VELOCITY_THETA,   VELOCITY_PHI, VELOCITY_MAGNITUDE, VELOCITY_NORMAL, VELOCITY_TANGENTIAL,   VELOCITY_SOUND, VELOCITY_SOUND_STAGNATION, MOMENTUM_X, MOMENTUM_Y,   MOMENTUM_Z, MOMENTUM_MAGNITUDE, ENERGY_KINETIC, PRESSURE_DYNAMIC,   VORTICITY_X, VORTICITY_Y, VORTICITY_Z, VORTICITY_MAGNITUDE,   SKIN_FRICTION_X, SKIN_FRICTION_Y, SKIN_FRICTION_Z, SKIN_FRICTION_MAGNITUDE,   VELOCITY_ANGLE_X, VELOCITY_ANGLE_Y, VELOCITY_ANGLE_Z, VELOCITY_UNIT_VECTOR_X,   VELOCITY_UNIT_VECTOR_Y, VELOCITY_UNIT_VECTOR_Z, MASS_FLOW, VISCOSITY_KINEMATIC,   VISCOSITY_MOLECULAR, VISCOSITY_EDDY_KINEMATIC, VISCOSITY_EDDY, THERMAL_CONDUCTIVITY,   REYNOLDS_STRESS_XX, REYNOLDS_STRESS_XY, REYNOLDS_STRESS_XZ, REYNOLDS_STRESS_YY,   REYNOLDS_STRESS_YZ, REYNOLDS_STRESS_ZZ, POWER_LAW_EXPONENT, SUTHERLAND_LAW_CONSTANT,   TEMPERATURE_REFERENCE, VISCOSITY_MOLECULAR_REFERENCE, THERMAL_CONDUCTIVITY_REFERENCE, IDEAL_GAS_CONSTANT,   SPECIFIC_HEAT_PRESSURE, SPECIFIC_HEAT_VOLUME, LENGTH_REFERENCE, TURBULENT_DISTANCE,   TURBULENT_ENERGY_KINETIC, TURBULENT_DISSIPATION, TURBULENT_DISSIPATION_RATE, TURBULENT_B_B_REYNOLDS,   TURBULENT_S_A_NU_TILDE, MACH, MACH_VELOCITY, MACH_VELOCITY_SOUND,   REYNOLDS, REYNOLDS_VELOCITY, REYNOLDS_LENGTH, REYNOLDS_VISCOSITY_KINEMATIC,   PRANDTL, PRANDTL_THERMAL_CONDUCTIVITY, PRANDTL_VISCOSITY_MOLECULAR, PRANDTL_SPECIFIC_HEAT_PRESSURE,   PRANDTL_TURBULENT, SPECIFIC_HEAT_RATIO, SPECIFIC_HEAT_RATIO_PRESSURE, SPECIFIC_HEAT_RATIO_VOLUME,   COEF_PRESSURE, COEF_SKIN_FRICTION_X, COEF_SKIN_FRICTION_Y, COEF_SKIN_FRICTION_Z,   COEF_PRESSURE_DYNAMIC, COEF_PRESSURE_REFERENCE, RIEMANN_INVARIANT_PLUS, RIEMANN_INVARIANT_MINUS,   CHARACTERISTIC_ENTROPY, CHARACTERISTIC_VORTICITY_1, CHARACTERISTIC_VORTICITY_2, CHARACTERISTIC_ACOUSTIC_PLUS,   CHARACTERISTIC_ACOUSTIC_MINUS, FORCE_X, FORCE_Y, FORCE_Z,   FORCE_R, FORCE_THETA, FORCE_PHI, LIFT,   DRAG, MOMENT_X, MOMENT_Y, MOMENT_Z,   MOMENT_R, MOMENT_THETA, MOMENT_PHI, MOMENT_XI,   MOMENT_ETA, MOMENT_ZETA, MOMENT_CENTER_X, MOMENT_CENTER_Y,   MOMENT_CENTER_Z, COEF_LIFT, COEF_DRAG, COEF_MOMENT_X,   COEF_MOMENT_Y, COEF_MOMENT_Z, COEF_MOMENT_R, COEF_MOMENT_THETA,   COEF_MOMENT_PHI, COEF_MOMENT_XI, COEF_MOMENT_ETA, COEF_MOMENT_ZETA,   COEF_AREA, COEF_LENGTH, TIME_VALUES, ITERATION_VALUES,   NUMBER_OF_ZONES, NUMBER_OF_FAMILIES, ZONE_POINTERS, FAMILY_POINTERS,   RIGID_GRID_MOTION_POINTERS, ARBITRARY_GRID_MOTION_POINTERS, GRID_COORDINATES_POINTERS, FLOW_SOLUTIONS_POINTERS,   ORIGIN_LOCATION, RIGID_ROTATION_ANGLE, RIGID_VELOCITY, RIGID_ROTATION_RATE,   GRID_VELOCITY_X, GRID_VELOCITY_Y, GRID_VELOCITY_Z, GRID_VELOCITY_R,   GRID_VELOCITY_THETA, GRID_VELOCITY_PHI, GRID_VELOCITY_XI, GRID_VELOCITY_ETA,   GRID_VELOCITY_ZETA, USER_DATA }
enum	DataType {   CHAR, INT, FLOAT, REAL4 = FLOAT,   DOUBLE, REAL8 = DOUBLE }
Public Methods
DataConversion	getDataConversion () const
double	getConversionScale () const
double	getConversionOffset () const
DimensionalExponents	getDimensionalExponents () const
double	getMassExponent () const
double	getLengthExponent () const
double	getTimeExponent () const
double	getTemperatureExponent () const
double	getAngleExponent () const
Quantity	getQuantity () const
int	getNumDimensions () const
int	getDimension (int iNth) const
void	setDimensions (int iNumDimensions, int const *iDimensions)
void	setDimensions (int iDimension)
void	setDimensions (int iDim1, int iDim2)
void	setDimensions (int iDim1, int iDim2, int iDim3)
DataType	getDataType () const
void	setDataTypeDimensions (DataType iType, int iNumDimensions, int const *iDimensions)
void	setDataTypeDimensions (DataType iType, int iDimension)
void	setDataTypeDimensions (DataType iType, int iDim1, int iDim2)
void	setDataTypeDimensions (DataType iType, int iDim1, int iDim2, int iDim3)
void	readData (INT_t *oData) const
void	readData (FLOAT_t *oData) const
void	readData (DOUBLE_t *oData) const
void	readData (StridedRange1D iDiskStride, INT_t *oData, StridedRange1D iMemoryStride) const
void	readData (StridedRange1D iDiskStride, FLOAT_t *oData, StridedRange1D iMemoryStride) const
void	readData (StridedRange1D iDiskStride, DOUBLE_t *oData, StridedRange1D iMemoryStride) const
void	readData (StridedRange2D iDiskStride, INT_t *oData, StridedRange2D iMemoryStride) const
void	readData (StridedRange2D iDiskStride, FLOAT_t *oData, StridedRange2D iMemoryStride) const
void	readData (StridedRange2D iDiskStride, DOUBLE_t *oData, StridedRange2D iMemoryStride) const
void	readData (StridedRange3D iDiskStride, INT_t *oData, StridedRange3D iMemoryStride) const
void	readData (StridedRange3D iDiskStride, FLOAT_t *oData, StridedRange3D iMemoryStride) const
void	readData (StridedRange3D iDiskStride, DOUBLE_t *oData, StridedRange3D iMemoryStride) const
void	writeData (INT_t const *iData)
void	writeData (FLOAT_t const *iData)
void	writeData (DOUBLE_t const *iData)
	DataArray (Private::DataArray *iImpl)

---

Detailed Description

Represents a SIDS node representing physical data.

---

Member Typedef Documentation

typedef char CHAR_t

typedef double DOUBLE_t

typedef float FLOAT_t

typedef int INT_t

typedef FLOAT_t REAL4_t

typedef DOUBLE_t REAL8_t

---

Member Enumeration Documentation

enum DataType

The different data types a DataArray node may contain. Enumeration values: CHAR  INT  FLOAT  REAL4  DOUBLE  REAL8

enum Quantity

Enumeration values: NULL_DATA  COORDINATE_X  COORDINATE_Y  COORDINATE_Z  COORDINATE_R  COORDINATE_THETA  COORDINATE_PHI  COORDINATE_NORMAL  COORDINATE_TANGENTIAL  COORDINATE_XI  COORDINATE_ETA  COORDINATE_ZETA  COORDINATE_TRANSFORM  INTERPOLANTS_DONOR  ELEMENT_CONNECTIVITY  PARENT_DATA  POTENTIAL  STREAM_FUNCTION  DENSITY  PRESSURE  TEMPERATURE  ENERGY_INTERNAL  ENTHALPY  ENTROPY  ENTROPY_APPROX  DENSITY_STAGNATION  PRESSURE_STAGNATION  TEMPERATURE_STAGNATION  ENERGY_STAGNATION  ENTHALPY_STAGNATION  ENERGY_STAGNATION_DENSITY  VELOCITY_X  VELOCITY_Y  VELOCITY_Z  VELOCITY_R  VELOCITY_THETA  VELOCITY_PHI  VELOCITY_MAGNITUDE  VELOCITY_NORMAL  VELOCITY_TANGENTIAL  VELOCITY_SOUND  VELOCITY_SOUND_STAGNATION  MOMENTUM_X  MOMENTUM_Y  MOMENTUM_Z  MOMENTUM_MAGNITUDE  ENERGY_KINETIC  PRESSURE_DYNAMIC  VORTICITY_X  VORTICITY_Y  VORTICITY_Z  VORTICITY_MAGNITUDE  SKIN_FRICTION_X  SKIN_FRICTION_Y  SKIN_FRICTION_Z  SKIN_FRICTION_MAGNITUDE  VELOCITY_ANGLE_X  VELOCITY_ANGLE_Y  VELOCITY_ANGLE_Z  VELOCITY_UNIT_VECTOR_X  VELOCITY_UNIT_VECTOR_Y  VELOCITY_UNIT_VECTOR_Z  MASS_FLOW  VISCOSITY_KINEMATIC  VISCOSITY_MOLECULAR  VISCOSITY_EDDY_KINEMATIC  VISCOSITY_EDDY  THERMAL_CONDUCTIVITY  REYNOLDS_STRESS_XX  REYNOLDS_STRESS_XY  REYNOLDS_STRESS_XZ  REYNOLDS_STRESS_YY  REYNOLDS_STRESS_YZ  REYNOLDS_STRESS_ZZ  POWER_LAW_EXPONENT  SUTHERLAND_LAW_CONSTANT  TEMPERATURE_REFERENCE  VISCOSITY_MOLECULAR_REFERENCE  THERMAL_CONDUCTIVITY_REFERENCE  IDEAL_GAS_CONSTANT  SPECIFIC_HEAT_PRESSURE  SPECIFIC_HEAT_VOLUME  LENGTH_REFERENCE  TURBULENT_DISTANCE  TURBULENT_ENERGY_KINETIC  TURBULENT_DISSIPATION  TURBULENT_DISSIPATION_RATE  TURBULENT_B_B_REYNOLDS  TURBULENT_S_A_NU_TILDE  MACH  MACH_VELOCITY  MACH_VELOCITY_SOUND  REYNOLDS  REYNOLDS_VELOCITY  REYNOLDS_LENGTH  REYNOLDS_VISCOSITY_KINEMATIC  PRANDTL  PRANDTL_THERMAL_CONDUCTIVITY  PRANDTL_VISCOSITY_MOLECULAR  PRANDTL_SPECIFIC_HEAT_PRESSURE  PRANDTL_TURBULENT  SPECIFIC_HEAT_RATIO  SPECIFIC_HEAT_RATIO_PRESSURE  SPECIFIC_HEAT_RATIO_VOLUME  COEF_PRESSURE  COEF_SKIN_FRICTION_X  COEF_SKIN_FRICTION_Y  COEF_SKIN_FRICTION_Z  COEF_PRESSURE_DYNAMIC  COEF_PRESSURE_REFERENCE  RIEMANN_INVARIANT_PLUS  RIEMANN_INVARIANT_MINUS  CHARACTERISTIC_ENTROPY  CHARACTERISTIC_VORTICITY_1  CHARACTERISTIC_VORTICITY_2  CHARACTERISTIC_ACOUSTIC_PLUS  CHARACTERISTIC_ACOUSTIC_MINUS  FORCE_X  FORCE_Y  FORCE_Z  FORCE_R  FORCE_THETA  FORCE_PHI  LIFT  DRAG  MOMENT_X  MOMENT_Y  MOMENT_Z  MOMENT_R  MOMENT_THETA  MOMENT_PHI  MOMENT_XI  MOMENT_ETA  MOMENT_ZETA  MOMENT_CENTER_X  MOMENT_CENTER_Y  MOMENT_CENTER_Z  COEF_LIFT  COEF_DRAG  COEF_MOMENT_X  COEF_MOMENT_Y  COEF_MOMENT_Z  COEF_MOMENT_R  COEF_MOMENT_THETA  COEF_MOMENT_PHI  COEF_MOMENT_XI  COEF_MOMENT_ETA  COEF_MOMENT_ZETA  COEF_AREA  COEF_LENGTH  TIME_VALUES  ITERATION_VALUES  NUMBER_OF_ZONES  NUMBER_OF_FAMILIES  ZONE_POINTERS  FAMILY_POINTERS  RIGID_GRID_MOTION_POINTERS  ARBITRARY_GRID_MOTION_POINTERS  GRID_COORDINATES_POINTERS  FLOW_SOLUTIONS_POINTERS  ORIGIN_LOCATION  RIGID_ROTATION_ANGLE  RIGID_VELOCITY  RIGID_ROTATION_RATE  GRID_VELOCITY_X  GRID_VELOCITY_Y  GRID_VELOCITY_Z  GRID_VELOCITY_R  GRID_VELOCITY_THETA  GRID_VELOCITY_PHI  GRID_VELOCITY_XI  GRID_VELOCITY_ETA  GRID_VELOCITY_ZETA  USER_DATA

---

Constructor & Destructor Documentation

DataArray (  Private::DataArray *    iImpl )

Creates this data array from implementation data.

---

Member Function Documentation

double getAngleExponent (    )  const

Gets the angle exponent applicable to this data.

double getConversionOffset (    )  const

Gets the conversion scale applicable to this data.

double getConversionScale (    )  const

Gets the conversion scale applicable to this data.

DataConversion getDataConversion (    )  const

Gets the conversion factors applicable to this data.

DataType getDataType (    )  const

Gets the data type used in this DataArray.

int getDimension (  int    iNth )  const

Gets the size of the nth dimension.

DimensionalExponents getDimensionalExponents (    )  const

Gets the dimensional exponents applicable to this data.

double getLengthExponent (    )  const

Gets the length exponent applicable to this data.

double getMassExponent (    )  const

Gets the mass exponent applicable to this data.

int getNumDimensions (    )  const

Gets the number of dimensions.

Quantity getQuantity (    )  const

Gets the quantity type of this data.

double getTemperatureExponent (    )  const

Gets the temperature exponent applicable to this data.

double getTimeExponent (    )  const

Gets the time exponent applicable to this data.

void readData (  StridedRange3D    iDiskStride, DOUBLE_t *    oData, StridedRange3D    iMemoryStride )  const

void readData (  StridedRange3D    iDiskStride, FLOAT_t *    oData, StridedRange3D    iMemoryStride )  const

void readData (  StridedRange3D    iDiskStride, INT_t *    oData, StridedRange3D    iMemoryStride )  const

void readData (  StridedRange2D    iDiskStride, DOUBLE_t *    oData, StridedRange2D    iMemoryStride )  const

void readData (  StridedRange2D    iDiskStride, FLOAT_t *    oData, StridedRange2D    iMemoryStride )  const

void readData (  StridedRange2D    iDiskStride, INT_t *    oData, StridedRange2D    iMemoryStride )  const

void readData (  StridedRange1D    iDiskStride, DOUBLE_t *    oData, StridedRange1D    iMemoryStride )  const

void readData (  StridedRange1D    iDiskStride, FLOAT_t *    oData, StridedRange1D    iMemoryStride )  const

void readData (  StridedRange1D    iDiskStride, INT_t *    oData, StridedRange1D    iMemoryStride )  const

Reads the data from disk, with strides and possibly conversion.

void readData (  DOUBLE_t *    oData )  const

void readData (  FLOAT_t *    oData )  const

void readData (  INT_t *    oData )  const

Reads the data from disk, possibly with conversion.

void setDataTypeDimensions (  DataType    iType, int    iDim1, int    iDim2, int    iDim3 )

Sets data type and three dimensions at once.

void setDataTypeDimensions (  DataType    iType, int    iDim1, int    iDim2 )

Sets data type and two dimensions at once.

void setDataTypeDimensions (  DataType    iType, int    iDimension )

Sets data type and a single one dimension at once.

void setDataTypeDimensions (  DataType    iType, int    iNumDimensions, int const *    iDimensions )

Sets data type and all dimensions at once.

void setDimensions (  int    iDim1, int    iDim2, int    iDim3 )

Sets three dimensions.

void setDimensions (  int    iDim1, int    iDim2 )

Sets two dimensions.

void setDimensions (  int    iDimension )

Sets a single one.

void setDimensions (  int    iNumDimensions, int const *    iDimensions )

Sets all dimensions at once.

void writeData (  DOUBLE_t const *    iData )

void writeData (  FLOAT_t const *    iData )

void writeData (  INT_t const *    iData )

Writes the data to disk.

---