KSPMonitorTrueResidual#

Prints the true residual norm, as well as the preconditioned residual norm, at each iteration of an iterative solver.

Synopsis#

#include "petscksp.h" 
PetscErrorCode KSPMonitorTrueResidual(KSP ksp, PetscInt n, PetscReal rnorm, PetscViewerAndFormat *vf)

Collective on ksp

Input Parameters#

  • ksp - iterative context

  • n - iteration number

  • rnorm - 2-norm (preconditioned) residual value (may be estimated).

  • vf - The viewer context

Options Database Key#

  • -ksp_monitor_true_residual - Activates KSPMonitorTrueResidual()

Notes#

When using right preconditioning, these values are equivalent.

This is not called directly by users, rather one calls KSPMonitorSet(), with this function as an argument, to cause the monitor to be used during the KSP solve.

See Also#

KSPMonitorSet(), KSPMonitorResidual(), KSPMonitorTrueResidualMaxNorm()

Level#

intermediate

Location#

src/ksp/ksp/interface/iterativ.c


Edit on GitLab

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