Actual source code: petscsnes.h

petsc-master 2016-02-13
Report Typos and Errors
  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 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_STATIC_INLINE PetscErrorCode SNESViewFromOptions(SNES A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
 91: PETSC_EXTERN PetscErrorCode SNESReasonView(SNES,PetscViewer);
 92: PETSC_EXTERN PetscErrorCode SNESReasonViewFromOptions(SNES);

 94: #define SNES_FILE_CLASSID 1211224

 96: PETSC_EXTERN PetscErrorCode SNESSetOptionsPrefix(SNES,const char[]);
 97: PETSC_EXTERN PetscErrorCode SNESAppendOptionsPrefix(SNES,const char[]);
 98: PETSC_EXTERN PetscErrorCode SNESGetOptionsPrefix(SNES,const char*[]);
 99: PETSC_EXTERN PetscErrorCode SNESSetFromOptions(SNES);

101: PETSC_EXTERN PetscErrorCode MatCreateSNESMF(SNES,Mat*);
102: PETSC_EXTERN PetscErrorCode MatMFFDComputeJacobian(SNES,Vec,Mat,Mat,void*);

104: PETSC_EXTERN PetscErrorCode MatDAADSetSNES(Mat,SNES);

106: PETSC_EXTERN PetscErrorCode SNESGetType(SNES,SNESType*);
107: PETSC_EXTERN PetscErrorCode SNESMonitorDefault(SNES,PetscInt,PetscReal,void *);
108: PETSC_EXTERN PetscErrorCode SNESMonitorRange(SNES,PetscInt,PetscReal,void *);
109: PETSC_EXTERN PetscErrorCode SNESMonitorRatio(SNES,PetscInt,PetscReal,void *);
110: PETSC_EXTERN PetscErrorCode SNESMonitorRatioSetUp(SNES,PetscViewer);
111: PETSC_EXTERN PetscErrorCode SNESMonitorSolution(SNES,PetscInt,PetscReal,void *);
112: PETSC_EXTERN PetscErrorCode SNESMonitorResidual(SNES,PetscInt,PetscReal,void *);
113: PETSC_EXTERN PetscErrorCode SNESMonitorSolutionUpdate(SNES,PetscInt,PetscReal,void *);
114: PETSC_EXTERN PetscErrorCode SNESMonitorDefaultShort(SNES,PetscInt,PetscReal,void *);
115: PETSC_EXTERN PetscErrorCode SNESMonitorDefaultField(SNES,PetscInt,PetscReal,void *);
116: PETSC_EXTERN PetscErrorCode SNESMonitorJacUpdateSpectrum(SNES,PetscInt,PetscReal,void *);
117: PETSC_EXTERN PetscErrorCode SNESMonitorFields(SNES,PetscInt,PetscReal,void *);
118: PETSC_EXTERN PetscErrorCode KSPMonitorSNES(KSP,PetscInt,PetscReal,void*);
119: PETSC_EXTERN PetscErrorCode KSPMonitorSNESLGResidualNormCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscObject**);
120: PETSC_EXTERN PetscErrorCode KSPMonitorSNESLGResidualNorm(KSP,PetscInt,PetscReal,PetscObject*);
121: PETSC_EXTERN PetscErrorCode KSPMonitorSNESLGResidualNormDestroy(PetscObject**);

123: PETSC_EXTERN PetscErrorCode SNESSetTolerances(SNES,PetscReal,PetscReal,PetscReal,PetscInt,PetscInt);
124: PETSC_EXTERN PetscErrorCode SNESGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,PetscInt*,PetscInt*);
125: PETSC_EXTERN PetscErrorCode SNESSetTrustRegionTolerance(SNES,PetscReal);
126: PETSC_EXTERN PetscErrorCode SNESGetIterationNumber(SNES,PetscInt*);
127: PETSC_EXTERN PetscErrorCode SNESSetIterationNumber(SNES,PetscInt);

129: PETSC_EXTERN PetscErrorCode SNESGetNonlinearStepFailures(SNES,PetscInt*);
130: PETSC_EXTERN PetscErrorCode SNESSetMaxNonlinearStepFailures(SNES,PetscInt);
131: PETSC_EXTERN PetscErrorCode SNESGetMaxNonlinearStepFailures(SNES,PetscInt*);
132: PETSC_EXTERN PetscErrorCode SNESGetNumberFunctionEvals(SNES,PetscInt*);

134: PETSC_EXTERN PetscErrorCode SNESSetLagPreconditioner(SNES,PetscInt);
135: PETSC_EXTERN PetscErrorCode SNESGetLagPreconditioner(SNES,PetscInt*);
136: PETSC_EXTERN PetscErrorCode SNESSetLagJacobian(SNES,PetscInt);
137: PETSC_EXTERN PetscErrorCode SNESGetLagJacobian(SNES,PetscInt*);
138: PETSC_EXTERN PetscErrorCode SNESSetLagPreconditionerPersists(SNES,PetscBool);
139: PETSC_EXTERN PetscErrorCode SNESSetLagJacobianPersists(SNES,PetscBool);
140: PETSC_EXTERN PetscErrorCode SNESSetGridSequence(SNES,PetscInt);
141: PETSC_EXTERN PetscErrorCode SNESGetGridSequence(SNES,PetscInt*);

143: PETSC_EXTERN PetscErrorCode SNESGetLinearSolveIterations(SNES,PetscInt*);
144: PETSC_EXTERN PetscErrorCode SNESGetLinearSolveFailures(SNES,PetscInt*);
145: PETSC_EXTERN PetscErrorCode SNESSetMaxLinearSolveFailures(SNES,PetscInt);
146: PETSC_EXTERN PetscErrorCode SNESGetMaxLinearSolveFailures(SNES,PetscInt*);
147: PETSC_EXTERN PetscErrorCode SNESSetCountersReset(SNES,PetscBool);

149: PETSC_EXTERN PetscErrorCode SNESKSPSetUseEW(SNES,PetscBool );
150: PETSC_EXTERN PetscErrorCode SNESKSPGetUseEW(SNES,PetscBool *);
151: PETSC_EXTERN PetscErrorCode SNESKSPSetParametersEW(SNES,PetscInt,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal);
152: PETSC_EXTERN PetscErrorCode SNESKSPGetParametersEW(SNES,PetscInt*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*);

154: #include <petscdrawtypes.h>
155: PETSC_EXTERN PetscErrorCode SNESMonitorLGCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscDrawLG*);
156: PETSC_EXTERN PetscErrorCode SNESMonitorLGResidualNorm(SNES,PetscInt,PetscReal,void*);
157: PETSC_EXTERN PetscErrorCode SNESMonitorLGRange(SNES,PetscInt,PetscReal,void*);

159: PETSC_EXTERN PetscErrorCode SNESSetApplicationContext(SNES,void *);
160: PETSC_EXTERN PetscErrorCode SNESGetApplicationContext(SNES,void *);
161: PETSC_EXTERN PetscErrorCode SNESSetComputeApplicationContext(SNES,PetscErrorCode (*)(SNES,void**),PetscErrorCode (*)(void**));

163: PETSC_EXTERN PetscErrorCode SNESPythonSetType(SNES,const char[]);

165: PETSC_EXTERN PetscErrorCode SNESSetFunctionDomainError(SNES);
166: PETSC_EXTERN PetscErrorCode SNESGetFunctionDomainError(SNES, PetscBool *);

168: /*E
169:     SNESConvergedReason - reason a SNES method was said to
170:          have converged or diverged

172:    Level: beginner

174:    The two most common reasons for divergence are
175: $   1) an incorrectly coded or computed Jacobian or
176: $   2) failure or lack of convergence in the linear system (in this case we recommend
177: $      testing with -pc_type lu to eliminate the linear solver as the cause of the problem).

179:    Diverged Reasons:
180: .    SNES_DIVERGED_LOCAL_MIN - this can only occur when using the line-search variant of SNES.
181:        The line search wants to minimize Q(alpha) = 1/2 || F(x + alpha s) ||^2_2  this occurs
182:        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
183:        you get Q'(alpha) = -F(x)^T F'(x)^(-1)^T F'(x+alpha s)F(x+alpha s); when alpha = 0
184:        Q'(0) = - ||F(x)||^2_2 which is always NEGATIVE if F'(x) is invertible. This means the Newton
185:        direction is a descent direction and the line search should succeed if alpha is small enough.

187:        If F'(x) is NOT invertible AND F'(x)^T F(x) = 0 then Q'(0) = 0 and the Newton direction
188:        is NOT a descent direction so the line search will fail. All one can do at this point
189:        is change the initial guess and try again.

191:        An alternative explanation: Newton's method can be regarded as replacing the function with
192:        its linear approximation and minimizing the 2-norm of that. That is F(x+s) approx F(x) + F'(x)s
193:        so we minimize || F(x) + F'(x) s ||^2_2; do this using Least Squares. If F'(x) is invertible then
194:        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
195:        exists a nontrival (that is F'(x)s != 0) solution to the equation and this direction is
196:        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)
197:        = - (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
198:        and F'(x)^T F'(x) has no negative eigenvalues Q'(0) < 0 so s is a descent direction and the line
199:        search should succeed for small enough alpha.

201:        Note that this RARELY happens in practice. Far more likely the linear system is not being solved
202:        (well enough?) or the Jacobian is wrong.

204:    SNES_DIVERGED_MAX_IT means that the solver reached the maximum number of iterations without satisfying any
205:    convergence criteria. SNES_CONVERGED_ITS means that SNESConvergedSkip() was chosen as the convergence test;
206:    thus the usual convergence criteria have not been checked and may or may not be satisfied.

208:    Developer Notes: this must match petsc/finclude/petscsnes.h

210:        The string versions of these are in SNESConvergedReason, if you change any value here you must
211:      also adjust that array.

213:    Each reason has its own manual page.

215: .seealso: SNESSolve(), SNESGetConvergedReason(), KSPConvergedReason, SNESSetConvergenceTest()
216: E*/
217: typedef enum {/* converged */
218:               SNES_CONVERGED_FNORM_ABS         =  2, /* ||F|| < atol */
219:               SNES_CONVERGED_FNORM_RELATIVE    =  3, /* ||F|| < rtol*||F_initial|| */
220:               SNES_CONVERGED_SNORM_RELATIVE    =  4, /* Newton computed step size small; || delta x || < stol || x ||*/
221:               SNES_CONVERGED_ITS               =  5, /* maximum iterations reached */
222:               SNES_CONVERGED_TR_DELTA          =  7,
223:               /* diverged */
224:               SNES_DIVERGED_FUNCTION_DOMAIN     = -1, /* the new x location passed the function is not in the domain of F */
225:               SNES_DIVERGED_FUNCTION_COUNT      = -2,
226:               SNES_DIVERGED_LINEAR_SOLVE        = -3, /* the linear solve failed */
227:               SNES_DIVERGED_FNORM_NAN           = -4,
228:               SNES_DIVERGED_MAX_IT              = -5,
229:               SNES_DIVERGED_LINE_SEARCH         = -6, /* the line search failed */
230:               SNES_DIVERGED_INNER               = -7, /* inner solve failed */
231:               SNES_DIVERGED_LOCAL_MIN           = -8, /* || J^T b || is small, implies converged to local minimum of F() */
232:               SNES_CONVERGED_ITERATING          =  0} SNESConvergedReason;
233: PETSC_EXTERN const char *const*SNESConvergedReasons;

235: /*MC
236:      SNES_CONVERGED_FNORM_ABS - 2-norm(F) <= abstol

238:    Level: beginner

240: .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()

242: M*/

244: /*MC
245:      SNES_CONVERGED_FNORM_RELATIVE - 2-norm(F) <= rtol*2-norm(F(x_0)) where x_0 is the initial guess

247:    Level: beginner

249: .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()

251: M*/

253: /*MC
254:      SNES_CONVERGED_SNORM_RELATIVE - The 2-norm of the last step <= stol * 2-norm(x) where x is the current
255:           solution and stol is the 4th argument to SNESSetTolerances()

257:      Options Database Keys:
258:       -snes_stol <stol> - the step tolerance

260:    Level: beginner

262: .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()

264: M*/

266: /*MC
267:      SNES_DIVERGED_FUNCTION_COUNT - The user provided function has been called more times then the final
268:          argument to SNESSetTolerances()

270:    Level: beginner

272: .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()

274: M*/

276: /*MC
277:      SNES_DIVERGED_FNORM_NAN - the 2-norm of the current function evaluation is not-a-number (NaN), this
278:       is usually caused by a division of 0 by 0.

280:    Level: beginner

282: .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()

284: M*/

286: /*MC
287:      SNES_DIVERGED_MAX_IT - SNESSolve() has reached the maximum number of iterations requested

289:    Level: beginner

291: .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()

293: M*/

295: /*MC
296:      SNES_DIVERGED_LINE_SEARCH - The line search has failed. This only occurs for a SNES solvers that use a line search

298:    Level: beginner

300: .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances(), SNESLineSearch

302: M*/

304: /*MC
305:      SNES_DIVERGED_LOCAL_MIN - the algorithm seems to have stagnated at a local minimum that is not zero.
306:         See the manual page for SNESConvergedReason for more details

308:    Level: beginner

310: .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()

312: M*/

314: /*MC
315:      SNES_CONERGED_ITERATING - this only occurs if SNESGetConvergedReason() is called during the SNESSolve()

317:    Level: beginner

319: .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()

321: M*/

323: PETSC_EXTERN PetscErrorCode SNESSetConvergenceTest(SNES,PetscErrorCode (*)(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void*,PetscErrorCode (*)(void*));
324: PETSC_EXTERN PetscErrorCode SNESConvergedDefault(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*);
325: PETSC_EXTERN PetscErrorCode SNESConvergedSkip(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*);
326: PETSC_EXTERN PetscErrorCode SNESGetConvergedReason(SNES,SNESConvergedReason*);
327: PETSC_EXTERN PetscErrorCode SNESSetConvergedReason(SNES,SNESConvergedReason);

329: PETSC_DEPRECATED("Use SNESConvergedSkip()") PETSC_STATIC_INLINE void SNESSkipConverged(void) { /* never called */ }
330: #define SNESSkipConverged (SNESSkipConverged, SNESConvergedSkip)

332: /* --------- Solving systems of nonlinear equations --------------- */
333: PETSC_EXTERN PetscErrorCode SNESSetFunction(SNES,Vec,PetscErrorCode (*)(SNES,Vec,Vec,void*),void*);
334: PETSC_EXTERN PetscErrorCode SNESGetFunction(SNES,Vec*,PetscErrorCode (**)(SNES,Vec,Vec,void*),void**);
335: PETSC_EXTERN PetscErrorCode SNESComputeFunction(SNES,Vec,Vec);

337: PETSC_EXTERN PetscErrorCode SNESSetJacobian(SNES,Mat,Mat,PetscErrorCode (*)(SNES,Vec,Mat,Mat,void*),void*);
338: PETSC_EXTERN PetscErrorCode SNESGetJacobian(SNES,Mat*,Mat*,PetscErrorCode (**)(SNES,Vec,Mat,Mat,void*),void**);
339: PETSC_EXTERN PetscErrorCode SNESObjectiveComputeFunctionDefaultFD(SNES,Vec,Vec,void*);
340: PETSC_EXTERN PetscErrorCode SNESComputeJacobianDefault(SNES,Vec,Mat,Mat,void*);
341: PETSC_EXTERN PetscErrorCode SNESComputeJacobianDefaultColor(SNES,Vec,Mat,Mat,void*);
342: PETSC_EXTERN PetscErrorCode SNESSetComputeInitialGuess(SNES,PetscErrorCode (*)(SNES,Vec,void*),void*);
343: PETSC_EXTERN PetscErrorCode SNESSetPicard(SNES,Vec,PetscErrorCode (*)(SNES,Vec,Vec,void*),Mat,Mat,PetscErrorCode (*)(SNES,Vec,Mat,Mat,void*),void*);
344: PETSC_EXTERN PetscErrorCode SNESGetPicard(SNES,Vec*,PetscErrorCode (**)(SNES,Vec,Vec,void*),Mat*,Mat*,PetscErrorCode (**)(SNES,Vec,Mat,Mat,void*),void**);
345: PETSC_EXTERN PetscErrorCode SNESSetInitialFunction(SNES,Vec);

347: PETSC_EXTERN PetscErrorCode SNESSetObjective(SNES,PetscErrorCode (*)(SNES,Vec,PetscReal *,void*),void*);
348: PETSC_EXTERN PetscErrorCode SNESGetObjective(SNES,PetscErrorCode (**)(SNES,Vec,PetscReal *,void*),void**);
349: PETSC_EXTERN PetscErrorCode SNESComputeObjective(SNES,Vec,PetscReal *);

351: /*E
352:     SNESNormSchedule - Frequency with which the norm is computed

354:    Level: advanced

356:    Support for these is highly dependent on the solver.

358:    Notes:
359:    This is primarily used to turn off extra norm and function computation
360:    when the solvers are composed.

362: .seealso: SNESSolve(), SNESGetConvergedReason(), KSPSetNormType(),
363:           KSPSetConvergenceTest(), KSPSetPCSide()
364: E*/

366: typedef enum {SNES_NORM_DEFAULT            = -1,
367:               SNES_NORM_NONE               =  0,
368:               SNES_NORM_ALWAYS             =  1,
369:               SNES_NORM_INITIAL_ONLY       =  2,
370:               SNES_NORM_FINAL_ONLY         =  3,
371:               SNES_NORM_INITIAL_FINAL_ONLY =  4} SNESNormSchedule;
372: PETSC_EXTERN const char *const*const SNESNormSchedules;

374: /*MC
375:     SNES_NORM_NONE - Don't compute function and its L2 norm.

377:    Level: advanced

379:     Notes:
380:     This is most useful for stationary solvers with a fixed number of iterations used as smoothers.

382: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_DEFAULT
383: M*/

385: /*MC
386:     SNES_NORM_ALWAYS - Compute the function and its L2 norm at each iteration.

388:    Level: advanced

390:     Notes:
391:     Most solvers will use this no matter what norm type is passed to them.

393: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_NONE
394: M*/

396: /*MC
397:     SNES_NORM_INITIAL_ONLY - Compute the function and its L2 at iteration 0, but do not update it.

399:    Level: advanced

401:    Notes:
402:    This method is useful in composed methods, when a true solution might actually be found before SNESSolve() is called.
403:    This option enables the solve to abort on the zeroth iteration if this is the case.

405:    For solvers that require the computation of the L2 norm of the function as part of the method, this merely cancels
406:    the norm computation at the last iteration (if possible).

408: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_FINAL_ONLY, SNES_NORM_INITIAL_FINAL_ONLY
409: M*/

411: /*MC
412:     SNES_NORM_FINAL_ONLY - Compute the function and its L2 norm on only the final iteration.

414:    Level: advanced

416:    Notes:
417:    For solvers that require the computation of the L2 norm of the function as part of the method, behaves
418:    exactly as SNES_NORM_DEFAULT.  This method is useful when the function is gotten after SNESSolve and
419:    used in subsequent computation for methods that do not need the norm computed during the rest of the
420:    solution procedure.

422: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_INITIAL_ONLY, SNES_NORM_INITIAL_FINAL_ONLY
423: M*/

425: /*MC
426:     SNES_NORM_INITIAL_FINAL_ONLY - Compute the function and its L2 norm on only the initial and final iterations.

428:    Level: advanced

430:    Notes:
431:    This method combines the benefits of SNES_NORM_INITIAL_ONLY and SNES_NORM_FINAL_ONLY.

433: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_SNES_NORM_INITIAL_ONLY, SNES_NORM_FINAL_ONLY
434: M*/

436: PETSC_EXTERN PetscErrorCode SNESSetNormSchedule(SNES,SNESNormSchedule);
437: PETSC_EXTERN PetscErrorCode SNESGetNormSchedule(SNES,SNESNormSchedule*);
438: PETSC_EXTERN PetscErrorCode SNESSetFunctionNorm(SNES,PetscReal);
439: PETSC_EXTERN PetscErrorCode SNESGetFunctionNorm(SNES,PetscReal*);

441: /*E
442:     SNESFunctionType - Type of function computed

444:    Level: advanced

446:    Support for these is highly dependent on the solver.

448: .seealso: SNESSolve(), SNESGetConvergedReason(), KSPSetNormType(),
449:           KSPSetConvergenceTest(), KSPSetPCSide()
450: E*/
451: typedef enum {SNES_FUNCTION_DEFAULT          = -1,
452:               SNES_FUNCTION_UNPRECONDITIONED =  0,
453:               SNES_FUNCTION_PRECONDITIONED   =  1} SNESFunctionType;
454: PETSC_EXTERN const char *const*const SNESFunctionTypes;

456: PETSC_EXTERN PetscErrorCode SNESSetFunctionType(SNES,SNESFunctionType);
457: PETSC_EXTERN PetscErrorCode SNESGetFunctionType(SNES,SNESFunctionType*);

459: PETSC_EXTERN PetscErrorCode SNESSetNGS(SNES,PetscErrorCode (*)(SNES,Vec,Vec,void*),void*);
460: PETSC_EXTERN PetscErrorCode SNESGetNGS(SNES,PetscErrorCode (**)(SNES,Vec,Vec,void*),void**);
461: PETSC_EXTERN PetscErrorCode SNESSetUseNGS(SNES,PetscBool);
462: PETSC_EXTERN PetscErrorCode SNESGetUseNGS(SNES,PetscBool *);
463: PETSC_EXTERN PetscErrorCode SNESComputeNGS(SNES,Vec,Vec);

465: PETSC_EXTERN PetscErrorCode SNESNGSSetSweeps(SNES,PetscInt);
466: PETSC_EXTERN PetscErrorCode SNESNGSGetSweeps(SNES,PetscInt *);
467: PETSC_EXTERN PetscErrorCode SNESNGSSetTolerances(SNES,PetscReal,PetscReal,PetscReal,PetscInt);
468: PETSC_EXTERN PetscErrorCode SNESNGSGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,PetscInt*);

470: PETSC_EXTERN PetscErrorCode SNESUpdateCheckJacobian(SNES,PetscInt);

472: PETSC_EXTERN PetscErrorCode SNESShellGetContext(SNES,void**);
473: PETSC_EXTERN PetscErrorCode SNESShellSetContext(SNES,void*);
474: PETSC_EXTERN PetscErrorCode SNESShellSetSolve(SNES,PetscErrorCode (*)(SNES,Vec));

476: /* --------- Routines specifically for line search methods --------------- */


479: /*S
480:      SNESLineSearch - Abstract PETSc object that manages line-search operations

482:    Level: beginner

484:   Concepts: nonlinear solvers, line search

486: .seealso:  SNESLineSearchCreate(), SNESLineSearchSetType(), SNES
487: S*/
488: typedef struct _p_LineSearch* SNESLineSearch;

490: /*J
491:     SNESLineSearchType - String with the name of a PETSc line search method

493:    Level: beginner

495: .seealso: SNESLineSearchSetType(), SNES
496: J*/
497: typedef const char* SNESLineSearchType;
498: #define SNESLINESEARCHBT                 "bt"
499: #define SNESLINESEARCHNLEQERR            "nleqerr"
500: #define SNESLINESEARCHBASIC              "basic"
501: #define SNESLINESEARCHL2                 "l2"
502: #define SNESLINESEARCHCP                 "cp"
503: #define SNESLINESEARCHSHELL              "shell"

505: PETSC_EXTERN PetscFunctionList SNESList;
506: PETSC_EXTERN PetscClassId      SNESLINESEARCH_CLASSID;
507: PETSC_EXTERN PetscFunctionList SNESLineSearchList;
508: PETSC_EXTERN PetscLogEvent     SNESLineSearch_Apply;

510: #define SNES_LINESEARCH_ORDER_LINEAR    1
511: #define SNES_LINESEARCH_ORDER_QUADRATIC 2
512: #define SNES_LINESEARCH_ORDER_CUBIC     3

514: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchVIProjectFunc)(SNES,Vec);
515: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchVINormFunc)(SNES,Vec,Vec,PetscReal *);
516: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchApplyFunc)(SNESLineSearch);
517: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchUserFunc)(SNESLineSearch, void *);

519: PETSC_EXTERN PetscErrorCode SNESLineSearchCreate(MPI_Comm, SNESLineSearch*);
520: PETSC_EXTERN PetscErrorCode SNESLineSearchReset(SNESLineSearch);
521: PETSC_EXTERN PetscErrorCode SNESLineSearchView(SNESLineSearch,PetscViewer);
522: PETSC_EXTERN PetscErrorCode SNESLineSearchDestroy(SNESLineSearch *);
523: PETSC_EXTERN PetscErrorCode SNESLineSearchSetType(SNESLineSearch, SNESLineSearchType);
524: PETSC_EXTERN PetscErrorCode SNESLineSearchSetFromOptions(SNESLineSearch);
525: PETSC_EXTERN PetscErrorCode SNESLineSearchSetFunction(SNESLineSearch,PetscErrorCode (*)(SNES,Vec,Vec));
526: PETSC_EXTERN PetscErrorCode SNESLineSearchSetUp(SNESLineSearch);
527: PETSC_EXTERN PetscErrorCode SNESLineSearchApply(SNESLineSearch, Vec, Vec, PetscReal *, Vec);
528: PETSC_EXTERN PetscErrorCode SNESLineSearchPreCheck(SNESLineSearch,Vec,Vec,PetscBool *);
529: PETSC_EXTERN PetscErrorCode SNESLineSearchPostCheck(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *);
530: PETSC_EXTERN PetscErrorCode SNESLineSearchSetWorkVecs(SNESLineSearch, PetscInt);

532: /* set the functions for precheck and postcheck */

534: PETSC_EXTERN PetscErrorCode SNESLineSearchSetPreCheck(SNESLineSearch, PetscErrorCode (*)(SNESLineSearch,Vec,Vec,PetscBool*,void*), void *ctx);
535: PETSC_EXTERN PetscErrorCode SNESLineSearchSetPostCheck(SNESLineSearch, PetscErrorCode (*)(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *,void*), void *ctx);

537: PETSC_EXTERN PetscErrorCode SNESLineSearchGetPreCheck(SNESLineSearch, PetscErrorCode (**)(SNESLineSearch,Vec,Vec,PetscBool*,void*), void **ctx);
538: PETSC_EXTERN PetscErrorCode SNESLineSearchGetPostCheck(SNESLineSearch, PetscErrorCode (**)(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *,void*), void **ctx);

540: /* set the functions for VI-specific line search operations */

542: PETSC_EXTERN PetscErrorCode SNESLineSearchSetVIFunctions(SNESLineSearch, SNESLineSearchVIProjectFunc, SNESLineSearchVINormFunc);
543: PETSC_EXTERN PetscErrorCode SNESLineSearchGetVIFunctions(SNESLineSearch, SNESLineSearchVIProjectFunc*, SNESLineSearchVINormFunc*);

545: /* pointers to the associated SNES in order to be able to get the function evaluation out */
546: PETSC_EXTERN PetscErrorCode SNESLineSearchSetSNES(SNESLineSearch,SNES);
547: PETSC_EXTERN PetscErrorCode SNESLineSearchGetSNES(SNESLineSearch,SNES*);

549: /* set and get the parameters and vectors */
550: PETSC_EXTERN PetscErrorCode SNESLineSearchGetTolerances(SNESLineSearch,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscInt*);
551: PETSC_EXTERN PetscErrorCode SNESLineSearchSetTolerances(SNESLineSearch,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscInt);

553: PETSC_EXTERN PetscErrorCode SNESLineSearchPreCheckPicard(SNESLineSearch,Vec,Vec,PetscBool*,void*);

555: PETSC_EXTERN PetscErrorCode SNESLineSearchGetLambda(SNESLineSearch,PetscReal*);
556: PETSC_EXTERN PetscErrorCode SNESLineSearchSetLambda(SNESLineSearch,PetscReal);

558: PETSC_EXTERN PetscErrorCode SNESLineSearchGetDamping(SNESLineSearch,PetscReal*);
559: PETSC_EXTERN PetscErrorCode SNESLineSearchSetDamping(SNESLineSearch,PetscReal);

561: PETSC_EXTERN PetscErrorCode SNESLineSearchGetOrder(SNESLineSearch,PetscInt *order);
562: PETSC_EXTERN PetscErrorCode SNESLineSearchSetOrder(SNESLineSearch,PetscInt order);

564: /*E
565:     SNESLineSearchReason - if line search has succeeded or failed and why

567:    Level: intermediate

569:    Developer Notes: this must match petsc/finclude/petscsnes.h

571:    Developer Note: The string versions of these are in SNESLineSearchReasons, if you change any value here you must
572:      also adjust that array.

574: .seealso: SNESSolve(), SNESGetConvergedReason(), KSPConvergedReason, SNESSetConvergenceTest()
575: E*/
576: typedef enum {SNES_LINESEARCH_SUCCEEDED,
577:               SNES_LINESEARCH_FAILED_NANORINF,
578:               SNES_LINESEARCH_FAILED_DOMAIN,
579:               SNES_LINESEARCH_FAILED_REDUCT,       /* INSUFFICENT REDUCTION */
580:               SNES_LINESEARCH_FAILED_USER,
581:               SNES_LINESEARCH_FAILED_FUNCTION} SNESLineSearchReason;

583: PETSC_EXTERN PetscErrorCode SNESLineSearchGetReason(SNESLineSearch, SNESLineSearchReason*);
584: PETSC_EXTERN PetscErrorCode SNESLineSearchSetReason(SNESLineSearch, SNESLineSearchReason);

586: PETSC_EXTERN PetscErrorCode SNESLineSearchGetVecs(SNESLineSearch,Vec*,Vec*,Vec*,Vec*,Vec*);
587: PETSC_EXTERN PetscErrorCode SNESLineSearchSetVecs(SNESLineSearch,Vec,Vec,Vec,Vec,Vec);

589: PETSC_EXTERN PetscErrorCode SNESLineSearchGetNorms(SNESLineSearch, PetscReal *, PetscReal *, PetscReal *);
590: PETSC_EXTERN PetscErrorCode SNESLineSearchSetNorms(SNESLineSearch, PetscReal, PetscReal, PetscReal);
591: PETSC_EXTERN PetscErrorCode SNESLineSearchComputeNorms(SNESLineSearch);
592: PETSC_EXTERN PetscErrorCode SNESLineSearchSetComputeNorms(SNESLineSearch, PetscBool);

594: PETSC_EXTERN PetscErrorCode SNESLineSearchMonitor(SNESLineSearch);
595: PETSC_EXTERN PetscErrorCode SNESLineSearchMonitorSet(SNESLineSearch,PetscErrorCode(*)(SNESLineSearch,void*),void *,PetscErrorCode (*)(void**));
596: PETSC_EXTERN PetscErrorCode SNESLineSearchMonitorCancel(SNESLineSearch);
597: PETSC_EXTERN PetscErrorCode SNESLineSearchMonitorUpdate(SNESLineSearch,void*);
598: PETSC_EXTERN PetscErrorCode SNESLineSearchSetDefaultMonitor(SNESLineSearch,PetscViewer);
599: PETSC_EXTERN PetscErrorCode SNESLineSearchGetDefaultMonitor(SNESLineSearch,PetscViewer*);
600: PETSC_EXTERN PetscErrorCode SNESLineSearchMonitorSolutionUpdate(SNESLineSearch,void*);

602: PETSC_EXTERN PetscErrorCode SNESLineSearchAppendOptionsPrefix(SNESLineSearch, const char prefix[]);
603: PETSC_EXTERN PetscErrorCode SNESLineSearchGetOptionsPrefix(SNESLineSearch, const char *prefix[]);


606: /* Shell interface functions */
607: PETSC_EXTERN PetscErrorCode SNESLineSearchShellSetUserFunc(SNESLineSearch,SNESLineSearchUserFunc,void*);
608: PETSC_EXTERN PetscErrorCode SNESLineSearchShellGetUserFunc(SNESLineSearch,SNESLineSearchUserFunc*,void**);

610: /* BT interface functions */
611: PETSC_EXTERN PetscErrorCode SNESLineSearchBTSetAlpha(SNESLineSearch, PetscReal);
612: PETSC_EXTERN PetscErrorCode SNESLineSearchBTGetAlpha(SNESLineSearch, PetscReal*);

614: /*register line search types */
615: PETSC_EXTERN PetscErrorCode SNESLineSearchRegister(const char[],PetscErrorCode(*)(SNESLineSearch));

617: /* Routines for VI solver */
618: PETSC_EXTERN PetscErrorCode SNESVISetVariableBounds(SNES,Vec,Vec);
619: PETSC_EXTERN PetscErrorCode SNESVISetComputeVariableBounds(SNES, PetscErrorCode (*)(SNES,Vec,Vec));
620: PETSC_EXTERN PetscErrorCode SNESVIGetInactiveSet(SNES,IS*);
621: PETSC_EXTERN PetscErrorCode SNESVIGetActiveSetIS(SNES,Vec,Vec,IS*);
622: PETSC_EXTERN PetscErrorCode SNESVIComputeInactiveSetFnorm(SNES,Vec,Vec,PetscReal*);
623: PETSC_EXTERN PetscErrorCode SNESVISetRedundancyCheck(SNES,PetscErrorCode(*)(SNES,IS,IS*,void*),void*);

625: PETSC_EXTERN PetscErrorCode SNESTestLocalMin(SNES);

627: /* Should this routine be private? */
628: PETSC_EXTERN PetscErrorCode SNESComputeJacobian(SNES,Vec,Mat,Mat);

630: PETSC_EXTERN PetscErrorCode SNESSetDM(SNES,DM);
631: PETSC_EXTERN PetscErrorCode SNESGetDM(SNES,DM*);
632: PETSC_EXTERN PetscErrorCode SNESSetNPC(SNES,SNES);
633: PETSC_EXTERN PetscErrorCode SNESGetNPC(SNES,SNES*);
634: PETSC_EXTERN PetscErrorCode SNESHasNPC(SNES,PetscBool*);
635: PETSC_EXTERN PetscErrorCode SNESApplyNPC(SNES,Vec,Vec,Vec);
636: PETSC_EXTERN PetscErrorCode SNESGetNPCFunction(SNES,Vec,PetscReal*);
637: PETSC_EXTERN PetscErrorCode SNESComputeFunctionDefaultNPC(SNES,Vec,Vec);
638: PETSC_EXTERN PetscErrorCode SNESSetNPCSide(SNES,PCSide);
639: PETSC_EXTERN PetscErrorCode SNESGetNPCSide(SNES,PCSide*);
640: PETSC_EXTERN PetscErrorCode SNESSetLineSearch(SNES,SNESLineSearch);
641: PETSC_EXTERN PetscErrorCode SNESGetLineSearch(SNES,SNESLineSearch*);
642: PETSC_EXTERN PetscErrorCode SNESRestrictHookAdd(SNES,PetscErrorCode (*)(SNES,SNES,void*),void*);
643: PETSC_EXTERN PetscErrorCode SNESRestrictHooksRun(SNES,SNES);

645: PETSC_DEPRECATED("Use SNESGetLineSearch()") PETSC_STATIC_INLINE PetscErrorCode SNESGetSNESLineSearch(SNES snes,SNESLineSearch *ls) {return SNESGetLineSearch(snes,ls);}
646: PETSC_DEPRECATED("Use SNESSetLineSearch()") PETSC_STATIC_INLINE PetscErrorCode SNESSetSNESLineSearch(SNES snes,SNESLineSearch ls) {return SNESSetLineSearch(snes,ls);}

648: PETSC_EXTERN PetscErrorCode SNESSetUpMatrices(SNES);
649: PETSC_EXTERN PetscErrorCode DMSNESSetFunction(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),void*);
650: PETSC_EXTERN PetscErrorCode DMSNESGetFunction(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),void**);
651: PETSC_EXTERN PetscErrorCode DMSNESSetNGS(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),void*);
652: PETSC_EXTERN PetscErrorCode DMSNESGetNGS(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),void**);
653: PETSC_EXTERN PetscErrorCode DMSNESSetJacobian(DM,PetscErrorCode(*)(SNES,Vec,Mat,Mat,void*),void*);
654: PETSC_EXTERN PetscErrorCode DMSNESGetJacobian(DM,PetscErrorCode(**)(SNES,Vec,Mat,Mat,void*),void**);
655: PETSC_EXTERN PetscErrorCode DMSNESSetPicard(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),PetscErrorCode(*)(SNES,Vec,Mat,Mat,void*),void*);
656: PETSC_EXTERN PetscErrorCode DMSNESGetPicard(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),PetscErrorCode(**)(SNES,Vec,Mat,Mat,void*),void**);
657: PETSC_EXTERN PetscErrorCode DMSNESSetObjective(DM,PetscErrorCode (*)(SNES,Vec,PetscReal *,void*),void*);
658: PETSC_EXTERN PetscErrorCode DMSNESGetObjective(DM,PetscErrorCode (**)(SNES,Vec,PetscReal *,void*),void**);

660: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESFunction)(DMDALocalInfo*,void*,void*,void*);
661: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESJacobian)(DMDALocalInfo*,void*,Mat,Mat,void*);
662: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESObjective)(DMDALocalInfo*,void*,PetscReal*,void*);

664: PETSC_EXTERN PetscErrorCode DMDASNESSetFunctionLocal(DM,InsertMode,DMDASNESFunction,void*);
665: PETSC_EXTERN PetscErrorCode DMDASNESSetJacobianLocal(DM,DMDASNESJacobian,void*);
666: PETSC_EXTERN PetscErrorCode DMDASNESSetObjectiveLocal(DM,DMDASNESObjective,void*);
667: PETSC_EXTERN PetscErrorCode DMDASNESSetPicardLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,void*,void*,void*),PetscErrorCode (*)(DMDALocalInfo*,void*,Mat,Mat,void*),void*);

669: PETSC_EXTERN PetscErrorCode DMPlexSNESGetGeometryFEM(DM,Vec*);
670: PETSC_EXTERN PetscErrorCode DMPlexSNESGetGeometryFVM(DM,Vec*,Vec*,PetscReal*);
671: PETSC_EXTERN PetscErrorCode DMPlexSNESGetGradientDM(DM,PetscFV,DM*);
672: PETSC_EXTERN PetscErrorCode DMPlexReconstructGradientsFVM(DM,Vec,Vec);
673: PETSC_EXTERN PetscErrorCode DMPlexGetCellFields(DM, PetscInt, PetscInt, Vec, Vec, Vec, PetscScalar **, PetscScalar **, PetscScalar **);
674: PETSC_EXTERN PetscErrorCode DMPlexRestoreCellFields(DM, PetscInt, PetscInt, Vec, Vec, Vec, PetscScalar **, PetscScalar **, PetscScalar **);
675: PETSC_EXTERN PetscErrorCode DMPlexGetFaceFields(DM, PetscInt, PetscInt, Vec, Vec, Vec, Vec, Vec, PetscScalar **, PetscScalar **);
676: PETSC_EXTERN PetscErrorCode DMPlexRestoreFaceFields(DM, PetscInt, PetscInt, Vec, Vec, Vec, Vec, Vec, PetscScalar **, PetscScalar **);
677: PETSC_EXTERN PetscErrorCode DMPlexGetFaceGeometry(DM, PetscInt, PetscInt, Vec, Vec, PetscFVFaceGeom **, PetscReal **);
678: PETSC_EXTERN PetscErrorCode DMPlexRestoreFaceGeometry(DM, PetscInt, PetscInt, Vec, Vec, PetscFVFaceGeom **, PetscReal **);

680: PETSC_EXTERN PetscErrorCode DMSNESSetFunctionLocal(DM,PetscErrorCode (*)(DM,Vec,Vec,void*),void*);
681: PETSC_EXTERN PetscErrorCode DMSNESSetJacobianLocal(DM,PetscErrorCode (*)(DM,Vec,Mat,Mat,void*),void*);

683: /* Routines for Multiblock solver */
684: PETSC_EXTERN PetscErrorCode SNESMultiblockSetFields(SNES, const char [], PetscInt, const PetscInt *);
685: PETSC_EXTERN PetscErrorCode SNESMultiblockSetIS(SNES, const char [], IS);
686: PETSC_EXTERN PetscErrorCode SNESMultiblockSetBlockSize(SNES, PetscInt);
687: PETSC_EXTERN PetscErrorCode SNESMultiblockSetType(SNES, PCCompositeType);

689: /*J
690:     SNESMSType - String with the name of a PETSc SNESMS method.

692:    Level: intermediate

694: .seealso: SNESMSSetType(), SNES
695: J*/
696: typedef const char* SNESMSType;
697: #define SNESMSM62       "m62"
698: #define SNESMSEULER     "euler"
699: #define SNESMSJAMESON83 "jameson83"
700: #define SNESMSVLTP21    "vltp21"
701: #define SNESMSVLTP31    "vltp31"
702: #define SNESMSVLTP41    "vltp41"
703: #define SNESMSVLTP51    "vltp51"
704: #define SNESMSVLTP61    "vltp61"

706: PETSC_EXTERN PetscErrorCode SNESMSRegister(SNESMSType,PetscInt,PetscInt,PetscReal,const PetscReal[],const PetscReal[],const PetscReal[]);
707: PETSC_EXTERN PetscErrorCode SNESMSSetType(SNES,SNESMSType);
708: PETSC_EXTERN PetscErrorCode SNESMSFinalizePackage(void);
709: PETSC_EXTERN PetscErrorCode SNESMSInitializePackage(void);
710: PETSC_EXTERN PetscErrorCode SNESMSRegisterDestroy(void);

712: /* routines for NGMRES solver */

714: typedef enum {
715:   SNES_NGMRES_RESTART_NONE       = 0,
716:   SNES_NGMRES_RESTART_PERIODIC   = 1,
717:   SNES_NGMRES_RESTART_DIFFERENCE = 2} SNESNGMRESRestartType;
718: PETSC_EXTERN const char *const SNESNGMRESRestartTypes[];

720: typedef enum {
721:   SNES_NGMRES_SELECT_NONE       = 0,
722:   SNES_NGMRES_SELECT_DIFFERENCE = 1,
723:   SNES_NGMRES_SELECT_LINESEARCH = 2} SNESNGMRESSelectType;
724: PETSC_EXTERN const char *const SNESNGMRESSelectTypes[];

726: PETSC_EXTERN PetscErrorCode SNESNGMRESSetRestartType(SNES, SNESNGMRESRestartType);
727: PETSC_EXTERN PetscErrorCode SNESNGMRESSetSelectType(SNES, SNESNGMRESSelectType);
728: PETSC_EXTERN PetscErrorCode SNESNGMRESSetRestartFmRise(SNES, PetscBool);
729: PETSC_EXTERN PetscErrorCode SNESNGMRESGetRestartFmRise(SNES, PetscBool*);

731: /* routines for NCG solver */

733: typedef enum {
734:   SNES_NCG_FR    = 0,
735:   SNES_NCG_PRP   = 1,
736:   SNES_NCG_HS    = 2,
737:   SNES_NCG_DY    = 3,
738:   SNES_NCG_CD    = 4} SNESNCGType;
739: PETSC_EXTERN const char *const SNESNCGTypes[];

741: PETSC_EXTERN PetscErrorCode SNESNCGSetType(SNES, SNESNCGType);

743: typedef enum {SNES_QN_SCALE_DEFAULT    = 0,
744:               SNES_QN_SCALE_NONE       = 1,
745:               SNES_QN_SCALE_SHANNO     = 2,
746:               SNES_QN_SCALE_LINESEARCH = 3,
747:               SNES_QN_SCALE_JACOBIAN   = 4} SNESQNScaleType;
748: PETSC_EXTERN const char *const SNESQNScaleTypes[];
749: typedef enum {SNES_QN_RESTART_DEFAULT  = 0,
750:               SNES_QN_RESTART_NONE     = 1,
751:               SNES_QN_RESTART_POWELL   = 2,
752:               SNES_QN_RESTART_PERIODIC = 3} SNESQNRestartType;
753: PETSC_EXTERN const char *const SNESQNRestartTypes[];
754: typedef enum {SNES_QN_LBFGS      = 0,
755:               SNES_QN_BROYDEN    = 1,
756:               SNES_QN_BADBROYDEN = 2
757:              } SNESQNType;
758: PETSC_EXTERN const char *const SNESQNTypes[];

760: PETSC_EXTERN PetscErrorCode SNESQNSetType(SNES, SNESQNType);
761: PETSC_EXTERN PetscErrorCode SNESQNSetScaleType(SNES, SNESQNScaleType);
762: PETSC_EXTERN PetscErrorCode SNESQNSetRestartType(SNES, SNESQNRestartType);

764: PETSC_EXTERN PetscErrorCode SNESNASMGetType(SNES,PCASMType*);
765: PETSC_EXTERN PetscErrorCode SNESNASMSetType(SNES,PCASMType);
766: PETSC_EXTERN PetscErrorCode SNESNASMGetSubdomains(SNES,PetscInt*,SNES**,VecScatter**,VecScatter**,VecScatter**);
767: PETSC_EXTERN PetscErrorCode SNESNASMSetSubdomains(SNES,PetscInt,SNES*,VecScatter*,VecScatter*,VecScatter*);
768: PETSC_EXTERN PetscErrorCode SNESNASMSetDamping(SNES,PetscReal);
769: PETSC_EXTERN PetscErrorCode SNESNASMGetDamping(SNES,PetscReal*);
770: PETSC_EXTERN PetscErrorCode SNESNASMGetSubdomainVecs(SNES,PetscInt*,Vec**,Vec**,Vec**,Vec**);
771: PETSC_EXTERN PetscErrorCode SNESNASMSetComputeFinalJacobian(SNES,PetscBool);

773: typedef enum {SNES_COMPOSITE_ADDITIVE,SNES_COMPOSITE_MULTIPLICATIVE,SNES_COMPOSITE_ADDITIVEOPTIMAL} SNESCompositeType;
774: PETSC_EXTERN const char *const SNESCompositeTypes[];

776: PETSC_EXTERN PetscErrorCode SNESCompositeSetType(SNES,SNESCompositeType);
777: PETSC_EXTERN PetscErrorCode SNESCompositeAddSNES(SNES,SNESType);
778: PETSC_EXTERN PetscErrorCode SNESCompositeGetSNES(SNES,PetscInt,SNES *);
779: PETSC_EXTERN PetscErrorCode SNESCompositeGetNumber(SNES,PetscInt*);
780: PETSC_EXTERN PetscErrorCode SNESCompositeSetDamping(SNES,PetscInt,PetscReal);

782: /*E
783:     SNESFASType - Determines the type of nonlinear multigrid method that is run.

785:    Level: beginner

787:    Values:
788: +  SNES_FAS_MULTIPLICATIVE (default) - traditional V or W cycle as determined by SNESFASSetCycles()
789: .  SNES_FAS_ADDITIVE                 - additive FAS cycle
790: .  SNES_FAS_FULL                     - full FAS cycle
791: -  SNES_FAS_KASKADE                  - Kaskade FAS cycle
792: .seealso: PCMGSetType(), PCMGType

794: E*/
795: typedef enum { SNES_FAS_MULTIPLICATIVE, SNES_FAS_ADDITIVE, SNES_FAS_FULL, SNES_FAS_KASKADE } SNESFASType;
796: PETSC_EXTERN const char *const  SNESFASTypes[];

798: /* called on the finest level FAS instance*/
799: PETSC_EXTERN PetscErrorCode SNESFASSetType(SNES, SNESFASType);
800: PETSC_EXTERN PetscErrorCode SNESFASGetType(SNES, SNESFASType*);
801: PETSC_EXTERN PetscErrorCode SNESFASSetLevels(SNES, PetscInt, MPI_Comm *);
802: PETSC_EXTERN PetscErrorCode SNESFASGetLevels(SNES, PetscInt *);
803: PETSC_EXTERN PetscErrorCode SNESFASGetCycleSNES(SNES, PetscInt, SNES*);
804: PETSC_EXTERN PetscErrorCode SNESFASSetNumberSmoothUp(SNES, PetscInt);
805: PETSC_EXTERN PetscErrorCode SNESFASSetNumberSmoothDown(SNES, PetscInt);
806: PETSC_EXTERN PetscErrorCode SNESFASSetCycles(SNES, PetscInt);
807: PETSC_EXTERN PetscErrorCode SNESFASSetMonitor(SNES, PetscBool);
808: PETSC_EXTERN PetscErrorCode SNESFASSetLog(SNES, PetscBool);

810: PETSC_EXTERN PetscErrorCode SNESFASSetGalerkin(SNES, PetscBool);
811: PETSC_EXTERN PetscErrorCode SNESFASGetGalerkin(SNES, PetscBool*);

813: /* called on any level -- "Cycle" FAS instance */
814: PETSC_EXTERN PetscErrorCode SNESFASCycleGetSmoother(SNES, SNES*);
815: PETSC_EXTERN PetscErrorCode SNESFASCycleGetSmootherUp(SNES, SNES*);
816: PETSC_EXTERN PetscErrorCode SNESFASCycleGetSmootherDown(SNES, SNES*);
817: PETSC_EXTERN PetscErrorCode SNESFASCycleGetCorrection(SNES, SNES*);
818: PETSC_EXTERN PetscErrorCode SNESFASCycleGetInterpolation(SNES, Mat*);
819: PETSC_EXTERN PetscErrorCode SNESFASCycleGetRestriction(SNES, Mat*);
820: PETSC_EXTERN PetscErrorCode SNESFASCycleGetInjection(SNES, Mat*);
821: PETSC_EXTERN PetscErrorCode SNESFASCycleGetRScale(SNES, Vec*);
822: PETSC_EXTERN PetscErrorCode SNESFASCycleSetCycles(SNES, PetscInt);
823: PETSC_EXTERN PetscErrorCode SNESFASCycleIsFine(SNES, PetscBool*);

825: /* called on the (outer) finest level FAS to set/get parameters on any level instance */
826: PETSC_EXTERN PetscErrorCode SNESFASSetInterpolation(SNES, PetscInt, Mat);
827: PETSC_EXTERN PetscErrorCode SNESFASGetInterpolation(SNES, PetscInt, Mat*);
828: PETSC_EXTERN PetscErrorCode SNESFASSetRestriction(SNES, PetscInt, Mat);
829: PETSC_EXTERN PetscErrorCode SNESFASGetRestriction(SNES, PetscInt, Mat*);
830: PETSC_EXTERN PetscErrorCode SNESFASSetInjection(SNES, PetscInt, Mat);
831: PETSC_EXTERN PetscErrorCode SNESFASGetInjection(SNES, PetscInt, Mat*);
832: PETSC_EXTERN PetscErrorCode SNESFASSetRScale(SNES, PetscInt, Vec);
833: PETSC_EXTERN PetscErrorCode SNESFASGetRScale(SNES, PetscInt, Vec*);
834: PETSC_EXTERN PetscErrorCode SNESFASSetContinuation(SNES,PetscBool);

836: PETSC_EXTERN PetscErrorCode SNESFASGetSmoother(SNES,     PetscInt, SNES*);
837: PETSC_EXTERN PetscErrorCode SNESFASGetSmootherUp(SNES,   PetscInt, SNES*);
838: PETSC_EXTERN PetscErrorCode SNESFASGetSmootherDown(SNES, PetscInt, SNES*);
839: PETSC_EXTERN PetscErrorCode SNESFASGetCoarseSolve(SNES, SNES*);

841: /* parameters for full FAS */
842: PETSC_EXTERN PetscErrorCode SNESFASFullSetDownSweep(SNES,PetscBool);
843: PETSC_EXTERN PetscErrorCode SNESFASCreateCoarseVec(SNES,Vec*);
844: PETSC_EXTERN PetscErrorCode SNESFASRestrict(SNES,Vec,Vec);

846: PETSC_EXTERN PetscErrorCode DMSNESCheckFromOptions(SNES,Vec,PetscErrorCode (**)(PetscInt,PetscReal,const PetscReal[],PetscInt,PetscScalar*,void*),void**);

848: #endif