KesSolverSetConvergeDetectorType
Interface Definition
KesReturnCode KesSolverSetConvergeDetectorType(KesSolver solver, KesConvergeDetectorType type);
Interface Description
Set the converge detector type. The default value is KES_RESIDUALS.
Parameters
Parameter |
Type |
Description |
Input/Output |
|---|---|---|---|
solver |
KesSolver |
Handle to the solver. It cannot be a null pointer. |
Input/Output |
type |
KesConvergeDetectorType |
Converge detector type. |
Input |
KesConvergeDetectorType |
Description |
|---|---|
KES_RESIDUALS |
The residual ||Ax - kBx|| is less than the convergence threshold. |
KES_RELATIVE_RESIDUALS |
The relative residual ||Ax - kBx|| / |k| is less than the convergence threshold. |
KES_EIGENVALUES |
The difference (|k - k'|) between the current eigenvalue and the eigenvalue in the previous iteration is less than the convergence threshold. |
KES_RESIDUALS_OR_EIGENVALUES |
The residual || Ax - kBx|| or |k - k'| is less than the convergence threshold. |