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