slepc-3.21.2 2024-09-25
SVDSetStoppingTestFunction
Sets a function to decide when to stop the outer iteration of the singular value solver.
Synopsis
#include "slepcsvd.h"
PetscErrorCode SVDSetStoppingTestFunction(SVD svd,PetscErrorCode (*stop)(SVD svd,PetscInt its,PetscInt max_it,PetscInt nconv,PetscInt nsv,SVDConvergedReason *reason,void *ctx),void* ctx,PetscErrorCode (*destroy)(void*))
Logically Collective
Input Parameters
| svd | - singular value solver context obtained from SVDCreate()
|
| stop | - pointer to the stopping test function
|
| ctx | - context for private data for the stopping routine (may be null)
|
| destroy | - a routine for destroying the context (may be null)
|
Calling sequence of stop
PetscErrorCode stop(SVD svd,PetscInt its,PetscInt max_it,PetscInt nconv,PetscInt nsv,SVDConvergedReason *reason,void *ctx)
| svd | - singular value solver context obtained from SVDCreate()
|
| its | - current number of iterations
|
| max_it | - maximum number of iterations
|
| nconv | - number of currently converged singular triplets
|
| nsv | - number of requested singular triplets
|
| reason | - (output) result of the stopping test
|
| ctx | - optional context, as set by SVDSetStoppingTestFunction()
|
Note
Normal usage is to first call the default routine SVDStoppingBasic() and then
set reason to SVD_CONVERGED_USER if some user-defined conditions have been
met. To let the singular value solver continue iterating, the result must be
left as SVD_CONVERGED_ITERATING.
See Also
SVDSetStoppingTest(), SVDStoppingBasic()
Level
advanced
Location
src/svd/interface/svdopts.c
Index of all SVD routines
Table of Contents for all manual pages
Index of all manual pages