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