KSPConvergedReason#

reason a Krylov method was determined to have converged or diverged

Synopsis#

Values#

Note#

The values KSP_CONVERGED_NEG_CURVE, and KSP_CONVERGED_STEP_LENGTH are returned only by KSPCG, KSPMINRES and by the special KSPNASH, KSPSTCG, and KSPGLTR solvers which are used by the SNESNEWTONTR (trust region) solver.

Developer Note#

The string versions of these are KSPConvergedReasons; if you change any of the values here also change them that array of names.

See Also#

KSP: Linear System Solvers, KSP, KSPSolve(), KSPGetConvergedReason(), KSPSetTolerances(), KSPConvergedReasonView()

Level#

beginner

Location#

include/petscksp.h

Examples#

src/dm/impls/stag/tutorials/ex4.c
src/dm/impls/stag/tutorials/ex8.c
src/ksp/ksp/tutorials/ex76.c
src/ksp/ksp/tutorials/ex87.c
src/snes/tutorials/ex6.c
src/ksp/ksp/tutorials/ex77.c
src/ksp/pc/tutorials/ex1.c
src/ksp/pc/tutorials/ex2.c
src/ksp/ksp/tutorials/ex59.c
src/ksp/ksp/tutorials/ex72.c


Index of all KSP routines
Table of Contents for all manual pages
Index of all manual pages