slepc-3.13.0 2020-03-31
Report Typos and Errors

SVDGetConvergedReason

Gets the reason why the SVDSolve() iteration was stopped.

Synopsis

#include "slepcsvd.h" 
PetscErrorCode SVDGetConvergedReason(SVD svd,SVDConvergedReason *reason)
Not Collective

Input Parameter

svd  - the singular value solver context

Output Parameter

reason  - negative value indicates diverged, positive value converged (see SVDConvergedReason)

Notes

Possible values for reason are

SVD_CONVERGED_TOL  - converged up to tolerance
SVD_CONVERGED_USER  - converged due to a user-defined condition
SVD_DIVERGED_ITS  - required more than max_it iterations to reach convergence
SVD_DIVERGED_BREAKDOWN  - generic breakdown in method

Can only be called after the call to SVDSolve() is complete.

See Also

SVDSetTolerances(), SVDSolve(), SVDConvergedReason

Location: src/svd/interface/svdsolve.c
Index of all SVD routines
Table of Contents for all manual pages
Index of all manual pages