slepc-3.7.0 2016-05-16
Report Typos and Errors

EPSGetConvergedReason

Gets the reason why the EPSSolve() iteration was stopped.

Synopsis

#include "slepceps.h" 
PetscErrorCode EPSGetConvergedReason(EPS eps,EPSConvergedReason *reason)
Not Collective

Input Parameter

eps  - the eigensolver context

Output Parameter

reason  - negative value indicates diverged, positive value converged

Possible values for reason

EPS_CONVERGED_TOL  - converged up to tolerance
EPS_CONVERGED_USER  - converged due to a user-defined condition
EPS_DIVERGED_ITS  - required more than max_it iterations to reach convergence
EPS_DIVERGED_BREAKDOWN  - generic breakdown in method
EPS_DIVERGED_SYMMETRY_LOST  - pseudo-Lanczos was not able to keep symmetry

Note

Can only be called after the call to EPSSolve() is complete.

See Also

EPSSetTolerances(), EPSSolve(), EPSConvergedReason

Location: src/eps/interface/epssolve.c
Index of all EPS routines
Table of Contents for all manual pages
Index of all manual pages

Examples

src/eps/examples/tutorials/ex29.c.html