udfGetOssData()
Return the nodal statistics (minimum, maximum and standard deviation) from a surface output set.
Syntax
ossData = udfGetOssData( udfHd, setName, dataName ) ;
Type
AcuSolve User-Defined Function Global
Parameters
- udfHd
- The opaque handle (pointer) which was passed to the user function.
- setName (string)
- Name of the SURFACE_OUTPUT set.
- dataName (integer)
- Symbolic name of the requested data.
- UDF_OSS_MIN_VELOCITY
- Minimum velocity.
- UDF_OSS_MIN_PRESSURE
- Minimum pressure.
- UDF_OSS_MIN_TOTAL_PRESSURE
- Minimum total pressure.
- UDF_OSS_MIN_TEMPERATURE
- Minimum temperature.
- UDF_OSS_MIN_SPECIES
- Minimum species.
- UDF_OSS_MIN_EDDY_VISCOSITY
- Minimum turbulence eddy viscosity.
- UDF_OSS_MIN_KINETIC_ENERGY
- Minimum turbulence kinetic energy.
- UDF_OSS_MIN_EDDY_FREQUENCY
- Minimum turbulence eddy frequency.
- UDF_OSS_MIN_MESH_DISPLACEMENT
- Minimum mesh displacement.
- UDF_OSS_MIN_MESH_VELOCITY
- Minimum mesh velocity.
- UDF_OSS_MIN_TURBULENCE_YPLUS
- Minimum y-plus of first node.
- UDF_OSS_MIN_FILM_COEFFICIENT
- Minimum heat transfer film coefficient.
- UDF_OSS_MIN_DENSITY
- Minimum density.
- UDF_OSS_MIN_VEST
- Minimum viscoelastic stress.
- UDF_OSS_MIN_WALL_SHEAR_STRESS
- Minimum wall shear stress.
- UDF_OSS_MAX_VELOCITY
- Maximum velocity.
- UDF_OSS_MAX_PRESSURE
- Maximum pressure.
- UDF_OSS_MAX_TOTAL_PRESSURE
- Maximum total pressure.
- UDF_OSS_MAX_TEMPERATURE
- Maximum temperature.
- UDF_OSS_MAX_SPECIES
- Maximum species.
- UDF_OSS_MAX_EDDY_VISCOSITY
- Maximum turbulence eddy viscosity.
- UDF_OSS_MAX_KINETIC_ENERGY
- Maximum turbulence kinetic energy.
- UDF_OSS_MAX_EDDY_FREQUENCY
- Maximum turbulence eddy frequency.
- UDF_OSS_MAX_MESH_DISPLACEMENT
- Maximum mesh displacement.
- UDF_OSS_MAX_MESH_VELOCITY
- Maximum mesh velocity.
- UDF_OSS_MAX_TURBULENCE_YPLUS
- Maximum y-plus of first node.
- UDF_OSS_MAX_FILM_COEFFICIENT
- Maximum heat transfer film coefficient.
- UDF_OSS_MAX_DENSITY
- Maximum density.
- UDF_OSS_MAX_VEST
- Maximum viscoelastic stress.
- UDF_OSS_MAX_WALL_SHEAR_STRESS
- Maximum wall shear stress.
- UDF_OSS_STD_VELOCITY
- Standard deviation of velocity.
- UDF_OSS_STD_PRESSURE
- Standard deviation of pressure.
- UDF_OSS_STD_TOTAL_PRESSURE
- Standard deviation of total pressure.
- UDF_OSS_STD_TEMPERATURE
- Standard deviation of temperature.
- UDF_OSS_STD_SPECIES
- Standard deviation of species.
- UDF_OSS_STD_EDDY_VISCOSITY
- Standard deviation of turbulence eddy viscosity.
- UDF_OSS_STD_KINETIC_ENERGY
- Standard deviation of turbulence kinetic energy.
- UDF_OSS_STD_EDDY_FREQUENCY
- Standard deviation of turbulence eddy frequency.
- UDF_OSS_STD_MESH_DISPLACEMENT
- Standard deviation of mesh displacement.
- UDF_OSS_STD_MESH_VELOCITY
- Standard deviation of mesh velocity.
- UDF_OSS_STD_TURBULENCE_YPLUS
- Standard deviation of y-plus of first node.
- UDF_OSS_STD_FILM_COEFFICIENT
- Standard deviation of heat transfer film coefficient.
- UDF_OSS_STD_DENSITY
- Standard deviation of density.
- UDF_OSS_STD_VEST
- Standard deviation of viscoelastic stress.
- UDF_OSS_STD_WALL_SHEAR_STRESS
- Standard deviation of wall shear stress.
- UDF_OSS_UNI_VELOCITY
- Uniformity index of velocity.
- UDF_OSS_UNI_PRESSURE
- Uniformity index of pressure.
- UDF_OSS_UNI_TOTAL_PRESSURE
- Uniformity index of total pressure.
- UDF_OSS_UNI_TEMPERATURE
- Uniformity index of temperature.
- UDF_OSS_UNI_SPECIES
- Uniformity index of species.
- UDF_OSS_UNI_EDDY_VISCOSITY
- Uniformity index of turbulence eddy viscosity.
- UDF_OSS_UNI_KINETIC_ENERGY
- Uniformity index of turbulence kinetic energy.
- UDF_OSS_UNI_EDDY_FREQUENCY
- Uniformity index of turbulence eddy frequency.
- UDF_OSS_UNI_MESH_DISPLACEMENT
- Uniformity index of mesh displacement.
- UDF_OSS_UNI_MESH_VELOCITY
- Uniformity index of mesh velocity.
- UDF_OSS_UNI_TURBULENCE_YPLUS
- Uniformity index of y-plus of first node.
- UDF_OSS_UNI_FILM_COEFFICIENT
- Uniformity index of heat transfer film coefficient.
- UDF_OSS_UNI_DENSITY
- Uniformity index of density.
- UDF_OSS_UNI_VEST
- Uniformity index of viscoelastic stress.
- UDF_OSS_UNI_WALL_SHEAR_STRESS
- Uniformity index of wall shear stress.
- UDF_OSS_CURR_MIN_VELOCITY
- Current minimum velocity.
- UDF_OSS_CURR_MIN_PRESSURE
- Current minimum pressure.
- UDF_OSS_CURR_MIN_TOTAL_PRESSURE
- Current minimum total pressure.
- UDF_OSS_CURR_MIN_TEMPERATURE
- Current minimum temperature.
- UDF_OSS_CURR_MIN_SPECIES
- Current minimum species.
- UDF_OSS_CURR_MIN_EDDY_VISCOSITY
- Current minimum turbulence eddy viscosity.
- UDF_OSS_CURR_MIN_KINETIC_ENERGY
- Current minimum turbulence kinetic energy.
- UDF_OSS_CURR_MIN_EDDY_FREQUENCY
- Current minimum turbulence eddy frequency.
- UDF_OSS_CURR_MIN_MESH_DISPLACEMENT
- Current minimum mesh displacement.
- UDF_OSS_CURR_MIN_MESH_VELOCITY
- Current minimum mesh velocity.
- UDF_OSS_CURR_MIN_TURBULENCE_YPLUS
- Current minimum y-plus of first node.
- UDF_OSS_CURR_MIN_FILM_COEFFICIENT
- Current minimum heat transfer film coefficient.
- UDF_OSS_CURR_MIN_DENSITY
- Current minimum density.
- UDF_OSS_CURR_MIN_VEST
- Current minimum viscoelastic stress.
- UDF_OSS_CURR_MIN_WALL_SHEAR_STRESS
- Current minimum wall shear stress.
- UDF_OSS_CURR_MAX_VELOCITY
- Current maximum velocity.
- UDF_OSS_CURR_MAX_PRESSURE
- Current maximum pressure.
- UDF_OSS_CURR_MAX_TOTAL_PRESSURE
- Current maximum total pressure.
- UDF_OSS_CURR_MAX_TEMPERATURE
- Current maximum temperature.
- UDF_OSS_CURR_MAX_SPECIES
- Current maximum species.
- UDF_OSS_CURR_MAX_EDDY_VISCOSITY
- Current maximum turbulence eddy viscosity.
- UDF_OSS_CURR_MAX_KINETIC_ENERGY
- Current maximum turbulence kinetic energy.
- UDF_OSS_CURR_MAX_EDDY_FREQUENCY
- Current maximum turbulence eddy frequency.
- UDF_OSS_CURR_MAX_MESH_DISPLACEMENT
- Current maximum mesh displacement.
- UDF_OSS_CURR_MAX_MESH_VELOCITY
- Current maximum mesh velocity.
- UDF_OSS_CURR_MAX_TURBULENCE_YPLUS
- Current maximum y-plus of first node.
- UDF_OSS_CURR_MAX_FILM_COEFFICIENT
- Current maximum heat transfer film coefficient.
- UDF_OSS_CURR_MAX_DENSITY
- Current maximum density.
- UDF_OSS_CURR_MAX_VEST
- Current maximum viscoelastic stress.
- UDF_OSS_CURR_MAX_WALL_SHEAR_STRESS
- Current maximum wall shear stress.
- UDF_OSS_CURR_STD_VELOCITY
- Current standard deviation of velocity.
- UDF_OSS_CURR_STD_PRESSURE
- Current standard deviation of pressure.
- UDF_OSS_CURR_STD_TOTAL_PRESSURE
- Current standard deviation of total pressure.
- UDF_OSS_CURR_STD_TEMPERATURE
- Current standard deviation of temperature.
- UDF_OSS_CURR_STD_SPECIES
- Current standard deviation of species.
- UDF_OSS_CURR_STD_EDDY_VISCOSITY
- Current standard deviation of turbulence eddy viscosity.
- UDF_OSS_CURR_STD_KINETIC_ENERGY
- Current standard deviation of turbulence kinetic energy.
- UDF_OSS_CURR_STD_EDDY_FREQUENCY
- Current standard deviation of turbulence eddy frequency.
- UDF_OSS_CURR_STD_MESH_DISPLACEMENT
- Current standard deviation of mesh displacement.
- UDF_OSS_CURR_STD_MESH_VELOCITY
- Current standard deviation of mesh velocity.
- UDF_OSS_CURR_STD_TURBULENCE_YPLUS
- Current standard deviation of y-plus of first node.
- UDF_OSS_CURR_STD_FILM_COEFFICIENT
- Current standard deviation of heat transfer film coefficient.
- UDF_OSS_CURR_STD_DENSITY
- Current standard deviation of density.
- UDF_OSS_CURR_STD_VEST
- Current standard deviation of viscoelastic stress.
- UDF_OSS_CURR_STD_WALL_SHEAR_STRESS
- Current standard deviation of wall shear stress.
- UDF_OSS_CURR_UNI_VELOCITY
- Current uniformity index of velocity.
- UDF_OSS_CURR_UNI_PRESSURE
- Current uniformity index of pressure.
- UDF_OSS_CURR_UNI_TOTAL_PRESSURE
- Current uniformity index of total pressure.
- UDF_OSS_CURR_UNI_TEMPERATURE
- Current uniformity index of temperature.
- UDF_OSS_CURR_UNI_SPECIES
- Current uniformity index of species.
- UDF_OSS_CURR_UNI_EDDY_VISCOSITY
- Current uniformity index of turbulence eddy viscosity.
- UDF_OSS_CURR_UNI_KINETIC_ENERGY
- Current uniformity index of turbulence kinetic energy.
- UDF_OSS_CURR_UNI_EDDY_FREQUENCY
- Current uniformity index of turbulence eddy frequency.
- UDF_OSS_CURR_UNI_MESH_DISPLACEMENT
- Current uniformity index of mesh displacement.
- UDF_OSS_CURR_UNI_MESH_VELOCITY
- Current uniformity index of mesh velocity.
- UDF_OSS_CURR_UNI_TURBULENCE_YPLUS
- Current uniformity index of y-plus of first node.
- UDF_OSS_CURR_UNI_FILM_COEFFICIENT
- Current uniformity index of heat transfer film coefficient.
- UDF_OSS_CURR_UNI_DENSITY
- Current uniformity index of density.
- UDF_OSS_CURR_UNI_VEST
- Current uniformity index of viscoelastic stress.
- UDF_OSS_CURR_UNI_WALL_SHEAR_STRESS
- Current uniformity index of wall shear stress.
Return Value
- osiData (real)
- Pointer to one dimensional real array of the requested data. The dimension of the array depends
on dataName as follows:
dataName Array dimension UDF_OSS_MIN_VELOCITY 3 UDF_OSS_MIN_PRESSURE 1 UDF_OSS_MIN_TOTAL_PRESSURE 1 UDF_OSS_MIN_TEMPERATURE 1 UDF_OSS_MIN_SPECIES udfGetNumSpecs() UDF_OSS_MIN_EDDY_VISCOSITY 1 UDF_OSS_MIN_KINETIC_ENERGY 1 UDF_OSS_MIN_EDDY_FREQUENCY 1 UDF_OSS_MIN_MESH_DISPLACEMENT 3 UDF_OSS_MIN_MESH_VELOCITY 3 UDF_OSS_MIN_TURBULENCE_YPLUS 1 UDF_OSS_MIN_FILM_COEFFICIENT 1 UDF_OSS_MIN_DENSITY 1 UDF_OSS_MIN_VEST 6 UDF_OSS_MIN_WALL_SHEAR_STRESS 3 UDF_OSS_MAX_VELOCITY 3 UDF_OSS_MAX_PRESSURE 1 UDF_OSS_MAX_TOTAL_PRESSURE 1 UDF_OSS_MAX_TEMPERATURE 1 UDF_OSS_MAX_SPECIES udfGetNumSpecs() UDF_OSS_MAX_EDDY_VISCOSITY 1 UDF_OSS_MAX_KINETIC_ENERGY 1 UDF_OSS_MAX_EDDY_FREQUENCY 1 UDF_OSS_MAX_MESH_DISPLACEMENT 3 UDF_OSS_MAX_MESH_VELOCITY 3 UDF_OSS_MAX_TURBULENCE_YPLUS 1 UDF_OSS_MAX_FILM_COEFFICIENT 1 UDF_OSS_MAX_DENSITY 1 UDF_OSS_MAX_VEST 1 UDF_OSS_MAX_WALL_SHEAR_STRESS 3 UDF_OSS_STD_VELOCITY 3 UDF_OSS_STD_PRESSURE 1 UDF_OSS_STD_TOTAL_PRESSURE 1 UDF_OSS_STD_TEMPERATURE 1 UDF_OSS_STD_SPECIES udfGetNumSpecs() UDF_OSS_STD_EDDY_VISCOSITY 1 UDF_OSS_STD_KINETIC_ENERGY 1 UDF_OSS_STD_EDDY_FREQUENCY 1 UDF_OSS_STD_MESH_DISPLACEMENT 3 UDF_OSS_STD_MESH_VELOCITY 3 UDF_OSS_STD_TURBULENCE_YPLUS 1 UDF_OSS_STD_FILM_COEFFICIENT 1 UDF_OSS_STD_DENSITY 1 UDF_OSS_STD_VEST 6 UDF_OSS_STD_WALL_SHEAR_STRESS 3 UDF_OSS_UNI_VELOCITY 3 UDF_OSS_UNI_PRESSURE 1 UDF_OSS_UNI_TOTAL_PRESSURE 1 UDF_OSS_UNI_TEMPERATURE 1 UDF_OSS_UNI_SPECIES udfGetNumSpecs() UDF_OSS_UNI_EDDY_VISCOSITY 1 UDF_OSS_UNI_KINETIC_ENERGY 1 UDF_OSS_UNI_EDDY_FREQUENCY 1 UDF_OSS_UNI_MESH_DISPLACEMENT 3 UDF_OSS_UNI_MESH_VELOCITY 3 UDF_OSS_UNI_TURBULENCE_YPLUS 1 UDF_OSS_UNI_FILM_COEFFICIENT 1 UDF_OSS_UNI_DENSITY 1 UDF_OSS_UNI_VEST 6 UDF_OSS_UNI_WALL_SHEAR_STRESS 3 UDF_OSS_CURR_MIN_VELOCITY 3 UDF_OSS_CURR_MIN_PRESSURE 1 UDF_OSS_CURR_MIN_TOTAL_PRESSURE 1 UDF_OSS_CURR_MIN_TEMPERATURE 1 UDF_OSS_CURR_MIN_SPECIES udfGetNumSpecs() UDF_OSS_CURR_MIN_EDDY_VISCOSITY 1 UDF_OSS_CURR_MIN_KINETIC_ENERGY 1 UDF_OSS_CURR_MIN_EDDY_FREQUENCY 1 UDF_OSS_CURR_MIN_MESH_DISPLACEMENT 3 UDF_OSS_CURR_MIN_MESH_VELOCITY 3 UDF_OSS_CURR_MIN_TURBULENCE_YPLUS 1 UDF_OSS_CURR_MIN_FILM_COEFFICIENT 1 UDF_OSS_CURR_MIN_DENSITY 1 UDF_OSS_CURR_MIN_VEST 6 UDF_OSS_CURR_MIN_WALL_SHEAR_STRESS 3 UDF_OSS_CURR_MAX_VELOCITY 3 UDF_OSS_CURR_MAX_PRESSURE 1 UDF_OSS_CURR_MAX_TOTAL_PRESSURE 1 UDF_OSS_CURR_MAX_TEMPERATURE 1 UDF_OSS_CURR_MAX_SPECIES udfGetNumSpecs() UDF_OSS_CURR_MAX_EDDY_VISCOSITY 1 UDF_OSS_CURR_MAX_KINETIC_ENERGY 1 UDF_OSS_CURR_MAX_EDDY_FREQUENCY 1 UDF_OSS_CURR_MAX_MESH_DISPLACEMENT 3 UDF_OSS_CURR_MAX_MESH_VELOCITY 3 UDF_OSS_CURR_MAX_TURBULENCE_YPLUS 1 UDF_OSS_CURR_MAX_FILM_COEFFICIENT 1 UDF_OSS_CURR_MAX_DENSITY 1 UDF_OSS_CURR_MAX_VEST 6 UDF_OSS_CURR_MAX_WALL_SHEAR_STRESS 3 UDF_OSS_CURR_STD_VELOCITY 3 UDF_OSS_CURR_STD_PRESSURE 1 UDF_OSS_CURR_STD_TOTAL_PRESSURE 1 UDF_OSS_CURR_STD_TEMPERATURE 1 UDF_OSS_CURR_STD_SPECIES udfGetNumSpecs() UDF_OSS_CURR_STD_EDDY_VISCOSITY 1 UDF_OSS_CURR_STD_KINETIC_ENERGY 1 UDF_OSS_CURR_STD_EDDY_FREQUENCY 1 UDF_OSS_CURR_STD_MESH_DISPLACEMENT 3 UDF_OSS_CURR_STD_MESH_VELOCITY 3 UDF_OSS_CURR_STD_TURBULENCE_YPLUS 1 UDF_OSS_CURR_STD_FILM_COEFFICIENT 1 UDF_OSS_CURR_STD_DENSITY 1 UDF_OSS_CURR_STD_VEST 6 UDF_OSS_CURR_STD_WALL_SHEAR_STRESS 3 UDF_OSS_CURR_UNI_VELOCITY 3 UDF_OSS_CURR_UNI_PRESSURE 1 UDF_OSS_CURR_UNI_TOTAL_PRESSURE 1 UDF_OSS_CURR_UNI_TEMPERATURE 1 UDF_OSS_CURR_UNI_SPECIES udfGetNumSpecs() UDF_OSS_CURR_UNI_EDDY_VISCOSITY 1 UDF_OSS_CURR_UNI_KINETIC_ENERGY 1 UDF_OSS_CURR_UNI_EDDY_FREQUENCY 1 UDF_OSS_CURR_UNI_MESH_DISPLACEMENT 3 UDF_OSS_CURR_UNI_MESH_VELOCITY 3 UDF_OSS_CURR_UNI_TURBULENCE_YPLUS 1 UDF_OSS_CURR_UNI_FILM_COEFFICIENT 1 UDF_OSS_CURR_UNI_DENSITY 1 UDF_OSS_CURR_UNI_VEST 6 UDF_OSS_CURR_UNI_WALL_SHEAR_STRESS 3
Description
This routine returns statistical data from a surface output set. For
example,
Real* ossData ;
Real max_pres, min_x_mesh_disp, min_y_mesh_disp, min_z_mesh_disp, convSpec ;
Integer specId, nSpecs ;
...
ossData = udfGetOssData( udfHd, "car body", UDF_OSS_MAX_PRESSURE ) ;
max_pres = ossData[0] ;
...
ossData = udfGetOssData( udfHd, "car body", UDF_OSS_MIN_MESH_DISPLACEMENT ) ;
min_x_mesh_disp = ossData[0] ;
min_y_mesh_disp = ossData[1] ;
min_z_mesh_disp = ossData[2] ;
...
nSpecs = udfGetNumSpecs( udfHd ) ;
ossData = udfGetOssData( udfHd, "car body", UDF_OSS_STD_SPECIES ) ;
for ( specId = 0 ; specId < nSpecs ; specId++ ) {
convSpec = osiData[specId] ;
...
)This routine is used to compute the statistical data from a surface output set. The data is computed by extracting the solution values from all nodes in the surface set, then performing the statistical operation to produce in the maximum, minimum and standard deviation values. When extracting the UDF_OSS_CURR_ variables, the returned values reflect the solution updates at each nonlinear iteration. When extracting the UDF_OSS_ variables, the values from the previous timestep are returned. In the above example, maximum pressure, minimum mesh displacement and standard deviation of species are extracted.
Errors
- This routine expects a valid udfHd.
- setName must be a valid name.
- dataName must be one of the values given above.
- The problem must contain the equation system corresponding to the parameter being requested. For example, the problem must contain a heat equation in order for UDF_OSS_STD_TEMPERATURE to be available.