Rate This Document
Findability
Accuracy
Completeness
Readability

KmlAmgSolverSetPrec

Set a preconditioner for the iterative solver.

Interface Definition

C interface: KmlamgStatus KmlamgSolverSetPrec(KmlAmgSolverH solver, KmlamgKmlAmgPrecondH precond);

Parameters

Parameter

Type

Description

Input/Output

solver

KmlAmgSolverH

Iterative solver handle

Input/Output

precond

KmlAmgPrecondH

Preconditioner handle

Input

Return Value

Return Value

Type

Description

KMLAMG_SUCCESS

int

The execution is successful.

KMLAMG_ERR_INVALID_PARAM

int

The parameter is invalid.

KMLAMG_ERR_UNSUPPORTED

int

Unsupported feature.

KMLAMG_ERR_NULL_POINTER

int

The pointer is null.

KMLAMG_ERR_NO_REQUIRED_FIELD

int

Required field not set.

KMLAMG_ERR_NO_MEMORY

int

Memory allocation failed.

KMLAMG_ERR_UNKNOWN_TYPE

int

Unknown type.

KMLAMG_ERR_UNEXPECTED_CALL_ORDER

int

Unexpected call order.

KMLAMG_ERR_NO_RESOURCE

int

Resources not ready.

KMLAMG_ERR_INCONSISTENT

int

Inconsistent information transferred in different phases.

KMLAMG_ERR_UNKNOWN_ERROR

int

Unknown error.

Dependencies

#include "amg4c.h"