ufpGetTimeInc()

Get the time increment for the current particle segment.

Syntax

dt = ufpGetTimeInc ( ufpHd ) ;

Type

AcuTrace User-Defined Function Particle Routine

Parameters

ufpHd (pointer): The opaque handle which was passed to the user function

Return Value

The return value is the particle time increment (real value). This time increment is not the time increment returned by the AcuSolve User-Defined Function udfGetTimeInc.

Description

This routine returns the time increment for the current particle segment. For example,

Real  dt;
...
dt = ufpGetTimeInc( ufpHd ) ;

Errors

This routine expects a valid ufpHd as an argument; an invalid argument returns an error.