SNESLineSearchMonitorSetFromOptions#

Sets a monitor function and viewer appropriate for the type indicated in the options database

Synopsis#

#include "petscsnes.h" 
PetscErrorCode SNESLineSearchMonitorSetFromOptions(SNESLineSearch ls, const char name[], const char help[], const char manual[], PetscErrorCode (*monitor)(SNESLineSearch ls, PetscViewerAndFormat *vf), PetscErrorCode (*monitorsetup)(SNESLineSearch ls, PetscViewerAndFormat *vf))

Collective

Input Parameters#

ls - SNESLineSearch object to monitor
name - the monitor type
help - message indicating what monitoring is done
manual - manual page for the monitor
monitor - the monitor function, must use PetscViewerAndFormat as its context
monitorsetup - a function that is called once ONLY if the user selected this monitor that may set additional features of the SNESLineSearch or PetscViewer

Calling sequence of `monitor`#

ls - SNESLineSearch object being monitored
vf - a PetscViewerAndFormat struct that provides the PetscViewer and PetscViewerFormat being used

Calling sequence of `monitorsetup`#

ls - SNESLineSearch object being monitored
vf - a PetscViewerAndFormat struct that provides the PetscViewer and PetscViewerFormat being used

See Also#

SNES: Nonlinear Solvers, SNES, SNESLineSearch, SNESLineSearchSetMonitor(), PetscOptionsCreateViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHeadBegin(), PetscOptionsStringArray(), PetscOptionsRealArray(), PetscOptionsScalar(), PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), PetscOptionsFList(), PetscOptionsEList()

Level#

advanced

Location#

src/snes/linesearch/interface/linesearch.c

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