Rate This Document
Findability
Accuracy
Completeness
Readability

KmlIssCgSet?I?

Set parameters related to iterative solution.

Interface Definition

C interface:

int KmlIssCgSetSII(KmlSolverTask **handle, enum KML_SOLVER_PARAM param, const int *data, int nd);

int KmlIssCgSetDII(KmlSolverTask **handle, enum KML_SOLVER_PARAM param, const int *data, int nd);

int KmlIssCgSetSIS(KmlSolverTask **handle, enum KML_SOLVER_PARAM param, const float *data, int nd);

int KmlIssCgSetDID(KmlSolverTask **handle, enum KML_SOLVER_PARAM param, const double *data, int nd);

Parameters

Parameter

Type

Description

Input/Output

handle

KmlSolverTask **

Solver handle, which transfers a variable defined previously.

Input/Output

param

enum KML_SOLVER_PARAM

  • KMLSS_THRESHOLD indicates the iteration residual threshold.
  • KMLSS_MAX_ITERATION_COUNT indicates the maximum number of iterations.
  • KMLSS_PRECONDITIONER_TYPE indicates the preconditioner type.
  • KMLSS_VECTOR_NORM_TYPE indicates the norm for computing the iteration residual.
  • KMLSS_MATRIX_FORMAT indicates the sparse storage format of a matrix.

Input

data

  • const int * in KmlIssCgSetSII
  • const int * in KmlIssCgSetDII
  • const float * in KmlIssCgSetSIS
  • const double * in KmlIssCgSetDID

Iterative solution-related parameter array (for example, maximum number of iterations).

Currently available norms for computation:

  • 1-NORM: KMLSS_L1
  • 2-NORM: KMLSS_L2

Currently available sparse matrix storage formats:

  • CSR format: KMLSS_CSR
  • ELLPACK format: KMLSS_ELL
  • COO format: KMLSS_COO
  • ELLPACK_COO hybrid format: KMLSS_SELLCOO

Available preconditioner types:

  • ILU preconditioner: KMLSS_ILU
  • ICC preconditioner: KMLSS_ICC
  • SOR preconditioner: KMLSS_SOR
  • ILUT preconditioner: KMLSS_ILUT

Input

nd

int

Number of elements in the data array.

Input

Return Values

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 argument exists in {handle, data}.

KMLSS_BAD_SELECTOR

int

Parameter param is invalid.

Dependency

#include "kml_iss.h"

Example

C interface:

KmlSolverTask *handle;
int ierr;
int n = 8;  

double a[26] = {1.0, 1.0, 2.0, 9.0, 2.0, 1.0, -3.0, 2.0, 3.0, 2.0, 1.0, 1.0, 9.0, -5.0, 2.0, 6.0, 1.0, -3.0, 1.0, 4.0, 1.0, -5.0, 7.0, 2.0,1.0, 2.0};
int ja[26] = {0, 3, 4, 1, 2, 3, 5, 1, 2, 7, 0, 1, 3, 6, 0, 4, 5, 1, 4, 5, 7, 3, 6, 2, 5, 7};
int ia[9] = {0, 3, 7, 10, 14, 17, 21, 23, 26};

ierr = KmlIssCgInitDI(&handle, n, a, ja, ia);

int nd = 1;
int idata[] = {0};
double ddata[] = {0};
double eps = 1e-4;
ierr = KmlIssCgSetDID(&handle, KMLSS_THRESHOLD, &eps, nd);
if (ierr != 0) {
    printf("\nERROR in KmlIssCgSetDID: %d", ierr);
    return 1;
    }
int max_iters = 2000;
ierr = KmlIssCgSetDII(&handle, KMLSS_MAX_ITERATION_COUNT, &max_iters, nd);
if (ierr != 0) {
    printf("\nERROR in KmlIssCgSetDII: %d", ierr);
    return 1;
    }