Actual source code: petscsnes.h
petsc-3.14.6 2021-03-30
1: /*
2: User interface for the nonlinear solvers package.
3: */
4: #if !defined(PETSCSNES_H)
5: #define PETSCSNES_H
6: #include <petscksp.h>
7: #include <petscdmtypes.h>
8: #include <petscfvtypes.h>
9: #include <petscdmdatypes.h>
11: /*S
12: SNES - Abstract PETSc object that manages all nonlinear solves
14: Level: beginner
16: .seealso: SNESCreate(), SNESSetType(), SNESType, TS, KSP, KSP, PC, SNESDestroy()
17: S*/
18: typedef struct _p_SNES* SNES;
20: /*J
21: SNESType - String with the name of a PETSc SNES method.
23: Level: beginner
25: .seealso: SNESSetType(), SNES, SNESCreate(), SNESDestroy(), SNESSetFromOptions()
26: J*/
27: typedef const char* SNESType;
28: #define SNESNEWTONLS "newtonls"
29: #define SNESNEWTONTR "newtontr"
30: #define SNESPYTHON "python"
31: #define SNESNRICHARDSON "nrichardson"
32: #define SNESKSPONLY "ksponly"
33: #define SNESKSPTRANSPOSEONLY "ksptransposeonly"
34: #define SNESVINEWTONRSLS "vinewtonrsls"
35: #define SNESVINEWTONSSLS "vinewtonssls"
36: #define SNESNGMRES "ngmres"
37: #define SNESQN "qn"
38: #define SNESSHELL "shell"
39: #define SNESNGS "ngs"
40: #define SNESNCG "ncg"
41: #define SNESFAS "fas"
42: #define SNESMS "ms"
43: #define SNESNASM "nasm"
44: #define SNESANDERSON "anderson"
45: #define SNESASPIN "aspin"
46: #define SNESCOMPOSITE "composite"
47: #define SNESPATCH "patch"
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 SNESMonitorSetFromOptions(SNES,const char[],const char[],const char [],PetscErrorCode (*)(SNES,PetscInt,PetscReal,PetscViewerAndFormat*),PetscErrorCode (*)(SNES,PetscViewerAndFormat*));
62: PETSC_EXTERN PetscErrorCode SNESMonitorCancel(SNES);
63: PETSC_EXTERN PetscErrorCode SNESMonitorSAWs(SNES,PetscInt,PetscReal,void*);
64: PETSC_EXTERN PetscErrorCode SNESMonitorSAWsCreate(SNES,void**);
65: PETSC_EXTERN PetscErrorCode SNESMonitorSAWsDestroy(void**);
66: PETSC_EXTERN PetscErrorCode SNESSetConvergenceHistory(SNES,PetscReal[],PetscInt[],PetscInt,PetscBool);
67: PETSC_EXTERN PetscErrorCode SNESGetConvergenceHistory(SNES,PetscReal*[],PetscInt *[],PetscInt *);
68: PETSC_EXTERN PetscErrorCode SNESSetUp(SNES);
69: PETSC_EXTERN PetscErrorCode SNESSolve(SNES,Vec,Vec);
70: PETSC_EXTERN PetscErrorCode SNESSetErrorIfNotConverged(SNES,PetscBool);
71: PETSC_EXTERN PetscErrorCode SNESGetErrorIfNotConverged(SNES,PetscBool *);
73: PETSC_EXTERN PetscErrorCode SNESSetWorkVecs(SNES,PetscInt);
75: PETSC_EXTERN PetscErrorCode SNESAddOptionsChecker(PetscErrorCode (*)(SNES));
77: PETSC_EXTERN PetscErrorCode SNESSetUpdate(SNES, PetscErrorCode (*)(SNES, PetscInt));
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 SNESSetSolution(SNES,Vec);
85: PETSC_EXTERN PetscErrorCode SNESGetSolution(SNES,Vec*);
86: PETSC_EXTERN PetscErrorCode SNESGetSolutionUpdate(SNES,Vec*);
87: PETSC_EXTERN PetscErrorCode SNESGetRhs(SNES,Vec*);
88: PETSC_EXTERN PetscErrorCode SNESView(SNES,PetscViewer);
89: PETSC_EXTERN PetscErrorCode SNESLoad(SNES,PetscViewer);
90: PETSC_EXTERN PetscErrorCode SNESViewFromOptions(SNES,PetscObject,const char[]);
91: PETSC_EXTERN PetscErrorCode SNESConvergedReasonView(SNES,PetscViewer);
92: PETSC_EXTERN PetscErrorCode SNESConvergedReasonViewFromOptions(SNES);
94: PETSC_DEPRECATED_FUNCTION("Use SNESConvergedReasonView() (since version 3.14)") PETSC_STATIC_INLINE PetscErrorCode SNESReasonView(SNES snes,PetscViewer v) {return SNESConvergedReasonView(snes,v);}
95: PETSC_DEPRECATED_FUNCTION("Use SNESConvergedReasonViewFromOptions() (since version 3.14)") PETSC_STATIC_INLINE PetscErrorCode SNESReasonViewFromOptions(SNES snes) {return SNESConvergedReasonViewFromOptions(snes);}
97: #define SNES_FILE_CLASSID 1211224
99: PETSC_EXTERN PetscErrorCode SNESSetOptionsPrefix(SNES,const char[]);
100: PETSC_EXTERN PetscErrorCode SNESAppendOptionsPrefix(SNES,const char[]);
101: PETSC_EXTERN PetscErrorCode SNESGetOptionsPrefix(SNES,const char*[]);
102: PETSC_EXTERN PetscErrorCode SNESSetFromOptions(SNES);
103: PETSC_EXTERN PetscErrorCode SNESResetFromOptions(SNES);
105: PETSC_EXTERN PetscErrorCode SNESSetUseMatrixFree(SNES,PetscBool,PetscBool);
106: PETSC_EXTERN PetscErrorCode SNESGetUseMatrixFree(SNES,PetscBool*,PetscBool*);
107: PETSC_EXTERN PetscErrorCode MatCreateSNESMF(SNES,Mat*);
108: PETSC_EXTERN PetscErrorCode MatSNESMFGetSNES(Mat,SNES*);
109: PETSC_EXTERN PetscErrorCode MatSNESMFSetReuseBase(Mat,PetscBool);
110: PETSC_EXTERN PetscErrorCode MatSNESMFGetReuseBase(Mat,PetscBool*);
111: PETSC_EXTERN PetscErrorCode MatMFFDComputeJacobian(SNES,Vec,Mat,Mat,void*);
113: PETSC_EXTERN PetscErrorCode SNESGetType(SNES,SNESType*);
114: PETSC_EXTERN PetscErrorCode SNESMonitorDefault(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
115: PETSC_EXTERN PetscErrorCode SNESMonitorScaling(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
116: PETSC_EXTERN PetscErrorCode SNESMonitorRange(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
117: PETSC_EXTERN PetscErrorCode SNESMonitorRatio(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
118: PETSC_EXTERN PetscErrorCode SNESMonitorRatioSetUp(SNES,PetscViewerAndFormat*);
119: PETSC_EXTERN PetscErrorCode SNESMonitorSolution(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
120: PETSC_EXTERN PetscErrorCode SNESMonitorResidual(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
121: PETSC_EXTERN PetscErrorCode SNESMonitorSolutionUpdate(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
122: PETSC_EXTERN PetscErrorCode SNESMonitorDefaultShort(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
123: PETSC_EXTERN PetscErrorCode SNESMonitorDefaultField(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
124: PETSC_EXTERN PetscErrorCode SNESMonitorJacUpdateSpectrum(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
125: PETSC_EXTERN PetscErrorCode SNESMonitorFields(SNES,PetscInt,PetscReal,PetscViewerAndFormat *);
126: PETSC_EXTERN PetscErrorCode KSPMonitorSNES(KSP,PetscInt,PetscReal,void*);
127: PETSC_EXTERN PetscErrorCode KSPMonitorSNESLGResidualNormCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscObject**);
128: PETSC_EXTERN PetscErrorCode KSPMonitorSNESLGResidualNorm(KSP,PetscInt,PetscReal,PetscObject*);
129: PETSC_EXTERN PetscErrorCode KSPMonitorSNESLGResidualNormDestroy(PetscObject**);
131: PETSC_EXTERN PetscErrorCode SNESSetTolerances(SNES,PetscReal,PetscReal,PetscReal,PetscInt,PetscInt);
132: PETSC_EXTERN PetscErrorCode SNESSetDivergenceTolerance(SNES,PetscReal);
133: PETSC_EXTERN PetscErrorCode SNESGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,PetscInt*,PetscInt*);
134: PETSC_EXTERN PetscErrorCode SNESGetDivergenceTolerance(SNES,PetscReal*);
135: PETSC_EXTERN PetscErrorCode SNESSetTrustRegionTolerance(SNES,PetscReal);
136: PETSC_EXTERN PetscErrorCode SNESGetForceIteration(SNES,PetscBool*);
137: PETSC_EXTERN PetscErrorCode SNESSetForceIteration(SNES,PetscBool);
138: PETSC_EXTERN PetscErrorCode SNESGetIterationNumber(SNES,PetscInt*);
139: PETSC_EXTERN PetscErrorCode SNESSetIterationNumber(SNES,PetscInt);
141: PETSC_EXTERN PetscErrorCode SNESNewtonTRSetPreCheck(SNES, PetscErrorCode (*)(SNES,Vec,Vec,PetscBool*,void*),void *ctx);
142: PETSC_EXTERN PetscErrorCode SNESNewtonTRGetPreCheck(SNES, PetscErrorCode (**)(SNES,Vec,Vec,PetscBool*,void*),void **ctx);
143: PETSC_EXTERN PetscErrorCode SNESNewtonTRSetPostCheck(SNES, PetscErrorCode (*)(SNES,Vec,Vec,Vec,PetscBool*,PetscBool*,void*),void *ctx);
144: PETSC_EXTERN PetscErrorCode SNESNewtonTRGetPostCheck(SNES, PetscErrorCode (**)(SNES,Vec,Vec,Vec,PetscBool*,PetscBool*,void*),void **ctx);
146: PETSC_EXTERN PetscErrorCode SNESGetNonlinearStepFailures(SNES,PetscInt*);
147: PETSC_EXTERN PetscErrorCode SNESSetMaxNonlinearStepFailures(SNES,PetscInt);
148: PETSC_EXTERN PetscErrorCode SNESGetMaxNonlinearStepFailures(SNES,PetscInt*);
149: PETSC_EXTERN PetscErrorCode SNESGetNumberFunctionEvals(SNES,PetscInt*);
151: PETSC_EXTERN PetscErrorCode SNESSetLagPreconditioner(SNES,PetscInt);
152: PETSC_EXTERN PetscErrorCode SNESGetLagPreconditioner(SNES,PetscInt*);
153: PETSC_EXTERN PetscErrorCode SNESSetLagJacobian(SNES,PetscInt);
154: PETSC_EXTERN PetscErrorCode SNESGetLagJacobian(SNES,PetscInt*);
155: PETSC_EXTERN PetscErrorCode SNESSetLagPreconditionerPersists(SNES,PetscBool);
156: PETSC_EXTERN PetscErrorCode SNESSetLagJacobianPersists(SNES,PetscBool);
157: PETSC_EXTERN PetscErrorCode SNESSetGridSequence(SNES,PetscInt);
158: PETSC_EXTERN PetscErrorCode SNESGetGridSequence(SNES,PetscInt*);
160: PETSC_EXTERN PetscErrorCode SNESGetLinearSolveIterations(SNES,PetscInt*);
161: PETSC_EXTERN PetscErrorCode SNESGetLinearSolveFailures(SNES,PetscInt*);
162: PETSC_EXTERN PetscErrorCode SNESSetMaxLinearSolveFailures(SNES,PetscInt);
163: PETSC_EXTERN PetscErrorCode SNESGetMaxLinearSolveFailures(SNES,PetscInt*);
164: PETSC_EXTERN PetscErrorCode SNESSetCountersReset(SNES,PetscBool);
166: PETSC_EXTERN PetscErrorCode SNESKSPSetUseEW(SNES,PetscBool);
167: PETSC_EXTERN PetscErrorCode SNESKSPGetUseEW(SNES,PetscBool *);
168: PETSC_EXTERN PetscErrorCode SNESKSPSetParametersEW(SNES,PetscInt,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal);
169: PETSC_EXTERN PetscErrorCode SNESKSPGetParametersEW(SNES,PetscInt*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*);
171: #include <petscdrawtypes.h>
172: PETSC_EXTERN PetscErrorCode SNESMonitorLGCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscDrawLG*);
173: PETSC_EXTERN PetscErrorCode SNESMonitorLGResidualNorm(SNES,PetscInt,PetscReal,void*);
174: PETSC_EXTERN PetscErrorCode SNESMonitorLGRange(SNES,PetscInt,PetscReal,void*);
176: PETSC_EXTERN PetscErrorCode SNESSetApplicationContext(SNES,void *);
177: PETSC_EXTERN PetscErrorCode SNESGetApplicationContext(SNES,void *);
178: PETSC_EXTERN PetscErrorCode SNESSetComputeApplicationContext(SNES,PetscErrorCode (*)(SNES,void**),PetscErrorCode (*)(void**));
180: PETSC_EXTERN PetscErrorCode SNESPythonSetType(SNES,const char[]);
182: PETSC_EXTERN PetscErrorCode SNESSetFunctionDomainError(SNES);
183: PETSC_EXTERN PetscErrorCode SNESGetFunctionDomainError(SNES, PetscBool *);
184: PETSC_EXTERN PetscErrorCode SNESGetJacobianDomainError(SNES,PetscBool*);
185: PETSC_EXTERN PetscErrorCode SNESSetJacobianDomainError(SNES);
186: PETSC_EXTERN PetscErrorCode SNESSetCheckJacobianDomainError(SNES,PetscBool);
187: PETSC_EXTERN PetscErrorCode SNESGetCheckJacobianDomainError(SNES,PetscBool*);
189: #define SNES_CONVERGED_TR_DELTA_DEPRECATED SNES_CONVERGED_TR_DELTA PETSC_DEPRECATED_ENUM("Use SNES_DIVERGED_TR_DELTA (since version 3.12)")
190: /*E
191: SNESConvergedReason - reason a SNES method was said to
192: have converged or diverged
194: Level: beginner
196: The two most common reasons for divergence are
197: $ 1) an incorrectly coded or computed Jacobian or
198: $ 2) failure or lack of convergence in the linear system (in this case we recommend
199: $ testing with -pc_type lu to eliminate the linear solver as the cause of the problem).
201: Diverged Reasons:
202: . SNES_DIVERGED_LOCAL_MIN - this can only occur when using the line-search variant of SNES.
203: The line search wants to minimize Q(alpha) = 1/2 || F(x + alpha s) ||^2_2 this occurs
204: 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
205: you get Q'(alpha) = -F(x)^T F'(x)^(-1)^T F'(x+alpha s)F(x+alpha s); when alpha = 0
206: Q'(0) = - ||F(x)||^2_2 which is always NEGATIVE if F'(x) is invertible. This means the Newton
207: direction is a descent direction and the line search should succeed if alpha is small enough.
209: If F'(x) is NOT invertible AND F'(x)^T F(x) = 0 then Q'(0) = 0 and the Newton direction
210: is NOT a descent direction so the line search will fail. All one can do at this point
211: is change the initial guess and try again.
213: An alternative explanation: Newton's method can be regarded as replacing the function with
214: its linear approximation and minimizing the 2-norm of that. That is F(x+s) approx F(x) + F'(x)s
215: so we minimize || F(x) + F'(x) s ||^2_2; do this using Least Squares. If F'(x) is invertible then
216: 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
217: exists a nontrival (that is F'(x)s != 0) solution to the equation and this direction is
218: 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)
219: = - (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
220: and F'(x)^T F'(x) has no negative eigenvalues Q'(0) < 0 so s is a descent direction and the line
221: search should succeed for small enough alpha.
223: Note that this RARELY happens in practice. Far more likely the linear system is not being solved
224: (well enough?) or the Jacobian is wrong.
226: SNES_DIVERGED_MAX_IT means that the solver reached the maximum number of iterations without satisfying any
227: convergence criteria. SNES_CONVERGED_ITS means that SNESConvergedSkip() was chosen as the convergence test;
228: thus the usual convergence criteria have not been checked and may or may not be satisfied.
230: Developer Notes:
231: this must match petsc/finclude/petscsnes.h
233: The string versions of these are in SNESConvergedReasons, if you change any value here you must
234: also adjust that array.
236: Each reason has its own manual page.
238: .seealso: SNESSolve(), SNESGetConvergedReason(), KSPConvergedReason, SNESSetConvergenceTest()
239: E*/
240: typedef enum {/* converged */
241: SNES_CONVERGED_FNORM_ABS = 2, /* ||F|| < atol */
242: SNES_CONVERGED_FNORM_RELATIVE = 3, /* ||F|| < rtol*||F_initial|| */
243: SNES_CONVERGED_SNORM_RELATIVE = 4, /* Newton computed step size small; || delta x || < stol || x ||*/
244: SNES_CONVERGED_ITS = 5, /* maximum iterations reached */
245: /* diverged */
246: SNES_DIVERGED_FUNCTION_DOMAIN = -1, /* the new x location passed the function is not in the domain of F */
247: SNES_DIVERGED_FUNCTION_COUNT = -2,
248: SNES_DIVERGED_LINEAR_SOLVE = -3, /* the linear solve failed */
249: SNES_DIVERGED_FNORM_NAN = -4,
250: SNES_DIVERGED_MAX_IT = -5,
251: SNES_DIVERGED_LINE_SEARCH = -6, /* the line search failed */
252: SNES_DIVERGED_INNER = -7, /* inner solve failed */
253: SNES_DIVERGED_LOCAL_MIN = -8, /* || J^T b || is small, implies converged to local minimum of F() */
254: SNES_DIVERGED_DTOL = -9, /* || F || > divtol*||F_initial|| */
255: SNES_DIVERGED_JACOBIAN_DOMAIN = -10, /* Jacobian calculation does not make sense */
256: SNES_DIVERGED_TR_DELTA = -11,
257: SNES_CONVERGED_TR_DELTA_DEPRECATED = -11,
259: SNES_CONVERGED_ITERATING = 0} SNESConvergedReason;
260: PETSC_EXTERN const char *const*SNESConvergedReasons;
262: /*MC
263: SNES_CONVERGED_FNORM_ABS - 2-norm(F) <= abstol
265: Level: beginner
267: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
269: M*/
271: /*MC
272: SNES_CONVERGED_FNORM_RELATIVE - 2-norm(F) <= rtol*2-norm(F(x_0)) where x_0 is the initial guess
274: Level: beginner
276: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
278: M*/
280: /*MC
281: SNES_CONVERGED_SNORM_RELATIVE - The 2-norm of the last step <= stol * 2-norm(x) where x is the current
282: solution and stol is the 4th argument to SNESSetTolerances()
284: Options Database Keys:
285: -snes_stol <stol> - the step tolerance
287: Level: beginner
289: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
291: M*/
293: /*MC
294: SNES_DIVERGED_FUNCTION_COUNT - The user provided function has been called more times then the final
295: argument to SNESSetTolerances()
297: Level: beginner
299: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
301: M*/
303: /*MC
304: SNES_DIVERGED_DTOL - The norm of the function has increased by a factor of divtol set with SNESSetDivergenceTolerance()
306: Level: beginner
308: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances(), SNESSetDivergenceTolerance()
310: M*/
312: /*MC
313: SNES_DIVERGED_FNORM_NAN - the 2-norm of the current function evaluation is not-a-number (NaN), this
314: is usually caused by a division of 0 by 0.
316: Level: beginner
318: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
320: M*/
322: /*MC
323: SNES_DIVERGED_MAX_IT - SNESSolve() has reached the maximum number of iterations requested
325: Level: beginner
327: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
329: M*/
331: /*MC
332: SNES_DIVERGED_LINE_SEARCH - The line search has failed. This only occurs for a SNES solvers that use a line search
334: Level: beginner
336: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances(), SNESLineSearch
338: M*/
340: /*MC
341: SNES_DIVERGED_LOCAL_MIN - the algorithm seems to have stagnated at a local minimum that is not zero.
342: See the manual page for SNESConvergedReason for more details
344: Level: beginner
346: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
348: M*/
350: /*MC
351: SNES_CONERGED_ITERATING - this only occurs if SNESGetConvergedReason() is called during the SNESSolve()
353: Level: beginner
355: .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
357: M*/
359: PETSC_EXTERN PetscErrorCode SNESSetConvergenceTest(SNES,PetscErrorCode (*)(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void*,PetscErrorCode (*)(void*));
360: PETSC_EXTERN PetscErrorCode SNESConvergedDefault(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*);
361: PETSC_EXTERN PetscErrorCode SNESConvergedSkip(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*);
362: PETSC_EXTERN PetscErrorCode SNESGetConvergedReason(SNES,SNESConvergedReason*);
363: PETSC_EXTERN PetscErrorCode SNESSetConvergedReason(SNES,SNESConvergedReason);
365: PETSC_DEPRECATED_FUNCTION("Use SNESConvergedSkip() (since version 3.5)") PETSC_STATIC_INLINE void SNESSkipConverged(void) { /* never called */ }
366: #define SNESSkipConverged (SNESSkipConverged, SNESConvergedSkip)
368: /* --------- Solving systems of nonlinear equations --------------- */
369: PETSC_EXTERN PetscErrorCode SNESSetFunction(SNES,Vec,PetscErrorCode (*)(SNES,Vec,Vec,void*),void*);
370: PETSC_EXTERN PetscErrorCode SNESGetFunction(SNES,Vec*,PetscErrorCode (**)(SNES,Vec,Vec,void*),void**);
371: PETSC_EXTERN PetscErrorCode SNESComputeFunction(SNES,Vec,Vec);
372: PETSC_EXTERN PetscErrorCode SNESSetInitialFunction(SNES,Vec);
374: PETSC_EXTERN PetscErrorCode SNESSetJacobian(SNES,Mat,Mat,PetscErrorCode (*)(SNES,Vec,Mat,Mat,void*),void*);
375: PETSC_EXTERN PetscErrorCode SNESGetJacobian(SNES,Mat*,Mat*,PetscErrorCode (**)(SNES,Vec,Mat,Mat,void*),void**);
376: PETSC_EXTERN PetscErrorCode SNESObjectiveComputeFunctionDefaultFD(SNES,Vec,Vec,void*);
377: PETSC_EXTERN PetscErrorCode SNESComputeJacobianDefault(SNES,Vec,Mat,Mat,void*);
378: PETSC_EXTERN PetscErrorCode SNESComputeJacobianDefaultColor(SNES,Vec,Mat,Mat,void*);
379: PETSC_EXTERN PetscErrorCode SNESSetComputeInitialGuess(SNES,PetscErrorCode (*)(SNES,Vec,void*),void*);
380: PETSC_EXTERN PetscErrorCode SNESSetPicard(SNES,Vec,PetscErrorCode (*)(SNES,Vec,Vec,void*),Mat,Mat,PetscErrorCode (*)(SNES,Vec,Mat,Mat,void*),void*);
381: PETSC_EXTERN PetscErrorCode SNESGetPicard(SNES,Vec*,PetscErrorCode (**)(SNES,Vec,Vec,void*),Mat*,Mat*,PetscErrorCode (**)(SNES,Vec,Mat,Mat,void*),void**);
382: PETSC_EXTERN PetscErrorCode SNESPicardComputeFunction(SNES,Vec,Vec,void *);
383: PETSC_EXTERN PetscErrorCode SNESPicardComputeJacobian(SNES,Vec,Mat,Mat,void*);
385: PETSC_EXTERN PetscErrorCode SNESSetObjective(SNES,PetscErrorCode (*)(SNES,Vec,PetscReal *,void*),void*);
386: PETSC_EXTERN PetscErrorCode SNESGetObjective(SNES,PetscErrorCode (**)(SNES,Vec,PetscReal *,void*),void**);
387: PETSC_EXTERN PetscErrorCode SNESComputeObjective(SNES,Vec,PetscReal *);
389: /*E
390: SNESNormSchedule - Frequency with which the norm is computed
392: Level: advanced
394: Support for these is highly dependent on the solver.
396: Notes:
397: This is primarily used to turn off extra norm and function computation
398: when the solvers are composed.
400: .seealso: SNESSolve(), SNESGetConvergedReason(), KSPSetNormType(),
401: KSPSetConvergenceTest(), KSPSetPCSide()
402: E*/
404: typedef enum {SNES_NORM_DEFAULT = -1,
405: SNES_NORM_NONE = 0,
406: SNES_NORM_ALWAYS = 1,
407: SNES_NORM_INITIAL_ONLY = 2,
408: SNES_NORM_FINAL_ONLY = 3,
409: SNES_NORM_INITIAL_FINAL_ONLY = 4} SNESNormSchedule;
410: PETSC_EXTERN const char *const*const SNESNormSchedules;
412: /*MC
413: SNES_NORM_NONE - Don't compute function and its L2 norm.
415: Level: advanced
417: Notes:
418: This is most useful for stationary solvers with a fixed number of iterations used as smoothers.
420: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_DEFAULT
421: M*/
423: /*MC
424: SNES_NORM_ALWAYS - Compute the function and its L2 norm at each iteration.
426: Level: advanced
428: Notes:
429: Most solvers will use this no matter what norm type is passed to them.
431: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_NONE
432: M*/
434: /*MC
435: SNES_NORM_INITIAL_ONLY - Compute the function and its L2 at iteration 0, but do not update it.
437: Level: advanced
439: Notes:
440: This method is useful in composed methods, when a true solution might actually be found before SNESSolve() is called.
441: This option enables the solve to abort on the zeroth iteration if this is the case.
443: For solvers that require the computation of the L2 norm of the function as part of the method, this merely cancels
444: the norm computation at the last iteration (if possible).
446: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_FINAL_ONLY, SNES_NORM_INITIAL_FINAL_ONLY
447: M*/
449: /*MC
450: SNES_NORM_FINAL_ONLY - Compute the function and its L2 norm on only the final iteration.
452: Level: advanced
454: Notes:
455: For solvers that require the computation of the L2 norm of the function as part of the method, behaves
456: exactly as SNES_NORM_DEFAULT. This method is useful when the function is gotten after SNESSolve and
457: used in subsequent computation for methods that do not need the norm computed during the rest of the
458: solution procedure.
460: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_INITIAL_ONLY, SNES_NORM_INITIAL_FINAL_ONLY
461: M*/
463: /*MC
464: SNES_NORM_INITIAL_FINAL_ONLY - Compute the function and its L2 norm on only the initial and final iterations.
466: Level: advanced
468: Notes:
469: This method combines the benefits of SNES_NORM_INITIAL_ONLY and SNES_NORM_FINAL_ONLY.
471: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_SNES_NORM_INITIAL_ONLY, SNES_NORM_FINAL_ONLY
472: M*/
474: PETSC_EXTERN PetscErrorCode SNESSetNormSchedule(SNES,SNESNormSchedule);
475: PETSC_EXTERN PetscErrorCode SNESGetNormSchedule(SNES,SNESNormSchedule*);
476: PETSC_EXTERN PetscErrorCode SNESSetFunctionNorm(SNES,PetscReal);
477: PETSC_EXTERN PetscErrorCode SNESGetFunctionNorm(SNES,PetscReal*);
478: PETSC_EXTERN PetscErrorCode SNESGetUpdateNorm(SNES,PetscReal*);
479: PETSC_EXTERN PetscErrorCode SNESGetSolutionNorm(SNES,PetscReal*);
481: /*E
482: SNESFunctionType - Type of function computed
484: Level: advanced
486: Support for these is highly dependent on the solver.
488: .seealso: SNESSolve(), SNESGetConvergedReason(), KSPSetNormType(),
489: KSPSetConvergenceTest(), KSPSetPCSide()
490: E*/
491: typedef enum {SNES_FUNCTION_DEFAULT = -1,
492: SNES_FUNCTION_UNPRECONDITIONED = 0,
493: SNES_FUNCTION_PRECONDITIONED = 1} SNESFunctionType;
494: PETSC_EXTERN const char *const*const SNESFunctionTypes;
496: PETSC_EXTERN PetscErrorCode SNESSetFunctionType(SNES,SNESFunctionType);
497: PETSC_EXTERN PetscErrorCode SNESGetFunctionType(SNES,SNESFunctionType*);
499: PETSC_EXTERN PetscErrorCode SNESSetNGS(SNES,PetscErrorCode (*)(SNES,Vec,Vec,void*),void*);
500: PETSC_EXTERN PetscErrorCode SNESGetNGS(SNES,PetscErrorCode (**)(SNES,Vec,Vec,void*),void**);
501: PETSC_EXTERN PetscErrorCode SNESComputeNGS(SNES,Vec,Vec);
503: PETSC_EXTERN PetscErrorCode SNESNGSSetSweeps(SNES,PetscInt);
504: PETSC_EXTERN PetscErrorCode SNESNGSGetSweeps(SNES,PetscInt *);
505: PETSC_EXTERN PetscErrorCode SNESNGSSetTolerances(SNES,PetscReal,PetscReal,PetscReal,PetscInt);
506: PETSC_EXTERN PetscErrorCode SNESNGSGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,PetscInt*);
508: PETSC_EXTERN PetscErrorCode SNESSetAlwaysComputesFinalResidual(SNES,PetscBool);
509: PETSC_EXTERN PetscErrorCode SNESGetAlwaysComputesFinalResidual(SNES,PetscBool*);
511: PETSC_EXTERN PetscErrorCode SNESShellGetContext(SNES,void**);
512: PETSC_EXTERN PetscErrorCode SNESShellSetContext(SNES,void*);
513: PETSC_EXTERN PetscErrorCode SNESShellSetSolve(SNES,PetscErrorCode (*)(SNES,Vec));
515: /* --------- Routines specifically for line search methods --------------- */
518: /*S
519: SNESLineSearch - Abstract PETSc object that manages line-search operations
521: Level: beginner
523: .seealso: SNESLineSearchCreate(), SNESLineSearchSetType(), SNES
524: S*/
525: typedef struct _p_LineSearch* SNESLineSearch;
527: /*J
528: SNESLineSearchType - String with the name of a PETSc line search method
530: Level: beginner
532: .seealso: SNESLineSearchSetType(), SNES
533: J*/
534: typedef const char* SNESLineSearchType;
535: #define SNESLINESEARCHBT "bt"
536: #define SNESLINESEARCHNLEQERR "nleqerr"
537: #define SNESLINESEARCHBASIC "basic"
538: #define SNESLINESEARCHL2 "l2"
539: #define SNESLINESEARCHCP "cp"
540: #define SNESLINESEARCHSHELL "shell"
541: #define SNESLINESEARCHNCGLINEAR "ncglinear"
543: PETSC_EXTERN PetscFunctionList SNESList;
544: PETSC_EXTERN PetscClassId SNESLINESEARCH_CLASSID;
545: PETSC_EXTERN PetscFunctionList SNESLineSearchList;
547: #define SNES_LINESEARCH_ORDER_LINEAR 1
548: #define SNES_LINESEARCH_ORDER_QUADRATIC 2
549: #define SNES_LINESEARCH_ORDER_CUBIC 3
551: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchVIProjectFunc)(SNES,Vec);
552: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchVINormFunc)(SNES,Vec,Vec,PetscReal *);
553: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchApplyFunc)(SNESLineSearch);
554: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchUserFunc)(SNESLineSearch, void *);
556: PETSC_EXTERN PetscErrorCode SNESLineSearchCreate(MPI_Comm, SNESLineSearch*);
557: PETSC_EXTERN PetscErrorCode SNESLineSearchReset(SNESLineSearch);
558: PETSC_EXTERN PetscErrorCode SNESLineSearchView(SNESLineSearch,PetscViewer);
559: PETSC_EXTERN PetscErrorCode SNESLineSearchDestroy(SNESLineSearch *);
560: PETSC_EXTERN PetscErrorCode SNESLineSearchGetType(SNESLineSearch, SNESLineSearchType *);
561: PETSC_EXTERN PetscErrorCode SNESLineSearchSetType(SNESLineSearch, SNESLineSearchType);
562: PETSC_EXTERN PetscErrorCode SNESLineSearchSetFromOptions(SNESLineSearch);
563: PETSC_EXTERN PetscErrorCode SNESLineSearchSetFunction(SNESLineSearch,PetscErrorCode (*)(SNES,Vec,Vec));
564: PETSC_EXTERN PetscErrorCode SNESLineSearchSetUp(SNESLineSearch);
565: PETSC_EXTERN PetscErrorCode SNESLineSearchApply(SNESLineSearch, Vec, Vec, PetscReal *, Vec);
566: PETSC_EXTERN PetscErrorCode SNESLineSearchPreCheck(SNESLineSearch,Vec,Vec,PetscBool *);
567: PETSC_EXTERN PetscErrorCode SNESLineSearchPostCheck(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *);
568: PETSC_EXTERN PetscErrorCode SNESLineSearchSetWorkVecs(SNESLineSearch, PetscInt);
570: /* set the functions for precheck and postcheck */
572: PETSC_EXTERN PetscErrorCode SNESLineSearchSetPreCheck(SNESLineSearch, PetscErrorCode (*)(SNESLineSearch,Vec,Vec,PetscBool*,void*), void *ctx);
573: PETSC_EXTERN PetscErrorCode SNESLineSearchSetPostCheck(SNESLineSearch, PetscErrorCode (*)(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *,void*), void *ctx);
575: PETSC_EXTERN PetscErrorCode SNESLineSearchGetPreCheck(SNESLineSearch, PetscErrorCode (**)(SNESLineSearch,Vec,Vec,PetscBool*,void*), void **ctx);
576: PETSC_EXTERN PetscErrorCode SNESLineSearchGetPostCheck(SNESLineSearch, PetscErrorCode (**)(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *,void*), void **ctx);
578: /* set the functions for VI-specific line search operations */
580: PETSC_EXTERN PetscErrorCode SNESLineSearchSetVIFunctions(SNESLineSearch, SNESLineSearchVIProjectFunc, SNESLineSearchVINormFunc);
581: PETSC_EXTERN PetscErrorCode SNESLineSearchGetVIFunctions(SNESLineSearch, SNESLineSearchVIProjectFunc*, SNESLineSearchVINormFunc*);
583: /* pointers to the associated SNES in order to be able to get the function evaluation out */
584: PETSC_EXTERN PetscErrorCode SNESLineSearchSetSNES(SNESLineSearch,SNES);
585: PETSC_EXTERN PetscErrorCode SNESLineSearchGetSNES(SNESLineSearch,SNES*);
587: /* set and get the parameters and vectors */
588: PETSC_EXTERN PetscErrorCode SNESLineSearchGetTolerances(SNESLineSearch,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscInt*);
589: PETSC_EXTERN PetscErrorCode SNESLineSearchSetTolerances(SNESLineSearch,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscInt);
591: PETSC_EXTERN PetscErrorCode SNESLineSearchPreCheckPicard(SNESLineSearch,Vec,Vec,PetscBool*,void*);
593: PETSC_EXTERN PetscErrorCode SNESLineSearchGetLambda(SNESLineSearch,PetscReal*);
594: PETSC_EXTERN PetscErrorCode SNESLineSearchSetLambda(SNESLineSearch,PetscReal);
596: PETSC_EXTERN PetscErrorCode SNESLineSearchGetDamping(SNESLineSearch,PetscReal*);
597: PETSC_EXTERN PetscErrorCode SNESLineSearchSetDamping(SNESLineSearch,PetscReal);
599: PETSC_EXTERN PetscErrorCode SNESLineSearchGetOrder(SNESLineSearch,PetscInt *order);
600: PETSC_EXTERN PetscErrorCode SNESLineSearchSetOrder(SNESLineSearch,PetscInt order);
602: /*E
603: SNESLineSearchReason - if line search has succeeded or failed and why
605: Level: intermediate
607: Developer Notes:
608: this must match petsc/finclude/petscsnes.h
610: Developer Note: The string versions of these are in SNESLineSearchReasons, if you change any value here you must
611: also adjust that array.
613: .seealso: SNESSolve(), SNESGetConvergedReason(), KSPConvergedReason, SNESSetConvergenceTest()
614: E*/
615: typedef enum {SNES_LINESEARCH_SUCCEEDED,
616: SNES_LINESEARCH_FAILED_NANORINF,
617: SNES_LINESEARCH_FAILED_DOMAIN,
618: SNES_LINESEARCH_FAILED_REDUCT, /* INSUFFICENT REDUCTION */
619: SNES_LINESEARCH_FAILED_USER,
620: SNES_LINESEARCH_FAILED_FUNCTION} SNESLineSearchReason;
622: PETSC_EXTERN PetscErrorCode SNESLineSearchGetReason(SNESLineSearch, SNESLineSearchReason*);
623: PETSC_EXTERN PetscErrorCode SNESLineSearchSetReason(SNESLineSearch, SNESLineSearchReason);
625: PETSC_EXTERN PetscErrorCode SNESLineSearchGetVecs(SNESLineSearch,Vec*,Vec*,Vec*,Vec*,Vec*);
626: PETSC_EXTERN PetscErrorCode SNESLineSearchSetVecs(SNESLineSearch,Vec,Vec,Vec,Vec,Vec);
628: PETSC_EXTERN PetscErrorCode SNESLineSearchGetNorms(SNESLineSearch, PetscReal *, PetscReal *, PetscReal *);
629: PETSC_EXTERN PetscErrorCode SNESLineSearchSetNorms(SNESLineSearch, PetscReal, PetscReal, PetscReal);
630: PETSC_EXTERN PetscErrorCode SNESLineSearchComputeNorms(SNESLineSearch);
631: PETSC_EXTERN PetscErrorCode SNESLineSearchSetComputeNorms(SNESLineSearch, PetscBool);
633: PETSC_EXTERN PetscErrorCode SNESLineSearchMonitor(SNESLineSearch);
634: PETSC_EXTERN PetscErrorCode SNESLineSearchMonitorSet(SNESLineSearch,PetscErrorCode(*)(SNESLineSearch,void*),void *,PetscErrorCode (*)(void**));
635: PETSC_EXTERN PetscErrorCode SNESLineSearchMonitorSetFromOptions(SNESLineSearch,const char[],const char[],const char[],PetscErrorCode (*)(SNESLineSearch,PetscViewerAndFormat*),PetscErrorCode (*)(SNESLineSearch,PetscViewerAndFormat*));
636: PETSC_EXTERN PetscErrorCode SNESLineSearchMonitorCancel(SNESLineSearch);
637: PETSC_EXTERN PetscErrorCode SNESLineSearchMonitorUpdate(SNESLineSearch,PetscViewerAndFormat*);
638: PETSC_EXTERN PetscErrorCode SNESLineSearchSetDefaultMonitor(SNESLineSearch,PetscViewer);
639: PETSC_EXTERN PetscErrorCode SNESLineSearchGetDefaultMonitor(SNESLineSearch,PetscViewer*);
640: PETSC_EXTERN PetscErrorCode SNESLineSearchMonitorSolutionUpdate(SNESLineSearch,PetscViewerAndFormat*);
642: PETSC_EXTERN PetscErrorCode SNESLineSearchAppendOptionsPrefix(SNESLineSearch, const char prefix[]);
643: PETSC_EXTERN PetscErrorCode SNESLineSearchGetOptionsPrefix(SNESLineSearch, const char *prefix[]);
646: /* Shell interface functions */
647: PETSC_EXTERN PetscErrorCode SNESLineSearchShellSetUserFunc(SNESLineSearch,SNESLineSearchUserFunc,void*);
648: PETSC_EXTERN PetscErrorCode SNESLineSearchShellGetUserFunc(SNESLineSearch,SNESLineSearchUserFunc*,void**);
650: /* BT interface functions */
651: PETSC_EXTERN PetscErrorCode SNESLineSearchBTSetAlpha(SNESLineSearch, PetscReal);
652: PETSC_EXTERN PetscErrorCode SNESLineSearchBTGetAlpha(SNESLineSearch, PetscReal*);
654: /*register line search types */
655: PETSC_EXTERN PetscErrorCode SNESLineSearchRegister(const char[],PetscErrorCode(*)(SNESLineSearch));
657: /* Routines for VI solver */
658: PETSC_EXTERN PetscErrorCode SNESVISetVariableBounds(SNES,Vec,Vec);
659: PETSC_EXTERN PetscErrorCode SNESVISetComputeVariableBounds(SNES, PetscErrorCode (*)(SNES,Vec,Vec));
660: PETSC_EXTERN PetscErrorCode SNESVIGetInactiveSet(SNES,IS*);
661: PETSC_EXTERN PetscErrorCode SNESVIGetActiveSetIS(SNES,Vec,Vec,IS*);
662: PETSC_EXTERN PetscErrorCode SNESVIComputeInactiveSetFnorm(SNES,Vec,Vec,PetscReal*);
663: PETSC_EXTERN PetscErrorCode SNESVISetRedundancyCheck(SNES,PetscErrorCode(*)(SNES,IS,IS*,void*),void*);
665: PETSC_EXTERN PetscErrorCode SNESTestLocalMin(SNES);
667: /* Should this routine be private? */
668: PETSC_EXTERN PetscErrorCode SNESComputeJacobian(SNES,Vec,Mat,Mat);
669: PETSC_EXTERN PetscErrorCode SNESTestJacobian(SNES);
671: PETSC_EXTERN PetscErrorCode SNESSetDM(SNES,DM);
672: PETSC_EXTERN PetscErrorCode SNESGetDM(SNES,DM*);
673: PETSC_EXTERN PetscErrorCode SNESSetNPC(SNES,SNES);
674: PETSC_EXTERN PetscErrorCode SNESGetNPC(SNES,SNES*);
675: PETSC_EXTERN PetscErrorCode SNESHasNPC(SNES,PetscBool*);
676: PETSC_EXTERN PetscErrorCode SNESApplyNPC(SNES,Vec,Vec,Vec);
677: PETSC_EXTERN PetscErrorCode SNESGetNPCFunction(SNES,Vec,PetscReal*);
678: PETSC_EXTERN PetscErrorCode SNESComputeFunctionDefaultNPC(SNES,Vec,Vec);
679: PETSC_EXTERN PetscErrorCode SNESSetNPCSide(SNES,PCSide);
680: PETSC_EXTERN PetscErrorCode SNESGetNPCSide(SNES,PCSide*);
681: PETSC_EXTERN PetscErrorCode SNESSetLineSearch(SNES,SNESLineSearch);
682: PETSC_EXTERN PetscErrorCode SNESGetLineSearch(SNES,SNESLineSearch*);
683: PETSC_EXTERN PetscErrorCode SNESRestrictHookAdd(SNES,PetscErrorCode (*)(SNES,SNES,void*),void*);
685: PETSC_DEPRECATED_FUNCTION("Use SNESGetLineSearch() (since version 3.4)") PETSC_STATIC_INLINE PetscErrorCode SNESGetSNESLineSearch(SNES snes,SNESLineSearch *ls) {return SNESGetLineSearch(snes,ls);}
686: PETSC_DEPRECATED_FUNCTION("Use SNESSetLineSearch() (since version 3.4)") PETSC_STATIC_INLINE PetscErrorCode SNESSetSNESLineSearch(SNES snes,SNESLineSearch ls) {return SNESSetLineSearch(snes,ls);}
688: PETSC_EXTERN PetscErrorCode SNESSetUpMatrices(SNES);
689: PETSC_EXTERN PetscErrorCode DMSNESSetFunction(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),void*);
690: PETSC_EXTERN PetscErrorCode DMSNESGetFunction(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),void**);
691: PETSC_EXTERN PetscErrorCode DMSNESSetNGS(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),void*);
692: PETSC_EXTERN PetscErrorCode DMSNESGetNGS(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),void**);
693: PETSC_EXTERN PetscErrorCode DMSNESSetJacobian(DM,PetscErrorCode(*)(SNES,Vec,Mat,Mat,void*),void*);
694: PETSC_EXTERN PetscErrorCode DMSNESGetJacobian(DM,PetscErrorCode(**)(SNES,Vec,Mat,Mat,void*),void**);
695: PETSC_EXTERN PetscErrorCode DMSNESSetPicard(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),PetscErrorCode(*)(SNES,Vec,Mat,Mat,void*),void*);
696: PETSC_EXTERN PetscErrorCode DMSNESGetPicard(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),PetscErrorCode(**)(SNES,Vec,Mat,Mat,void*),void**);
697: PETSC_EXTERN PetscErrorCode DMSNESSetObjective(DM,PetscErrorCode (*)(SNES,Vec,PetscReal *,void*),void*);
698: PETSC_EXTERN PetscErrorCode DMSNESGetObjective(DM,PetscErrorCode (**)(SNES,Vec,PetscReal *,void*),void**);
699: PETSC_EXTERN PetscErrorCode DMCopyDMSNES(DM,DM);
701: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESFunction)(DMDALocalInfo*,void*,void*,void*);
702: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESJacobian)(DMDALocalInfo*,void*,Mat,Mat,void*);
703: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESObjective)(DMDALocalInfo*,void*,PetscReal*,void*);
705: PETSC_EXTERN PetscErrorCode DMDASNESSetFunctionLocal(DM,InsertMode,DMDASNESFunction,void*);
706: PETSC_EXTERN PetscErrorCode DMDASNESSetJacobianLocal(DM,DMDASNESJacobian,void*);
707: PETSC_EXTERN PetscErrorCode DMDASNESSetObjectiveLocal(DM,DMDASNESObjective,void*);
708: PETSC_EXTERN PetscErrorCode DMDASNESSetPicardLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,void*,void*,void*),PetscErrorCode (*)(DMDALocalInfo*,void*,Mat,Mat,void*),void*);
710: PETSC_EXTERN PetscErrorCode DMSNESSetBoundaryLocal(DM,PetscErrorCode (*)(DM,Vec,void*),void*);
711: PETSC_EXTERN PetscErrorCode DMSNESSetFunctionLocal(DM,PetscErrorCode (*)(DM,Vec,Vec,void*),void*);
712: PETSC_EXTERN PetscErrorCode DMSNESSetJacobianLocal(DM,PetscErrorCode (*)(DM,Vec,Mat,Mat,void*),void*);
713: PETSC_EXTERN PetscErrorCode DMSNESGetBoundaryLocal(DM,PetscErrorCode (**)(DM,Vec,void*),void**);
714: PETSC_EXTERN PetscErrorCode DMSNESGetFunctionLocal(DM,PetscErrorCode (**)(DM,Vec,Vec,void*),void**);
715: PETSC_EXTERN PetscErrorCode DMSNESGetJacobianLocal(DM,PetscErrorCode (**)(DM,Vec,Mat,Mat,void*),void**);
717: /* Routines for Multiblock solver */
718: PETSC_EXTERN PetscErrorCode SNESMultiblockSetFields(SNES, const char [], PetscInt, const PetscInt *);
719: PETSC_EXTERN PetscErrorCode SNESMultiblockSetIS(SNES, const char [], IS);
720: PETSC_EXTERN PetscErrorCode SNESMultiblockSetBlockSize(SNES, PetscInt);
721: PETSC_EXTERN PetscErrorCode SNESMultiblockSetType(SNES, PCCompositeType);
723: /*J
724: SNESMSType - String with the name of a PETSc SNESMS method.
726: Level: intermediate
728: .seealso: SNESMSGetType(), SNESMSSetType(), SNES
729: J*/
730: typedef const char* SNESMSType;
731: #define SNESMSM62 "m62"
732: #define SNESMSEULER "euler"
733: #define SNESMSJAMESON83 "jameson83"
734: #define SNESMSVLTP11 "vltp11"
735: #define SNESMSVLTP21 "vltp21"
736: #define SNESMSVLTP31 "vltp31"
737: #define SNESMSVLTP41 "vltp41"
738: #define SNESMSVLTP51 "vltp51"
739: #define SNESMSVLTP61 "vltp61"
741: PETSC_EXTERN PetscErrorCode SNESMSRegister(SNESMSType,PetscInt,PetscInt,PetscReal,const PetscReal[],const PetscReal[],const PetscReal[]);
742: PETSC_EXTERN PetscErrorCode SNESMSGetType(SNES,SNESMSType*);
743: PETSC_EXTERN PetscErrorCode SNESMSSetType(SNES,SNESMSType);
744: PETSC_EXTERN PetscErrorCode SNESMSGetDamping(SNES,PetscReal*);
745: PETSC_EXTERN PetscErrorCode SNESMSSetDamping(SNES,PetscReal);
746: PETSC_EXTERN PetscErrorCode SNESMSFinalizePackage(void);
747: PETSC_EXTERN PetscErrorCode SNESMSInitializePackage(void);
748: PETSC_EXTERN PetscErrorCode SNESMSRegisterDestroy(void);
750: /* routines for NGMRES solver */
752: typedef enum {
753: SNES_NGMRES_RESTART_NONE = 0,
754: SNES_NGMRES_RESTART_PERIODIC = 1,
755: SNES_NGMRES_RESTART_DIFFERENCE = 2} SNESNGMRESRestartType;
756: PETSC_EXTERN const char *const SNESNGMRESRestartTypes[];
758: typedef enum {
759: SNES_NGMRES_SELECT_NONE = 0,
760: SNES_NGMRES_SELECT_DIFFERENCE = 1,
761: SNES_NGMRES_SELECT_LINESEARCH = 2} SNESNGMRESSelectType;
762: PETSC_EXTERN const char *const SNESNGMRESSelectTypes[];
764: PETSC_EXTERN PetscErrorCode SNESNGMRESSetRestartType(SNES, SNESNGMRESRestartType);
765: PETSC_EXTERN PetscErrorCode SNESNGMRESSetSelectType(SNES, SNESNGMRESSelectType);
766: PETSC_EXTERN PetscErrorCode SNESNGMRESSetRestartFmRise(SNES, PetscBool);
767: PETSC_EXTERN PetscErrorCode SNESNGMRESGetRestartFmRise(SNES, PetscBool*);
769: /* routines for NCG solver */
771: typedef enum {
772: SNES_NCG_FR = 0,
773: SNES_NCG_PRP = 1,
774: SNES_NCG_HS = 2,
775: SNES_NCG_DY = 3,
776: SNES_NCG_CD = 4} SNESNCGType;
777: PETSC_EXTERN const char *const SNESNCGTypes[];
779: PETSC_EXTERN PetscErrorCode SNESNCGSetType(SNES, SNESNCGType);
781: typedef enum {SNES_QN_SCALE_DEFAULT = 0,
782: SNES_QN_SCALE_NONE = 1,
783: SNES_QN_SCALE_SCALAR = 2,
784: SNES_QN_SCALE_DIAGONAL = 3,
785: SNES_QN_SCALE_JACOBIAN = 4} SNESQNScaleType;
786: PETSC_EXTERN const char *const SNESQNScaleTypes[];
787: typedef enum {SNES_QN_RESTART_DEFAULT = 0,
788: SNES_QN_RESTART_NONE = 1,
789: SNES_QN_RESTART_POWELL = 2,
790: SNES_QN_RESTART_PERIODIC = 3} SNESQNRestartType;
791: PETSC_EXTERN const char *const SNESQNRestartTypes[];
792: typedef enum {SNES_QN_LBFGS = 0,
793: SNES_QN_BROYDEN = 1,
794: SNES_QN_BADBROYDEN = 2
795: } SNESQNType;
796: PETSC_EXTERN const char *const SNESQNTypes[];
798: PETSC_EXTERN PetscErrorCode SNESQNSetType(SNES, SNESQNType);
799: PETSC_EXTERN PetscErrorCode SNESQNSetScaleType(SNES, SNESQNScaleType);
800: PETSC_EXTERN PetscErrorCode SNESQNSetRestartType(SNES, SNESQNRestartType);
802: PETSC_EXTERN PetscErrorCode SNESNASMGetType(SNES,PCASMType*);
803: PETSC_EXTERN PetscErrorCode SNESNASMSetType(SNES,PCASMType);
804: PETSC_EXTERN PetscErrorCode SNESNASMGetSubdomains(SNES,PetscInt*,SNES**,VecScatter**,VecScatter**,VecScatter**);
805: PETSC_EXTERN PetscErrorCode SNESNASMSetSubdomains(SNES,PetscInt,SNES*,VecScatter*,VecScatter*,VecScatter*);
806: PETSC_EXTERN PetscErrorCode SNESNASMSetDamping(SNES,PetscReal);
807: PETSC_EXTERN PetscErrorCode SNESNASMGetDamping(SNES,PetscReal*);
808: PETSC_EXTERN PetscErrorCode SNESNASMGetSubdomainVecs(SNES,PetscInt*,Vec**,Vec**,Vec**,Vec**);
809: PETSC_EXTERN PetscErrorCode SNESNASMSetComputeFinalJacobian(SNES,PetscBool);
810: PETSC_EXTERN PetscErrorCode SNESNASMGetSNES(SNES,PetscInt,SNES *);
811: PETSC_EXTERN PetscErrorCode SNESNASMGetNumber(SNES,PetscInt*);
812: PETSC_EXTERN PetscErrorCode SNESNASMSetWeight(SNES,Vec);
814: typedef enum {SNES_COMPOSITE_ADDITIVE,SNES_COMPOSITE_MULTIPLICATIVE,SNES_COMPOSITE_ADDITIVEOPTIMAL} SNESCompositeType;
815: PETSC_EXTERN const char *const SNESCompositeTypes[];
817: PETSC_EXTERN PetscErrorCode SNESCompositeSetType(SNES,SNESCompositeType);
818: PETSC_EXTERN PetscErrorCode SNESCompositeAddSNES(SNES,SNESType);
819: PETSC_EXTERN PetscErrorCode SNESCompositeGetSNES(SNES,PetscInt,SNES *);
820: PETSC_EXTERN PetscErrorCode SNESCompositeGetNumber(SNES,PetscInt*);
821: PETSC_EXTERN PetscErrorCode SNESCompositeSetDamping(SNES,PetscInt,PetscReal);
823: PETSC_EXTERN PetscErrorCode SNESPatchSetDiscretisationInfo(SNES,PetscInt,DM*,PetscInt*,PetscInt*,const PetscInt**,const PetscInt*,PetscInt,const PetscInt*,PetscInt,const PetscInt*);
824: PETSC_EXTERN PetscErrorCode SNESPatchSetComputeOperator(SNES, PetscErrorCode (*func)(PC, PetscInt, Vec, Mat, IS, PetscInt, const PetscInt *, const PetscInt *, void *), void*);
825: PETSC_EXTERN PetscErrorCode SNESPatchSetComputeFunction(SNES, PetscErrorCode (*func)(PC, PetscInt, Vec, Vec, IS, PetscInt, const PetscInt *, const PetscInt *, void *), void*);
826: PETSC_EXTERN PetscErrorCode SNESPatchSetConstructType(SNES,PCPatchConstructType, PetscErrorCode (*func)(PC, PetscInt *, IS **, IS *, void *), void*);
827: PETSC_EXTERN PetscErrorCode SNESPatchSetCellNumbering(SNES,PetscSection);
829: /*E
830: SNESFASType - Determines the type of nonlinear multigrid method that is run.
832: Level: beginner
834: Values:
835: + SNES_FAS_MULTIPLICATIVE (default) - traditional V or W cycle as determined by SNESFASSetCycles()
836: . SNES_FAS_ADDITIVE - additive FAS cycle
837: . SNES_FAS_FULL - full FAS cycle
838: - SNES_FAS_KASKADE - Kaskade FAS cycle
839: .seealso: PCMGSetType(), PCMGType
841: E*/
842: typedef enum { SNES_FAS_MULTIPLICATIVE, SNES_FAS_ADDITIVE, SNES_FAS_FULL, SNES_FAS_KASKADE } SNESFASType;
843: PETSC_EXTERN const char *const SNESFASTypes[];
845: /* called on the finest level FAS instance*/
846: PETSC_EXTERN PetscErrorCode SNESFASSetType(SNES, SNESFASType);
847: PETSC_EXTERN PetscErrorCode SNESFASGetType(SNES, SNESFASType*);
848: PETSC_EXTERN PetscErrorCode SNESFASSetLevels(SNES, PetscInt, MPI_Comm *);
849: PETSC_EXTERN PetscErrorCode SNESFASGetLevels(SNES, PetscInt *);
850: PETSC_EXTERN PetscErrorCode SNESFASGetCycleSNES(SNES, PetscInt, SNES*);
851: PETSC_EXTERN PetscErrorCode SNESFASSetNumberSmoothUp(SNES, PetscInt);
852: PETSC_EXTERN PetscErrorCode SNESFASSetNumberSmoothDown(SNES, PetscInt);
853: PETSC_EXTERN PetscErrorCode SNESFASSetCycles(SNES, PetscInt);
854: PETSC_EXTERN PetscErrorCode SNESFASSetMonitor(SNES, PetscViewerAndFormat *, PetscBool);
855: PETSC_EXTERN PetscErrorCode SNESFASSetLog(SNES, PetscBool);
857: PETSC_EXTERN PetscErrorCode SNESFASSetGalerkin(SNES, PetscBool);
858: PETSC_EXTERN PetscErrorCode SNESFASGetGalerkin(SNES, PetscBool*);
859: PETSC_EXTERN PetscErrorCode SNESFASGalerkinFunctionDefault(SNES,Vec,Vec,void*);
861: /* called on any level -- "Cycle" FAS instance */
862: PETSC_EXTERN PetscErrorCode SNESFASCycleGetSmoother(SNES, SNES*);
863: PETSC_EXTERN PetscErrorCode SNESFASCycleGetSmootherUp(SNES, SNES*);
864: PETSC_EXTERN PetscErrorCode SNESFASCycleGetSmootherDown(SNES, SNES*);
865: PETSC_EXTERN PetscErrorCode SNESFASCycleGetCorrection(SNES, SNES*);
866: PETSC_EXTERN PetscErrorCode SNESFASCycleGetInterpolation(SNES, Mat*);
867: PETSC_EXTERN PetscErrorCode SNESFASCycleGetRestriction(SNES, Mat*);
868: PETSC_EXTERN PetscErrorCode SNESFASCycleGetInjection(SNES, Mat*);
869: PETSC_EXTERN PetscErrorCode SNESFASCycleGetRScale(SNES, Vec*);
870: PETSC_EXTERN PetscErrorCode SNESFASCycleSetCycles(SNES, PetscInt);
871: PETSC_EXTERN PetscErrorCode SNESFASCycleIsFine(SNES, PetscBool*);
873: /* called on the (outer) finest level FAS to set/get parameters on any level instance */
874: PETSC_EXTERN PetscErrorCode SNESFASSetInterpolation(SNES, PetscInt, Mat);
875: PETSC_EXTERN PetscErrorCode SNESFASGetInterpolation(SNES, PetscInt, Mat*);
876: PETSC_EXTERN PetscErrorCode SNESFASSetRestriction(SNES, PetscInt, Mat);
877: PETSC_EXTERN PetscErrorCode SNESFASGetRestriction(SNES, PetscInt, Mat*);
878: PETSC_EXTERN PetscErrorCode SNESFASSetInjection(SNES, PetscInt, Mat);
879: PETSC_EXTERN PetscErrorCode SNESFASGetInjection(SNES, PetscInt, Mat*);
880: PETSC_EXTERN PetscErrorCode SNESFASSetRScale(SNES, PetscInt, Vec);
881: PETSC_EXTERN PetscErrorCode SNESFASGetRScale(SNES, PetscInt, Vec*);
882: PETSC_EXTERN PetscErrorCode SNESFASSetContinuation(SNES,PetscBool);
884: PETSC_EXTERN PetscErrorCode SNESFASGetSmoother(SNES, PetscInt, SNES*);
885: PETSC_EXTERN PetscErrorCode SNESFASGetSmootherUp(SNES, PetscInt, SNES*);
886: PETSC_EXTERN PetscErrorCode SNESFASGetSmootherDown(SNES, PetscInt, SNES*);
887: PETSC_EXTERN PetscErrorCode SNESFASGetCoarseSolve(SNES, SNES*);
889: /* parameters for full FAS */
890: PETSC_EXTERN PetscErrorCode SNESFASFullSetDownSweep(SNES,PetscBool);
891: PETSC_EXTERN PetscErrorCode SNESFASCreateCoarseVec(SNES,Vec*);
892: PETSC_EXTERN PetscErrorCode SNESFASRestrict(SNES,Vec,Vec);
894: PETSC_EXTERN PetscErrorCode DMSNESCheckDiscretization(SNES,DM,PetscReal,Vec,PetscReal,PetscReal[]);
895: PETSC_EXTERN PetscErrorCode DMSNESCheckResidual(SNES,DM,Vec,PetscReal,PetscReal*);
896: PETSC_EXTERN PetscErrorCode DMSNESCheckJacobian(SNES,DM,Vec,PetscReal,PetscBool*,PetscReal*);
897: PETSC_EXTERN PetscErrorCode DMSNESCheckFromOptions(SNES,Vec);
899: #endif