xref: /petsc/include/petscsnes.h (revision 145b24f9ba8375c528df0ebc88beadfe15cf9e59) 
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, SNESDestroy()
18 S*/
19 typedef struct _p_SNES* SNES;
20 
21 /*J
22     SNESType - String with the name of a PETSc SNES method.
23 
24    Level: beginner
25 
26 .seealso: SNESSetType(), SNES, SNESCreate(), SNESDestroy(), SNESSetFromOptions()
27 J*/
28 typedef const char* SNESType;
29 #define SNESNEWTONLS     "newtonls"
30 #define SNESNEWTONTR     "newtontr"
31 #define SNESPYTHON       "python"
32 #define SNESTEST         "test"
33 #define SNESNRICHARDSON  "nrichardson"
34 #define SNESKSPONLY      "ksponly"
35 #define SNESVINEWTONRSLS "vinewtonrsls"
36 #define SNESVINEWTONSSLS "vinewtonssls"
37 #define SNESNGMRES       "ngmres"
38 #define SNESQN           "qn"
39 #define SNESSHELL        "shell"
40 #define SNESNGS          "ngs"
41 #define SNESNCG          "ncg"
42 #define SNESFAS          "fas"
43 #define SNESMS           "ms"
44 #define SNESNASM         "nasm"
45 #define SNESANDERSON     "anderson"
46 #define SNESASPIN        "aspin"
47 #define SNESCOMPOSITE    "composite"
48 
49 /* Logging support */
50 PETSC_EXTERN PetscClassId SNES_CLASSID;
51 PETSC_EXTERN PetscClassId DMSNES_CLASSID;
52 
53 PETSC_EXTERN PetscErrorCode SNESInitializePackage(void);
54 
55 PETSC_EXTERN PetscErrorCode SNESCreate(MPI_Comm,SNES*);
56 PETSC_EXTERN PetscErrorCode SNESReset(SNES);
57 PETSC_EXTERN PetscErrorCode SNESDestroy(SNES*);
58 PETSC_EXTERN PetscErrorCode SNESSetType(SNES,SNESType);
59 PETSC_EXTERN PetscErrorCode SNESMonitor(SNES,PetscInt,PetscReal);
60 PETSC_EXTERN PetscErrorCode SNESMonitorSet(SNES,PetscErrorCode(*)(SNES,PetscInt,PetscReal,void*),void *,PetscErrorCode (*)(void**));
61 PETSC_EXTERN PetscErrorCode SNESMonitorCancel(SNES);
62 PETSC_EXTERN PetscErrorCode SNESMonitorSAWs(SNES,PetscInt,PetscReal,void*);
63 PETSC_EXTERN PetscErrorCode SNESMonitorSAWsCreate(SNES,void**);
64 PETSC_EXTERN PetscErrorCode SNESMonitorSAWsDestroy(void**);
65 PETSC_EXTERN PetscErrorCode SNESSetConvergenceHistory(SNES,PetscReal[],PetscInt[],PetscInt,PetscBool );
66 PETSC_EXTERN PetscErrorCode SNESGetConvergenceHistory(SNES,PetscReal*[],PetscInt *[],PetscInt *);
67 PETSC_EXTERN PetscErrorCode SNESSetUp(SNES);
68 PETSC_EXTERN PetscErrorCode SNESSolve(SNES,Vec,Vec);
69 PETSC_EXTERN PetscErrorCode SNESSetErrorIfNotConverged(SNES,PetscBool );
70 PETSC_EXTERN PetscErrorCode SNESGetErrorIfNotConverged(SNES,PetscBool  *);
71 
72 PETSC_EXTERN PetscErrorCode SNESSetWorkVecs(SNES,PetscInt);
73 
74 PETSC_EXTERN PetscErrorCode SNESAddOptionsChecker(PetscErrorCode (*)(SNES));
75 
76 PETSC_EXTERN PetscErrorCode SNESSetUpdate(SNES, PetscErrorCode (*)(SNES, PetscInt));
77 
78 
79 PETSC_EXTERN PetscErrorCode SNESRegister(const char[],PetscErrorCode (*)(SNES));
80 
81 PETSC_EXTERN PetscErrorCode SNESGetKSP(SNES,KSP*);
82 PETSC_EXTERN PetscErrorCode SNESSetKSP(SNES,KSP);
83 PETSC_EXTERN PetscErrorCode SNESGetSolution(SNES,Vec*);
84 PETSC_EXTERN PetscErrorCode SNESGetSolutionUpdate(SNES,Vec*);
85 PETSC_EXTERN PetscErrorCode SNESGetRhs(SNES,Vec*);
86 PETSC_EXTERN PetscErrorCode SNESView(SNES,PetscViewer);
87 PETSC_EXTERN PetscErrorCode SNESLoad(SNES,PetscViewer);
88 PETSC_STATIC_INLINE PetscErrorCode SNESViewFromOptions(SNES A,const char prefix[],const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,prefix,name);}
89 
90 #define SNES_FILE_CLASSID 1211224
91 
92 PETSC_EXTERN PetscErrorCode SNESSetOptionsPrefix(SNES,const char[]);
93 PETSC_EXTERN PetscErrorCode SNESAppendOptionsPrefix(SNES,const char[]);
94 PETSC_EXTERN PetscErrorCode SNESGetOptionsPrefix(SNES,const char*[]);
95 PETSC_EXTERN PetscErrorCode SNESSetFromOptions(SNES);
96 
97 PETSC_EXTERN PetscErrorCode MatCreateSNESMF(SNES,Mat*);
98 PETSC_EXTERN PetscErrorCode MatMFFDComputeJacobian(SNES,Vec,Mat,Mat,void*);
99 
100 PETSC_EXTERN PetscErrorCode MatDAADSetSNES(Mat,SNES);
101 
102 PETSC_EXTERN PetscErrorCode SNESGetType(SNES,SNESType*);
103 PETSC_EXTERN PetscErrorCode SNESMonitorDefault(SNES,PetscInt,PetscReal,void *);
104 PETSC_EXTERN PetscErrorCode SNESMonitorRange(SNES,PetscInt,PetscReal,void *);
105 PETSC_EXTERN PetscErrorCode SNESMonitorRatio(SNES,PetscInt,PetscReal,void *);
106 PETSC_EXTERN PetscErrorCode SNESMonitorSetRatio(SNES,PetscViewer);
107 PETSC_EXTERN PetscErrorCode SNESMonitorSolution(SNES,PetscInt,PetscReal,void *);
108 PETSC_EXTERN PetscErrorCode SNESMonitorResidual(SNES,PetscInt,PetscReal,void *);
109 PETSC_EXTERN PetscErrorCode SNESMonitorSolutionUpdate(SNES,PetscInt,PetscReal,void *);
110 PETSC_EXTERN PetscErrorCode SNESMonitorDefaultShort(SNES,PetscInt,PetscReal,void *);
111 PETSC_EXTERN PetscErrorCode SNESMonitorJacUpdateSpectrum(SNES,PetscInt,PetscReal,void *);
112 PETSC_EXTERN PetscErrorCode SNESMonitorFields(SNES,PetscInt,PetscReal,void *);
113 PETSC_EXTERN PetscErrorCode KSPMonitorSNES(KSP,PetscInt,PetscReal,void*);
114 PETSC_EXTERN PetscErrorCode KSPMonitorSNESLGResidualNormCreate(const char[],const char[],int,int,int,int,PetscObject**);
115 PETSC_EXTERN PetscErrorCode KSPMonitorSNESLGResidualNorm(KSP,PetscInt,PetscReal,PetscObject*);
116 PETSC_EXTERN PetscErrorCode KSPMonitorSNESLGResidualNormDestroy(PetscObject**);
117 
118 PETSC_EXTERN PetscErrorCode SNESSetTolerances(SNES,PetscReal,PetscReal,PetscReal,PetscInt,PetscInt);
119 PETSC_EXTERN PetscErrorCode SNESGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,PetscInt*,PetscInt*);
120 PETSC_EXTERN PetscErrorCode SNESSetTrustRegionTolerance(SNES,PetscReal);
121 PETSC_EXTERN PetscErrorCode SNESGetIterationNumber(SNES,PetscInt*);
122 PETSC_EXTERN PetscErrorCode SNESSetIterationNumber(SNES,PetscInt);
123 
124 PETSC_EXTERN PetscErrorCode SNESGetNonlinearStepFailures(SNES,PetscInt*);
125 PETSC_EXTERN PetscErrorCode SNESSetMaxNonlinearStepFailures(SNES,PetscInt);
126 PETSC_EXTERN PetscErrorCode SNESGetMaxNonlinearStepFailures(SNES,PetscInt*);
127 PETSC_EXTERN PetscErrorCode SNESGetNumberFunctionEvals(SNES,PetscInt*);
128 
129 PETSC_EXTERN PetscErrorCode SNESSetLagPreconditioner(SNES,PetscInt);
130 PETSC_EXTERN PetscErrorCode SNESGetLagPreconditioner(SNES,PetscInt*);
131 PETSC_EXTERN PetscErrorCode SNESSetLagJacobian(SNES,PetscInt);
132 PETSC_EXTERN PetscErrorCode SNESGetLagJacobian(SNES,PetscInt*);
133 PETSC_EXTERN PetscErrorCode SNESSetLagPreconditionerPersists(SNES,PetscBool);
134 PETSC_EXTERN PetscErrorCode SNESSetLagJacobianPersists(SNES,PetscBool);
135 PETSC_EXTERN PetscErrorCode SNESSetGridSequence(SNES,PetscInt);
136 
137 PETSC_EXTERN PetscErrorCode SNESGetLinearSolveIterations(SNES,PetscInt*);
138 PETSC_EXTERN PetscErrorCode SNESGetLinearSolveFailures(SNES,PetscInt*);
139 PETSC_EXTERN PetscErrorCode SNESSetMaxLinearSolveFailures(SNES,PetscInt);
140 PETSC_EXTERN PetscErrorCode SNESGetMaxLinearSolveFailures(SNES,PetscInt*);
141 PETSC_EXTERN PetscErrorCode SNESSetCountersReset(SNES,PetscBool);
142 
143 PETSC_EXTERN PetscErrorCode SNESKSPSetUseEW(SNES,PetscBool );
144 PETSC_EXTERN PetscErrorCode SNESKSPGetUseEW(SNES,PetscBool *);
145 PETSC_EXTERN PetscErrorCode SNESKSPSetParametersEW(SNES,PetscInt,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal);
146 PETSC_EXTERN PetscErrorCode SNESKSPGetParametersEW(SNES,PetscInt*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*);
147 
148 #include <petscdrawtypes.h>
149 PETSC_EXTERN PetscErrorCode SNESMonitorLGCreate(const char[],const char[],int,int,int,int,PetscDrawLG*);
150 PETSC_EXTERN PetscErrorCode SNESMonitorLGResidualNorm(SNES,PetscInt,PetscReal,void*);
151 PETSC_EXTERN PetscErrorCode SNESMonitorLGDestroy(PetscDrawLG*);
152 PETSC_EXTERN PetscErrorCode SNESMonitorLGRange(SNES,PetscInt,PetscReal,void*);
153 
154 PETSC_EXTERN PetscErrorCode SNESSetApplicationContext(SNES,void *);
155 PETSC_EXTERN PetscErrorCode SNESGetApplicationContext(SNES,void *);
156 PETSC_EXTERN PetscErrorCode SNESSetComputeApplicationContext(SNES,PetscErrorCode (*)(SNES,void**),PetscErrorCode (*)(void**));
157 
158 PETSC_EXTERN PetscErrorCode SNESPythonSetType(SNES,const char[]);
159 
160 PETSC_EXTERN PetscErrorCode SNESSetFunctionDomainError(SNES);
161 PETSC_EXTERN PetscErrorCode SNESGetFunctionDomainError(SNES, PetscBool *);
162 
163 /*E
164     SNESConvergedReason - reason a SNES method was said to
165          have converged or diverged
166 
167    Level: beginner
168 
169    The two most common reasons for divergence are
170 $   1) an incorrectly coded or computed Jacobian or
171 $   2) failure or lack of convergence in the linear system (in this case we recommend
172 $      testing with -pc_type lu to eliminate the linear solver as the cause of the problem).
173 
174    Diverged Reasons:
175 .    SNES_DIVERGED_LOCAL_MIN - this can only occur when using the line-search variant of SNES.
176        The line search wants to minimize Q(alpha) = 1/2 || F(x + alpha s) ||^2_2  this occurs
177        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
178        you get Q'(alpha) = -F(x)^T F'(x)^(-1)^T F'(x+alpha s)F(x+alpha s); when alpha = 0
179        Q'(0) = - ||F(x)||^2_2 which is always NEGATIVE if F'(x) is invertible. This means the Newton
180        direction is a descent direction and the line search should succeed if alpha is small enough.
181 
182        If F'(x) is NOT invertible AND F'(x)^T F(x) = 0 then Q'(0) = 0 and the Newton direction
183        is NOT a descent direction so the line search will fail. All one can do at this point
184        is change the initial guess and try again.
185 
186        An alternative explanation: Newton's method can be regarded as replacing the function with
187        its linear approximation and minimizing the 2-norm of that. That is F(x+s) approx F(x) + F'(x)s
188        so we minimize || F(x) + F'(x) s ||^2_2; do this using Least Squares. If F'(x) is invertible then
189        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
190        exists a nontrival (that is F'(x)s != 0) solution to the equation and this direction is
191        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)
192        = - (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
193        and F'(x)^T F'(x) has no negative eigenvalues Q'(0) < 0 so s is a descent direction and the line
194        search should succeed for small enough alpha.
195 
196        Note that this RARELY happens in practice. Far more likely the linear system is not being solved
197        (well enough?) or the Jacobian is wrong.
198 
199    SNES_DIVERGED_MAX_IT means that the solver reached the maximum number of iterations without satisfying any
200    convergence criteria. SNES_CONVERGED_ITS means that SNESConvergedSkip() was chosen as the convergence test;
201    thus the usual convergence criteria have not been checked and may or may not be satisfied.
202 
203    Developer Notes: this must match finclude/petscsnes.h
204 
205        The string versions of these are in SNESConvergedReason, if you change any value here you must
206      also adjust that array.
207 
208    Each reason has its own manual page.
209 
210 .seealso: SNESSolve(), SNESGetConvergedReason(), KSPConvergedReason, SNESSetConvergenceTest()
211 E*/
212 typedef enum {/* converged */
213               SNES_CONVERGED_FNORM_ABS         =  2, /* ||F|| < atol */
214               SNES_CONVERGED_FNORM_RELATIVE    =  3, /* ||F|| < rtol*||F_initial|| */
215               SNES_CONVERGED_SNORM_RELATIVE    =  4, /* Newton computed step size small; || delta x || < stol || x ||*/
216               SNES_CONVERGED_ITS               =  5, /* maximum iterations reached */
217               SNES_CONVERGED_TR_DELTA          =  7,
218               /* diverged */
219               SNES_DIVERGED_FUNCTION_DOMAIN     = -1, /* the new x location passed the function is not in the domain of F */
220               SNES_DIVERGED_FUNCTION_COUNT      = -2,
221               SNES_DIVERGED_LINEAR_SOLVE        = -3, /* the linear solve failed */
222               SNES_DIVERGED_FNORM_NAN           = -4,
223               SNES_DIVERGED_MAX_IT              = -5,
224               SNES_DIVERGED_LINE_SEARCH         = -6, /* the line search failed */
225               SNES_DIVERGED_INNER               = -7, /* inner solve failed */
226               SNES_DIVERGED_LOCAL_MIN           = -8, /* || J^T b || is small, implies converged to local minimum of F() */
227               SNES_CONVERGED_ITERATING          =  0} SNESConvergedReason;
228 PETSC_EXTERN const char *const*SNESConvergedReasons;
229 
230 /*MC
231      SNES_CONVERGED_FNORM_ABS - 2-norm(F) <= abstol
232 
233    Level: beginner
234 
235 .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
236 
237 M*/
238 
239 /*MC
240      SNES_CONVERGED_FNORM_RELATIVE - 2-norm(F) <= rtol*2-norm(F(x_0)) where x_0 is the initial guess
241 
242    Level: beginner
243 
244 .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
245 
246 M*/
247 
248 /*MC
249      SNES_CONVERGED_SNORM_RELATIVE - The 2-norm of the last step <= stol * 2-norm(x) where x is the current
250           solution and stol is the 4th argument to SNESSetTolerances()
251 
252      Options Database Keys:
253       -snes_stol <stol> - the step tolerance
254 
255    Level: beginner
256 
257 .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
258 
259 M*/
260 
261 /*MC
262      SNES_DIVERGED_FUNCTION_COUNT - The user provided function has been called more times then the final
263          argument to SNESSetTolerances()
264 
265    Level: beginner
266 
267 .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
268 
269 M*/
270 
271 /*MC
272      SNES_DIVERGED_FNORM_NAN - the 2-norm of the current function evaluation is not-a-number (NaN), this
273       is usually caused by a division of 0 by 0.
274 
275    Level: beginner
276 
277 .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
278 
279 M*/
280 
281 /*MC
282      SNES_DIVERGED_MAX_IT - SNESSolve() has reached the maximum number of iterations requested
283 
284    Level: beginner
285 
286 .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
287 
288 M*/
289 
290 /*MC
291      SNES_DIVERGED_LINE_SEARCH - The line search has failed. This only occurs for a SNES solvers that use a line search
292 
293    Level: beginner
294 
295 .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances(), SNESLineSearch
296 
297 M*/
298 
299 /*MC
300      SNES_DIVERGED_LOCAL_MIN - the algorithm seems to have stagnated at a local minimum that is not zero.
301         See the manual page for SNESConvergedReason for more details
302 
303    Level: beginner
304 
305 .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
306 
307 M*/
308 
309 /*MC
310      SNES_CONERGED_ITERATING - this only occurs if SNESGetConvergedReason() is called during the SNESSolve()
311 
312    Level: beginner
313 
314 .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
315 
316 M*/
317 
318 PETSC_EXTERN PetscErrorCode SNESSetConvergenceTest(SNES,PetscErrorCode (*)(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void*,PetscErrorCode (*)(void*));
319 PETSC_EXTERN PetscErrorCode SNESConvergedDefault(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*);
320 PETSC_EXTERN PetscErrorCode SNESConvergedSkip(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*);
321 PETSC_EXTERN PetscErrorCode SNESGetConvergedReason(SNES,SNESConvergedReason*);
322 
323 PETSC_DEPRECATED("Use SNESConvergedSkip()") PETSC_STATIC_INLINE void SNESSkipConverged(void) { /* never called */ }
324 #define SNESSkipConverged (SNESSkipConverged, SNESConvergedSkip)
325 
326 /* --------- Solving systems of nonlinear equations --------------- */
327 PETSC_EXTERN PetscErrorCode SNESSetFunction(SNES,Vec,PetscErrorCode (*)(SNES,Vec,Vec,void*),void*);
328 PETSC_EXTERN PetscErrorCode SNESGetFunction(SNES,Vec*,PetscErrorCode (**)(SNES,Vec,Vec,void*),void**);
329 PETSC_EXTERN PetscErrorCode SNESComputeFunction(SNES,Vec,Vec);
330 
331 PETSC_EXTERN PetscErrorCode SNESSetJacobian(SNES,Mat,Mat,PetscErrorCode (*)(SNES,Vec,Mat,Mat,void*),void*);
332 PETSC_EXTERN PetscErrorCode SNESGetJacobian(SNES,Mat*,Mat*,PetscErrorCode (**)(SNES,Vec,Mat,Mat,void*),void**);
333 PETSC_EXTERN PetscErrorCode SNESObjectiveComputeFunctionDefaultFD(SNES,Vec,Vec,void*);
334 PETSC_EXTERN PetscErrorCode SNESComputeJacobianDefault(SNES,Vec,Mat,Mat,void*);
335 PETSC_EXTERN PetscErrorCode SNESComputeJacobianDefaultColor(SNES,Vec,Mat,Mat,void*);
336 PETSC_EXTERN PetscErrorCode SNESSetComputeInitialGuess(SNES,PetscErrorCode (*)(SNES,Vec,void*),void*);
337 PETSC_EXTERN PetscErrorCode SNESSetPicard(SNES,Vec,PetscErrorCode (*)(SNES,Vec,Vec,void*),Mat,Mat,PetscErrorCode (*)(SNES,Vec,Mat,Mat,void*),void*);
338 PETSC_EXTERN PetscErrorCode SNESGetPicard(SNES,Vec*,PetscErrorCode (**)(SNES,Vec,Vec,void*),Mat*,Mat*,PetscErrorCode (**)(SNES,Vec,Mat,Mat,void*),void**);
339 PETSC_EXTERN PetscErrorCode SNESSetInitialFunction(SNES,Vec);
340 
341 PETSC_EXTERN PetscErrorCode SNESSetObjective(SNES,PetscErrorCode (*)(SNES,Vec,PetscReal *,void*),void*);
342 PETSC_EXTERN PetscErrorCode SNESGetObjective(SNES,PetscErrorCode (**)(SNES,Vec,PetscReal *,void*),void**);
343 PETSC_EXTERN PetscErrorCode SNESComputeObjective(SNES,Vec,PetscReal *);
344 
345 /*E
346     SNESNormSchedule - Frequency with which the norm is computed
347 
348    Level: advanced
349 
350    Support for these is highly dependent on the solver.
351 
352    Notes:
353    This is primarily used to turn off extra norm and function computation
354    when the solvers are composed.
355 
356 .seealso: SNESSolve(), SNESGetConvergedReason(), KSPSetNormType(),
357           KSPSetConvergenceTest(), KSPSetPCSide()
358 E*/
359 
360 typedef enum {SNES_NORM_DEFAULT            = -1,
361               SNES_NORM_NONE               =  0,
362               SNES_NORM_ALWAYS             =  1,
363               SNES_NORM_INITIAL_ONLY       =  2,
364               SNES_NORM_FINAL_ONLY         =  3,
365               SNES_NORM_INITIAL_FINAL_ONLY =  4} SNESNormSchedule;
366 PETSC_EXTERN const char *const*const SNESNormSchedules;
367 
368 /*MC
369     SNES_NORM_NONE - Don't compute function and its L2 norm.
370 
371    Level: advanced
372 
373     Notes:
374     This is most useful for stationary solvers with a fixed number of iterations used as smoothers.
375 
376 .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_DEFAULT
377 M*/
378 
379 /*MC
380     SNES_NORM_ALWAYS - Compute the function and its L2 norm at each iteration.
381 
382    Level: advanced
383 
384     Notes:
385     Most solvers will use this no matter what norm type is passed to them.
386 
387 .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_NONE
388 M*/
389 
390 /*MC
391     SNES_NORM_INITIAL_ONLY - Compute the function and its L2 at iteration 0, but do not update it.
392 
393    Level: advanced
394 
395    Notes:
396    This method is useful in composed methods, when a true solution might actually be found before SNESSolve() is called.
397    This option enables the solve to abort on the zeroth iteration if this is the case.
398 
399    For solvers that require the computation of the L2 norm of the function as part of the method, this merely cancels
400    the norm computation at the last iteration (if possible).
401 
402 .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_FINAL_ONLY, SNES_NORM_INITIAL_FINAL_ONLY
403 M*/
404 
405 /*MC
406     SNES_NORM_FINAL_ONLY - Compute the function and its L2 norm on only the final iteration.
407 
408    Level: advanced
409 
410    Notes:
411    For solvers that require the computation of the L2 norm of the function as part of the method, behaves
412    exactly as SNES_NORM_DEFAULT.  This method is useful when the function is gotten after SNESSolve and
413    used in subsequent computation for methods that do not need the norm computed during the rest of the
414    solution procedure.
415 
416 .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_INITIAL_ONLY, SNES_NORM_INITIAL_FINAL_ONLY
417 M*/
418 
419 /*MC
420     SNES_NORM_INITIAL_FINAL_ONLY - Compute the function and its L2 norm on only the initial and final iterations.
421 
422    Level: advanced
423 
424    Notes:
425    This method combines the benefits of SNES_NORM_INITIAL_ONLY and SNES_NORM_FINAL_ONLY.
426 
427 .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_SNES_NORM_INITIAL_ONLY, SNES_NORM_FINAL_ONLY
428 M*/
429 
430 PETSC_EXTERN PetscErrorCode SNESSetNormSchedule(SNES,SNESNormSchedule);
431 PETSC_EXTERN PetscErrorCode SNESGetNormSchedule(SNES,SNESNormSchedule*);
432 
433 /*E
434     SNESFunctionType - Type of function computed
435 
436    Level: advanced
437 
438    Support for these is highly dependent on the solver.
439 
440 .seealso: SNESSolve(), SNESGetConvergedReason(), KSPSetNormType(),
441           KSPSetConvergenceTest(), KSPSetPCSide()
442 E*/
443 typedef enum {SNES_FUNCTION_DEFAULT          = -1,
444               SNES_FUNCTION_UNPRECONDITIONED =  0,
445               SNES_FUNCTION_PRECONDITIONED   =  1} SNESFunctionType;
446 PETSC_EXTERN const char *const*const SNESFunctionTypes;
447 
448 PETSC_EXTERN PetscErrorCode SNESSetFunctionType(SNES,SNESFunctionType);
449 PETSC_EXTERN PetscErrorCode SNESGetFunctionType(SNES,SNESFunctionType*);
450 
451 PETSC_EXTERN PetscErrorCode SNESSetNGS(SNES,PetscErrorCode (*)(SNES,Vec,Vec,void*),void*);
452 PETSC_EXTERN PetscErrorCode SNESGetNGS(SNES,PetscErrorCode (**)(SNES,Vec,Vec,void*),void**);
453 PETSC_EXTERN PetscErrorCode SNESSetUseNGS(SNES,PetscBool);
454 PETSC_EXTERN PetscErrorCode SNESGetUseNGS(SNES,PetscBool *);
455 PETSC_EXTERN PetscErrorCode SNESComputeNGS(SNES,Vec,Vec);
456 
457 PETSC_EXTERN PetscErrorCode SNESNGSSetSweeps(SNES,PetscInt);
458 PETSC_EXTERN PetscErrorCode SNESNGSGetSweeps(SNES,PetscInt *);
459 PETSC_EXTERN PetscErrorCode SNESNGSSetTolerances(SNES,PetscReal,PetscReal,PetscReal,PetscInt);
460 PETSC_EXTERN PetscErrorCode SNESNGSGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,PetscInt*);
461 
462 PETSC_EXTERN PetscErrorCode SNESUpdateCheckJacobian(SNES,PetscInt);
463 
464 PETSC_EXTERN PetscErrorCode SNESShellGetContext(SNES,void**);
465 PETSC_EXTERN PetscErrorCode SNESShellSetContext(SNES,void*);
466 PETSC_EXTERN PetscErrorCode SNESShellSetSolve(SNES,PetscErrorCode (*)(SNES,Vec));
467 
468 /* --------- Routines specifically for line search methods --------------- */
469 
470 typedef struct _p_LineSearch* SNESLineSearch;
471 
472 /*S
473      SNESLineSearch - Abstract PETSc object that manages line-search operations
474 
475    Level: beginner
476 
477   Concepts: nonlinear solvers, line search
478 
479 .seealso:  SNESLineSearchCreate(), SNESLineSearchSetType(), SNES
480 S*/
481 
482 /*J
483     SNESLineSearchType - String with the name of a PETSc line search method
484 
485    Level: beginner
486 
487 .seealso: SNESLineSearchSetType(), SNES
488 J*/
489 
490 typedef const char* SNESLineSearchType;
491 #define SNESLINESEARCHBT                 "bt"
492 #define SNESLINESEARCHBASIC              "basic"
493 #define SNESLINESEARCHL2                 "l2"
494 #define SNESLINESEARCHCP                 "cp"
495 #define SNESLINESEARCHSHELL              "shell"
496 
497 PETSC_EXTERN PetscFunctionList SNESList;
498 PETSC_EXTERN PetscClassId      SNESLINESEARCH_CLASSID;
499 PETSC_EXTERN PetscFunctionList SNESLineSearchList;
500 PETSC_EXTERN PetscLogEvent     SNESLineSearch_Apply;
501 
502 #define SNES_LINESEARCH_ORDER_LINEAR    1
503 #define SNES_LINESEARCH_ORDER_QUADRATIC 2
504 #define SNES_LINESEARCH_ORDER_CUBIC     3
505 
506 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchVIProjectFunc)(SNES,Vec);
507 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchVINormFunc)(SNES,Vec,Vec,PetscReal *);
508 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchApplyFunc)(SNESLineSearch);
509 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchUserFunc)(SNESLineSearch, void *);
510 
511 PETSC_EXTERN PetscErrorCode SNESLineSearchCreate(MPI_Comm, SNESLineSearch*);
512 PETSC_EXTERN PetscErrorCode SNESLineSearchReset(SNESLineSearch);
513 PETSC_EXTERN PetscErrorCode SNESLineSearchView(SNESLineSearch,PetscViewer);
514 PETSC_EXTERN PetscErrorCode SNESLineSearchDestroy(SNESLineSearch *);
515 PETSC_EXTERN PetscErrorCode SNESLineSearchSetType(SNESLineSearch, SNESLineSearchType);
516 PETSC_EXTERN PetscErrorCode SNESLineSearchSetFromOptions(SNESLineSearch);
517 PETSC_EXTERN PetscErrorCode SNESLineSearchSetFunction(SNESLineSearch,PetscErrorCode (*)(SNES,Vec,Vec));
518 PETSC_EXTERN PetscErrorCode SNESLineSearchSetUp(SNESLineSearch);
519 PETSC_EXTERN PetscErrorCode SNESLineSearchApply(SNESLineSearch, Vec, Vec, PetscReal *, Vec);
520 PETSC_EXTERN PetscErrorCode SNESLineSearchPreCheck(SNESLineSearch,Vec,Vec,PetscBool *);
521 PETSC_EXTERN PetscErrorCode SNESLineSearchPostCheck(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *);
522 PETSC_EXTERN PetscErrorCode SNESLineSearchSetWorkVecs(SNESLineSearch, PetscInt);
523 
524 /* set the functions for precheck and postcheck */
525 
526 PETSC_EXTERN PetscErrorCode SNESLineSearchSetPreCheck(SNESLineSearch, PetscErrorCode (*)(SNESLineSearch,Vec,Vec,PetscBool*,void*), void *ctx);
527 PETSC_EXTERN PetscErrorCode SNESLineSearchSetPostCheck(SNESLineSearch, PetscErrorCode (*)(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *,void*), void *ctx);
528 
529 PETSC_EXTERN PetscErrorCode SNESLineSearchGetPreCheck(SNESLineSearch, PetscErrorCode (**)(SNESLineSearch,Vec,Vec,PetscBool*,void*), void **ctx);
530 PETSC_EXTERN PetscErrorCode SNESLineSearchGetPostCheck(SNESLineSearch, PetscErrorCode (**)(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *,void*), void **ctx);
531 
532 /* set the functions for VI-specific line search operations */
533 
534 PETSC_EXTERN PetscErrorCode SNESLineSearchSetVIFunctions(SNESLineSearch, SNESLineSearchVIProjectFunc, SNESLineSearchVINormFunc);
535 PETSC_EXTERN PetscErrorCode SNESLineSearchGetVIFunctions(SNESLineSearch, SNESLineSearchVIProjectFunc*, SNESLineSearchVINormFunc*);
536 
537 /* pointers to the associated SNES in order to be able to get the function evaluation out */
538 PETSC_EXTERN PetscErrorCode SNESLineSearchSetSNES(SNESLineSearch,SNES);
539 PETSC_EXTERN PetscErrorCode SNESLineSearchGetSNES(SNESLineSearch,SNES*);
540 
541 /* set and get the parameters and vectors */
542 PETSC_EXTERN PetscErrorCode SNESLineSearchGetTolerances(SNESLineSearch,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscInt*);
543 PETSC_EXTERN PetscErrorCode SNESLineSearchSetTolerances(SNESLineSearch,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscInt);
544 
545 PETSC_EXTERN PetscErrorCode SNESLineSearchPreCheckPicard(SNESLineSearch,Vec,Vec,PetscBool*,void*);
546 
547 PETSC_EXTERN PetscErrorCode SNESLineSearchGetLambda(SNESLineSearch,PetscReal*);
548 PETSC_EXTERN PetscErrorCode SNESLineSearchSetLambda(SNESLineSearch,PetscReal);
549 
550 PETSC_EXTERN PetscErrorCode SNESLineSearchGetDamping(SNESLineSearch,PetscReal*);
551 PETSC_EXTERN PetscErrorCode SNESLineSearchSetDamping(SNESLineSearch,PetscReal);
552 
553 PETSC_EXTERN PetscErrorCode SNESLineSearchGetOrder(SNESLineSearch,PetscInt *order);
554 PETSC_EXTERN PetscErrorCode SNESLineSearchSetOrder(SNESLineSearch,PetscInt order);
555 
556 PETSC_EXTERN PetscErrorCode SNESLineSearchGetSuccess(SNESLineSearch, PetscBool*);
557 PETSC_EXTERN PetscErrorCode SNESLineSearchSetSuccess(SNESLineSearch, PetscBool);
558 
559 PETSC_EXTERN PetscErrorCode SNESLineSearchGetVecs(SNESLineSearch,Vec*,Vec*,Vec*,Vec*,Vec*);
560 PETSC_EXTERN PetscErrorCode SNESLineSearchSetVecs(SNESLineSearch,Vec,Vec,Vec,Vec,Vec);
561 
562 PETSC_EXTERN PetscErrorCode SNESLineSearchGetNorms(SNESLineSearch, PetscReal *, PetscReal *, PetscReal *);
563 PETSC_EXTERN PetscErrorCode SNESLineSearchSetNorms(SNESLineSearch, PetscReal, PetscReal, PetscReal);
564 PETSC_EXTERN PetscErrorCode SNESLineSearchComputeNorms(SNESLineSearch);
565 PETSC_EXTERN PetscErrorCode SNESLineSearchSetComputeNorms(SNESLineSearch, PetscBool);
566 
567 PETSC_EXTERN PetscErrorCode SNESLineSearchSetMonitor(SNESLineSearch, PetscBool);
568 PETSC_EXTERN PetscErrorCode SNESLineSearchGetMonitor(SNESLineSearch, PetscViewer*);
569 
570 PETSC_EXTERN PetscErrorCode SNESLineSearchAppendOptionsPrefix(SNESLineSearch, const char prefix[]);
571 PETSC_EXTERN PetscErrorCode SNESLineSearchGetOptionsPrefix(SNESLineSearch, const char *prefix[]);
572 
573 
574 /* Shell interface functions */
575 PETSC_EXTERN PetscErrorCode SNESLineSearchShellSetUserFunc(SNESLineSearch,SNESLineSearchUserFunc,void*);
576 PETSC_EXTERN PetscErrorCode SNESLineSearchShellGetUserFunc(SNESLineSearch,SNESLineSearchUserFunc*,void**);
577 
578 /* BT interface functions */
579 PETSC_EXTERN PetscErrorCode SNESLineSearchBTSetAlpha(SNESLineSearch, PetscReal);
580 PETSC_EXTERN PetscErrorCode SNESLineSearchBTGetAlpha(SNESLineSearch, PetscReal*);
581 
582 /*register line search types */
583 PETSC_EXTERN PetscErrorCode SNESLineSearchRegister(const char[],PetscErrorCode(*)(SNESLineSearch));
584 
585 /* Routines for VI solver */
586 PETSC_EXTERN PetscErrorCode SNESVISetVariableBounds(SNES,Vec,Vec);
587 PETSC_EXTERN PetscErrorCode SNESVISetComputeVariableBounds(SNES, PetscErrorCode (*)(SNES,Vec,Vec));
588 PETSC_EXTERN PetscErrorCode SNESVIGetInactiveSet(SNES,IS*);
589 PETSC_EXTERN PetscErrorCode SNESVIGetActiveSetIS(SNES,Vec,Vec,IS*);
590 PETSC_EXTERN PetscErrorCode SNESVIComputeInactiveSetFnorm(SNES,Vec,Vec,PetscReal*);
591 PETSC_EXTERN PetscErrorCode SNESVISetRedundancyCheck(SNES,PetscErrorCode(*)(SNES,IS,IS*,void*),void*);
592 
593 PETSC_EXTERN PetscErrorCode SNESTestLocalMin(SNES);
594 
595 /* Should this routine be private? */
596 PETSC_EXTERN PetscErrorCode SNESComputeJacobian(SNES,Vec,Mat,Mat);
597 
598 PETSC_EXTERN PetscErrorCode SNESSetDM(SNES,DM);
599 PETSC_EXTERN PetscErrorCode SNESGetDM(SNES,DM*);
600 PETSC_EXTERN PetscErrorCode SNESSetNPC(SNES,SNES);
601 PETSC_EXTERN PetscErrorCode SNESGetNPC(SNES,SNES*);
602 PETSC_EXTERN PetscErrorCode SNESApplyNPC(SNES,Vec,Vec,Vec);
603 PETSC_EXTERN PetscErrorCode SNESGetNPCFunction(SNES,Vec,PetscReal*);
604 PETSC_EXTERN PetscErrorCode SNESComputeFunctionDefaultNPC(SNES,Vec,Vec);
605 PETSC_EXTERN PetscErrorCode SNESSetNPCSide(SNES,PCSide);
606 PETSC_EXTERN PetscErrorCode SNESGetNPCSide(SNES,PCSide*);
607 PETSC_EXTERN PetscErrorCode SNESSetLineSearch(SNES,SNESLineSearch);
608 PETSC_EXTERN PetscErrorCode SNESGetLineSearch(SNES,SNESLineSearch*);
609 PETSC_EXTERN PetscErrorCode SNESRestrictHookAdd(SNES,PetscErrorCode (*)(SNES,SNES,void*),void*);
610 PETSC_EXTERN PetscErrorCode SNESRestrictHooksRun(SNES,SNES);
611 
612 PETSC_DEPRECATED("Use SNESGetLineSearch()") PETSC_STATIC_INLINE PetscErrorCode SNESGetSNESLineSearch(SNES snes,SNESLineSearch *ls) {return SNESGetLineSearch(snes,ls);}
613 PETSC_DEPRECATED("Use SNESSetLineSearch()") PETSC_STATIC_INLINE PetscErrorCode SNESSetSNESLineSearch(SNES snes,SNESLineSearch ls) {return SNESSetLineSearch(snes,ls);}
614 
615 PETSC_EXTERN PetscErrorCode SNESSetUpMatrices(SNES);
616 PETSC_EXTERN PetscErrorCode DMSNESSetFunction(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),void*);
617 PETSC_EXTERN PetscErrorCode DMSNESGetFunction(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),void**);
618 PETSC_EXTERN PetscErrorCode DMSNESSetNGS(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),void*);
619 PETSC_EXTERN PetscErrorCode DMSNESGetNGS(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),void**);
620 PETSC_EXTERN PetscErrorCode DMSNESSetJacobian(DM,PetscErrorCode(*)(SNES,Vec,Mat,Mat,void*),void*);
621 PETSC_EXTERN PetscErrorCode DMSNESGetJacobian(DM,PetscErrorCode(**)(SNES,Vec,Mat,Mat,void*),void**);
622 PETSC_EXTERN PetscErrorCode DMSNESSetPicard(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),PetscErrorCode(*)(SNES,Vec,Mat,Mat,void*),void*);
623 PETSC_EXTERN PetscErrorCode DMSNESGetPicard(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),PetscErrorCode(**)(SNES,Vec,Mat,Mat,void*),void**);
624 PETSC_EXTERN PetscErrorCode DMSNESSetObjective(DM,PetscErrorCode (*)(SNES,Vec,PetscReal *,void*),void*);
625 PETSC_EXTERN PetscErrorCode DMSNESGetObjective(DM,PetscErrorCode (**)(SNES,Vec,PetscReal *,void*),void**);
626 
627 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESFunction)(DMDALocalInfo*,void*,void*,void*);
628 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESJacobian)(DMDALocalInfo*,void*,Mat,Mat,void*);
629 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESObjective)(DMDALocalInfo*,void*,PetscReal*,void*);
630 
631 PETSC_EXTERN PetscErrorCode DMDASNESSetFunctionLocal(DM,InsertMode,DMDASNESFunction,void*);
632 PETSC_EXTERN PetscErrorCode DMDASNESSetJacobianLocal(DM,DMDASNESJacobian,void*);
633 PETSC_EXTERN PetscErrorCode DMDASNESSetObjectiveLocal(DM,DMDASNESObjective,void*);
634 PETSC_EXTERN PetscErrorCode DMDASNESSetPicardLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,void*,void*,void*),PetscErrorCode (*)(DMDALocalInfo*,void*,Mat,Mat,void*),void*);
635 
636 PETSC_EXTERN PetscErrorCode DMPlexSNESGetGeometryFEM(DM,Vec*);
637 PETSC_EXTERN PetscErrorCode DMPlexSNESGetGeometryFVM(DM,Vec*,Vec*,PetscReal*);
638 
639 PETSC_EXTERN PetscErrorCode DMSNESSetFunctionLocal(DM,PetscErrorCode (*)(DM,Vec,Vec,void*),void*);
640 PETSC_EXTERN PetscErrorCode DMSNESSetJacobianLocal(DM,PetscErrorCode (*)(DM,Vec,Mat,Mat,void*),void*);
641 
642 /* Routines for Multiblock solver */
643 PETSC_EXTERN PetscErrorCode SNESMultiblockSetFields(SNES, const char [], PetscInt, const PetscInt *);
644 PETSC_EXTERN PetscErrorCode SNESMultiblockSetIS(SNES, const char [], IS);
645 PETSC_EXTERN PetscErrorCode SNESMultiblockSetBlockSize(SNES, PetscInt);
646 PETSC_EXTERN PetscErrorCode SNESMultiblockSetType(SNES, PCCompositeType);
647 
648 /*J
649     SNESMSType - String with the name of a PETSc SNESMS method.
650 
651    Level: intermediate
652 
653 .seealso: SNESMSSetType(), SNES
654 J*/
655 typedef const char* SNESMSType;
656 #define SNESMSM62       "m62"
657 #define SNESMSEULER     "euler"
658 #define SNESMSJAMESON83 "jameson83"
659 #define SNESMSVLTP21    "vltp21"
660 #define SNESMSVLTP31    "vltp31"
661 #define SNESMSVLTP41    "vltp41"
662 #define SNESMSVLTP51    "vltp51"
663 #define SNESMSVLTP61    "vltp61"
664 
665 PETSC_EXTERN PetscErrorCode SNESMSRegister(SNESMSType,PetscInt,PetscInt,PetscReal,const PetscReal[],const PetscReal[],const PetscReal[]);
666 PETSC_EXTERN PetscErrorCode SNESMSSetType(SNES,SNESMSType);
667 PETSC_EXTERN PetscErrorCode SNESMSFinalizePackage(void);
668 PETSC_EXTERN PetscErrorCode SNESMSInitializePackage(void);
669 PETSC_EXTERN PetscErrorCode SNESMSRegisterDestroy(void);
670 
671 /* routines for NGMRES solver */
672 
673 typedef enum {
674   SNES_NGMRES_RESTART_NONE       = 0,
675   SNES_NGMRES_RESTART_PERIODIC   = 1,
676   SNES_NGMRES_RESTART_DIFFERENCE = 2} SNESNGMRESRestartType;
677 PETSC_EXTERN const char *const SNESNGMRESRestartTypes[];
678 
679 typedef enum {
680   SNES_NGMRES_SELECT_NONE       = 0,
681   SNES_NGMRES_SELECT_DIFFERENCE = 1,
682   SNES_NGMRES_SELECT_LINESEARCH = 2} SNESNGMRESSelectType;
683 PETSC_EXTERN const char *const SNESNGMRESSelectTypes[];
684 
685 PETSC_EXTERN PetscErrorCode SNESNGMRESSetRestartType(SNES, SNESNGMRESRestartType);
686 PETSC_EXTERN PetscErrorCode SNESNGMRESSetSelectType(SNES, SNESNGMRESSelectType);
687 
688 /* routines for NCG solver */
689 
690 typedef enum {
691   SNES_NCG_FR    = 0,
692   SNES_NCG_PRP   = 1,
693   SNES_NCG_HS    = 2,
694   SNES_NCG_DY    = 3,
695   SNES_NCG_CD    = 4} SNESNCGType;
696 PETSC_EXTERN const char *const SNESNCGTypes[];
697 
698 PETSC_EXTERN PetscErrorCode SNESNCGSetType(SNES, SNESNCGType);
699 
700 typedef enum {SNES_QN_SCALE_DEFAULT    = 0,
701               SNES_QN_SCALE_NONE       = 1,
702               SNES_QN_SCALE_SHANNO     = 2,
703               SNES_QN_SCALE_LINESEARCH = 3,
704               SNES_QN_SCALE_JACOBIAN   = 4} SNESQNScaleType;
705 PETSC_EXTERN const char *const SNESQNScaleTypes[];
706 typedef enum {SNES_QN_RESTART_DEFAULT  = 0,
707               SNES_QN_RESTART_NONE     = 1,
708               SNES_QN_RESTART_POWELL   = 2,
709               SNES_QN_RESTART_PERIODIC = 3} SNESQNRestartType;
710 PETSC_EXTERN const char *const SNESQNRestartTypes[];
711 typedef enum {SNES_QN_LBFGS      = 0,
712               SNES_QN_BROYDEN    = 1,
713               SNES_QN_BADBROYDEN = 2
714              } SNESQNType;
715 PETSC_EXTERN const char *const SNESQNTypes[];
716 
717 PETSC_EXTERN PetscErrorCode SNESQNSetType(SNES, SNESQNType);
718 PETSC_EXTERN PetscErrorCode SNESQNSetScaleType(SNES, SNESQNScaleType);
719 PETSC_EXTERN PetscErrorCode SNESQNSetRestartType(SNES, SNESQNRestartType);
720 
721 PETSC_EXTERN PetscErrorCode SNESNASMGetType(SNES,PCASMType*);
722 PETSC_EXTERN PetscErrorCode SNESNASMSetType(SNES,PCASMType);
723 PETSC_EXTERN PetscErrorCode SNESNASMGetSubdomains(SNES,PetscInt*,SNES**,VecScatter**,VecScatter**,VecScatter**);
724 PETSC_EXTERN PetscErrorCode SNESNASMSetSubdomains(SNES,PetscInt,SNES*,VecScatter*,VecScatter*,VecScatter*);
725 PETSC_EXTERN PetscErrorCode SNESNASMSetDamping(SNES,PetscReal);
726 PETSC_EXTERN PetscErrorCode SNESNASMGetDamping(SNES,PetscReal*);
727 PETSC_EXTERN PetscErrorCode SNESNASMGetSubdomainVecs(SNES,PetscInt*,Vec**,Vec**,Vec**,Vec**);
728 PETSC_EXTERN PetscErrorCode SNESNASMSetComputeFinalJacobian(SNES,PetscBool);
729 
730 typedef enum {SNES_COMPOSITE_ADDITIVE,SNES_COMPOSITE_MULTIPLICATIVE,SNES_COMPOSITE_ADDITIVEOPTIMAL} SNESCompositeType;
731 PETSC_EXTERN const char *const SNESCompositeTypes[];
732 
733 PETSC_EXTERN PetscErrorCode SNESCompositeSetType(SNES,SNESCompositeType);
734 PETSC_EXTERN PetscErrorCode SNESCompositeAddSNES(SNES,SNESType);
735 PETSC_EXTERN PetscErrorCode SNESCompositeGetSNES(SNES,PetscInt,SNES *);
736 PETSC_EXTERN PetscErrorCode SNESCompositeGetNumber(SNES,PetscInt*);
737 PETSC_EXTERN PetscErrorCode SNESCompositeSetDamping(SNES,PetscInt,PetscReal);
738 
739 /*E
740     SNESFASType - Determines the type of nonlinear multigrid method that is run.
741 
742    Level: beginner
743 
744    Values:
745 +  SNES_FAS_MULTIPLICATIVE (default) - traditional V or W cycle as determined by SNESFASSetCycles()
746 .  SNES_FAS_ADDITIVE                 - additive FAS cycle
747 .  SNES_FAS_FULL                     - full FAS cycle
748 -  SNES_FAS_KASKADE                  - Kaskade FAS cycle
749 .seealso: PCMGSetType(), PCMGType
750 
751 E*/
752 typedef enum { SNES_FAS_MULTIPLICATIVE, SNES_FAS_ADDITIVE, SNES_FAS_FULL, SNES_FAS_KASKADE } SNESFASType;
753 PETSC_EXTERN const char *const  SNESFASTypes[];
754 
755 /* called on the finest level FAS instance*/
756 PETSC_EXTERN PetscErrorCode SNESFASSetType(SNES, SNESFASType);
757 PETSC_EXTERN PetscErrorCode SNESFASGetType(SNES, SNESFASType*);
758 PETSC_EXTERN PetscErrorCode SNESFASSetLevels(SNES, PetscInt, MPI_Comm *);
759 PETSC_EXTERN PetscErrorCode SNESFASGetLevels(SNES, PetscInt *);
760 PETSC_EXTERN PetscErrorCode SNESFASGetCycleSNES(SNES, PetscInt, SNES*);
761 PETSC_EXTERN PetscErrorCode SNESFASSetNumberSmoothUp(SNES, PetscInt);
762 PETSC_EXTERN PetscErrorCode SNESFASSetNumberSmoothDown(SNES, PetscInt);
763 PETSC_EXTERN PetscErrorCode SNESFASSetCycles(SNES, PetscInt);
764 PETSC_EXTERN PetscErrorCode SNESFASSetMonitor(SNES, PetscBool);
765 PETSC_EXTERN PetscErrorCode SNESFASSetLog(SNES, PetscBool);
766 
767 PETSC_EXTERN PetscErrorCode SNESFASSetGalerkin(SNES, PetscBool);
768 PETSC_EXTERN PetscErrorCode SNESFASGetGalerkin(SNES, PetscBool*);
769 
770 /* called on any level -- "Cycle" FAS instance */
771 PETSC_EXTERN PetscErrorCode SNESFASCycleGetSmoother(SNES, SNES*);
772 PETSC_EXTERN PetscErrorCode SNESFASCycleGetSmootherUp(SNES, SNES*);
773 PETSC_EXTERN PetscErrorCode SNESFASCycleGetSmootherDown(SNES, SNES*);
774 PETSC_EXTERN PetscErrorCode SNESFASCycleGetCorrection(SNES, SNES*);
775 PETSC_EXTERN PetscErrorCode SNESFASCycleGetInterpolation(SNES, Mat*);
776 PETSC_EXTERN PetscErrorCode SNESFASCycleGetRestriction(SNES, Mat*);
777 PETSC_EXTERN PetscErrorCode SNESFASCycleGetInjection(SNES, Mat*);
778 PETSC_EXTERN PetscErrorCode SNESFASCycleGetRScale(SNES, Vec*);
779 PETSC_EXTERN PetscErrorCode SNESFASCycleSetCycles(SNES, PetscInt);
780 PETSC_EXTERN PetscErrorCode SNESFASCycleIsFine(SNES, PetscBool*);
781 
782 /* called on the (outer) finest level FAS to set/get parameters on any level instance */
783 PETSC_EXTERN PetscErrorCode SNESFASSetInterpolation(SNES, PetscInt, Mat);
784 PETSC_EXTERN PetscErrorCode SNESFASGetInterpolation(SNES, PetscInt, Mat*);
785 PETSC_EXTERN PetscErrorCode SNESFASSetRestriction(SNES, PetscInt, Mat);
786 PETSC_EXTERN PetscErrorCode SNESFASGetRestriction(SNES, PetscInt, Mat*);
787 PETSC_EXTERN PetscErrorCode SNESFASSetInjection(SNES, PetscInt, Mat);
788 PETSC_EXTERN PetscErrorCode SNESFASGetInjection(SNES, PetscInt, Mat*);
789 PETSC_EXTERN PetscErrorCode SNESFASSetRScale(SNES, PetscInt, Vec);
790 PETSC_EXTERN PetscErrorCode SNESFASGetRScale(SNES, PetscInt, Vec*);
791 PETSC_EXTERN PetscErrorCode SNESFASSetContinuation(SNES,PetscBool);
792 
793 PETSC_EXTERN PetscErrorCode SNESFASGetSmoother(SNES,     PetscInt, SNES*);
794 PETSC_EXTERN PetscErrorCode SNESFASGetSmootherUp(SNES,   PetscInt, SNES*);
795 PETSC_EXTERN PetscErrorCode SNESFASGetSmootherDown(SNES, PetscInt, SNES*);
796 PETSC_EXTERN PetscErrorCode SNESFASGetCoarseSolve(SNES, SNES*);
797 
798 /* parameters for full FAS */
799 PETSC_EXTERN PetscErrorCode SNESFASFullSetDownSweep(SNES,PetscBool);
800 PETSC_EXTERN PetscErrorCode SNESFASCreateCoarseVec(SNES,Vec*);
801 PETSC_EXTERN PetscErrorCode SNESFASRestrict(SNES,Vec,Vec);
802 
803 #endif
804