KmlAmgPrecondCreate
Create a preconditioner handle.
Interface Definition
C interface: KmlAmgStatus KmlAmgPrecondCreate(KmlAmgPrecondH* precond, const KmlAmgPrecondOptions* options);
Parameters
Parameter |
Type |
Description |
Input/Output |
|---|---|---|---|
precond |
KmlAmgPrecondH* |
Preconditioner handle. precond cannot be a null pointer. |
Input/Output |
options |
const KmlAmgPrecondOptions* |
Preconditioner configuration. |
Input |
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 KmlAmgPrecondOptions 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. |
valueType |
KmlAmgValueType |
Value type of the preconditioner matrix.
Mask bit: KMLAMG_PRECOND_OPTIONS_VALUE_TYPE |
indexType |
KmlAmgIndexType |
Index type of the preconditioner matrix.
Mask bit: KMLAMG_PRECOND_OPTIONS_INDEX_TYPE |
precondType |
KmlAmgPrecondType |
Preconditioner type: KMLAMG_PRECOND_AMG: AMG preconditioner Mask bit: KMLAMG_PRECOND_OPTIONS_TYPE |
numThreads |
int32_t |
Number of threads. Mask bit: KMLAMG_PRECOND_OPTIONS_NUM_THREADS |
Dependencies
#include "amg4c.h"