TSMonitorSet#

Sets an ADDITIONAL function that is to be used at every timestep to display the iteration’s progress.

Synopsis#

#include "petscts.h"  
PetscErrorCode TSMonitorSet(TS ts, PetscErrorCode (*monitor)(TS, PetscInt, PetscReal, Vec, void *), void *mctx, PetscErrorCode (*mdestroy)(void **))

Logically Collective

Input Parameters#

  • ts - the TS context obtained from TSCreate()

  • monitor - monitoring routine

  • mctx - [optional] user-defined 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#

PetscErrorCode monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx)
  • ts - the TS context

  • steps - iteration number (after the final time step the monitor routine may be called with a step of -1, this indicates the solution has been interpolated to this time)

  • time - current time

  • u - current iterate

  • mctx - [optional] monitoring context

Note#

This routine adds an additional monitor to the list of monitors that already has been loaded.

Fortran Note#

Only a single monitor function can be set for each TS object

See Also#

TS: Scalable ODE and DAE Solvers, TSMonitorDefault(), TSMonitorCancel(), TSDMSwarmMonitorMoments(), TSMonitorExtreme(), TSMonitorDrawSolution(), TSMonitorDrawSolutionPhase(), TSMonitorDrawSolutionFunction(), TSMonitorDrawError(), TSMonitorSolution(), TSMonitorSolutionVTK(), TSMonitorLGSolution(), TSMonitorLGError(), TSMonitorSPSwarmSolution(), TSMonitorError(), TSMonitorEnvelope(), TSDMSwarmMonitorMoments()

Level#

intermediate

Location#

src/ts/interface/tsmon.c

Examples#

src/ts/tutorials/ex11.c.html
src/ts/tutorials/ex11_sa.c.html
src/ts/tutorials/ex12.c.html
src/ts/tutorials/ex14.c.html
src/ts/tutorials/ex16.c.html
src/ts/tutorials/ex16fwd.c.html
src/ts/tutorials/ex18.c.html
src/ts/tutorials/ex19.c.html
src/ts/tutorials/ex20adj.c.html
src/ts/tutorials/ex20.c.html
src/ts/tutorials/ex20fwd.c.html


Edit on GitLab

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