SNESGetIterationNumber

Gets the number of nonlinear iterations completed at this time.

Synopsis

int SNESGetIterationNumber(SNES snes,int* iter)
Not Collective

Input Parameter

snes -SNES context

Output Parameter

iter -iteration number

Notes

For example, during the computation of iteration 2 this would return 1.

This is useful for using lagged Jacobians (where one does not recompute the Jacobian at each SNES iteration). For example, the code

      ierr = SNESGetIterationNumber(snes,&it);
      if (!(it % 2)) {
        [compute Jacobian here]
      }
can be used in your ComputeJacobian() function to cause the Jacobian to be recomputed every second SNES iteration.

Keywords

SNES, nonlinear, get, iteration, number

Level:intermediate
Location:src/snes/interface/snes.c
SNES Index
Table of Contents