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

# MFNGetConvergedReason

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

### Synopsis

    #include "slepcmfn.h"
    PetscErrorCode MFNGetConvergedReason(MFN mfn,MFNConvergedReason *reason)

Not Collective

### Input Parameter

mfn - the matrix function context

### Output Parameter

reason - negative value indicates diverged, positive value converged

### Possible values for reason

| MFN_CONVERGED_TOL | - converged up to tolerance
| MFN_DIVERGED_ITS | - required more than its to reach convergence
| MFN_DIVERGED_BREAKDOWN | - generic breakdown in method

### Note

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

### See Also

MFNSetTolerances(), MFNSolve(), MFNConvergedReason, MFNSetErrorIfNotConverged()

Location: src/mfn/interface/mfnsolve.c
Index of all MFN routines
Table of Contents for all manual pages
Index of all manual pages

### Examples

src/mfn/examples/tutorials/ex23.c.html