petsc-3.14.6 2021-03-30

SNESGetIterationNumber

Gets the number of nonlinear iterations completed at this time.

#include "petscsnes.h"  
PetscErrorCode  SNESGetIterationNumber(SNES snes,PetscInt *iter)

Not Collective

snes

- SNES context

iter

- iteration number

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.

After the SNES solve is complete this will return the number of nonlinear iterations used.

intermediate