Rate This Document
Findability
Accuracy
Completeness
Readability

KmlDss(Spd/Hpd)Get?II

Obtain handle-related integer values.

Interface Definition

C interfaces:

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

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

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

int KmlDssHpdGetZII(KmlSolverTask **pHandle, enum KmlSolverParam param, int *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_STEPS is supported, indicating the number of iterative refinements.

Input

value

int *

Array containing parameters related to direct solution methods.

Output

nvalue

int

Number of elements in the value array. Currently, the number must be 1.

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.

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 not 1.

KMLSS_BAD_SELECTOR

int

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

Dependencies

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

Examples

C interface:

int n = 2;
int ia[3] = {0,2,4};
int ja[4] = {0,1,0,1};
double a[4] = {2,1,1,2};
double b[2] = {3,1};
double x[2];

int nrhs = 1;
int ldx = n, ldb = n;

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

double tolerance = 1.e-12;
ierr = KmlDssSpdSetDID(&handle, KMLSS_REFINEMENT_TOLERANCE_LEVEL, &tolerance, 1);
if (ierr != 0) {
        printf("\nERROR in KmlDssSpdSetDID: %d", ierr);
}
int nsteps = 2;
ierr = KmlDssSpdSetDII(&handle, KMLSS_REFINEMENT_MAX_STEPS, &nsteps, 1);
if (ierr != 0) {
        printf("\nERROR in KmlDssSpdSetDII: %d", ierr);
}

ierr = KmlDssSpdSolveDI(&handle, nrhs, x, ldx, b, ldb);
if (ierr != 0) {
        printf("\nERROR in KmlDssSpdSolveDI: %d", ierr);
}

printf("\n");
int nstep;
ierr = KmlDssSpdGetDII(&handle, KMLSS_REFINEMENT_STEPS, &nstep, 1);
if (ierr != 0) {
        printf("\nERROR in KmlDssSpdGetDII: %d", ierr);
}
printf("REFINEMENT_STEP = %d\n", nstep);
Output:
REFINEMENT_STEP = 1