KmlScaissCsiSetUserPreconditioner?I
Associate with user-defined preconditioners for callback. This interface is not required if no user-defined preconditioner is used.
Interface Definition
C interfaces:
int KmlScaissCsiSetUserPreconditionerSI(KmlScasolverTask **handle, void *ustruct, int (*fptr)(void *ustruct, float *x));
int KmlScaissCsiSetUserPreconditionerDI(KmlScasolverTask **handle, void *ustruct, int (*fptr)(void *ustruct, double *x));
Parameters
Parameter |
Type |
Description |
Input/Output |
|---|---|---|---|
handle |
KmlScasolverTask ** |
Solver handle, which is a variable passed from a previous step. |
Input/Output |
ustruct |
void * |
Pointer to user data. This parameter is transferred as the first parameter each time the preconditioner is called. |
Input |
(*fptr) |
int |
User-defined function pointer to the callback function. The callback function performs calculation between the preconditioner and its second parameter. |
Input |
Return Value
Return Value |
Type |
Description |
|---|---|---|
KMLSS_NO_ERROR |
int |
The execution is successful. |
KMLSS_NULL_ARGUMENT |
int |
A null parameter exists in {handle, fptr}. |