KmlAmgPrecondQuery
Query preconditioner information.
Interface Definition
C interface:
KmlAmgStatus KmlAmgPrecondQuery(KmlAmgPrecondH precond, KmlAmgPrecondInfo* info);
Parameters
Parameter |
Type |
Description |
Input/Output |
|---|---|---|---|
precond |
KmlAmgPrecondH |
Preconditioner handle |
Input |
info |
KmlAmgPrecondInfo |
Preconditioner information results for user queries |
Input/Output |
Return Value
Return Value |
Type |
Description |
|---|---|---|
KMLAMG_SUCCESS |
int |
Successful execution. |
KMLAMG_ERR_INVALID_PARAM |
int |
Invalid parameter. |
KMLAMG_ERR_UNSUPPORTED |
int |
Unsupported feature. |
KMLAMG_ERR_NULL_POINTER |
int |
Null pointer |
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. |
Structure Description
The table below describes the KmlAmgPrecondInfo structure.
Field |
Type |
Description |
|---|---|---|
fieldMask |
uint64_t |
Mask that determines to which fields the configuration is applied. A non-zero bit indicates that the value specified by the corresponding field is used, and a zero bit indicates that the default value is used. Currently, no mask bit can be configured. |
perm |
void* |
Reordering/Partitioning permutation applied to the matrix. After permutation, the i-th row/column of the matrix corresponds to the perm[i]-th row/column of the original matrix. You need to allocate sufficient space, that is, N * sizeof(IndexType). - N: global dimension of the matrix. - IndexType: TyamgIndexType of the preconditioner, which can be int32_t or int64_t. |
localBegin |
int64_t |
Start row/column index of the matrix in the current process after reordering. |
Dependencies
#include "amg4c.h"