TSConvergedReason

reason a TS method has converged (integrated to the requested time) or not

Synopsis

#include <petscts.h> 
typedef enum {
  TS_CONVERGED_ITERATING          = 0,
  TS_CONVERGED_TIME               = 1,
  TS_CONVERGED_ITS                = 2,
  TS_CONVERGED_USER               = 3,
  TS_CONVERGED_EVENT              = 4,
  TS_CONVERGED_PSEUDO_FATOL       = 5,
  TS_CONVERGED_PSEUDO_FRTOL       = 6,
  TS_DIVERGED_NONLINEAR_SOLVE     = -1,
  TS_DIVERGED_STEP_REJECTED       = -2,
  TSFORWARD_DIVERGED_LINEAR_SOLVE = -3,
  TSADJOINT_DIVERGED_LINEAR_SOLVE = -4
} TSConvergedReason;

Values

• TS_CONVERGED_ITERATING - this only occurs if TSGetConvergedReason() is called during the TSSolve()

• TS_CONVERGED_TIME - the final time was reached

• TS_CONVERGED_ITS - the maximum number of iterations (time-steps) was reached prior to the final time

• TS_CONVERGED_USER - user requested termination

• TS_CONVERGED_EVENT - user requested termination on event detection

• TS_CONVERGED_PSEUDO_FATOL - stops when function norm decreased by a set amount, used only for TSPSEUDO

• TS_CONVERGED_PSEUDO_FRTOL - stops when function norm decreases below a set amount, used only for TSPSEUDO

• TS_DIVERGED_NONLINEAR_SOLVE - too many nonlinear solve failures have occurred

• TS_DIVERGED_STEP_REJECTED - too many steps were rejected

• TSFORWARD_DIVERGED_LINEAR_SOLVE - tangent linear solve failed

• TSADJOINT_DIVERGED_LINEAR_SOLVE - transposed linear solve failed

See Also

TS: Scalable ODE and DAE Solvers, TS, TSGetConvergedReason()

Level

beginner

Location

include/petscts.h

Examples

src/ts/tutorials/ex22.c
src/ts/tutorials/ex11.c
src/ts/tutorials/ex34.c
src/ts/tutorials/ex25.c
src/ts/tutorials/ex1f.F90
src/ts/tutorials/ex11_sa.c
src/ts/utils/dmplexlandau/tutorials/ex1.c
src/ts/tutorials/extchem.c
src/ts/tutorials/ex35.cxx
src/ts/utils/dmplexlandau/tutorials/ex2.c

---

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