slepc-main 2024-11-15
Report Typos and Errors

SVDSetConvergenceTestFunction

Sets a function to compute the error estimate used in the convergence test.

Synopsis

#include "slepcsvd.h" 
PetscErrorCode SVDSetConvergenceTestFunction(SVD svd,SVDConvergenceTestFn *conv,void* ctx,PetscCtxDestroyFn *destroy)
Logically Collective

Input Parameters

svd  - singular value solver context obtained from SVDCreate()
conv  - the convergence test function, see SVDConvergenceTestFn for the calling sequence
ctx  - context for private data for the convergence routine (may be NULL)
destroy  - a routine for destroying the context (may be NULL), see PetscCtxDestroyFn for the calling sequence

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