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