Actual source code: petscsnes.h

petsc-dev 2014-07-30
Report Typos and Errors
  1: /*
  2:     User interface for the nonlinear solvers package.
  3: */
  6: #include <petscksp.h>
  7: #include <petscdmtypes.h>
  8: #include <petscdmdatypes.h>

 10: /*S
 11:      SNES - Abstract PETSc object that manages all nonlinear solves

 13:    Level: beginner

 15:   Concepts: nonlinear solvers

 17: .seealso:  SNESCreate(), SNESSetType(), SNESType, TS, KSP, KSP, PC, SNESDestroy()
 18: S*/
 19: typedef struct _p_SNES* SNES;

 21: /*J
 22:     SNESType - String with the name of a PETSc SNES method.

 24:    Level: beginner

 26: .seealso: SNESSetType(), SNES, SNESCreate(), SNESDestroy(), SNESSetFromOptions()
 27: J*/
 28: typedef const char* SNESType;
 29: #define SNESNEWTONLS     "newtonls"
 30: #define SNESNEWTONTR     "newtontr"
 31: #define SNESPYTHON       "python"
 32: #define SNESTEST         "test"
 33: #define SNESNRICHARDSON  "nrichardson"
 34: #define SNESKSPONLY      "ksponly"
 35: #define SNESVINEWTONRSLS "vinewtonrsls"
 36: #define SNESVINEWTONSSLS "vinewtonssls"
 37: #define SNESNGMRES       "ngmres"
 38: #define SNESQN           "qn"
 39: #define SNESSHELL        "shell"
 40: #define SNESNGS          "ngs"
 41: #define SNESNCG          "ncg"
 42: #define SNESFAS          "fas"
 43: #define SNESMS           "ms"
 44: #define SNESNASM         "nasm"
 45: #define SNESANDERSON     "anderson"
 46: #define SNESASPIN        "aspin"
 47: #define SNESCOMPOSITE    "composite"

 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 SNESMonitorCancel(SNES);
 62: PETSC_EXTERN PetscErrorCode SNESMonitorSAWs(SNES,PetscInt,PetscReal,void*);
 63: PETSC_EXTERN PetscErrorCode SNESMonitorSAWsCreate(SNES,void**);
 64: PETSC_EXTERN PetscErrorCode SNESMonitorSAWsDestroy(void**);
 65: PETSC_EXTERN PetscErrorCode SNESSetConvergenceHistory(SNES,PetscReal[],PetscInt[],PetscInt,PetscBool );
 66: PETSC_EXTERN PetscErrorCode SNESGetConvergenceHistory(SNES,PetscReal*[],PetscInt *[],PetscInt *);
 67: PETSC_EXTERN PetscErrorCode SNESSetUp(SNES);
 68: PETSC_EXTERN PetscErrorCode SNESSolve(SNES,Vec,Vec);
 69: PETSC_EXTERN PetscErrorCode SNESSetErrorIfNotConverged(SNES,PetscBool );
 70: PETSC_EXTERN PetscErrorCode SNESGetErrorIfNotConverged(SNES,PetscBool  *);

 72: PETSC_EXTERN PetscErrorCode SNESSetWorkVecs(SNES,PetscInt);

 74: PETSC_EXTERN PetscErrorCode SNESAddOptionsChecker(PetscErrorCode (*)(SNES));

 76: PETSC_EXTERN PetscErrorCode SNESSetUpdate(SNES, PetscErrorCode (*)(SNES, PetscInt));

 78: PETSC_EXTERN PetscErrorCode SNESRegisterAll(void);

 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 SNESGetSolution(SNES,Vec*);
 85: PETSC_EXTERN PetscErrorCode SNESGetSolutionUpdate(SNES,Vec*);
 86: PETSC_EXTERN PetscErrorCode SNESGetRhs(SNES,Vec*);
 87: PETSC_EXTERN PetscErrorCode SNESView(SNES,PetscViewer);
 88: PETSC_EXTERN PetscErrorCode SNESLoad(SNES,PetscViewer);
 89: PETSC_STATIC_INLINE PetscErrorCode SNESViewFromOptions(SNES A,const char prefix[],const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,prefix,name);}

 91: #define SNES_FILE_CLASSID 1211224

 93: PETSC_EXTERN PetscErrorCode SNESSetOptionsPrefix(SNES,const char[]);
 94: PETSC_EXTERN PetscErrorCode SNESAppendOptionsPrefix(SNES,const char[]);
 95: PETSC_EXTERN PetscErrorCode SNESGetOptionsPrefix(SNES,const char*[]);
 96: PETSC_EXTERN PetscErrorCode SNESSetFromOptions(SNES);

 98: PETSC_EXTERN PetscErrorCode MatCreateSNESMF(SNES,Mat*);
 99: PETSC_EXTERN PetscErrorCode MatMFFDComputeJacobian(SNES,Vec,Mat,Mat,void*);

101: PETSC_EXTERN PetscErrorCode MatDAADSetSNES(Mat,SNES);

103: PETSC_EXTERN PetscErrorCode SNESGetType(SNES,SNESType*);
104: PETSC_EXTERN PetscErrorCode SNESMonitorDefault(SNES,PetscInt,PetscReal,void *);
105: PETSC_EXTERN PetscErrorCode SNESMonitorRange(SNES,PetscInt,PetscReal,void *);
106: PETSC_EXTERN PetscErrorCode SNESMonitorRatio(SNES,PetscInt,PetscReal,void *);
107: PETSC_EXTERN PetscErrorCode SNESMonitorSetRatio(SNES,PetscViewer);
108: PETSC_EXTERN PetscErrorCode SNESMonitorSolution(SNES,PetscInt,PetscReal,void *);
109: PETSC_EXTERN PetscErrorCode SNESMonitorResidual(SNES,PetscInt,PetscReal,void *);
110: PETSC_EXTERN PetscErrorCode SNESMonitorSolutionUpdate(SNES,PetscInt,PetscReal,void *);
111: PETSC_EXTERN PetscErrorCode SNESMonitorDefaultShort(SNES,PetscInt,PetscReal,void *);
112: PETSC_EXTERN PetscErrorCode SNESMonitorJacUpdateSpectrum(SNES,PetscInt,PetscReal,void *);
113: PETSC_EXTERN PetscErrorCode SNESMonitorFields(SNES,PetscInt,PetscReal,void *);
114: PETSC_EXTERN PetscErrorCode SNESSetTolerances(SNES,PetscReal,PetscReal,PetscReal,PetscInt,PetscInt);
115: PETSC_EXTERN PetscErrorCode SNESGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,PetscInt*,PetscInt*);
116: PETSC_EXTERN PetscErrorCode SNESSetTrustRegionTolerance(SNES,PetscReal);
117: PETSC_EXTERN PetscErrorCode SNESGetIterationNumber(SNES,PetscInt*);
118: PETSC_EXTERN PetscErrorCode SNESSetIterationNumber(SNES,PetscInt);

120: PETSC_EXTERN PetscErrorCode SNESGetNonlinearStepFailures(SNES,PetscInt*);
121: PETSC_EXTERN PetscErrorCode SNESSetMaxNonlinearStepFailures(SNES,PetscInt);
122: PETSC_EXTERN PetscErrorCode SNESGetMaxNonlinearStepFailures(SNES,PetscInt*);
123: PETSC_EXTERN PetscErrorCode SNESGetNumberFunctionEvals(SNES,PetscInt*);

125: PETSC_EXTERN PetscErrorCode SNESSetLagPreconditioner(SNES,PetscInt);
126: PETSC_EXTERN PetscErrorCode SNESGetLagPreconditioner(SNES,PetscInt*);
127: PETSC_EXTERN PetscErrorCode SNESSetLagJacobian(SNES,PetscInt);
128: PETSC_EXTERN PetscErrorCode SNESGetLagJacobian(SNES,PetscInt*);
129: PETSC_EXTERN PetscErrorCode SNESSetLagPreconditionerPersists(SNES,PetscBool);
130: PETSC_EXTERN PetscErrorCode SNESSetLagJacobianPersists(SNES,PetscBool);
131: PETSC_EXTERN PetscErrorCode SNESSetGridSequence(SNES,PetscInt);

133: PETSC_EXTERN PetscErrorCode SNESGetLinearSolveIterations(SNES,PetscInt*);
134: PETSC_EXTERN PetscErrorCode SNESGetLinearSolveFailures(SNES,PetscInt*);
135: PETSC_EXTERN PetscErrorCode SNESSetMaxLinearSolveFailures(SNES,PetscInt);
136: PETSC_EXTERN PetscErrorCode SNESGetMaxLinearSolveFailures(SNES,PetscInt*);
137: PETSC_EXTERN PetscErrorCode SNESSetCountersReset(SNES,PetscBool);

139: PETSC_EXTERN PetscErrorCode SNESKSPSetUseEW(SNES,PetscBool );
140: PETSC_EXTERN PetscErrorCode SNESKSPGetUseEW(SNES,PetscBool *);
141: PETSC_EXTERN PetscErrorCode SNESKSPSetParametersEW(SNES,PetscInt,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal);
142: PETSC_EXTERN PetscErrorCode SNESKSPGetParametersEW(SNES,PetscInt*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*);

144: #include <petscdrawtypes.h>
145: PETSC_EXTERN PetscErrorCode SNESMonitorLGCreate(const char[],const char[],int,int,int,int,PetscDrawLG*);
146: PETSC_EXTERN PetscErrorCode SNESMonitorLGResidualNorm(SNES,PetscInt,PetscReal,void*);
147: PETSC_EXTERN PetscErrorCode SNESMonitorLGDestroy(PetscDrawLG*);
148: PETSC_EXTERN PetscErrorCode SNESMonitorLGRange(SNES,PetscInt,PetscReal,void*);

150: PETSC_EXTERN PetscErrorCode SNESSetApplicationContext(SNES,void *);
151: PETSC_EXTERN PetscErrorCode SNESGetApplicationContext(SNES,void *);
152: PETSC_EXTERN PetscErrorCode SNESSetComputeApplicationContext(SNES,PetscErrorCode (*)(SNES,void**),PetscErrorCode (*)(void**));

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

156: PETSC_EXTERN PetscErrorCode SNESSetFunctionDomainError(SNES);
157: PETSC_EXTERN PetscErrorCode SNESGetFunctionDomainError(SNES, PetscBool *);

159: /*E
160:     SNESConvergedReason - reason a SNES method was said to
161:          have converged or diverged

163:    Level: beginner

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

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

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

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

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

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

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

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

204:    Each reason has its own manual page.

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

226: /*MC
227:      SNES_CONVERGED_FNORM_ABS - 2-norm(F) <= abstol

229:    Level: beginner

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

233: M*/

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

238:    Level: beginner

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

242: M*/

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

248:      Options Database Keys:
249:       -snes_stol <stol> - the step tolerance

251:    Level: beginner

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

255: M*/

257: /*MC
258:      SNES_DIVERGED_FUNCTION_COUNT - The user provided function has been called more times then the final
259:          argument to SNESSetTolerances()

261:    Level: beginner

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

265: M*/

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

271:    Level: beginner

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

275: M*/

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

280:    Level: beginner

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

284: M*/

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

289:    Level: beginner

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

293: M*/

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

299:    Level: beginner

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

303: M*/

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

308:    Level: beginner

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

312: M*/

314: PETSC_EXTERN PetscErrorCode SNESSetConvergenceTest(SNES,PetscErrorCode (*)(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void*,PetscErrorCode (*)(void*));
315: PETSC_EXTERN PetscErrorCode SNESConvergedDefault(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*);
316: PETSC_EXTERN PetscErrorCode SNESConvergedSkip(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*);
317: PETSC_EXTERN PetscErrorCode SNESGetConvergedReason(SNES,SNESConvergedReason*);

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

322: /* --------- Solving systems of nonlinear equations --------------- */
323: PETSC_EXTERN PetscErrorCode SNESSetFunction(SNES,Vec,PetscErrorCode (*)(SNES,Vec,Vec,void*),void*);
324: PETSC_EXTERN PetscErrorCode SNESGetFunction(SNES,Vec*,PetscErrorCode (**)(SNES,Vec,Vec,void*),void**);
325: PETSC_EXTERN PetscErrorCode SNESComputeFunction(SNES,Vec,Vec);

327: PETSC_EXTERN PetscErrorCode SNESSetJacobian(SNES,Mat,Mat,PetscErrorCode (*)(SNES,Vec,Mat,Mat,void*),void*);
328: PETSC_EXTERN PetscErrorCode SNESGetJacobian(SNES,Mat*,Mat*,PetscErrorCode (**)(SNES,Vec,Mat,Mat,void*),void**);
329: PETSC_EXTERN PetscErrorCode SNESObjectiveComputeFunctionDefaultFD(SNES,Vec,Vec,void*);
330: PETSC_EXTERN PetscErrorCode SNESComputeJacobianDefault(SNES,Vec,Mat,Mat,void*);
331: PETSC_EXTERN PetscErrorCode SNESComputeJacobianDefaultColor(SNES,Vec,Mat,Mat,void*);
332: PETSC_EXTERN PetscErrorCode SNESSetComputeInitialGuess(SNES,PetscErrorCode (*)(SNES,Vec,void*),void*);
333: PETSC_EXTERN PetscErrorCode SNESSetPicard(SNES,Vec,PetscErrorCode (*)(SNES,Vec,Vec,void*),Mat,Mat,PetscErrorCode (*)(SNES,Vec,Mat,Mat,void*),void*);
334: PETSC_EXTERN PetscErrorCode SNESGetPicard(SNES,Vec*,PetscErrorCode (**)(SNES,Vec,Vec,void*),Mat*,Mat*,PetscErrorCode (**)(SNES,Vec,Mat,Mat,void*),void**);
335: PETSC_EXTERN PetscErrorCode SNESSetInitialFunction(SNES,Vec);

337: PETSC_EXTERN PetscErrorCode SNESSetObjective(SNES,PetscErrorCode (*)(SNES,Vec,PetscReal *,void*),void*);
338: PETSC_EXTERN PetscErrorCode SNESGetObjective(SNES,PetscErrorCode (**)(SNES,Vec,PetscReal *,void*),void**);
339: PETSC_EXTERN PetscErrorCode SNESComputeObjective(SNES,Vec,PetscReal *);

341: /*E
342:     SNESNormSchedule - Frequency with which the norm is computed

344:    Level: advanced

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

348:    Notes:
349:    This is primarily used to turn off extra norm and function computation
350:    when the solvers are composed.

352: .seealso: SNESSolve(), SNESGetConvergedReason(), KSPSetNormType(),
353:           KSPSetConvergenceTest(), KSPSetPCSide()
354: E*/

356: typedef enum {SNES_NORM_DEFAULT            = -1,
357:               SNES_NORM_NONE               =  0,
358:               SNES_NORM_ALWAYS             =  1,
359:               SNES_NORM_INITIAL_ONLY       =  2,
360:               SNES_NORM_FINAL_ONLY         =  3,
361:               SNES_NORM_INITIAL_FINAL_ONLY =  4} SNESNormSchedule;
362: PETSC_EXTERN const char *const*const SNESNormSchedules;

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

367:    Level: advanced

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

372: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_DEFAULT
373: M*/

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

378:    Level: advanced

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

383: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_NONE
384: M*/

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

389:    Level: advanced

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

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

398: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_FINAL_ONLY, SNES_NORM_INITIAL_FINAL_ONLY
399: M*/

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

404:    Level: advanced

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

412: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_INITIAL_ONLY, SNES_NORM_INITIAL_FINAL_ONLY
413: M*/

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

418:    Level: advanced

420:    Notes:
421:    This method combines the benefits of SNES_NORM_INITIAL_ONLY and SNES_NORM_FINAL_ONLY.

423: .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_SNES_NORM_INITIAL_ONLY, SNES_NORM_FINAL_ONLY
424: M*/

426: PETSC_EXTERN PetscErrorCode SNESSetNormSchedule(SNES,SNESNormSchedule);
427: PETSC_EXTERN PetscErrorCode SNESGetNormSchedule(SNES,SNESNormSchedule*);

429: /*E
430:     SNESFunctionType - Type of function computed

432:    Level: advanced

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

436: .seealso: SNESSolve(), SNESGetConvergedReason(), KSPSetNormType(),
437:           KSPSetConvergenceTest(), KSPSetPCSide()
438: E*/
439: typedef enum {SNES_FUNCTION_DEFAULT          = -1,
440:               SNES_FUNCTION_UNPRECONDITIONED =  0,
441:               SNES_FUNCTION_PRECONDITIONED   =  1} SNESFunctionType;
442: PETSC_EXTERN const char *const*const SNESFunctionTypes;

444: PETSC_EXTERN PetscErrorCode SNESSetFunctionType(SNES,SNESFunctionType);
445: PETSC_EXTERN PetscErrorCode SNESGetFunctionType(SNES,SNESFunctionType*);

447: PETSC_EXTERN PetscErrorCode SNESSetNGS(SNES,PetscErrorCode (*)(SNES,Vec,Vec,void*),void*);
448: PETSC_EXTERN PetscErrorCode SNESGetNGS(SNES,PetscErrorCode (**)(SNES,Vec,Vec,void*),void**);
449: PETSC_EXTERN PetscErrorCode SNESSetUseNGS(SNES,PetscBool);
450: PETSC_EXTERN PetscErrorCode SNESGetUseNGS(SNES,PetscBool *);
451: PETSC_EXTERN PetscErrorCode SNESComputeNGS(SNES,Vec,Vec);

453: PETSC_EXTERN PetscErrorCode SNESNGSSetSweeps(SNES,PetscInt);
454: PETSC_EXTERN PetscErrorCode SNESNGSGetSweeps(SNES,PetscInt *);
455: PETSC_EXTERN PetscErrorCode SNESNGSSetTolerances(SNES,PetscReal,PetscReal,PetscReal,PetscInt);
456: PETSC_EXTERN PetscErrorCode SNESNGSGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,PetscInt*);

458: PETSC_EXTERN PetscErrorCode SNESUpdateCheckJacobian(SNES,PetscInt);

460: PETSC_EXTERN PetscErrorCode SNESShellGetContext(SNES,void**);
461: PETSC_EXTERN PetscErrorCode SNESShellSetContext(SNES,void*);
462: PETSC_EXTERN PetscErrorCode SNESShellSetSolve(SNES,PetscErrorCode (*)(SNES,Vec));

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

466: typedef struct _p_LineSearch* SNESLineSearch;

468: /*S
469:      SNESLineSearch - Abstract PETSc object that manages line-search operations

471:    Level: beginner

473:   Concepts: nonlinear solvers, line search

475: .seealso:  SNESLineSearchCreate(), SNESLineSearchSetType(), SNES
476: S*/

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

481:    Level: beginner

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

486: typedef const char* SNESLineSearchType;
487: #define SNESLINESEARCHBT                 "bt"
488: #define SNESLINESEARCHBASIC              "basic"
489: #define SNESLINESEARCHL2                 "l2"
490: #define SNESLINESEARCHCP                 "cp"
491: #define SNESLINESEARCHSHELL              "shell"

493: PETSC_EXTERN PetscBool         SNESRegisterAllCalled;
494: PETSC_EXTERN PetscFunctionList SNESList;
495: PETSC_EXTERN PetscClassId      SNESLINESEARCH_CLASSID;
496: PETSC_EXTERN PetscBool         SNESLineSearchRegisterAllCalled;
497: PETSC_EXTERN PetscFunctionList SNESLineSearchList;
498: PETSC_EXTERN PetscLogEvent     SNESLineSearch_Apply;

500: #define SNES_LINESEARCH_ORDER_LINEAR    1
501: #define SNES_LINESEARCH_ORDER_QUADRATIC 2
502: #define SNES_LINESEARCH_ORDER_CUBIC     3

504: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchVIProjectFunc)(SNES,Vec);
505: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchVINormFunc)(SNES,Vec,Vec,PetscReal *);
506: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchApplyFunc)(SNESLineSearch);
507: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchUserFunc)(SNESLineSearch, void *);

509: PETSC_EXTERN PetscErrorCode SNESLineSearchCreate(MPI_Comm, SNESLineSearch*);
510: PETSC_EXTERN PetscErrorCode SNESLineSearchReset(SNESLineSearch);
511: PETSC_EXTERN PetscErrorCode SNESLineSearchView(SNESLineSearch,PetscViewer);
512: PETSC_EXTERN PetscErrorCode SNESLineSearchDestroy(SNESLineSearch *);
513: PETSC_EXTERN PetscErrorCode SNESLineSearchSetType(SNESLineSearch, SNESLineSearchType);
514: PETSC_EXTERN PetscErrorCode SNESLineSearchSetFromOptions(SNESLineSearch);
515: PETSC_EXTERN PetscErrorCode SNESLineSearchSetFunction(SNESLineSearch,PetscErrorCode (*)(SNES,Vec,Vec));
516: PETSC_EXTERN PetscErrorCode SNESLineSearchSetUp(SNESLineSearch);
517: PETSC_EXTERN PetscErrorCode SNESLineSearchApply(SNESLineSearch, Vec, Vec, PetscReal *, Vec);
518: PETSC_EXTERN PetscErrorCode SNESLineSearchPreCheck(SNESLineSearch,Vec,Vec,PetscBool *);
519: PETSC_EXTERN PetscErrorCode SNESLineSearchPostCheck(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *);
520: PETSC_EXTERN PetscErrorCode SNESLineSearchSetWorkVecs(SNESLineSearch, PetscInt);

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

524: PETSC_EXTERN PetscErrorCode SNESLineSearchSetPreCheck(SNESLineSearch, PetscErrorCode (*)(SNESLineSearch,Vec,Vec,PetscBool*,void*), void *ctx);
525: PETSC_EXTERN PetscErrorCode SNESLineSearchSetPostCheck(SNESLineSearch, PetscErrorCode (*)(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *,void*), void *ctx);

527: PETSC_EXTERN PetscErrorCode SNESLineSearchGetPreCheck(SNESLineSearch, PetscErrorCode (**)(SNESLineSearch,Vec,Vec,PetscBool*,void*), void **ctx);
528: PETSC_EXTERN PetscErrorCode SNESLineSearchGetPostCheck(SNESLineSearch, PetscErrorCode (**)(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *,void*), void **ctx);

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

532: PETSC_EXTERN PetscErrorCode SNESLineSearchSetVIFunctions(SNESLineSearch, SNESLineSearchVIProjectFunc, SNESLineSearchVINormFunc);
533: PETSC_EXTERN PetscErrorCode SNESLineSearchGetVIFunctions(SNESLineSearch, SNESLineSearchVIProjectFunc*, SNESLineSearchVINormFunc*);

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

539: /* set and get the parameters and vectors */
540: PETSC_EXTERN PetscErrorCode SNESLineSearchGetTolerances(SNESLineSearch,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscInt*);
541: PETSC_EXTERN PetscErrorCode SNESLineSearchSetTolerances(SNESLineSearch,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscInt);

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

545: PETSC_EXTERN PetscErrorCode SNESLineSearchGetLambda(SNESLineSearch,PetscReal*);
546: PETSC_EXTERN PetscErrorCode SNESLineSearchSetLambda(SNESLineSearch,PetscReal);

548: PETSC_EXTERN PetscErrorCode SNESLineSearchGetDamping(SNESLineSearch,PetscReal*);
549: PETSC_EXTERN PetscErrorCode SNESLineSearchSetDamping(SNESLineSearch,PetscReal);

551: PETSC_EXTERN PetscErrorCode SNESLineSearchGetOrder(SNESLineSearch,PetscInt *order);
552: PETSC_EXTERN PetscErrorCode SNESLineSearchSetOrder(SNESLineSearch,PetscInt order);

554: PETSC_EXTERN PetscErrorCode SNESLineSearchGetSuccess(SNESLineSearch, PetscBool*);
555: PETSC_EXTERN PetscErrorCode SNESLineSearchSetSuccess(SNESLineSearch, PetscBool);

557: PETSC_EXTERN PetscErrorCode SNESLineSearchGetVecs(SNESLineSearch,Vec*,Vec*,Vec*,Vec*,Vec*);
558: PETSC_EXTERN PetscErrorCode SNESLineSearchSetVecs(SNESLineSearch,Vec,Vec,Vec,Vec,Vec);

560: PETSC_EXTERN PetscErrorCode SNESLineSearchGetNorms(SNESLineSearch, PetscReal *, PetscReal *, PetscReal *);
561: PETSC_EXTERN PetscErrorCode SNESLineSearchSetNorms(SNESLineSearch, PetscReal, PetscReal, PetscReal);
562: PETSC_EXTERN PetscErrorCode SNESLineSearchComputeNorms(SNESLineSearch);
563: PETSC_EXTERN PetscErrorCode SNESLineSearchSetComputeNorms(SNESLineSearch, PetscBool);

565: PETSC_EXTERN PetscErrorCode SNESLineSearchSetMonitor(SNESLineSearch, PetscBool);
566: PETSC_EXTERN PetscErrorCode SNESLineSearchGetMonitor(SNESLineSearch, PetscViewer*);

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


572: /* Shell interface functions */
573: PETSC_EXTERN PetscErrorCode SNESLineSearchShellSetUserFunc(SNESLineSearch,SNESLineSearchUserFunc,void*);
574: PETSC_EXTERN PetscErrorCode SNESLineSearchShellGetUserFunc(SNESLineSearch,SNESLineSearchUserFunc*,void**);

576: /* BT interface functions */
577: PETSC_EXTERN PetscErrorCode SNESLineSearchBTSetAlpha(SNESLineSearch, PetscReal);
578: PETSC_EXTERN PetscErrorCode SNESLineSearchBTGetAlpha(SNESLineSearch, PetscReal*);

580: /*register line search types */
581: PETSC_EXTERN PetscErrorCode SNESLineSearchRegister(const char[],PetscErrorCode(*)(SNESLineSearch));
582: PETSC_EXTERN PetscErrorCode SNESLineSearchRegisterAll(void);

584: /* Routines for VI solver */
585: PETSC_EXTERN PetscErrorCode SNESVISetVariableBounds(SNES,Vec,Vec);
586: PETSC_EXTERN PetscErrorCode SNESVISetComputeVariableBounds(SNES, PetscErrorCode (*)(SNES,Vec,Vec));
587: PETSC_EXTERN PetscErrorCode SNESVIGetInactiveSet(SNES,IS*);
588: PETSC_EXTERN PetscErrorCode SNESVIGetActiveSetIS(SNES,Vec,Vec,IS*);
589: PETSC_EXTERN PetscErrorCode SNESVIComputeInactiveSetFnorm(SNES,Vec,Vec,PetscReal*);
590: PETSC_EXTERN PetscErrorCode SNESVISetRedundancyCheck(SNES,PetscErrorCode(*)(SNES,IS,IS*,void*),void*);

592: PETSC_EXTERN PetscErrorCode SNESTestLocalMin(SNES);

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

597: PETSC_EXTERN PetscErrorCode SNESSetDM(SNES,DM);
598: PETSC_EXTERN PetscErrorCode SNESGetDM(SNES,DM*);
599: PETSC_EXTERN PetscErrorCode SNESSetNPC(SNES,SNES);
600: PETSC_EXTERN PetscErrorCode SNESGetNPC(SNES,SNES*);
601: PETSC_EXTERN PetscErrorCode SNESApplyNPC(SNES,Vec,Vec,Vec);
602: PETSC_EXTERN PetscErrorCode SNESGetNPCFunction(SNES,Vec,PetscReal*);
603: PETSC_EXTERN PetscErrorCode SNESComputeFunctionDefaultNPC(SNES,Vec,Vec);
604: PETSC_EXTERN PetscErrorCode SNESSetNPCSide(SNES,PCSide);
605: PETSC_EXTERN PetscErrorCode SNESGetNPCSide(SNES,PCSide*);
606: PETSC_EXTERN PetscErrorCode SNESSetLineSearch(SNES,SNESLineSearch);
607: PETSC_EXTERN PetscErrorCode SNESGetLineSearch(SNES,SNESLineSearch*);
608: PETSC_EXTERN PetscErrorCode SNESRestrictHookAdd(SNES,PetscErrorCode (*)(SNES,SNES,void*),void*);
609: PETSC_EXTERN PetscErrorCode SNESRestrictHooksRun(SNES,SNES);

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

614: PETSC_EXTERN PetscErrorCode SNESSetUpMatrices(SNES);
615: PETSC_EXTERN PetscErrorCode DMSNESSetFunction(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),void*);
616: PETSC_EXTERN PetscErrorCode DMSNESGetFunction(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),void**);
617: PETSC_EXTERN PetscErrorCode DMSNESSetNGS(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),void*);
618: PETSC_EXTERN PetscErrorCode DMSNESGetNGS(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),void**);
619: PETSC_EXTERN PetscErrorCode DMSNESSetJacobian(DM,PetscErrorCode(*)(SNES,Vec,Mat,Mat,void*),void*);
620: PETSC_EXTERN PetscErrorCode DMSNESGetJacobian(DM,PetscErrorCode(**)(SNES,Vec,Mat,Mat,void*),void**);
621: PETSC_EXTERN PetscErrorCode DMSNESSetPicard(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),PetscErrorCode(*)(SNES,Vec,Mat,Mat,void*),void*);
622: PETSC_EXTERN PetscErrorCode DMSNESGetPicard(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),PetscErrorCode(**)(SNES,Vec,Mat,Mat,void*),void**);
623: PETSC_EXTERN PetscErrorCode DMSNESSetObjective(DM,PetscErrorCode (*)(SNES,Vec,PetscReal *,void*),void*);
624: PETSC_EXTERN PetscErrorCode DMSNESGetObjective(DM,PetscErrorCode (**)(SNES,Vec,PetscReal *,void*),void**);

626: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESFunction)(DMDALocalInfo*,void*,void*,void*);
627: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESJacobian)(DMDALocalInfo*,void*,Mat,Mat,void*);
628: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESObjective)(DMDALocalInfo*,void*,PetscReal*,void*);

630: PETSC_EXTERN PetscErrorCode DMDASNESSetFunctionLocal(DM,InsertMode,DMDASNESFunction,void*);
631: PETSC_EXTERN PetscErrorCode DMDASNESSetJacobianLocal(DM,DMDASNESJacobian,void*);
632: PETSC_EXTERN PetscErrorCode DMDASNESSetObjectiveLocal(DM,DMDASNESObjective,void*);
633: PETSC_EXTERN PetscErrorCode DMDASNESSetPicardLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,void*,void*,void*),PetscErrorCode (*)(DMDALocalInfo*,void*,Mat,Mat,void*),void*);

635: PETSC_EXTERN PetscErrorCode DMSNESSetFunctionLocal(DM,PetscErrorCode (*)(DM,Vec,Vec,void*),void*);
636: PETSC_EXTERN PetscErrorCode DMSNESSetJacobianLocal(DM,PetscErrorCode (*)(DM,Vec,Mat,Mat,void*),void*);

638: /* Routines for Multiblock solver */
639: PETSC_EXTERN PetscErrorCode SNESMultiblockSetFields(SNES, const char [], PetscInt, const PetscInt *);
640: PETSC_EXTERN PetscErrorCode SNESMultiblockSetIS(SNES, const char [], IS);
641: PETSC_EXTERN PetscErrorCode SNESMultiblockSetBlockSize(SNES, PetscInt);
642: PETSC_EXTERN PetscErrorCode SNESMultiblockSetType(SNES, PCCompositeType);

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

647:    Level: intermediate

649: .seealso: SNESMSSetType(), SNES
650: J*/
651: typedef const char* SNESMSType;
652: #define SNESMSM62       "m62"
653: #define SNESMSEULER     "euler"
654: #define SNESMSJAMESON83 "jameson83"
655: #define SNESMSVLTP21    "vltp21"
656: #define SNESMSVLTP31    "vltp31"
657: #define SNESMSVLTP41    "vltp41"
658: #define SNESMSVLTP51    "vltp51"
659: #define SNESMSVLTP61    "vltp61"

661: PETSC_EXTERN PetscErrorCode SNESMSRegister(SNESMSType,PetscInt,PetscInt,PetscReal,const PetscReal[],const PetscReal[],const PetscReal[]);
662: PETSC_EXTERN PetscErrorCode SNESMSSetType(SNES,SNESMSType);
663: PETSC_EXTERN PetscErrorCode SNESMSFinalizePackage(void);
664: PETSC_EXTERN PetscErrorCode SNESMSInitializePackage(void);
665: PETSC_EXTERN PetscErrorCode SNESMSRegisterDestroy(void);
666: PETSC_EXTERN PetscErrorCode SNESMSRegisterAll(void);

668: /* routines for NGMRES solver */

670: typedef enum {
671:   SNES_NGMRES_RESTART_NONE       = 0,
672:   SNES_NGMRES_RESTART_PERIODIC   = 1,
673:   SNES_NGMRES_RESTART_DIFFERENCE = 2} SNESNGMRESRestartType;
674: PETSC_EXTERN const char *const SNESNGMRESRestartTypes[];

676: typedef enum {
677:   SNES_NGMRES_SELECT_NONE       = 0,
678:   SNES_NGMRES_SELECT_DIFFERENCE = 1,
679:   SNES_NGMRES_SELECT_LINESEARCH = 2} SNESNGMRESSelectType;
680: PETSC_EXTERN const char *const SNESNGMRESSelectTypes[];

682: PETSC_EXTERN PetscErrorCode SNESNGMRESSetRestartType(SNES, SNESNGMRESRestartType);
683: PETSC_EXTERN PetscErrorCode SNESNGMRESSetSelectType(SNES, SNESNGMRESSelectType);

685: /* routines for NCG solver */

687: typedef enum {
688:   SNES_NCG_FR    = 0,
689:   SNES_NCG_PRP   = 1,
690:   SNES_NCG_HS    = 2,
691:   SNES_NCG_DY    = 3,
692:   SNES_NCG_CD    = 4} SNESNCGType;
693: PETSC_EXTERN const char *const SNESNCGTypes[];

695: PETSC_EXTERN PetscErrorCode SNESNCGSetType(SNES, SNESNCGType);

697: typedef enum {SNES_QN_SCALE_DEFAULT    = 0,
698:               SNES_QN_SCALE_NONE       = 1,
699:               SNES_QN_SCALE_SHANNO     = 2,
700:               SNES_QN_SCALE_LINESEARCH = 3,
701:               SNES_QN_SCALE_JACOBIAN   = 4} SNESQNScaleType;
702: PETSC_EXTERN const char *const SNESQNScaleTypes[];
703: typedef enum {SNES_QN_RESTART_DEFAULT  = 0,
704:               SNES_QN_RESTART_NONE     = 1,
705:               SNES_QN_RESTART_POWELL   = 2,
706:               SNES_QN_RESTART_PERIODIC = 3} SNESQNRestartType;
707: PETSC_EXTERN const char *const SNESQNRestartTypes[];
708: typedef enum {SNES_QN_LBFGS      = 0,
709:               SNES_QN_BROYDEN    = 1,
710:               SNES_QN_BADBROYDEN = 2
711:              } SNESQNType;
712: PETSC_EXTERN const char *const SNESQNTypes[];

714: PETSC_EXTERN PetscErrorCode SNESQNSetType(SNES, SNESQNType);
715: PETSC_EXTERN PetscErrorCode SNESQNSetScaleType(SNES, SNESQNScaleType);
716: PETSC_EXTERN PetscErrorCode SNESQNSetRestartType(SNES, SNESQNRestartType);

718: PETSC_EXTERN PetscErrorCode SNESNASMGetType(SNES,PCASMType*);
719: PETSC_EXTERN PetscErrorCode SNESNASMSetType(SNES,PCASMType);
720: PETSC_EXTERN PetscErrorCode SNESNASMGetSubdomains(SNES,PetscInt*,SNES**,VecScatter**,VecScatter**,VecScatter**);
721: PETSC_EXTERN PetscErrorCode SNESNASMSetSubdomains(SNES,PetscInt,SNES*,VecScatter*,VecScatter*,VecScatter*);
722: PETSC_EXTERN PetscErrorCode SNESNASMSetDamping(SNES,PetscReal);
723: PETSC_EXTERN PetscErrorCode SNESNASMGetDamping(SNES,PetscReal*);
724: PETSC_EXTERN PetscErrorCode SNESNASMGetSubdomainVecs(SNES,PetscInt*,Vec**,Vec**,Vec**,Vec**);
725: PETSC_EXTERN PetscErrorCode SNESNASMSetComputeFinalJacobian(SNES,PetscBool);

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

730: PETSC_EXTERN PetscErrorCode SNESCompositeSetType(SNES,SNESCompositeType);
731: PETSC_EXTERN PetscErrorCode SNESCompositeAddSNES(SNES,SNESType);
732: PETSC_EXTERN PetscErrorCode SNESCompositeGetSNES(SNES,PetscInt,SNES *);
733: PETSC_EXTERN PetscErrorCode SNESCompositeSetDamping(SNES,PetscInt,PetscReal);

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

738:    Level: beginner

740:    Values:
741: +  SNES_FAS_MULTIPLICATIVE (default) - traditional V or W cycle as determined by SNESFASSetCycles()
742: .  SNES_FAS_ADDITIVE                 - additive FAS cycle
743: .  SNES_FAS_FULL                     - full FAS cycle
744: -  SNES_FAS_KASKADE                  - Kaskade FAS cycle
745: .seealso: PCMGSetType(), PCMGType

747: E*/
748: typedef enum { SNES_FAS_MULTIPLICATIVE, SNES_FAS_ADDITIVE, SNES_FAS_FULL, SNES_FAS_KASKADE } SNESFASType;
749: PETSC_EXTERN const char *const  SNESFASTypes[];

751: /* called on the finest level FAS instance*/
752: PETSC_EXTERN PetscErrorCode SNESFASSetType(SNES, SNESFASType);
753: PETSC_EXTERN PetscErrorCode SNESFASGetType(SNES, SNESFASType*);
754: PETSC_EXTERN PetscErrorCode SNESFASSetLevels(SNES, PetscInt, MPI_Comm *);
755: PETSC_EXTERN PetscErrorCode SNESFASGetLevels(SNES, PetscInt *);
756: PETSC_EXTERN PetscErrorCode SNESFASGetCycleSNES(SNES, PetscInt, SNES*);
757: PETSC_EXTERN PetscErrorCode SNESFASSetNumberSmoothUp(SNES, PetscInt);
758: PETSC_EXTERN PetscErrorCode SNESFASSetNumberSmoothDown(SNES, PetscInt);
759: PETSC_EXTERN PetscErrorCode SNESFASSetCycles(SNES, PetscInt);
760: PETSC_EXTERN PetscErrorCode SNESFASSetMonitor(SNES, PetscBool);
761: PETSC_EXTERN PetscErrorCode SNESFASSetLog(SNES, PetscBool);

763: PETSC_EXTERN PetscErrorCode SNESFASSetGalerkin(SNES, PetscBool);
764: PETSC_EXTERN PetscErrorCode SNESFASGetGalerkin(SNES, PetscBool*);

766: /* called on any level -- "Cycle" FAS instance */
767: PETSC_EXTERN PetscErrorCode SNESFASCycleGetSmoother(SNES, SNES*);
768: PETSC_EXTERN PetscErrorCode SNESFASCycleGetSmootherUp(SNES, SNES*);
769: PETSC_EXTERN PetscErrorCode SNESFASCycleGetSmootherDown(SNES, SNES*);
770: PETSC_EXTERN PetscErrorCode SNESFASCycleGetCorrection(SNES, SNES*);
771: PETSC_EXTERN PetscErrorCode SNESFASCycleGetInterpolation(SNES, Mat*);
772: PETSC_EXTERN PetscErrorCode SNESFASCycleGetRestriction(SNES, Mat*);
773: PETSC_EXTERN PetscErrorCode SNESFASCycleGetInjection(SNES, Mat*);
774: PETSC_EXTERN PetscErrorCode SNESFASCycleGetRScale(SNES, Vec*);
775: PETSC_EXTERN PetscErrorCode SNESFASCycleSetCycles(SNES, PetscInt);
776: PETSC_EXTERN PetscErrorCode SNESFASCycleIsFine(SNES, PetscBool*);

778: /* called on the (outer) finest level FAS to set/get parameters on any level instance */
779: PETSC_EXTERN PetscErrorCode SNESFASSetInterpolation(SNES, PetscInt, Mat);
780: PETSC_EXTERN PetscErrorCode SNESFASGetInterpolation(SNES, PetscInt, Mat*);
781: PETSC_EXTERN PetscErrorCode SNESFASSetRestriction(SNES, PetscInt, Mat);
782: PETSC_EXTERN PetscErrorCode SNESFASGetRestriction(SNES, PetscInt, Mat*);
783: PETSC_EXTERN PetscErrorCode SNESFASSetInjection(SNES, PetscInt, Mat);
784: PETSC_EXTERN PetscErrorCode SNESFASGetInjection(SNES, PetscInt, Mat*);
785: PETSC_EXTERN PetscErrorCode SNESFASSetRScale(SNES, PetscInt, Vec);
786: PETSC_EXTERN PetscErrorCode SNESFASGetRScale(SNES, PetscInt, Vec*);
787: PETSC_EXTERN PetscErrorCode SNESFASSetContinuation(SNES,PetscBool);

789: PETSC_EXTERN PetscErrorCode SNESFASGetSmoother(SNES,     PetscInt, SNES*);
790: PETSC_EXTERN PetscErrorCode SNESFASGetSmootherUp(SNES,   PetscInt, SNES*);
791: PETSC_EXTERN PetscErrorCode SNESFASGetSmootherDown(SNES, PetscInt, SNES*);
792: PETSC_EXTERN PetscErrorCode SNESFASGetCoarseSolve(SNES, SNES*);

794: /* parameters for full FAS */
795: PETSC_EXTERN PetscErrorCode SNESFASFullSetDownSweep(SNES,PetscBool);
796: PETSC_EXTERN PetscErrorCode SNESFASCreateCoarseVec(SNES,Vec*);
797: PETSC_EXTERN PetscErrorCode SNESFASRestrict(SNES,Vec,Vec);

799: #endif