KSPSetResidualHistory#

Sets the array used to hold the residual history. If set, this array will contain the residual norms computed at each iteration of the solver.

Synopsis#

#include "petscksp.h" 
#include "petscmat.h" 
PetscErrorCode KSPSetResidualHistory(KSP ksp, PetscReal a[], PetscInt na, PetscBool reset)

Not Collective

Input Parameters#

  • ksp - iterative context obtained from KSPCreate()

  • a - array to hold history

  • na - size of a

  • reset - PETSC_TRUE indicates the history counter is reset to zero for each new linear solve

Notes#

If provided, he array is NOT freed by PETSc so the user needs to keep track of it and destroy once the KSP object is destroyed. If β€˜a’ is NULL then space is allocated for the history. If β€˜na’ PETSC_DECIDE or PETSC_DEFAULT then a default array of length 10000 is allocated.

See Also#

KSPGetResidualHistory(), KSP

Level#

advanced

Location#

src/ksp/ksp/interface/itfunc.c


Edit on GitLab

Index of all KSP routines
Table of Contents for all manual pages
Index of all manual pages