Actual source code: petscsnes.h
petsc-3.9.4 2018-09-11
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 SNESSetUseMatrixFree(SNES,PetscBool,PetscBool);
103: PETSC_EXTERN PetscErrorCode SNESGetUseMatrixFree(SNES,PetscBool*,PetscBool*);
104: PETSC_EXTERN PetscErrorCode MatCreateSNESMF(SNES,Mat*);
105: PETSC_EXTERN PetscErrorCode MatSNESMFGetSNES(Mat,SNES*);
106: PETSC_EXTERN PetscErrorCode MatSNESMFSetReuseBase(Mat,PetscBool);
107: PETSC_EXTERN PetscErrorCode MatSNESMFGetReuseBase(Mat,PetscBool*);
108: PETSC_EXTERN PetscErrorCode MatMFFDComputeJacobian(SNES,Vec,Mat,Mat,void*);
110: PETSC_EXTERN PetscErrorCode MatDAADSetSNES(Mat,SNES);
112: PETSC_EXTERN PetscErrorCode SNESGetType(SNES,SNESType*);
113: PETSC_EXTERN PetscErrorCode SNESMonitorDefault(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
114: PETSC_EXTERN PetscErrorCode SNESMonitorScaling(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
115: PETSC_EXTERN PetscErrorCode SNESMonitorRange(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
116: PETSC_EXTERN PetscErrorCode SNESMonitorRatio(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
117: PETSC_EXTERN PetscErrorCode SNESMonitorRatioSetUp(SNES,PetscViewerAndFormat*);
118: PETSC_EXTERN PetscErrorCode SNESMonitorSolution(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
119: PETSC_EXTERN PetscErrorCode SNESMonitorResidual(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
120: PETSC_EXTERN PetscErrorCode SNESMonitorSolutionUpdate(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
121: PETSC_EXTERN PetscErrorCode SNESMonitorDefaultShort(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
122: PETSC_EXTERN PetscErrorCode SNESMonitorDefaultField(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
123: PETSC_EXTERN PetscErrorCode SNESMonitorJacUpdateSpectrum(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
124: PETSC_EXTERN PetscErrorCode SNESMonitorFields(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
125: PETSC_EXTERN PetscErrorCode KSPMonitorSNES(KSP,PetscInt,PetscReal,void*);
126: PETSC_EXTERN PetscErrorCode KSPMonitorSNESLGResidualNormCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscObject**);
127: PETSC_EXTERN PetscErrorCode KSPMonitorSNESLGResidualNorm(KSP,PetscInt,PetscReal,PetscObject*);
128: PETSC_EXTERN PetscErrorCode KSPMonitorSNESLGResidualNormDestroy(PetscObject**);
130: PETSC_EXTERN PetscErrorCode SNESSetTolerances(SNES,PetscReal,PetscReal,PetscReal,PetscInt,PetscInt);
131: PETSC_EXTERN PetscErrorCode SNESSetDivergenceTolerance(SNES,PetscReal);
132: PETSC_EXTERN PetscErrorCode SNESGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,PetscInt*,PetscInt*);
133: PETSC_EXTERN PetscErrorCode SNESGetDivergenceTolerance(SNES,PetscReal*);
134: PETSC_EXTERN PetscErrorCode SNESSetTrustRegionTolerance(SNES,PetscReal);
135: PETSC_EXTERN PetscErrorCode SNESGetForceIteration(SNES,PetscBool*);
136: PETSC_EXTERN PetscErrorCode SNESSetForceIteration(SNES,PetscBool);
137: PETSC_EXTERN PetscErrorCode SNESGetIterationNumber(SNES,PetscInt*);
138: PETSC_EXTERN PetscErrorCode SNESSetIterationNumber(SNES,PetscInt);
140: PETSC_EXTERN PetscErrorCode SNESGetNonlinearStepFailures(SNES,PetscInt*);
141: PETSC_EXTERN PetscErrorCode SNESSetMaxNonlinearStepFailures(SNES,PetscInt);
142: PETSC_EXTERN PetscErrorCode SNESGetMaxNonlinearStepFailures(SNES,PetscInt*);
143: PETSC_EXTERN PetscErrorCode SNESGetNumberFunctionEvals(SNES,PetscInt*);
145: PETSC_EXTERN PetscErrorCode SNESSetLagPreconditioner(SNES,PetscInt);
146: PETSC_EXTERN PetscErrorCode SNESGetLagPreconditioner(SNES,PetscInt*);
147: PETSC_EXTERN PetscErrorCode SNESSetLagJacobian(SNES,PetscInt);
148: PETSC_EXTERN PetscErrorCode SNESGetLagJacobian(SNES,PetscInt*);
149: PETSC_EXTERN PetscErrorCode SNESSetLagPreconditionerPersists(SNES,PetscBool);
150: PETSC_EXTERN PetscErrorCode SNESSetLagJacobianPersists(SNES,PetscBool);
151: PETSC_EXTERN PetscErrorCode SNESSetGridSequence(SNES,PetscInt);
152: PETSC_EXTERN PetscErrorCode SNESGetGridSequence(SNES,PetscInt*);
154: PETSC_EXTERN PetscErrorCode SNESGetLinearSolveIterations(SNES,PetscInt*);
155: PETSC_EXTERN PetscErrorCode SNESGetLinearSolveFailures(SNES,PetscInt*);
156: PETSC_EXTERN PetscErrorCode SNESSetMaxLinearSolveFailures(SNES,PetscInt);
157: PETSC_EXTERN PetscErrorCode SNESGetMaxLinearSolveFailures(SNES,PetscInt*);
158: PETSC_EXTERN PetscErrorCode SNESSetCountersReset(SNES,PetscBool);
160: PETSC_EXTERN PetscErrorCode SNESKSPSetUseEW(SNES,PetscBool );
161: PETSC_EXTERN PetscErrorCode SNESKSPGetUseEW(SNES,PetscBool *);
162: PETSC_EXTERN PetscErrorCode SNESKSPSetParametersEW(SNES,PetscInt,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal);
163: PETSC_EXTERN PetscErrorCode SNESKSPGetParametersEW(SNES,PetscInt*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*);
165: #include <petscdrawtypes.h>
166: PETSC_EXTERN PetscErrorCode SNESMonitorLGCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscDrawLG*);
167: PETSC_EXTERN PetscErrorCode SNESMonitorLGResidualNorm(SNES,PetscInt,PetscReal,void*);
168: PETSC_EXTERN PetscErrorCode SNESMonitorLGRange(SNES,PetscInt,PetscReal,void*);
170: PETSC_EXTERN PetscErrorCode SNESSetApplicationContext(SNES,void *);
171: PETSC_EXTERN PetscErrorCode SNESGetApplicationContext(SNES,void *);
172: PETSC_EXTERN PetscErrorCode SNESSetComputeApplicationContext(SNES,PetscErrorCode (*)(SNES,void**),PetscErrorCode (*)(void**));
174: PETSC_EXTERN PetscErrorCode SNESPythonSetType(SNES,const char[]);
176: PETSC_EXTERN PetscErrorCode SNESSetFunctionDomainError(SNES);
177: PETSC_EXTERN PetscErrorCode SNESGetFunctionDomainError(SNES, PetscBool *);
179: /*E
180: SNESConvergedReason - reason a SNES method was said to
181: have converged or diverged
183: Level: beginner
185: The two most common reasons for divergence are
186: $ 1) an incorrectly coded or computed Jacobian or
187: $ 2) failure or lack of convergence in the linear system (in this case we recommend
188: $ testing with -pc_type lu to eliminate the linear solver as the cause of the problem).
190: Diverged Reasons:
191: . SNES_DIVERGED_LOCAL_MIN - this can only occur when using the line-search variant of SNES.
192: The line search wants to minimize Q(alpha) = 1/2 || F(x + alpha s) ||^2_2 this occurs
193: 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
194: you get Q'(alpha) = -F(x)^T F'(x)^(-1)^T F'(x+alpha s)F(x+alpha s); when alpha = 0
195: Q'(0) = - ||F(x)||^2_2 which is always NEGATIVE if F'(x) is invertible. This means the Newton
196: direction is a descent direction and the line search should succeed if alpha is small enough.
198: If F'(x) is NOT invertible AND F'(x)^T F(x) = 0 then Q'(0) = 0 and the Newton direction
199: is NOT a descent direction so the line search will fail. All one can do at this point
200: is change the initial guess and try again.
202: An alternative explanation: Newton's method can be regarded as replacing the function with
203: its linear approximation and minimizing the 2-norm of that. That is F(x+s) approx F(x) + F'(x)s
204: so we minimize || F(x) + F'(x) s ||^2_2; do this using Least Squares. If F'(x) is invertible then
205: 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
206: exists a nontrival (that is F'(x)s != 0) solution to the equation and this direction is
207: 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)
208: = - (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
209: and F'(x)^T F'(x) has no negative eigenvalues Q'(0) < 0 so s is a descent direction and the line
210: search should succeed for small enough alpha.
212: Note that this RARELY happens in practice. Far more likely the linear system is not being solved
213: (well enough?) or the Jacobian is wrong.
215: SNES_DIVERGED_MAX_IT means that the solver reached the maximum number of iterations without satisfying any
216: convergence criteria. SNES_CONVERGED_ITS means that SNESConvergedSkip() was chosen as the convergence test;
217: thus the usual convergence criteria have not been checked and may or may not be satisfied.
219: Developer Notes: this must match petsc/finclude/petscsnes.h
221: The string versions of these are in SNESConvergedReasons, if you change any value here you must
222: also adjust that array.
224: Each reason has its own manual page.
226: .seealso: SNESSolve(), SNESGetConvergedReason(), KSPConvergedReason, SNESSetConvergenceTest()
227: E*/
228: typedef enum {/* converged */
229: SNES_CONVERGED_FNORM_ABS = 2, /* ||F|| < atol */
230: SNES_CONVERGED_FNORM_RELATIVE = 3, /* ||F|| < rtol*||F_initial|| */
231: SNES_CONVERGED_SNORM_RELATIVE = 4, /* Newton computed step size small; || delta x || < stol || x ||*/
232: SNES_CONVERGED_ITS = 5, /* maximum iterations reached */
233: SNES_CONVERGED_TR_DELTA = 7,
234: /* diverged */
235: SNES_DIVERGED_FUNCTION_DOMAIN = -1, /* the new x location passed the function is not in the domain of F */
236: SNES_DIVERGED_FUNCTION_COUNT = -2,
237: SNES_DIVERGED_LINEAR_SOLVE = -3, /* the linear solve failed */
238: SNES_DIVERGED_FNORM_NAN = -4,
239: SNES_DIVERGED_MAX_IT = -5,
240: SNES_DIVERGED_LINE_SEARCH = -6, /* the line search failed */
241: SNES_DIVERGED_INNER = -7, /* inner solve failed */
242: SNES_DIVERGED_LOCAL_MIN = -8, /* || J^T b || is small, implies converged to local minimum of F() */
243: SNES_DIVERGED_DTOL = -9, /* || F || > divtol*||F_initial|| */
245: SNES_CONVERGED_ITERATING = 0} SNESConvergedReason;
246: PETSC_EXTERN const char *const*SNESConvergedReasons;
248: /*MC
249: SNES_CONVERGED_FNORM_ABS - 2-norm(F) <= abstol
251: Level: beginner
253: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
255: M*/
257: /*MC
258: SNES_CONVERGED_FNORM_RELATIVE - 2-norm(F) <= rtol*2-norm(F(x_0)) where x_0 is the initial guess
260: Level: beginner
262: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
264: M*/
266: /*MC
267: SNES_CONVERGED_SNORM_RELATIVE - The 2-norm of the last step <= stol * 2-norm(x) where x is the current
268: solution and stol is the 4th argument to SNESSetTolerances()
270: Options Database Keys:
271: -snes_stol <stol> - the step tolerance
273: Level: beginner
275: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
277: M*/
279: /*MC
280: SNES_DIVERGED_FUNCTION_COUNT - The user provided function has been called more times then the final
281: argument to SNESSetTolerances()
283: Level: beginner
285: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
287: M*/
289: /*MC
290: SNES_DIVERGED_DTOL - The norm of the function has increased by a factor of divtol set with SNESSetDivergenceTolerance()
292: Level: beginner
294: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances(), SNESSetDivergenceTolerance()
296: M*/
298: /*MC
299: SNES_DIVERGED_FNORM_NAN - the 2-norm of the current function evaluation is not-a-number (NaN), this
300: is usually caused by a division of 0 by 0.
302: Level: beginner
304: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
306: M*/
308: /*MC
309: SNES_DIVERGED_MAX_IT - SNESSolve() has reached the maximum number of iterations requested
311: Level: beginner
313: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
315: M*/
317: /*MC
318: SNES_DIVERGED_LINE_SEARCH - The line search has failed. This only occurs for a SNES solvers that use a line search
320: Level: beginner
322: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances(), SNESLineSearch
324: M*/
326: /*MC
327: SNES_DIVERGED_LOCAL_MIN - the algorithm seems to have stagnated at a local minimum that is not zero.
328: See the manual page for SNESConvergedReason for more details
330: Level: beginner
332: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
334: M*/
336: /*MC
337: SNES_CONERGED_ITERATING - this only occurs if SNESGetConvergedReason() is called during the SNESSolve()
339: Level: beginner
341: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
343: M*/
345: PETSC_EXTERN PetscErrorCode SNESSetConvergenceTest(SNES,PetscErrorCode (*)(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void*,PetscErrorCode (*)(void*));
346: PETSC_EXTERN PetscErrorCode SNESConvergedDefault(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*);
347: PETSC_EXTERN PetscErrorCode SNESConvergedSkip(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*);
348: PETSC_EXTERN PetscErrorCode SNESGetConvergedReason(SNES,SNESConvergedReason*);
349: PETSC_EXTERN PetscErrorCode SNESSetConvergedReason(SNES,SNESConvergedReason);
351: PETSC_DEPRECATED("Use SNESConvergedSkip()") PETSC_STATIC_INLINE void SNESSkipConverged(void) { /* never called */ }
352: #define SNESSkipConverged (SNESSkipConverged, SNESConvergedSkip)
354: /* --------- Solving systems of nonlinear equations --------------- */
355: PETSC_EXTERN PetscErrorCode SNESSetFunction(SNES,Vec,PetscErrorCode (*)(SNES,Vec,Vec,void*),void*);
356: PETSC_EXTERN PetscErrorCode SNESGetFunction(SNES,Vec*,PetscErrorCode (**)(SNES,Vec,Vec,void*),void**);
357: PETSC_EXTERN PetscErrorCode SNESComputeFunction(SNES,Vec,Vec);
359: PETSC_EXTERN PetscErrorCode SNESSetJacobian(SNES,Mat,Mat,PetscErrorCode (*)(SNES,Vec,Mat,Mat,void*),void*);
360: PETSC_EXTERN PetscErrorCode SNESGetJacobian(SNES,Mat*,Mat*,PetscErrorCode (**)(SNES,Vec,Mat,Mat,void*),void**);
361: PETSC_EXTERN PetscErrorCode SNESObjectiveComputeFunctionDefaultFD(SNES,Vec,Vec,void*);
362: PETSC_EXTERN PetscErrorCode SNESComputeJacobianDefault(SNES,Vec,Mat,Mat,void*);
363: PETSC_EXTERN PetscErrorCode SNESComputeJacobianDefaultColor(SNES,Vec,Mat,Mat,void*);
364: PETSC_EXTERN PetscErrorCode SNESSetComputeInitialGuess(SNES,PetscErrorCode (*)(SNES,Vec,void*),void*);
365: PETSC_EXTERN PetscErrorCode SNESSetPicard(SNES,Vec,PetscErrorCode (*)(SNES,Vec,Vec,void*),Mat,Mat,PetscErrorCode (*)(SNES,Vec,Mat,Mat,void*),void*);
366: PETSC_EXTERN PetscErrorCode SNESGetPicard(SNES,Vec*,PetscErrorCode (**)(SNES,Vec,Vec,void*),Mat*,Mat*,PetscErrorCode (**)(SNES,Vec,Mat,Mat,void*),void**);
367: PETSC_EXTERN PetscErrorCode SNESSetInitialFunction(SNES,Vec);
369: PETSC_EXTERN PetscErrorCode SNESSetObjective(SNES,PetscErrorCode (*)(SNES,Vec,PetscReal *,void*),void*);
370: PETSC_EXTERN PetscErrorCode SNESGetObjective(SNES,PetscErrorCode (**)(SNES,Vec,PetscReal *,void*),void**);
371: PETSC_EXTERN PetscErrorCode SNESComputeObjective(SNES,Vec,PetscReal *);
373: /*E
374: SNESNormSchedule - Frequency with which the norm is computed
376: Level: advanced
378: Support for these is highly dependent on the solver.
380: Notes:
381: This is primarily used to turn off extra norm and function computation
382: when the solvers are composed.
384: .seealso: SNESSolve(), SNESGetConvergedReason(), KSPSetNormType(),
385: KSPSetConvergenceTest(), KSPSetPCSide()
386: E*/
388: typedef enum {SNES_NORM_DEFAULT = -1,
389: SNES_NORM_NONE = 0,
390: SNES_NORM_ALWAYS = 1,
391: SNES_NORM_INITIAL_ONLY = 2,
392: SNES_NORM_FINAL_ONLY = 3,
393: SNES_NORM_INITIAL_FINAL_ONLY = 4} SNESNormSchedule;
394: PETSC_EXTERN const char *const*const SNESNormSchedules;
396: /*MC
397: SNES_NORM_NONE - Don't compute function and its L2 norm.
399: Level: advanced
401: Notes:
402: This is most useful for stationary solvers with a fixed number of iterations used as smoothers.
404: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_DEFAULT
405: M*/
407: /*MC
408: SNES_NORM_ALWAYS - Compute the function and its L2 norm at each iteration.
410: Level: advanced
412: Notes:
413: Most solvers will use this no matter what norm type is passed to them.
415: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_NONE
416: M*/
418: /*MC
419: SNES_NORM_INITIAL_ONLY - Compute the function and its L2 at iteration 0, but do not update it.
421: Level: advanced
423: Notes:
424: This method is useful in composed methods, when a true solution might actually be found before SNESSolve() is called.
425: This option enables the solve to abort on the zeroth iteration if this is the case.
427: For solvers that require the computation of the L2 norm of the function as part of the method, this merely cancels
428: the norm computation at the last iteration (if possible).
430: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_FINAL_ONLY, SNES_NORM_INITIAL_FINAL_ONLY
431: M*/
433: /*MC
434: SNES_NORM_FINAL_ONLY - Compute the function and its L2 norm on only the final iteration.
436: Level: advanced
438: Notes:
439: For solvers that require the computation of the L2 norm of the function as part of the method, behaves
440: exactly as SNES_NORM_DEFAULT. This method is useful when the function is gotten after SNESSolve and
441: used in subsequent computation for methods that do not need the norm computed during the rest of the
442: solution procedure.
444: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_INITIAL_ONLY, SNES_NORM_INITIAL_FINAL_ONLY
445: M*/
447: /*MC
448: SNES_NORM_INITIAL_FINAL_ONLY - Compute the function and its L2 norm on only the initial and final iterations.
450: Level: advanced
452: Notes:
453: This method combines the benefits of SNES_NORM_INITIAL_ONLY and SNES_NORM_FINAL_ONLY.
455: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_SNES_NORM_INITIAL_ONLY, SNES_NORM_FINAL_ONLY
456: M*/
458: PETSC_EXTERN PetscErrorCode SNESSetNormSchedule(SNES,SNESNormSchedule);
459: PETSC_EXTERN PetscErrorCode SNESGetNormSchedule(SNES,SNESNormSchedule*);
460: PETSC_EXTERN PetscErrorCode SNESSetFunctionNorm(SNES,PetscReal);
461: PETSC_EXTERN PetscErrorCode SNESGetFunctionNorm(SNES,PetscReal*);
463: /*E
464: SNESFunctionType - Type of function computed
466: Level: advanced
468: Support for these is highly dependent on the solver.
470: .seealso: SNESSolve(), SNESGetConvergedReason(), KSPSetNormType(),
471: KSPSetConvergenceTest(), KSPSetPCSide()
472: E*/
473: typedef enum {SNES_FUNCTION_DEFAULT = -1,
474: SNES_FUNCTION_UNPRECONDITIONED = 0,
475: SNES_FUNCTION_PRECONDITIONED = 1} SNESFunctionType;
476: PETSC_EXTERN const char *const*const SNESFunctionTypes;
478: PETSC_EXTERN PetscErrorCode SNESSetFunctionType(SNES,SNESFunctionType);
479: PETSC_EXTERN PetscErrorCode SNESGetFunctionType(SNES,SNESFunctionType*);
481: PETSC_EXTERN PetscErrorCode SNESSetNGS(SNES,PetscErrorCode (*)(SNES,Vec,Vec,void*),void*);
482: PETSC_EXTERN PetscErrorCode SNESGetNGS(SNES,PetscErrorCode (**)(SNES,Vec,Vec,void*),void**);
483: PETSC_EXTERN PetscErrorCode SNESSetUseNGS(SNES,PetscBool);
484: PETSC_EXTERN PetscErrorCode SNESGetUseNGS(SNES,PetscBool *);
485: PETSC_EXTERN PetscErrorCode SNESComputeNGS(SNES,Vec,Vec);
487: PETSC_EXTERN PetscErrorCode SNESNGSSetSweeps(SNES,PetscInt);
488: PETSC_EXTERN PetscErrorCode SNESNGSGetSweeps(SNES,PetscInt *);
489: PETSC_EXTERN PetscErrorCode SNESNGSSetTolerances(SNES,PetscReal,PetscReal,PetscReal,PetscInt);
490: PETSC_EXTERN PetscErrorCode SNESNGSGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,PetscInt*);
492: PETSC_EXTERN PetscErrorCode SNESUpdateCheckJacobian(SNES,PetscInt);
494: PETSC_EXTERN PetscErrorCode SNESSetAlwaysComputesFinalResidual(SNES,PetscBool);
495: PETSC_EXTERN PetscErrorCode SNESGetAlwaysComputesFinalResidual(SNES,PetscBool*);
497: PETSC_EXTERN PetscErrorCode SNESShellGetContext(SNES,void**);
498: PETSC_EXTERN PetscErrorCode SNESShellSetContext(SNES,void*);
499: PETSC_EXTERN PetscErrorCode SNESShellSetSolve(SNES,PetscErrorCode (*)(SNES,Vec));
501: /* --------- Routines specifically for line search methods --------------- */
504: /*S
505: SNESLineSearch - Abstract PETSc object that manages line-search operations
507: Level: beginner
509: Concepts: nonlinear solvers, line search
511: .seealso: SNESLineSearchCreate(), SNESLineSearchSetType(), SNES
512: S*/
513: typedef struct _p_LineSearch* SNESLineSearch;
515: /*J
516: SNESLineSearchType - String with the name of a PETSc line search method
518: Level: beginner
520: .seealso: SNESLineSearchSetType(), SNES
521: J*/
522: typedef const char* SNESLineSearchType;
523: #define SNESLINESEARCHBT "bt"
524: #define SNESLINESEARCHNLEQERR "nleqerr"
525: #define SNESLINESEARCHBASIC "basic"
526: #define SNESLINESEARCHL2 "l2"
527: #define SNESLINESEARCHCP "cp"
528: #define SNESLINESEARCHSHELL "shell"
530: PETSC_EXTERN PetscFunctionList SNESList;
531: PETSC_EXTERN PetscClassId SNESLINESEARCH_CLASSID;
532: PETSC_EXTERN PetscFunctionList SNESLineSearchList;
534: #define SNES_LINESEARCH_ORDER_LINEAR 1
535: #define SNES_LINESEARCH_ORDER_QUADRATIC 2
536: #define SNES_LINESEARCH_ORDER_CUBIC 3
538: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchVIProjectFunc)(SNES,Vec);
539: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchVINormFunc)(SNES,Vec,Vec,PetscReal *);
540: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchApplyFunc)(SNESLineSearch);
541: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchUserFunc)(SNESLineSearch, void *);
543: PETSC_EXTERN PetscErrorCode SNESLineSearchCreate(MPI_Comm, SNESLineSearch*);
544: PETSC_EXTERN PetscErrorCode SNESLineSearchReset(SNESLineSearch);
545: PETSC_EXTERN PetscErrorCode SNESLineSearchView(SNESLineSearch,PetscViewer);
546: PETSC_EXTERN PetscErrorCode SNESLineSearchDestroy(SNESLineSearch *);
547: PETSC_EXTERN PetscErrorCode SNESLineSearchSetType(SNESLineSearch, SNESLineSearchType);
548: PETSC_EXTERN PetscErrorCode SNESLineSearchSetFromOptions(SNESLineSearch);
549: PETSC_EXTERN PetscErrorCode SNESLineSearchSetFunction(SNESLineSearch,PetscErrorCode (*)(SNES,Vec,Vec));
550: PETSC_EXTERN PetscErrorCode SNESLineSearchSetUp(SNESLineSearch);
551: PETSC_EXTERN PetscErrorCode SNESLineSearchApply(SNESLineSearch, Vec, Vec, PetscReal *, Vec);
552: PETSC_EXTERN PetscErrorCode SNESLineSearchPreCheck(SNESLineSearch,Vec,Vec,PetscBool *);
553: PETSC_EXTERN PetscErrorCode SNESLineSearchPostCheck(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *);
554: PETSC_EXTERN PetscErrorCode SNESLineSearchSetWorkVecs(SNESLineSearch, PetscInt);
556: /* set the functions for precheck and postcheck */
558: PETSC_EXTERN PetscErrorCode SNESLineSearchSetPreCheck(SNESLineSearch, PetscErrorCode (*)(SNESLineSearch,Vec,Vec,PetscBool*,void*), void *ctx);
559: PETSC_EXTERN PetscErrorCode SNESLineSearchSetPostCheck(SNESLineSearch, PetscErrorCode (*)(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *,void*), void *ctx);
561: PETSC_EXTERN PetscErrorCode SNESLineSearchGetPreCheck(SNESLineSearch, PetscErrorCode (**)(SNESLineSearch,Vec,Vec,PetscBool*,void*), void **ctx);
562: PETSC_EXTERN PetscErrorCode SNESLineSearchGetPostCheck(SNESLineSearch, PetscErrorCode (**)(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *,void*), void **ctx);
564: /* set the functions for VI-specific line search operations */
566: PETSC_EXTERN PetscErrorCode SNESLineSearchSetVIFunctions(SNESLineSearch, SNESLineSearchVIProjectFunc, SNESLineSearchVINormFunc);
567: PETSC_EXTERN PetscErrorCode SNESLineSearchGetVIFunctions(SNESLineSearch, SNESLineSearchVIProjectFunc*, SNESLineSearchVINormFunc*);
569: /* pointers to the associated SNES in order to be able to get the function evaluation out */
570: PETSC_EXTERN PetscErrorCode SNESLineSearchSetSNES(SNESLineSearch,SNES);
571: PETSC_EXTERN PetscErrorCode SNESLineSearchGetSNES(SNESLineSearch,SNES*);
573: /* set and get the parameters and vectors */
574: PETSC_EXTERN PetscErrorCode SNESLineSearchGetTolerances(SNESLineSearch,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscInt*);
575: PETSC_EXTERN PetscErrorCode SNESLineSearchSetTolerances(SNESLineSearch,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscInt);
577: PETSC_EXTERN PetscErrorCode SNESLineSearchPreCheckPicard(SNESLineSearch,Vec,Vec,PetscBool*,void*);
579: PETSC_EXTERN PetscErrorCode SNESLineSearchGetLambda(SNESLineSearch,PetscReal*);
580: PETSC_EXTERN PetscErrorCode SNESLineSearchSetLambda(SNESLineSearch,PetscReal);
582: PETSC_EXTERN PetscErrorCode SNESLineSearchGetDamping(SNESLineSearch,PetscReal*);
583: PETSC_EXTERN PetscErrorCode SNESLineSearchSetDamping(SNESLineSearch,PetscReal);
585: PETSC_EXTERN PetscErrorCode SNESLineSearchGetOrder(SNESLineSearch,PetscInt *order);
586: PETSC_EXTERN PetscErrorCode SNESLineSearchSetOrder(SNESLineSearch,PetscInt order);
588: /*E
589: SNESLineSearchReason - if line search has succeeded or failed and why
591: Level: intermediate
593: Developer Notes: this must match petsc/finclude/petscsnes.h
595: Developer Note: The string versions of these are in SNESLineSearchReasons, if you change any value here you must
596: also adjust that array.
598: .seealso: SNESSolve(), SNESGetConvergedReason(), KSPConvergedReason, SNESSetConvergenceTest()
599: E*/
600: typedef enum {SNES_LINESEARCH_SUCCEEDED,
601: SNES_LINESEARCH_FAILED_NANORINF,
602: SNES_LINESEARCH_FAILED_DOMAIN,
603: SNES_LINESEARCH_FAILED_REDUCT, /* INSUFFICENT REDUCTION */
604: SNES_LINESEARCH_FAILED_USER,
605: SNES_LINESEARCH_FAILED_FUNCTION} SNESLineSearchReason;
607: PETSC_EXTERN PetscErrorCode SNESLineSearchGetReason(SNESLineSearch, SNESLineSearchReason*);
608: PETSC_EXTERN PetscErrorCode SNESLineSearchSetReason(SNESLineSearch, SNESLineSearchReason);
610: PETSC_EXTERN PetscErrorCode SNESLineSearchGetVecs(SNESLineSearch,Vec*,Vec*,Vec*,Vec*,Vec*);
611: PETSC_EXTERN PetscErrorCode SNESLineSearchSetVecs(SNESLineSearch,Vec,Vec,Vec,Vec,Vec);
613: PETSC_EXTERN PetscErrorCode SNESLineSearchGetNorms(SNESLineSearch, PetscReal *, PetscReal *, PetscReal *);
614: PETSC_EXTERN PetscErrorCode SNESLineSearchSetNorms(SNESLineSearch, PetscReal, PetscReal, PetscReal);
615: PETSC_EXTERN PetscErrorCode SNESLineSearchComputeNorms(SNESLineSearch);
616: PETSC_EXTERN PetscErrorCode SNESLineSearchSetComputeNorms(SNESLineSearch, PetscBool);
618: PETSC_EXTERN PetscErrorCode SNESLineSearchMonitor(SNESLineSearch);
619: PETSC_EXTERN PetscErrorCode SNESLineSearchMonitorSet(SNESLineSearch,PetscErrorCode(*)(SNESLineSearch,void*),void *,PetscErrorCode (*)(void**));
620: PETSC_EXTERN PetscErrorCode SNESLineSearchMonitorSetFromOptions(SNESLineSearch,const char[],const char[],const char[],PetscErrorCode (*)(SNESLineSearch,PetscViewerAndFormat*),PetscErrorCode (*)(SNESLineSearch,PetscViewerAndFormat*));
621: PETSC_EXTERN PetscErrorCode SNESLineSearchMonitorCancel(SNESLineSearch);
622: PETSC_EXTERN PetscErrorCode SNESLineSearchMonitorUpdate(SNESLineSearch,PetscViewerAndFormat*);
623: PETSC_EXTERN PetscErrorCode SNESLineSearchSetDefaultMonitor(SNESLineSearch,PetscViewer);
624: PETSC_EXTERN PetscErrorCode SNESLineSearchGetDefaultMonitor(SNESLineSearch,PetscViewer*);
625: PETSC_EXTERN PetscErrorCode SNESLineSearchMonitorSolutionUpdate(SNESLineSearch,PetscViewerAndFormat*);
627: PETSC_EXTERN PetscErrorCode SNESLineSearchAppendOptionsPrefix(SNESLineSearch, const char prefix[]);
628: PETSC_EXTERN PetscErrorCode SNESLineSearchGetOptionsPrefix(SNESLineSearch, const char *prefix[]);
631: /* Shell interface functions */
632: PETSC_EXTERN PetscErrorCode SNESLineSearchShellSetUserFunc(SNESLineSearch,SNESLineSearchUserFunc,void*);
633: PETSC_EXTERN PetscErrorCode SNESLineSearchShellGetUserFunc(SNESLineSearch,SNESLineSearchUserFunc*,void**);
635: /* BT interface functions */
636: PETSC_EXTERN PetscErrorCode SNESLineSearchBTSetAlpha(SNESLineSearch, PetscReal);
637: PETSC_EXTERN PetscErrorCode SNESLineSearchBTGetAlpha(SNESLineSearch, PetscReal*);
639: /*register line search types */
640: PETSC_EXTERN PetscErrorCode SNESLineSearchRegister(const char[],PetscErrorCode(*)(SNESLineSearch));
642: /* Routines for VI solver */
643: PETSC_EXTERN PetscErrorCode SNESVISetVariableBounds(SNES,Vec,Vec);
644: PETSC_EXTERN PetscErrorCode SNESVISetComputeVariableBounds(SNES, PetscErrorCode (*)(SNES,Vec,Vec));
645: PETSC_EXTERN PetscErrorCode SNESVIGetInactiveSet(SNES,IS*);
646: PETSC_EXTERN PetscErrorCode SNESVIGetActiveSetIS(SNES,Vec,Vec,IS*);
647: PETSC_EXTERN PetscErrorCode SNESVIComputeInactiveSetFnorm(SNES,Vec,Vec,PetscReal*);
648: PETSC_EXTERN PetscErrorCode SNESVISetRedundancyCheck(SNES,PetscErrorCode(*)(SNES,IS,IS*,void*),void*);
650: PETSC_EXTERN PetscErrorCode SNESTestLocalMin(SNES);
652: /* Should this routine be private? */
653: PETSC_EXTERN PetscErrorCode SNESComputeJacobian(SNES,Vec,Mat,Mat);
654: PETSC_EXTERN PetscErrorCode SNESTestJacobian(SNES);
656: PETSC_EXTERN PetscErrorCode SNESSetDM(SNES,DM);
657: PETSC_EXTERN PetscErrorCode SNESGetDM(SNES,DM*);
658: PETSC_EXTERN PetscErrorCode SNESSetNPC(SNES,SNES);
659: PETSC_EXTERN PetscErrorCode SNESGetNPC(SNES,SNES*);
660: PETSC_EXTERN PetscErrorCode SNESHasNPC(SNES,PetscBool*);
661: PETSC_EXTERN PetscErrorCode SNESApplyNPC(SNES,Vec,Vec,Vec);
662: PETSC_EXTERN PetscErrorCode SNESGetNPCFunction(SNES,Vec,PetscReal*);
663: PETSC_EXTERN PetscErrorCode SNESComputeFunctionDefaultNPC(SNES,Vec,Vec);
664: PETSC_EXTERN PetscErrorCode SNESSetNPCSide(SNES,PCSide);
665: PETSC_EXTERN PetscErrorCode SNESGetNPCSide(SNES,PCSide*);
666: PETSC_EXTERN PetscErrorCode SNESSetLineSearch(SNES,SNESLineSearch);
667: PETSC_EXTERN PetscErrorCode SNESGetLineSearch(SNES,SNESLineSearch*);
668: PETSC_EXTERN PetscErrorCode SNESRestrictHookAdd(SNES,PetscErrorCode (*)(SNES,SNES,void*),void*);
669: PETSC_EXTERN PetscErrorCode SNESRestrictHooksRun(SNES,SNES);
671: PETSC_DEPRECATED("Use SNESGetLineSearch()") PETSC_STATIC_INLINE PetscErrorCode SNESGetSNESLineSearch(SNES snes,SNESLineSearch *ls) {return SNESGetLineSearch(snes,ls);}
672: PETSC_DEPRECATED("Use SNESSetLineSearch()") PETSC_STATIC_INLINE PetscErrorCode SNESSetSNESLineSearch(SNES snes,SNESLineSearch ls) {return SNESSetLineSearch(snes,ls);}
674: PETSC_EXTERN PetscErrorCode SNESSetUpMatrices(SNES);
675: PETSC_EXTERN PetscErrorCode DMSNESSetFunction(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),void*);
676: PETSC_EXTERN PetscErrorCode DMSNESGetFunction(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),void**);
677: PETSC_EXTERN PetscErrorCode DMSNESSetNGS(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),void*);
678: PETSC_EXTERN PetscErrorCode DMSNESGetNGS(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),void**);
679: PETSC_EXTERN PetscErrorCode DMSNESSetJacobian(DM,PetscErrorCode(*)(SNES,Vec,Mat,Mat,void*),void*);
680: PETSC_EXTERN PetscErrorCode DMSNESGetJacobian(DM,PetscErrorCode(**)(SNES,Vec,Mat,Mat,void*),void**);
681: PETSC_EXTERN PetscErrorCode DMSNESSetPicard(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),PetscErrorCode(*)(SNES,Vec,Mat,Mat,void*),void*);
682: PETSC_EXTERN PetscErrorCode DMSNESGetPicard(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),PetscErrorCode(**)(SNES,Vec,Mat,Mat,void*),void**);
683: PETSC_EXTERN PetscErrorCode DMSNESSetObjective(DM,PetscErrorCode (*)(SNES,Vec,PetscReal *,void*),void*);
684: PETSC_EXTERN PetscErrorCode DMSNESGetObjective(DM,PetscErrorCode (**)(SNES,Vec,PetscReal *,void*),void**);
685: PETSC_EXTERN PetscErrorCode DMCopyDMSNES(DM,DM);
687: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESFunction)(DMDALocalInfo*,void*,void*,void*);
688: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESJacobian)(DMDALocalInfo*,void*,Mat,Mat,void*);
689: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESObjective)(DMDALocalInfo*,void*,PetscReal*,void*);
691: PETSC_EXTERN PetscErrorCode DMDASNESSetFunctionLocal(DM,InsertMode,DMDASNESFunction,void*);
692: PETSC_EXTERN PetscErrorCode DMDASNESSetJacobianLocal(DM,DMDASNESJacobian,void*);
693: PETSC_EXTERN PetscErrorCode DMDASNESSetObjectiveLocal(DM,DMDASNESObjective,void*);
694: PETSC_EXTERN PetscErrorCode DMDASNESSetPicardLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,void*,void*,void*),PetscErrorCode (*)(DMDALocalInfo*,void*,Mat,Mat,void*),void*);
696: PETSC_EXTERN PetscErrorCode DMPlexSNESGetGeometryFEM(DM,Vec*);
697: PETSC_EXTERN PetscErrorCode DMPlexSNESGetGeometryFVM(DM,Vec*,Vec*,PetscReal*);
698: PETSC_EXTERN PetscErrorCode DMPlexSNESGetGradientDM(DM,PetscFV,DM*);
699: PETSC_EXTERN PetscErrorCode DMPlexGetCellFields(DM, PetscInt, PetscInt, Vec, Vec, Vec, PetscScalar **, PetscScalar **, PetscScalar **);
700: PETSC_EXTERN PetscErrorCode DMPlexRestoreCellFields(DM, PetscInt, PetscInt, Vec, Vec, Vec, PetscScalar **, PetscScalar **, PetscScalar **);
701: PETSC_EXTERN PetscErrorCode DMPlexGetFaceFields(DM, PetscInt, PetscInt, Vec, Vec, Vec, Vec, Vec, PetscInt *, PetscScalar **, PetscScalar **);
702: PETSC_EXTERN PetscErrorCode DMPlexRestoreFaceFields(DM, PetscInt, PetscInt, Vec, Vec, Vec, Vec, Vec, PetscInt *, PetscScalar **, PetscScalar **);
703: PETSC_EXTERN PetscErrorCode DMPlexGetFaceGeometry(DM, PetscInt, PetscInt, Vec, Vec, PetscInt *, PetscFVFaceGeom **, PetscReal **);
704: PETSC_EXTERN PetscErrorCode DMPlexRestoreFaceGeometry(DM, PetscInt, PetscInt, Vec, Vec, PetscInt *, PetscFVFaceGeom **, PetscReal **);
706: PETSC_EXTERN PetscErrorCode DMSNESSetBoundaryLocal(DM,PetscErrorCode (*)(DM,Vec,void*),void*);
707: PETSC_EXTERN PetscErrorCode DMSNESSetFunctionLocal(DM,PetscErrorCode (*)(DM,Vec,Vec,void*),void*);
708: PETSC_EXTERN PetscErrorCode DMSNESSetJacobianLocal(DM,PetscErrorCode (*)(DM,Vec,Mat,Mat,void*),void*);
710: /* Routines for Multiblock solver */
711: PETSC_EXTERN PetscErrorCode SNESMultiblockSetFields(SNES, const char [], PetscInt, const PetscInt *);
712: PETSC_EXTERN PetscErrorCode SNESMultiblockSetIS(SNES, const char [], IS);
713: PETSC_EXTERN PetscErrorCode SNESMultiblockSetBlockSize(SNES, PetscInt);
714: PETSC_EXTERN PetscErrorCode SNESMultiblockSetType(SNES, PCCompositeType);
716: /*J
717: SNESMSType - String with the name of a PETSc SNESMS method.
719: Level: intermediate
721: .seealso: SNESMSSetType(), SNES
722: J*/
723: typedef const char* SNESMSType;
724: #define SNESMSM62 "m62"
725: #define SNESMSEULER "euler"
726: #define SNESMSJAMESON83 "jameson83"
727: #define SNESMSVLTP21 "vltp21"
728: #define SNESMSVLTP31 "vltp31"
729: #define SNESMSVLTP41 "vltp41"
730: #define SNESMSVLTP51 "vltp51"
731: #define SNESMSVLTP61 "vltp61"
733: PETSC_EXTERN PetscErrorCode SNESMSRegister(SNESMSType,PetscInt,PetscInt,PetscReal,const PetscReal[],const PetscReal[],const PetscReal[]);
734: PETSC_EXTERN PetscErrorCode SNESMSSetType(SNES,SNESMSType);
735: PETSC_EXTERN PetscErrorCode SNESMSFinalizePackage(void);
736: PETSC_EXTERN PetscErrorCode SNESMSInitializePackage(void);
737: PETSC_EXTERN PetscErrorCode SNESMSRegisterDestroy(void);
739: /* routines for NGMRES solver */
741: typedef enum {
742: SNES_NGMRES_RESTART_NONE = 0,
743: SNES_NGMRES_RESTART_PERIODIC = 1,
744: SNES_NGMRES_RESTART_DIFFERENCE = 2} SNESNGMRESRestartType;
745: PETSC_EXTERN const char *const SNESNGMRESRestartTypes[];
747: typedef enum {
748: SNES_NGMRES_SELECT_NONE = 0,
749: SNES_NGMRES_SELECT_DIFFERENCE = 1,
750: SNES_NGMRES_SELECT_LINESEARCH = 2} SNESNGMRESSelectType;
751: PETSC_EXTERN const char *const SNESNGMRESSelectTypes[];
753: PETSC_EXTERN PetscErrorCode SNESNGMRESSetRestartType(SNES, SNESNGMRESRestartType);
754: PETSC_EXTERN PetscErrorCode SNESNGMRESSetSelectType(SNES, SNESNGMRESSelectType);
755: PETSC_EXTERN PetscErrorCode SNESNGMRESSetRestartFmRise(SNES, PetscBool);
756: PETSC_EXTERN PetscErrorCode SNESNGMRESGetRestartFmRise(SNES, PetscBool*);
758: /* routines for NCG solver */
760: typedef enum {
761: SNES_NCG_FR = 0,
762: SNES_NCG_PRP = 1,
763: SNES_NCG_HS = 2,
764: SNES_NCG_DY = 3,
765: SNES_NCG_CD = 4} SNESNCGType;
766: PETSC_EXTERN const char *const SNESNCGTypes[];
768: PETSC_EXTERN PetscErrorCode SNESNCGSetType(SNES, SNESNCGType);
770: typedef enum {SNES_QN_SCALE_DEFAULT = 0,
771: SNES_QN_SCALE_NONE = 1,
772: SNES_QN_SCALE_SHANNO = 2,
773: SNES_QN_SCALE_LINESEARCH = 3,
774: SNES_QN_SCALE_JACOBIAN = 4} SNESQNScaleType;
775: PETSC_EXTERN const char *const SNESQNScaleTypes[];
776: typedef enum {SNES_QN_RESTART_DEFAULT = 0,
777: SNES_QN_RESTART_NONE = 1,
778: SNES_QN_RESTART_POWELL = 2,
779: SNES_QN_RESTART_PERIODIC = 3} SNESQNRestartType;
780: PETSC_EXTERN const char *const SNESQNRestartTypes[];
781: typedef enum {SNES_QN_LBFGS = 0,
782: SNES_QN_BROYDEN = 1,
783: SNES_QN_BADBROYDEN = 2
784: } SNESQNType;
785: PETSC_EXTERN const char *const SNESQNTypes[];
787: PETSC_EXTERN PetscErrorCode SNESQNSetType(SNES, SNESQNType);
788: PETSC_EXTERN PetscErrorCode SNESQNSetScaleType(SNES, SNESQNScaleType);
789: PETSC_EXTERN PetscErrorCode SNESQNSetRestartType(SNES, SNESQNRestartType);
791: PETSC_EXTERN PetscErrorCode SNESNASMGetType(SNES,PCASMType*);
792: PETSC_EXTERN PetscErrorCode SNESNASMSetType(SNES,PCASMType);
793: PETSC_EXTERN PetscErrorCode SNESNASMGetSubdomains(SNES,PetscInt*,SNES**,VecScatter**,VecScatter**,VecScatter**);
794: PETSC_EXTERN PetscErrorCode SNESNASMSetSubdomains(SNES,PetscInt,SNES*,VecScatter*,VecScatter*,VecScatter*);
795: PETSC_EXTERN PetscErrorCode SNESNASMSetDamping(SNES,PetscReal);
796: PETSC_EXTERN PetscErrorCode SNESNASMGetDamping(SNES,PetscReal*);
797: PETSC_EXTERN PetscErrorCode SNESNASMGetSubdomainVecs(SNES,PetscInt*,Vec**,Vec**,Vec**,Vec**);
798: PETSC_EXTERN PetscErrorCode SNESNASMSetComputeFinalJacobian(SNES,PetscBool);
799: PETSC_EXTERN PetscErrorCode SNESNASMGetSNES(SNES,PetscInt,SNES *);
800: PETSC_EXTERN PetscErrorCode SNESNASMGetNumber(SNES,PetscInt*);
801: PETSC_EXTERN PetscErrorCode SNESNASMSetWeight(SNES,Vec);
803: typedef enum {SNES_COMPOSITE_ADDITIVE,SNES_COMPOSITE_MULTIPLICATIVE,SNES_COMPOSITE_ADDITIVEOPTIMAL} SNESCompositeType;
804: PETSC_EXTERN const char *const SNESCompositeTypes[];
806: PETSC_EXTERN PetscErrorCode SNESCompositeSetType(SNES,SNESCompositeType);
807: PETSC_EXTERN PetscErrorCode SNESCompositeAddSNES(SNES,SNESType);
808: PETSC_EXTERN PetscErrorCode SNESCompositeGetSNES(SNES,PetscInt,SNES *);
809: PETSC_EXTERN PetscErrorCode SNESCompositeGetNumber(SNES,PetscInt*);
810: PETSC_EXTERN PetscErrorCode SNESCompositeSetDamping(SNES,PetscInt,PetscReal);
812: /*E
813: SNESFASType - Determines the type of nonlinear multigrid method that is run.
815: Level: beginner
817: Values:
818: + SNES_FAS_MULTIPLICATIVE (default) - traditional V or W cycle as determined by SNESFASSetCycles()
819: . SNES_FAS_ADDITIVE - additive FAS cycle
820: . SNES_FAS_FULL - full FAS cycle
821: - SNES_FAS_KASKADE - Kaskade FAS cycle
822: .seealso: PCMGSetType(), PCMGType
824: E*/
825: typedef enum { SNES_FAS_MULTIPLICATIVE, SNES_FAS_ADDITIVE, SNES_FAS_FULL, SNES_FAS_KASKADE } SNESFASType;
826: PETSC_EXTERN const char *const SNESFASTypes[];
828: /* called on the finest level FAS instance*/
829: PETSC_EXTERN PetscErrorCode SNESFASSetType(SNES, SNESFASType);
830: PETSC_EXTERN PetscErrorCode SNESFASGetType(SNES, SNESFASType*);
831: PETSC_EXTERN PetscErrorCode SNESFASSetLevels(SNES, PetscInt, MPI_Comm *);
832: PETSC_EXTERN PetscErrorCode SNESFASGetLevels(SNES, PetscInt *);
833: PETSC_EXTERN PetscErrorCode SNESFASGetCycleSNES(SNES, PetscInt, SNES*);
834: PETSC_EXTERN PetscErrorCode SNESFASSetNumberSmoothUp(SNES, PetscInt);
835: PETSC_EXTERN PetscErrorCode SNESFASSetNumberSmoothDown(SNES, PetscInt);
836: PETSC_EXTERN PetscErrorCode SNESFASSetCycles(SNES, PetscInt);
837: PETSC_EXTERN PetscErrorCode SNESFASSetMonitor(SNES, PetscViewerAndFormat *, PetscBool);
838: PETSC_EXTERN PetscErrorCode SNESFASSetLog(SNES, PetscBool);
840: PETSC_EXTERN PetscErrorCode SNESFASSetGalerkin(SNES, PetscBool);
841: PETSC_EXTERN PetscErrorCode SNESFASGetGalerkin(SNES, PetscBool*);
843: /* called on any level -- "Cycle" FAS instance */
844: PETSC_EXTERN PetscErrorCode SNESFASCycleGetSmoother(SNES, SNES*);
845: PETSC_EXTERN PetscErrorCode SNESFASCycleGetSmootherUp(SNES, SNES*);
846: PETSC_EXTERN PetscErrorCode SNESFASCycleGetSmootherDown(SNES, SNES*);
847: PETSC_EXTERN PetscErrorCode SNESFASCycleGetCorrection(SNES, SNES*);
848: PETSC_EXTERN PetscErrorCode SNESFASCycleGetInterpolation(SNES, Mat*);
849: PETSC_EXTERN PetscErrorCode SNESFASCycleGetRestriction(SNES, Mat*);
850: PETSC_EXTERN PetscErrorCode SNESFASCycleGetInjection(SNES, Mat*);
851: PETSC_EXTERN PetscErrorCode SNESFASCycleGetRScale(SNES, Vec*);
852: PETSC_EXTERN PetscErrorCode SNESFASCycleSetCycles(SNES, PetscInt);
853: PETSC_EXTERN PetscErrorCode SNESFASCycleIsFine(SNES, PetscBool*);
855: /* called on the (outer) finest level FAS to set/get parameters on any level instance */
856: PETSC_EXTERN PetscErrorCode SNESFASSetInterpolation(SNES, PetscInt, Mat);
857: PETSC_EXTERN PetscErrorCode SNESFASGetInterpolation(SNES, PetscInt, Mat*);
858: PETSC_EXTERN PetscErrorCode SNESFASSetRestriction(SNES, PetscInt, Mat);
859: PETSC_EXTERN PetscErrorCode SNESFASGetRestriction(SNES, PetscInt, Mat*);
860: PETSC_EXTERN PetscErrorCode SNESFASSetInjection(SNES, PetscInt, Mat);
861: PETSC_EXTERN PetscErrorCode SNESFASGetInjection(SNES, PetscInt, Mat*);
862: PETSC_EXTERN PetscErrorCode SNESFASSetRScale(SNES, PetscInt, Vec);
863: PETSC_EXTERN PetscErrorCode SNESFASGetRScale(SNES, PetscInt, Vec*);
864: PETSC_EXTERN PetscErrorCode SNESFASSetContinuation(SNES,PetscBool);
866: PETSC_EXTERN PetscErrorCode SNESFASGetSmoother(SNES, PetscInt, SNES*);
867: PETSC_EXTERN PetscErrorCode SNESFASGetSmootherUp(SNES, PetscInt, SNES*);
868: PETSC_EXTERN PetscErrorCode SNESFASGetSmootherDown(SNES, PetscInt, SNES*);
869: PETSC_EXTERN PetscErrorCode SNESFASGetCoarseSolve(SNES, SNES*);
871: /* parameters for full FAS */
872: PETSC_EXTERN PetscErrorCode SNESFASFullSetDownSweep(SNES,PetscBool);
873: PETSC_EXTERN PetscErrorCode SNESFASCreateCoarseVec(SNES,Vec*);
874: PETSC_EXTERN PetscErrorCode SNESFASRestrict(SNES,Vec,Vec);
876: PETSC_EXTERN PetscErrorCode DMSNESCheckFromOptions(SNES,Vec,PetscErrorCode (**)(PetscInt,PetscReal,const PetscReal[],PetscInt,PetscScalar*,void*),void**);
878: #endif