TaoMonitorSetFromOptions#

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

Synopsis#

#include "petsctao.h" 
PetscErrorCode TaoMonitorSetFromOptions(Tao tao, const char name[], const char help[], const char manual[], PetscErrorCode (*monitor)(Tao, PetscViewerAndFormat *))

Collective

Input Parameters#

tao - Tao object you wish to monitor
name - the monitor type one is seeking
help - message indicating what monitoring is done
manual - manual page for the monitor
monitor - the monitor function, this must use a PetscViewerFormat as its context

Options Database Key#

-name_interval interval - sets the interval of Tao iterations to monitor, by default this is 1.

Note#

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

See Also#

TAO: Optimization Solvers, Tao, TaoMonitorSet(), 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/tao/interface/taosolver.c

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