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 71 PETSC_EXTERN PetscErrorCode SNESAddOptionsChecker(PetscErrorCode (*)(SNES)); 72 73 PETSC_EXTERN PetscErrorCode SNESSetUpdate(SNES, PetscErrorCode (*)(SNES, PetscInt)); 74 75 PETSC_EXTERN PetscErrorCode SNESRegisterDestroy(void); 76 PETSC_EXTERN PetscErrorCode SNESRegisterAll(const char[]); 77 78 PETSC_EXTERN PetscErrorCode SNESRegister(const char[],const char[],const char[],PetscErrorCode (*)(SNES)); 79 80 /*MC 81 SNESRegisterDynamic - Adds a method to the nonlinear solver package. 82 83 Synopsis: 84 #include "petscsnes.h" 85 PetscErrorCode SNESRegisterDynamic(const char *name_solver,const char *path,const char *name_create,PetscErrorCode (*routine_create)(SNES)) 86 87 Not collective 88 89 Input Parameters: 90 + name_solver - name of a new user-defined solver 91 . path - path (either absolute or relative) the library containing this solver 92 . name_create - name of routine to create method context 93 - routine_create - routine to create method context 94 95 Notes: 96 SNESRegisterDynamic() may be called multiple times to add several user-defined solvers. 97 98 If dynamic libraries are used, then the fourth input argument (routine_create) 99 is ignored. 100 101 Environmental variables such as ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR}, 102 and others of the form ${any_environmental_variable} occuring in pathname will be 103 replaced with appropriate values. 104 105 Sample usage: 106 .vb 107 SNESRegisterDynamic("my_solver",/home/username/my_lib/lib/libg/solaris/mylib.a, 108 "MySolverCreate",MySolverCreate); 109 .ve 110 111 Then, your solver can be chosen with the procedural interface via 112 $ SNESSetType(snes,"my_solver") 113 or at runtime via the option 114 $ -snes_type my_solver 115 116 Level: advanced 117 118 Note: If your function is not being put into a shared library then use SNESRegister() instead 119 120 .keywords: SNES, nonlinear, register 121 122 .seealso: SNESRegisterAll(), SNESRegisterDestroy() 123 M*/ 124 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 125 #define SNESRegisterDynamic(a,b,c,d) SNESRegister(a,b,c,0) 126 #else 127 #define SNESRegisterDynamic(a,b,c,d) SNESRegister(a,b,c,d) 128 #endif 129 130 PETSC_EXTERN PetscErrorCode SNESGetKSP(SNES,KSP*); 131 PETSC_EXTERN PetscErrorCode SNESSetKSP(SNES,KSP); 132 PETSC_EXTERN PetscErrorCode SNESGetSolution(SNES,Vec*); 133 PETSC_EXTERN PetscErrorCode SNESGetSolutionUpdate(SNES,Vec*); 134 PETSC_EXTERN PetscErrorCode SNESGetRhs(SNES,Vec*); 135 PETSC_EXTERN PetscErrorCode SNESView(SNES,PetscViewer); 136 PETSC_EXTERN PetscErrorCode SNESLoad(SNES,PetscViewer); 137 138 #define SNES_FILE_CLASSID 1211224 139 140 PETSC_EXTERN PetscErrorCode SNESSetOptionsPrefix(SNES,const char[]); 141 PETSC_EXTERN PetscErrorCode SNESAppendOptionsPrefix(SNES,const char[]); 142 PETSC_EXTERN PetscErrorCode SNESGetOptionsPrefix(SNES,const char*[]); 143 PETSC_EXTERN PetscErrorCode SNESSetFromOptions(SNES); 144 145 PETSC_EXTERN PetscErrorCode MatCreateSNESMF(SNES,Mat*); 146 PETSC_EXTERN PetscErrorCode MatMFFDComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 147 148 PETSC_EXTERN PetscErrorCode MatDAADSetSNES(Mat,SNES); 149 150 PETSC_EXTERN PetscErrorCode SNESGetType(SNES,SNESType*); 151 PETSC_EXTERN PetscErrorCode SNESMonitorDefault(SNES,PetscInt,PetscReal,void *); 152 PETSC_EXTERN PetscErrorCode SNESMonitorRange(SNES,PetscInt,PetscReal,void *); 153 PETSC_EXTERN PetscErrorCode SNESMonitorRatio(SNES,PetscInt,PetscReal,void *); 154 PETSC_EXTERN PetscErrorCode SNESMonitorSetRatio(SNES,PetscViewer); 155 PETSC_EXTERN PetscErrorCode SNESMonitorSolution(SNES,PetscInt,PetscReal,void *); 156 PETSC_EXTERN PetscErrorCode SNESMonitorResidual(SNES,PetscInt,PetscReal,void *); 157 PETSC_EXTERN PetscErrorCode SNESMonitorSolutionUpdate(SNES,PetscInt,PetscReal,void *); 158 PETSC_EXTERN PetscErrorCode SNESMonitorDefaultShort(SNES,PetscInt,PetscReal,void *); 159 PETSC_EXTERN PetscErrorCode SNESMonitorJacUpdateSpectrum(SNES,PetscInt,PetscReal,void *); 160 PETSC_EXTERN PetscErrorCode SNESSetTolerances(SNES,PetscReal,PetscReal,PetscReal,PetscInt,PetscInt); 161 PETSC_EXTERN PetscErrorCode SNESGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,PetscInt*,PetscInt*); 162 PETSC_EXTERN PetscErrorCode SNESSetTrustRegionTolerance(SNES,PetscReal); 163 PETSC_EXTERN PetscErrorCode SNESGetFunctionNorm(SNES,PetscReal*); 164 PETSC_EXTERN PetscErrorCode SNESSetFunctionNorm(SNES,PetscReal); 165 PETSC_EXTERN PetscErrorCode SNESGetIterationNumber(SNES,PetscInt*); 166 PETSC_EXTERN PetscErrorCode SNESSetIterationNumber(SNES,PetscInt); 167 168 PETSC_EXTERN PetscErrorCode SNESGetNonlinearStepFailures(SNES,PetscInt*); 169 PETSC_EXTERN PetscErrorCode SNESSetMaxNonlinearStepFailures(SNES,PetscInt); 170 PETSC_EXTERN PetscErrorCode SNESGetMaxNonlinearStepFailures(SNES,PetscInt*); 171 PETSC_EXTERN PetscErrorCode SNESGetNumberFunctionEvals(SNES,PetscInt*); 172 173 PETSC_EXTERN PetscErrorCode SNESSetLagPreconditioner(SNES,PetscInt); 174 PETSC_EXTERN PetscErrorCode SNESGetLagPreconditioner(SNES,PetscInt*); 175 PETSC_EXTERN PetscErrorCode SNESSetLagJacobian(SNES,PetscInt); 176 PETSC_EXTERN PetscErrorCode SNESGetLagJacobian(SNES,PetscInt*); 177 PETSC_EXTERN PetscErrorCode SNESSetGridSequence(SNES,PetscInt); 178 179 PETSC_EXTERN PetscErrorCode SNESGetLinearSolveIterations(SNES,PetscInt*); 180 PETSC_EXTERN PetscErrorCode SNESGetLinearSolveFailures(SNES,PetscInt*); 181 PETSC_EXTERN PetscErrorCode SNESSetMaxLinearSolveFailures(SNES,PetscInt); 182 PETSC_EXTERN PetscErrorCode SNESGetMaxLinearSolveFailures(SNES,PetscInt*); 183 184 PETSC_EXTERN PetscErrorCode SNESKSPSetUseEW(SNES,PetscBool ); 185 PETSC_EXTERN PetscErrorCode SNESKSPGetUseEW(SNES,PetscBool *); 186 PETSC_EXTERN PetscErrorCode SNESKSPSetParametersEW(SNES,PetscInt,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal); 187 PETSC_EXTERN PetscErrorCode SNESKSPGetParametersEW(SNES,PetscInt*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*); 188 189 #include <petscdrawtypes.h> 190 PETSC_EXTERN PetscErrorCode SNESMonitorLGCreate(const char[],const char[],int,int,int,int,PetscDrawLG*); 191 PETSC_EXTERN PetscErrorCode SNESMonitorLGResidualNorm(SNES,PetscInt,PetscReal,void*); 192 PETSC_EXTERN PetscErrorCode SNESMonitorLGDestroy(PetscDrawLG*); 193 PETSC_EXTERN PetscErrorCode SNESMonitorLGRange(SNES,PetscInt,PetscReal,void*); 194 195 PETSC_EXTERN PetscErrorCode SNESSetApplicationContext(SNES,void *); 196 PETSC_EXTERN PetscErrorCode SNESGetApplicationContext(SNES,void *); 197 PETSC_EXTERN PetscErrorCode SNESSetComputeApplicationContext(SNES,PetscErrorCode (*)(SNES,void**),PetscErrorCode (*)(void**)); 198 199 PETSC_EXTERN PetscErrorCode SNESPythonSetType(SNES,const char[]); 200 201 PETSC_EXTERN PetscErrorCode SNESSetFunctionDomainError(SNES); 202 PETSC_EXTERN PetscErrorCode SNESGetFunctionDomainError(SNES, PetscBool *); 203 204 /*E 205 SNESConvergedReason - reason a SNES method was said to 206 have converged or diverged 207 208 Level: beginner 209 210 The two most common reasons for divergence are 211 $ 1) an incorrectly coded or computed Jacobian or 212 $ 2) failure or lack of convergence in the linear system (in this case we recommend 213 $ testing with -pc_type lu to eliminate the linear solver as the cause of the problem). 214 215 Diverged Reasons: 216 . SNES_DIVERGED_LOCAL_MIN - this can only occur when using the line-search variant of SNES. 217 The line search wants to minimize Q(alpha) = 1/2 || F(x + alpha s) ||^2_2 this occurs 218 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 219 you get Q'(alpha) = -F(x)^T F'(x)^(-1)^T F'(x+alpha s)F(x+alpha s); when alpha = 0 220 Q'(0) = - ||F(x)||^2_2 which is always NEGATIVE if F'(x) is invertible. This means the Newton 221 direction is a descent direction and the line search should succeed if alpha is small enough. 222 223 If F'(x) is NOT invertible AND F'(x)^T F(x) = 0 then Q'(0) = 0 and the Newton direction 224 is NOT a descent direction so the line search will fail. All one can do at this point 225 is change the initial guess and try again. 226 227 An alternative explanation: Newton's method can be regarded as replacing the function with 228 its linear approximation and minimizing the 2-norm of that. That is F(x+s) approx F(x) + F'(x)s 229 so we minimize || F(x) + F'(x) s ||^2_2; do this using Least Squares. If F'(x) is invertible then 230 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 231 exists a nontrival (that is F'(x)s != 0) solution to the equation and this direction is 232 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) 233 = - (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 234 and F'(x)^T F'(x) has no negative eigenvalues Q'(0) < 0 so s is a descent direction and the line 235 search should succeed for small enough alpha. 236 237 Note that this RARELY happens in practice. Far more likely the linear system is not being solved 238 (well enough?) or the Jacobian is wrong. 239 240 SNES_DIVERGED_MAX_IT means that the solver reached the maximum number of iterations without satisfying any 241 convergence criteria. SNES_CONVERGED_ITS means that SNESSkipConverged() was chosen as the convergence test; 242 thus the usual convergence criteria have not been checked and may or may not be satisfied. 243 244 Developer Notes: this must match finclude/petscsnes.h 245 246 The string versions of these are in SNESConvergedReason, if you change any value here you must 247 also adjust that array. 248 249 Each reason has its own manual page. 250 251 .seealso: SNESSolve(), SNESGetConvergedReason(), KSPConvergedReason, SNESSetConvergenceTest() 252 E*/ 253 typedef enum {/* converged */ 254 SNES_CONVERGED_FNORM_ABS = 2, /* ||F|| < atol */ 255 SNES_CONVERGED_FNORM_RELATIVE = 3, /* ||F|| < rtol*||F_initial|| */ 256 SNES_CONVERGED_SNORM_RELATIVE = 4, /* Newton computed step size small; || delta x || < stol || x ||*/ 257 SNES_CONVERGED_ITS = 5, /* maximum iterations reached */ 258 SNES_CONVERGED_TR_DELTA = 7, 259 /* diverged */ 260 SNES_DIVERGED_FUNCTION_DOMAIN = -1, /* the new x location passed the function is not in the domain of F */ 261 SNES_DIVERGED_FUNCTION_COUNT = -2, 262 SNES_DIVERGED_LINEAR_SOLVE = -3, /* the linear solve failed */ 263 SNES_DIVERGED_FNORM_NAN = -4, 264 SNES_DIVERGED_MAX_IT = -5, 265 SNES_DIVERGED_LINE_SEARCH = -6, /* the line search failed */ 266 SNES_DIVERGED_INNER = -7, /* inner solve failed */ 267 SNES_DIVERGED_LOCAL_MIN = -8, /* || J^T b || is small, implies converged to local minimum of F() */ 268 SNES_CONVERGED_ITERATING = 0} SNESConvergedReason; 269 PETSC_EXTERN const char *const*SNESConvergedReasons; 270 271 /*MC 272 SNES_CONVERGED_FNORM_ABS - 2-norm(F) <= abstol 273 274 Level: beginner 275 276 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 277 278 M*/ 279 280 /*MC 281 SNES_CONVERGED_FNORM_RELATIVE - 2-norm(F) <= rtol*2-norm(F(x_0)) where x_0 is the initial guess 282 283 Level: beginner 284 285 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 286 287 M*/ 288 289 /*MC 290 SNES_CONVERGED_SNORM_RELATIVE - The 2-norm of the last step <= stol * 2-norm(x) where x is the current 291 solution and stol is the 4th argument to SNESSetTolerances() 292 293 Options Database Keys: 294 -snes_stol <stol> - the step tolerance 295 296 Level: beginner 297 298 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 299 300 M*/ 301 302 /*MC 303 SNES_DIVERGED_FUNCTION_COUNT - The user provided function has been called more times then the final 304 argument to SNESSetTolerances() 305 306 Level: beginner 307 308 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 309 310 M*/ 311 312 /*MC 313 SNES_DIVERGED_FNORM_NAN - the 2-norm of the current function evaluation is not-a-number (NaN), this 314 is usually caused by a division of 0 by 0. 315 316 Level: beginner 317 318 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 319 320 M*/ 321 322 /*MC 323 SNES_DIVERGED_MAX_IT - SNESSolve() has reached the maximum number of iterations requested 324 325 Level: beginner 326 327 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 328 329 M*/ 330 331 /*MC 332 SNES_DIVERGED_LINE_SEARCH - The line search has failed. This only occurs for a SNES solvers that use a line search 333 334 Level: beginner 335 336 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances(), SNESLineSearch 337 338 M*/ 339 340 /*MC 341 SNES_DIVERGED_LOCAL_MIN - the algorithm seems to have stagnated at a local minimum that is not zero. 342 See the manual page for SNESConvergedReason for more details 343 344 Level: beginner 345 346 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 347 348 M*/ 349 350 /*MC 351 SNES_CONERGED_ITERATING - this only occurs if SNESGetConvergedReason() is called during the SNESSolve() 352 353 Level: beginner 354 355 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 356 357 M*/ 358 359 PETSC_EXTERN PetscErrorCode SNESSetConvergenceTest(SNES,PetscErrorCode (*)(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void*,PetscErrorCode (*)(void*)); 360 PETSC_EXTERN PetscErrorCode SNESConvergedDefault(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*); 361 PETSC_EXTERN PetscErrorCode SNESSkipConverged(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*); 362 PETSC_EXTERN PetscErrorCode SNESGetConvergedReason(SNES,SNESConvergedReason*); 363 364 PETSC_EXTERN PetscErrorCode SNESDMMeshComputeFunction(SNES,Vec,Vec,void*); 365 PETSC_EXTERN PetscErrorCode SNESDMMeshComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 366 367 /* --------- Solving systems of nonlinear equations --------------- */ 368 PETSC_EXTERN PetscErrorCode SNESSetFunction(SNES,Vec,PetscErrorCode (*SNESFunction)(SNES,Vec,Vec,void*),void*); 369 PETSC_EXTERN PetscErrorCode SNESGetFunction(SNES,Vec*,PetscErrorCode (**SNESFunction)(SNES,Vec,Vec,void*),void**); 370 PETSC_EXTERN PetscErrorCode SNESComputeFunction(SNES,Vec,Vec); 371 PETSC_EXTERN PetscErrorCode SNESSetJacobian(SNES,Mat,Mat,PetscErrorCode (*SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void*); 372 PETSC_EXTERN PetscErrorCode SNESGetJacobian(SNES,Mat*,Mat*,PetscErrorCode (**SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void**); 373 PETSC_EXTERN PetscErrorCode SNESObjectiveComputeFunctionDefaultFD(SNES,Vec,Vec,void*); 374 PETSC_EXTERN PetscErrorCode SNESComputeJacobianDefault(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 375 PETSC_EXTERN PetscErrorCode SNESComputeJacobianDefaultColor(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 376 PETSC_EXTERN PetscErrorCode SNESSetComputeInitialGuess(SNES,PetscErrorCode (*)(SNES,Vec,void*),void*); 377 PETSC_EXTERN PetscErrorCode SNESSetPicard(SNES,Vec,PetscErrorCode (*SNESFunction)(SNES,Vec,Vec,void*),Mat,Mat,PetscErrorCode (*SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void*); 378 PETSC_EXTERN PetscErrorCode SNESGetPicard(SNES,Vec*,PetscErrorCode (**SNESFunction)(SNES,Vec,Vec,void*),Mat*,Mat*,PetscErrorCode (**SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void**); 379 PETSC_EXTERN PetscErrorCode SNESSetInitialFunction(SNES,Vec); 380 PETSC_EXTERN PetscErrorCode SNESSetInitialFunctionNorm(SNES,PetscReal); 381 382 PETSC_EXTERN PetscErrorCode SNESSetObjective(SNES,PetscErrorCode (*SNESObjectiveFunction)(SNES,Vec,PetscReal *,void*),void*); 383 PETSC_EXTERN PetscErrorCode SNESGetObjective(SNES,PetscErrorCode (**SNESObjectiveFunction)(SNES,Vec,PetscReal *,void*),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,PetscErrorCode (*SNESGSFunction)(SNES,Vec,Vec,void*),void*); 476 PETSC_EXTERN PetscErrorCode SNESGetGS(SNES,PetscErrorCode (**SNESGSFunction)(SNES,Vec,Vec,void*),void**); 477 PETSC_EXTERN PetscErrorCode SNESSetUseGS(SNES,PetscBool); 478 PETSC_EXTERN PetscErrorCode SNESGetUseGS(SNES,PetscBool *); 479 PETSC_EXTERN PetscErrorCode SNESComputeGS(SNES,Vec,Vec); 480 481 PETSC_EXTERN PetscErrorCode SNESGSSetSweeps(SNES,PetscInt); 482 PETSC_EXTERN PetscErrorCode SNESGSGetSweeps(SNES,PetscInt *); 483 PETSC_EXTERN PetscErrorCode SNESGSSetTolerances(SNES,PetscReal,PetscReal,PetscReal,PetscInt); 484 PETSC_EXTERN PetscErrorCode SNESGSGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,PetscInt*); 485 486 PETSC_EXTERN PetscErrorCode SNESUpdateCheckJacobian(SNES,PetscInt); 487 488 PETSC_EXTERN PetscErrorCode SNESShellGetContext(SNES,void**); 489 PETSC_EXTERN PetscErrorCode SNESShellSetContext(SNES,void*); 490 PETSC_EXTERN PetscErrorCode SNESShellSetSolve(SNES,PetscErrorCode (*)(SNES,Vec)); 491 492 /* --------- Routines specifically for line search methods --------------- */ 493 494 typedef struct _p_LineSearch* SNESLineSearch; 495 496 /*S 497 SNESLineSearch - Abstract PETSc object that manages line-search operations 498 499 Level: beginner 500 501 Concepts: nonlinear solvers, line search 502 503 .seealso: SNESLineSearchCreate(), SNESLineSearchSetType(), SNES 504 S*/ 505 506 /*J 507 SNESLineSearchType - String with the name of a PETSc line search method 508 509 Level: beginner 510 511 .seealso: SNESLineSearchSetType(), SNES 512 J*/ 513 514 typedef const char* SNESLineSearchType; 515 #define SNESLINESEARCHBT "bt" 516 #define SNESLINESEARCHBASIC "basic" 517 #define SNESLINESEARCHL2 "l2" 518 #define SNESLINESEARCHCP "cp" 519 #define SNESLINESEARCHSHELL "shell" 520 521 PETSC_EXTERN PetscBool SNESRegisterAllCalled; 522 PETSC_EXTERN PetscFunctionList SNESList; 523 PETSC_EXTERN PetscClassId SNESLINESEARCH_CLASSID; 524 PETSC_EXTERN PetscBool SNESLineSearchRegisterAllCalled; 525 PETSC_EXTERN PetscFunctionList SNESLineSearchList; 526 PETSC_EXTERN PetscLogEvent SNESLineSearch_Apply; 527 528 #define SNES_LINESEARCH_ORDER_LINEAR 1 529 #define SNES_LINESEARCH_ORDER_QUADRATIC 2 530 #define SNES_LINESEARCH_ORDER_CUBIC 3 531 532 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchVIProjectFunc)(SNES,Vec); 533 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchVINormFunc)(SNES,Vec,Vec,PetscReal *); 534 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchApplyFunc)(SNESLineSearch); 535 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchUserFunc)(SNESLineSearch, void *); 536 537 PETSC_EXTERN PetscErrorCode SNESLineSearchCreate(MPI_Comm, SNESLineSearch*); 538 PETSC_EXTERN PetscErrorCode SNESLineSearchReset(SNESLineSearch); 539 PETSC_EXTERN PetscErrorCode SNESLineSearchView(SNESLineSearch,PetscViewer); 540 PETSC_EXTERN PetscErrorCode SNESLineSearchDestroy(SNESLineSearch *); 541 PETSC_EXTERN PetscErrorCode SNESLineSearchSetType(SNESLineSearch, SNESLineSearchType); 542 PETSC_EXTERN PetscErrorCode SNESLineSearchSetFromOptions(SNESLineSearch); 543 PETSC_EXTERN PetscErrorCode SNESLineSearchSetUp(SNESLineSearch); 544 PETSC_EXTERN PetscErrorCode SNESLineSearchApply(SNESLineSearch, Vec, Vec, PetscReal *, Vec); 545 PETSC_EXTERN PetscErrorCode SNESLineSearchPreCheck(SNESLineSearch,Vec,Vec,PetscBool *); 546 PETSC_EXTERN PetscErrorCode SNESLineSearchPostCheck(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *); 547 548 /* set the functions for precheck and postcheck */ 549 550 PETSC_EXTERN PetscErrorCode SNESLineSearchSetPreCheck(SNESLineSearch, PetscErrorCode (*SNESLineSearchPreCheckFunction)(SNESLineSearch,Vec,Vec,PetscBool*,void*), void *ctx); 551 PETSC_EXTERN PetscErrorCode SNESLineSearchSetPostCheck(SNESLineSearch, PetscErrorCode (*SNESLineSearchPostCheckFunction)(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *,void*), void *ctx); 552 553 PETSC_EXTERN PetscErrorCode SNESLineSearchGetPreCheck(SNESLineSearch, PetscErrorCode (**SNESLineSearchPreCheckFunction)(SNESLineSearch,Vec,Vec,PetscBool*,void*), void **ctx); 554 PETSC_EXTERN PetscErrorCode SNESLineSearchGetPostCheck(SNESLineSearch, PetscErrorCode (**SNESLineSearchPostCheckFunction)(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *,void*), void **ctx); 555 556 /* set the functions for VI-specific line search operations */ 557 558 PETSC_EXTERN PetscErrorCode SNESLineSearchSetVIFunctions(SNESLineSearch, SNESLineSearchVIProjectFunc, SNESLineSearchVINormFunc); 559 PETSC_EXTERN PetscErrorCode SNESLineSearchGetVIFunctions(SNESLineSearch, SNESLineSearchVIProjectFunc*, SNESLineSearchVINormFunc*); 560 561 /* pointers to the associated SNES in order to be able to get the function evaluation out */ 562 PETSC_EXTERN PetscErrorCode SNESLineSearchSetSNES(SNESLineSearch,SNES); 563 PETSC_EXTERN PetscErrorCode SNESLineSearchGetSNES(SNESLineSearch,SNES*); 564 565 /* set and get the parameters and vectors */ 566 PETSC_EXTERN PetscErrorCode SNESLineSearchGetTolerances(SNESLineSearch,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscInt*); 567 PETSC_EXTERN PetscErrorCode SNESLineSearchSetTolerances(SNESLineSearch,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscInt); 568 569 PETSC_EXTERN PetscErrorCode SNESLineSearchPreCheckPicard(SNESLineSearch,Vec,Vec,PetscBool*,void*); 570 571 PETSC_EXTERN PetscErrorCode SNESLineSearchGetLambda(SNESLineSearch,PetscReal*); 572 PETSC_EXTERN PetscErrorCode SNESLineSearchSetLambda(SNESLineSearch,PetscReal); 573 574 PETSC_EXTERN PetscErrorCode SNESLineSearchGetDamping(SNESLineSearch,PetscReal*); 575 PETSC_EXTERN PetscErrorCode SNESLineSearchSetDamping(SNESLineSearch,PetscReal); 576 577 PETSC_EXTERN PetscErrorCode SNESLineSearchGetOrder(SNESLineSearch,PetscInt *order); 578 PETSC_EXTERN PetscErrorCode SNESLineSearchSetOrder(SNESLineSearch,PetscInt order); 579 580 PETSC_EXTERN PetscErrorCode SNESLineSearchGetSuccess(SNESLineSearch, PetscBool*); 581 PETSC_EXTERN PetscErrorCode SNESLineSearchSetSuccess(SNESLineSearch, PetscBool); 582 583 PETSC_EXTERN PetscErrorCode SNESLineSearchGetVecs(SNESLineSearch,Vec*,Vec*,Vec*,Vec*,Vec*); 584 PETSC_EXTERN PetscErrorCode SNESLineSearchSetVecs(SNESLineSearch,Vec,Vec,Vec,Vec,Vec); 585 586 PETSC_EXTERN PetscErrorCode SNESLineSearchGetNorms(SNESLineSearch, PetscReal *, PetscReal *, PetscReal *); 587 PETSC_EXTERN PetscErrorCode SNESLineSearchSetNorms(SNESLineSearch, PetscReal, PetscReal, PetscReal); 588 PETSC_EXTERN PetscErrorCode SNESLineSearchComputeNorms(SNESLineSearch); 589 PETSC_EXTERN PetscErrorCode SNESLineSearchSetComputeNorms(SNESLineSearch, PetscBool); 590 591 PETSC_EXTERN PetscErrorCode SNESLineSearchSetMonitor(SNESLineSearch, PetscBool); 592 PETSC_EXTERN PetscErrorCode SNESLineSearchGetMonitor(SNESLineSearch, PetscViewer*); 593 594 PETSC_EXTERN PetscErrorCode SNESLineSearchAppendOptionsPrefix(SNESLineSearch, const char prefix[]); 595 PETSC_EXTERN PetscErrorCode SNESLineSearchGetOptionsPrefix(SNESLineSearch, const char *prefix[]); 596 597 598 /* Shell interface functions */ 599 PETSC_EXTERN PetscErrorCode SNESLineSearchShellSetUserFunc(SNESLineSearch,SNESLineSearchUserFunc,void*); 600 PETSC_EXTERN PetscErrorCode SNESLineSearchShellGetUserFunc(SNESLineSearch,SNESLineSearchUserFunc*,void**); 601 602 /* BT interface functions */ 603 PETSC_EXTERN PetscErrorCode SNESLineSearchBTSetAlpha(SNESLineSearch, PetscReal); 604 PETSC_EXTERN PetscErrorCode SNESLineSearchBTGetAlpha(SNESLineSearch, PetscReal*); 605 606 /*register line search types */ 607 PETSC_EXTERN PetscErrorCode SNESLineSearchRegister(const char[],const char[],const char[],PetscErrorCode(*)(SNESLineSearch)); 608 PETSC_EXTERN PetscErrorCode SNESLineSearchRegisterAll(const char path[]); 609 PETSC_EXTERN PetscErrorCode SNESLineSearchRegisterDestroy(void); 610 611 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 612 #define SNESLineSearchRegisterDynamic(a,b,c,d) SNESLineSearchRegister(a,b,c,0) 613 #else 614 #define SNESLineSearchRegisterDynamic(a,b,c,d) SNESLineSearchRegister(a,b,c,d) 615 #endif 616 617 /* Routines for VI solver */ 618 PETSC_EXTERN PetscErrorCode SNESVISetVariableBounds(SNES,Vec,Vec); 619 PETSC_EXTERN PetscErrorCode SNESVISetComputeVariableBounds(SNES, PetscErrorCode (*)(SNES,Vec,Vec)); 620 PETSC_EXTERN PetscErrorCode SNESVIGetInactiveSet(SNES,IS*); 621 PETSC_EXTERN PetscErrorCode SNESVIGetActiveSetIS(SNES,Vec,Vec,IS*); 622 PETSC_EXTERN PetscErrorCode SNESVIComputeInactiveSetFnorm(SNES,Vec,Vec,PetscReal*); 623 PETSC_EXTERN PetscErrorCode SNESVISetRedundancyCheck(SNES,PetscErrorCode(*)(SNES,IS,IS*,void*),void*); 624 #define SNES_VI_INF 1.0e20 625 #define SNES_VI_NINF -1.0e20 626 627 PETSC_EXTERN PetscErrorCode SNESTestLocalMin(SNES); 628 629 /* Should this routine be private? */ 630 PETSC_EXTERN PetscErrorCode SNESComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*); 631 632 PETSC_EXTERN PetscErrorCode SNESSetDM(SNES,DM); 633 PETSC_EXTERN PetscErrorCode SNESGetDM(SNES,DM*); 634 PETSC_EXTERN PetscErrorCode SNESSetPC(SNES,SNES); 635 PETSC_EXTERN PetscErrorCode SNESGetPC(SNES,SNES*); 636 PETSC_EXTERN PetscErrorCode SNESSetPCSide(SNES,PCSide); 637 PETSC_EXTERN PetscErrorCode SNESGetPCSide(SNES,PCSide*); 638 PETSC_EXTERN PetscErrorCode SNESSetSNESLineSearch(SNES,SNESLineSearch); 639 PETSC_EXTERN PetscErrorCode SNESGetSNESLineSearch(SNES,SNESLineSearch*); 640 PETSC_EXTERN PetscErrorCode SNESRestrictHookAdd(SNES,PetscErrorCode (*)(SNES,SNES,void*),void*); 641 PETSC_EXTERN PetscErrorCode SNESRestrictHooksRun(SNES,SNES); 642 643 PETSC_EXTERN PetscErrorCode SNESSetUpMatrices(SNES); 644 PETSC_EXTERN PetscErrorCode DMSNESSetFunction(DM,PetscErrorCode(*SNESFunction)(SNES,Vec,Vec,void*),void*); 645 PETSC_EXTERN PetscErrorCode DMSNESGetFunction(DM,PetscErrorCode(**SNESSetFunction)(SNES,Vec,Vec,void*),void**); 646 PETSC_EXTERN PetscErrorCode DMSNESSetGS(DM,PetscErrorCode(*SNESGSFunction)(SNES,Vec,Vec,void*),void*); 647 PETSC_EXTERN PetscErrorCode DMSNESGetGS(DM,PetscErrorCode(**SNESGSFunction)(SNES,Vec,Vec,void*),void**); 648 PETSC_EXTERN PetscErrorCode DMSNESSetJacobian(DM,PetscErrorCode(*SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void*); 649 PETSC_EXTERN PetscErrorCode DMSNESGetJacobian(DM,PetscErrorCode(**SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void**); 650 PETSC_EXTERN PetscErrorCode DMSNESSetPicard(DM,PetscErrorCode(*SNESFunction)(SNES,Vec,Vec,void*),PetscErrorCode(*SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void*); 651 PETSC_EXTERN PetscErrorCode DMSNESGetPicard(DM,PetscErrorCode(**SNESFunction)(SNES,Vec,Vec,void*),PetscErrorCode(**SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void**); 652 PETSC_EXTERN PetscErrorCode DMSNESSetObjective(DM,PetscErrorCode (*SNESObjectiveFunction)(SNES,Vec,PetscReal *,void*),void*); 653 PETSC_EXTERN PetscErrorCode DMSNESGetObjective(DM,PetscErrorCode (**SNESObjectiveFunction)(SNES,Vec,PetscReal *,void*),void**); 654 655 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESFunction)(DMDALocalInfo*,void*,void*,void*); 656 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESJacobian)(DMDALocalInfo*,void*,Mat,Mat,MatStructure*,void*); 657 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESObjective)(DMDALocalInfo*,void*,PetscReal*,void*); 658 659 PETSC_EXTERN PetscErrorCode DMDASNESSetFunctionLocal(DM,InsertMode,DMDASNESFunction,void*); 660 PETSC_EXTERN PetscErrorCode DMDASNESSetJacobianLocal(DM,DMDASNESJacobian,void*); 661 PETSC_EXTERN PetscErrorCode DMDASNESSetObjectiveLocal(DM,DMDASNESObjective,void*); 662 PETSC_EXTERN PetscErrorCode DMDASNESSetPicardLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,void*,void*,void*),PetscErrorCode (*)(DMDALocalInfo*,void*,Mat,Mat,MatStructure*,void*),void*); 663 664 PETSC_EXTERN PetscErrorCode DMSNESSetFunctionLocal(DM,PetscErrorCode (*)(DM,Vec,Vec,void*),void*); 665 PETSC_EXTERN PetscErrorCode DMSNESSetJacobianLocal(DM,PetscErrorCode (*)(DM,Vec,Mat,Mat,MatStructure*,void*),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 PETSC_EXTERN PetscErrorCode SNESNASMGetSubdomains(SNES,PetscInt*,SNES**,VecScatter**,VecScatter**,VecScatter**); 740 PETSC_EXTERN PetscErrorCode SNESNASMSetSubdomains(SNES,PetscInt,SNES*,VecScatter*,VecScatter*,VecScatter*); 741 PETSC_EXTERN PetscErrorCode SNESNASMGetSubdomainVecs(SNES,PetscInt*,Vec**,Vec**,Vec**,Vec**); 742 PETSC_EXTERN PetscErrorCode SNESNASMSetComputeFinalJacobian(SNES,PetscBool); 743 744 #endif 745