EPSStoppingTestFn#
A prototype of an EPS stopping test function that would be passed to EPSSetStoppingTestFunction().
Synopsis#
PETSC_EXTERN_TYPEDEF typedef PetscErrorCode EPSStoppingTestFn(EPS eps,PetscInt its,PetscInt max_it,PetscInt nconv,PetscInt nev,EPSConvergedReason *reason,void *ctx);
Calling Sequence#
eps - the linear 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
EPSSetStoppingTestFunction()
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 EPS_CONVERGED_ITERATING
(zero).
See Also#
EPS: Eigenvalue Problem Solver, EPSSetStoppingTest(), EPSSetStoppingTestFunction()
Level#
advanced
Location#
Index of all EPS routines Table of Contents for all manual pages Index of all manual pages