Rate This Document
Findability
Accuracy
Completeness
Readability

KmlDss(Spd/Hpd)Set?I(D/S)

Set handle-related real-number values.

Interface Definition

C interfaces:

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

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

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

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

Parameters

Parameter

Type

Description

Input/Output

pHandle

KmlSolverTask **

Solver handle. pHandle cannot be a null pointer.

Input

param

enum KmlSolverParam

  • KMLSS_REFINEMENT_TOLERANCE_LEVEL indicates the threshold set for the iterative refinement algorithm.
  • KMLSS_PIVOTING_THRESHOLD indicates the threshold set by the iterative pivoting algorithm. Its value is the value set by the pivoting algorithm.

Input

value

double * or float *

Array containing parameters related to direct solution methods.

Input

nvalue

int

Number of elements in the value array.

Input

Return Value

Return Value

Type

Description

KMLSS_NO_ERROR

int

The execution is successful.

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);
}

int nstep;
ierr = KmlDssSpdGetDII(&handle, KMLSS_REFINEMENT_STEPS, &nstep, 1);
printf("REFINEMENT_STEP = %d\n", nstep);
double res;
ierr = KmlDssSymGetDID(&handle, KMLSS_REFINEMENT_RESIDUAL, &res, 1);
printf("REFINEMENT_RESIDUAL = %f\n", res);
Output:
REFINEMENT_STEP = 1
REFINEMENT_RESIDUAL = 0.000000