Rate This Document
Findability
Accuracy
Completeness
Readability

KmlScaissCgSubPcSet?I?

Set the parameters related to the Block-Jacobi sub-preconditioners in the iterative solution.

Interface Definition

C interfaces:

int KmlScaissCgSubPcSetSII(KmlScasolverTask **handle, enum KmlSolverPreconditionerParam param, int subn, const int *data, int nd);

int KmlScaissCgSubPcSetDII(KmlScasolverTask **handle, enum KmlSolverPreconditionerParam param, int subn, const int *data, int nd);

int KmlScaissCgSubPcSetSIS(KmlScasolverTask **handle, enum KmlSolverPreconditionerParam param, int subn, const float *data, int nd);

int KmlScaissCgSubPcSetDID(KmlScasolverTask **handle, enum KmlSolverPreconditionerParam param, int subn, const double *data, int nd);

Parameters

Parameter

Type

Description

Input/Output

handle

KmlScasolverTask **

Solver handle, which is a variable passed from a previous step.

Input/Output

param

enum KmlSolverParam

  • KML_RELAXATION_FACTOR indicates the parameters related to the SOR preconditioner.
  • KMLSS_DROP_FILL indicates the maximum number of elements to be retained per row for the ILUT preconditioner.
  • KMLSS_DROP_TOL indicates the threshold for retaining elements for the ILUT preconditioner.

Input

subn

int in KmlScaissCgSubPcSetSIS, KmlScaissCgSubPcSetSII, KmlScaissCgSubPcSetDII, and KmlScaissCgSubPcSetDID.

Index of a sub-preconditioner.

Input

data

  • const int * in KmlScaissCgSubPcSetSII and KmlScaissCgSubPcSetDII.
  • const float * in KmlScaissCgSubPcSetSIS.
  • const double * in KmlScaissCgSubPcSetDID.

Parameters related to the preconditioner.

Input

nd

int in KmlScaissCgPcSetSII, KmlScaissCgPcSetSIS, KmlScaissCgPcSetDII, and KmlScaissCgPcSetDID.

Number of elements in the data array.

Input

Return Value

Return Value

Type

Description

KMLSS_NO_ERROR

int

The execution is successful.

KMLSS_DATA_SIZE

int

The value of nd is not 1.

KMLSS_NULL_ARGUMENT

int

A null parameter exists in {handle, data}.

KMLSS_BAD_SELECTOR

int

Parameter param is invalid.

KMLSS_BAD_PRECONDITIONER

int

The selected preconditioner has not been implemented.