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