slepc-3.21.0 2024-03-30
SVDSetConvergenceTestFunction
Sets a function to compute the error estimate used in the convergence test.
Synopsis
#include "slepcsvd.h"
PetscErrorCode SVDSetConvergenceTestFunction(SVD svd,PetscErrorCode (*conv)(SVD svd,PetscReal sigma,PetscReal res,PetscReal *errest,void *ctx),void* ctx,PetscErrorCode (*destroy)(void*))
Logically Collective
Input Parameters
| svd | - singular value solver context obtained from SVDCreate()
|
| conv | - a pointer to the convergence test function
|
| ctx | - context for private data for the convergence routine (may be null)
|
| destroy | - a routine for destroying the context (may be null)
|
Calling sequence of conv
PetscErrorCode conv(SVD svd,PetscReal sigma,PetscReal res,PetscReal *errest,void *ctx)
| svd | - singular value solver context obtained from SVDCreate()
|
| sigma | - computed singular value
|
| res | - residual norm associated to the singular triplet
|
| errest | - (output) computed error estimate
|
| ctx | - optional context, as set by SVDSetConvergenceTestFunction()
|
Note
If the error estimate returned by the convergence test function is less than
the tolerance, then the singular value is accepted as converged.
See Also
SVDSetConvergenceTest(), SVDSetTolerances()
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