Rate This Document
Findability
Accuracy
Completeness
Readability

KmlDssSymGet?I(D/S)

Interface Definition

C interface:

int KmlDssSymGetSIS(KmlSolverTask **pHandle, enum KmlSolverParam param, float *value, int nvalue);

int KmlDssSymGetDID(KmlSolverTask **pHandle, enum KmlSolverParam param, double *value, int nvalue);

int KmlDssSymGetCIS(KmlSolverTask **pHandle, enum KmlSolverParam param, float *value, int nvalue);

int KmlDssSymGetZID(KmlSolverTask **pHandle, enum KmlSolverParam param, double *value, int nvalue);

Parameters

Parameter

Type

Description

Input/Output

pHandle

KmlSolverTask **

Solver handle. pHandle cannot be a null pointer.

Input

param

enum KmlSolverParam

Currently, only KMLSS_REFINEMENT_RESIDUAL is supported, indicating the residual of iterative refinement.

Input

value

double or float

Array containing parameters related to direct resolution

Output

nvalue

int

Number of elements in the value array. The number must be the same as the number of RHS terms (nb).

Input

Return Value

Return Value

Type

Description

KMLSS_NO_ERROR

int

The execution is successful.

KMLSS_NULL_ARGUMENT

int

The pHandle or data pointer is null, or the parameter is invalid.

KMLSS_BAD_HANDLE

int

The format of pHandle is incorrect.

KMLSS_BAD_DATA_SIZE

int

The user-defined length (nvalue) of the value array is improper. That is, nvalue is inconsistent with the number of RHS terms.

KMLSS_BAD_SELECTOR

int

The input value of KML_SOLVER_PARAM is not supported currently or does not exist during the analysis.

Dependencies

#include "kml_dss.h" or #include "kml_solver.h"

Examples

C interface:

int n = 8;
int ia[9] = {0, 2, 4, 6, 7, 8, 9, 10, 11};
int ja[11] = {0, 7, 1, 6, 2, 5, 3, 4, 5, 6, 7};
double a[11] = {1.0, 2.0, -2.0, 3.0, 3.0, 4.0, -4.0, 5.0, -6.0, 7.0, 8.0};

double b[8] = {3.0, 1.0, 7.0, -4.0, 5.0, -2.0, 10.0, 10.0};
double x[8];
int nrhs = 1;
int ldx = n, ldb = n;

KmlSolverTask *handle;
int ierr = KmlDssSymInitDI(&handle, n, a, ja, ia);
if (ierr != 0) {
        printf("\nERROR in KmlDssSymInitDI: %d", ierr);
}
ierr = KmlDssSymAnalyzeDI(&handle);
if (ierr != 0) {
        printf("\nERROR in KmlDssSymAnalyzeDI: %d", ierr);
}
ierr = KmlDssSymFactorizeDI(&handle);
if (ierr != 0) {
        printf("\nERROR in KmlDssSymFactorizeDI: %d", ierr);
}

double tolerance = 1.e-12;
ierr = KmlDssSymSetDID(&handle, KMLSS_REFINEMENT_TOLERANCE_LEVEL, &tolerance, 1);
if (ierr != 0) {
        printf("\nERROR in KmlDssSymSetDID: %d", ierr);
}
int nsteps = 2;
ierr = KmlDssSymSetDII(&handle, KMLSS_REFINEMENT_MAX_STEPS, &nsteps, 1);
if (ierr != 0) {
        printf("\nERROR in KmlDssSymSetDII: %d", ierr);
}
ierr = KmlDssSymSolveDI(&handle, nrhs, x, ldx, b, ldb);
if (ierr != 0) {
        printf("\nERROR in KmlDssSymSolveDI: %d", ierr);
}

double res;
ierr = KmlDssSymGetDID(&handle, KMLSS_REFINEMENT_RESIDUAL, &res, 1);
if (ierr != 0) {
        printf("\nERROR in KmlDssSymGetDID: %d", ierr);
}
printf("REFINEMENT_RESIDUAL = %f\n", res);
Output:
REFINEMENT_RESIDUAL = 0.000000