udfGetSdDataType()

Return the type of a data variable.

Syntax

datatype = udfGetSdDataType( udfHd, dataName ) ;

Type

AcuSolve User-Defined Subdomain Routine

Parameters

udfHd
The opaque handle (pointer) which was passed to the user function.
dataName (integer)
Symbolic name of a data variable.
UDF_SD_VELOCITY
Velocity.
UDF_SD_ACCELERATION
Acceleration.
UDF_SD_PRESSURE
Pressure.
UDF_SD_TEMPERATURE
Temperature.
UDF_SD_SPECIES
Species.
UDF_SD_EDDY_VISCOSITY
Turbulence eddy viscosity.
UDF_SD_KINETIC_ENERGY
Turbulence kinetic energy.
UDF_SD_EDDY_FREQUENCY
Turbulence eddy frequency.
UDF_SD_MESH_DISPLACEMENT
Mesh displacement.
UDF_SD_MESH_VELOCITY
Mesh velocity.
UDF_SD_TURBULENCE_Y
Distance to nearest turbulence wall.
UDF_SD_TURBULENCE_YPLUS
Turbulence y+ based on distance to nearest turbulence wall and shear at that wall.

Return Value

dataType (integer)
Symbolic type corresponding to the data name.
UDF_SD_TYPE_SCALAR
Scalar.
UDF_SD_TYPE_VECTOR
Vector.

Description

This routine returns the type (scalar or vector) of a variable associated with the given symbolic data name. For example,
Integer dataType ;
...
dataType = udfGetSdDataType( udfHd, UDF_SD_VELOCITY )

Errors

  • This routine expects a valid udfHd.
  • This routine may only be called within an external code.
  • dataName must be one of the values given above.
  • The subdomain must contain the equation associated with the data variable.