udfGetActSpecId()

The identification number of the current species being solved.

Syntax

specId = udfGetActSpecId( udfHd ) ;

Type

AcuSolve User-Defined Function Global

Parameters

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

Return Value

specId (integer): Identification number of the species being solved. If not within a species stagger, the return value is zero. The return value is one based.

Description

This routine returns the identification number of species being solved in the current stagger. For example,

Integer specId ;
...
specId = udfGetActSpecId( udfHd ) ;

Errors

This routine expects a valid udfHd.