1. Vijay Mahadevan
  2. petsc

Commits

Peter Brune  committed baca469 Merge

Merge branch 'prbrune/snestest-docupdate'

* prbrune/snestest-docupdate:
SNESTEST: Update manual entry notes to say exactly what a user should expect.

  • Participants
  • Parent commits a6a40a5, 87183b0
  • Branches master

Comments (0)

Files changed (1)

File src/snes/impls/test/snestest.c

View file
 
    Level: intermediate
 
+   Notes: This solver is not a solver and does not converge to a solution.  SNESTEST checks the Jacobian at three
+   points: the 0, 1, and -1 solution vectors.  After doing these three tests, it always aborts with the error message
+   "SNESTest aborts after Jacobian test".  No other behavior is to be expected.  It may be similarly used to check if a
+   SNES function is the gradient of an objective function set with SNESSetObjective().
+
 .seealso:  SNESCreate(), SNES, SNESSetType(), SNESNEWTONLS, SNESNEWTONTR
 
 M*/