petsc-master 2020-08-25
Report Typos and Errors

KSPConvergedReasonView

Displays the reason a KSP solve converged or diverged to a viewer

Synopsis

#include "petscksp.h" 
#include "petscmat.h" 
PetscErrorCode KSPConvergedReasonView(KSP ksp, PetscViewer viewer, PetscViewerFormat format)
Collective on ksp

Parameter

ksp - iterative context obtained from KSPCreate()
viewer - the viewer to display the reason

Options Database Keys

-ksp_converged_reason - print reason for converged or diverged, also prints number of iterations
-ksp_converged_reason ::failed - only print reason and number of iterations when diverged

See Also

KSPCreate(), KSPSetUp(), KSPDestroy(), KSPSetTolerances(), KSPConvergedDefault(),
KSPSolveTranspose(), KSPGetIterationNumber(), KSP, KSPGetConvergedReason()

Level

beginner

Location

src/ksp/ksp/interface/itfunc.c
Index of all KSP routines
Table of Contents for all manual pages
Index of all manual pages