slepc-3.6.3 2016-03-29
Report Typos and Errors

# NEPGetConvergedReason

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

### Synopsis

    #include "slepcnep.h"
    PetscErrorCode NEPGetConvergedReason(NEP nep,NEPConvergedReason *reason)

Not Collective

### Input Parameter

nep - the nonlinear eigensolver context

### Output Parameter

reason - negative value indicates diverged, positive value converged

### Possible values for reason

| NEP_CONVERGED_FNORM_ABS | - function norm satisfied absolute tolerance
| NEP_CONVERGED_FNORM_RELATIVE | - function norm satisfied relative tolerance
| NEP_CONVERGED_SNORM_RELATIVE | - step norm satisfied relative tolerance
| NEP_DIVERGED_LINEAR_SOLVE | - inner linear solve failed
| NEP_DIVERGED_FUNCTION_COUNT | - reached maximum allowed function evaluations
| NEP_DIVERGED_MAX_IT | - required more than its to reach convergence
| NEP_DIVERGED_BREAKDOWN | - generic breakdown in method
| NEP_DIVERGED_FNORM_NAN | - Inf or NaN detected in function evaluation

### Note

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

### See Also

NEPSetTolerances(), NEPSolve(), NEPConvergedReason

Location: src/nep/interface/nepsolve.c
Index of all NEP routines
Table of Contents for all manual pages
Index of all manual pages