KmlAmgSolverQuery
Query the information about the iterative solver.
Interface Definition
C interface: KmlAmgStatus KmlAmgSolverQuery(KmlAmgSolverH solver, KmlAmgSolverInfo* info);
Parameters
Parameter |
Type |
Description |
Input/Output |
|---|---|---|---|
solver |
KmlAmgSolverH |
Iterative solver handle |
Input |
info |
KmlAmgSolverInfo* |
Iterative solver 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 KmlAmgSolverInfo structure.
Field |
Type |
Description |
|---|---|---|
fieldMask |
uint64_t |
Mask that determines to which fields the configuration is applied. If a bit is set to 1, its corresponding field uses a specified value. If a bit is set to 0, its corresponding field uses the default value. See the individual field description for configurable mask bits. |
nIters |
int64_t |
Number of iterations. Mask bit: KMLAMG_SOLVER_INFO_NUM_ITERS |
perm |
void * |
Permutation used for matrix reordering. This parameter is valid only when partitionAlgo is not set to KMLAMG_PARTITION_NONE. Mask bit: KMLAMG_SOLVER_INFO_PERM |
localBegin |
int64_t |
Start row/column index of the matrix in the current process after reordering. This parameter is valid only when partitionAlgo is not set to KMLAMG_PARTITION_NONE. Mask bit: KMLAMG_SOLVER_INFO_LOCAL_BEGIN |
Dependencies
#include "amg4c.h"