PetscOptionsMonitorSet#

Sets an ADDITIONAL function to be called at every method that modified the PETSc options database.

Synopsis#

#include "petscsys.h"   
PetscErrorCode PetscOptionsMonitorSet(PetscErrorCode (*monitor)(const char name[], const char value[], PetscOptionSource source, void *mctx), void *mctx, PetscErrorCode (*monitordestroy)(void **mctx))

Not Collective

Input Parameters#

  • monitor - pointer to function (if this is NULL, it turns off monitoring

  • mctx - [optional] context for private data for the monitor routine (use NULL if no context is desired)

  • monitordestroy - [optional] routine that frees monitor context (may be NULL)

Calling sequence of monitor#

  • name - option name string

  • value - option value string

  • source - option source

  • mctx - optional monitoring context, as set by PetscOptionsMonitorSet()

Calling sequence of monitordestroy#

  • mctx - [optional] pointer to context to destroy with

Notes#

See PetscInitialize() for options related to option database monitoring.

The default is to do nothing. To print the name and value of options being inserted into the database, use PetscOptionsMonitorDefault() as the monitoring routine, with a null monitoring context.

Several different monitoring routines may be set by calling PetscOptionsMonitorSet() multiple times; all will be called in the order in which they were set.

See Also#

PetscOptionsMonitorDefault(), PetscInitialize()

Level#

intermediate

Location#

src/sys/objects/options.c

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