TSGetConvergedReason#

Gets the reason the TS iteration was stopped.

Synopsis#

#include "petscts.h"  
PetscErrorCode TSGetConvergedReason(TS ts, TSConvergedReason *reason)

Not Collective

Input Parameter#

  • ts - the TS context

Output Parameter#

  • reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the manual pages for the individual convergence tests for complete lists

Note#

Can only be called after the call to TSSolve() is complete.

See Also#

TS: Scalable ODE and DAE Solvers, TS, TSSolve(), TSSetConvergenceTest(), TSConvergedReason

Level#

beginner

Location#

src/ts/interface/ts.c

Examples#

src/ts/tutorials/ex11.c.html
src/ts/tutorials/ex11_sa.c.html
src/ts/tutorials/ex18.c.html
src/ts/tutorials/ex1f.F90.html
src/ts/tutorials/ex22.c.html
src/ts/tutorials/ex25.c.html
src/ts/tutorials/ex26.c.html
src/ts/tutorials/ex34.c.html
src/ts/tutorials/ex35.cxx.html
src/ts/tutorials/extchem.c.html
src/ts/tutorials/extchemfield.c.html


Edit on GitLab

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