udfSetSig()

Set a signal to alter the behavior of AcuSolve.

Syntax

udfSetSig( udfHd, name, value ) ;

Type

AcuSolve User-Defined Function Basic

Parameters

udfHd
The opaque handle (pointer) which was passed to the user function.
name
integer
Symbolic name of the signal to be set
UDF_SIG_NO_CONV
Stagger not converged.
UDF_SIG_DONT_AMP_TIMEINC
Do not amplify time increment.
UDF_SIG_REDUCE_TIMEINC
Reduce time increment.
UDF_SIG_REDO_STEP
Redo time step.
UDF_SIG_MUST_REDO_STEP
Must redo time step.
UDF_SIG_FATAL
Fatal error, exit.
UDF_SIG_STOP
Stop at end of step.
UDF_SIG_OUTPUT
Output at end of step.
UDF_SIG_OUTPUT_RESIDUAL
Output nodal residual.
UDF_SIG_PARTIAL_UPDATE
Partially update solution.
value (real)
Value of the signal. Ignored except for UDF_SIG_PARTIAL_UPDATE name.

Return Value

None

Description

This routine allows you to send a signal to AcuSolve from a user-defined function. For example, to signal AcuSolve to stop at the end of the current time step:
udfSetSig( udfHd, UDF_SIG_STOP, 0 ) ;

Errors

  • This routine expects a valid udfHd.
  • name must be one of the supported names.