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