Actual source code: petscsnes.h

petsc-master 2014-12-27
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));

 79: PETSC_EXTERN PetscErrorCode SNESRegisterAll(void);

 81: PETSC_EXTERN PetscErrorCode SNESRegister(const char[],PetscErrorCode (*)(SNES));

 83: PETSC_EXTERN PetscErrorCode SNESGetKSP(SNES,KSP*);
 84: PETSC_EXTERN PetscErrorCode SNESSetKSP(SNES,KSP);
 85: PETSC_EXTERN PetscErrorCode 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,const char prefix[],const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,prefix,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 SNESMonitorSetRatio(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 SNESMonitorJacUpdateSpectrum(SNES,PetscInt,PetscReal,void *);
116: PETSC_EXTERN PetscErrorCode SNESMonitorFields(SNES,PetscInt,PetscReal,void *);
117: PETSC_EXTERN PetscErrorCode KSPMonitorSNES(KSP,PetscInt,PetscReal,void*);
118: PETSC_EXTERN PetscErrorCode KSPMonitorSNESLGResidualNormCreate(const char[],const char[],int,int,int,int,PetscObject**);
119: PETSC_EXTERN PetscErrorCode KSPMonitorSNESLGResidualNorm(KSP,PetscInt,PetscReal,PetscObject*);
120: PETSC_EXTERN PetscErrorCode KSPMonitorSNESLGResidualNormDestroy(PetscObject**);

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

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

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

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

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

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

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

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

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

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

171:    Level: beginner

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

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

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

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

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

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

207:    Developer Notes: this must match finclude/petscsnes.h

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

212:    Each reason has its own manual page.

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

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

237:    Level: beginner

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

241: M*/

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

246:    Level: beginner

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

250: M*/

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

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

259:    Level: beginner

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

263: M*/

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

269:    Level: beginner

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

273: M*/

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

279:    Level: beginner

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

283: M*/

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

288:    Level: beginner

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

292: M*/

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

297:    Level: beginner

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

301: M*/

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

307:    Level: beginner

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

311: M*/

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

316:    Level: beginner

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

320: M*/

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

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

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

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

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

349: /*E
350:     SNESNormSchedule - Frequency with which the norm is computed

352:    Level: advanced

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

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

360: .seealso: SNESSolve(), SNESGetConvergedReason(), KSPSetNormType(),
361:           KSPSetConvergenceTest(), KSPSetPCSide()
362: E*/

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

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

375:    Level: advanced

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

380: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_DEFAULT
381: M*/

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

386:    Level: advanced

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

391: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_NONE
392: M*/

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

397:    Level: advanced

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

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

406: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_FINAL_ONLY, SNES_NORM_INITIAL_FINAL_ONLY
407: M*/

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

412:    Level: advanced

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

420: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_INITIAL_ONLY, SNES_NORM_INITIAL_FINAL_ONLY
421: M*/

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

426:    Level: advanced

428:    Notes:
429:    This method combines the benefits of SNES_NORM_INITIAL_ONLY and SNES_NORM_FINAL_ONLY.

431: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_SNES_NORM_INITIAL_ONLY, SNES_NORM_FINAL_ONLY
432: M*/

434: PETSC_EXTERN PetscErrorCode SNESSetNormSchedule(SNES,SNESNormSchedule);
435: PETSC_EXTERN PetscErrorCode SNESGetNormSchedule(SNES,SNESNormSchedule*);

437: /*E
438:     SNESFunctionType - Type of function computed

440:    Level: advanced

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

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

452: PETSC_EXTERN PetscErrorCode SNESSetFunctionType(SNES,SNESFunctionType);
453: PETSC_EXTERN PetscErrorCode SNESGetFunctionType(SNES,SNESFunctionType*);

455: PETSC_EXTERN PetscErrorCode SNESSetNGS(SNES,PetscErrorCode (*)(SNES,Vec,Vec,void*),void*);
456: PETSC_EXTERN PetscErrorCode SNESGetNGS(SNES,PetscErrorCode (**)(SNES,Vec,Vec,void*),void**);
457: PETSC_EXTERN PetscErrorCode SNESSetUseNGS(SNES,PetscBool);
458: PETSC_EXTERN PetscErrorCode SNESGetUseNGS(SNES,PetscBool *);
459: PETSC_EXTERN PetscErrorCode SNESComputeNGS(SNES,Vec,Vec);

461: PETSC_EXTERN PetscErrorCode SNESNGSSetSweeps(SNES,PetscInt);
462: PETSC_EXTERN PetscErrorCode SNESNGSGetSweeps(SNES,PetscInt *);
463: PETSC_EXTERN PetscErrorCode SNESNGSSetTolerances(SNES,PetscReal,PetscReal,PetscReal,PetscInt);
464: PETSC_EXTERN PetscErrorCode SNESNGSGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,PetscInt*);

466: PETSC_EXTERN PetscErrorCode SNESUpdateCheckJacobian(SNES,PetscInt);

468: PETSC_EXTERN PetscErrorCode SNESShellGetContext(SNES,void**);
469: PETSC_EXTERN PetscErrorCode SNESShellSetContext(SNES,void*);
470: PETSC_EXTERN PetscErrorCode SNESShellSetSolve(SNES,PetscErrorCode (*)(SNES,Vec));

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

474: typedef struct _p_LineSearch* SNESLineSearch;

476: /*S
477:      SNESLineSearch - Abstract PETSc object that manages line-search operations

479:    Level: beginner

481:   Concepts: nonlinear solvers, line search

483: .seealso:  SNESLineSearchCreate(), SNESLineSearchSetType(), SNES
484: S*/

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

489:    Level: beginner

491: .seealso: SNESLineSearchSetType(), SNES
492: J*/

494: typedef const char* SNESLineSearchType;
495: #define SNESLINESEARCHBT                 "bt"
496: #define SNESLINESEARCHBASIC              "basic"
497: #define SNESLINESEARCHL2                 "l2"
498: #define SNESLINESEARCHCP                 "cp"
499: #define SNESLINESEARCHSHELL              "shell"

501: PETSC_EXTERN PetscBool         SNESRegisterAllCalled;
502: PETSC_EXTERN PetscFunctionList SNESList;
503: PETSC_EXTERN PetscClassId      SNESLINESEARCH_CLASSID;
504: PETSC_EXTERN PetscBool         SNESLineSearchRegisterAllCalled;
505: PETSC_EXTERN PetscFunctionList SNESLineSearchList;
506: PETSC_EXTERN PetscLogEvent     SNESLineSearch_Apply;

508: #define SNES_LINESEARCH_ORDER_LINEAR    1
509: #define SNES_LINESEARCH_ORDER_QUADRATIC 2
510: #define SNES_LINESEARCH_ORDER_CUBIC     3

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

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

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

532: PETSC_EXTERN PetscErrorCode SNESLineSearchSetPreCheck(SNESLineSearch, PetscErrorCode (*)(SNESLineSearch,Vec,Vec,PetscBool*,void*), void *ctx);
533: PETSC_EXTERN PetscErrorCode SNESLineSearchSetPostCheck(SNESLineSearch, PetscErrorCode (*)(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *,void*), void *ctx);

535: PETSC_EXTERN PetscErrorCode SNESLineSearchGetPreCheck(SNESLineSearch, PetscErrorCode (**)(SNESLineSearch,Vec,Vec,PetscBool*,void*), void **ctx);
536: PETSC_EXTERN PetscErrorCode SNESLineSearchGetPostCheck(SNESLineSearch, PetscErrorCode (**)(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *,void*), void **ctx);

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

540: PETSC_EXTERN PetscErrorCode SNESLineSearchSetVIFunctions(SNESLineSearch, SNESLineSearchVIProjectFunc, SNESLineSearchVINormFunc);
541: PETSC_EXTERN PetscErrorCode SNESLineSearchGetVIFunctions(SNESLineSearch, SNESLineSearchVIProjectFunc*, SNESLineSearchVINormFunc*);

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

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

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

553: PETSC_EXTERN PetscErrorCode SNESLineSearchGetLambda(SNESLineSearch,PetscReal*);
554: PETSC_EXTERN PetscErrorCode SNESLineSearchSetLambda(SNESLineSearch,PetscReal);

556: PETSC_EXTERN PetscErrorCode SNESLineSearchGetDamping(SNESLineSearch,PetscReal*);
557: PETSC_EXTERN PetscErrorCode SNESLineSearchSetDamping(SNESLineSearch,PetscReal);

559: PETSC_EXTERN PetscErrorCode SNESLineSearchGetOrder(SNESLineSearch,PetscInt *order);
560: PETSC_EXTERN PetscErrorCode SNESLineSearchSetOrder(SNESLineSearch,PetscInt order);

562: PETSC_EXTERN PetscErrorCode SNESLineSearchGetSuccess(SNESLineSearch, PetscBool*);
563: PETSC_EXTERN PetscErrorCode SNESLineSearchSetSuccess(SNESLineSearch, PetscBool);

565: PETSC_EXTERN PetscErrorCode SNESLineSearchGetVecs(SNESLineSearch,Vec*,Vec*,Vec*,Vec*,Vec*);
566: PETSC_EXTERN PetscErrorCode SNESLineSearchSetVecs(SNESLineSearch,Vec,Vec,Vec,Vec,Vec);

568: PETSC_EXTERN PetscErrorCode SNESLineSearchGetNorms(SNESLineSearch, PetscReal *, PetscReal *, PetscReal *);
569: PETSC_EXTERN PetscErrorCode SNESLineSearchSetNorms(SNESLineSearch, PetscReal, PetscReal, PetscReal);
570: PETSC_EXTERN PetscErrorCode SNESLineSearchComputeNorms(SNESLineSearch);
571: PETSC_EXTERN PetscErrorCode SNESLineSearchSetComputeNorms(SNESLineSearch, PetscBool);

573: PETSC_EXTERN PetscErrorCode SNESLineSearchSetMonitor(SNESLineSearch, PetscBool);
574: PETSC_EXTERN PetscErrorCode SNESLineSearchGetMonitor(SNESLineSearch, PetscViewer*);

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


580: /* Shell interface functions */
581: PETSC_EXTERN PetscErrorCode SNESLineSearchShellSetUserFunc(SNESLineSearch,SNESLineSearchUserFunc,void*);
582: PETSC_EXTERN PetscErrorCode SNESLineSearchShellGetUserFunc(SNESLineSearch,SNESLineSearchUserFunc*,void**);

584: /* BT interface functions */
585: PETSC_EXTERN PetscErrorCode SNESLineSearchBTSetAlpha(SNESLineSearch, PetscReal);
586: PETSC_EXTERN PetscErrorCode SNESLineSearchBTGetAlpha(SNESLineSearch, PetscReal*);

588: /*register line search types */
589: PETSC_EXTERN PetscErrorCode SNESLineSearchRegister(const char[],PetscErrorCode(*)(SNESLineSearch));
590: PETSC_EXTERN PetscErrorCode SNESLineSearchRegisterAll(void);

592: /* Routines for VI solver */
593: PETSC_EXTERN PetscErrorCode SNESVISetVariableBounds(SNES,Vec,Vec);
594: PETSC_EXTERN PetscErrorCode SNESVISetComputeVariableBounds(SNES, PetscErrorCode (*)(SNES,Vec,Vec));
595: PETSC_EXTERN PetscErrorCode SNESVIGetInactiveSet(SNES,IS*);
596: PETSC_EXTERN PetscErrorCode SNESVIGetActiveSetIS(SNES,Vec,Vec,IS*);
597: PETSC_EXTERN PetscErrorCode SNESVIComputeInactiveSetFnorm(SNES,Vec,Vec,PetscReal*);
598: PETSC_EXTERN PetscErrorCode SNESVISetRedundancyCheck(SNES,PetscErrorCode(*)(SNES,IS,IS*,void*),void*);

600: PETSC_EXTERN PetscErrorCode SNESTestLocalMin(SNES);

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

605: PETSC_EXTERN PetscErrorCode SNESSetDM(SNES,DM);
606: PETSC_EXTERN PetscErrorCode SNESGetDM(SNES,DM*);
607: PETSC_EXTERN PetscErrorCode SNESSetNPC(SNES,SNES);
608: PETSC_EXTERN PetscErrorCode SNESGetNPC(SNES,SNES*);
609: PETSC_EXTERN PetscErrorCode SNESHasNPC(SNES,PetscBool*);
610: PETSC_EXTERN PetscErrorCode SNESApplyNPC(SNES,Vec,Vec,Vec);
611: PETSC_EXTERN PetscErrorCode SNESGetNPCFunction(SNES,Vec,PetscReal*);
612: PETSC_EXTERN PetscErrorCode SNESComputeFunctionDefaultNPC(SNES,Vec,Vec);
613: PETSC_EXTERN PetscErrorCode SNESSetNPCSide(SNES,PCSide);
614: PETSC_EXTERN PetscErrorCode SNESGetNPCSide(SNES,PCSide*);
615: PETSC_EXTERN PetscErrorCode SNESSetLineSearch(SNES,SNESLineSearch);
616: PETSC_EXTERN PetscErrorCode SNESGetLineSearch(SNES,SNESLineSearch*);
617: PETSC_EXTERN PetscErrorCode SNESRestrictHookAdd(SNES,PetscErrorCode (*)(SNES,SNES,void*),void*);
618: PETSC_EXTERN PetscErrorCode SNESRestrictHooksRun(SNES,SNES);

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

623: PETSC_EXTERN PetscErrorCode SNESSetUpMatrices(SNES);
624: PETSC_EXTERN PetscErrorCode DMSNESSetFunction(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),void*);
625: PETSC_EXTERN PetscErrorCode DMSNESGetFunction(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),void**);
626: PETSC_EXTERN PetscErrorCode DMSNESSetNGS(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),void*);
627: PETSC_EXTERN PetscErrorCode DMSNESGetNGS(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),void**);
628: PETSC_EXTERN PetscErrorCode DMSNESSetJacobian(DM,PetscErrorCode(*)(SNES,Vec,Mat,Mat,void*),void*);
629: PETSC_EXTERN PetscErrorCode DMSNESGetJacobian(DM,PetscErrorCode(**)(SNES,Vec,Mat,Mat,void*),void**);
630: PETSC_EXTERN PetscErrorCode DMSNESSetPicard(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),PetscErrorCode(*)(SNES,Vec,Mat,Mat,void*),void*);
631: PETSC_EXTERN PetscErrorCode DMSNESGetPicard(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),PetscErrorCode(**)(SNES,Vec,Mat,Mat,void*),void**);
632: PETSC_EXTERN PetscErrorCode DMSNESSetObjective(DM,PetscErrorCode (*)(SNES,Vec,PetscReal *,void*),void*);
633: PETSC_EXTERN PetscErrorCode DMSNESGetObjective(DM,PetscErrorCode (**)(SNES,Vec,PetscReal *,void*),void**);

635: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESFunction)(DMDALocalInfo*,void*,void*,void*);
636: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESJacobian)(DMDALocalInfo*,void*,Mat,Mat,void*);
637: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESObjective)(DMDALocalInfo*,void*,PetscReal*,void*);

639: PETSC_EXTERN PetscErrorCode DMDASNESSetFunctionLocal(DM,InsertMode,DMDASNESFunction,void*);
640: PETSC_EXTERN PetscErrorCode DMDASNESSetJacobianLocal(DM,DMDASNESJacobian,void*);
641: PETSC_EXTERN PetscErrorCode DMDASNESSetObjectiveLocal(DM,DMDASNESObjective,void*);
642: PETSC_EXTERN PetscErrorCode DMDASNESSetPicardLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,void*,void*,void*),PetscErrorCode (*)(DMDALocalInfo*,void*,Mat,Mat,void*),void*);

644: PETSC_EXTERN PetscErrorCode DMPlexSNESGetGeometryFEM(DM,Vec*);
645: PETSC_EXTERN PetscErrorCode DMPlexSNESGetGeometryFVM(DM,Vec*,Vec*,PetscReal*);
646: PETSC_EXTERN PetscErrorCode DMPlexSNESGetGradientDM(DM,PetscFV,DM*);
647: PETSC_EXTERN PetscErrorCode DMPlexGetCellFields(DM, PetscInt, PetscInt, Vec, Vec, Vec, PetscScalar **, PetscScalar **, PetscScalar **);
648: PETSC_EXTERN PetscErrorCode DMPlexRestoreCellFields(DM, PetscInt, PetscInt, Vec, Vec, Vec, PetscScalar **, PetscScalar **, PetscScalar **);
649: PETSC_EXTERN PetscErrorCode DMPlexGetFaceFields(DM, PetscInt, PetscInt, Vec, Vec, Vec, Vec, Vec, PetscScalar **, PetscScalar **);
650: PETSC_EXTERN PetscErrorCode DMPlexRestoreFaceFields(DM, PetscInt, PetscInt, Vec, Vec, Vec, Vec, Vec, PetscScalar **, PetscScalar **);
651: PETSC_EXTERN PetscErrorCode DMPlexGetFaceGeometry(DM, PetscInt, PetscInt, Vec, Vec, PetscFVFaceGeom **, PetscReal **);
652: PETSC_EXTERN PetscErrorCode DMPlexRestoreFaceGeometry(DM, PetscInt, PetscInt, Vec, Vec, PetscFVFaceGeom **, PetscReal **);

654: PETSC_EXTERN PetscErrorCode DMSNESSetFunctionLocal(DM,PetscErrorCode (*)(DM,Vec,Vec,void*),void*);
655: PETSC_EXTERN PetscErrorCode DMSNESSetJacobianLocal(DM,PetscErrorCode (*)(DM,Vec,Mat,Mat,void*),void*);

657: /* Routines for Multiblock solver */
658: PETSC_EXTERN PetscErrorCode SNESMultiblockSetFields(SNES, const char [], PetscInt, const PetscInt *);
659: PETSC_EXTERN PetscErrorCode SNESMultiblockSetIS(SNES, const char [], IS);
660: PETSC_EXTERN PetscErrorCode SNESMultiblockSetBlockSize(SNES, PetscInt);
661: PETSC_EXTERN PetscErrorCode SNESMultiblockSetType(SNES, PCCompositeType);

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

666:    Level: intermediate

668: .seealso: SNESMSSetType(), SNES
669: J*/
670: typedef const char* SNESMSType;
671: #define SNESMSM62       "m62"
672: #define SNESMSEULER     "euler"
673: #define SNESMSJAMESON83 "jameson83"
674: #define SNESMSVLTP21    "vltp21"
675: #define SNESMSVLTP31    "vltp31"
676: #define SNESMSVLTP41    "vltp41"
677: #define SNESMSVLTP51    "vltp51"
678: #define SNESMSVLTP61    "vltp61"

680: PETSC_EXTERN PetscErrorCode SNESMSRegister(SNESMSType,PetscInt,PetscInt,PetscReal,const PetscReal[],const PetscReal[],const PetscReal[]);
681: PETSC_EXTERN PetscErrorCode SNESMSSetType(SNES,SNESMSType);
682: PETSC_EXTERN PetscErrorCode SNESMSFinalizePackage(void);
683: PETSC_EXTERN PetscErrorCode SNESMSInitializePackage(void);
684: PETSC_EXTERN PetscErrorCode SNESMSRegisterDestroy(void);
685: PETSC_EXTERN PetscErrorCode SNESMSRegisterAll(void);

687: /* routines for NGMRES solver */

689: typedef enum {
690:   SNES_NGMRES_RESTART_NONE       = 0,
691:   SNES_NGMRES_RESTART_PERIODIC   = 1,
692:   SNES_NGMRES_RESTART_DIFFERENCE = 2} SNESNGMRESRestartType;
693: PETSC_EXTERN const char *const SNESNGMRESRestartTypes[];

695: typedef enum {
696:   SNES_NGMRES_SELECT_NONE       = 0,
697:   SNES_NGMRES_SELECT_DIFFERENCE = 1,
698:   SNES_NGMRES_SELECT_LINESEARCH = 2} SNESNGMRESSelectType;
699: PETSC_EXTERN const char *const SNESNGMRESSelectTypes[];

701: PETSC_EXTERN PetscErrorCode SNESNGMRESSetRestartType(SNES, SNESNGMRESRestartType);
702: PETSC_EXTERN PetscErrorCode SNESNGMRESSetSelectType(SNES, SNESNGMRESSelectType);

704: /* routines for NCG solver */

706: typedef enum {
707:   SNES_NCG_FR    = 0,
708:   SNES_NCG_PRP   = 1,
709:   SNES_NCG_HS    = 2,
710:   SNES_NCG_DY    = 3,
711:   SNES_NCG_CD    = 4} SNESNCGType;
712: PETSC_EXTERN const char *const SNESNCGTypes[];

714: PETSC_EXTERN PetscErrorCode SNESNCGSetType(SNES, SNESNCGType);

716: typedef enum {SNES_QN_SCALE_DEFAULT    = 0,
717:               SNES_QN_SCALE_NONE       = 1,
718:               SNES_QN_SCALE_SHANNO     = 2,
719:               SNES_QN_SCALE_LINESEARCH = 3,
720:               SNES_QN_SCALE_JACOBIAN   = 4} SNESQNScaleType;
721: PETSC_EXTERN const char *const SNESQNScaleTypes[];
722: typedef enum {SNES_QN_RESTART_DEFAULT  = 0,
723:               SNES_QN_RESTART_NONE     = 1,
724:               SNES_QN_RESTART_POWELL   = 2,
725:               SNES_QN_RESTART_PERIODIC = 3} SNESQNRestartType;
726: PETSC_EXTERN const char *const SNESQNRestartTypes[];
727: typedef enum {SNES_QN_LBFGS      = 0,
728:               SNES_QN_BROYDEN    = 1,
729:               SNES_QN_BADBROYDEN = 2
730:              } SNESQNType;
731: PETSC_EXTERN const char *const SNESQNTypes[];

733: PETSC_EXTERN PetscErrorCode SNESQNSetType(SNES, SNESQNType);
734: PETSC_EXTERN PetscErrorCode SNESQNSetScaleType(SNES, SNESQNScaleType);
735: PETSC_EXTERN PetscErrorCode SNESQNSetRestartType(SNES, SNESQNRestartType);

737: PETSC_EXTERN PetscErrorCode SNESNASMGetType(SNES,PCASMType*);
738: PETSC_EXTERN PetscErrorCode SNESNASMSetType(SNES,PCASMType);
739: PETSC_EXTERN PetscErrorCode SNESNASMGetSubdomains(SNES,PetscInt*,SNES**,VecScatter**,VecScatter**,VecScatter**);
740: PETSC_EXTERN PetscErrorCode SNESNASMSetSubdomains(SNES,PetscInt,SNES*,VecScatter*,VecScatter*,VecScatter*);
741: PETSC_EXTERN PetscErrorCode SNESNASMSetDamping(SNES,PetscReal);
742: PETSC_EXTERN PetscErrorCode SNESNASMGetDamping(SNES,PetscReal*);
743: PETSC_EXTERN PetscErrorCode SNESNASMGetSubdomainVecs(SNES,PetscInt*,Vec**,Vec**,Vec**,Vec**);
744: PETSC_EXTERN PetscErrorCode SNESNASMSetComputeFinalJacobian(SNES,PetscBool);

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

749: PETSC_EXTERN PetscErrorCode SNESCompositeSetType(SNES,SNESCompositeType);
750: PETSC_EXTERN PetscErrorCode SNESCompositeAddSNES(SNES,SNESType);
751: PETSC_EXTERN PetscErrorCode SNESCompositeGetSNES(SNES,PetscInt,SNES *);
752: PETSC_EXTERN PetscErrorCode SNESCompositeGetNumber(SNES,PetscInt*);
753: PETSC_EXTERN PetscErrorCode SNESCompositeSetDamping(SNES,PetscInt,PetscReal);

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

758:    Level: beginner

760:    Values:
761: +  SNES_FAS_MULTIPLICATIVE (default) - traditional V or W cycle as determined by SNESFASSetCycles()
762: .  SNES_FAS_ADDITIVE                 - additive FAS cycle
763: .  SNES_FAS_FULL                     - full FAS cycle
764: -  SNES_FAS_KASKADE                  - Kaskade FAS cycle
765: .seealso: PCMGSetType(), PCMGType

767: E*/
768: typedef enum { SNES_FAS_MULTIPLICATIVE, SNES_FAS_ADDITIVE, SNES_FAS_FULL, SNES_FAS_KASKADE } SNESFASType;
769: PETSC_EXTERN const char *const  SNESFASTypes[];

771: /* called on the finest level FAS instance*/
772: PETSC_EXTERN PetscErrorCode SNESFASSetType(SNES, SNESFASType);
773: PETSC_EXTERN PetscErrorCode SNESFASGetType(SNES, SNESFASType*);
774: PETSC_EXTERN PetscErrorCode SNESFASSetLevels(SNES, PetscInt, MPI_Comm *);
775: PETSC_EXTERN PetscErrorCode SNESFASGetLevels(SNES, PetscInt *);
776: PETSC_EXTERN PetscErrorCode SNESFASGetCycleSNES(SNES, PetscInt, SNES*);
777: PETSC_EXTERN PetscErrorCode SNESFASSetNumberSmoothUp(SNES, PetscInt);
778: PETSC_EXTERN PetscErrorCode SNESFASSetNumberSmoothDown(SNES, PetscInt);
779: PETSC_EXTERN PetscErrorCode SNESFASSetCycles(SNES, PetscInt);
780: PETSC_EXTERN PetscErrorCode SNESFASSetMonitor(SNES, PetscBool);
781: PETSC_EXTERN PetscErrorCode SNESFASSetLog(SNES, PetscBool);

783: PETSC_EXTERN PetscErrorCode SNESFASSetGalerkin(SNES, PetscBool);
784: PETSC_EXTERN PetscErrorCode SNESFASGetGalerkin(SNES, PetscBool*);

786: /* called on any level -- "Cycle" FAS instance */
787: PETSC_EXTERN PetscErrorCode SNESFASCycleGetSmoother(SNES, SNES*);
788: PETSC_EXTERN PetscErrorCode SNESFASCycleGetSmootherUp(SNES, SNES*);
789: PETSC_EXTERN PetscErrorCode SNESFASCycleGetSmootherDown(SNES, SNES*);
790: PETSC_EXTERN PetscErrorCode SNESFASCycleGetCorrection(SNES, SNES*);
791: PETSC_EXTERN PetscErrorCode SNESFASCycleGetInterpolation(SNES, Mat*);
792: PETSC_EXTERN PetscErrorCode SNESFASCycleGetRestriction(SNES, Mat*);
793: PETSC_EXTERN PetscErrorCode SNESFASCycleGetInjection(SNES, Mat*);
794: PETSC_EXTERN PetscErrorCode SNESFASCycleGetRScale(SNES, Vec*);
795: PETSC_EXTERN PetscErrorCode SNESFASCycleSetCycles(SNES, PetscInt);
796: PETSC_EXTERN PetscErrorCode SNESFASCycleIsFine(SNES, PetscBool*);

798: /* called on the (outer) finest level FAS to set/get parameters on any level instance */
799: PETSC_EXTERN PetscErrorCode SNESFASSetInterpolation(SNES, PetscInt, Mat);
800: PETSC_EXTERN PetscErrorCode SNESFASGetInterpolation(SNES, PetscInt, Mat*);
801: PETSC_EXTERN PetscErrorCode SNESFASSetRestriction(SNES, PetscInt, Mat);
802: PETSC_EXTERN PetscErrorCode SNESFASGetRestriction(SNES, PetscInt, Mat*);
803: PETSC_EXTERN PetscErrorCode SNESFASSetInjection(SNES, PetscInt, Mat);
804: PETSC_EXTERN PetscErrorCode SNESFASGetInjection(SNES, PetscInt, Mat*);
805: PETSC_EXTERN PetscErrorCode SNESFASSetRScale(SNES, PetscInt, Vec);
806: PETSC_EXTERN PetscErrorCode SNESFASGetRScale(SNES, PetscInt, Vec*);
807: PETSC_EXTERN PetscErrorCode SNESFASSetContinuation(SNES,PetscBool);

809: PETSC_EXTERN PetscErrorCode SNESFASGetSmoother(SNES,     PetscInt, SNES*);
810: PETSC_EXTERN PetscErrorCode SNESFASGetSmootherUp(SNES,   PetscInt, SNES*);
811: PETSC_EXTERN PetscErrorCode SNESFASGetSmootherDown(SNES, PetscInt, SNES*);
812: PETSC_EXTERN PetscErrorCode SNESFASGetCoarseSolve(SNES, SNES*);

814: /* parameters for full FAS */
815: PETSC_EXTERN PetscErrorCode SNESFASFullSetDownSweep(SNES,PetscBool);
816: PETSC_EXTERN PetscErrorCode SNESFASCreateCoarseVec(SNES,Vec*);
817: PETSC_EXTERN PetscErrorCode SNESFASRestrict(SNES,Vec,Vec);

819: #endif