slepc-3.22.2 2024-12-02
Report Typos and Errors

# EPSSetStoppingTestFunction

Sets a function to decide when to stop the outer iteration of the eigensolver.

### Synopsis

    #include "slepceps.h"
    PetscErrorCode EPSSetStoppingTestFunction(EPS eps,EPSStoppingTestFn *func,void* ctx,PetscErrorCode (*destroy)(void*))

Logically Collective

### Input Parameters

| eps | - eigensolver context obtained from EPSCreate()
| func | - stopping test function, see EPSStoppingTestFn for the calling sequence
| ctx | - context for private data for the stopping routine (may be NULL)
| destroy | - a routine for destroying the context (may be NULL)

### Note

Normal usage is to first call the default routine EPSStoppingBasic() and then set reason to EPS_CONVERGED_USER if some user-defined conditions have been met. To let the eigensolver continue iterating, the result must be left as EPS_CONVERGED_ITERATING.

### See Also

EPSSetStoppingTest(), EPSStoppingBasic()

### Level

advanced

### Location

src/eps/interface/epsopts.c

### Examples

src/eps/tutorials/ex29.c
src/eps/tutorials/ex30.c
Index of all EPS routines
Table of Contents for all manual pages
Index of all manual pages