ufpGetFlowData()
Get the array of flow data.
Syntax
data = ufpGetFlowData ( ufpHd, dataName ) ;
Type
AcuSolve User-Defined Function Flow Routine.
Parameters
- ufpHd (pointer)
- The opaque handle which was passed to the user function.
- dataName (integer)
- Symbolic name of the requested data.
Table 1. Symbolic Name Data returned Array size UFP_FLOW_VELOCITY flow velocity 3 UFP_FLOW_PRESSURE pressure 1 UFP_FLOW_TEMPERATURE temperature 1 UFP_FLOW_EDDY_VISCOSITY eddy viscosity 1 UFP_FLOW_SPECIES_1 species 1 1 UFP_FLOW_SPECIES_2 species 2 1 UFP_FLOW_SPECIES_3 species 3 1 UFP_FLOW_SPECIES_4 species 4 1 UFP_FLOW_SPECIES_5 species 5 1 UFP_FLOW_SPECIES_6 species 6 1 UFP_FLOW_SPECIES_7 species 7 1 UFP_FLOW_SPECIES_8 species 8 1 UFP_FLOW_SPECIES_9 species 9 1 UFP_FLOW_GRAD_VELOCITY flow velocity gradient 9 UFP_FLOW_GRAD_PRESSURE pressure gradient 3 UFP_FLOW_GRAD_TEMPERATURE temperature gradient 3 UFP_FLOW_GRAD_EDDY_VISCOSITY eddy viscosity gradient 3 UFP_FLOW_GRAD_SPECIES_1 species 1 gradient 3 UFP_FLOW_GRAD_SPECIES_2 species 2 gradient 3 UFP_FLOW_GRAD_SPECIES_3 species 3 gradient 3 UFP_FLOW_GRAD_SPECIES_4 species 4 gradient 3 UFP_FLOW_GRAD_SPECIES_5 species 5 gradient 3 UFP_FLOW_GRAD_SPECIES_6 species 6 gradient 3 UFP_FLOW_GRAD_SPECIES_7 species 7 gradient 3 UFP_FLOW_GRAD_SPECIES_8 species 8 gradient 3 UFP_FLOW_GRAD_SPECIES_9 species 9 gradient 3
Return Value
The return value is a pointer to a one-dimensional real array.
The size of the array depends on the value of dataName. You are responsible for ensuring that the requested data is available in the AcuSolve data base.
Description
This routine returns the array of flow data at the current particle location and time. For
example,
Real* data ;
Real ext ;
data = ufpGetFlowData( ufpHd, UFP_FLOW_GRAD_VELOCITY ) ;
ext = sqrt(data[0]*data[0] + data[4]*data[4] + data[8]*data[8]) ;
Errors
This routine expects valid ufpHd and dataName as arguments; invalid arguments return an error.