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