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