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