KmlAmgPrecondSetApplyOptions
Set and execute preconditioner parameters.
Interface Definition
C interface: KmlAmgStatus KmlAmgPrecondSetApplyOptions(KmlAmgPrecondH precond, const KmlAmgPrecondApplyOptions* options);
Parameters
Parameter |
Type |
Description |
Input/Output |
|---|---|---|---|
precond |
KmlAmgPrecondH |
Preconditioner handle |
Input/Output |
options |
KmlAmgPrecondApplyOptions |
Preconditioner solving 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 KmlAmgPrecondApplyOptions structure (no configuration item available).
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. |
Dependencies
#include "amg4c.h"