KmlAmgSolverSetApplyOptions
Perform back substitution.
Interface Definition
C interface: KmlAmgStatus KmlAmgSolverSetApplyOptions(KmlAmgSolverH solver, const KmlAmgSolverApplyOptions* options);
Parameters
Parameter |
Type |
Description |
Input/Output |
|---|---|---|---|
solver |
KmlAmgSolverH |
Iterative solver handle |
Input/Output |
options |
const KmlAmgSolverApplyOptions* |
Configuration options for iterative solving |
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 KmlAmgSolverApplyOptions 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. |
maxIters |
int64_t |
Maximum number of iterations allowed by the iterative method. If the number of iterations exceeds this value, the iteration automatically stops. The default value is 1000. Mask bit: KMLAMG_SOLVER_APPLY_OPTIONS_MAX_ITERS |
tolerance |
double |
Error value of the iterative method. The default value is 1e-10. Mask bit: KMLAMG_SOLVER_APPLY_OPTIONS_TOLERANCE |
Dependencies
#include "amg4c.h"