KSPConvergedReasonViewSet#
Sets an ADDITIONAL function that is to be used at the end of the linear solver to display the convergence reason of the linear solver.
Synopsis#
#include "petscksp.h"
#include "petscmat.h"
PetscErrorCode KSPConvergedReasonViewSet(KSP ksp, PetscErrorCode (*f)(KSP, void *), void *vctx, PetscCtxDestroyFn *reasonviewdestroy)
Logically Collective
Input Parameters#
ksp - the
KSPcontextf - the ksp converged reason view function
vctx - [optional] user-defined context for private data for the
KSPConvergedReasonview routine (useNULLif no context is desired)reasonviewdestroy - [optional] routine that frees
vctx(may beNULL), seePetscCtxDestroyFnfor the calling sequence
Options Database Keys#
-ksp_converged_reason - sets a default
KSPConvergedReasonView()-ksp_converged_reason_view_cancel - cancels all converged reason viewers that have been hardwired into a code by calls to
KSPConvergedReasonViewSet(), but does not cancel those set via the options database.
Note#
Several different converged reason view routines may be set by calling
KSPConvergedReasonViewSet() multiple times; all will be called in the
order in which they were set.
Developer Note#
Should be named KSPConvergedReasonViewAdd().
See Also#
KSP: Linear System Solvers, KSPConvergedReasonView(), KSPConvergedReasonViewCancel(), PetscCtxDestroyFn
Level#
intermediate
Location#
Examples#
Index of all KSP routines
Table of Contents for all manual pages
Index of all manual pages