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 <petscdmda.h> 8 9 /*S 10 SNES - Abstract PETSc object that manages all nonlinear solves 11 12 Level: beginner 13 14 Concepts: nonlinear solvers 15 16 .seealso: SNESCreate(), SNESSetType(), SNESType, TS, KSP, KSP, PC 17 S*/ 18 typedef struct _p_SNES* SNES; 19 20 /*J 21 SNESType - String with the name of a PETSc SNES method or the creation function 22 with an optional dynamic library name, for example 23 http://www.mcs.anl.gov/petsc/lib.a:mysnescreate() 24 25 Level: beginner 26 27 .seealso: SNESSetType(), SNES 28 J*/ 29 typedef const char* SNESType; 30 #define SNESLS "ls" 31 #define SNESTR "tr" 32 #define SNESPYTHON "python" 33 #define SNESTEST "test" 34 #define SNESNRICHARDSON "nrichardson" 35 #define SNESKSPONLY "ksponly" 36 #define SNESVIRS "virs" 37 #define SNESVISS "viss" 38 #define SNESNGMRES "ngmres" 39 #define SNESQN "qn" 40 #define SNESSHELL "shell" 41 #define SNESGS "gs" 42 #define SNESNCG "ncg" 43 #define SNESFAS "fas" 44 #define SNESMS "ms" 45 #define SNESNASM "nasm" 46 47 /* Logging support */ 48 PETSC_EXTERN PetscClassId SNES_CLASSID; 49 50 PETSC_EXTERN PetscErrorCode SNESInitializePackage(const char[]); 51 52 PETSC_EXTERN PetscErrorCode SNESCreate(MPI_Comm,SNES*); 53 PETSC_EXTERN PetscErrorCode SNESReset(SNES); 54 PETSC_EXTERN PetscErrorCode SNESDestroy(SNES*); 55 PETSC_EXTERN PetscErrorCode SNESSetType(SNES,SNESType); 56 PETSC_EXTERN PetscErrorCode SNESMonitor(SNES,PetscInt,PetscReal); 57 PETSC_EXTERN PetscErrorCode SNESMonitorSet(SNES,PetscErrorCode(*)(SNES,PetscInt,PetscReal,void*),void *,PetscErrorCode (*)(void**)); 58 PETSC_EXTERN PetscErrorCode SNESMonitorCancel(SNES); 59 PETSC_EXTERN PetscErrorCode SNESSetConvergenceHistory(SNES,PetscReal[],PetscInt[],PetscInt,PetscBool ); 60 PETSC_EXTERN PetscErrorCode SNESGetConvergenceHistory(SNES,PetscReal*[],PetscInt *[],PetscInt *); 61 PETSC_EXTERN PetscErrorCode SNESSetUp(SNES); 62 PETSC_EXTERN PetscErrorCode SNESSolve(SNES,Vec,Vec); 63 PETSC_EXTERN PetscErrorCode SNESSetErrorIfNotConverged(SNES,PetscBool ); 64 PETSC_EXTERN PetscErrorCode SNESGetErrorIfNotConverged(SNES,PetscBool *); 65 66 67 PETSC_EXTERN PetscErrorCode SNESAddOptionsChecker(PetscErrorCode (*)(SNES)); 68 69 PETSC_EXTERN PetscErrorCode SNESSetUpdate(SNES, PetscErrorCode (*)(SNES, PetscInt)); 70 PETSC_EXTERN PetscErrorCode SNESDefaultUpdate(SNES, PetscInt); 71 72 PETSC_EXTERN PetscFList SNESList; 73 PETSC_EXTERN PetscErrorCode SNESRegisterDestroy(void); 74 PETSC_EXTERN PetscErrorCode SNESRegisterAll(const char[]); 75 76 PETSC_EXTERN PetscErrorCode SNESRegister(const char[],const char[],const char[],PetscErrorCode (*)(SNES)); 77 78 /*MC 79 SNESRegisterDynamic - Adds a method to the nonlinear solver package. 80 81 Synopsis: 82 PetscErrorCode SNESRegisterDynamic(const char *name_solver,const char *path,const char *name_create,PetscErrorCode (*routine_create)(SNES)) 83 84 Not collective 85 86 Input Parameters: 87 + name_solver - name of a new user-defined solver 88 . path - path (either absolute or relative) the library containing this solver 89 . name_create - name of routine to create method context 90 - routine_create - routine to create method context 91 92 Notes: 93 SNESRegisterDynamic() may be called multiple times to add several user-defined solvers. 94 95 If dynamic libraries are used, then the fourth input argument (routine_create) 96 is ignored. 97 98 Environmental variables such as ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR}, 99 and others of the form ${any_environmental_variable} occuring in pathname will be 100 replaced with appropriate values. 101 102 Sample usage: 103 .vb 104 SNESRegisterDynamic("my_solver",/home/username/my_lib/lib/libg/solaris/mylib.a, 105 "MySolverCreate",MySolverCreate); 106 .ve 107 108 Then, your solver can be chosen with the procedural interface via 109 $ SNESSetType(snes,"my_solver") 110 or at runtime via the option 111 $ -snes_type my_solver 112 113 Level: advanced 114 115 Note: If your function is not being put into a shared library then use SNESRegister() instead 116 117 .keywords: SNES, nonlinear, register 118 119 .seealso: SNESRegisterAll(), SNESRegisterDestroy() 120 M*/ 121 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 122 #define SNESRegisterDynamic(a,b,c,d) SNESRegister(a,b,c,0) 123 #else 124 #define SNESRegisterDynamic(a,b,c,d) SNESRegister(a,b,c,d) 125 #endif 126 127 PETSC_EXTERN PetscErrorCode SNESGetKSP(SNES,KSP*); 128 PETSC_EXTERN PetscErrorCode SNESSetKSP(SNES,KSP); 129 PETSC_EXTERN PetscErrorCode SNESGetSolution(SNES,Vec*); 130 PETSC_EXTERN PetscErrorCode SNESGetSolutionUpdate(SNES,Vec*); 131 PETSC_EXTERN PetscErrorCode SNESGetRhs(SNES,Vec*); 132 PETSC_EXTERN PetscErrorCode SNESView(SNES,PetscViewer); 133 134 PETSC_EXTERN PetscErrorCode SNESSetOptionsPrefix(SNES,const char[]); 135 PETSC_EXTERN PetscErrorCode SNESAppendOptionsPrefix(SNES,const char[]); 136 PETSC_EXTERN PetscErrorCode SNESGetOptionsPrefix(SNES,const char*[]); 137 PETSC_EXTERN PetscErrorCode SNESSetFromOptions(SNES); 138 PETSC_EXTERN PetscErrorCode SNESDefaultGetWork(SNES,PetscInt); 139 140 PETSC_EXTERN PetscErrorCode MatCreateSNESMF(SNES,Mat*); 141 PETSC_EXTERN PetscErrorCode MatMFFDComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 142 143 PETSC_EXTERN PetscErrorCode MatDAADSetSNES(Mat,SNES); 144 145 PETSC_EXTERN PetscErrorCode SNESGetType(SNES,SNESType*); 146 PETSC_EXTERN PetscErrorCode SNESMonitorDefault(SNES,PetscInt,PetscReal,void *); 147 PETSC_EXTERN PetscErrorCode SNESMonitorRange(SNES,PetscInt,PetscReal,void *); 148 PETSC_EXTERN PetscErrorCode SNESMonitorRatio(SNES,PetscInt,PetscReal,void *); 149 PETSC_EXTERN PetscErrorCode SNESMonitorSetRatio(SNES,PetscViewer); 150 PETSC_EXTERN PetscErrorCode SNESMonitorSolution(SNES,PetscInt,PetscReal,void *); 151 PETSC_EXTERN PetscErrorCode SNESMonitorResidual(SNES,PetscInt,PetscReal,void *); 152 PETSC_EXTERN PetscErrorCode SNESMonitorSolutionUpdate(SNES,PetscInt,PetscReal,void *); 153 PETSC_EXTERN PetscErrorCode SNESMonitorDefaultShort(SNES,PetscInt,PetscReal,void *); 154 PETSC_EXTERN PetscErrorCode SNESMonitorJacUpdateSpectrum(SNES,PetscInt,PetscReal,void *); 155 PETSC_EXTERN PetscErrorCode SNESSetTolerances(SNES,PetscReal,PetscReal,PetscReal,PetscInt,PetscInt); 156 PETSC_EXTERN PetscErrorCode SNESGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,PetscInt*,PetscInt*); 157 PETSC_EXTERN PetscErrorCode SNESSetTrustRegionTolerance(SNES,PetscReal); 158 PETSC_EXTERN PetscErrorCode SNESGetFunctionNorm(SNES,PetscReal*); 159 PETSC_EXTERN PetscErrorCode SNESSetFunctionNorm(SNES,PetscReal); 160 PETSC_EXTERN PetscErrorCode SNESGetIterationNumber(SNES,PetscInt*); 161 PETSC_EXTERN PetscErrorCode SNESSetIterationNumber(SNES,PetscInt); 162 163 PETSC_EXTERN PetscErrorCode SNESGetNonlinearStepFailures(SNES,PetscInt*); 164 PETSC_EXTERN PetscErrorCode SNESSetMaxNonlinearStepFailures(SNES,PetscInt); 165 PETSC_EXTERN PetscErrorCode SNESGetMaxNonlinearStepFailures(SNES,PetscInt*); 166 PETSC_EXTERN PetscErrorCode SNESGetNumberFunctionEvals(SNES,PetscInt*); 167 168 PETSC_EXTERN PetscErrorCode SNESSetLagPreconditioner(SNES,PetscInt); 169 PETSC_EXTERN PetscErrorCode SNESGetLagPreconditioner(SNES,PetscInt*); 170 PETSC_EXTERN PetscErrorCode SNESSetLagJacobian(SNES,PetscInt); 171 PETSC_EXTERN PetscErrorCode SNESGetLagJacobian(SNES,PetscInt*); 172 PETSC_EXTERN PetscErrorCode SNESSetGridSequence(SNES,PetscInt); 173 174 PETSC_EXTERN PetscErrorCode SNESGetLinearSolveIterations(SNES,PetscInt*); 175 PETSC_EXTERN PetscErrorCode SNESGetLinearSolveFailures(SNES,PetscInt*); 176 PETSC_EXTERN PetscErrorCode SNESSetMaxLinearSolveFailures(SNES,PetscInt); 177 PETSC_EXTERN PetscErrorCode SNESGetMaxLinearSolveFailures(SNES,PetscInt*); 178 179 PETSC_EXTERN PetscErrorCode SNESKSPSetUseEW(SNES,PetscBool ); 180 PETSC_EXTERN PetscErrorCode SNESKSPGetUseEW(SNES,PetscBool *); 181 PETSC_EXTERN PetscErrorCode SNESKSPSetParametersEW(SNES,PetscInt,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal); 182 PETSC_EXTERN PetscErrorCode SNESKSPGetParametersEW(SNES,PetscInt*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*); 183 184 PETSC_EXTERN PetscErrorCode SNESMonitorLGCreate(const char[],const char[],int,int,int,int,PetscDrawLG*); 185 PETSC_EXTERN PetscErrorCode SNESMonitorLG(SNES,PetscInt,PetscReal,void*); 186 PETSC_EXTERN PetscErrorCode SNESMonitorLGDestroy(PetscDrawLG*); 187 PETSC_EXTERN PetscErrorCode SNESMonitorLGRangeCreate(const char[],const char[],int,int,int,int,PetscDrawLG*); 188 PETSC_EXTERN PetscErrorCode SNESMonitorLGRange(SNES,PetscInt,PetscReal,void*); 189 PETSC_EXTERN PetscErrorCode SNESMonitorLGRangeDestroy(PetscDrawLG*); 190 191 PETSC_EXTERN PetscErrorCode SNESSetApplicationContext(SNES,void *); 192 PETSC_EXTERN PetscErrorCode SNESGetApplicationContext(SNES,void *); 193 PETSC_EXTERN PetscErrorCode SNESSetComputeApplicationContext(SNES,PetscErrorCode (*)(SNES,void**),PetscErrorCode (*)(void**)); 194 195 PETSC_EXTERN PetscErrorCode SNESPythonSetType(SNES,const char[]); 196 197 PETSC_EXTERN PetscErrorCode SNESSetFunctionDomainError(SNES); 198 PETSC_EXTERN PetscErrorCode SNESGetFunctionDomainError(SNES, PetscBool *); 199 200 /*E 201 SNESConvergedReason - reason a SNES method was said to 202 have converged or diverged 203 204 Level: beginner 205 206 The two most common reasons for divergence are 207 $ 1) an incorrectly coded or computed Jacobian or 208 $ 2) failure or lack of convergence in the linear system (in this case we recommend 209 $ testing with -pc_type lu to eliminate the linear solver as the cause of the problem). 210 211 Diverged Reasons: 212 . SNES_DIVERGED_LOCAL_MIN - this can only occur when using the line-search variant of SNES. 213 The line search wants to minimize Q(alpha) = 1/2 || F(x + alpha s) ||^2_2 this occurs 214 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 215 you get Q'(alpha) = -F(x)^T F'(x)^(-1)^T F'(x+alpha s)F(x+alpha s); when alpha = 0 216 Q'(0) = - ||F(x)||^2_2 which is always NEGATIVE if F'(x) is invertible. This means the Newton 217 direction is a descent direction and the line search should succeed if alpha is small enough. 218 219 If F'(x) is NOT invertible AND F'(x)^T F(x) = 0 then Q'(0) = 0 and the Newton direction 220 is NOT a descent direction so the line search will fail. All one can do at this point 221 is change the initial guess and try again. 222 223 An alternative explanation: Newton's method can be regarded as replacing the function with 224 its linear approximation and minimizing the 2-norm of that. That is F(x+s) approx F(x) + F'(x)s 225 so we minimize || F(x) + F'(x) s ||^2_2; do this using Least Squares. If F'(x) is invertible then 226 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 227 exists a nontrival (that is F'(x)s != 0) solution to the equation and this direction is 228 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) 229 = - (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 230 and F'(x)^T F'(x) has no negative eigenvalues Q'(0) < 0 so s is a descent direction and the line 231 search should succeed for small enough alpha. 232 233 Note that this RARELY happens in practice. Far more likely the linear system is not being solved 234 (well enough?) or the Jacobian is wrong. 235 236 SNES_DIVERGED_MAX_IT means that the solver reached the maximum number of iterations without satisfying any 237 convergence criteria. SNES_CONVERGED_ITS means that SNESSkipConverged() was chosen as the convergence test; 238 thus the usual convergence criteria have not been checked and may or may not be satisfied. 239 240 Developer Notes: this must match finclude/petscsnes.h 241 242 The string versions of these are in SNESConvergedReason, if you change any value here you must 243 also adjust that array. 244 245 Each reason has its own manual page. 246 247 .seealso: SNESSolve(), SNESGetConvergedReason(), KSPConvergedReason, SNESSetConvergenceTest() 248 E*/ 249 typedef enum {/* converged */ 250 SNES_CONVERGED_FNORM_ABS = 2, /* ||F|| < atol */ 251 SNES_CONVERGED_FNORM_RELATIVE = 3, /* ||F|| < rtol*||F_initial|| */ 252 SNES_CONVERGED_SNORM_RELATIVE = 4, /* Newton computed step size small; || delta x || < stol */ 253 SNES_CONVERGED_ITS = 5, /* maximum iterations reached */ 254 SNES_CONVERGED_TR_DELTA = 7, 255 /* diverged */ 256 SNES_DIVERGED_FUNCTION_DOMAIN = -1, /* the new x location passed the function is not in the domain of F */ 257 SNES_DIVERGED_FUNCTION_COUNT = -2, 258 SNES_DIVERGED_LINEAR_SOLVE = -3, /* the linear solve failed */ 259 SNES_DIVERGED_FNORM_NAN = -4, 260 SNES_DIVERGED_MAX_IT = -5, 261 SNES_DIVERGED_LINE_SEARCH = -6, /* the line search failed */ 262 SNES_DIVERGED_INNER = -7, /* inner solve failed */ 263 SNES_DIVERGED_LOCAL_MIN = -8, /* || J^T b || is small, implies converged to local minimum of F() */ 264 SNES_CONVERGED_ITERATING = 0} SNESConvergedReason; 265 PETSC_EXTERN const char *const*SNESConvergedReasons; 266 267 /*MC 268 SNES_CONVERGED_FNORM_ABS - 2-norm(F) <= abstol 269 270 Level: beginner 271 272 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 273 274 M*/ 275 276 /*MC 277 SNES_CONVERGED_FNORM_RELATIVE - 2-norm(F) <= rtol*2-norm(F(x_0)) where x_0 is the initial guess 278 279 Level: beginner 280 281 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 282 283 M*/ 284 285 /*MC 286 SNES_CONVERGED_SNORM_RELATIVE - The 2-norm of the last step <= stol * 2-norm(x) where x is the current 287 solution and stol is the 4th argument to SNESSetTolerances() 288 289 Options Database Keys: 290 -snes_stol <stol> - the step tolerance 291 292 Level: beginner 293 294 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 295 296 M*/ 297 298 /*MC 299 SNES_DIVERGED_FUNCTION_COUNT - The user provided function has been called more times then the final 300 argument to SNESSetTolerances() 301 302 Level: beginner 303 304 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 305 306 M*/ 307 308 /*MC 309 SNES_DIVERGED_FNORM_NAN - the 2-norm of the current function evaluation is not-a-number (NaN), this 310 is usually caused by a division of 0 by 0. 311 312 Level: beginner 313 314 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 315 316 M*/ 317 318 /*MC 319 SNES_DIVERGED_MAX_IT - SNESSolve() has reached the maximum number of iterations requested 320 321 Level: beginner 322 323 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 324 325 M*/ 326 327 /*MC 328 SNES_DIVERGED_LINE_SEARCH - The line search has failed. This only occurs for a SNESType of SNESLS 329 330 Level: beginner 331 332 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 333 334 M*/ 335 336 /*MC 337 SNES_DIVERGED_LOCAL_MIN - the algorithm seems to have stagnated at a local minimum that is not zero. 338 See the manual page for SNESConvergedReason for more details 339 340 Level: beginner 341 342 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 343 344 M*/ 345 346 /*MC 347 SNES_CONERGED_ITERATING - this only occurs if SNESGetConvergedReason() is called during the SNESSolve() 348 349 Level: beginner 350 351 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 352 353 M*/ 354 355 PETSC_EXTERN PetscErrorCode SNESSetConvergenceTest(SNES,PetscErrorCode (*)(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void*,PetscErrorCode (*)(void*)); 356 PETSC_EXTERN PetscErrorCode SNESDefaultConverged(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*); 357 PETSC_EXTERN PetscErrorCode SNESSkipConverged(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*); 358 PETSC_EXTERN PetscErrorCode SNESGetConvergedReason(SNES,SNESConvergedReason*); 359 360 PETSC_EXTERN PetscErrorCode SNESDMMeshComputeFunction(SNES,Vec,Vec,void*); 361 PETSC_EXTERN PetscErrorCode SNESDMMeshComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 362 PETSC_EXTERN PetscErrorCode SNESDMComputeFunction(SNES,Vec,Vec,void *); 363 PETSC_EXTERN PetscErrorCode SNESDMComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 364 365 /* --------- Solving systems of nonlinear equations --------------- */ 366 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESFunction)(SNES,Vec,Vec,void*); 367 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESJacobian)(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 368 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESGSFunction)(SNES,Vec,Vec,void*); 369 PETSC_EXTERN PetscErrorCode SNESSetFunction(SNES,Vec,SNESFunction,void*); 370 PETSC_EXTERN PetscErrorCode SNESGetFunction(SNES,Vec*,SNESFunction*,void**); 371 PETSC_EXTERN PetscErrorCode SNESComputeFunction(SNES,Vec,Vec); 372 PETSC_EXTERN PetscErrorCode SNESSetJacobian(SNES,Mat,Mat,SNESJacobian,void*); 373 PETSC_EXTERN PetscErrorCode SNESGetJacobian(SNES,Mat*,Mat*,SNESJacobian*,void**); 374 PETSC_EXTERN PetscErrorCode SNESDefaultComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 375 PETSC_EXTERN PetscErrorCode SNESDefaultComputeJacobianColor(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 376 PETSC_EXTERN PetscErrorCode SNESSetComputeInitialGuess(SNES,PetscErrorCode (*)(SNES,Vec,void*),void*); 377 PETSC_EXTERN PetscErrorCode SNESSetPicard(SNES,Vec,SNESFunction,Mat,Mat,SNESJacobian,void*); 378 PETSC_EXTERN PetscErrorCode SNESGetPicard(SNES,Vec*,SNESFunction*,Mat*,Mat*,SNESJacobian*,void**); 379 PETSC_EXTERN PetscErrorCode SNESSetInitialFunction(SNES,Vec); 380 PETSC_EXTERN PetscErrorCode SNESSetInitialFunctionNorm(SNES,PetscReal); 381 382 /*E 383 SNESNormType - Norm that is passed in the Krylov convergence 384 test routines. 385 386 Level: advanced 387 388 Support for these is highly dependent on the solver. 389 390 Notes: 391 This is primarily used to turn off extra norm and function computation 392 when the solvers are composed. 393 394 .seealso: SNESSolve(), SNESGetConvergedReason(), KSPSetNormType(), 395 KSPSetConvergenceTest(), KSPSetPCSide() 396 E*/ 397 398 typedef enum {SNES_NORM_DEFAULT = -1, 399 SNES_NORM_NONE = 0, 400 SNES_NORM_FUNCTION = 1, 401 SNES_NORM_INITIAL_ONLY = 2, 402 SNES_NORM_FINAL_ONLY = 3, 403 SNES_NORM_INITIAL_FINAL_ONLY = 4} SNESNormType; 404 PETSC_EXTERN const char *const*const SNESNormTypes; 405 /*MC 406 SNES_NORM_NONE - Don't compute function and its L2 norm. 407 408 Level: advanced 409 410 Notes: 411 This is most useful for stationary solvers with a fixed number of iterations used as smoothers. 412 413 .seealso: SNESNormType, SNESSetNormType(), SNES_NORM_DEFAULT 414 M*/ 415 416 /*MC 417 SNES_NORM_FUNCTION - Compute the function and its L2 norm at each iteration. 418 419 Level: advanced 420 421 Notes: 422 Most solvers will use this no matter what norm type is passed to them. 423 424 .seealso: SNESNormType, SNESSetNormType(), SNES_NORM_NONE 425 M*/ 426 427 /*MC 428 SNES_NORM_INITIAL_ONLY - Compute the function and its L2 at iteration 0, but do not update it. 429 430 Level: advanced 431 432 Notes: 433 This method is useful in composed methods, when a true solution might actually be found before SNESSolve() is called. 434 This option enables the solve to abort on the zeroth iteration if this is the case. 435 436 For solvers that require the computation of the L2 norm of the function as part of the method, this merely cancels 437 the norm computation at the last iteration (if possible). 438 439 .seealso: SNESNormType, SNESSetNormType(), SNES_NORM_FINAL_ONLY, SNES_NORM_INITIAL_FINAL_ONLY 440 M*/ 441 442 /*MC 443 SNES_NORM_FINAL_ONLY - Compute the function and its L2 norm on only the final iteration. 444 445 Level: advanced 446 447 Notes: 448 For solvers that require the computation of the L2 norm of the function as part of the method, behaves 449 exactly as SNES_NORM_DEFAULT. This method is useful when the function is gotten after SNESSolve and 450 used in subsequent computation for methods that do not need the norm computed during the rest of the 451 solution procedure. 452 453 .seealso: SNESNormType, SNESSetNormType(), SNES_NORM_INITIAL_ONLY, SNES_NORM_INITIAL_FINAL_ONLY 454 M*/ 455 456 /*MC 457 SNES_NORM_INITIAL_FINAL_ONLY - Compute the function and its L2 norm on only the initial and final iterations. 458 459 Level: advanced 460 461 Notes: 462 This method combines the benefits of SNES_NORM_INITIAL_ONLY and SNES_NORM_FINAL_ONLY. 463 464 .seealso: SNESNormType, SNESSetNormType(), SNES_NORM_SNES_NORM_INITIAL_ONLY, SNES_NORM_FINAL_ONLY 465 M*/ 466 467 468 PETSC_EXTERN PetscErrorCode SNESSetNormType(SNES,SNESNormType); 469 PETSC_EXTERN PetscErrorCode SNESGetNormType(SNES,SNESNormType*); 470 471 PETSC_EXTERN PetscErrorCode SNESSetGS(SNES,SNESGSFunction,void*); 472 PETSC_EXTERN PetscErrorCode SNESGetGS(SNES,SNESGSFunction*,void**); 473 PETSC_EXTERN PetscErrorCode SNESSetUseGS(SNES,PetscBool); 474 PETSC_EXTERN PetscErrorCode SNESGetUseGS(SNES,PetscBool *); 475 PETSC_EXTERN PetscErrorCode SNESSetGSSweeps(SNES,PetscInt); 476 PETSC_EXTERN PetscErrorCode SNESGetGSSweeps(SNES,PetscInt *); 477 PETSC_EXTERN PetscErrorCode SNESComputeGS(SNES,Vec,Vec); 478 479 PETSC_EXTERN PetscErrorCode SNESShellGetContext(SNES,void**); 480 PETSC_EXTERN PetscErrorCode SNESShellSetContext(SNES,void*); 481 PETSC_EXTERN PetscErrorCode SNESShellSetSolve(SNES,PetscErrorCode (*)(SNES,Vec)); 482 483 /* --------- Routines specifically for line search methods --------------- */ 484 485 typedef struct _p_LineSearch* SNESLineSearch; 486 487 /*S 488 SNESLineSearch - Abstract PETSc object that manages line-search operations 489 490 Level: beginner 491 492 Concepts: nonlinear solvers, line search 493 494 .seealso: SNESLineSearchCreate(), SNESLineSearchSetType(), SNES 495 S*/ 496 497 /*J 498 SNESLineSearchType - String with the name of a PETSc line search method 499 500 Level: beginner 501 502 .seealso: SNESLineSearchSetType(), SNES 503 J*/ 504 505 typedef const char* SNESLineSearchType; 506 #define SNESLINESEARCHBT "bt" 507 #define SNESLINESEARCHBASIC "basic" 508 #define SNESLINESEARCHL2 "l2" 509 #define SNESLINESEARCHCP "cp" 510 #define SNESLINESEARCHSHELL "shell" 511 512 PETSC_EXTERN PetscClassId SNESLINESEARCH_CLASSID; 513 PETSC_EXTERN PetscBool SNESLineSearchRegisterAllCalled; 514 PETSC_EXTERN PetscFList SNESLineSearchList; 515 PETSC_EXTERN PetscLogEvent SNESLineSearch_Apply; 516 517 #define SNES_LINESEARCH_ORDER_LINEAR 1 518 #define SNES_LINESEARCH_ORDER_QUADRATIC 2 519 #define SNES_LINESEARCH_ORDER_CUBIC 3 520 521 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchPreCheckFunc)(SNESLineSearch,Vec,Vec,PetscBool*,void*); 522 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchVIProjectFunc)(SNES,Vec); 523 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchVINormFunc)(SNES,Vec,Vec,PetscReal *); 524 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchPostCheckFunc)(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *,void*); 525 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchApplyFunc)(SNESLineSearch); 526 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchUserFunc)(SNESLineSearch, void *); 527 528 PETSC_EXTERN PetscErrorCode SNESLineSearchCreate(MPI_Comm, SNESLineSearch*); 529 PETSC_EXTERN PetscErrorCode SNESLineSearchReset(SNESLineSearch); 530 PETSC_EXTERN PetscErrorCode SNESLineSearchView(SNESLineSearch,PetscViewer); 531 PETSC_EXTERN PetscErrorCode SNESLineSearchDestroy(SNESLineSearch *); 532 PETSC_EXTERN PetscErrorCode SNESLineSearchSetType(SNESLineSearch, SNESLineSearchType); 533 PETSC_EXTERN PetscErrorCode SNESLineSearchSetFromOptions(SNESLineSearch); 534 PETSC_EXTERN PetscErrorCode SNESLineSearchSetUp(SNESLineSearch); 535 PETSC_EXTERN PetscErrorCode SNESLineSearchApply(SNESLineSearch, Vec, Vec, PetscReal *, Vec); 536 PETSC_EXTERN PetscErrorCode SNESLineSearchPreCheck(SNESLineSearch,Vec,Vec,PetscBool *); 537 PETSC_EXTERN PetscErrorCode SNESLineSearchPostCheck(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *); 538 PETSC_EXTERN PetscErrorCode SNESLineSearchGetWork(SNESLineSearch, PetscInt); 539 540 /* set the functions for precheck and postcheck */ 541 542 PETSC_EXTERN PetscErrorCode SNESLineSearchSetPreCheck(SNESLineSearch, SNESLineSearchPreCheckFunc, void *ctx); 543 PETSC_EXTERN PetscErrorCode SNESLineSearchSetPostCheck(SNESLineSearch, SNESLineSearchPostCheckFunc, void *ctx); 544 545 PETSC_EXTERN PetscErrorCode SNESLineSearchGetPreCheck(SNESLineSearch, SNESLineSearchPreCheckFunc*, void **ctx); 546 PETSC_EXTERN PetscErrorCode SNESLineSearchGetPostCheck(SNESLineSearch, SNESLineSearchPostCheckFunc*, void **ctx); 547 548 /* set the functions for VI-specific line search operations */ 549 550 PETSC_EXTERN PetscErrorCode SNESLineSearchSetVIFunctions(SNESLineSearch, SNESLineSearchVIProjectFunc, SNESLineSearchVINormFunc); 551 PETSC_EXTERN PetscErrorCode SNESLineSearchGetVIFunctions(SNESLineSearch, SNESLineSearchVIProjectFunc*, SNESLineSearchVINormFunc*); 552 553 /* pointers to the associated SNES in order to be able to get the function evaluation out */ 554 PETSC_EXTERN PetscErrorCode SNESLineSearchSetSNES(SNESLineSearch,SNES); 555 PETSC_EXTERN PetscErrorCode SNESLineSearchGetSNES(SNESLineSearch,SNES*); 556 557 /* set and get the parameters and vectors */ 558 PETSC_EXTERN PetscErrorCode SNESLineSearchGetTolerances(SNESLineSearch,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscInt*); 559 PETSC_EXTERN PetscErrorCode SNESLineSearchSetTolerances(SNESLineSearch,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscInt); 560 561 PETSC_EXTERN PetscErrorCode SNESLineSearchPreCheckPicard(SNESLineSearch,Vec,Vec,PetscBool*,void*); 562 563 PETSC_EXTERN PetscErrorCode SNESLineSearchGetLambda(SNESLineSearch,PetscReal*); 564 PETSC_EXTERN PetscErrorCode SNESLineSearchSetLambda(SNESLineSearch,PetscReal); 565 566 PETSC_EXTERN PetscErrorCode SNESLineSearchGetDamping(SNESLineSearch,PetscReal*); 567 PETSC_EXTERN PetscErrorCode SNESLineSearchSetDamping(SNESLineSearch,PetscReal); 568 569 PETSC_EXTERN PetscErrorCode SNESLineSearchGetOrder(SNESLineSearch,PetscInt *order); 570 PETSC_EXTERN PetscErrorCode SNESLineSearchSetOrder(SNESLineSearch,PetscInt order); 571 572 PETSC_EXTERN PetscErrorCode SNESLineSearchGetSuccess(SNESLineSearch, PetscBool*); 573 PETSC_EXTERN PetscErrorCode SNESLineSearchSetSuccess(SNESLineSearch, PetscBool); 574 575 PETSC_EXTERN PetscErrorCode SNESLineSearchGetVecs(SNESLineSearch,Vec*,Vec*,Vec*,Vec*,Vec*); 576 PETSC_EXTERN PetscErrorCode SNESLineSearchSetVecs(SNESLineSearch,Vec,Vec,Vec,Vec,Vec); 577 578 PETSC_EXTERN PetscErrorCode SNESLineSearchGetNorms(SNESLineSearch, PetscReal *, PetscReal *, PetscReal *); 579 PETSC_EXTERN PetscErrorCode SNESLineSearchSetNorms(SNESLineSearch, PetscReal, PetscReal, PetscReal); 580 PETSC_EXTERN PetscErrorCode SNESLineSearchComputeNorms(SNESLineSearch); 581 PETSC_EXTERN PetscErrorCode SNESLineSearchSetComputeNorms(SNESLineSearch, PetscBool); 582 583 PETSC_EXTERN PetscErrorCode SNESLineSearchSetMonitor(SNESLineSearch, PetscBool); 584 PETSC_EXTERN PetscErrorCode SNESLineSearchGetMonitor(SNESLineSearch, PetscViewer*); 585 586 PETSC_EXTERN PetscErrorCode SNESLineSearchAppendOptionsPrefix(SNESLineSearch, const char prefix[]); 587 PETSC_EXTERN PetscErrorCode SNESLineSearchGetOptionsPrefix(SNESLineSearch, const char *prefix[]); 588 589 590 /* Shell interface functions */ 591 PETSC_EXTERN PetscErrorCode SNESLineSearchShellSetUserFunc(SNESLineSearch,SNESLineSearchUserFunc,void*); 592 PETSC_EXTERN PetscErrorCode SNESLineSearchShellGetUserFunc(SNESLineSearch,SNESLineSearchUserFunc*,void**); 593 594 /* BT interface functions */ 595 PETSC_EXTERN PetscErrorCode SNESLineSearchBTSetAlpha(SNESLineSearch, PetscReal); 596 PETSC_EXTERN PetscErrorCode SNESLineSearchBTGetAlpha(SNESLineSearch, PetscReal*); 597 598 /*register line search types */ 599 PETSC_EXTERN PetscErrorCode SNESLineSearchRegister(const char[],const char[],const char[],PetscErrorCode(*)(SNESLineSearch)); 600 PETSC_EXTERN PetscErrorCode SNESLineSearchRegisterAll(const char path[]); 601 PETSC_EXTERN PetscErrorCode SNESLineSearchRegisterDestroy(void); 602 603 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 604 #define SNESLineSearchRegisterDynamic(a,b,c,d) SNESLineSearchRegister(a,b,c,0) 605 #else 606 #define SNESLineSearchRegisterDynamic(a,b,c,d) SNESLineSearchRegister(a,b,c,d) 607 #endif 608 609 /* Routines for VI solver */ 610 PETSC_EXTERN PetscErrorCode SNESVISetVariableBounds(SNES,Vec,Vec); 611 PETSC_EXTERN PetscErrorCode SNESVISetComputeVariableBounds(SNES, PetscErrorCode (*)(SNES,Vec,Vec)); 612 PETSC_EXTERN PetscErrorCode SNESVIGetInactiveSet(SNES,IS*); 613 PETSC_EXTERN PetscErrorCode SNESVIGetActiveSetIS(SNES,Vec,Vec,IS*); 614 PETSC_EXTERN PetscErrorCode SNESVIComputeInactiveSetFnorm(SNES,Vec,Vec,PetscReal*); 615 PETSC_EXTERN PetscErrorCode SNESVISetRedundancyCheck(SNES,PetscErrorCode(*)(SNES,IS,IS*,void*),void*); 616 #define SNES_VI_INF 1.0e20 617 #define SNES_VI_NINF -1.0e20 618 619 PETSC_EXTERN PetscErrorCode SNESTestLocalMin(SNES); 620 621 /* Should this routine be private? */ 622 PETSC_EXTERN PetscErrorCode SNESComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*); 623 624 PETSC_EXTERN PetscErrorCode SNESSetDM(SNES,DM); 625 PETSC_EXTERN PetscErrorCode SNESGetDM(SNES,DM*); 626 PETSC_EXTERN PetscErrorCode SNESSetPC(SNES,SNES); 627 PETSC_EXTERN PetscErrorCode SNESGetPC(SNES,SNES*); 628 PETSC_EXTERN PetscErrorCode SNESSetPCSide(SNES,PCSide); 629 PETSC_EXTERN PetscErrorCode SNESGetPCSide(SNES,PCSide*); 630 PETSC_EXTERN PetscErrorCode SNESSetSNESLineSearch(SNES,SNESLineSearch); 631 PETSC_EXTERN PetscErrorCode SNESGetSNESLineSearch(SNES,SNESLineSearch*); 632 PETSC_EXTERN PetscErrorCode SNESRestrictHookAdd(SNES,PetscErrorCode (*)(SNES,SNES,void*),void*); 633 PETSC_EXTERN PetscErrorCode SNESRestrictHooksRun(SNES,SNES); 634 635 PETSC_EXTERN PetscErrorCode SNESSetUpMatrices(SNES); 636 PETSC_EXTERN PetscErrorCode DMSNESSetFunction(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),void*); 637 PETSC_EXTERN PetscErrorCode DMSNESGetFunction(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),void**); 638 PETSC_EXTERN PetscErrorCode DMSNESSetGS(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),void*); 639 PETSC_EXTERN PetscErrorCode DMSNESGetGS(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),void**); 640 PETSC_EXTERN PetscErrorCode DMSNESSetJacobian(DM,PetscErrorCode(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void*); 641 PETSC_EXTERN PetscErrorCode DMSNESGetJacobian(DM,PetscErrorCode(**)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void**); 642 PETSC_EXTERN PetscErrorCode DMSNESSetPicard(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),PetscErrorCode(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void*); 643 PETSC_EXTERN PetscErrorCode DMSNESGetPicard(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),PetscErrorCode(**)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void**); 644 645 PETSC_EXTERN PetscErrorCode DMSNESSetBlockFunction(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),void*); 646 PETSC_EXTERN PetscErrorCode DMSNESGetBlockFunction(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),void**); 647 PETSC_EXTERN PetscErrorCode DMSNESSetBlockJacobian(DM,PetscErrorCode(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void*); 648 PETSC_EXTERN PetscErrorCode DMSNESGetBlockJacobian(DM,PetscErrorCode(**)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void**); 649 650 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESFunction)(DMDALocalInfo*,void*,void*,void*); 651 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESJacobian)(DMDALocalInfo*,void*,Mat,Mat,MatStructure*,void*); 652 653 PETSC_EXTERN PetscErrorCode DMDASNESSetFunctionLocal(DM,InsertMode,DMDASNESFunction,void*); 654 PETSC_EXTERN PetscErrorCode DMDASNESSetJacobianLocal(DM,DMDASNESJacobian,void*); 655 656 PETSC_EXTERN PetscErrorCode SNESComputeLocalBlockFunction_DMDA(SNES,Vec,Vec,void *); 657 PETSC_EXTERN PetscErrorCode SNESComputeLocalBlockJacobian_DMDA(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 658 659 /* Routines for Multiblock solver */ 660 PETSC_EXTERN PetscErrorCode SNESMultiblockSetFields(SNES, const char [], PetscInt, const PetscInt *); 661 PETSC_EXTERN PetscErrorCode SNESMultiblockSetIS(SNES, const char [], IS); 662 PETSC_EXTERN PetscErrorCode SNESMultiblockSetBlockSize(SNES, PetscInt); 663 PETSC_EXTERN PetscErrorCode SNESMultiblockSetType(SNES, PCCompositeType); 664 665 /*J 666 SNESMSType - String with the name of a PETSc SNESMS method. 667 668 Level: intermediate 669 670 .seealso: SNESMSSetType(), SNES 671 J*/ 672 typedef const char* SNESMSType; 673 #define SNESMSM62 "m62" 674 #define SNESMSEULER "euler" 675 #define SNESMSJAMESON83 "jameson83" 676 #define SNESMSVLTP21 "vltp21" 677 #define SNESMSVLTP31 "vltp31" 678 #define SNESMSVLTP41 "vltp41" 679 #define SNESMSVLTP51 "vltp51" 680 #define SNESMSVLTP61 "vltp61" 681 682 PETSC_EXTERN PetscErrorCode SNESMSRegister(SNESMSType,PetscInt,PetscInt,PetscReal,const PetscReal[],const PetscReal[],const PetscReal[]); 683 PETSC_EXTERN PetscErrorCode SNESMSSetType(SNES,SNESMSType); 684 PETSC_EXTERN PetscErrorCode SNESMSFinalizePackage(void); 685 PETSC_EXTERN PetscErrorCode SNESMSInitializePackage(const char path[]); 686 PETSC_EXTERN PetscErrorCode SNESMSRegisterDestroy(void); 687 PETSC_EXTERN PetscErrorCode SNESMSRegisterAll(void); 688 689 /* routines for NGMRES solver */ 690 691 typedef enum { 692 SNES_NGMRES_RESTART_NONE = 0, 693 SNES_NGMRES_RESTART_PERIODIC = 1, 694 SNES_NGMRES_RESTART_DIFFERENCE = 2} SNESNGMRESRestartType; 695 PETSC_EXTERN const char *const SNESNGMRESRestartTypes[]; 696 697 typedef enum { 698 SNES_NGMRES_SELECT_NONE = 0, 699 SNES_NGMRES_SELECT_DIFFERENCE = 1, 700 SNES_NGMRES_SELECT_LINESEARCH = 2} SNESNGMRESSelectType; 701 PETSC_EXTERN const char *const SNESNGMRESSelectTypes[]; 702 703 PETSC_EXTERN PetscErrorCode SNESNGMRESSetRestartType(SNES, SNESNGMRESRestartType); 704 PETSC_EXTERN PetscErrorCode SNESNGMRESSetSelectType(SNES, SNESNGMRESSelectType); 705 706 /* routines for NCG solver */ 707 708 typedef enum { 709 SNES_NCG_FR = 0, 710 SNES_NCG_PRP = 1, 711 SNES_NCG_HS = 2, 712 SNES_NCG_DY = 3, 713 SNES_NCG_CD = 4} SNESNCGType; 714 PETSC_EXTERN const char *const SNESNCGTypes[]; 715 716 PETSC_EXTERN PetscErrorCode SNESNCGSetType(SNES, SNESNCGType); 717 718 typedef enum {SNES_QN_SCALE_NONE = 0, 719 SNES_QN_SCALE_SHANNO = 1, 720 SNES_QN_SCALE_LINESEARCH = 2, 721 SNES_QN_SCALE_JACOBIAN = 3} SNESQNScaleType; 722 PETSC_EXTERN const char *const SNESQNScaleTypes[]; 723 typedef enum {SNES_QN_RESTART_NONE = 0, 724 SNES_QN_RESTART_POWELL = 1, 725 SNES_QN_RESTART_PERIODIC = 2} SNESQNRestartType; 726 PETSC_EXTERN const char *const SNESQNRestartTypes[]; 727 728 PETSC_EXTERN PetscErrorCode SNESQNSetScaleType(SNES, SNESQNScaleType); 729 PETSC_EXTERN PetscErrorCode SNESQNSetRestartType(SNES, SNESQNRestartType); 730 731 732 #endif 733