1 /* 2 User interface for the nonlinear solvers package. 3 */ 4 #if !defined(__PETSCSNES_H) 5 #define __PETSCSNES_H 6 #include <petscksp.h> 7 #include <petscdmtypes.h> 8 #include <petscdmdatypes.h> 9 10 /*S 11 SNES - Abstract PETSc object that manages all nonlinear solves 12 13 Level: beginner 14 15 Concepts: nonlinear solvers 16 17 .seealso: SNESCreate(), SNESSetType(), SNESType, TS, KSP, KSP, PC, SNESDestroy() 18 S*/ 19 typedef struct _p_SNES* SNES; 20 21 /*J 22 SNESType - String with the name of a PETSc SNES method. 23 24 Level: beginner 25 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" 48 49 /* Logging support */ 50 PETSC_EXTERN PetscClassId SNES_CLASSID; 51 PETSC_EXTERN PetscClassId DMSNES_CLASSID; 52 53 PETSC_EXTERN PetscErrorCode SNESInitializePackage(void); 54 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 *); 71 72 PETSC_EXTERN PetscErrorCode SNESSetWorkVecs(SNES,PetscInt); 73 74 PETSC_EXTERN PetscErrorCode SNESAddOptionsChecker(PetscErrorCode (*)(SNES)); 75 76 PETSC_EXTERN PetscErrorCode SNESSetUpdate(SNES, PetscErrorCode (*)(SNES, PetscInt)); 77 78 PETSC_EXTERN PetscErrorCode SNESRegisterAll(void); 79 80 PETSC_EXTERN PetscErrorCode SNESRegister(const char[],PetscErrorCode (*)(SNES)); 81 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);} 90 91 #define SNES_FILE_CLASSID 1211224 92 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); 97 98 PETSC_EXTERN PetscErrorCode MatCreateSNESMF(SNES,Mat*); 99 PETSC_EXTERN PetscErrorCode MatMFFDComputeJacobian(SNES,Vec,Mat,Mat,void*); 100 101 PETSC_EXTERN PetscErrorCode MatDAADSetSNES(Mat,SNES); 102 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 KSPMonitorSNES(KSP,PetscInt,PetscReal,void*); 115 PETSC_EXTERN PetscErrorCode KSPMonitorSNESLGResidualNormCreate(const char[],const char[],int,int,int,int,PetscObject**); 116 PETSC_EXTERN PetscErrorCode KSPMonitorSNESLGResidualNorm(KSP,PetscInt,PetscReal,PetscObject*); 117 PETSC_EXTERN PetscErrorCode KSPMonitorSNESLGResidualNormDestroy(PetscObject**); 118 119 PETSC_EXTERN PetscErrorCode SNESSetTolerances(SNES,PetscReal,PetscReal,PetscReal,PetscInt,PetscInt); 120 PETSC_EXTERN PetscErrorCode SNESGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,PetscInt*,PetscInt*); 121 PETSC_EXTERN PetscErrorCode SNESSetTrustRegionTolerance(SNES,PetscReal); 122 PETSC_EXTERN PetscErrorCode SNESGetIterationNumber(SNES,PetscInt*); 123 PETSC_EXTERN PetscErrorCode SNESSetIterationNumber(SNES,PetscInt); 124 125 PETSC_EXTERN PetscErrorCode SNESGetNonlinearStepFailures(SNES,PetscInt*); 126 PETSC_EXTERN PetscErrorCode SNESSetMaxNonlinearStepFailures(SNES,PetscInt); 127 PETSC_EXTERN PetscErrorCode SNESGetMaxNonlinearStepFailures(SNES,PetscInt*); 128 PETSC_EXTERN PetscErrorCode SNESGetNumberFunctionEvals(SNES,PetscInt*); 129 130 PETSC_EXTERN PetscErrorCode SNESSetLagPreconditioner(SNES,PetscInt); 131 PETSC_EXTERN PetscErrorCode SNESGetLagPreconditioner(SNES,PetscInt*); 132 PETSC_EXTERN PetscErrorCode SNESSetLagJacobian(SNES,PetscInt); 133 PETSC_EXTERN PetscErrorCode SNESGetLagJacobian(SNES,PetscInt*); 134 PETSC_EXTERN PetscErrorCode SNESSetLagPreconditionerPersists(SNES,PetscBool); 135 PETSC_EXTERN PetscErrorCode SNESSetLagJacobianPersists(SNES,PetscBool); 136 PETSC_EXTERN PetscErrorCode SNESSetGridSequence(SNES,PetscInt); 137 138 PETSC_EXTERN PetscErrorCode SNESGetLinearSolveIterations(SNES,PetscInt*); 139 PETSC_EXTERN PetscErrorCode SNESGetLinearSolveFailures(SNES,PetscInt*); 140 PETSC_EXTERN PetscErrorCode SNESSetMaxLinearSolveFailures(SNES,PetscInt); 141 PETSC_EXTERN PetscErrorCode SNESGetMaxLinearSolveFailures(SNES,PetscInt*); 142 PETSC_EXTERN PetscErrorCode SNESSetCountersReset(SNES,PetscBool); 143 144 PETSC_EXTERN PetscErrorCode SNESKSPSetUseEW(SNES,PetscBool ); 145 PETSC_EXTERN PetscErrorCode SNESKSPGetUseEW(SNES,PetscBool *); 146 PETSC_EXTERN PetscErrorCode SNESKSPSetParametersEW(SNES,PetscInt,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal); 147 PETSC_EXTERN PetscErrorCode SNESKSPGetParametersEW(SNES,PetscInt*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*); 148 149 #include <petscdrawtypes.h> 150 PETSC_EXTERN PetscErrorCode SNESMonitorLGCreate(const char[],const char[],int,int,int,int,PetscDrawLG*); 151 PETSC_EXTERN PetscErrorCode SNESMonitorLGResidualNorm(SNES,PetscInt,PetscReal,void*); 152 PETSC_EXTERN PetscErrorCode SNESMonitorLGDestroy(PetscDrawLG*); 153 PETSC_EXTERN PetscErrorCode SNESMonitorLGRange(SNES,PetscInt,PetscReal,void*); 154 155 PETSC_EXTERN PetscErrorCode SNESSetApplicationContext(SNES,void *); 156 PETSC_EXTERN PetscErrorCode SNESGetApplicationContext(SNES,void *); 157 PETSC_EXTERN PetscErrorCode SNESSetComputeApplicationContext(SNES,PetscErrorCode (*)(SNES,void**),PetscErrorCode (*)(void**)); 158 159 PETSC_EXTERN PetscErrorCode SNESPythonSetType(SNES,const char[]); 160 161 PETSC_EXTERN PetscErrorCode SNESSetFunctionDomainError(SNES); 162 PETSC_EXTERN PetscErrorCode SNESGetFunctionDomainError(SNES, PetscBool *); 163 164 /*E 165 SNESConvergedReason - reason a SNES method was said to 166 have converged or diverged 167 168 Level: beginner 169 170 The two most common reasons for divergence are 171 $ 1) an incorrectly coded or computed Jacobian or 172 $ 2) failure or lack of convergence in the linear system (in this case we recommend 173 $ testing with -pc_type lu to eliminate the linear solver as the cause of the problem). 174 175 Diverged Reasons: 176 . SNES_DIVERGED_LOCAL_MIN - this can only occur when using the line-search variant of SNES. 177 The line search wants to minimize Q(alpha) = 1/2 || F(x + alpha s) ||^2_2 this occurs 178 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 179 you get Q'(alpha) = -F(x)^T F'(x)^(-1)^T F'(x+alpha s)F(x+alpha s); when alpha = 0 180 Q'(0) = - ||F(x)||^2_2 which is always NEGATIVE if F'(x) is invertible. This means the Newton 181 direction is a descent direction and the line search should succeed if alpha is small enough. 182 183 If F'(x) is NOT invertible AND F'(x)^T F(x) = 0 then Q'(0) = 0 and the Newton direction 184 is NOT a descent direction so the line search will fail. All one can do at this point 185 is change the initial guess and try again. 186 187 An alternative explanation: Newton's method can be regarded as replacing the function with 188 its linear approximation and minimizing the 2-norm of that. That is F(x+s) approx F(x) + F'(x)s 189 so we minimize || F(x) + F'(x) s ||^2_2; do this using Least Squares. If F'(x) is invertible then 190 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 191 exists a nontrival (that is F'(x)s != 0) solution to the equation and this direction is 192 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) 193 = - (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 194 and F'(x)^T F'(x) has no negative eigenvalues Q'(0) < 0 so s is a descent direction and the line 195 search should succeed for small enough alpha. 196 197 Note that this RARELY happens in practice. Far more likely the linear system is not being solved 198 (well enough?) or the Jacobian is wrong. 199 200 SNES_DIVERGED_MAX_IT means that the solver reached the maximum number of iterations without satisfying any 201 convergence criteria. SNES_CONVERGED_ITS means that SNESConvergedSkip() was chosen as the convergence test; 202 thus the usual convergence criteria have not been checked and may or may not be satisfied. 203 204 Developer Notes: this must match finclude/petscsnes.h 205 206 The string versions of these are in SNESConvergedReason, if you change any value here you must 207 also adjust that array. 208 209 Each reason has its own manual page. 210 211 .seealso: SNESSolve(), SNESGetConvergedReason(), KSPConvergedReason, SNESSetConvergenceTest() 212 E*/ 213 typedef enum {/* converged */ 214 SNES_CONVERGED_FNORM_ABS = 2, /* ||F|| < atol */ 215 SNES_CONVERGED_FNORM_RELATIVE = 3, /* ||F|| < rtol*||F_initial|| */ 216 SNES_CONVERGED_SNORM_RELATIVE = 4, /* Newton computed step size small; || delta x || < stol || x ||*/ 217 SNES_CONVERGED_ITS = 5, /* maximum iterations reached */ 218 SNES_CONVERGED_TR_DELTA = 7, 219 /* diverged */ 220 SNES_DIVERGED_FUNCTION_DOMAIN = -1, /* the new x location passed the function is not in the domain of F */ 221 SNES_DIVERGED_FUNCTION_COUNT = -2, 222 SNES_DIVERGED_LINEAR_SOLVE = -3, /* the linear solve failed */ 223 SNES_DIVERGED_FNORM_NAN = -4, 224 SNES_DIVERGED_MAX_IT = -5, 225 SNES_DIVERGED_LINE_SEARCH = -6, /* the line search failed */ 226 SNES_DIVERGED_INNER = -7, /* inner solve failed */ 227 SNES_DIVERGED_LOCAL_MIN = -8, /* || J^T b || is small, implies converged to local minimum of F() */ 228 SNES_CONVERGED_ITERATING = 0} SNESConvergedReason; 229 PETSC_EXTERN const char *const*SNESConvergedReasons; 230 231 /*MC 232 SNES_CONVERGED_FNORM_ABS - 2-norm(F) <= abstol 233 234 Level: beginner 235 236 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 237 238 M*/ 239 240 /*MC 241 SNES_CONVERGED_FNORM_RELATIVE - 2-norm(F) <= rtol*2-norm(F(x_0)) where x_0 is the initial guess 242 243 Level: beginner 244 245 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 246 247 M*/ 248 249 /*MC 250 SNES_CONVERGED_SNORM_RELATIVE - The 2-norm of the last step <= stol * 2-norm(x) where x is the current 251 solution and stol is the 4th argument to SNESSetTolerances() 252 253 Options Database Keys: 254 -snes_stol <stol> - the step tolerance 255 256 Level: beginner 257 258 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 259 260 M*/ 261 262 /*MC 263 SNES_DIVERGED_FUNCTION_COUNT - The user provided function has been called more times then the final 264 argument to SNESSetTolerances() 265 266 Level: beginner 267 268 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 269 270 M*/ 271 272 /*MC 273 SNES_DIVERGED_FNORM_NAN - the 2-norm of the current function evaluation is not-a-number (NaN), this 274 is usually caused by a division of 0 by 0. 275 276 Level: beginner 277 278 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 279 280 M*/ 281 282 /*MC 283 SNES_DIVERGED_MAX_IT - SNESSolve() has reached the maximum number of iterations requested 284 285 Level: beginner 286 287 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 288 289 M*/ 290 291 /*MC 292 SNES_DIVERGED_LINE_SEARCH - The line search has failed. This only occurs for a SNES solvers that use a line search 293 294 Level: beginner 295 296 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances(), SNESLineSearch 297 298 M*/ 299 300 /*MC 301 SNES_DIVERGED_LOCAL_MIN - the algorithm seems to have stagnated at a local minimum that is not zero. 302 See the manual page for SNESConvergedReason for more details 303 304 Level: beginner 305 306 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 307 308 M*/ 309 310 /*MC 311 SNES_CONERGED_ITERATING - this only occurs if SNESGetConvergedReason() is called during the SNESSolve() 312 313 Level: beginner 314 315 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 316 317 M*/ 318 319 PETSC_EXTERN PetscErrorCode SNESSetConvergenceTest(SNES,PetscErrorCode (*)(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void*,PetscErrorCode (*)(void*)); 320 PETSC_EXTERN PetscErrorCode SNESConvergedDefault(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*); 321 PETSC_EXTERN PetscErrorCode SNESConvergedSkip(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*); 322 PETSC_EXTERN PetscErrorCode SNESGetConvergedReason(SNES,SNESConvergedReason*); 323 324 PETSC_DEPRECATED("Use SNESConvergedSkip()") PETSC_STATIC_INLINE void SNESSkipConverged(void) { /* never called */ } 325 #define SNESSkipConverged (SNESSkipConverged, SNESConvergedSkip) 326 327 /* --------- Solving systems of nonlinear equations --------------- */ 328 PETSC_EXTERN PetscErrorCode SNESSetFunction(SNES,Vec,PetscErrorCode (*)(SNES,Vec,Vec,void*),void*); 329 PETSC_EXTERN PetscErrorCode SNESGetFunction(SNES,Vec*,PetscErrorCode (**)(SNES,Vec,Vec,void*),void**); 330 PETSC_EXTERN PetscErrorCode SNESComputeFunction(SNES,Vec,Vec); 331 332 PETSC_EXTERN PetscErrorCode SNESSetJacobian(SNES,Mat,Mat,PetscErrorCode (*)(SNES,Vec,Mat,Mat,void*),void*); 333 PETSC_EXTERN PetscErrorCode SNESGetJacobian(SNES,Mat*,Mat*,PetscErrorCode (**)(SNES,Vec,Mat,Mat,void*),void**); 334 PETSC_EXTERN PetscErrorCode SNESObjectiveComputeFunctionDefaultFD(SNES,Vec,Vec,void*); 335 PETSC_EXTERN PetscErrorCode SNESComputeJacobianDefault(SNES,Vec,Mat,Mat,void*); 336 PETSC_EXTERN PetscErrorCode SNESComputeJacobianDefaultColor(SNES,Vec,Mat,Mat,void*); 337 PETSC_EXTERN PetscErrorCode SNESSetComputeInitialGuess(SNES,PetscErrorCode (*)(SNES,Vec,void*),void*); 338 PETSC_EXTERN PetscErrorCode SNESSetPicard(SNES,Vec,PetscErrorCode (*)(SNES,Vec,Vec,void*),Mat,Mat,PetscErrorCode (*)(SNES,Vec,Mat,Mat,void*),void*); 339 PETSC_EXTERN PetscErrorCode SNESGetPicard(SNES,Vec*,PetscErrorCode (**)(SNES,Vec,Vec,void*),Mat*,Mat*,PetscErrorCode (**)(SNES,Vec,Mat,Mat,void*),void**); 340 PETSC_EXTERN PetscErrorCode SNESSetInitialFunction(SNES,Vec); 341 342 PETSC_EXTERN PetscErrorCode SNESSetObjective(SNES,PetscErrorCode (*)(SNES,Vec,PetscReal *,void*),void*); 343 PETSC_EXTERN PetscErrorCode SNESGetObjective(SNES,PetscErrorCode (**)(SNES,Vec,PetscReal *,void*),void**); 344 PETSC_EXTERN PetscErrorCode SNESComputeObjective(SNES,Vec,PetscReal *); 345 346 /*E 347 SNESNormSchedule - Frequency with which the norm is computed 348 349 Level: advanced 350 351 Support for these is highly dependent on the solver. 352 353 Notes: 354 This is primarily used to turn off extra norm and function computation 355 when the solvers are composed. 356 357 .seealso: SNESSolve(), SNESGetConvergedReason(), KSPSetNormType(), 358 KSPSetConvergenceTest(), KSPSetPCSide() 359 E*/ 360 361 typedef enum {SNES_NORM_DEFAULT = -1, 362 SNES_NORM_NONE = 0, 363 SNES_NORM_ALWAYS = 1, 364 SNES_NORM_INITIAL_ONLY = 2, 365 SNES_NORM_FINAL_ONLY = 3, 366 SNES_NORM_INITIAL_FINAL_ONLY = 4} SNESNormSchedule; 367 PETSC_EXTERN const char *const*const SNESNormSchedules; 368 369 /*MC 370 SNES_NORM_NONE - Don't compute function and its L2 norm. 371 372 Level: advanced 373 374 Notes: 375 This is most useful for stationary solvers with a fixed number of iterations used as smoothers. 376 377 .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_DEFAULT 378 M*/ 379 380 /*MC 381 SNES_NORM_ALWAYS - Compute the function and its L2 norm at each iteration. 382 383 Level: advanced 384 385 Notes: 386 Most solvers will use this no matter what norm type is passed to them. 387 388 .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_NONE 389 M*/ 390 391 /*MC 392 SNES_NORM_INITIAL_ONLY - Compute the function and its L2 at iteration 0, but do not update it. 393 394 Level: advanced 395 396 Notes: 397 This method is useful in composed methods, when a true solution might actually be found before SNESSolve() is called. 398 This option enables the solve to abort on the zeroth iteration if this is the case. 399 400 For solvers that require the computation of the L2 norm of the function as part of the method, this merely cancels 401 the norm computation at the last iteration (if possible). 402 403 .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_FINAL_ONLY, SNES_NORM_INITIAL_FINAL_ONLY 404 M*/ 405 406 /*MC 407 SNES_NORM_FINAL_ONLY - Compute the function and its L2 norm on only the final iteration. 408 409 Level: advanced 410 411 Notes: 412 For solvers that require the computation of the L2 norm of the function as part of the method, behaves 413 exactly as SNES_NORM_DEFAULT. This method is useful when the function is gotten after SNESSolve and 414 used in subsequent computation for methods that do not need the norm computed during the rest of the 415 solution procedure. 416 417 .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_INITIAL_ONLY, SNES_NORM_INITIAL_FINAL_ONLY 418 M*/ 419 420 /*MC 421 SNES_NORM_INITIAL_FINAL_ONLY - Compute the function and its L2 norm on only the initial and final iterations. 422 423 Level: advanced 424 425 Notes: 426 This method combines the benefits of SNES_NORM_INITIAL_ONLY and SNES_NORM_FINAL_ONLY. 427 428 .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_SNES_NORM_INITIAL_ONLY, SNES_NORM_FINAL_ONLY 429 M*/ 430 431 PETSC_EXTERN PetscErrorCode SNESSetNormSchedule(SNES,SNESNormSchedule); 432 PETSC_EXTERN PetscErrorCode SNESGetNormSchedule(SNES,SNESNormSchedule*); 433 434 /*E 435 SNESFunctionType - Type of function computed 436 437 Level: advanced 438 439 Support for these is highly dependent on the solver. 440 441 .seealso: SNESSolve(), SNESGetConvergedReason(), KSPSetNormType(), 442 KSPSetConvergenceTest(), KSPSetPCSide() 443 E*/ 444 typedef enum {SNES_FUNCTION_DEFAULT = -1, 445 SNES_FUNCTION_UNPRECONDITIONED = 0, 446 SNES_FUNCTION_PRECONDITIONED = 1} SNESFunctionType; 447 PETSC_EXTERN const char *const*const SNESFunctionTypes; 448 449 PETSC_EXTERN PetscErrorCode SNESSetFunctionType(SNES,SNESFunctionType); 450 PETSC_EXTERN PetscErrorCode SNESGetFunctionType(SNES,SNESFunctionType*); 451 452 PETSC_EXTERN PetscErrorCode SNESSetNGS(SNES,PetscErrorCode (*)(SNES,Vec,Vec,void*),void*); 453 PETSC_EXTERN PetscErrorCode SNESGetNGS(SNES,PetscErrorCode (**)(SNES,Vec,Vec,void*),void**); 454 PETSC_EXTERN PetscErrorCode SNESSetUseNGS(SNES,PetscBool); 455 PETSC_EXTERN PetscErrorCode SNESGetUseNGS(SNES,PetscBool *); 456 PETSC_EXTERN PetscErrorCode SNESComputeNGS(SNES,Vec,Vec); 457 458 PETSC_EXTERN PetscErrorCode SNESNGSSetSweeps(SNES,PetscInt); 459 PETSC_EXTERN PetscErrorCode SNESNGSGetSweeps(SNES,PetscInt *); 460 PETSC_EXTERN PetscErrorCode SNESNGSSetTolerances(SNES,PetscReal,PetscReal,PetscReal,PetscInt); 461 PETSC_EXTERN PetscErrorCode SNESNGSGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,PetscInt*); 462 463 PETSC_EXTERN PetscErrorCode SNESUpdateCheckJacobian(SNES,PetscInt); 464 465 PETSC_EXTERN PetscErrorCode SNESShellGetContext(SNES,void**); 466 PETSC_EXTERN PetscErrorCode SNESShellSetContext(SNES,void*); 467 PETSC_EXTERN PetscErrorCode SNESShellSetSolve(SNES,PetscErrorCode (*)(SNES,Vec)); 468 469 /* --------- Routines specifically for line search methods --------------- */ 470 471 typedef struct _p_LineSearch* SNESLineSearch; 472 473 /*S 474 SNESLineSearch - Abstract PETSc object that manages line-search operations 475 476 Level: beginner 477 478 Concepts: nonlinear solvers, line search 479 480 .seealso: SNESLineSearchCreate(), SNESLineSearchSetType(), SNES 481 S*/ 482 483 /*J 484 SNESLineSearchType - String with the name of a PETSc line search method 485 486 Level: beginner 487 488 .seealso: SNESLineSearchSetType(), SNES 489 J*/ 490 491 typedef const char* SNESLineSearchType; 492 #define SNESLINESEARCHBT "bt" 493 #define SNESLINESEARCHBASIC "basic" 494 #define SNESLINESEARCHL2 "l2" 495 #define SNESLINESEARCHCP "cp" 496 #define SNESLINESEARCHSHELL "shell" 497 498 PETSC_EXTERN PetscFunctionList SNESList; 499 PETSC_EXTERN PetscClassId SNESLINESEARCH_CLASSID; 500 PETSC_EXTERN PetscFunctionList SNESLineSearchList; 501 PETSC_EXTERN PetscLogEvent SNESLineSearch_Apply; 502 503 #define SNES_LINESEARCH_ORDER_LINEAR 1 504 #define SNES_LINESEARCH_ORDER_QUADRATIC 2 505 #define SNES_LINESEARCH_ORDER_CUBIC 3 506 507 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchVIProjectFunc)(SNES,Vec); 508 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchVINormFunc)(SNES,Vec,Vec,PetscReal *); 509 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchApplyFunc)(SNESLineSearch); 510 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchUserFunc)(SNESLineSearch, void *); 511 512 PETSC_EXTERN PetscErrorCode SNESLineSearchCreate(MPI_Comm, SNESLineSearch*); 513 PETSC_EXTERN PetscErrorCode SNESLineSearchReset(SNESLineSearch); 514 PETSC_EXTERN PetscErrorCode SNESLineSearchView(SNESLineSearch,PetscViewer); 515 PETSC_EXTERN PetscErrorCode SNESLineSearchDestroy(SNESLineSearch *); 516 PETSC_EXTERN PetscErrorCode SNESLineSearchSetType(SNESLineSearch, SNESLineSearchType); 517 PETSC_EXTERN PetscErrorCode SNESLineSearchSetFromOptions(SNESLineSearch); 518 PETSC_EXTERN PetscErrorCode SNESLineSearchSetFunction(SNESLineSearch,PetscErrorCode (*)(SNES,Vec,Vec)); 519 PETSC_EXTERN PetscErrorCode SNESLineSearchSetUp(SNESLineSearch); 520 PETSC_EXTERN PetscErrorCode SNESLineSearchApply(SNESLineSearch, Vec, Vec, PetscReal *, Vec); 521 PETSC_EXTERN PetscErrorCode SNESLineSearchPreCheck(SNESLineSearch,Vec,Vec,PetscBool *); 522 PETSC_EXTERN PetscErrorCode SNESLineSearchPostCheck(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *); 523 PETSC_EXTERN PetscErrorCode SNESLineSearchSetWorkVecs(SNESLineSearch, PetscInt); 524 525 /* set the functions for precheck and postcheck */ 526 527 PETSC_EXTERN PetscErrorCode SNESLineSearchSetPreCheck(SNESLineSearch, PetscErrorCode (*)(SNESLineSearch,Vec,Vec,PetscBool*,void*), void *ctx); 528 PETSC_EXTERN PetscErrorCode SNESLineSearchSetPostCheck(SNESLineSearch, PetscErrorCode (*)(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *,void*), void *ctx); 529 530 PETSC_EXTERN PetscErrorCode SNESLineSearchGetPreCheck(SNESLineSearch, PetscErrorCode (**)(SNESLineSearch,Vec,Vec,PetscBool*,void*), void **ctx); 531 PETSC_EXTERN PetscErrorCode SNESLineSearchGetPostCheck(SNESLineSearch, PetscErrorCode (**)(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *,void*), void **ctx); 532 533 /* set the functions for VI-specific line search operations */ 534 535 PETSC_EXTERN PetscErrorCode SNESLineSearchSetVIFunctions(SNESLineSearch, SNESLineSearchVIProjectFunc, SNESLineSearchVINormFunc); 536 PETSC_EXTERN PetscErrorCode SNESLineSearchGetVIFunctions(SNESLineSearch, SNESLineSearchVIProjectFunc*, SNESLineSearchVINormFunc*); 537 538 /* pointers to the associated SNES in order to be able to get the function evaluation out */ 539 PETSC_EXTERN PetscErrorCode SNESLineSearchSetSNES(SNESLineSearch,SNES); 540 PETSC_EXTERN PetscErrorCode SNESLineSearchGetSNES(SNESLineSearch,SNES*); 541 542 /* set and get the parameters and vectors */ 543 PETSC_EXTERN PetscErrorCode SNESLineSearchGetTolerances(SNESLineSearch,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscInt*); 544 PETSC_EXTERN PetscErrorCode SNESLineSearchSetTolerances(SNESLineSearch,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscInt); 545 546 PETSC_EXTERN PetscErrorCode SNESLineSearchPreCheckPicard(SNESLineSearch,Vec,Vec,PetscBool*,void*); 547 548 PETSC_EXTERN PetscErrorCode SNESLineSearchGetLambda(SNESLineSearch,PetscReal*); 549 PETSC_EXTERN PetscErrorCode SNESLineSearchSetLambda(SNESLineSearch,PetscReal); 550 551 PETSC_EXTERN PetscErrorCode SNESLineSearchGetDamping(SNESLineSearch,PetscReal*); 552 PETSC_EXTERN PetscErrorCode SNESLineSearchSetDamping(SNESLineSearch,PetscReal); 553 554 PETSC_EXTERN PetscErrorCode SNESLineSearchGetOrder(SNESLineSearch,PetscInt *order); 555 PETSC_EXTERN PetscErrorCode SNESLineSearchSetOrder(SNESLineSearch,PetscInt order); 556 557 PETSC_EXTERN PetscErrorCode SNESLineSearchGetSuccess(SNESLineSearch, PetscBool*); 558 PETSC_EXTERN PetscErrorCode SNESLineSearchSetSuccess(SNESLineSearch, PetscBool); 559 560 PETSC_EXTERN PetscErrorCode SNESLineSearchGetVecs(SNESLineSearch,Vec*,Vec*,Vec*,Vec*,Vec*); 561 PETSC_EXTERN PetscErrorCode SNESLineSearchSetVecs(SNESLineSearch,Vec,Vec,Vec,Vec,Vec); 562 563 PETSC_EXTERN PetscErrorCode SNESLineSearchGetNorms(SNESLineSearch, PetscReal *, PetscReal *, PetscReal *); 564 PETSC_EXTERN PetscErrorCode SNESLineSearchSetNorms(SNESLineSearch, PetscReal, PetscReal, PetscReal); 565 PETSC_EXTERN PetscErrorCode SNESLineSearchComputeNorms(SNESLineSearch); 566 PETSC_EXTERN PetscErrorCode SNESLineSearchSetComputeNorms(SNESLineSearch, PetscBool); 567 568 PETSC_EXTERN PetscErrorCode SNESLineSearchSetMonitor(SNESLineSearch, PetscBool); 569 PETSC_EXTERN PetscErrorCode SNESLineSearchGetMonitor(SNESLineSearch, PetscViewer*); 570 571 PETSC_EXTERN PetscErrorCode SNESLineSearchAppendOptionsPrefix(SNESLineSearch, const char prefix[]); 572 PETSC_EXTERN PetscErrorCode SNESLineSearchGetOptionsPrefix(SNESLineSearch, const char *prefix[]); 573 574 575 /* Shell interface functions */ 576 PETSC_EXTERN PetscErrorCode SNESLineSearchShellSetUserFunc(SNESLineSearch,SNESLineSearchUserFunc,void*); 577 PETSC_EXTERN PetscErrorCode SNESLineSearchShellGetUserFunc(SNESLineSearch,SNESLineSearchUserFunc*,void**); 578 579 /* BT interface functions */ 580 PETSC_EXTERN PetscErrorCode SNESLineSearchBTSetAlpha(SNESLineSearch, PetscReal); 581 PETSC_EXTERN PetscErrorCode SNESLineSearchBTGetAlpha(SNESLineSearch, PetscReal*); 582 583 /*register line search types */ 584 PETSC_EXTERN PetscErrorCode SNESLineSearchRegister(const char[],PetscErrorCode(*)(SNESLineSearch)); 585 PETSC_EXTERN PetscErrorCode SNESLineSearchRegisterAll(void); 586 587 /* Routines for VI solver */ 588 PETSC_EXTERN PetscErrorCode SNESVISetVariableBounds(SNES,Vec,Vec); 589 PETSC_EXTERN PetscErrorCode SNESVISetComputeVariableBounds(SNES, PetscErrorCode (*)(SNES,Vec,Vec)); 590 PETSC_EXTERN PetscErrorCode SNESVIGetInactiveSet(SNES,IS*); 591 PETSC_EXTERN PetscErrorCode SNESVIGetActiveSetIS(SNES,Vec,Vec,IS*); 592 PETSC_EXTERN PetscErrorCode SNESVIComputeInactiveSetFnorm(SNES,Vec,Vec,PetscReal*); 593 PETSC_EXTERN PetscErrorCode SNESVISetRedundancyCheck(SNES,PetscErrorCode(*)(SNES,IS,IS*,void*),void*); 594 595 PETSC_EXTERN PetscErrorCode SNESTestLocalMin(SNES); 596 597 /* Should this routine be private? */ 598 PETSC_EXTERN PetscErrorCode SNESComputeJacobian(SNES,Vec,Mat,Mat); 599 600 PETSC_EXTERN PetscErrorCode SNESSetDM(SNES,DM); 601 PETSC_EXTERN PetscErrorCode SNESGetDM(SNES,DM*); 602 PETSC_EXTERN PetscErrorCode SNESSetNPC(SNES,SNES); 603 PETSC_EXTERN PetscErrorCode SNESGetNPC(SNES,SNES*); 604 PETSC_EXTERN PetscErrorCode SNESApplyNPC(SNES,Vec,Vec,Vec); 605 PETSC_EXTERN PetscErrorCode SNESGetNPCFunction(SNES,Vec,PetscReal*); 606 PETSC_EXTERN PetscErrorCode SNESComputeFunctionDefaultNPC(SNES,Vec,Vec); 607 PETSC_EXTERN PetscErrorCode SNESSetNPCSide(SNES,PCSide); 608 PETSC_EXTERN PetscErrorCode SNESGetNPCSide(SNES,PCSide*); 609 PETSC_EXTERN PetscErrorCode SNESSetLineSearch(SNES,SNESLineSearch); 610 PETSC_EXTERN PetscErrorCode SNESGetLineSearch(SNES,SNESLineSearch*); 611 PETSC_EXTERN PetscErrorCode SNESRestrictHookAdd(SNES,PetscErrorCode (*)(SNES,SNES,void*),void*); 612 PETSC_EXTERN PetscErrorCode SNESRestrictHooksRun(SNES,SNES); 613 614 PETSC_DEPRECATED("Use SNESGetLineSearch()") PETSC_STATIC_INLINE PetscErrorCode SNESGetSNESLineSearch(SNES snes,SNESLineSearch *ls) {return SNESGetLineSearch(snes,ls);} 615 PETSC_DEPRECATED("Use SNESSetLineSearch()") PETSC_STATIC_INLINE PetscErrorCode SNESSetSNESLineSearch(SNES snes,SNESLineSearch ls) {return SNESSetLineSearch(snes,ls);} 616 617 PETSC_EXTERN PetscErrorCode SNESSetUpMatrices(SNES); 618 PETSC_EXTERN PetscErrorCode DMSNESSetFunction(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),void*); 619 PETSC_EXTERN PetscErrorCode DMSNESGetFunction(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),void**); 620 PETSC_EXTERN PetscErrorCode DMSNESSetNGS(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),void*); 621 PETSC_EXTERN PetscErrorCode DMSNESGetNGS(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),void**); 622 PETSC_EXTERN PetscErrorCode DMSNESSetJacobian(DM,PetscErrorCode(*)(SNES,Vec,Mat,Mat,void*),void*); 623 PETSC_EXTERN PetscErrorCode DMSNESGetJacobian(DM,PetscErrorCode(**)(SNES,Vec,Mat,Mat,void*),void**); 624 PETSC_EXTERN PetscErrorCode DMSNESSetPicard(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),PetscErrorCode(*)(SNES,Vec,Mat,Mat,void*),void*); 625 PETSC_EXTERN PetscErrorCode DMSNESGetPicard(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),PetscErrorCode(**)(SNES,Vec,Mat,Mat,void*),void**); 626 PETSC_EXTERN PetscErrorCode DMSNESSetObjective(DM,PetscErrorCode (*)(SNES,Vec,PetscReal *,void*),void*); 627 PETSC_EXTERN PetscErrorCode DMSNESGetObjective(DM,PetscErrorCode (**)(SNES,Vec,PetscReal *,void*),void**); 628 629 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESFunction)(DMDALocalInfo*,void*,void*,void*); 630 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESJacobian)(DMDALocalInfo*,void*,Mat,Mat,void*); 631 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESObjective)(DMDALocalInfo*,void*,PetscReal*,void*); 632 633 PETSC_EXTERN PetscErrorCode DMDASNESSetFunctionLocal(DM,InsertMode,DMDASNESFunction,void*); 634 PETSC_EXTERN PetscErrorCode DMDASNESSetJacobianLocal(DM,DMDASNESJacobian,void*); 635 PETSC_EXTERN PetscErrorCode DMDASNESSetObjectiveLocal(DM,DMDASNESObjective,void*); 636 PETSC_EXTERN PetscErrorCode DMDASNESSetPicardLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,void*,void*,void*),PetscErrorCode (*)(DMDALocalInfo*,void*,Mat,Mat,void*),void*); 637 638 PETSC_EXTERN PetscErrorCode DMPlexSNESGetGeometryFEM(DM,Vec*); 639 PETSC_EXTERN PetscErrorCode DMPlexSNESGetGeometryFVM(DM,Vec*,Vec*,PetscReal*); 640 641 PETSC_EXTERN PetscErrorCode DMSNESSetFunctionLocal(DM,PetscErrorCode (*)(DM,Vec,Vec,void*),void*); 642 PETSC_EXTERN PetscErrorCode DMSNESSetJacobianLocal(DM,PetscErrorCode (*)(DM,Vec,Mat,Mat,void*),void*); 643 644 /* Routines for Multiblock solver */ 645 PETSC_EXTERN PetscErrorCode SNESMultiblockSetFields(SNES, const char [], PetscInt, const PetscInt *); 646 PETSC_EXTERN PetscErrorCode SNESMultiblockSetIS(SNES, const char [], IS); 647 PETSC_EXTERN PetscErrorCode SNESMultiblockSetBlockSize(SNES, PetscInt); 648 PETSC_EXTERN PetscErrorCode SNESMultiblockSetType(SNES, PCCompositeType); 649 650 /*J 651 SNESMSType - String with the name of a PETSc SNESMS method. 652 653 Level: intermediate 654 655 .seealso: SNESMSSetType(), SNES 656 J*/ 657 typedef const char* SNESMSType; 658 #define SNESMSM62 "m62" 659 #define SNESMSEULER "euler" 660 #define SNESMSJAMESON83 "jameson83" 661 #define SNESMSVLTP21 "vltp21" 662 #define SNESMSVLTP31 "vltp31" 663 #define SNESMSVLTP41 "vltp41" 664 #define SNESMSVLTP51 "vltp51" 665 #define SNESMSVLTP61 "vltp61" 666 667 PETSC_EXTERN PetscErrorCode SNESMSRegister(SNESMSType,PetscInt,PetscInt,PetscReal,const PetscReal[],const PetscReal[],const PetscReal[]); 668 PETSC_EXTERN PetscErrorCode SNESMSSetType(SNES,SNESMSType); 669 PETSC_EXTERN PetscErrorCode SNESMSFinalizePackage(void); 670 PETSC_EXTERN PetscErrorCode SNESMSInitializePackage(void); 671 PETSC_EXTERN PetscErrorCode SNESMSRegisterDestroy(void); 672 PETSC_EXTERN PetscErrorCode SNESMSRegisterAll(void); 673 674 /* routines for NGMRES solver */ 675 676 typedef enum { 677 SNES_NGMRES_RESTART_NONE = 0, 678 SNES_NGMRES_RESTART_PERIODIC = 1, 679 SNES_NGMRES_RESTART_DIFFERENCE = 2} SNESNGMRESRestartType; 680 PETSC_EXTERN const char *const SNESNGMRESRestartTypes[]; 681 682 typedef enum { 683 SNES_NGMRES_SELECT_NONE = 0, 684 SNES_NGMRES_SELECT_DIFFERENCE = 1, 685 SNES_NGMRES_SELECT_LINESEARCH = 2} SNESNGMRESSelectType; 686 PETSC_EXTERN const char *const SNESNGMRESSelectTypes[]; 687 688 PETSC_EXTERN PetscErrorCode SNESNGMRESSetRestartType(SNES, SNESNGMRESRestartType); 689 PETSC_EXTERN PetscErrorCode SNESNGMRESSetSelectType(SNES, SNESNGMRESSelectType); 690 691 /* routines for NCG solver */ 692 693 typedef enum { 694 SNES_NCG_FR = 0, 695 SNES_NCG_PRP = 1, 696 SNES_NCG_HS = 2, 697 SNES_NCG_DY = 3, 698 SNES_NCG_CD = 4} SNESNCGType; 699 PETSC_EXTERN const char *const SNESNCGTypes[]; 700 701 PETSC_EXTERN PetscErrorCode SNESNCGSetType(SNES, SNESNCGType); 702 703 typedef enum {SNES_QN_SCALE_DEFAULT = 0, 704 SNES_QN_SCALE_NONE = 1, 705 SNES_QN_SCALE_SHANNO = 2, 706 SNES_QN_SCALE_LINESEARCH = 3, 707 SNES_QN_SCALE_JACOBIAN = 4} SNESQNScaleType; 708 PETSC_EXTERN const char *const SNESQNScaleTypes[]; 709 typedef enum {SNES_QN_RESTART_DEFAULT = 0, 710 SNES_QN_RESTART_NONE = 1, 711 SNES_QN_RESTART_POWELL = 2, 712 SNES_QN_RESTART_PERIODIC = 3} SNESQNRestartType; 713 PETSC_EXTERN const char *const SNESQNRestartTypes[]; 714 typedef enum {SNES_QN_LBFGS = 0, 715 SNES_QN_BROYDEN = 1, 716 SNES_QN_BADBROYDEN = 2 717 } SNESQNType; 718 PETSC_EXTERN const char *const SNESQNTypes[]; 719 720 PETSC_EXTERN PetscErrorCode SNESQNSetType(SNES, SNESQNType); 721 PETSC_EXTERN PetscErrorCode SNESQNSetScaleType(SNES, SNESQNScaleType); 722 PETSC_EXTERN PetscErrorCode SNESQNSetRestartType(SNES, SNESQNRestartType); 723 724 PETSC_EXTERN PetscErrorCode SNESNASMGetType(SNES,PCASMType*); 725 PETSC_EXTERN PetscErrorCode SNESNASMSetType(SNES,PCASMType); 726 PETSC_EXTERN PetscErrorCode SNESNASMGetSubdomains(SNES,PetscInt*,SNES**,VecScatter**,VecScatter**,VecScatter**); 727 PETSC_EXTERN PetscErrorCode SNESNASMSetSubdomains(SNES,PetscInt,SNES*,VecScatter*,VecScatter*,VecScatter*); 728 PETSC_EXTERN PetscErrorCode SNESNASMSetDamping(SNES,PetscReal); 729 PETSC_EXTERN PetscErrorCode SNESNASMGetDamping(SNES,PetscReal*); 730 PETSC_EXTERN PetscErrorCode SNESNASMGetSubdomainVecs(SNES,PetscInt*,Vec**,Vec**,Vec**,Vec**); 731 PETSC_EXTERN PetscErrorCode SNESNASMSetComputeFinalJacobian(SNES,PetscBool); 732 733 typedef enum {SNES_COMPOSITE_ADDITIVE,SNES_COMPOSITE_MULTIPLICATIVE,SNES_COMPOSITE_ADDITIVEOPTIMAL} SNESCompositeType; 734 PETSC_EXTERN const char *const SNESCompositeTypes[]; 735 736 PETSC_EXTERN PetscErrorCode SNESCompositeSetType(SNES,SNESCompositeType); 737 PETSC_EXTERN PetscErrorCode SNESCompositeAddSNES(SNES,SNESType); 738 PETSC_EXTERN PetscErrorCode SNESCompositeGetSNES(SNES,PetscInt,SNES *); 739 PETSC_EXTERN PetscErrorCode SNESCompositeGetNumber(SNES,PetscInt*); 740 PETSC_EXTERN PetscErrorCode SNESCompositeSetDamping(SNES,PetscInt,PetscReal); 741 742 /*E 743 SNESFASType - Determines the type of nonlinear multigrid method that is run. 744 745 Level: beginner 746 747 Values: 748 + SNES_FAS_MULTIPLICATIVE (default) - traditional V or W cycle as determined by SNESFASSetCycles() 749 . SNES_FAS_ADDITIVE - additive FAS cycle 750 . SNES_FAS_FULL - full FAS cycle 751 - SNES_FAS_KASKADE - Kaskade FAS cycle 752 .seealso: PCMGSetType(), PCMGType 753 754 E*/ 755 typedef enum { SNES_FAS_MULTIPLICATIVE, SNES_FAS_ADDITIVE, SNES_FAS_FULL, SNES_FAS_KASKADE } SNESFASType; 756 PETSC_EXTERN const char *const SNESFASTypes[]; 757 758 /* called on the finest level FAS instance*/ 759 PETSC_EXTERN PetscErrorCode SNESFASSetType(SNES, SNESFASType); 760 PETSC_EXTERN PetscErrorCode SNESFASGetType(SNES, SNESFASType*); 761 PETSC_EXTERN PetscErrorCode SNESFASSetLevels(SNES, PetscInt, MPI_Comm *); 762 PETSC_EXTERN PetscErrorCode SNESFASGetLevels(SNES, PetscInt *); 763 PETSC_EXTERN PetscErrorCode SNESFASGetCycleSNES(SNES, PetscInt, SNES*); 764 PETSC_EXTERN PetscErrorCode SNESFASSetNumberSmoothUp(SNES, PetscInt); 765 PETSC_EXTERN PetscErrorCode SNESFASSetNumberSmoothDown(SNES, PetscInt); 766 PETSC_EXTERN PetscErrorCode SNESFASSetCycles(SNES, PetscInt); 767 PETSC_EXTERN PetscErrorCode SNESFASSetMonitor(SNES, PetscBool); 768 PETSC_EXTERN PetscErrorCode SNESFASSetLog(SNES, PetscBool); 769 770 PETSC_EXTERN PetscErrorCode SNESFASSetGalerkin(SNES, PetscBool); 771 PETSC_EXTERN PetscErrorCode SNESFASGetGalerkin(SNES, PetscBool*); 772 773 /* called on any level -- "Cycle" FAS instance */ 774 PETSC_EXTERN PetscErrorCode SNESFASCycleGetSmoother(SNES, SNES*); 775 PETSC_EXTERN PetscErrorCode SNESFASCycleGetSmootherUp(SNES, SNES*); 776 PETSC_EXTERN PetscErrorCode SNESFASCycleGetSmootherDown(SNES, SNES*); 777 PETSC_EXTERN PetscErrorCode SNESFASCycleGetCorrection(SNES, SNES*); 778 PETSC_EXTERN PetscErrorCode SNESFASCycleGetInterpolation(SNES, Mat*); 779 PETSC_EXTERN PetscErrorCode SNESFASCycleGetRestriction(SNES, Mat*); 780 PETSC_EXTERN PetscErrorCode SNESFASCycleGetInjection(SNES, Mat*); 781 PETSC_EXTERN PetscErrorCode SNESFASCycleGetRScale(SNES, Vec*); 782 PETSC_EXTERN PetscErrorCode SNESFASCycleSetCycles(SNES, PetscInt); 783 PETSC_EXTERN PetscErrorCode SNESFASCycleIsFine(SNES, PetscBool*); 784 785 /* called on the (outer) finest level FAS to set/get parameters on any level instance */ 786 PETSC_EXTERN PetscErrorCode SNESFASSetInterpolation(SNES, PetscInt, Mat); 787 PETSC_EXTERN PetscErrorCode SNESFASGetInterpolation(SNES, PetscInt, Mat*); 788 PETSC_EXTERN PetscErrorCode SNESFASSetRestriction(SNES, PetscInt, Mat); 789 PETSC_EXTERN PetscErrorCode SNESFASGetRestriction(SNES, PetscInt, Mat*); 790 PETSC_EXTERN PetscErrorCode SNESFASSetInjection(SNES, PetscInt, Mat); 791 PETSC_EXTERN PetscErrorCode SNESFASGetInjection(SNES, PetscInt, Mat*); 792 PETSC_EXTERN PetscErrorCode SNESFASSetRScale(SNES, PetscInt, Vec); 793 PETSC_EXTERN PetscErrorCode SNESFASGetRScale(SNES, PetscInt, Vec*); 794 PETSC_EXTERN PetscErrorCode SNESFASSetContinuation(SNES,PetscBool); 795 796 PETSC_EXTERN PetscErrorCode SNESFASGetSmoother(SNES, PetscInt, SNES*); 797 PETSC_EXTERN PetscErrorCode SNESFASGetSmootherUp(SNES, PetscInt, SNES*); 798 PETSC_EXTERN PetscErrorCode SNESFASGetSmootherDown(SNES, PetscInt, SNES*); 799 PETSC_EXTERN PetscErrorCode SNESFASGetCoarseSolve(SNES, SNES*); 800 801 /* parameters for full FAS */ 802 PETSC_EXTERN PetscErrorCode SNESFASFullSetDownSweep(SNES,PetscBool); 803 PETSC_EXTERN PetscErrorCode SNESFASCreateCoarseVec(SNES,Vec*); 804 PETSC_EXTERN PetscErrorCode SNESFASRestrict(SNES,Vec,Vec); 805 806 #endif 807