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