KSPSetUsePreconditionedResidual

Sets a flag so that the two norm of the preconditioned residual is used rather than the true residual, in the default convergence tests.

Synopsis

int KSPSetUsePreconditionedResidual(KSP ksp)
Collective on KSP

Input Parameter

ksp -iterative context obtained from KSPCreate()

Notes

Currently only CG, CHEBYCHEV, and RICHARDSON use this with leftpreconditioning. All other methods always used the preconditionedresidual. With right preconditioning this flag is ignored, sincethe preconditioned residual and true residual are the same.

Options Database Key

-ksp_preres -Activates KSPSetUsePreconditionedResidual()

Keywords

KSP, set, residual, precondition, flag

Location: src/ksp/interface/itfunc.c
KSP Index
Table of Contents