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 -
SNESLineSearchobject to monitorname - the monitor type
help - message indicating what monitoring is done
manual - manual page for the monitor
monitor - the monitor function
monitorsetup - a function that is called once ONLY if the user selected this monitor that may set additional features of the
SNESLineSearchorPetscViewer
Calling sequence of monitor#
ls -
SNESLineSearchobject being monitoredvf - a
PetscViewerAndFormatstruct that provides thePetscViewerandPetscViewerFormatbeing used
Calling sequence of monitorsetup#
ls -
SNESLineSearchobject being monitoredvf - a
PetscViewerAndFormatstruct that provides thePetscViewerandPetscViewerFormatbeing used
See Also#
SNES: Nonlinear Solvers, SNES, SNESLineSearch, SNESLineSearchSetMonitor(), PetscOptionsGetViewer(), 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