# 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)
```
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



## Notes
To change the format of the output call PetscViewerPushFormat(viewer,format) before this call. Use PETSC_VIEWER_DEFAULT for the default,
use PETSC_VIEWER_FAILED to only display a reason if it fails.




## See Also
 [](chapter_ksp), `KSPCreate()`, `KSPSetUp()`, `KSPDestroy()`, `KSPSetTolerances()`, `KSPConvergedDefault()`,
`KSPSolveTranspose()`, `KSPGetIterationNumber()`, `KSP`, `KSPGetConvergedReason()`, `PetscViewerPushFormat()`, `PetscViewerPopFormat()`

## Level
beginner

## Location
<A HREF="PETSC_DOC_OUT_ROOT_PLACEHOLDER/src/ksp/ksp/interface/itfunc.c.html#KSPConvergedReasonView">src/ksp/ksp/interface/itfunc.c</A>

## Examples
<A HREF="PETSC_DOC_OUT_ROOT_PLACEHOLDER/src/ksp/ksp/tutorials/ex1f.F90.html">src/ksp/ksp/tutorials/ex1f.F90.html</A><BR>


---
[Edit on GitLab](https://gitlab.com/petsc/petsc/-/edit/release/src/ksp/ksp/interface/itfunc.c)


[Index of all KSP routines](index.md)  
[Table of Contents for all manual pages](/docs/manualpages/index.md)  
[Index of all manual pages](/docs/manualpages/singleindex.md)  
