Rate This Document
Findability
Accuracy
Completeness
Readability

KmlMgSolverSetPreconditionerMatrix

Set the preconditioner matrix. The current implementation requires the preconditioner matrix to be identical to the matrix used in the KSP stage.

Interface Definition

C interface:

KmlMgStatus KmlMgSolverSetPreconditionerMatrix(KmlMgSolverH solver, KmlMgMatrixH A);

Parameters

Parameter

Type

Description

Input/Output

solver

KmlMgSolverH

Solver handle created by KmlMgSolverCreate

Input/Output

A

KmlMgMatrixH

Matrix handle created by KmlMgMatrixCreate

Input

Return Value

Return Value

Type

Description

KML_MG_OK

int

Normal execution.

MG_ERR_INVALID_PARAM

int

Invalid parameter.

KML_MG_ERR_UNSUPPORTED

int

Unsupported feature.

KML_MG_ERR_NO_MEMORY

int

Memory allocation failed.

KML_MG_ERR_EXCEEDS_LIMIT

int

Value out of the valid range.

KML_MG_ERR_INCOMPATIBLE

int

Incompatible version.

KML_MG_ERR_NO_REQUIRED_FIELD

int

Required field not set.

KML_MG_ERR_UNKNOWN_TYPE

int

Unknown type.

KML_MG_ERR_THIRD_PART

int

Internal third-party call error.

KML_MG_ERR_INCONSISTENT

int

Inconsistent information transferred.

KML_MG_ERR_UNEXPECTED_CALL_ORDER

int

Unexpected call order.

KML_MG_ERR_MATRIX_VALUE_IS_NULL

int

Null matrix value.

KML_MG_ERR_NO_RESOURCE

int

Resources not ready.

Dependencies

#include "mg.h"

For details about the sample code, see Examples.