KmlAmgPrecondApply
Performs a preconditioned solution process. When using the preconditioner alone, the parameter x must be initialized to zero; non-zero initial values are not supported.
Interface Definition
C interface: KmlAmgStatus KmlAmgPrecondApply(KmlAmgPrecondH precond, KmlAmgMatrixH b, KmlAmgMatrixH x);
Parameters
Parameter |
Type |
Description |
Input/Output |
|---|---|---|---|
precond |
KmlAmgPrecondH |
Preconditioner handle |
Input |
b |
KmlAmgMatrixH |
Matrix handle, indicating the RHS vector. |
Input |
x |
KmlAmgMatrixH |
Matrix handle, indicating the solution vector. The initial input value is used as the initial value for the first iteration. |
Input/Output |
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"