udfGetOsiData()
Return data from an integrated surface output set.
Syntax
osiData = udfGetOsiData( 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_OSI_AREA
- Total area.
- UDF_OSI_MASS_FLUX
- Total mass flux.
- UDF_OSI_MOMENTUM_FLUX
- Total momentum flux.
- UDF_OSI_TRACTION
- Total traction.
- UDF_OSI_MOMENT
- Total moment.
- UDF_OSI_HEAT_FLUX
- Total heat flux.
- UDF_OSI_CONVECTIVE_SPECIES
- Total convective species flux.
- UDF_OSI_VELOCITY
- Average velocity.
- UDF_OSI_PRESSURE
- Average pressure.
- UDF_OSI_TOTAL_PRESSURE
- Average total pressure.
- UDF_OSI_TEMPERATURE
- Average temperature.
- UDF_OSI_SPECIES
- Average species.
- UDF_OSI_EDDY_VISCOSITY
- Average turbulence eddy viscosity.
- UDF_OSI_KINETIC_ENERGY
- Average turbulence kinetic energy.
- UDF_OSI_EDDY_FREQUENCY
- Average turbulence eddy frequency.
- UDF_OSI_MESH_DISPLACEMENT
- Average mesh displacement.
- UDF_OSI_MESH_VELOCITY
- Average mesh velocity.
- UDF_OSI_TURBULENCE_YPLUS
- Average y-plus of first node.
- UDF_OSI_FILM_COEFFICIENT
- Average heat transfer film coefficient.
- UDF_OSI_AVE_DENSITY
- Average density.
- UDF_OSI_MAV_VELOCITY
- Mass averaged velocity.
- UDF_OSI_MAV_PRESSURE
- Mass averaged pressure.
- UDF_OSI_MAV_TOTAL_PRESSURE
- Mass averaged total pressure.
- UDF_OSI_MAV_TEMPERATURE
- Mass averaged temperature.
- UDF_OSI_MAV_SPECIES
- Mass averaged species.
- UDF_OSI_MAV_EDDY_VISCOSITY
- Mass averaged viscosity.
- UDF_OSI_MAV_KINETIC_ENERGY
- Mass averaged kinetic energy.
- UDF_OSI_MAV_EDDY_FREQUENCY
- Mass averaged eddy frequency.
- UDF_OSI_VEST
- Average viscoelastic stress.
- UDF_OSI_MAV_VEST
- Mass averaged viscoelastic stress.
- UDF_OSI_MFAV_VELOCITY
- Mass flux average of velocity.
- UDF_OSI_MFAV_PRESSURE
- Mass flux average of pressure.
- UDF_OSI_MFAV_TOTAL_PRESSURE
- Mass flux average of total pressure.
- UDF_OSI_MFAV_TEMPERATURE
- Mass flux average of temperature.
- UDF_OSI_MFAV_SPECIES
- Mass flux average of species.
- UDF_OSI_MFAV_EDDY_VISCOSITY
- Mass flux average of turbulence eddy viscosity.
- UDF_OSI_MFAV_KINETIC_ENERGY
- Mass flux average of turbulence kinetic energy.
- UDF_OSI_MFAV_EDDY_FREQUENCY
- Mass flux average of turbulent eddy frequency.
- UDF_OSI_MFAV_VEST
- Mass flux average of viscoelastic stress.
- UDF_OSI_BULK_TEMPERATURE
- Bulk temperature.
- UDF_OSI_PARTIAL_VOLUME
- Partial volume.
- UDF_OSI_WALL_SHEAR_STRESS
- Wall shear stress.
- UDF_OSI_CURR_AREA
- Current total area.
- UDF_OSI_CURR_MASS_FLUX
- Current total mass flux.
- UDF_OSI_CURR_MOMENTUM_FLUX
- Current total momentum flux.
- UDF_OSI_CURR_TRACTION
- Current total traction.
- UDF_OSI_CURR_MOMENT
- Current total moment.
- UDF_OSI_CURR_CONVECTIVE_TEMPERATURE
- Current total convective temperature flux.
- UDF_OSI_CURR_HEAT_FLUX
- Current total heat flux.
- UDF_OSI_CURR_CONVECTIVE_SPECIES
- Current convective species flux.
- UDF_OSI_CURR_SPECIES_FLUX
- Current total species flux.
- UDF_OSI_CURR_VELOCITY
- Current average velocity.
- UDF_OSI_CURR_PRESSURE
- Current average pressure.
- UDF_OSI_CURR_TOTAL_PRESSURE
- Current average total pressure.
- UDF_OSI_CURR_TEMPERATURE
- Current average temperature.
- UDF_OSI_CURR_SPECIES
- Current average species.
- UDF_OSI_CURR_EDDY_VISCOSITY
- Current average turbulence eddy viscosity.
- UDF_OSI_CURR_KINETIC_ENERGY
- Current average turbulence kinetic energy.
- UDF_OSI_CURR_EDDY_FREQUENCY
- Current average turbulence eddy frequency.
- UDF_OSI_CURR_MESH_DISPLACEMENT
- Current average mesh displacement.
- UDF_OSI_CURR_MESH_VELOCITY
- Current average mesh velocity.
- UDF_OSI_CURR_TURBULENCE_YPLUS
- Current average y-plus of first node.
- UDF_OSI_CURR_FILM_COEFFICIENT
- Current average heat transfer film coefficient.
- UDF_OSI_CURR_AVE_DENSITY
- Current average density.
- UDF_OSI_CURR_MAV_VELOCITY
- Current mass averaged velocity.
- UDF_OSI_CURR_MAV_PRESSURE
- Current mass averaged pressure.
- UDF_OSI_CURR_MAV_TOTAL_PRESSURE
- Current mass averaged total pressure.
- UDF_OSI_CURR_MAV_TEMPERATURE
- Current mass averaged temperature.
- UDF_OSI_CURR_MAV_SPECIES_FLUX
- Current mass averaged species flux.
- UDF_OSI_CURR_MAV_EDDY_VISCOSITY
- Current mass averaged eddy viscosity.
- UDF_OSI_CURR_MAV_KINETIC_ENERGY
- Current mass averaged kinetic energy.
- UDF_OSI_CURR_MAV_EDDY_FREQUENCY
- Current mass averaged eddy frequency.
- UDF_OSI_CURR_VEST
- Current average viscoelastic stress.
- UDF_OSI_CURR_MAV_VEST
- Current mass averaged viscoelastic stress.
- UDF_OSI_CURR_MFAV_VELOCITY
- Current mass flux average of velocity.
- UDF_OSI_CURR_MFAV_PRESSURE
- Current mass flux average of pressure.
- UDF_OSI_CURR_MFAV_TOTAL_PRESSURE
- Current mass flux average of total pressure.
- UDF_OSI_CURR_MFAV_TEMPERATURE
- Current mass flux average of temperature.
- UDF_OSI_CURR_MFAV_SPECIES
- Current mass flux average of species.
- UDF_OSI_CURR_MFAV_EDDY_VISCOSITY
- Current mass flux average of turbulence eddy viscosity.
- UDF_OSI_CURR_MFAV_KINETIC_ENERGY
- Current mass flux average of turbulence kinetic energy.
- UDF_OSI_CURR_MFAV_EDDY_FREQUENCY
- Current mass flux average of turbulence eddy frequency.
- UDF_OSI_CURR_MFAV_VEST
- Current mass flux average of viscoelastic stress.
- UDF_OSI_CURR_BULK_TEMPERATURE
- Current bulk temperature.
- UDF_OSI_CURR_PARTIAL_VOLUME
- Current partial volume.
- UDF_OSI_CURR_WALL_SHEAR_STRESS
- Current wall shear stress.
Return Value
- osiData (string)
- Pointer to one-dimensional real array of the requested data. The dimension of the array depends
on dataName as follows:
dataName Array dimension UDF_OSI_AREA 1 UDF_OSI_MASS_FLUX 1 UDF_OSI_MOMENTUM_FLUX 3 UDF_OSI_TRACTION 3 UDF_OSI_MOMENT 3 UDF_OSI_CONVECTIVE_TEMPERATURE 1 UDF_OSI_HEAT_FLUX 1 UDF_OSI_CONVECTIVE_SPECIES udfGetNumSpecs() UDF_OSI_SPECIES_FLUX udfGetNumSpecs() UDF_OSI_VELOCITY 3 UDF_OSI_PRESSURE 1 UDF_OSI_TOTAL_PRESSURE 1 UDF_OSI_TEMPERATURE 1 UDF_OSI_SPECIES udfGetNumSpecs() UDF_OSI_EDDY_VISCOSITY 1 UDF_OSI_KINETIC_ENERGY 1 UDF_OSI_EDDY_FREQUENCY 1 UDF_OSI_MESH_DISPLACEMENT 3 UDF_OSI_MESH_VELOCITY 3 UDF_OSI_TURBULENCE_YPLUS 1 UDF_OSI_FILM_COEFFICIENT 1 UDF_OSI_AVE_DENSITY 1 UDF_OSI_MAV_VELOCITY 3 UDF_OSI_MAV_PRESSURE 1 UDF_OSI_MAV_TOTAL_PRESSURE 1 UDF_OSI_MAV_TEMPERATURE 1 UDF_OSI_MAV_SPECIES udfGetNumSpecs() UDF_OSI_MAV_EDDY_VISCOSITY 1 UDF_OSI_MAV_KINETIC_ENERGY 1 UDF_OSI_MAV_EDDY_FREQUENCY 1 UDF_OSI_VEST 6 UDF_OSI_MAV_VEST 6 UDF_OSI_MFAV_VELOCITY 3 UDF_OSI_MFAV_PRESSURE 1 UDF_OSI_MFAV_TOTAL_PRESSURE 1 UDF_OSI_MFAV_TEMPERATURE 1 UDF_OSI_MFAV_SPECIES udfGetNumSpecs() UDF_OSI_MFAV_EDDY_VISCOSITY 1 UDF_OSI_MFAV_KINETIC_ENERGY 1 UDF_OSI_MFAV_EDDY_FREQUENCY 1 UDF_OSI_MFAV_VEST 6 UDF_OSI_BULK_TEMPERATURE 1 UDF_OSI_PARTIAL_VOLUME 1 UDF_OSI_WALL_SHEAR_STRESS 3 UDF_OSI_CURR_AREA 1 UDF_OSI_CURR_MASS_FLUX 1 UDF_OSI_CURR_MOMENTUM_FLUX 3 UDF_OSI_CURR_TRACTION 3 UDF_OSI_CURR_MOMENT 3 UDF_OSI_CURR_CONVECTIVE_TEMPERATURE 1 UDF_OSI_CURR_HEAT_FLUX 1 UDF_OSI_CURR_CONVECTIVE_SPECIES udfGetNumSpecs() UDF_OSI_CURR_SPECIES_FLUX udfGetNumSpecs() UDF_OSI_CURR_VELOCITY 3 UDF_OSI_CURR_PRESSURE 1 UDF_OSI_CURR_TOTAL_PRESSURE 1 UDF_OSI_CURR_TEMPERATURE 1 UDF_OSI_CURR_SPECIES udfGetNumSpecs() UDF_OSI_CURR_EDDY_VISCOSITY 1 UDF_OSI_CURR_KINETIC_ENERGY 1 UDF_OSI_CURR_EDDY_FREQUENCY 1 UDF_OSI_CURR_MESH_DISPLACEMENT 3 UDF_OSI_CURR_MESH_VELOCITY 3 UDF_OSI_CURR_TURBULENCE_YPLUS 1 UDF_OSI_CURR_FILM_COEFFICIENT 1 UDF_OSI_CURR_AVE_DENSITY 1 UDF_OSI_CURR_MAV_VELOCITY 3 UDF_OSI_CURR_MAV_PRESSURE 1 UDF_OSI_CURR_MAV_TOTAL_PRESSURE 1 UDF_OSI_CURR_MAV_TEMPERATURE 1 UDF_OSI_CURR_MAV_SPECIES_FLUX udfGetNumSpecs() UDF_OSI_CURR_MAV_EDDY_VISCOSITY 1 UDF_OSI_CURR_MAV_KINETIC_ENERGY 1 UDF_OSI_CURR_MAV_EDDY_FREQUENCY 1 UDF_OSI_CURR_VEST 6 UDF_OSI_CURR_MAV_VEST 6 UDF_OSI_CURR_MFAV_VELOCITY 3 UDF_OSI_CURR_MFAV_PRESSURE 1 UDF_OSI_CURR_MFAV_TOTAL_PRESSURE 1 UDF_OSI_CURR_MFAV_TEMPERATURE 1 UDF_OSI_CURR_MFAV_SPECIES udfGetNumSpecs() UDF_OSI_CURR_MFAV_EDDY_VISCOSITY 1 UDF_OSI_CURR_MFAV_KINETIC_ENERGY 1 UDF_OSI_CURR_MFAV_EDDY_FREQUENCY 1 UDF_OSI_CURR_MFAV_VEST 6 UDF_OSI_CURR_BULK_TEMPERATURE 1 UDF_OSI_CURR_PARTIAL_VOLUME 1 UDF_OSI_CURR_WALL_SHEAR_STRESS 3
Description
This routine returns data from an integrated surface output set. For
example,
Real* osiData ;
Real area, x_mom_flux, y_mom_flux, z_mom_flux, convSpec ;
Integer specId, nSpecs ;
...
osiData = udfGetOsiData( udfHd, "car body", UDF_OSI_AREA ) ;
area = osiData[0] ;
...
osiData = udfGetOsiData( udfHd, "car body", UDF_OSI_MOMENTUM_FLUX ) ;
x_mom_flux = osiData[0] ;
y_mom_flux = osiData[1] ;
z_mom_flux = osiData[2] ;
...
nSpecs = udfGetNumSpecs( udfHd ) ;
osiData = udfGetOsiData( udfHd, "car body", UDF_OSI_CONVECTIVE_SPECIES ) ;
for ( specId = 0 ; specId < nSpecs ; specId++ ) {
convSpec = osiData[specId] ;
...
)All quantities are evaluated at the end of the previous time step, except for the "current" variables (UDF_OSI_CURR_MASS_FLUX, UDF_OSI_CURR_MOMENTUM_FLUX, and UDF_OSI_CURR_TRACTION). These are evaluated at the end of every flow stagger in order to provide the latest data.
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_OSI_HEAT_FLUX to be available.