EPSConvergedReasonView#

Displays the reason an EPS solve converged or diverged.

Synopsis#

#include "slepceps.h" 
PetscErrorCode EPSConvergedReasonView(EPS eps,PetscViewer viewer)

Collective

Input Parameters#

eps - the linear eigensolver context
viewer - the viewer to display the reason

Options Database Key#

-eps_converged_reason - print reason for convergence/divergence, and number of iterations

Notes#

Use EPSConvergedReasonViewFromOptions() to display the reason based on values in the options database.

To change the format of the output call PetscViewerPushFormat() before this call. Use PETSC_VIEWER_DEFAULT for the default, or PETSC_VIEWER_FAILED to only display a reason if it fails. The latter can be set in the command line with -eps_converged_reason ::failed.