Skip to main content
`Ctrl`+`K`

# PEPStoppingTestFn

A prototype of a `PEP` stopping test function that would be passed to `PEPSetStoppingTestFunction()`.

## Synopsis

    PETSC_EXTERN_TYPEDEF typedef PetscErrorCode PEPStoppingTestFn(PEP pep,PetscInt its,PetscInt max_it,PetscInt nconv,PetscInt nev,PEPConvergedReason *reason,PetscCtx ctx);

## Calling Sequence

- pep - the polynomial eigensolver context

- its - current number of iterations

- max_it - maximum number of iterations

- nconv - number of currently converged eigenpairs

- nev - number of requested eigenpairs

- reason - [output] result of the stopping test

- ctx - optional stopping context, as set by `PEPSetStoppingTestFunction()`

## Note

A positive value of `reason` indicates that the iteration has finished successfully (converged), and a negative value indicates an error condition (diverged). If the iteration needs to be continued, `reason` must be set to `PEP_CONVERGED_ITERATING` (zero).

## See Also

PEP: Polynomial Eigenvalue Problems, `PEPSetStoppingTestFunction()`

## Level

advanced

## Location

include/slepcpep.h

Index of all PEP routines Table of Contents for all manual pages Index of all manual pages