xref: /petsc/include/petscsnes.h (revision 8dc331a1884e7d9f3e74ba293e4b2ea0b4ee67ee) 
1 /*
2     User interface for the nonlinear solvers package.
3 */
4 #if !defined(__PETSCSNES_H)
5 #define __PETSCSNES_H
6 #include <petscksp.h>
7 #include <petscdmtypes.h>
8 #include <petscdmdatypes.h>
9 
10 /*S
11      SNES - Abstract PETSc object that manages all nonlinear solves
12 
13    Level: beginner
14 
15   Concepts: nonlinear solvers
16 
17 .seealso:  SNESCreate(), SNESSetType(), SNESType, TS, KSP, KSP, PC
18 S*/
19 typedef struct _p_SNES* SNES;
20 
21 /*J
22     SNESType - String with the name of a PETSc SNES method or the creation function
23        with an optional dynamic library name, for example
24        http://www.mcs.anl.gov/petsc/lib.a:mysnescreate()
25 
26    Level: beginner
27 
28 .seealso: SNESSetType(), SNES
29 J*/
30 typedef const char* SNESType;
31 #define SNESNEWTONLS     "newtonls"
32 #define SNESNEWTONTR     "newtontr"
33 #define SNESPYTHON       "python"
34 #define SNESTEST         "test"
35 #define SNESNRICHARDSON  "nrichardson"
36 #define SNESKSPONLY      "ksponly"
37 #define SNESVINEWTONRSLS "vinewtonrsls"
38 #define SNESVINEWTONSSLS "vinewtonssls"
39 #define SNESNGMRES       "ngmres"
40 #define SNESQN           "qn"
41 #define SNESSHELL        "shell"
42 #define SNESGS           "gs"
43 #define SNESNCG          "ncg"
44 #define SNESFAS          "fas"
45 #define SNESMS           "ms"
46 #define SNESNASM         "nasm"
47 #define SNESANDERSON     "anderson"
48 #define SNESASPIN        "aspin"
49 
50 /* Logging support */
51 PETSC_EXTERN PetscClassId SNES_CLASSID;
52 PETSC_EXTERN PetscClassId DMSNES_CLASSID;
53 
54 PETSC_EXTERN PetscErrorCode SNESInitializePackage(void);
55 
56 PETSC_EXTERN PetscErrorCode SNESCreate(MPI_Comm,SNES*);
57 PETSC_EXTERN PetscErrorCode SNESReset(SNES);
58 PETSC_EXTERN PetscErrorCode SNESDestroy(SNES*);
59 PETSC_EXTERN PetscErrorCode SNESSetType(SNES,SNESType);
60 PETSC_EXTERN PetscErrorCode SNESMonitor(SNES,PetscInt,PetscReal);
61 PETSC_EXTERN PetscErrorCode SNESMonitorSet(SNES,PetscErrorCode(*)(SNES,PetscInt,PetscReal,void*),void *,PetscErrorCode (*)(void**));
62 PETSC_EXTERN PetscErrorCode SNESMonitorCancel(SNES);
63 PETSC_EXTERN PetscErrorCode SNESSetConvergenceHistory(SNES,PetscReal[],PetscInt[],PetscInt,PetscBool );
64 PETSC_EXTERN PetscErrorCode SNESGetConvergenceHistory(SNES,PetscReal*[],PetscInt *[],PetscInt *);
65 PETSC_EXTERN PetscErrorCode SNESSetUp(SNES);
66 PETSC_EXTERN PetscErrorCode SNESSolve(SNES,Vec,Vec);
67 PETSC_EXTERN PetscErrorCode SNESSetErrorIfNotConverged(SNES,PetscBool );
68 PETSC_EXTERN PetscErrorCode SNESGetErrorIfNotConverged(SNES,PetscBool  *);
69 
70 PETSC_EXTERN PetscErrorCode SNESSetWorkVecs(SNES,PetscInt);
71 
72 PETSC_EXTERN PetscErrorCode SNESAddOptionsChecker(PetscErrorCode (*)(SNES));
73 
74 PETSC_EXTERN PetscErrorCode SNESSetUpdate(SNES, PetscErrorCode (*)(SNES, PetscInt));
75 
76 PETSC_EXTERN PetscErrorCode SNESRegisterAll(void);
77 
78 PETSC_EXTERN PetscErrorCode SNESRegister(const char[],PetscErrorCode (*)(SNES));
79 
80 PETSC_EXTERN PetscErrorCode SNESGetKSP(SNES,KSP*);
81 PETSC_EXTERN PetscErrorCode SNESSetKSP(SNES,KSP);
82 PETSC_EXTERN PetscErrorCode SNESGetSolution(SNES,Vec*);
83 PETSC_EXTERN PetscErrorCode SNESGetSolutionUpdate(SNES,Vec*);
84 PETSC_EXTERN PetscErrorCode SNESGetRhs(SNES,Vec*);
85 PETSC_EXTERN PetscErrorCode SNESView(SNES,PetscViewer);
86 PETSC_EXTERN PetscErrorCode SNESLoad(SNES,PetscViewer);
87 
88 #define SNES_FILE_CLASSID 1211224
89 
90 PETSC_EXTERN PetscErrorCode SNESSetOptionsPrefix(SNES,const char[]);
91 PETSC_EXTERN PetscErrorCode SNESAppendOptionsPrefix(SNES,const char[]);
92 PETSC_EXTERN PetscErrorCode SNESGetOptionsPrefix(SNES,const char*[]);
93 PETSC_EXTERN PetscErrorCode SNESSetFromOptions(SNES);
94 
95 PETSC_EXTERN PetscErrorCode MatCreateSNESMF(SNES,Mat*);
96 PETSC_EXTERN PetscErrorCode MatMFFDComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
97 
98 PETSC_EXTERN PetscErrorCode MatDAADSetSNES(Mat,SNES);
99 
100 PETSC_EXTERN PetscErrorCode SNESGetType(SNES,SNESType*);
101 PETSC_EXTERN PetscErrorCode SNESMonitorDefault(SNES,PetscInt,PetscReal,void *);
102 PETSC_EXTERN PetscErrorCode SNESMonitorRange(SNES,PetscInt,PetscReal,void *);
103 PETSC_EXTERN PetscErrorCode SNESMonitorRatio(SNES,PetscInt,PetscReal,void *);
104 PETSC_EXTERN PetscErrorCode SNESMonitorSetRatio(SNES,PetscViewer);
105 PETSC_EXTERN PetscErrorCode SNESMonitorSolution(SNES,PetscInt,PetscReal,void *);
106 PETSC_EXTERN PetscErrorCode SNESMonitorResidual(SNES,PetscInt,PetscReal,void *);
107 PETSC_EXTERN PetscErrorCode SNESMonitorSolutionUpdate(SNES,PetscInt,PetscReal,void *);
108 PETSC_EXTERN PetscErrorCode SNESMonitorDefaultShort(SNES,PetscInt,PetscReal,void *);
109 PETSC_EXTERN PetscErrorCode SNESMonitorJacUpdateSpectrum(SNES,PetscInt,PetscReal,void *);
110 PETSC_EXTERN PetscErrorCode SNESSetTolerances(SNES,PetscReal,PetscReal,PetscReal,PetscInt,PetscInt);
111 PETSC_EXTERN PetscErrorCode SNESGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,PetscInt*,PetscInt*);
112 PETSC_EXTERN PetscErrorCode SNESSetTrustRegionTolerance(SNES,PetscReal);
113 PETSC_EXTERN PetscErrorCode SNESGetFunctionNorm(SNES,PetscReal*);
114 PETSC_EXTERN PetscErrorCode SNESSetFunctionNorm(SNES,PetscReal);
115 PETSC_EXTERN PetscErrorCode SNESGetIterationNumber(SNES,PetscInt*);
116 PETSC_EXTERN PetscErrorCode SNESSetIterationNumber(SNES,PetscInt);
117 
118 PETSC_EXTERN PetscErrorCode SNESGetNonlinearStepFailures(SNES,PetscInt*);
119 PETSC_EXTERN PetscErrorCode SNESSetMaxNonlinearStepFailures(SNES,PetscInt);
120 PETSC_EXTERN PetscErrorCode SNESGetMaxNonlinearStepFailures(SNES,PetscInt*);
121 PETSC_EXTERN PetscErrorCode SNESGetNumberFunctionEvals(SNES,PetscInt*);
122 
123 PETSC_EXTERN PetscErrorCode SNESSetLagPreconditioner(SNES,PetscInt);
124 PETSC_EXTERN PetscErrorCode SNESGetLagPreconditioner(SNES,PetscInt*);
125 PETSC_EXTERN PetscErrorCode SNESSetLagJacobian(SNES,PetscInt);
126 PETSC_EXTERN PetscErrorCode SNESGetLagJacobian(SNES,PetscInt*);
127 PETSC_EXTERN PetscErrorCode SNESSetGridSequence(SNES,PetscInt);
128 
129 PETSC_EXTERN PetscErrorCode SNESGetLinearSolveIterations(SNES,PetscInt*);
130 PETSC_EXTERN PetscErrorCode SNESGetLinearSolveFailures(SNES,PetscInt*);
131 PETSC_EXTERN PetscErrorCode SNESSetMaxLinearSolveFailures(SNES,PetscInt);
132 PETSC_EXTERN PetscErrorCode SNESGetMaxLinearSolveFailures(SNES,PetscInt*);
133 
134 PETSC_EXTERN PetscErrorCode SNESKSPSetUseEW(SNES,PetscBool );
135 PETSC_EXTERN PetscErrorCode SNESKSPGetUseEW(SNES,PetscBool *);
136 PETSC_EXTERN PetscErrorCode SNESKSPSetParametersEW(SNES,PetscInt,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal);
137 PETSC_EXTERN PetscErrorCode SNESKSPGetParametersEW(SNES,PetscInt*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*);
138 
139 #include <petscdrawtypes.h>
140 PETSC_EXTERN PetscErrorCode SNESMonitorLGCreate(const char[],const char[],int,int,int,int,PetscDrawLG*);
141 PETSC_EXTERN PetscErrorCode SNESMonitorLGResidualNorm(SNES,PetscInt,PetscReal,void*);
142 PETSC_EXTERN PetscErrorCode SNESMonitorLGDestroy(PetscDrawLG*);
143 PETSC_EXTERN PetscErrorCode SNESMonitorLGRange(SNES,PetscInt,PetscReal,void*);
144 
145 PETSC_EXTERN PetscErrorCode SNESSetApplicationContext(SNES,void *);
146 PETSC_EXTERN PetscErrorCode SNESGetApplicationContext(SNES,void *);
147 PETSC_EXTERN PetscErrorCode SNESSetComputeApplicationContext(SNES,PetscErrorCode (*)(SNES,void**),PetscErrorCode (*)(void**));
148 
149 PETSC_EXTERN PetscErrorCode SNESPythonSetType(SNES,const char[]);
150 
151 PETSC_EXTERN PetscErrorCode SNESSetFunctionDomainError(SNES);
152 PETSC_EXTERN PetscErrorCode SNESGetFunctionDomainError(SNES, PetscBool *);
153 
154 /*E
155     SNESConvergedReason - reason a SNES method was said to
156          have converged or diverged
157 
158    Level: beginner
159 
160    The two most common reasons for divergence are
161 $   1) an incorrectly coded or computed Jacobian or
162 $   2) failure or lack of convergence in the linear system (in this case we recommend
163 $      testing with -pc_type lu to eliminate the linear solver as the cause of the problem).
164 
165    Diverged Reasons:
166 .    SNES_DIVERGED_LOCAL_MIN - this can only occur when using the line-search variant of SNES.
167        The line search wants to minimize Q(alpha) = 1/2 || F(x + alpha s) ||^2_2  this occurs
168        at Q'(alpha) = s^T F'(x+alpha s)^T F(x+alpha s) = 0. If s is the Newton direction - F'(x)^(-1)F(x) then
169        you get Q'(alpha) = -F(x)^T F'(x)^(-1)^T F'(x+alpha s)F(x+alpha s); when alpha = 0
170        Q'(0) = - ||F(x)||^2_2 which is always NEGATIVE if F'(x) is invertible. This means the Newton
171        direction is a descent direction and the line search should succeed if alpha is small enough.
172 
173        If F'(x) is NOT invertible AND F'(x)^T F(x) = 0 then Q'(0) = 0 and the Newton direction
174        is NOT a descent direction so the line search will fail. All one can do at this point
175        is change the initial guess and try again.
176 
177        An alternative explanation: Newton's method can be regarded as replacing the function with
178        its linear approximation and minimizing the 2-norm of that. That is F(x+s) approx F(x) + F'(x)s
179        so we minimize || F(x) + F'(x) s ||^2_2; do this using Least Squares. If F'(x) is invertible then
180        s = - F'(x)^(-1)F(x) otherwise F'(x)^T F'(x) s = -F'(x)^T F(x). If F'(x)^T F(x) is NOT zero then there
181        exists a nontrival (that is F'(x)s != 0) solution to the equation and this direction is
182        s = - [F'(x)^T F'(x)]^(-1) F'(x)^T F(x) so Q'(0) = - F(x)^T F'(x) [F'(x)^T F'(x)]^(-T) F'(x)^T F(x)
183        = - (F'(x)^T F(x)) [F'(x)^T F'(x)]^(-T) (F'(x)^T F(x)). Since we are assuming (F'(x)^T F(x)) != 0
184        and F'(x)^T F'(x) has no negative eigenvalues Q'(0) < 0 so s is a descent direction and the line
185        search should succeed for small enough alpha.
186 
187        Note that this RARELY happens in practice. Far more likely the linear system is not being solved
188        (well enough?) or the Jacobian is wrong.
189 
190    SNES_DIVERGED_MAX_IT means that the solver reached the maximum number of iterations without satisfying any
191    convergence criteria. SNES_CONVERGED_ITS means that SNESSkipConverged() was chosen as the convergence test;
192    thus the usual convergence criteria have not been checked and may or may not be satisfied.
193 
194    Developer Notes: this must match finclude/petscsnes.h
195 
196        The string versions of these are in SNESConvergedReason, if you change any value here you must
197      also adjust that array.
198 
199    Each reason has its own manual page.
200 
201 .seealso: SNESSolve(), SNESGetConvergedReason(), KSPConvergedReason, SNESSetConvergenceTest()
202 E*/
203 typedef enum {/* converged */
204               SNES_CONVERGED_FNORM_ABS         =  2, /* ||F|| < atol */
205               SNES_CONVERGED_FNORM_RELATIVE    =  3, /* ||F|| < rtol*||F_initial|| */
206               SNES_CONVERGED_SNORM_RELATIVE    =  4, /* Newton computed step size small; || delta x || < stol || x ||*/
207               SNES_CONVERGED_ITS               =  5, /* maximum iterations reached */
208               SNES_CONVERGED_TR_DELTA          =  7,
209               /* diverged */
210               SNES_DIVERGED_FUNCTION_DOMAIN     = -1, /* the new x location passed the function is not in the domain of F */
211               SNES_DIVERGED_FUNCTION_COUNT      = -2,
212               SNES_DIVERGED_LINEAR_SOLVE        = -3, /* the linear solve failed */
213               SNES_DIVERGED_FNORM_NAN           = -4,
214               SNES_DIVERGED_MAX_IT              = -5,
215               SNES_DIVERGED_LINE_SEARCH         = -6, /* the line search failed */
216               SNES_DIVERGED_INNER               = -7, /* inner solve failed */
217               SNES_DIVERGED_LOCAL_MIN           = -8, /* || J^T b || is small, implies converged to local minimum of F() */
218               SNES_CONVERGED_ITERATING          =  0} SNESConvergedReason;
219 PETSC_EXTERN const char *const*SNESConvergedReasons;
220 
221 /*MC
222      SNES_CONVERGED_FNORM_ABS - 2-norm(F) <= abstol
223 
224    Level: beginner
225 
226 .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
227 
228 M*/
229 
230 /*MC
231      SNES_CONVERGED_FNORM_RELATIVE - 2-norm(F) <= rtol*2-norm(F(x_0)) where x_0 is the initial guess
232 
233    Level: beginner
234 
235 .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
236 
237 M*/
238 
239 /*MC
240      SNES_CONVERGED_SNORM_RELATIVE - The 2-norm of the last step <= stol * 2-norm(x) where x is the current
241           solution and stol is the 4th argument to SNESSetTolerances()
242 
243      Options Database Keys:
244       -snes_stol <stol> - the step tolerance
245 
246    Level: beginner
247 
248 .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
249 
250 M*/
251 
252 /*MC
253      SNES_DIVERGED_FUNCTION_COUNT - The user provided function has been called more times then the final
254          argument to SNESSetTolerances()
255 
256    Level: beginner
257 
258 .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
259 
260 M*/
261 
262 /*MC
263      SNES_DIVERGED_FNORM_NAN - the 2-norm of the current function evaluation is not-a-number (NaN), this
264       is usually caused by a division of 0 by 0.
265 
266    Level: beginner
267 
268 .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
269 
270 M*/
271 
272 /*MC
273      SNES_DIVERGED_MAX_IT - SNESSolve() has reached the maximum number of iterations requested
274 
275    Level: beginner
276 
277 .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
278 
279 M*/
280 
281 /*MC
282      SNES_DIVERGED_LINE_SEARCH - The line search has failed. This only occurs for a SNES solvers that use a line search
283 
284    Level: beginner
285 
286 .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances(), SNESLineSearch
287 
288 M*/
289 
290 /*MC
291      SNES_DIVERGED_LOCAL_MIN - the algorithm seems to have stagnated at a local minimum that is not zero.
292         See the manual page for SNESConvergedReason for more details
293 
294    Level: beginner
295 
296 .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
297 
298 M*/
299 
300 /*MC
301      SNES_CONERGED_ITERATING - this only occurs if SNESGetConvergedReason() is called during the SNESSolve()
302 
303    Level: beginner
304 
305 .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
306 
307 M*/
308 
309 PETSC_EXTERN PetscErrorCode SNESSetConvergenceTest(SNES,PetscErrorCode (*)(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void*,PetscErrorCode (*)(void*));
310 PETSC_EXTERN PetscErrorCode SNESConvergedDefault(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*);
311 PETSC_EXTERN PetscErrorCode SNESSkipConverged(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*);
312 PETSC_EXTERN PetscErrorCode SNESGetConvergedReason(SNES,SNESConvergedReason*);
313 
314 PETSC_EXTERN PetscErrorCode SNESDMMeshComputeFunction(SNES,Vec,Vec,void*);
315 PETSC_EXTERN PetscErrorCode SNESDMMeshComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
316 
317 /* --------- Solving systems of nonlinear equations --------------- */
318 PETSC_EXTERN PetscErrorCode SNESSetFunction(SNES,Vec,PetscErrorCode (*SNESFunction)(SNES,Vec,Vec,void*),void*);
319 PETSC_EXTERN PetscErrorCode SNESGetFunction(SNES,Vec*,PetscErrorCode (**SNESFunction)(SNES,Vec,Vec,void*),void**);
320 PETSC_EXTERN PetscErrorCode SNESComputeFunction(SNES,Vec,Vec);
321 PETSC_EXTERN PetscErrorCode SNESSetJacobian(SNES,Mat,Mat,PetscErrorCode (*SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void*);
322 PETSC_EXTERN PetscErrorCode SNESGetJacobian(SNES,Mat*,Mat*,PetscErrorCode (**SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void**);
323 PETSC_EXTERN PetscErrorCode SNESObjectiveComputeFunctionDefaultFD(SNES,Vec,Vec,void*);
324 PETSC_EXTERN PetscErrorCode SNESComputeJacobianDefault(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
325 PETSC_EXTERN PetscErrorCode SNESComputeJacobianDefaultColor(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
326 PETSC_EXTERN PetscErrorCode SNESSetComputeInitialGuess(SNES,PetscErrorCode (*)(SNES,Vec,void*),void*);
327 PETSC_EXTERN PetscErrorCode SNESSetPicard(SNES,Vec,PetscErrorCode (*SNESFunction)(SNES,Vec,Vec,void*),Mat,Mat,PetscErrorCode (*SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void*);
328 PETSC_EXTERN PetscErrorCode SNESGetPicard(SNES,Vec*,PetscErrorCode (**SNESFunction)(SNES,Vec,Vec,void*),Mat*,Mat*,PetscErrorCode (**SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void**);
329 PETSC_EXTERN PetscErrorCode SNESSetInitialFunction(SNES,Vec);
330 PETSC_EXTERN PetscErrorCode SNESSetInitialFunctionNorm(SNES,PetscReal);
331 
332 PETSC_EXTERN PetscErrorCode SNESSetObjective(SNES,PetscErrorCode (*SNESObjectiveFunction)(SNES,Vec,PetscReal *,void*),void*);
333 PETSC_EXTERN PetscErrorCode SNESGetObjective(SNES,PetscErrorCode (**SNESObjectiveFunction)(SNES,Vec,PetscReal *,void*),void**);
334 PETSC_EXTERN PetscErrorCode SNESComputeObjective(SNES,Vec,PetscReal *);
335 
336 /*E
337     SNESNormType - Norm that is passed in the Krylov convergence
338        test routines.
339 
340    Level: advanced
341 
342    Support for these is highly dependent on the solver.
343 
344    Notes:
345    This is primarily used to turn off extra norm and function computation
346    when the solvers are composed.
347 
348 .seealso: SNESSolve(), SNESGetConvergedReason(), KSPSetNormType(),
349           KSPSetConvergenceTest(), KSPSetPCSide()
350 E*/
351 
352 typedef enum {SNES_NORM_DEFAULT            = -1,
353               SNES_NORM_NONE               =  0,
354               SNES_NORM_FUNCTION           =  1,
355               SNES_NORM_INITIAL_ONLY       =  2,
356               SNES_NORM_FINAL_ONLY         =  3,
357               SNES_NORM_INITIAL_FINAL_ONLY =  4} SNESNormType;
358 PETSC_EXTERN const char *const*const SNESNormTypes;
359 /*MC
360     SNES_NORM_NONE - Don't compute function and its L2 norm.
361 
362    Level: advanced
363 
364     Notes:
365     This is most useful for stationary solvers with a fixed number of iterations used as smoothers.
366 
367 .seealso: SNESNormType, SNESSetNormType(), SNES_NORM_DEFAULT
368 M*/
369 
370 /*MC
371     SNES_NORM_FUNCTION - Compute the function and its L2 norm at each iteration.
372 
373    Level: advanced
374 
375     Notes:
376     Most solvers will use this no matter what norm type is passed to them.
377 
378 .seealso: SNESNormType, SNESSetNormType(), SNES_NORM_NONE
379 M*/
380 
381 /*MC
382     SNES_NORM_INITIAL_ONLY - Compute the function and its L2 at iteration 0, but do not update it.
383 
384    Level: advanced
385 
386    Notes:
387    This method is useful in composed methods, when a true solution might actually be found before SNESSolve() is called.
388    This option enables the solve to abort on the zeroth iteration if this is the case.
389 
390    For solvers that require the computation of the L2 norm of the function as part of the method, this merely cancels
391    the norm computation at the last iteration (if possible).
392 
393 .seealso: SNESNormType, SNESSetNormType(), SNES_NORM_FINAL_ONLY, SNES_NORM_INITIAL_FINAL_ONLY
394 M*/
395 
396 /*MC
397     SNES_NORM_FINAL_ONLY - Compute the function and its L2 norm on only the final iteration.
398 
399    Level: advanced
400 
401    Notes:
402    For solvers that require the computation of the L2 norm of the function as part of the method, behaves
403    exactly as SNES_NORM_DEFAULT.  This method is useful when the function is gotten after SNESSolve and
404    used in subsequent computation for methods that do not need the norm computed during the rest of the
405    solution procedure.
406 
407 .seealso: SNESNormType, SNESSetNormType(), SNES_NORM_INITIAL_ONLY, SNES_NORM_INITIAL_FINAL_ONLY
408 M*/
409 
410 /*MC
411     SNES_NORM_INITIAL_FINAL_ONLY - Compute the function and its L2 norm on only the initial and final iterations.
412 
413    Level: advanced
414 
415    Notes:
416    This method combines the benefits of SNES_NORM_INITIAL_ONLY and SNES_NORM_FINAL_ONLY.
417 
418 .seealso: SNESNormType, SNESSetNormType(), SNES_NORM_SNES_NORM_INITIAL_ONLY, SNES_NORM_FINAL_ONLY
419 M*/
420 
421 
422 PETSC_EXTERN PetscErrorCode SNESSetNormType(SNES,SNESNormType);
423 PETSC_EXTERN PetscErrorCode SNESGetNormType(SNES,SNESNormType*);
424 
425 PETSC_EXTERN PetscErrorCode SNESSetGS(SNES,PetscErrorCode (*SNESGSFunction)(SNES,Vec,Vec,void*),void*);
426 PETSC_EXTERN PetscErrorCode SNESGetGS(SNES,PetscErrorCode (**SNESGSFunction)(SNES,Vec,Vec,void*),void**);
427 PETSC_EXTERN PetscErrorCode SNESSetUseGS(SNES,PetscBool);
428 PETSC_EXTERN PetscErrorCode SNESGetUseGS(SNES,PetscBool *);
429 PETSC_EXTERN PetscErrorCode SNESComputeGS(SNES,Vec,Vec);
430 
431 PETSC_EXTERN PetscErrorCode SNESGSSetSweeps(SNES,PetscInt);
432 PETSC_EXTERN PetscErrorCode SNESGSGetSweeps(SNES,PetscInt *);
433 PETSC_EXTERN PetscErrorCode SNESGSSetTolerances(SNES,PetscReal,PetscReal,PetscReal,PetscInt);
434 PETSC_EXTERN PetscErrorCode SNESGSGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,PetscInt*);
435 
436 PETSC_EXTERN PetscErrorCode SNESUpdateCheckJacobian(SNES,PetscInt);
437 
438 PETSC_EXTERN PetscErrorCode SNESShellGetContext(SNES,void**);
439 PETSC_EXTERN PetscErrorCode SNESShellSetContext(SNES,void*);
440 PETSC_EXTERN PetscErrorCode SNESShellSetSolve(SNES,PetscErrorCode (*)(SNES,Vec));
441 
442 /* --------- Routines specifically for line search methods --------------- */
443 
444 typedef struct _p_LineSearch* SNESLineSearch;
445 
446 /*S
447      SNESLineSearch - Abstract PETSc object that manages line-search operations
448 
449    Level: beginner
450 
451   Concepts: nonlinear solvers, line search
452 
453 .seealso:  SNESLineSearchCreate(), SNESLineSearchSetType(), SNES
454 S*/
455 
456 /*J
457     SNESLineSearchType - String with the name of a PETSc line search method
458 
459    Level: beginner
460 
461 .seealso: SNESLineSearchSetType(), SNES
462 J*/
463 
464 typedef const char* SNESLineSearchType;
465 #define SNESLINESEARCHBT                 "bt"
466 #define SNESLINESEARCHBASIC              "basic"
467 #define SNESLINESEARCHL2                 "l2"
468 #define SNESLINESEARCHCP                 "cp"
469 #define SNESLINESEARCHSHELL              "shell"
470 
471 PETSC_EXTERN PetscBool         SNESRegisterAllCalled;
472 PETSC_EXTERN PetscFunctionList SNESList;
473 PETSC_EXTERN PetscClassId      SNESLINESEARCH_CLASSID;
474 PETSC_EXTERN PetscBool         SNESLineSearchRegisterAllCalled;
475 PETSC_EXTERN PetscFunctionList SNESLineSearchList;
476 PETSC_EXTERN PetscLogEvent     SNESLineSearch_Apply;
477 
478 #define SNES_LINESEARCH_ORDER_LINEAR    1
479 #define SNES_LINESEARCH_ORDER_QUADRATIC 2
480 #define SNES_LINESEARCH_ORDER_CUBIC     3
481 
482 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchVIProjectFunc)(SNES,Vec);
483 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchVINormFunc)(SNES,Vec,Vec,PetscReal *);
484 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchApplyFunc)(SNESLineSearch);
485 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchUserFunc)(SNESLineSearch, void *);
486 
487 PETSC_EXTERN PetscErrorCode SNESLineSearchCreate(MPI_Comm, SNESLineSearch*);
488 PETSC_EXTERN PetscErrorCode SNESLineSearchReset(SNESLineSearch);
489 PETSC_EXTERN PetscErrorCode SNESLineSearchView(SNESLineSearch,PetscViewer);
490 PETSC_EXTERN PetscErrorCode SNESLineSearchDestroy(SNESLineSearch *);
491 PETSC_EXTERN PetscErrorCode SNESLineSearchSetType(SNESLineSearch, SNESLineSearchType);
492 PETSC_EXTERN PetscErrorCode SNESLineSearchSetFromOptions(SNESLineSearch);
493 PETSC_EXTERN PetscErrorCode SNESLineSearchSetUp(SNESLineSearch);
494 PETSC_EXTERN PetscErrorCode SNESLineSearchApply(SNESLineSearch, Vec, Vec, PetscReal *, Vec);
495 PETSC_EXTERN PetscErrorCode SNESLineSearchPreCheck(SNESLineSearch,Vec,Vec,PetscBool *);
496 PETSC_EXTERN PetscErrorCode SNESLineSearchPostCheck(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *);
497 PETSC_EXTERN PetscErrorCode SNESLineSearchSetWorkVecs(SNESLineSearch, PetscInt);
498 
499 /* set the functions for precheck and postcheck */
500 
501 PETSC_EXTERN PetscErrorCode SNESLineSearchSetPreCheck(SNESLineSearch, PetscErrorCode (*SNESLineSearchPreCheckFunction)(SNESLineSearch,Vec,Vec,PetscBool*,void*), void *ctx);
502 PETSC_EXTERN PetscErrorCode SNESLineSearchSetPostCheck(SNESLineSearch, PetscErrorCode (*SNESLineSearchPostCheckFunction)(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *,void*), void *ctx);
503 
504 PETSC_EXTERN PetscErrorCode SNESLineSearchGetPreCheck(SNESLineSearch, PetscErrorCode (**SNESLineSearchPreCheckFunction)(SNESLineSearch,Vec,Vec,PetscBool*,void*), void **ctx);
505 PETSC_EXTERN PetscErrorCode SNESLineSearchGetPostCheck(SNESLineSearch, PetscErrorCode (**SNESLineSearchPostCheckFunction)(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *,void*), void **ctx);
506 
507 /* set the functions for VI-specific line search operations */
508 
509 PETSC_EXTERN PetscErrorCode SNESLineSearchSetVIFunctions(SNESLineSearch, SNESLineSearchVIProjectFunc, SNESLineSearchVINormFunc);
510 PETSC_EXTERN PetscErrorCode SNESLineSearchGetVIFunctions(SNESLineSearch, SNESLineSearchVIProjectFunc*, SNESLineSearchVINormFunc*);
511 
512 /* pointers to the associated SNES in order to be able to get the function evaluation out */
513 PETSC_EXTERN PetscErrorCode SNESLineSearchSetSNES(SNESLineSearch,SNES);
514 PETSC_EXTERN PetscErrorCode SNESLineSearchGetSNES(SNESLineSearch,SNES*);
515 
516 /* set and get the parameters and vectors */
517 PETSC_EXTERN PetscErrorCode SNESLineSearchGetTolerances(SNESLineSearch,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscInt*);
518 PETSC_EXTERN PetscErrorCode SNESLineSearchSetTolerances(SNESLineSearch,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscInt);
519 
520 PETSC_EXTERN PetscErrorCode SNESLineSearchPreCheckPicard(SNESLineSearch,Vec,Vec,PetscBool*,void*);
521 
522 PETSC_EXTERN PetscErrorCode SNESLineSearchGetLambda(SNESLineSearch,PetscReal*);
523 PETSC_EXTERN PetscErrorCode SNESLineSearchSetLambda(SNESLineSearch,PetscReal);
524 
525 PETSC_EXTERN PetscErrorCode SNESLineSearchGetDamping(SNESLineSearch,PetscReal*);
526 PETSC_EXTERN PetscErrorCode SNESLineSearchSetDamping(SNESLineSearch,PetscReal);
527 
528 PETSC_EXTERN PetscErrorCode SNESLineSearchGetOrder(SNESLineSearch,PetscInt *order);
529 PETSC_EXTERN PetscErrorCode SNESLineSearchSetOrder(SNESLineSearch,PetscInt order);
530 
531 PETSC_EXTERN PetscErrorCode SNESLineSearchGetSuccess(SNESLineSearch, PetscBool*);
532 PETSC_EXTERN PetscErrorCode SNESLineSearchSetSuccess(SNESLineSearch, PetscBool);
533 
534 PETSC_EXTERN PetscErrorCode SNESLineSearchGetVecs(SNESLineSearch,Vec*,Vec*,Vec*,Vec*,Vec*);
535 PETSC_EXTERN PetscErrorCode SNESLineSearchSetVecs(SNESLineSearch,Vec,Vec,Vec,Vec,Vec);
536 
537 PETSC_EXTERN PetscErrorCode SNESLineSearchGetNorms(SNESLineSearch, PetscReal *, PetscReal *, PetscReal *);
538 PETSC_EXTERN PetscErrorCode SNESLineSearchSetNorms(SNESLineSearch, PetscReal, PetscReal, PetscReal);
539 PETSC_EXTERN PetscErrorCode SNESLineSearchComputeNorms(SNESLineSearch);
540 PETSC_EXTERN PetscErrorCode SNESLineSearchSetComputeNorms(SNESLineSearch, PetscBool);
541 
542 PETSC_EXTERN PetscErrorCode SNESLineSearchSetMonitor(SNESLineSearch, PetscBool);
543 PETSC_EXTERN PetscErrorCode SNESLineSearchGetMonitor(SNESLineSearch, PetscViewer*);
544 
545 PETSC_EXTERN PetscErrorCode SNESLineSearchAppendOptionsPrefix(SNESLineSearch, const char prefix[]);
546 PETSC_EXTERN PetscErrorCode SNESLineSearchGetOptionsPrefix(SNESLineSearch, const char *prefix[]);
547 
548 
549 /* Shell interface functions */
550 PETSC_EXTERN PetscErrorCode SNESLineSearchShellSetUserFunc(SNESLineSearch,SNESLineSearchUserFunc,void*);
551 PETSC_EXTERN PetscErrorCode SNESLineSearchShellGetUserFunc(SNESLineSearch,SNESLineSearchUserFunc*,void**);
552 
553 /* BT interface functions */
554 PETSC_EXTERN PetscErrorCode SNESLineSearchBTSetAlpha(SNESLineSearch, PetscReal);
555 PETSC_EXTERN PetscErrorCode SNESLineSearchBTGetAlpha(SNESLineSearch, PetscReal*);
556 
557 /*register line search types */
558 PETSC_EXTERN PetscErrorCode SNESLineSearchRegister(const char[],PetscErrorCode(*)(SNESLineSearch));
559 PETSC_EXTERN PetscErrorCode SNESLineSearchRegisterAll(void);
560 
561 /* Routines for VI solver */
562 PETSC_EXTERN PetscErrorCode SNESVISetVariableBounds(SNES,Vec,Vec);
563 PETSC_EXTERN PetscErrorCode SNESVISetComputeVariableBounds(SNES, PetscErrorCode (*)(SNES,Vec,Vec));
564 PETSC_EXTERN PetscErrorCode SNESVIGetInactiveSet(SNES,IS*);
565 PETSC_EXTERN PetscErrorCode SNESVIGetActiveSetIS(SNES,Vec,Vec,IS*);
566 PETSC_EXTERN PetscErrorCode SNESVIComputeInactiveSetFnorm(SNES,Vec,Vec,PetscReal*);
567 PETSC_EXTERN PetscErrorCode SNESVISetRedundancyCheck(SNES,PetscErrorCode(*)(SNES,IS,IS*,void*),void*);
568 #define SNES_VI_INF   1.0e20
569 #define SNES_VI_NINF -1.0e20
570 
571 PETSC_EXTERN PetscErrorCode SNESTestLocalMin(SNES);
572 
573 /* Should this routine be private? */
574 PETSC_EXTERN PetscErrorCode SNESComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*);
575 
576 PETSC_EXTERN PetscErrorCode SNESSetDM(SNES,DM);
577 PETSC_EXTERN PetscErrorCode SNESGetDM(SNES,DM*);
578 PETSC_EXTERN PetscErrorCode SNESSetPC(SNES,SNES);
579 PETSC_EXTERN PetscErrorCode SNESGetPC(SNES,SNES*);
580 PETSC_EXTERN PetscErrorCode SNESSetPCSide(SNES,PCSide);
581 PETSC_EXTERN PetscErrorCode SNESGetPCSide(SNES,PCSide*);
582 PETSC_EXTERN PetscErrorCode SNESSetSNESLineSearch(SNES,SNESLineSearch);
583 PETSC_EXTERN PetscErrorCode SNESGetSNESLineSearch(SNES,SNESLineSearch*);
584 PETSC_EXTERN PetscErrorCode SNESRestrictHookAdd(SNES,PetscErrorCode (*)(SNES,SNES,void*),void*);
585 PETSC_EXTERN PetscErrorCode SNESRestrictHooksRun(SNES,SNES);
586 
587 PETSC_EXTERN PetscErrorCode SNESSetUpMatrices(SNES);
588 PETSC_EXTERN PetscErrorCode DMSNESSetFunction(DM,PetscErrorCode(*SNESFunction)(SNES,Vec,Vec,void*),void*);
589 PETSC_EXTERN PetscErrorCode DMSNESGetFunction(DM,PetscErrorCode(**SNESSetFunction)(SNES,Vec,Vec,void*),void**);
590 PETSC_EXTERN PetscErrorCode DMSNESSetGS(DM,PetscErrorCode(*SNESGSFunction)(SNES,Vec,Vec,void*),void*);
591 PETSC_EXTERN PetscErrorCode DMSNESGetGS(DM,PetscErrorCode(**SNESGSFunction)(SNES,Vec,Vec,void*),void**);
592 PETSC_EXTERN PetscErrorCode DMSNESSetJacobian(DM,PetscErrorCode(*SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void*);
593 PETSC_EXTERN PetscErrorCode DMSNESGetJacobian(DM,PetscErrorCode(**SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void**);
594 PETSC_EXTERN PetscErrorCode DMSNESSetPicard(DM,PetscErrorCode(*SNESFunction)(SNES,Vec,Vec,void*),PetscErrorCode(*SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void*);
595 PETSC_EXTERN PetscErrorCode DMSNESGetPicard(DM,PetscErrorCode(**SNESFunction)(SNES,Vec,Vec,void*),PetscErrorCode(**SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void**);
596 PETSC_EXTERN PetscErrorCode DMSNESSetObjective(DM,PetscErrorCode (*SNESObjectiveFunction)(SNES,Vec,PetscReal *,void*),void*);
597 PETSC_EXTERN PetscErrorCode DMSNESGetObjective(DM,PetscErrorCode (**SNESObjectiveFunction)(SNES,Vec,PetscReal *,void*),void**);
598 
599 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESFunction)(DMDALocalInfo*,void*,void*,void*);
600 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESJacobian)(DMDALocalInfo*,void*,Mat,Mat,MatStructure*,void*);
601 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESObjective)(DMDALocalInfo*,void*,PetscReal*,void*);
602 
603 PETSC_EXTERN PetscErrorCode DMDASNESSetFunctionLocal(DM,InsertMode,DMDASNESFunction,void*);
604 PETSC_EXTERN PetscErrorCode DMDASNESSetJacobianLocal(DM,DMDASNESJacobian,void*);
605 PETSC_EXTERN PetscErrorCode DMDASNESSetObjectiveLocal(DM,DMDASNESObjective,void*);
606 PETSC_EXTERN PetscErrorCode DMDASNESSetPicardLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,void*,void*,void*),PetscErrorCode (*)(DMDALocalInfo*,void*,Mat,Mat,MatStructure*,void*),void*);
607 
608 PETSC_EXTERN PetscErrorCode DMSNESSetFunctionLocal(DM,PetscErrorCode (*)(DM,Vec,Vec,void*),void*);
609 PETSC_EXTERN PetscErrorCode DMSNESSetJacobianLocal(DM,PetscErrorCode (*)(DM,Vec,Mat,Mat,MatStructure*,void*),void*);
610 
611 /* Routines for Multiblock solver */
612 PETSC_EXTERN PetscErrorCode SNESMultiblockSetFields(SNES, const char [], PetscInt, const PetscInt *);
613 PETSC_EXTERN PetscErrorCode SNESMultiblockSetIS(SNES, const char [], IS);
614 PETSC_EXTERN PetscErrorCode SNESMultiblockSetBlockSize(SNES, PetscInt);
615 PETSC_EXTERN PetscErrorCode SNESMultiblockSetType(SNES, PCCompositeType);
616 
617 /*J
618     SNESMSType - String with the name of a PETSc SNESMS method.
619 
620    Level: intermediate
621 
622 .seealso: SNESMSSetType(), SNES
623 J*/
624 typedef const char* SNESMSType;
625 #define SNESMSM62       "m62"
626 #define SNESMSEULER     "euler"
627 #define SNESMSJAMESON83 "jameson83"
628 #define SNESMSVLTP21    "vltp21"
629 #define SNESMSVLTP31    "vltp31"
630 #define SNESMSVLTP41    "vltp41"
631 #define SNESMSVLTP51    "vltp51"
632 #define SNESMSVLTP61    "vltp61"
633 
634 PETSC_EXTERN PetscErrorCode SNESMSRegister(SNESMSType,PetscInt,PetscInt,PetscReal,const PetscReal[],const PetscReal[],const PetscReal[]);
635 PETSC_EXTERN PetscErrorCode SNESMSSetType(SNES,SNESMSType);
636 PETSC_EXTERN PetscErrorCode SNESMSFinalizePackage(void);
637 PETSC_EXTERN PetscErrorCode SNESMSInitializePackage(void);
638 PETSC_EXTERN PetscErrorCode SNESMSRegisterDestroy(void);
639 PETSC_EXTERN PetscErrorCode SNESMSRegisterAll(void);
640 
641 /* routines for NGMRES solver */
642 
643 typedef enum {
644   SNES_NGMRES_RESTART_NONE       = 0,
645   SNES_NGMRES_RESTART_PERIODIC   = 1,
646   SNES_NGMRES_RESTART_DIFFERENCE = 2} SNESNGMRESRestartType;
647 PETSC_EXTERN const char *const SNESNGMRESRestartTypes[];
648 
649 typedef enum {
650   SNES_NGMRES_SELECT_NONE       = 0,
651   SNES_NGMRES_SELECT_DIFFERENCE = 1,
652   SNES_NGMRES_SELECT_LINESEARCH = 2} SNESNGMRESSelectType;
653 PETSC_EXTERN const char *const SNESNGMRESSelectTypes[];
654 
655 PETSC_EXTERN PetscErrorCode SNESNGMRESSetRestartType(SNES, SNESNGMRESRestartType);
656 PETSC_EXTERN PetscErrorCode SNESNGMRESSetSelectType(SNES, SNESNGMRESSelectType);
657 
658 /* routines for NCG solver */
659 
660 typedef enum {
661   SNES_NCG_FR    = 0,
662   SNES_NCG_PRP   = 1,
663   SNES_NCG_HS    = 2,
664   SNES_NCG_DY    = 3,
665   SNES_NCG_CD    = 4} SNESNCGType;
666 PETSC_EXTERN const char *const SNESNCGTypes[];
667 
668 PETSC_EXTERN PetscErrorCode SNESNCGSetType(SNES, SNESNCGType);
669 
670 typedef enum {SNES_QN_SCALE_NONE       = 0,
671               SNES_QN_SCALE_SHANNO     = 1,
672               SNES_QN_SCALE_LINESEARCH = 2,
673               SNES_QN_SCALE_JACOBIAN   = 3} SNESQNScaleType;
674 PETSC_EXTERN const char *const SNESQNScaleTypes[];
675 typedef enum {SNES_QN_RESTART_NONE     = 0,
676               SNES_QN_RESTART_POWELL   = 1,
677               SNES_QN_RESTART_PERIODIC = 2} SNESQNRestartType;
678 PETSC_EXTERN const char *const SNESQNRestartTypes[];
679 
680 PETSC_EXTERN PetscErrorCode SNESQNSetScaleType(SNES, SNESQNScaleType);
681 PETSC_EXTERN PetscErrorCode SNESQNSetRestartType(SNES, SNESQNRestartType);
682 
683 PETSC_EXTERN PetscErrorCode SNESNASMGetSubdomains(SNES,PetscInt*,SNES**,VecScatter**,VecScatter**,VecScatter**);
684 PETSC_EXTERN PetscErrorCode SNESNASMSetSubdomains(SNES,PetscInt,SNES*,VecScatter*,VecScatter*,VecScatter*);
685 PETSC_EXTERN PetscErrorCode SNESNASMGetSubdomainVecs(SNES,PetscInt*,Vec**,Vec**,Vec**,Vec**);
686 PETSC_EXTERN PetscErrorCode SNESNASMSetComputeFinalJacobian(SNES,PetscBool);
687 
688 #endif
689