slepc-3.22.2 2024-12-02

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,SVDStoppingTestFn *stop,void* ctx,PetscErrorCode (*destroy)(void*))

Logically Collective

Input Parameters

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

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.

Level

advanced

Location