KSPMonitorSetFromOptions#

Sets a monitor function, viewer, and viewer format based on the viewer specification in the options database

Synopsis#

#include "petscksp.h" 
PetscErrorCode KSPMonitorSetFromOptions(KSP ksp, const char opt[], const char name[], PetscCtx ctx)

Collective

Input Parameters#

  • ksp - KSP object you wish to monitor

  • opt - the command line option for this monitor, for example -ksp_monitor

  • name - the monitor type one is seeking, for example, "preconditioned_residual"

  • ctx - An optional application context for the monitor, or NULL

Note#

See PetscOptionsCreateViewer() for details on the viewer specification, for example, -ksp_monitor ascii:myfile::append

See Also#

KSP: Linear System Solvers, KSPMonitorRegister(), KSPMonitorSet(), PetscOptionsCreateViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHeadBegin(), PetscOptionsStringArray(), PetscOptionsRealArray(), PetscOptionsScalar(), PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), PetscOptionsFList(), PetscOptionsEList()

Level#

developer

Location#

src/ksp/ksp/interface/itcl.c


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