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