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