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