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