udfGetNbcRafData()

Return nodal running average field solution data for the nodal boundary condition.

Syntax

data = udfGetNbcRafData( udfHd, dataName ) ;

Type

AcuSolve User-Defined Nodal Boundary Condition

Parameters

udfHd
The opaque handle (pointer) which was passed to the user function.
dataName (integer)
Symbolic name of the requested data.
UDF_NBC_VELOCITY
Velocity.
UDF_NBC_ACCELERATION
Acceleration.
UDF_NBC_PRESSURE
Pressure.
UDF_NBC_TEMPERATURE
Temperature.
UDF_NBC_SPECIES
Species.
UDF_NBC_EDDY_VISCOSITY
Turbulence eddy viscosity.
UDF_NBC_KINETIC_ENERGY
Turbulence kinetic energy.
UDF_NBC_EDDY_FREQUENCY
Turbulence eddy frequency.
UDF_NBC_EDDY_TIME
Turbulence eddy time.
UDF_NBC_TRANSITION_RETHETA
Transition Re-Theta.
UDF_NBC_INTERMITTENCY
Transition intermittency.
UDF_NBC_MESH_DISPLACEMENT
Mesh displacement.
UDF_NBC_MESH_VELOCITY
Mesh velocity.
UDF_NBC_TURBULENCE_Y
Distance to nearest turbulence wall.
UDF_NBC_TURBULENCE_YPLUS
Turbulence y+ based on distance to nearest turbulence wall and shear at that wall.
UDF_NBC_VISCOELASTIC
Viscoelastic.

Return Value

data (Real*)
Pointer to one or two dimensional real array of the requested data. The dimensions of the array depend on dataName as follows. If the second dimension is one, then the array may be treated as one dimensional.
dataName First Dimension Second Dimension
UDF_NBC_VELOCITY nItems 3
UDF_NBC_ACCLERATION nItems 3
UDF_NBC_PRESSURE nItems 1
UDF_NBC_TEMPERATURE nItems 1
UDF_NBC_SPECIES nItems udfGetNumSpecs()
UDF_NBC_EDDY_VISCOSITY nItems 1
UDF_NBC_KINETIC_ENERGY nItems 1
UDF_NBC_EDDY_FREQUENCY nItems 1
UDF_NBC_EDDY_TIME nItems 1
UDF_NBC_TRANSITION_RETHETA nItems 1
UDF_NBC_INTERMITTENCY nItems 1
UDF_NBC_MESH_DISPLACEMENT nItems 3
UDF_NBC_MESH_VELOCITY nItems 3
UDF_NBC_TURBULENCE_Y nItems 1
UDF_NBC_TURBULENCE_YPLUS nItems 1
UDF_NBC_VISCOELASTIC nItems 6

Description

This routine returns the requested nodal solution data. It is used exactly the same way as udfGetNbcData, but returns the running average field versions of the data.

Errors

  • This routine expects a valid udfHd.
  • This routine may only be called within an Nodal Boundary Condition user function.
  • dataName must be one of the values given above.
  • The problem must contain the equation associated with the requested data.
  • running_average must be turned on in the EQUATION command.