Rate This Document
Findability
Accuracy
Completeness
Readability

KmlScaissBicgstabSubPcSet?I?

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

Interface Definition

C interface:

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

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

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

int KmlScaissBicgstabSubPcSetDID(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 KmlScaissBicgstabSubPcSetSIS/KmlScaissBicgstabSubPcSetSII/ KmlScaissBicgstabSubPcSetDII/ KmlScaissBicgstabSubPcSetDID

Index of a sub-preconditioner.

Input

data

  • const int * in KmlScaissBicgstabSubPcSetSII/KmlScaissBicgstabSubPcSetDII
  • const float * in KmlScaissBicgstabSubPcSetSIS
  • const double * in KmlScaissBicgstabSubPcSetDID

Parameters related to the preconditioner.

Input

nd

  • int in KmlScaissBicgstabSubPcSetSIS/KmlScaissBicgstabSubPcSetSII/ KmlScaissBicgstabSubPcSetDII/ KmlScaissBicgstabSubPcSetDID

Number of elements in the data array.

Input

Return Value

Return Value

Type

Description

KMLSS_NO_ERROR

int

Normal execution.

KMLSS_DATA_SIZE

int

The value of nd is not 1.

KMLSS_NULL_ARGUMENT

int

A null argument exists in {handle, data}.

KMLSS_BAD_SELECTOR

int

param is invalid.

KMLSS_BAD_PRECONDITIONER

int

The selected preconditioner has not been implemented.