udfFirstStep()

Determine whether this is the initial time step of this run.

Syntax

firstStep = udfFirstStep( udfHd ) ;

Type

AcuSolve User-Defined Function Basic

Parameters

udfHd
The opaque handle (pointer) which was passed to the user function.

Return Value

firstStep (integer)
The integer return value firstStep indicates whether or not this is the initial time step of this run:
0
No, this is not the first time.
1
Yes, this is the first time.

Description

This routine determines if this user-defined function is called during the first time step. For example,
Integer firstStep ;
...
firstStep = udfFirstStep( udfHd ) ;
if ( firstStep == 1 ) {
   /* possible initialization */
} else {
   /* the rest of the time */
}

Errors

This routine expects a valid udfHd.