slepc-main 2024-12-17

NEPSetStoppingTestFunction

Sets a function to decide when to stop the outer iteration of the eigensolver.

Synopsis

#include "slepcnep.h" 
PetscErrorCode NEPSetStoppingTestFunction(NEP nep,NEPStoppingTestFn *stop,void* ctx,PetscCtxDestroyFn *destroy)

Logically Collective

Input Parameters

	nep	- nonlinear eigensolver context obtained from NEPCreate()
	stop	- the stopping test function, see NEPStoppingTestFn 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), see PetscCtxDestroyFn for the calling sequence

Note

Normal usage is to first call the default routine NEPStoppingBasic() and then set reason to NEP_CONVERGED_USER if some user-defined conditions have been met. To let the eigensolver continue iterating, the result must be left as NEP_CONVERGED_ITERATING.

Level

advanced

Location