Actual source code: petscsnes.h
petsc-3.3-p7 2013-05-11
1: /*
2: User interface for the nonlinear solvers package.
3: */
6: #include petscksp.h
7: #include petscdmda.h
9: /*S
10: SNES - Abstract PETSc object that manages all nonlinear solves
12: Level: beginner
14: Concepts: nonlinear solvers
16: .seealso: SNESCreate(), SNESSetType(), SNESType, TS, KSP, KSP, PC
17: S*/
18: typedef struct _p_SNES* SNES;
20: /*J
21: SNESType - String with the name of a PETSc SNES method or the creation function
22: with an optional dynamic library name, for example
23: http://www.mcs.anl.gov/petsc/lib.a:mysnescreate()
25: Level: beginner
27: .seealso: SNESSetType(), SNES
28: J*/
29: #define SNESType char*
30: #define SNESLS "ls"
31: #define SNESTR "tr"
32: #define SNESPYTHON "python"
33: #define SNESTEST "test"
34: #define SNESNRICHARDSON "nrichardson"
35: #define SNESKSPONLY "ksponly"
36: #define SNESVIRS "virs"
37: #define SNESVISS "viss"
38: #define SNESNGMRES "ngmres"
39: #define SNESQN "qn"
40: #define SNESSHELL "shell"
41: #define SNESGS "gs"
42: #define SNESNCG "ncg"
43: #define SNESFAS "fas"
44: #define SNESMS "ms"
46: /* Logging support */
47: PETSC_EXTERN PetscClassId SNES_CLASSID;
49: PETSC_EXTERN PetscErrorCode SNESInitializePackage(const char[]);
51: PETSC_EXTERN PetscErrorCode SNESCreate(MPI_Comm,SNES*);
52: PETSC_EXTERN PetscErrorCode SNESReset(SNES);
53: PETSC_EXTERN PetscErrorCode SNESDestroy(SNES*);
54: PETSC_EXTERN PetscErrorCode SNESSetType(SNES,const SNESType);
55: PETSC_EXTERN PetscErrorCode SNESMonitor(SNES,PetscInt,PetscReal);
56: PETSC_EXTERN PetscErrorCode SNESMonitorSet(SNES,PetscErrorCode(*)(SNES,PetscInt,PetscReal,void*),void *,PetscErrorCode (*)(void**));
57: PETSC_EXTERN PetscErrorCode SNESMonitorCancel(SNES);
58: PETSC_EXTERN PetscErrorCode SNESSetConvergenceHistory(SNES,PetscReal[],PetscInt[],PetscInt,PetscBool );
59: PETSC_EXTERN PetscErrorCode SNESGetConvergenceHistory(SNES,PetscReal*[],PetscInt *[],PetscInt *);
60: PETSC_EXTERN PetscErrorCode SNESSetUp(SNES);
61: PETSC_EXTERN PetscErrorCode SNESSolve(SNES,Vec,Vec);
62: PETSC_EXTERN PetscErrorCode SNESSetErrorIfNotConverged(SNES,PetscBool );
63: PETSC_EXTERN PetscErrorCode SNESGetErrorIfNotConverged(SNES,PetscBool *);
66: PETSC_EXTERN PetscErrorCode SNESAddOptionsChecker(PetscErrorCode (*)(SNES));
68: PETSC_EXTERN PetscErrorCode SNESSetUpdate(SNES, PetscErrorCode (*)(SNES, PetscInt));
69: PETSC_EXTERN PetscErrorCode SNESDefaultUpdate(SNES, PetscInt);
71: PETSC_EXTERN PetscFList SNESList;
72: PETSC_EXTERN PetscErrorCode SNESRegisterDestroy(void);
73: PETSC_EXTERN PetscErrorCode SNESRegisterAll(const char[]);
75: PETSC_EXTERN PetscErrorCode SNESRegister(const char[],const char[],const char[],PetscErrorCode (*)(SNES));
77: /*MC
78: SNESRegisterDynamic - Adds a method to the nonlinear solver package.
80: Synopsis:
81: PetscErrorCode SNESRegisterDynamic(const char *name_solver,const char *path,const char *name_create,PetscErrorCode (*routine_create)(SNES))
83: Not collective
85: Input Parameters:
86: + name_solver - name of a new user-defined solver
87: . path - path (either absolute or relative) the library containing this solver
88: . name_create - name of routine to create method context
89: - routine_create - routine to create method context
91: Notes:
92: SNESRegisterDynamic() may be called multiple times to add several user-defined solvers.
94: If dynamic libraries are used, then the fourth input argument (routine_create)
95: is ignored.
97: Environmental variables such as ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR},
98: and others of the form ${any_environmental_variable} occuring in pathname will be
99: replaced with appropriate values.
101: Sample usage:
102: .vb
103: SNESRegisterDynamic("my_solver",/home/username/my_lib/lib/libg/solaris/mylib.a,
104: "MySolverCreate",MySolverCreate);
105: .ve
107: Then, your solver can be chosen with the procedural interface via
108: $ SNESSetType(snes,"my_solver")
109: or at runtime via the option
110: $ -snes_type my_solver
112: Level: advanced
114: Note: If your function is not being put into a shared library then use SNESRegister() instead
116: .keywords: SNES, nonlinear, register
118: .seealso: SNESRegisterAll(), SNESRegisterDestroy()
119: M*/
120: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
121: #define SNESRegisterDynamic(a,b,c,d) SNESRegister(a,b,c,0)
122: #else
123: #define SNESRegisterDynamic(a,b,c,d) SNESRegister(a,b,c,d)
124: #endif
126: PETSC_EXTERN PetscErrorCode SNESGetKSP(SNES,KSP*);
127: PETSC_EXTERN PetscErrorCode SNESSetKSP(SNES,KSP);
128: PETSC_EXTERN PetscErrorCode SNESGetSolution(SNES,Vec*);
129: PETSC_EXTERN PetscErrorCode SNESGetSolutionUpdate(SNES,Vec*);
130: PETSC_EXTERN PetscErrorCode SNESGetRhs(SNES,Vec*);
131: PETSC_EXTERN PetscErrorCode SNESView(SNES,PetscViewer);
133: PETSC_EXTERN PetscErrorCode SNESSetOptionsPrefix(SNES,const char[]);
134: PETSC_EXTERN PetscErrorCode SNESAppendOptionsPrefix(SNES,const char[]);
135: PETSC_EXTERN PetscErrorCode SNESGetOptionsPrefix(SNES,const char*[]);
136: PETSC_EXTERN PetscErrorCode SNESSetFromOptions(SNES);
137: PETSC_EXTERN PetscErrorCode SNESDefaultGetWork(SNES,PetscInt);
139: PETSC_EXTERN PetscErrorCode MatCreateSNESMF(SNES,Mat*);
140: PETSC_EXTERN PetscErrorCode MatMFFDComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
142: PETSC_EXTERN PetscErrorCode MatDAADSetSNES(Mat,SNES);
144: PETSC_EXTERN PetscErrorCode SNESGetType(SNES,const SNESType*);
145: PETSC_EXTERN PetscErrorCode SNESMonitorDefault(SNES,PetscInt,PetscReal,void *);
146: PETSC_EXTERN PetscErrorCode SNESMonitorRange(SNES,PetscInt,PetscReal,void *);
147: PETSC_EXTERN PetscErrorCode SNESMonitorRatio(SNES,PetscInt,PetscReal,void *);
148: PETSC_EXTERN PetscErrorCode SNESMonitorSetRatio(SNES,PetscViewer);
149: PETSC_EXTERN PetscErrorCode SNESMonitorSolution(SNES,PetscInt,PetscReal,void *);
150: PETSC_EXTERN PetscErrorCode SNESMonitorResidual(SNES,PetscInt,PetscReal,void *);
151: PETSC_EXTERN PetscErrorCode SNESMonitorSolutionUpdate(SNES,PetscInt,PetscReal,void *);
152: PETSC_EXTERN PetscErrorCode SNESMonitorDefaultShort(SNES,PetscInt,PetscReal,void *);
153: PETSC_EXTERN PetscErrorCode SNESSetTolerances(SNES,PetscReal,PetscReal,PetscReal,PetscInt,PetscInt);
154: PETSC_EXTERN PetscErrorCode SNESGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,PetscInt*,PetscInt*);
155: PETSC_EXTERN PetscErrorCode SNESSetTrustRegionTolerance(SNES,PetscReal);
156: PETSC_EXTERN PetscErrorCode SNESGetFunctionNorm(SNES,PetscReal*);
157: PETSC_EXTERN PetscErrorCode SNESSetFunctionNorm(SNES,PetscReal);
158: PETSC_EXTERN PetscErrorCode SNESGetIterationNumber(SNES,PetscInt*);
159: PETSC_EXTERN PetscErrorCode SNESSetIterationNumber(SNES,PetscInt);
161: PETSC_EXTERN PetscErrorCode SNESGetNonlinearStepFailures(SNES,PetscInt*);
162: PETSC_EXTERN PetscErrorCode SNESSetMaxNonlinearStepFailures(SNES,PetscInt);
163: PETSC_EXTERN PetscErrorCode SNESGetMaxNonlinearStepFailures(SNES,PetscInt*);
164: PETSC_EXTERN PetscErrorCode SNESGetNumberFunctionEvals(SNES,PetscInt*);
166: PETSC_EXTERN PetscErrorCode SNESSetLagPreconditioner(SNES,PetscInt);
167: PETSC_EXTERN PetscErrorCode SNESGetLagPreconditioner(SNES,PetscInt*);
168: PETSC_EXTERN PetscErrorCode SNESSetLagJacobian(SNES,PetscInt);
169: PETSC_EXTERN PetscErrorCode SNESGetLagJacobian(SNES,PetscInt*);
170: PETSC_EXTERN PetscErrorCode SNESSetGridSequence(SNES,PetscInt);
172: PETSC_EXTERN PetscErrorCode SNESGetLinearSolveIterations(SNES,PetscInt*);
173: PETSC_EXTERN PetscErrorCode SNESGetLinearSolveFailures(SNES,PetscInt*);
174: PETSC_EXTERN PetscErrorCode SNESSetMaxLinearSolveFailures(SNES,PetscInt);
175: PETSC_EXTERN PetscErrorCode SNESGetMaxLinearSolveFailures(SNES,PetscInt*);
177: PETSC_EXTERN PetscErrorCode SNESKSPSetUseEW(SNES,PetscBool );
178: PETSC_EXTERN PetscErrorCode SNESKSPGetUseEW(SNES,PetscBool *);
179: PETSC_EXTERN PetscErrorCode SNESKSPSetParametersEW(SNES,PetscInt,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal);
180: PETSC_EXTERN PetscErrorCode SNESKSPGetParametersEW(SNES,PetscInt*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*);
182: PETSC_EXTERN PetscErrorCode SNESMonitorLGCreate(const char[],const char[],int,int,int,int,PetscDrawLG*);
183: PETSC_EXTERN PetscErrorCode SNESMonitorLG(SNES,PetscInt,PetscReal,void*);
184: PETSC_EXTERN PetscErrorCode SNESMonitorLGDestroy(PetscDrawLG*);
185: PETSC_EXTERN PetscErrorCode SNESMonitorLGRangeCreate(const char[],const char[],int,int,int,int,PetscDrawLG*);
186: PETSC_EXTERN PetscErrorCode SNESMonitorLGRange(SNES,PetscInt,PetscReal,void*);
187: PETSC_EXTERN PetscErrorCode SNESMonitorLGRangeDestroy(PetscDrawLG*);
189: PETSC_EXTERN PetscErrorCode SNESSetApplicationContext(SNES,void *);
190: PETSC_EXTERN PetscErrorCode SNESGetApplicationContext(SNES,void *);
191: PETSC_EXTERN PetscErrorCode SNESSetComputeApplicationContext(SNES,PetscErrorCode (*)(SNES,void**),PetscErrorCode (*)(void**));
193: PETSC_EXTERN PetscErrorCode SNESPythonSetType(SNES,const char[]);
195: PETSC_EXTERN PetscErrorCode SNESSetFunctionDomainError(SNES);
196: PETSC_EXTERN PetscErrorCode SNESGetFunctionDomainError(SNES, PetscBool *);
198: /*E
199: SNESConvergedReason - reason a SNES method was said to
200: have converged or diverged
202: Level: beginner
204: The two most common reasons for divergence are
205: $ 1) an incorrectly coded or computed Jacobian or
206: $ 2) failure or lack of convergence in the linear system (in this case we recommend
207: $ testing with -pc_type lu to eliminate the linear solver as the cause of the problem).
209: Diverged Reasons:
210: . SNES_DIVERGED_LOCAL_MIN - this can only occur when using the line-search variant of SNES.
211: The line search wants to minimize Q(alpha) = 1/2 || F(x + alpha s) ||^2_2 this occurs
212: 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
213: you get Q'(alpha) = -F(x)^T F'(x)^(-1)^T F'(x+alpha s)F(x+alpha s); when alpha = 0
214: Q'(0) = - ||F(x)||^2_2 which is always NEGATIVE if F'(x) is invertible. This means the Newton
215: direction is a descent direction and the line search should succeed if alpha is small enough.
217: If F'(x) is NOT invertible AND F'(x)^T F(x) = 0 then Q'(0) = 0 and the Newton direction
218: is NOT a descent direction so the line search will fail. All one can do at this point
219: is change the initial guess and try again.
221: An alternative explanation: Newton's method can be regarded as replacing the function with
222: its linear approximation and minimizing the 2-norm of that. That is F(x+s) approx F(x) + F'(x)s
223: so we minimize || F(x) + F'(x) s ||^2_2; do this using Least Squares. If F'(x) is invertible then
224: 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
225: exists a nontrival (that is F'(x)s != 0) solution to the equation and this direction is
226: 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)
227: = - (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
228: and F'(x)^T F'(x) has no negative eigenvalues Q'(0) < 0 so s is a descent direction and the line
229: search should succeed for small enough alpha.
231: Note that this RARELY happens in practice. Far more likely the linear system is not being solved
232: (well enough?) or the Jacobian is wrong.
233:
234: SNES_DIVERGED_MAX_IT means that the solver reached the maximum number of iterations without satisfying any
235: convergence criteria. SNES_CONVERGED_ITS means that SNESSkipConverged() was chosen as the convergence test;
236: thus the usual convergence criteria have not been checked and may or may not be satisfied.
238: Developer Notes: this must match finclude/petscsnes.h
240: The string versions of these are in SNESConvergedReason, if you change any value here you must
241: also adjust that array.
243: Each reason has its own manual page.
245: .seealso: SNESSolve(), SNESGetConvergedReason(), KSPConvergedReason, SNESSetConvergenceTest()
246: E*/
247: typedef enum {/* converged */
248: SNES_CONVERGED_FNORM_ABS = 2, /* ||F|| < atol */
249: SNES_CONVERGED_FNORM_RELATIVE = 3, /* ||F|| < rtol*||F_initial|| */
250: SNES_CONVERGED_SNORM_RELATIVE = 4, /* Newton computed step size small; || delta x || < stol */
251: SNES_CONVERGED_ITS = 5, /* maximum iterations reached */
252: SNES_CONVERGED_TR_DELTA = 7,
253: /* diverged */
254: SNES_DIVERGED_FUNCTION_DOMAIN = -1, /* the new x location passed the function is not in the domain of F */
255: SNES_DIVERGED_FUNCTION_COUNT = -2,
256: SNES_DIVERGED_LINEAR_SOLVE = -3, /* the linear solve failed */
257: SNES_DIVERGED_FNORM_NAN = -4,
258: SNES_DIVERGED_MAX_IT = -5,
259: SNES_DIVERGED_LINE_SEARCH = -6, /* the line search failed */
260: SNES_DIVERGED_INNER = -7, /* inner solve failed */
261: SNES_DIVERGED_LOCAL_MIN = -8, /* || J^T b || is small, implies converged to local minimum of F() */
262: SNES_CONVERGED_ITERATING = 0} SNESConvergedReason;
263: PETSC_EXTERN const char *const*SNESConvergedReasons;
265: /*MC
266: SNES_CONVERGED_FNORM_ABS - 2-norm(F) <= abstol
268: Level: beginner
270: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
272: M*/
274: /*MC
275: SNES_CONVERGED_FNORM_RELATIVE - 2-norm(F) <= rtol*2-norm(F(x_0)) where x_0 is the initial guess
277: Level: beginner
279: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
281: M*/
283: /*MC
284: SNES_CONVERGED_SNORM_RELATIVE - The 2-norm of the last step <= stol * 2-norm(x) where x is the current
285: solution and stol is the 4th argument to SNESSetTolerances()
287: Options Database Keys:
288: -snes_stol <stol> - the step tolerance
290: Level: beginner
292: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
294: M*/
296: /*MC
297: SNES_DIVERGED_FUNCTION_COUNT - The user provided function has been called more times then the final
298: argument to SNESSetTolerances()
300: Level: beginner
302: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
304: M*/
306: /*MC
307: SNES_DIVERGED_FNORM_NAN - the 2-norm of the current function evaluation is not-a-number (NaN), this
308: is usually caused by a division of 0 by 0.
310: Level: beginner
312: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
314: M*/
316: /*MC
317: SNES_DIVERGED_MAX_IT - SNESSolve() has reached the maximum number of iterations requested
319: Level: beginner
321: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
323: M*/
325: /*MC
326: SNES_DIVERGED_LINE_SEARCH - The line search has failed. This only occurs for a SNESType of SNESLS
328: Level: beginner
330: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
332: M*/
334: /*MC
335: SNES_DIVERGED_LOCAL_MIN - the algorithm seems to have stagnated at a local minimum that is not zero.
336: See the manual page for SNESConvergedReason for more details
338: Level: beginner
340: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
342: M*/
344: /*MC
345: SNES_CONERGED_ITERATING - this only occurs if SNESGetConvergedReason() is called during the SNESSolve()
347: Level: beginner
349: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
351: M*/
353: PETSC_EXTERN PetscErrorCode SNESSetConvergenceTest(SNES,PetscErrorCode (*)(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void*,PetscErrorCode (*)(void*));
354: PETSC_EXTERN PetscErrorCode SNESDefaultConverged(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*);
355: PETSC_EXTERN PetscErrorCode SNESSkipConverged(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*);
356: PETSC_EXTERN PetscErrorCode SNESGetConvergedReason(SNES,SNESConvergedReason*);
358: PETSC_EXTERN PetscErrorCode SNESDMMeshComputeFunction(SNES,Vec,Vec,void*);
359: PETSC_EXTERN PetscErrorCode SNESDMMeshComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
360: PETSC_EXTERN PetscErrorCode SNESDMComputeFunction(SNES,Vec,Vec,void *);
361: PETSC_EXTERN PetscErrorCode SNESDMComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
363: /* --------- Solving systems of nonlinear equations --------------- */
364: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESFunction)(SNES,Vec,Vec,void*);
365: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESJacobian)(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
366: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESGSFunction)(SNES,Vec,Vec,void*);
367: PETSC_EXTERN PetscErrorCode SNESSetFunction(SNES,Vec,SNESFunction,void*);
368: PETSC_EXTERN PetscErrorCode SNESGetFunction(SNES,Vec*,SNESFunction*,void**);
369: PETSC_EXTERN PetscErrorCode SNESComputeFunction(SNES,Vec,Vec);
370: PETSC_EXTERN PetscErrorCode SNESSetJacobian(SNES,Mat,Mat,SNESJacobian,void*);
371: PETSC_EXTERN PetscErrorCode SNESGetJacobian(SNES,Mat*,Mat*,SNESJacobian*,void**);
372: PETSC_EXTERN PetscErrorCode SNESDefaultComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
373: PETSC_EXTERN PetscErrorCode SNESDefaultComputeJacobianColor(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
374: PETSC_EXTERN PetscErrorCode SNESSetComputeInitialGuess(SNES,PetscErrorCode (*)(SNES,Vec,void*),void*);
375: PETSC_EXTERN PetscErrorCode SNESSetPicard(SNES,Vec,SNESFunction,Mat,Mat,SNESJacobian,void*);
376: PETSC_EXTERN PetscErrorCode SNESGetPicard(SNES,Vec*,SNESFunction*,Mat*,Mat*,SNESJacobian*,void**);
377: PETSC_EXTERN PetscErrorCode SNESSetInitialFunction(SNES,Vec);
378: PETSC_EXTERN PetscErrorCode SNESSetInitialFunctionNorm(SNES,PetscReal);
380: /*E
381: SNESNormType - Norm that is passed in the Krylov convergence
382: test routines.
384: Level: advanced
386: Support for these is highly dependent on the solver.
388: Notes:
389: This is primarily used to turn off extra norm and function computation
390: when the solvers are composed.
392: .seealso: SNESSolve(), SNESGetConvergedReason(), KSPSetNormType(),
393: KSPSetConvergenceTest(), KSPSetPCSide()
394: E*/
396: typedef enum {SNES_NORM_DEFAULT = -1,
397: SNES_NORM_NONE = 0,
398: SNES_NORM_FUNCTION = 1,
399: SNES_NORM_INITIAL_ONLY = 2,
400: SNES_NORM_FINAL_ONLY = 3,
401: SNES_NORM_INITIAL_FINAL_ONLY = 4} SNESNormType;
402: PETSC_EXTERN const char *const*const SNESNormTypes;
403: /*MC
404: SNES_NORM_NONE - Don't compute function and its L2 norm.
406: Level: advanced
408: Notes:
409: This is most useful for stationary solvers with a fixed number of iterations used as smoothers.
411: .seealso: SNESNormType, SNESSetNormType(), SNES_NORM_DEFAULT
412: M*/
414: /*MC
415: SNES_NORM_FUNCTION - Compute the function and its L2 norm at each iteration.
417: Level: advanced
419: Notes:
420: Most solvers will use this no matter what norm type is passed to them.
422: .seealso: SNESNormType, SNESSetNormType(), SNES_NORM_NONE
423: M*/
425: /*MC
426: SNES_NORM_INITIAL_ONLY - Compute the function and its L2 at iteration 0, but do not update it.
428: Level: advanced
430: Notes:
431: This method is useful in composed methods, when a true solution might actually be found before SNESSolve() is called.
432: This option enables the solve to abort on the zeroth iteration if this is the case.
434: For solvers that require the computation of the L2 norm of the function as part of the method, this merely cancels
435: the norm computation at the last iteration (if possible).
437: .seealso: SNESNormType, SNESSetNormType(), SNES_NORM_FINAL_ONLY, SNES_NORM_INITIAL_FINAL_ONLY
438: M*/
440: /*MC
441: SNES_NORM_FINAL_ONLY - Compute the function and its L2 norm on only the final iteration.
443: Level: advanced
445: Notes:
446: For solvers that require the computation of the L2 norm of the function as part of the method, behaves
447: exactly as SNES_NORM_DEFAULT. This method is useful when the function is gotten after SNESSolve and
448: used in subsequent computation for methods that do not need the norm computed during the rest of the
449: solution procedure.
451: .seealso: SNESNormType, SNESSetNormType(), SNES_NORM_INITIAL_ONLY, SNES_NORM_INITIAL_FINAL_ONLY
452: M*/
454: /*MC
455: SNES_NORM_INITIAL_FINAL_ONLY - Compute the function and its L2 norm on only the initial and final iterations.
457: Level: advanced
459: Notes:
460: This method combines the benefits of SNES_NORM_INITIAL_ONLY and SNES_NORM_FINAL_ONLY.
462: .seealso: SNESNormType, SNESSetNormType(), SNES_NORM_SNES_NORM_INITIAL_ONLY, SNES_NORM_FINAL_ONLY
463: M*/
466: PETSC_EXTERN PetscErrorCode SNESSetNormType(SNES,SNESNormType);
467: PETSC_EXTERN PetscErrorCode SNESGetNormType(SNES,SNESNormType*);
469: PETSC_EXTERN PetscErrorCode SNESSetGS(SNES,SNESGSFunction,void*);
470: PETSC_EXTERN PetscErrorCode SNESGetGS(SNES,SNESGSFunction*,void**);
471: PETSC_EXTERN PetscErrorCode SNESSetUseGS(SNES,PetscBool);
472: PETSC_EXTERN PetscErrorCode SNESGetUseGS(SNES,PetscBool *);
473: PETSC_EXTERN PetscErrorCode SNESSetGSSweeps(SNES,PetscInt);
474: PETSC_EXTERN PetscErrorCode SNESGetGSSweeps(SNES,PetscInt *);
475: PETSC_EXTERN PetscErrorCode SNESComputeGS(SNES,Vec,Vec);
477: PETSC_EXTERN PetscErrorCode SNESShellGetContext(SNES,void**);
478: PETSC_EXTERN PetscErrorCode SNESShellSetContext(SNES,void*);
479: PETSC_EXTERN PetscErrorCode SNESShellSetSolve(SNES,PetscErrorCode (*)(SNES,Vec));
481: /* --------- Routines specifically for line search methods --------------- */
483: typedef struct _p_LineSearch* SNESLineSearch;
485: /*S
486: SNESLineSearch - Abstract PETSc object that manages line-search operations
488: Level: beginner
490: Concepts: nonlinear solvers, line search
492: .seealso: SNESLineSearchCreate(), SNESLineSearchSetType(), SNES
493: S*/
495: /*J
496: SNESLineSearchType - String with the name of a PETSc line search method
498: Level: beginner
500: .seealso: SNESLineSearchSetType(), SNES
501: J*/
503: #define SNESLineSearchType char*
504: #define SNESLINESEARCHBT "bt"
505: #define SNESLINESEARCHBASIC "basic"
506: #define SNESLINESEARCHL2 "l2"
507: #define SNESLINESEARCHCP "cp"
508: #define SNESLINESEARCHSHELL "shell"
510: PETSC_EXTERN PetscClassId SNESLINESEARCH_CLASSID;
511: PETSC_EXTERN PetscBool SNESLineSearchRegisterAllCalled;
512: PETSC_EXTERN PetscFList SNESLineSearchList;
513: PETSC_EXTERN PetscLogEvent SNESLineSearch_Apply;
515: #define SNES_LINESEARCH_ORDER_LINEAR 1
516: #define SNES_LINESEARCH_ORDER_QUADRATIC 2
517: #define SNES_LINESEARCH_ORDER_CUBIC 3
519: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchPreCheckFunc)(SNESLineSearch,Vec,Vec,PetscBool*,void*);
520: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchVIProjectFunc)(SNES,Vec);
521: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchVINormFunc)(SNES,Vec,Vec,PetscReal *);
522: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchPostCheckFunc)(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *,void*);
523: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchApplyFunc)(SNESLineSearch);
524: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchUserFunc)(SNESLineSearch, void *);
526: PETSC_EXTERN PetscErrorCode SNESLineSearchCreate(MPI_Comm, SNESLineSearch*);
527: PETSC_EXTERN PetscErrorCode SNESLineSearchReset(SNESLineSearch);
528: PETSC_EXTERN PetscErrorCode SNESLineSearchView(SNESLineSearch,PetscViewer);
529: PETSC_EXTERN PetscErrorCode SNESLineSearchDestroy(SNESLineSearch *);
530: PETSC_EXTERN PetscErrorCode SNESLineSearchSetType(SNESLineSearch, const SNESLineSearchType);
531: PETSC_EXTERN PetscErrorCode SNESLineSearchSetFromOptions(SNESLineSearch);
532: PETSC_EXTERN PetscErrorCode SNESLineSearchSetUp(SNESLineSearch);
533: PETSC_EXTERN PetscErrorCode SNESLineSearchApply(SNESLineSearch, Vec, Vec, PetscReal *, Vec);
534: PETSC_EXTERN PetscErrorCode SNESLineSearchPreCheck(SNESLineSearch,Vec,Vec,PetscBool *);
535: PETSC_EXTERN PetscErrorCode SNESLineSearchPostCheck(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *);
536: PETSC_EXTERN PetscErrorCode SNESLineSearchGetWork(SNESLineSearch, PetscInt);
538: /* set the functions for precheck and postcheck */
540: PETSC_EXTERN PetscErrorCode SNESLineSearchSetPreCheck(SNESLineSearch, SNESLineSearchPreCheckFunc, void *ctx);
541: PETSC_EXTERN PetscErrorCode SNESLineSearchSetPostCheck(SNESLineSearch, SNESLineSearchPostCheckFunc, void *ctx);
543: PETSC_EXTERN PetscErrorCode SNESLineSearchGetPreCheck(SNESLineSearch, SNESLineSearchPreCheckFunc*, void **ctx);
544: PETSC_EXTERN PetscErrorCode SNESLineSearchGetPostCheck(SNESLineSearch, SNESLineSearchPostCheckFunc*, void **ctx);
546: /* set the functions for VI-specific line search operations */
548: PETSC_EXTERN PetscErrorCode SNESLineSearchSetVIFunctions(SNESLineSearch, SNESLineSearchVIProjectFunc, SNESLineSearchVINormFunc);
549: PETSC_EXTERN PetscErrorCode SNESLineSearchGetVIFunctions(SNESLineSearch, SNESLineSearchVIProjectFunc*, SNESLineSearchVINormFunc*);
551: /* pointers to the associated SNES in order to be able to get the function evaluation out */
552: PETSC_EXTERN PetscErrorCode SNESLineSearchSetSNES(SNESLineSearch,SNES);
553: PETSC_EXTERN PetscErrorCode SNESLineSearchGetSNES(SNESLineSearch,SNES*);
555: /* set and get the parameters and vectors */
556: PETSC_EXTERN PetscErrorCode SNESLineSearchGetTolerances(SNESLineSearch,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscInt*);
557: PETSC_EXTERN PetscErrorCode SNESLineSearchSetTolerances(SNESLineSearch,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscInt);
559: PETSC_EXTERN PetscErrorCode SNESLineSearchPreCheckPicard(SNESLineSearch,Vec,Vec,PetscBool*,void*);
561: PETSC_EXTERN PetscErrorCode SNESLineSearchGetLambda(SNESLineSearch,PetscReal*);
562: PETSC_EXTERN PetscErrorCode SNESLineSearchSetLambda(SNESLineSearch,PetscReal);
564: PETSC_EXTERN PetscErrorCode SNESLineSearchGetDamping(SNESLineSearch,PetscReal*);
565: PETSC_EXTERN PetscErrorCode SNESLineSearchSetDamping(SNESLineSearch,PetscReal);
567: PETSC_EXTERN PetscErrorCode SNESLineSearchGetOrder(SNESLineSearch,PetscInt *order);
568: PETSC_EXTERN PetscErrorCode SNESLineSearchSetOrder(SNESLineSearch,PetscInt order);
570: PETSC_EXTERN PetscErrorCode SNESLineSearchGetSuccess(SNESLineSearch, PetscBool*);
571: PETSC_EXTERN PetscErrorCode SNESLineSearchSetSuccess(SNESLineSearch, PetscBool);
573: PETSC_EXTERN PetscErrorCode SNESLineSearchGetVecs(SNESLineSearch,Vec*,Vec*,Vec*,Vec*,Vec*);
574: PETSC_EXTERN PetscErrorCode SNESLineSearchSetVecs(SNESLineSearch,Vec,Vec,Vec,Vec,Vec);
576: PETSC_EXTERN PetscErrorCode SNESLineSearchGetNorms(SNESLineSearch, PetscReal *, PetscReal *, PetscReal *);
577: PETSC_EXTERN PetscErrorCode SNESLineSearchSetNorms(SNESLineSearch, PetscReal, PetscReal, PetscReal);
578: PETSC_EXTERN PetscErrorCode SNESLineSearchComputeNorms(SNESLineSearch);
579: PETSC_EXTERN PetscErrorCode SNESLineSearchSetComputeNorms(SNESLineSearch, PetscBool);
581: PETSC_EXTERN PetscErrorCode SNESLineSearchSetMonitor(SNESLineSearch, PetscBool);
582: PETSC_EXTERN PetscErrorCode SNESLineSearchGetMonitor(SNESLineSearch, PetscViewer*);
584: PETSC_EXTERN PetscErrorCode SNESLineSearchAppendOptionsPrefix(SNESLineSearch, const char prefix[]);
585: PETSC_EXTERN PetscErrorCode SNESLineSearchGetOptionsPrefix(SNESLineSearch, const char *prefix[]);
588: /* Shell interface functions */
589: PETSC_EXTERN PetscErrorCode SNESLineSearchShellSetUserFunc(SNESLineSearch,SNESLineSearchUserFunc,void*);
590: PETSC_EXTERN PetscErrorCode SNESLineSearchShellGetUserFunc(SNESLineSearch,SNESLineSearchUserFunc*,void**);
592: /* BT interface functions */
593: PETSC_EXTERN PetscErrorCode SNESLineSearchBTSetAlpha(SNESLineSearch, PetscReal);
594: PETSC_EXTERN PetscErrorCode SNESLineSearchBTGetAlpha(SNESLineSearch, PetscReal*);
596: /*register line search types */
597: PETSC_EXTERN PetscErrorCode SNESLineSearchRegister(const char[],const char[],const char[],PetscErrorCode(*)(SNESLineSearch));
598: PETSC_EXTERN PetscErrorCode SNESLineSearchRegisterAll(const char path[]);
599: PETSC_EXTERN PetscErrorCode SNESLineSearchRegisterDestroy(void);
601: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
602: #define SNESLineSearchRegisterDynamic(a,b,c,d) SNESLineSearchRegister(a,b,c,0)
603: #else
604: #define SNESLineSearchRegisterDynamic(a,b,c,d) SNESLineSearchRegister(a,b,c,d)
605: #endif
607: /* Routines for VI solver */
608: PETSC_EXTERN PetscErrorCode SNESVISetVariableBounds(SNES,Vec,Vec);
609: PETSC_EXTERN PetscErrorCode SNESVISetComputeVariableBounds(SNES, PetscErrorCode (*)(SNES,Vec,Vec));
610: PETSC_EXTERN PetscErrorCode SNESVIGetInactiveSet(SNES,IS*);
611: PETSC_EXTERN PetscErrorCode SNESVIGetActiveSetIS(SNES,Vec,Vec,IS*);
612: PETSC_EXTERN PetscErrorCode SNESVIComputeInactiveSetFnorm(SNES,Vec,Vec,PetscReal*);
613: PETSC_EXTERN PetscErrorCode SNESVISetRedundancyCheck(SNES,PetscErrorCode(*)(SNES,IS,IS*,void*),void*);
614: #define SNES_VI_INF 1.0e20
615: #define SNES_VI_NINF -1.0e20
617: PETSC_EXTERN PetscErrorCode SNESTestLocalMin(SNES);
619: /* Should this routine be private? */
620: PETSC_EXTERN PetscErrorCode SNESComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*);
622: PETSC_EXTERN PetscErrorCode SNESSetDM(SNES,DM);
623: PETSC_EXTERN PetscErrorCode SNESGetDM(SNES,DM*);
624: PETSC_EXTERN PetscErrorCode SNESSetPC(SNES,SNES);
625: PETSC_EXTERN PetscErrorCode SNESGetPC(SNES,SNES*);
626: PETSC_EXTERN PetscErrorCode SNESSetSNESLineSearch(SNES,SNESLineSearch);
627: PETSC_EXTERN PetscErrorCode SNESGetSNESLineSearch(SNES,SNESLineSearch*);
628: PETSC_EXTERN PetscErrorCode SNESRestrictHookAdd(SNES,PetscErrorCode (*)(SNES,SNES,void*),void*);
629: PETSC_EXTERN PetscErrorCode SNESRestrictHooksRun(SNES,SNES);
631: PETSC_EXTERN PetscErrorCode SNESSetUpMatrices(SNES);
632: PETSC_EXTERN PetscErrorCode DMSNESSetFunction(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),void*);
633: PETSC_EXTERN PetscErrorCode DMSNESGetFunction(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),void**);
634: PETSC_EXTERN PetscErrorCode DMSNESSetGS(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),void*);
635: PETSC_EXTERN PetscErrorCode DMSNESGetGS(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),void**);
636: PETSC_EXTERN PetscErrorCode DMSNESSetJacobian(DM,PetscErrorCode(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void*);
637: PETSC_EXTERN PetscErrorCode DMSNESGetJacobian(DM,PetscErrorCode(**)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void**);
638: PETSC_EXTERN PetscErrorCode DMSNESSetPicard(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),PetscErrorCode(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void*);
639: PETSC_EXTERN PetscErrorCode DMSNESGetPicard(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),PetscErrorCode(**)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void**);
641: PETSC_EXTERN PetscErrorCode DMDASNESSetFunctionLocal(DM,InsertMode,PetscErrorCode(*)(DMDALocalInfo*,void*,void*,void*),void*);
642: PETSC_EXTERN PetscErrorCode DMDASNESSetJacobianLocal(DM,PetscErrorCode(*)(DMDALocalInfo*,void*,Mat,Mat,MatStructure*,void*),void*);
644: /* Routines for Multiblock solver */
645: PETSC_EXTERN PetscErrorCode SNESMultiblockSetFields(SNES, const char [], PetscInt, const PetscInt *);
646: PETSC_EXTERN PetscErrorCode SNESMultiblockSetIS(SNES, const char [], IS);
647: PETSC_EXTERN PetscErrorCode SNESMultiblockSetBlockSize(SNES, PetscInt);
648: PETSC_EXTERN PetscErrorCode SNESMultiblockSetType(SNES, PCCompositeType);
650: /*J
651: SNESMSType - String with the name of a PETSc SNESMS method.
653: Level: intermediate
655: .seealso: SNESMSSetType(), SNES
656: J*/
657: #define SNESMSType char*
658: #define SNESMSM62 "m62"
659: #define SNESMSEULER "euler"
660: #define SNESMSJAMESON83 "jameson83"
661: #define SNESMSVLTP21 "vltp21"
662: #define SNESMSVLTP31 "vltp31"
663: #define SNESMSVLTP41 "vltp41"
664: #define SNESMSVLTP51 "vltp51"
665: #define SNESMSVLTP61 "vltp61"
667: PETSC_EXTERN PetscErrorCode SNESMSRegister(const SNESMSType,PetscInt,PetscInt,PetscReal,const PetscReal[],const PetscReal[],const PetscReal[]);
668: PETSC_EXTERN PetscErrorCode SNESMSSetType(SNES,const SNESMSType);
669: PETSC_EXTERN PetscErrorCode SNESMSFinalizePackage(void);
670: PETSC_EXTERN PetscErrorCode SNESMSInitializePackage(const char path[]);
671: PETSC_EXTERN PetscErrorCode SNESMSRegisterDestroy(void);
672: PETSC_EXTERN PetscErrorCode SNESMSRegisterAll(void);
674: /* routines for NGMRES solver */
676: typedef enum {
677: SNES_NGMRES_RESTART_NONE = 0,
678: SNES_NGMRES_RESTART_PERIODIC = 1,
679: SNES_NGMRES_RESTART_DIFFERENCE = 2} SNESNGMRESRestartType;
680: PETSC_EXTERN const char *SNESNGMRESRestartTypes[];
682: typedef enum {
683: SNES_NGMRES_SELECT_NONE = 0,
684: SNES_NGMRES_SELECT_DIFFERENCE = 1,
685: SNES_NGMRES_SELECT_LINESEARCH = 2} SNESNGMRESSelectType;
686: PETSC_EXTERN const char *SNESNGMRESSelectTypes[];
688: PETSC_EXTERN PetscErrorCode SNESNGMRESSetRestartType(SNES, SNESNGMRESRestartType);
689: PETSC_EXTERN PetscErrorCode SNESNGMRESSetSelectType(SNES, SNESNGMRESSelectType);
691: /* routines for NCG solver */
693: typedef enum {
694: SNES_NCG_FR = 0,
695: SNES_NCG_PRP = 1,
696: SNES_NCG_HS = 2,
697: SNES_NCG_DY = 3,
698: SNES_NCG_CD = 4} SNESNCGType;
699: PETSC_EXTERN const char *SNESNCGTypes[];
701: PETSC_EXTERN PetscErrorCode SNESNCGSetType(SNES, SNESNCGType);
703: /* routines for QN solver */
705: typedef enum {SNES_QN_SEQUENTIAL = 0,
706: SNES_QN_COMPOSED = 1} SNESQNCompositionType;
707: PETSC_EXTERN const char *SNESQNCompositionTypes[];
708: typedef enum {SNES_QN_SCALE_NONE = 0,
709: SNES_QN_SCALE_SHANNO = 1,
710: SNES_QN_SCALE_LINESEARCH = 2,
711: SNES_QN_SCALE_JACOBIAN = 3} SNESQNScaleType;
712: PETSC_EXTERN const char *SNESQNScaleTypes[];
713: typedef enum {SNES_QN_RESTART_NONE = 0,
714: SNES_QN_RESTART_POWELL = 1,
715: SNES_QN_RESTART_PERIODIC = 2} SNESQNRestartType;
716: PETSC_EXTERN const char *SNESQNRestartTypes[];
718: PETSC_EXTERN PetscErrorCode SNESQNSetCompositionType(SNES, SNESQNCompositionType);
719: PETSC_EXTERN PetscErrorCode SNESQNSetScaleType(SNES, SNESQNScaleType);
720: PETSC_EXTERN PetscErrorCode SNESQNSetRestartType(SNES, SNESQNRestartType);
723: #endif