Rate This Document
Findability
Accuracy
Completeness
Readability

KmlIssGcrGet?I?

Obtain parameters related to iterative solution.

Interface Definition

C interface:

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

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

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

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

Parameters

Parameter

Type

Description

Input/Output

handle

KmlSolverTask **

Solver handle, which is a variable transferred previously

Input/Output

param

enum KML_SOLVER_PARAM

  • ITERATION_COUNT indicates the number of iterations.
  • TOLERANCE indicates the final iteration residual.

Input

data

  • int * in KmlIssGcrGetSII
  • int * in KmlIssGcrGetDII
  • float * in KmlIssGcrGetSIS
  • double * in KmlIssGcrGetDID
  • Number of iteration steps in KmlIssGcrGetSII
  • Number of iteration steps in KmlIssGcrGetDII
  • Residual in KmlIssGcrGetSIS
  • Residual in KmlIssGcrGetDID

Input

nd

int

Number of elements in the data array

Input

Return Values

Return Value

Type

Description

NO_ERROR

int

The execution is successful.

DATA_SIZE_ERROR

int

The number of data records is incorrect.

KML_SOLVER_INVALID_ARGUMENT

int

Invalid parameter.

Dependencies

#include "kml_iss.h"

Examples

C interface:

    KmlSolverTask *handle
    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};

  
    int nb = 0;
    double x[8]
    int ldx = 0;
    double b[8] = {4.0, 9.0, 7.0, 6.0, 9.0, 3.0, 2.0, 5.0};
    int ldb = 0;
    KML_SOLVER_PARAM param = ITERATION_COUNT;
    int data[] = {0};
    int nd = 1;
    double data1[] = {0};
    int ierr;
    ierr = KmlIssGcrInitDI(&handle, n, a, ja, ia);
    ierr = KmlIssGcrAnalyzeDI(&handle);
    ierr = KmlIssGcrFactorizeDI(&handle);
    ierr = KmlIssGcrSolveDI(&handle, nb, x, ldx, b, ldb);
    ierr = KmlIssGcrGetDII(&handle, param, data, nd);
    param = TOLERANCE;
    ierr = KmlIssGcrGetDID(&handle, param, data1, nd);