KSPGetConvergedReason

Gets the reason the KSP iteration was stopped.

Synopsis

#include "ksp.h" 
int KSPGetConvergedReason(KSP ksp,KSPConvergedReason *reason)
Not Collective

Input Parameter

ksp - the KSP context

Output Parameter

reason - negative value indicates diverged, positive value converged, see ksp.h or the manual pages for the individual convergence tests for complete lists

Notes: Can only be called after the call the KSPSolve() is complete.

Keywords

KSP, nonlinear, set, convergence, test

See Also

KSPSetConvergenceTest(), KSPDefaultConverged()

Level:intermediate
Location:src/sles/ksp/interface/iterativ.c
KSP Index
Table of Contents