Actual source code: petscsnes.h
petsc-dev 2014-02-02
1: /*
2: User interface for the nonlinear solvers package.
3: */
6: #include <petscksp.h>
7: #include <petscdmtypes.h>
8: #include <petscdmdatypes.h>
10: /*S
11: SNES - Abstract PETSc object that manages all nonlinear solves
13: Level: beginner
15: Concepts: nonlinear solvers
17: .seealso: SNESCreate(), SNESSetType(), SNESType, TS, KSP, KSP, PC, SNESDestroy()
18: S*/
19: typedef struct _p_SNES* SNES;
21: /*J
22: SNESType - String with the name of a PETSc SNES method.
24: Level: beginner
26: .seealso: SNESSetType(), SNES, SNESCreate(), SNESDestroy(), SNESSetFromOptions()
27: J*/
28: typedef const char* SNESType;
29: #define SNESNEWTONLS "newtonls"
30: #define SNESNEWTONTR "newtontr"
31: #define SNESPYTHON "python"
32: #define SNESTEST "test"
33: #define SNESNRICHARDSON "nrichardson"
34: #define SNESKSPONLY "ksponly"
35: #define SNESVINEWTONRSLS "vinewtonrsls"
36: #define SNESVINEWTONSSLS "vinewtonssls"
37: #define SNESNGMRES "ngmres"
38: #define SNESQN "qn"
39: #define SNESSHELL "shell"
40: #define SNESGS "gs"
41: #define SNESNCG "ncg"
42: #define SNESFAS "fas"
43: #define SNESMS "ms"
44: #define SNESNASM "nasm"
45: #define SNESANDERSON "anderson"
46: #define SNESASPIN "aspin"
47: #define SNESCOMPOSITE "composite"
49: /* Logging support */
50: PETSC_EXTERN PetscClassId SNES_CLASSID;
51: PETSC_EXTERN PetscClassId DMSNES_CLASSID;
53: PETSC_EXTERN PetscErrorCode SNESInitializePackage(void);
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 SNESMonitorCancel(SNES);
62: PETSC_EXTERN PetscErrorCode SNESMonitorSAWs(SNES,PetscInt,PetscReal,void*);
63: PETSC_EXTERN PetscErrorCode SNESMonitorSAWsCreate(SNES,void**);
64: PETSC_EXTERN PetscErrorCode SNESMonitorSAWsDestroy(void**);
65: PETSC_EXTERN PetscErrorCode SNESSetConvergenceHistory(SNES,PetscReal[],PetscInt[],PetscInt,PetscBool );
66: PETSC_EXTERN PetscErrorCode SNESGetConvergenceHistory(SNES,PetscReal*[],PetscInt *[],PetscInt *);
67: PETSC_EXTERN PetscErrorCode SNESSetUp(SNES);
68: PETSC_EXTERN PetscErrorCode SNESSolve(SNES,Vec,Vec);
69: PETSC_EXTERN PetscErrorCode SNESSetErrorIfNotConverged(SNES,PetscBool );
70: PETSC_EXTERN PetscErrorCode SNESGetErrorIfNotConverged(SNES,PetscBool *);
72: PETSC_EXTERN PetscErrorCode SNESSetWorkVecs(SNES,PetscInt);
74: PETSC_EXTERN PetscErrorCode SNESAddOptionsChecker(PetscErrorCode (*)(SNES));
76: PETSC_EXTERN PetscErrorCode SNESSetUpdate(SNES, PetscErrorCode (*)(SNES, PetscInt));
78: PETSC_EXTERN PetscErrorCode SNESRegisterAll(void);
80: PETSC_EXTERN PetscErrorCode SNESRegister(const char[],PetscErrorCode (*)(SNES));
82: PETSC_EXTERN PetscErrorCode SNESGetKSP(SNES,KSP*);
83: PETSC_EXTERN PetscErrorCode SNESSetKSP(SNES,KSP);
84: PETSC_EXTERN PetscErrorCode SNESGetSolution(SNES,Vec*);
85: PETSC_EXTERN PetscErrorCode SNESGetSolutionUpdate(SNES,Vec*);
86: PETSC_EXTERN PetscErrorCode SNESGetRhs(SNES,Vec*);
87: PETSC_EXTERN PetscErrorCode SNESView(SNES,PetscViewer);
88: PETSC_EXTERN PetscErrorCode SNESLoad(SNES,PetscViewer);
89: PETSC_STATIC_INLINE PetscErrorCode SNESViewFromOptions(SNES A,const char prefix[],const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,prefix,name);}
91: #define SNES_FILE_CLASSID 1211224
93: PETSC_EXTERN PetscErrorCode SNESSetOptionsPrefix(SNES,const char[]);
94: PETSC_EXTERN PetscErrorCode SNESAppendOptionsPrefix(SNES,const char[]);
95: PETSC_EXTERN PetscErrorCode SNESGetOptionsPrefix(SNES,const char*[]);
96: PETSC_EXTERN PetscErrorCode SNESSetFromOptions(SNES);
98: PETSC_EXTERN PetscErrorCode MatCreateSNESMF(SNES,Mat*);
99: PETSC_EXTERN PetscErrorCode MatMFFDComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
101: PETSC_EXTERN PetscErrorCode MatDAADSetSNES(Mat,SNES);
103: PETSC_EXTERN PetscErrorCode SNESGetType(SNES,SNESType*);
104: PETSC_EXTERN PetscErrorCode SNESMonitorDefault(SNES,PetscInt,PetscReal,void *);
105: PETSC_EXTERN PetscErrorCode SNESMonitorRange(SNES,PetscInt,PetscReal,void *);
106: PETSC_EXTERN PetscErrorCode SNESMonitorRatio(SNES,PetscInt,PetscReal,void *);
107: PETSC_EXTERN PetscErrorCode SNESMonitorSetRatio(SNES,PetscViewer);
108: PETSC_EXTERN PetscErrorCode SNESMonitorSolution(SNES,PetscInt,PetscReal,void *);
109: PETSC_EXTERN PetscErrorCode SNESMonitorResidual(SNES,PetscInt,PetscReal,void *);
110: PETSC_EXTERN PetscErrorCode SNESMonitorSolutionUpdate(SNES,PetscInt,PetscReal,void *);
111: PETSC_EXTERN PetscErrorCode SNESMonitorDefaultShort(SNES,PetscInt,PetscReal,void *);
112: PETSC_EXTERN PetscErrorCode SNESMonitorJacUpdateSpectrum(SNES,PetscInt,PetscReal,void *);
113: PETSC_EXTERN PetscErrorCode SNESSetTolerances(SNES,PetscReal,PetscReal,PetscReal,PetscInt,PetscInt);
114: PETSC_EXTERN PetscErrorCode SNESGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,PetscInt*,PetscInt*);
115: PETSC_EXTERN PetscErrorCode SNESSetTrustRegionTolerance(SNES,PetscReal);
116: PETSC_EXTERN PetscErrorCode SNESGetFunctionNorm(SNES,PetscReal*);
117: PETSC_EXTERN PetscErrorCode SNESSetFunctionNorm(SNES,PetscReal);
118: PETSC_EXTERN PetscErrorCode SNESGetIterationNumber(SNES,PetscInt*);
119: PETSC_EXTERN PetscErrorCode SNESSetIterationNumber(SNES,PetscInt);
121: PETSC_EXTERN PetscErrorCode SNESGetNonlinearStepFailures(SNES,PetscInt*);
122: PETSC_EXTERN PetscErrorCode SNESSetMaxNonlinearStepFailures(SNES,PetscInt);
123: PETSC_EXTERN PetscErrorCode SNESGetMaxNonlinearStepFailures(SNES,PetscInt*);
124: PETSC_EXTERN PetscErrorCode SNESGetNumberFunctionEvals(SNES,PetscInt*);
126: PETSC_EXTERN PetscErrorCode SNESSetLagPreconditioner(SNES,PetscInt);
127: PETSC_EXTERN PetscErrorCode SNESGetLagPreconditioner(SNES,PetscInt*);
128: PETSC_EXTERN PetscErrorCode SNESSetLagJacobian(SNES,PetscInt);
129: PETSC_EXTERN PetscErrorCode SNESGetLagJacobian(SNES,PetscInt*);
130: PETSC_EXTERN PetscErrorCode SNESSetLagPreconditionerPersists(SNES,PetscBool);
131: PETSC_EXTERN PetscErrorCode SNESSetLagJacobianPersists(SNES,PetscBool);
132: PETSC_EXTERN PetscErrorCode SNESSetGridSequence(SNES,PetscInt);
134: PETSC_EXTERN PetscErrorCode SNESGetLinearSolveIterations(SNES,PetscInt*);
135: PETSC_EXTERN PetscErrorCode SNESGetLinearSolveFailures(SNES,PetscInt*);
136: PETSC_EXTERN PetscErrorCode SNESSetMaxLinearSolveFailures(SNES,PetscInt);
137: PETSC_EXTERN PetscErrorCode SNESGetMaxLinearSolveFailures(SNES,PetscInt*);
138: PETSC_EXTERN PetscErrorCode SNESSetCountersReset(SNES,PetscBool);
140: PETSC_EXTERN PetscErrorCode SNESKSPSetUseEW(SNES,PetscBool );
141: PETSC_EXTERN PetscErrorCode SNESKSPGetUseEW(SNES,PetscBool *);
142: PETSC_EXTERN PetscErrorCode SNESKSPSetParametersEW(SNES,PetscInt,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal);
143: PETSC_EXTERN PetscErrorCode SNESKSPGetParametersEW(SNES,PetscInt*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*);
145: #include <petscdrawtypes.h>
146: PETSC_EXTERN PetscErrorCode SNESMonitorLGCreate(const char[],const char[],int,int,int,int,PetscDrawLG*);
147: PETSC_EXTERN PetscErrorCode SNESMonitorLGResidualNorm(SNES,PetscInt,PetscReal,void*);
148: PETSC_EXTERN PetscErrorCode SNESMonitorLGDestroy(PetscDrawLG*);
149: PETSC_EXTERN PetscErrorCode SNESMonitorLGRange(SNES,PetscInt,PetscReal,void*);
151: PETSC_EXTERN PetscErrorCode SNESSetApplicationContext(SNES,void *);
152: PETSC_EXTERN PetscErrorCode SNESGetApplicationContext(SNES,void *);
153: PETSC_EXTERN PetscErrorCode SNESSetComputeApplicationContext(SNES,PetscErrorCode (*)(SNES,void**),PetscErrorCode (*)(void**));
155: PETSC_EXTERN PetscErrorCode SNESPythonSetType(SNES,const char[]);
157: PETSC_EXTERN PetscErrorCode SNESSetFunctionDomainError(SNES);
158: PETSC_EXTERN PetscErrorCode SNESGetFunctionDomainError(SNES, PetscBool *);
160: /*E
161: SNESConvergedReason - reason a SNES method was said to
162: have converged or diverged
164: Level: beginner
166: The two most common reasons for divergence are
167: $ 1) an incorrectly coded or computed Jacobian or
168: $ 2) failure or lack of convergence in the linear system (in this case we recommend
169: $ testing with -pc_type lu to eliminate the linear solver as the cause of the problem).
171: Diverged Reasons:
172: . SNES_DIVERGED_LOCAL_MIN - this can only occur when using the line-search variant of SNES.
173: The line search wants to minimize Q(alpha) = 1/2 || F(x + alpha s) ||^2_2 this occurs
174: 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
175: you get Q'(alpha) = -F(x)^T F'(x)^(-1)^T F'(x+alpha s)F(x+alpha s); when alpha = 0
176: Q'(0) = - ||F(x)||^2_2 which is always NEGATIVE if F'(x) is invertible. This means the Newton
177: direction is a descent direction and the line search should succeed if alpha is small enough.
179: If F'(x) is NOT invertible AND F'(x)^T F(x) = 0 then Q'(0) = 0 and the Newton direction
180: is NOT a descent direction so the line search will fail. All one can do at this point
181: is change the initial guess and try again.
183: An alternative explanation: Newton's method can be regarded as replacing the function with
184: its linear approximation and minimizing the 2-norm of that. That is F(x+s) approx F(x) + F'(x)s
185: so we minimize || F(x) + F'(x) s ||^2_2; do this using Least Squares. If F'(x) is invertible then
186: 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
187: exists a nontrival (that is F'(x)s != 0) solution to the equation and this direction is
188: 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)
189: = - (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
190: and F'(x)^T F'(x) has no negative eigenvalues Q'(0) < 0 so s is a descent direction and the line
191: search should succeed for small enough alpha.
193: Note that this RARELY happens in practice. Far more likely the linear system is not being solved
194: (well enough?) or the Jacobian is wrong.
196: SNES_DIVERGED_MAX_IT means that the solver reached the maximum number of iterations without satisfying any
197: convergence criteria. SNES_CONVERGED_ITS means that SNESConvergedSkip() was chosen as the convergence test;
198: thus the usual convergence criteria have not been checked and may or may not be satisfied.
200: Developer Notes: this must match finclude/petscsnes.h
202: The string versions of these are in SNESConvergedReason, if you change any value here you must
203: also adjust that array.
205: Each reason has its own manual page.
207: .seealso: SNESSolve(), SNESGetConvergedReason(), KSPConvergedReason, SNESSetConvergenceTest()
208: E*/
209: typedef enum {/* converged */
210: SNES_CONVERGED_FNORM_ABS = 2, /* ||F|| < atol */
211: SNES_CONVERGED_FNORM_RELATIVE = 3, /* ||F|| < rtol*||F_initial|| */
212: SNES_CONVERGED_SNORM_RELATIVE = 4, /* Newton computed step size small; || delta x || < stol || x ||*/
213: SNES_CONVERGED_ITS = 5, /* maximum iterations reached */
214: SNES_CONVERGED_TR_DELTA = 7,
215: /* diverged */
216: SNES_DIVERGED_FUNCTION_DOMAIN = -1, /* the new x location passed the function is not in the domain of F */
217: SNES_DIVERGED_FUNCTION_COUNT = -2,
218: SNES_DIVERGED_LINEAR_SOLVE = -3, /* the linear solve failed */
219: SNES_DIVERGED_FNORM_NAN = -4,
220: SNES_DIVERGED_MAX_IT = -5,
221: SNES_DIVERGED_LINE_SEARCH = -6, /* the line search failed */
222: SNES_DIVERGED_INNER = -7, /* inner solve failed */
223: SNES_DIVERGED_LOCAL_MIN = -8, /* || J^T b || is small, implies converged to local minimum of F() */
224: SNES_CONVERGED_ITERATING = 0} SNESConvergedReason;
225: PETSC_EXTERN const char *const*SNESConvergedReasons;
227: /*MC
228: SNES_CONVERGED_FNORM_ABS - 2-norm(F) <= abstol
230: Level: beginner
232: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
234: M*/
236: /*MC
237: SNES_CONVERGED_FNORM_RELATIVE - 2-norm(F) <= rtol*2-norm(F(x_0)) where x_0 is the initial guess
239: Level: beginner
241: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
243: M*/
245: /*MC
246: SNES_CONVERGED_SNORM_RELATIVE - The 2-norm of the last step <= stol * 2-norm(x) where x is the current
247: solution and stol is the 4th argument to SNESSetTolerances()
249: Options Database Keys:
250: -snes_stol <stol> - the step tolerance
252: Level: beginner
254: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
256: M*/
258: /*MC
259: SNES_DIVERGED_FUNCTION_COUNT - The user provided function has been called more times then the final
260: argument to SNESSetTolerances()
262: Level: beginner
264: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
266: M*/
268: /*MC
269: SNES_DIVERGED_FNORM_NAN - the 2-norm of the current function evaluation is not-a-number (NaN), this
270: is usually caused by a division of 0 by 0.
272: Level: beginner
274: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
276: M*/
278: /*MC
279: SNES_DIVERGED_MAX_IT - SNESSolve() has reached the maximum number of iterations requested
281: Level: beginner
283: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
285: M*/
287: /*MC
288: SNES_DIVERGED_LINE_SEARCH - The line search has failed. This only occurs for a SNES solvers that use a line search
290: Level: beginner
292: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances(), SNESLineSearch
294: M*/
296: /*MC
297: SNES_DIVERGED_LOCAL_MIN - the algorithm seems to have stagnated at a local minimum that is not zero.
298: See the manual page for SNESConvergedReason for more details
300: Level: beginner
302: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
304: M*/
306: /*MC
307: SNES_CONERGED_ITERATING - this only occurs if SNESGetConvergedReason() is called during the SNESSolve()
309: Level: beginner
311: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
313: M*/
315: PETSC_EXTERN PetscErrorCode SNESSetConvergenceTest(SNES,PetscErrorCode (*)(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void*,PetscErrorCode (*)(void*));
316: PETSC_EXTERN PetscErrorCode SNESConvergedDefault(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*);
317: PETSC_EXTERN PetscErrorCode SNESConvergedSkip(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*);
318: PETSC_EXTERN PetscErrorCode SNESGetConvergedReason(SNES,SNESConvergedReason*);
320: PETSC_DEPRECATED("Use SNESConvergedSkip()") PETSC_STATIC_INLINE void SNESSkipConverged(void) { /* never called */ }
321: #define SNESSkipConverged (SNESSkipConverged, SNESConvergedSkip)
323: /* --------- Solving systems of nonlinear equations --------------- */
324: PETSC_EXTERN PetscErrorCode SNESSetFunction(SNES,Vec,PetscErrorCode (*)(SNES,Vec,Vec,void*),void*);
325: PETSC_EXTERN PetscErrorCode SNESGetFunction(SNES,Vec*,PetscErrorCode (**)(SNES,Vec,Vec,void*),void**);
326: PETSC_EXTERN PetscErrorCode SNESComputeFunction(SNES,Vec,Vec);
328: PETSC_EXTERN PetscErrorCode SNESSetJacobian(SNES,Mat,Mat,PetscErrorCode (*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void*);
329: PETSC_EXTERN PetscErrorCode SNESGetJacobian(SNES,Mat*,Mat*,PetscErrorCode (**)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void**);
330: PETSC_EXTERN PetscErrorCode SNESObjectiveComputeFunctionDefaultFD(SNES,Vec,Vec,void*);
331: PETSC_EXTERN PetscErrorCode SNESComputeJacobianDefault(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
332: PETSC_EXTERN PetscErrorCode SNESComputeJacobianDefaultColor(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
333: PETSC_EXTERN PetscErrorCode SNESSetComputeInitialGuess(SNES,PetscErrorCode (*)(SNES,Vec,void*),void*);
334: PETSC_EXTERN PetscErrorCode SNESSetPicard(SNES,Vec,PetscErrorCode (*)(SNES,Vec,Vec,void*),Mat,Mat,PetscErrorCode (*SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void*);
335: PETSC_EXTERN PetscErrorCode SNESGetPicard(SNES,Vec*,PetscErrorCode (**)(SNES,Vec,Vec,void*),Mat*,Mat*,PetscErrorCode (**SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void**);
336: PETSC_EXTERN PetscErrorCode SNESSetInitialFunction(SNES,Vec);
338: PETSC_EXTERN PetscErrorCode SNESSetObjective(SNES,PetscErrorCode (*)(SNES,Vec,PetscReal *,void*),void*);
339: PETSC_EXTERN PetscErrorCode SNESGetObjective(SNES,PetscErrorCode (**)(SNES,Vec,PetscReal *,void*),void**);
340: PETSC_EXTERN PetscErrorCode SNESComputeObjective(SNES,Vec,PetscReal *);
342: /*E
343: SNESNormSchedule - Frequency with which the norm is computed
345: Level: advanced
347: Support for these is highly dependent on the solver.
349: Notes:
350: This is primarily used to turn off extra norm and function computation
351: when the solvers are composed.
353: .seealso: SNESSolve(), SNESGetConvergedReason(), KSPSetNormType(),
354: KSPSetConvergenceTest(), KSPSetPCSide()
355: E*/
357: typedef enum {SNES_NORM_DEFAULT = -1,
358: SNES_NORM_NONE = 0,
359: SNES_NORM_ALWAYS = 1,
360: SNES_NORM_INITIAL_ONLY = 2,
361: SNES_NORM_FINAL_ONLY = 3,
362: SNES_NORM_INITIAL_FINAL_ONLY = 4} SNESNormSchedule;
363: PETSC_EXTERN const char *const*const SNESNormSchedules;
364: /*MC
365: SNES_NORM_NONE - Don't compute function and its L2 norm.
367: Level: advanced
369: Notes:
370: This is most useful for stationary solvers with a fixed number of iterations used as smoothers.
372: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_DEFAULT
373: M*/
375: /*MC
376: SNES_NORM_ALWAYS - Compute the function and its L2 norm at each iteration.
378: Level: advanced
380: Notes:
381: Most solvers will use this no matter what norm type is passed to them.
383: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_NONE
384: M*/
386: /*MC
387: SNES_NORM_INITIAL_ONLY - Compute the function and its L2 at iteration 0, but do not update it.
389: Level: advanced
391: Notes:
392: This method is useful in composed methods, when a true solution might actually be found before SNESSolve() is called.
393: This option enables the solve to abort on the zeroth iteration if this is the case.
395: For solvers that require the computation of the L2 norm of the function as part of the method, this merely cancels
396: the norm computation at the last iteration (if possible).
398: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_FINAL_ONLY, SNES_NORM_INITIAL_FINAL_ONLY
399: M*/
401: /*MC
402: SNES_NORM_FINAL_ONLY - Compute the function and its L2 norm on only the final iteration.
404: Level: advanced
406: Notes:
407: For solvers that require the computation of the L2 norm of the function as part of the method, behaves
408: exactly as SNES_NORM_DEFAULT. This method is useful when the function is gotten after SNESSolve and
409: used in subsequent computation for methods that do not need the norm computed during the rest of the
410: solution procedure.
412: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_INITIAL_ONLY, SNES_NORM_INITIAL_FINAL_ONLY
413: M*/
415: /*MC
416: SNES_NORM_INITIAL_FINAL_ONLY - Compute the function and its L2 norm on only the initial and final iterations.
418: Level: advanced
420: Notes:
421: This method combines the benefits of SNES_NORM_INITIAL_ONLY and SNES_NORM_FINAL_ONLY.
423: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_SNES_NORM_INITIAL_ONLY, SNES_NORM_FINAL_ONLY
424: M*/
427: PETSC_EXTERN PetscErrorCode SNESSetNormSchedule(SNES,SNESNormSchedule);
428: PETSC_EXTERN PetscErrorCode SNESGetNormSchedule(SNES,SNESNormSchedule*);
430: /*E
431: SNESFunctionType - Type of function computed
433: Level: advanced
435: Support for these is highly dependent on the solver.
437: .seealso: SNESSolve(), SNESGetConvergedReason(), KSPSetNormType(),
438: KSPSetConvergenceTest(), KSPSetPCSide()
439: E*/
440: typedef enum {SNES_FUNCTION_DEFAULT = -1,
441: SNES_FUNCTION_UNPRECONDITIONED = 0,
442: SNES_FUNCTION_PRECONDITIONED = 1} SNESFunctionType;
443: PETSC_EXTERN const char *const*const SNESFunctionTypes;
445: PETSC_EXTERN PetscErrorCode SNESSetFunctionType(SNES,SNESFunctionType);
446: PETSC_EXTERN PetscErrorCode SNESGetFunctionType(SNES,SNESFunctionType*);
448: PETSC_EXTERN PetscErrorCode SNESSetGS(SNES,PetscErrorCode (*SNESGSFunction)(SNES,Vec,Vec,void*),void*);
449: PETSC_EXTERN PetscErrorCode SNESGetGS(SNES,PetscErrorCode (**SNESGSFunction)(SNES,Vec,Vec,void*),void**);
450: PETSC_EXTERN PetscErrorCode SNESSetUseGS(SNES,PetscBool);
451: PETSC_EXTERN PetscErrorCode SNESGetUseGS(SNES,PetscBool *);
452: PETSC_EXTERN PetscErrorCode SNESComputeGS(SNES,Vec,Vec);
454: PETSC_EXTERN PetscErrorCode SNESGSSetSweeps(SNES,PetscInt);
455: PETSC_EXTERN PetscErrorCode SNESGSGetSweeps(SNES,PetscInt *);
456: PETSC_EXTERN PetscErrorCode SNESGSSetTolerances(SNES,PetscReal,PetscReal,PetscReal,PetscInt);
457: PETSC_EXTERN PetscErrorCode SNESGSGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,PetscInt*);
459: PETSC_EXTERN PetscErrorCode SNESUpdateCheckJacobian(SNES,PetscInt);
461: PETSC_EXTERN PetscErrorCode SNESShellGetContext(SNES,void**);
462: PETSC_EXTERN PetscErrorCode SNESShellSetContext(SNES,void*);
463: PETSC_EXTERN PetscErrorCode SNESShellSetSolve(SNES,PetscErrorCode (*)(SNES,Vec));
465: /* --------- Routines specifically for line search methods --------------- */
467: typedef struct _p_LineSearch* SNESLineSearch;
469: /*S
470: SNESLineSearch - Abstract PETSc object that manages line-search operations
472: Level: beginner
474: Concepts: nonlinear solvers, line search
476: .seealso: SNESLineSearchCreate(), SNESLineSearchSetType(), SNES
477: S*/
479: /*J
480: SNESLineSearchType - String with the name of a PETSc line search method
482: Level: beginner
484: .seealso: SNESLineSearchSetType(), SNES
485: J*/
487: typedef const char* SNESLineSearchType;
488: #define SNESLINESEARCHBT "bt"
489: #define SNESLINESEARCHBASIC "basic"
490: #define SNESLINESEARCHL2 "l2"
491: #define SNESLINESEARCHCP "cp"
492: #define SNESLINESEARCHSHELL "shell"
494: PETSC_EXTERN PetscBool SNESRegisterAllCalled;
495: PETSC_EXTERN PetscFunctionList SNESList;
496: PETSC_EXTERN PetscClassId SNESLINESEARCH_CLASSID;
497: PETSC_EXTERN PetscBool SNESLineSearchRegisterAllCalled;
498: PETSC_EXTERN PetscFunctionList SNESLineSearchList;
499: PETSC_EXTERN PetscLogEvent SNESLineSearch_Apply;
501: #define SNES_LINESEARCH_ORDER_LINEAR 1
502: #define SNES_LINESEARCH_ORDER_QUADRATIC 2
503: #define SNES_LINESEARCH_ORDER_CUBIC 3
505: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchVIProjectFunc)(SNES,Vec);
506: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchVINormFunc)(SNES,Vec,Vec,PetscReal *);
507: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchApplyFunc)(SNESLineSearch);
508: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchUserFunc)(SNESLineSearch, void *);
510: PETSC_EXTERN PetscErrorCode SNESLineSearchCreate(MPI_Comm, SNESLineSearch*);
511: PETSC_EXTERN PetscErrorCode SNESLineSearchReset(SNESLineSearch);
512: PETSC_EXTERN PetscErrorCode SNESLineSearchView(SNESLineSearch,PetscViewer);
513: PETSC_EXTERN PetscErrorCode SNESLineSearchDestroy(SNESLineSearch *);
514: PETSC_EXTERN PetscErrorCode SNESLineSearchSetType(SNESLineSearch, SNESLineSearchType);
515: PETSC_EXTERN PetscErrorCode SNESLineSearchSetFromOptions(SNESLineSearch);
516: PETSC_EXTERN PetscErrorCode SNESLineSearchSetFunction(SNESLineSearch,PetscErrorCode (*)(SNES,Vec,Vec));
517: PETSC_EXTERN PetscErrorCode SNESLineSearchSetUp(SNESLineSearch);
518: PETSC_EXTERN PetscErrorCode SNESLineSearchApply(SNESLineSearch, Vec, Vec, PetscReal *, Vec);
519: PETSC_EXTERN PetscErrorCode SNESLineSearchPreCheck(SNESLineSearch,Vec,Vec,PetscBool *);
520: PETSC_EXTERN PetscErrorCode SNESLineSearchPostCheck(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *);
521: PETSC_EXTERN PetscErrorCode SNESLineSearchSetWorkVecs(SNESLineSearch, PetscInt);
523: /* set the functions for precheck and postcheck */
525: PETSC_EXTERN PetscErrorCode SNESLineSearchSetPreCheck(SNESLineSearch, PetscErrorCode (*SNESLineSearchPreCheckFunction)(SNESLineSearch,Vec,Vec,PetscBool*,void*), void *ctx);
526: PETSC_EXTERN PetscErrorCode SNESLineSearchSetPostCheck(SNESLineSearch, PetscErrorCode (*SNESLineSearchPostCheckFunction)(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *,void*), void *ctx);
528: PETSC_EXTERN PetscErrorCode SNESLineSearchGetPreCheck(SNESLineSearch, PetscErrorCode (**SNESLineSearchPreCheckFunction)(SNESLineSearch,Vec,Vec,PetscBool*,void*), void **ctx);
529: PETSC_EXTERN PetscErrorCode SNESLineSearchGetPostCheck(SNESLineSearch, PetscErrorCode (**SNESLineSearchPostCheckFunction)(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *,void*), void **ctx);
531: /* set the functions for VI-specific line search operations */
533: PETSC_EXTERN PetscErrorCode SNESLineSearchSetVIFunctions(SNESLineSearch, SNESLineSearchVIProjectFunc, SNESLineSearchVINormFunc);
534: PETSC_EXTERN PetscErrorCode SNESLineSearchGetVIFunctions(SNESLineSearch, SNESLineSearchVIProjectFunc*, SNESLineSearchVINormFunc*);
536: /* pointers to the associated SNES in order to be able to get the function evaluation out */
537: PETSC_EXTERN PetscErrorCode SNESLineSearchSetSNES(SNESLineSearch,SNES);
538: PETSC_EXTERN PetscErrorCode SNESLineSearchGetSNES(SNESLineSearch,SNES*);
540: /* set and get the parameters and vectors */
541: PETSC_EXTERN PetscErrorCode SNESLineSearchGetTolerances(SNESLineSearch,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscInt*);
542: PETSC_EXTERN PetscErrorCode SNESLineSearchSetTolerances(SNESLineSearch,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscInt);
544: PETSC_EXTERN PetscErrorCode SNESLineSearchPreCheckPicard(SNESLineSearch,Vec,Vec,PetscBool*,void*);
546: PETSC_EXTERN PetscErrorCode SNESLineSearchGetLambda(SNESLineSearch,PetscReal*);
547: PETSC_EXTERN PetscErrorCode SNESLineSearchSetLambda(SNESLineSearch,PetscReal);
549: PETSC_EXTERN PetscErrorCode SNESLineSearchGetDamping(SNESLineSearch,PetscReal*);
550: PETSC_EXTERN PetscErrorCode SNESLineSearchSetDamping(SNESLineSearch,PetscReal);
552: PETSC_EXTERN PetscErrorCode SNESLineSearchGetOrder(SNESLineSearch,PetscInt *order);
553: PETSC_EXTERN PetscErrorCode SNESLineSearchSetOrder(SNESLineSearch,PetscInt order);
555: PETSC_EXTERN PetscErrorCode SNESLineSearchGetSuccess(SNESLineSearch, PetscBool*);
556: PETSC_EXTERN PetscErrorCode SNESLineSearchSetSuccess(SNESLineSearch, PetscBool);
558: PETSC_EXTERN PetscErrorCode SNESLineSearchGetVecs(SNESLineSearch,Vec*,Vec*,Vec*,Vec*,Vec*);
559: PETSC_EXTERN PetscErrorCode SNESLineSearchSetVecs(SNESLineSearch,Vec,Vec,Vec,Vec,Vec);
561: PETSC_EXTERN PetscErrorCode SNESLineSearchGetNorms(SNESLineSearch, PetscReal *, PetscReal *, PetscReal *);
562: PETSC_EXTERN PetscErrorCode SNESLineSearchSetNorms(SNESLineSearch, PetscReal, PetscReal, PetscReal);
563: PETSC_EXTERN PetscErrorCode SNESLineSearchComputeNorms(SNESLineSearch);
564: PETSC_EXTERN PetscErrorCode SNESLineSearchSetComputeNorms(SNESLineSearch, PetscBool);
566: PETSC_EXTERN PetscErrorCode SNESLineSearchSetMonitor(SNESLineSearch, PetscBool);
567: PETSC_EXTERN PetscErrorCode SNESLineSearchGetMonitor(SNESLineSearch, PetscViewer*);
569: PETSC_EXTERN PetscErrorCode SNESLineSearchAppendOptionsPrefix(SNESLineSearch, const char prefix[]);
570: PETSC_EXTERN PetscErrorCode SNESLineSearchGetOptionsPrefix(SNESLineSearch, const char *prefix[]);
573: /* Shell interface functions */
574: PETSC_EXTERN PetscErrorCode SNESLineSearchShellSetUserFunc(SNESLineSearch,SNESLineSearchUserFunc,void*);
575: PETSC_EXTERN PetscErrorCode SNESLineSearchShellGetUserFunc(SNESLineSearch,SNESLineSearchUserFunc*,void**);
577: /* BT interface functions */
578: PETSC_EXTERN PetscErrorCode SNESLineSearchBTSetAlpha(SNESLineSearch, PetscReal);
579: PETSC_EXTERN PetscErrorCode SNESLineSearchBTGetAlpha(SNESLineSearch, PetscReal*);
581: /*register line search types */
582: PETSC_EXTERN PetscErrorCode SNESLineSearchRegister(const char[],PetscErrorCode(*)(SNESLineSearch));
583: PETSC_EXTERN PetscErrorCode SNESLineSearchRegisterAll(void);
585: /* Routines for VI solver */
586: PETSC_EXTERN PetscErrorCode SNESVISetVariableBounds(SNES,Vec,Vec);
587: PETSC_EXTERN PetscErrorCode SNESVISetComputeVariableBounds(SNES, PetscErrorCode (*)(SNES,Vec,Vec));
588: PETSC_EXTERN PetscErrorCode SNESVIGetInactiveSet(SNES,IS*);
589: PETSC_EXTERN PetscErrorCode SNESVIGetActiveSetIS(SNES,Vec,Vec,IS*);
590: PETSC_EXTERN PetscErrorCode SNESVIComputeInactiveSetFnorm(SNES,Vec,Vec,PetscReal*);
591: PETSC_EXTERN PetscErrorCode SNESVISetRedundancyCheck(SNES,PetscErrorCode(*)(SNES,IS,IS*,void*),void*);
593: PETSC_EXTERN PetscErrorCode SNESTestLocalMin(SNES);
595: /* Should this routine be private? */
596: PETSC_EXTERN PetscErrorCode SNESComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*);
598: PETSC_EXTERN PetscErrorCode SNESSetDM(SNES,DM);
599: PETSC_EXTERN PetscErrorCode SNESGetDM(SNES,DM*);
600: PETSC_EXTERN PetscErrorCode SNESSetPC(SNES,SNES);
601: PETSC_EXTERN PetscErrorCode SNESGetPC(SNES,SNES*);
602: PETSC_EXTERN PetscErrorCode SNESApplyPC(SNES,Vec,Vec,PetscReal*,Vec);
603: PETSC_EXTERN PetscErrorCode SNESGetPCFunction(SNES,Vec,PetscReal*);
604: PETSC_EXTERN PetscErrorCode SNESComputeFunctionDefaultPC(SNES,Vec,Vec);
605: PETSC_EXTERN PetscErrorCode SNESSetPCSide(SNES,PCSide);
606: PETSC_EXTERN PetscErrorCode SNESGetPCSide(SNES,PCSide*);
607: PETSC_EXTERN PetscErrorCode SNESSetLineSearch(SNES,SNESLineSearch);
608: PETSC_EXTERN PetscErrorCode SNESGetLineSearch(SNES,SNESLineSearch*);
609: PETSC_EXTERN PetscErrorCode SNESRestrictHookAdd(SNES,PetscErrorCode (*)(SNES,SNES,void*),void*);
610: PETSC_EXTERN PetscErrorCode SNESRestrictHooksRun(SNES,SNES);
612: PETSC_DEPRECATED("Use SNESGetLineSearch()") PETSC_STATIC_INLINE PetscErrorCode SNESGetSNESLineSearch(SNES snes,SNESLineSearch *ls) {return SNESGetLineSearch(snes,ls);}
613: PETSC_DEPRECATED("Use SNESSetLineSearch()") PETSC_STATIC_INLINE PetscErrorCode SNESSetSNESLineSearch(SNES snes,SNESLineSearch ls) {return SNESSetLineSearch(snes,ls);}
615: PETSC_EXTERN PetscErrorCode SNESSetUpMatrices(SNES);
616: PETSC_EXTERN PetscErrorCode DMSNESSetFunction(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),void*);
617: PETSC_EXTERN PetscErrorCode DMSNESGetFunction(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),void**);
618: PETSC_EXTERN PetscErrorCode DMSNESSetGS(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),void*);
619: PETSC_EXTERN PetscErrorCode DMSNESGetGS(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),void**);
620: PETSC_EXTERN PetscErrorCode DMSNESSetJacobian(DM,PetscErrorCode(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void*);
621: PETSC_EXTERN PetscErrorCode DMSNESGetJacobian(DM,PetscErrorCode(**)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void**);
622: PETSC_EXTERN PetscErrorCode DMSNESSetPicard(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),PetscErrorCode(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void*);
623: PETSC_EXTERN PetscErrorCode DMSNESGetPicard(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),PetscErrorCode(**)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void**);
624: PETSC_EXTERN PetscErrorCode DMSNESSetObjective(DM,PetscErrorCode (*)(SNES,Vec,PetscReal *,void*),void*);
625: PETSC_EXTERN PetscErrorCode DMSNESGetObjective(DM,PetscErrorCode (**)(SNES,Vec,PetscReal *,void*),void**);
627: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESFunction)(DMDALocalInfo*,void*,void*,void*);
628: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESJacobian)(DMDALocalInfo*,void*,Mat,Mat,MatStructure*,void*);
629: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESObjective)(DMDALocalInfo*,void*,PetscReal*,void*);
631: PETSC_EXTERN PetscErrorCode DMDASNESSetFunctionLocal(DM,InsertMode,DMDASNESFunction,void*);
632: PETSC_EXTERN PetscErrorCode DMDASNESSetJacobianLocal(DM,DMDASNESJacobian,void*);
633: PETSC_EXTERN PetscErrorCode DMDASNESSetObjectiveLocal(DM,DMDASNESObjective,void*);
634: PETSC_EXTERN PetscErrorCode DMDASNESSetPicardLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,void*,void*,void*),PetscErrorCode (*)(DMDALocalInfo*,void*,Mat,Mat,MatStructure*,void*),void*);
636: PETSC_EXTERN PetscErrorCode DMSNESSetFunctionLocal(DM,PetscErrorCode (*)(DM,Vec,Vec,void*),void*);
637: PETSC_EXTERN PetscErrorCode DMSNESSetJacobianLocal(DM,PetscErrorCode (*)(DM,Vec,Mat,Mat,MatStructure*,void*),void*);
639: /* Routines for Multiblock solver */
640: PETSC_EXTERN PetscErrorCode SNESMultiblockSetFields(SNES, const char [], PetscInt, const PetscInt *);
641: PETSC_EXTERN PetscErrorCode SNESMultiblockSetIS(SNES, const char [], IS);
642: PETSC_EXTERN PetscErrorCode SNESMultiblockSetBlockSize(SNES, PetscInt);
643: PETSC_EXTERN PetscErrorCode SNESMultiblockSetType(SNES, PCCompositeType);
645: /*J
646: SNESMSType - String with the name of a PETSc SNESMS method.
648: Level: intermediate
650: .seealso: SNESMSSetType(), SNES
651: J*/
652: typedef const char* SNESMSType;
653: #define SNESMSM62 "m62"
654: #define SNESMSEULER "euler"
655: #define SNESMSJAMESON83 "jameson83"
656: #define SNESMSVLTP21 "vltp21"
657: #define SNESMSVLTP31 "vltp31"
658: #define SNESMSVLTP41 "vltp41"
659: #define SNESMSVLTP51 "vltp51"
660: #define SNESMSVLTP61 "vltp61"
662: PETSC_EXTERN PetscErrorCode SNESMSRegister(SNESMSType,PetscInt,PetscInt,PetscReal,const PetscReal[],const PetscReal[],const PetscReal[]);
663: PETSC_EXTERN PetscErrorCode SNESMSSetType(SNES,SNESMSType);
664: PETSC_EXTERN PetscErrorCode SNESMSFinalizePackage(void);
665: PETSC_EXTERN PetscErrorCode SNESMSInitializePackage(void);
666: PETSC_EXTERN PetscErrorCode SNESMSRegisterDestroy(void);
667: PETSC_EXTERN PetscErrorCode SNESMSRegisterAll(void);
669: /* routines for NGMRES solver */
671: typedef enum {
672: SNES_NGMRES_RESTART_NONE = 0,
673: SNES_NGMRES_RESTART_PERIODIC = 1,
674: SNES_NGMRES_RESTART_DIFFERENCE = 2} SNESNGMRESRestartType;
675: PETSC_EXTERN const char *const SNESNGMRESRestartTypes[];
677: typedef enum {
678: SNES_NGMRES_SELECT_NONE = 0,
679: SNES_NGMRES_SELECT_DIFFERENCE = 1,
680: SNES_NGMRES_SELECT_LINESEARCH = 2} SNESNGMRESSelectType;
681: PETSC_EXTERN const char *const SNESNGMRESSelectTypes[];
683: PETSC_EXTERN PetscErrorCode SNESNGMRESSetRestartType(SNES, SNESNGMRESRestartType);
684: PETSC_EXTERN PetscErrorCode SNESNGMRESSetSelectType(SNES, SNESNGMRESSelectType);
686: /* routines for NCG solver */
688: typedef enum {
689: SNES_NCG_FR = 0,
690: SNES_NCG_PRP = 1,
691: SNES_NCG_HS = 2,
692: SNES_NCG_DY = 3,
693: SNES_NCG_CD = 4} SNESNCGType;
694: PETSC_EXTERN const char *const SNESNCGTypes[];
696: PETSC_EXTERN PetscErrorCode SNESNCGSetType(SNES, SNESNCGType);
698: typedef enum {SNES_QN_SCALE_DEFAULT = 0,
699: SNES_QN_SCALE_NONE = 1,
700: SNES_QN_SCALE_SHANNO = 2,
701: SNES_QN_SCALE_LINESEARCH = 3,
702: SNES_QN_SCALE_JACOBIAN = 4} SNESQNScaleType;
703: PETSC_EXTERN const char *const SNESQNScaleTypes[];
704: typedef enum {SNES_QN_RESTART_DEFAULT = 0,
705: SNES_QN_RESTART_NONE = 1,
706: SNES_QN_RESTART_POWELL = 2,
707: SNES_QN_RESTART_PERIODIC = 3} SNESQNRestartType;
708: PETSC_EXTERN const char *const SNESQNRestartTypes[];
709: typedef enum {SNES_QN_LBFGS = 0,
710: SNES_QN_BROYDEN = 1,
711: SNES_QN_BADBROYDEN = 2
712: } SNESQNType;
713: PETSC_EXTERN const char *const SNESQNTypes[];
715: PETSC_EXTERN PetscErrorCode SNESQNSetType(SNES, SNESQNType);
716: PETSC_EXTERN PetscErrorCode SNESQNSetScaleType(SNES, SNESQNScaleType);
717: PETSC_EXTERN PetscErrorCode SNESQNSetRestartType(SNES, SNESQNRestartType);
719: PETSC_EXTERN PetscErrorCode SNESNASMGetSubdomains(SNES,PetscInt*,SNES**,VecScatter**,VecScatter**,VecScatter**);
720: PETSC_EXTERN PetscErrorCode SNESNASMSetSubdomains(SNES,PetscInt,SNES*,VecScatter*,VecScatter*,VecScatter*);
721: PETSC_EXTERN PetscErrorCode SNESNASMSetDamping(SNES,PetscReal);
722: PETSC_EXTERN PetscErrorCode SNESNASMGetDamping(SNES,PetscReal*);
723: PETSC_EXTERN PetscErrorCode SNESNASMGetSubdomainVecs(SNES,PetscInt*,Vec**,Vec**,Vec**,Vec**);
724: PETSC_EXTERN PetscErrorCode SNESNASMSetComputeFinalJacobian(SNES,PetscBool);
726: typedef enum {SNES_COMPOSITE_ADDITIVE,SNES_COMPOSITE_MULTIPLICATIVE,SNES_COMPOSITE_ADDITIVEOPTIMAL} SNESCompositeType;
727: PETSC_EXTERN const char *const SNESCompositeTypes[];
729: PETSC_EXTERN PetscErrorCode SNESCompositeSetType(SNES,SNESCompositeType);
730: PETSC_EXTERN PetscErrorCode SNESCompositeAddSNES(SNES,SNESType);
731: PETSC_EXTERN PetscErrorCode SNESCompositeGetSNES(SNES,PetscInt,SNES *);
732: PETSC_EXTERN PetscErrorCode SNESCompositeSetDamping(SNES,PetscInt,PetscReal);
734: #endif