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 <petscfvtypes.h> 9 #include <petscdmdatypes.h> 10 11 /*S 12 SNES - Abstract PETSc object that manages all nonlinear solves 13 14 Level: beginner 15 16 Concepts: nonlinear solvers 17 18 .seealso: SNESCreate(), SNESSetType(), SNESType, TS, KSP, KSP, PC, SNESDestroy() 19 S*/ 20 typedef struct _p_SNES* SNES; 21 22 /*J 23 SNESType - String with the name of a PETSc SNES method. 24 25 Level: beginner 26 27 .seealso: SNESSetType(), SNES, SNESCreate(), SNESDestroy(), SNESSetFromOptions() 28 J*/ 29 typedef const char* SNESType; 30 #define SNESNEWTONLS "newtonls" 31 #define SNESNEWTONTR "newtontr" 32 #define SNESPYTHON "python" 33 #define SNESTEST "test" 34 #define SNESNRICHARDSON "nrichardson" 35 #define SNESKSPONLY "ksponly" 36 #define SNESVINEWTONRSLS "vinewtonrsls" 37 #define SNESVINEWTONSSLS "vinewtonssls" 38 #define SNESNGMRES "ngmres" 39 #define SNESQN "qn" 40 #define SNESSHELL "shell" 41 #define SNESNGS "ngs" 42 #define SNESNCG "ncg" 43 #define SNESFAS "fas" 44 #define SNESMS "ms" 45 #define SNESNASM "nasm" 46 #define SNESANDERSON "anderson" 47 #define SNESASPIN "aspin" 48 #define SNESCOMPOSITE "composite" 49 50 /* Logging support */ 51 PETSC_EXTERN PetscClassId SNES_CLASSID; 52 PETSC_EXTERN PetscClassId DMSNES_CLASSID; 53 54 PETSC_EXTERN PetscErrorCode SNESInitializePackage(void); 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 SNESMonitorSAWs(SNES,PetscInt,PetscReal,void*); 64 PETSC_EXTERN PetscErrorCode SNESMonitorSAWsCreate(SNES,void**); 65 PETSC_EXTERN PetscErrorCode SNESMonitorSAWsDestroy(void**); 66 PETSC_EXTERN PetscErrorCode SNESSetConvergenceHistory(SNES,PetscReal[],PetscInt[],PetscInt,PetscBool ); 67 PETSC_EXTERN PetscErrorCode SNESGetConvergenceHistory(SNES,PetscReal*[],PetscInt *[],PetscInt *); 68 PETSC_EXTERN PetscErrorCode SNESSetUp(SNES); 69 PETSC_EXTERN PetscErrorCode SNESSolve(SNES,Vec,Vec); 70 PETSC_EXTERN PetscErrorCode SNESSetErrorIfNotConverged(SNES,PetscBool ); 71 PETSC_EXTERN PetscErrorCode SNESGetErrorIfNotConverged(SNES,PetscBool *); 72 73 PETSC_EXTERN PetscErrorCode SNESSetWorkVecs(SNES,PetscInt); 74 75 PETSC_EXTERN PetscErrorCode SNESAddOptionsChecker(PetscErrorCode (*)(SNES)); 76 77 PETSC_EXTERN PetscErrorCode SNESSetUpdate(SNES, PetscErrorCode (*)(SNES, PetscInt)); 78 79 PETSC_EXTERN PetscErrorCode SNESRegisterAll(void); 80 81 PETSC_EXTERN PetscErrorCode SNESRegister(const char[],PetscErrorCode (*)(SNES)); 82 83 PETSC_EXTERN PetscErrorCode SNESGetKSP(SNES,KSP*); 84 PETSC_EXTERN PetscErrorCode SNESSetKSP(SNES,KSP); 85 PETSC_EXTERN PetscErrorCode SNESGetSolution(SNES,Vec*); 86 PETSC_EXTERN PetscErrorCode SNESGetSolutionUpdate(SNES,Vec*); 87 PETSC_EXTERN PetscErrorCode SNESGetRhs(SNES,Vec*); 88 PETSC_EXTERN PetscErrorCode SNESView(SNES,PetscViewer); 89 PETSC_EXTERN PetscErrorCode SNESLoad(SNES,PetscViewer); 90 PETSC_STATIC_INLINE PetscErrorCode SNESViewFromOptions(SNES A,const char prefix[],const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,prefix,name);} 91 92 #define SNES_FILE_CLASSID 1211224 93 94 PETSC_EXTERN PetscErrorCode SNESSetOptionsPrefix(SNES,const char[]); 95 PETSC_EXTERN PetscErrorCode SNESAppendOptionsPrefix(SNES,const char[]); 96 PETSC_EXTERN PetscErrorCode SNESGetOptionsPrefix(SNES,const char*[]); 97 PETSC_EXTERN PetscErrorCode SNESSetFromOptions(SNES); 98 99 PETSC_EXTERN PetscErrorCode MatCreateSNESMF(SNES,Mat*); 100 PETSC_EXTERN PetscErrorCode MatMFFDComputeJacobian(SNES,Vec,Mat,Mat,void*); 101 102 PETSC_EXTERN PetscErrorCode MatDAADSetSNES(Mat,SNES); 103 104 PETSC_EXTERN PetscErrorCode SNESGetType(SNES,SNESType*); 105 PETSC_EXTERN PetscErrorCode SNESMonitorDefault(SNES,PetscInt,PetscReal,void *); 106 PETSC_EXTERN PetscErrorCode SNESMonitorRange(SNES,PetscInt,PetscReal,void *); 107 PETSC_EXTERN PetscErrorCode SNESMonitorRatio(SNES,PetscInt,PetscReal,void *); 108 PETSC_EXTERN PetscErrorCode SNESMonitorSetRatio(SNES,PetscViewer); 109 PETSC_EXTERN PetscErrorCode SNESMonitorSolution(SNES,PetscInt,PetscReal,void *); 110 PETSC_EXTERN PetscErrorCode SNESMonitorResidual(SNES,PetscInt,PetscReal,void *); 111 PETSC_EXTERN PetscErrorCode SNESMonitorSolutionUpdate(SNES,PetscInt,PetscReal,void *); 112 PETSC_EXTERN PetscErrorCode SNESMonitorDefaultShort(SNES,PetscInt,PetscReal,void *); 113 PETSC_EXTERN PetscErrorCode SNESMonitorJacUpdateSpectrum(SNES,PetscInt,PetscReal,void *); 114 PETSC_EXTERN PetscErrorCode SNESMonitorFields(SNES,PetscInt,PetscReal,void *); 115 PETSC_EXTERN PetscErrorCode KSPMonitorSNES(KSP,PetscInt,PetscReal,void*); 116 PETSC_EXTERN PetscErrorCode KSPMonitorSNESLGResidualNormCreate(const char[],const char[],int,int,int,int,PetscObject**); 117 PETSC_EXTERN PetscErrorCode KSPMonitorSNESLGResidualNorm(KSP,PetscInt,PetscReal,PetscObject*); 118 PETSC_EXTERN PetscErrorCode KSPMonitorSNESLGResidualNormDestroy(PetscObject**); 119 120 PETSC_EXTERN PetscErrorCode SNESSetTolerances(SNES,PetscReal,PetscReal,PetscReal,PetscInt,PetscInt); 121 PETSC_EXTERN PetscErrorCode SNESGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,PetscInt*,PetscInt*); 122 PETSC_EXTERN PetscErrorCode SNESSetTrustRegionTolerance(SNES,PetscReal); 123 PETSC_EXTERN PetscErrorCode SNESGetIterationNumber(SNES,PetscInt*); 124 PETSC_EXTERN PetscErrorCode SNESSetIterationNumber(SNES,PetscInt); 125 126 PETSC_EXTERN PetscErrorCode SNESGetNonlinearStepFailures(SNES,PetscInt*); 127 PETSC_EXTERN PetscErrorCode SNESSetMaxNonlinearStepFailures(SNES,PetscInt); 128 PETSC_EXTERN PetscErrorCode SNESGetMaxNonlinearStepFailures(SNES,PetscInt*); 129 PETSC_EXTERN PetscErrorCode SNESGetNumberFunctionEvals(SNES,PetscInt*); 130 131 PETSC_EXTERN PetscErrorCode SNESSetLagPreconditioner(SNES,PetscInt); 132 PETSC_EXTERN PetscErrorCode SNESGetLagPreconditioner(SNES,PetscInt*); 133 PETSC_EXTERN PetscErrorCode SNESSetLagJacobian(SNES,PetscInt); 134 PETSC_EXTERN PetscErrorCode SNESGetLagJacobian(SNES,PetscInt*); 135 PETSC_EXTERN PetscErrorCode SNESSetLagPreconditionerPersists(SNES,PetscBool); 136 PETSC_EXTERN PetscErrorCode SNESSetLagJacobianPersists(SNES,PetscBool); 137 PETSC_EXTERN PetscErrorCode SNESSetGridSequence(SNES,PetscInt); 138 139 PETSC_EXTERN PetscErrorCode SNESGetLinearSolveIterations(SNES,PetscInt*); 140 PETSC_EXTERN PetscErrorCode SNESGetLinearSolveFailures(SNES,PetscInt*); 141 PETSC_EXTERN PetscErrorCode SNESSetMaxLinearSolveFailures(SNES,PetscInt); 142 PETSC_EXTERN PetscErrorCode SNESGetMaxLinearSolveFailures(SNES,PetscInt*); 143 PETSC_EXTERN PetscErrorCode SNESSetCountersReset(SNES,PetscBool); 144 145 PETSC_EXTERN PetscErrorCode SNESKSPSetUseEW(SNES,PetscBool ); 146 PETSC_EXTERN PetscErrorCode SNESKSPGetUseEW(SNES,PetscBool *); 147 PETSC_EXTERN PetscErrorCode SNESKSPSetParametersEW(SNES,PetscInt,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal); 148 PETSC_EXTERN PetscErrorCode SNESKSPGetParametersEW(SNES,PetscInt*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*); 149 150 #include <petscdrawtypes.h> 151 PETSC_EXTERN PetscErrorCode SNESMonitorLGCreate(const char[],const char[],int,int,int,int,PetscDrawLG*); 152 PETSC_EXTERN PetscErrorCode SNESMonitorLGResidualNorm(SNES,PetscInt,PetscReal,void*); 153 PETSC_EXTERN PetscErrorCode SNESMonitorLGDestroy(PetscDrawLG*); 154 PETSC_EXTERN PetscErrorCode SNESMonitorLGRange(SNES,PetscInt,PetscReal,void*); 155 156 PETSC_EXTERN PetscErrorCode SNESSetApplicationContext(SNES,void *); 157 PETSC_EXTERN PetscErrorCode SNESGetApplicationContext(SNES,void *); 158 PETSC_EXTERN PetscErrorCode SNESSetComputeApplicationContext(SNES,PetscErrorCode (*)(SNES,void**),PetscErrorCode (*)(void**)); 159 160 PETSC_EXTERN PetscErrorCode SNESPythonSetType(SNES,const char[]); 161 162 PETSC_EXTERN PetscErrorCode SNESSetFunctionDomainError(SNES); 163 PETSC_EXTERN PetscErrorCode SNESGetFunctionDomainError(SNES, PetscBool *); 164 165 /*E 166 SNESConvergedReason - reason a SNES method was said to 167 have converged or diverged 168 169 Level: beginner 170 171 The two most common reasons for divergence are 172 $ 1) an incorrectly coded or computed Jacobian or 173 $ 2) failure or lack of convergence in the linear system (in this case we recommend 174 $ testing with -pc_type lu to eliminate the linear solver as the cause of the problem). 175 176 Diverged Reasons: 177 . SNES_DIVERGED_LOCAL_MIN - this can only occur when using the line-search variant of SNES. 178 The line search wants to minimize Q(alpha) = 1/2 || F(x + alpha s) ||^2_2 this occurs 179 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 180 you get Q'(alpha) = -F(x)^T F'(x)^(-1)^T F'(x+alpha s)F(x+alpha s); when alpha = 0 181 Q'(0) = - ||F(x)||^2_2 which is always NEGATIVE if F'(x) is invertible. This means the Newton 182 direction is a descent direction and the line search should succeed if alpha is small enough. 183 184 If F'(x) is NOT invertible AND F'(x)^T F(x) = 0 then Q'(0) = 0 and the Newton direction 185 is NOT a descent direction so the line search will fail. All one can do at this point 186 is change the initial guess and try again. 187 188 An alternative explanation: Newton's method can be regarded as replacing the function with 189 its linear approximation and minimizing the 2-norm of that. That is F(x+s) approx F(x) + F'(x)s 190 so we minimize || F(x) + F'(x) s ||^2_2; do this using Least Squares. If F'(x) is invertible then 191 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 192 exists a nontrival (that is F'(x)s != 0) solution to the equation and this direction is 193 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) 194 = - (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 195 and F'(x)^T F'(x) has no negative eigenvalues Q'(0) < 0 so s is a descent direction and the line 196 search should succeed for small enough alpha. 197 198 Note that this RARELY happens in practice. Far more likely the linear system is not being solved 199 (well enough?) or the Jacobian is wrong. 200 201 SNES_DIVERGED_MAX_IT means that the solver reached the maximum number of iterations without satisfying any 202 convergence criteria. SNES_CONVERGED_ITS means that SNESConvergedSkip() was chosen as the convergence test; 203 thus the usual convergence criteria have not been checked and may or may not be satisfied. 204 205 Developer Notes: this must match finclude/petscsnes.h 206 207 The string versions of these are in SNESConvergedReason, if you change any value here you must 208 also adjust that array. 209 210 Each reason has its own manual page. 211 212 .seealso: SNESSolve(), SNESGetConvergedReason(), KSPConvergedReason, SNESSetConvergenceTest() 213 E*/ 214 typedef enum {/* converged */ 215 SNES_CONVERGED_FNORM_ABS = 2, /* ||F|| < atol */ 216 SNES_CONVERGED_FNORM_RELATIVE = 3, /* ||F|| < rtol*||F_initial|| */ 217 SNES_CONVERGED_SNORM_RELATIVE = 4, /* Newton computed step size small; || delta x || < stol || x ||*/ 218 SNES_CONVERGED_ITS = 5, /* maximum iterations reached */ 219 SNES_CONVERGED_TR_DELTA = 7, 220 /* diverged */ 221 SNES_DIVERGED_FUNCTION_DOMAIN = -1, /* the new x location passed the function is not in the domain of F */ 222 SNES_DIVERGED_FUNCTION_COUNT = -2, 223 SNES_DIVERGED_LINEAR_SOLVE = -3, /* the linear solve failed */ 224 SNES_DIVERGED_FNORM_NAN = -4, 225 SNES_DIVERGED_MAX_IT = -5, 226 SNES_DIVERGED_LINE_SEARCH = -6, /* the line search failed */ 227 SNES_DIVERGED_INNER = -7, /* inner solve failed */ 228 SNES_DIVERGED_LOCAL_MIN = -8, /* || J^T b || is small, implies converged to local minimum of F() */ 229 SNES_CONVERGED_ITERATING = 0} SNESConvergedReason; 230 PETSC_EXTERN const char *const*SNESConvergedReasons; 231 232 /*MC 233 SNES_CONVERGED_FNORM_ABS - 2-norm(F) <= abstol 234 235 Level: beginner 236 237 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 238 239 M*/ 240 241 /*MC 242 SNES_CONVERGED_FNORM_RELATIVE - 2-norm(F) <= rtol*2-norm(F(x_0)) where x_0 is the initial guess 243 244 Level: beginner 245 246 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 247 248 M*/ 249 250 /*MC 251 SNES_CONVERGED_SNORM_RELATIVE - The 2-norm of the last step <= stol * 2-norm(x) where x is the current 252 solution and stol is the 4th argument to SNESSetTolerances() 253 254 Options Database Keys: 255 -snes_stol <stol> - the step tolerance 256 257 Level: beginner 258 259 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 260 261 M*/ 262 263 /*MC 264 SNES_DIVERGED_FUNCTION_COUNT - The user provided function has been called more times then the final 265 argument to SNESSetTolerances() 266 267 Level: beginner 268 269 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 270 271 M*/ 272 273 /*MC 274 SNES_DIVERGED_FNORM_NAN - the 2-norm of the current function evaluation is not-a-number (NaN), this 275 is usually caused by a division of 0 by 0. 276 277 Level: beginner 278 279 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 280 281 M*/ 282 283 /*MC 284 SNES_DIVERGED_MAX_IT - SNESSolve() has reached the maximum number of iterations requested 285 286 Level: beginner 287 288 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 289 290 M*/ 291 292 /*MC 293 SNES_DIVERGED_LINE_SEARCH - The line search has failed. This only occurs for a SNES solvers that use a line search 294 295 Level: beginner 296 297 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances(), SNESLineSearch 298 299 M*/ 300 301 /*MC 302 SNES_DIVERGED_LOCAL_MIN - the algorithm seems to have stagnated at a local minimum that is not zero. 303 See the manual page for SNESConvergedReason for more details 304 305 Level: beginner 306 307 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 308 309 M*/ 310 311 /*MC 312 SNES_CONERGED_ITERATING - this only occurs if SNESGetConvergedReason() is called during the SNESSolve() 313 314 Level: beginner 315 316 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 317 318 M*/ 319 320 PETSC_EXTERN PetscErrorCode SNESSetConvergenceTest(SNES,PetscErrorCode (*)(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void*,PetscErrorCode (*)(void*)); 321 PETSC_EXTERN PetscErrorCode SNESConvergedDefault(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*); 322 PETSC_EXTERN PetscErrorCode SNESConvergedSkip(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*); 323 PETSC_EXTERN PetscErrorCode SNESGetConvergedReason(SNES,SNESConvergedReason*); 324 325 PETSC_DEPRECATED("Use SNESConvergedSkip()") PETSC_STATIC_INLINE void SNESSkipConverged(void) { /* never called */ } 326 #define SNESSkipConverged (SNESSkipConverged, SNESConvergedSkip) 327 328 /* --------- Solving systems of nonlinear equations --------------- */ 329 PETSC_EXTERN PetscErrorCode SNESSetFunction(SNES,Vec,PetscErrorCode (*)(SNES,Vec,Vec,void*),void*); 330 PETSC_EXTERN PetscErrorCode SNESGetFunction(SNES,Vec*,PetscErrorCode (**)(SNES,Vec,Vec,void*),void**); 331 PETSC_EXTERN PetscErrorCode SNESComputeFunction(SNES,Vec,Vec); 332 333 PETSC_EXTERN PetscErrorCode SNESSetJacobian(SNES,Mat,Mat,PetscErrorCode (*)(SNES,Vec,Mat,Mat,void*),void*); 334 PETSC_EXTERN PetscErrorCode SNESGetJacobian(SNES,Mat*,Mat*,PetscErrorCode (**)(SNES,Vec,Mat,Mat,void*),void**); 335 PETSC_EXTERN PetscErrorCode SNESObjectiveComputeFunctionDefaultFD(SNES,Vec,Vec,void*); 336 PETSC_EXTERN PetscErrorCode SNESComputeJacobianDefault(SNES,Vec,Mat,Mat,void*); 337 PETSC_EXTERN PetscErrorCode SNESComputeJacobianDefaultColor(SNES,Vec,Mat,Mat,void*); 338 PETSC_EXTERN PetscErrorCode SNESSetComputeInitialGuess(SNES,PetscErrorCode (*)(SNES,Vec,void*),void*); 339 PETSC_EXTERN PetscErrorCode SNESSetPicard(SNES,Vec,PetscErrorCode (*)(SNES,Vec,Vec,void*),Mat,Mat,PetscErrorCode (*)(SNES,Vec,Mat,Mat,void*),void*); 340 PETSC_EXTERN PetscErrorCode SNESGetPicard(SNES,Vec*,PetscErrorCode (**)(SNES,Vec,Vec,void*),Mat*,Mat*,PetscErrorCode (**)(SNES,Vec,Mat,Mat,void*),void**); 341 PETSC_EXTERN PetscErrorCode SNESSetInitialFunction(SNES,Vec); 342 343 PETSC_EXTERN PetscErrorCode SNESSetObjective(SNES,PetscErrorCode (*)(SNES,Vec,PetscReal *,void*),void*); 344 PETSC_EXTERN PetscErrorCode SNESGetObjective(SNES,PetscErrorCode (**)(SNES,Vec,PetscReal *,void*),void**); 345 PETSC_EXTERN PetscErrorCode SNESComputeObjective(SNES,Vec,PetscReal *); 346 347 /*E 348 SNESNormSchedule - Frequency with which the norm is computed 349 350 Level: advanced 351 352 Support for these is highly dependent on the solver. 353 354 Notes: 355 This is primarily used to turn off extra norm and function computation 356 when the solvers are composed. 357 358 .seealso: SNESSolve(), SNESGetConvergedReason(), KSPSetNormType(), 359 KSPSetConvergenceTest(), KSPSetPCSide() 360 E*/ 361 362 typedef enum {SNES_NORM_DEFAULT = -1, 363 SNES_NORM_NONE = 0, 364 SNES_NORM_ALWAYS = 1, 365 SNES_NORM_INITIAL_ONLY = 2, 366 SNES_NORM_FINAL_ONLY = 3, 367 SNES_NORM_INITIAL_FINAL_ONLY = 4} SNESNormSchedule; 368 PETSC_EXTERN const char *const*const SNESNormSchedules; 369 370 /*MC 371 SNES_NORM_NONE - Don't compute function and its L2 norm. 372 373 Level: advanced 374 375 Notes: 376 This is most useful for stationary solvers with a fixed number of iterations used as smoothers. 377 378 .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_DEFAULT 379 M*/ 380 381 /*MC 382 SNES_NORM_ALWAYS - Compute the function and its L2 norm at each iteration. 383 384 Level: advanced 385 386 Notes: 387 Most solvers will use this no matter what norm type is passed to them. 388 389 .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_NONE 390 M*/ 391 392 /*MC 393 SNES_NORM_INITIAL_ONLY - Compute the function and its L2 at iteration 0, but do not update it. 394 395 Level: advanced 396 397 Notes: 398 This method is useful in composed methods, when a true solution might actually be found before SNESSolve() is called. 399 This option enables the solve to abort on the zeroth iteration if this is the case. 400 401 For solvers that require the computation of the L2 norm of the function as part of the method, this merely cancels 402 the norm computation at the last iteration (if possible). 403 404 .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_FINAL_ONLY, SNES_NORM_INITIAL_FINAL_ONLY 405 M*/ 406 407 /*MC 408 SNES_NORM_FINAL_ONLY - Compute the function and its L2 norm on only the final iteration. 409 410 Level: advanced 411 412 Notes: 413 For solvers that require the computation of the L2 norm of the function as part of the method, behaves 414 exactly as SNES_NORM_DEFAULT. This method is useful when the function is gotten after SNESSolve and 415 used in subsequent computation for methods that do not need the norm computed during the rest of the 416 solution procedure. 417 418 .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_INITIAL_ONLY, SNES_NORM_INITIAL_FINAL_ONLY 419 M*/ 420 421 /*MC 422 SNES_NORM_INITIAL_FINAL_ONLY - Compute the function and its L2 norm on only the initial and final iterations. 423 424 Level: advanced 425 426 Notes: 427 This method combines the benefits of SNES_NORM_INITIAL_ONLY and SNES_NORM_FINAL_ONLY. 428 429 .seealso: SNESNormSchedule, SNESSetNormSchedule(), SNES_NORM_SNES_NORM_INITIAL_ONLY, SNES_NORM_FINAL_ONLY 430 M*/ 431 432 PETSC_EXTERN PetscErrorCode SNESSetNormSchedule(SNES,SNESNormSchedule); 433 PETSC_EXTERN PetscErrorCode SNESGetNormSchedule(SNES,SNESNormSchedule*); 434 435 /*E 436 SNESFunctionType - Type of function computed 437 438 Level: advanced 439 440 Support for these is highly dependent on the solver. 441 442 .seealso: SNESSolve(), SNESGetConvergedReason(), KSPSetNormType(), 443 KSPSetConvergenceTest(), KSPSetPCSide() 444 E*/ 445 typedef enum {SNES_FUNCTION_DEFAULT = -1, 446 SNES_FUNCTION_UNPRECONDITIONED = 0, 447 SNES_FUNCTION_PRECONDITIONED = 1} SNESFunctionType; 448 PETSC_EXTERN const char *const*const SNESFunctionTypes; 449 450 PETSC_EXTERN PetscErrorCode SNESSetFunctionType(SNES,SNESFunctionType); 451 PETSC_EXTERN PetscErrorCode SNESGetFunctionType(SNES,SNESFunctionType*); 452 453 PETSC_EXTERN PetscErrorCode SNESSetNGS(SNES,PetscErrorCode (*)(SNES,Vec,Vec,void*),void*); 454 PETSC_EXTERN PetscErrorCode SNESGetNGS(SNES,PetscErrorCode (**)(SNES,Vec,Vec,void*),void**); 455 PETSC_EXTERN PetscErrorCode SNESSetUseNGS(SNES,PetscBool); 456 PETSC_EXTERN PetscErrorCode SNESGetUseNGS(SNES,PetscBool *); 457 PETSC_EXTERN PetscErrorCode SNESComputeNGS(SNES,Vec,Vec); 458 459 PETSC_EXTERN PetscErrorCode SNESNGSSetSweeps(SNES,PetscInt); 460 PETSC_EXTERN PetscErrorCode SNESNGSGetSweeps(SNES,PetscInt *); 461 PETSC_EXTERN PetscErrorCode SNESNGSSetTolerances(SNES,PetscReal,PetscReal,PetscReal,PetscInt); 462 PETSC_EXTERN PetscErrorCode SNESNGSGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,PetscInt*); 463 464 PETSC_EXTERN PetscErrorCode SNESUpdateCheckJacobian(SNES,PetscInt); 465 466 PETSC_EXTERN PetscErrorCode SNESShellGetContext(SNES,void**); 467 PETSC_EXTERN PetscErrorCode SNESShellSetContext(SNES,void*); 468 PETSC_EXTERN PetscErrorCode SNESShellSetSolve(SNES,PetscErrorCode (*)(SNES,Vec)); 469 470 /* --------- Routines specifically for line search methods --------------- */ 471 472 typedef struct _p_LineSearch* SNESLineSearch; 473 474 /*S 475 SNESLineSearch - Abstract PETSc object that manages line-search operations 476 477 Level: beginner 478 479 Concepts: nonlinear solvers, line search 480 481 .seealso: SNESLineSearchCreate(), SNESLineSearchSetType(), SNES 482 S*/ 483 484 /*J 485 SNESLineSearchType - String with the name of a PETSc line search method 486 487 Level: beginner 488 489 .seealso: SNESLineSearchSetType(), SNES 490 J*/ 491 492 typedef const char* SNESLineSearchType; 493 #define SNESLINESEARCHBT "bt" 494 #define SNESLINESEARCHBASIC "basic" 495 #define SNESLINESEARCHL2 "l2" 496 #define SNESLINESEARCHCP "cp" 497 #define SNESLINESEARCHSHELL "shell" 498 499 PETSC_EXTERN PetscBool SNESRegisterAllCalled; 500 PETSC_EXTERN PetscFunctionList SNESList; 501 PETSC_EXTERN PetscClassId SNESLINESEARCH_CLASSID; 502 PETSC_EXTERN PetscBool SNESLineSearchRegisterAllCalled; 503 PETSC_EXTERN PetscFunctionList SNESLineSearchList; 504 PETSC_EXTERN PetscLogEvent SNESLineSearch_Apply; 505 506 #define SNES_LINESEARCH_ORDER_LINEAR 1 507 #define SNES_LINESEARCH_ORDER_QUADRATIC 2 508 #define SNES_LINESEARCH_ORDER_CUBIC 3 509 510 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchVIProjectFunc)(SNES,Vec); 511 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchVINormFunc)(SNES,Vec,Vec,PetscReal *); 512 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchApplyFunc)(SNESLineSearch); 513 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESLineSearchUserFunc)(SNESLineSearch, void *); 514 515 PETSC_EXTERN PetscErrorCode SNESLineSearchCreate(MPI_Comm, SNESLineSearch*); 516 PETSC_EXTERN PetscErrorCode SNESLineSearchReset(SNESLineSearch); 517 PETSC_EXTERN PetscErrorCode SNESLineSearchView(SNESLineSearch,PetscViewer); 518 PETSC_EXTERN PetscErrorCode SNESLineSearchDestroy(SNESLineSearch *); 519 PETSC_EXTERN PetscErrorCode SNESLineSearchSetType(SNESLineSearch, SNESLineSearchType); 520 PETSC_EXTERN PetscErrorCode SNESLineSearchSetFromOptions(SNESLineSearch); 521 PETSC_EXTERN PetscErrorCode SNESLineSearchSetFunction(SNESLineSearch,PetscErrorCode (*)(SNES,Vec,Vec)); 522 PETSC_EXTERN PetscErrorCode SNESLineSearchSetUp(SNESLineSearch); 523 PETSC_EXTERN PetscErrorCode SNESLineSearchApply(SNESLineSearch, Vec, Vec, PetscReal *, Vec); 524 PETSC_EXTERN PetscErrorCode SNESLineSearchPreCheck(SNESLineSearch,Vec,Vec,PetscBool *); 525 PETSC_EXTERN PetscErrorCode SNESLineSearchPostCheck(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *); 526 PETSC_EXTERN PetscErrorCode SNESLineSearchSetWorkVecs(SNESLineSearch, PetscInt); 527 528 /* set the functions for precheck and postcheck */ 529 530 PETSC_EXTERN PetscErrorCode SNESLineSearchSetPreCheck(SNESLineSearch, PetscErrorCode (*)(SNESLineSearch,Vec,Vec,PetscBool*,void*), void *ctx); 531 PETSC_EXTERN PetscErrorCode SNESLineSearchSetPostCheck(SNESLineSearch, PetscErrorCode (*)(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *,void*), void *ctx); 532 533 PETSC_EXTERN PetscErrorCode SNESLineSearchGetPreCheck(SNESLineSearch, PetscErrorCode (**)(SNESLineSearch,Vec,Vec,PetscBool*,void*), void **ctx); 534 PETSC_EXTERN PetscErrorCode SNESLineSearchGetPostCheck(SNESLineSearch, PetscErrorCode (**)(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *,void*), void **ctx); 535 536 /* set the functions for VI-specific line search operations */ 537 538 PETSC_EXTERN PetscErrorCode SNESLineSearchSetVIFunctions(SNESLineSearch, SNESLineSearchVIProjectFunc, SNESLineSearchVINormFunc); 539 PETSC_EXTERN PetscErrorCode SNESLineSearchGetVIFunctions(SNESLineSearch, SNESLineSearchVIProjectFunc*, SNESLineSearchVINormFunc*); 540 541 /* pointers to the associated SNES in order to be able to get the function evaluation out */ 542 PETSC_EXTERN PetscErrorCode SNESLineSearchSetSNES(SNESLineSearch,SNES); 543 PETSC_EXTERN PetscErrorCode SNESLineSearchGetSNES(SNESLineSearch,SNES*); 544 545 /* set and get the parameters and vectors */ 546 PETSC_EXTERN PetscErrorCode SNESLineSearchGetTolerances(SNESLineSearch,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscInt*); 547 PETSC_EXTERN PetscErrorCode SNESLineSearchSetTolerances(SNESLineSearch,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscInt); 548 549 PETSC_EXTERN PetscErrorCode SNESLineSearchPreCheckPicard(SNESLineSearch,Vec,Vec,PetscBool*,void*); 550 551 PETSC_EXTERN PetscErrorCode SNESLineSearchGetLambda(SNESLineSearch,PetscReal*); 552 PETSC_EXTERN PetscErrorCode SNESLineSearchSetLambda(SNESLineSearch,PetscReal); 553 554 PETSC_EXTERN PetscErrorCode SNESLineSearchGetDamping(SNESLineSearch,PetscReal*); 555 PETSC_EXTERN PetscErrorCode SNESLineSearchSetDamping(SNESLineSearch,PetscReal); 556 557 PETSC_EXTERN PetscErrorCode SNESLineSearchGetOrder(SNESLineSearch,PetscInt *order); 558 PETSC_EXTERN PetscErrorCode SNESLineSearchSetOrder(SNESLineSearch,PetscInt order); 559 560 PETSC_EXTERN PetscErrorCode SNESLineSearchGetSuccess(SNESLineSearch, PetscBool*); 561 PETSC_EXTERN PetscErrorCode SNESLineSearchSetSuccess(SNESLineSearch, PetscBool); 562 563 PETSC_EXTERN PetscErrorCode SNESLineSearchGetVecs(SNESLineSearch,Vec*,Vec*,Vec*,Vec*,Vec*); 564 PETSC_EXTERN PetscErrorCode SNESLineSearchSetVecs(SNESLineSearch,Vec,Vec,Vec,Vec,Vec); 565 566 PETSC_EXTERN PetscErrorCode SNESLineSearchGetNorms(SNESLineSearch, PetscReal *, PetscReal *, PetscReal *); 567 PETSC_EXTERN PetscErrorCode SNESLineSearchSetNorms(SNESLineSearch, PetscReal, PetscReal, PetscReal); 568 PETSC_EXTERN PetscErrorCode SNESLineSearchComputeNorms(SNESLineSearch); 569 PETSC_EXTERN PetscErrorCode SNESLineSearchSetComputeNorms(SNESLineSearch, PetscBool); 570 571 PETSC_EXTERN PetscErrorCode SNESLineSearchSetMonitor(SNESLineSearch, PetscBool); 572 PETSC_EXTERN PetscErrorCode SNESLineSearchGetMonitor(SNESLineSearch, PetscViewer*); 573 574 PETSC_EXTERN PetscErrorCode SNESLineSearchAppendOptionsPrefix(SNESLineSearch, const char prefix[]); 575 PETSC_EXTERN PetscErrorCode SNESLineSearchGetOptionsPrefix(SNESLineSearch, const char *prefix[]); 576 577 578 /* Shell interface functions */ 579 PETSC_EXTERN PetscErrorCode SNESLineSearchShellSetUserFunc(SNESLineSearch,SNESLineSearchUserFunc,void*); 580 PETSC_EXTERN PetscErrorCode SNESLineSearchShellGetUserFunc(SNESLineSearch,SNESLineSearchUserFunc*,void**); 581 582 /* BT interface functions */ 583 PETSC_EXTERN PetscErrorCode SNESLineSearchBTSetAlpha(SNESLineSearch, PetscReal); 584 PETSC_EXTERN PetscErrorCode SNESLineSearchBTGetAlpha(SNESLineSearch, PetscReal*); 585 586 /*register line search types */ 587 PETSC_EXTERN PetscErrorCode SNESLineSearchRegister(const char[],PetscErrorCode(*)(SNESLineSearch)); 588 PETSC_EXTERN PetscErrorCode SNESLineSearchRegisterAll(void); 589 590 /* Routines for VI solver */ 591 PETSC_EXTERN PetscErrorCode SNESVISetVariableBounds(SNES,Vec,Vec); 592 PETSC_EXTERN PetscErrorCode SNESVISetComputeVariableBounds(SNES, PetscErrorCode (*)(SNES,Vec,Vec)); 593 PETSC_EXTERN PetscErrorCode SNESVIGetInactiveSet(SNES,IS*); 594 PETSC_EXTERN PetscErrorCode SNESVIGetActiveSetIS(SNES,Vec,Vec,IS*); 595 PETSC_EXTERN PetscErrorCode SNESVIComputeInactiveSetFnorm(SNES,Vec,Vec,PetscReal*); 596 PETSC_EXTERN PetscErrorCode SNESVISetRedundancyCheck(SNES,PetscErrorCode(*)(SNES,IS,IS*,void*),void*); 597 598 PETSC_EXTERN PetscErrorCode SNESTestLocalMin(SNES); 599 600 /* Should this routine be private? */ 601 PETSC_EXTERN PetscErrorCode SNESComputeJacobian(SNES,Vec,Mat,Mat); 602 603 PETSC_EXTERN PetscErrorCode SNESSetDM(SNES,DM); 604 PETSC_EXTERN PetscErrorCode SNESGetDM(SNES,DM*); 605 PETSC_EXTERN PetscErrorCode SNESSetNPC(SNES,SNES); 606 PETSC_EXTERN PetscErrorCode SNESGetNPC(SNES,SNES*); 607 PETSC_EXTERN PetscErrorCode SNESApplyNPC(SNES,Vec,Vec,Vec); 608 PETSC_EXTERN PetscErrorCode SNESGetNPCFunction(SNES,Vec,PetscReal*); 609 PETSC_EXTERN PetscErrorCode SNESComputeFunctionDefaultNPC(SNES,Vec,Vec); 610 PETSC_EXTERN PetscErrorCode SNESSetNPCSide(SNES,PCSide); 611 PETSC_EXTERN PetscErrorCode SNESGetNPCSide(SNES,PCSide*); 612 PETSC_EXTERN PetscErrorCode SNESSetLineSearch(SNES,SNESLineSearch); 613 PETSC_EXTERN PetscErrorCode SNESGetLineSearch(SNES,SNESLineSearch*); 614 PETSC_EXTERN PetscErrorCode SNESRestrictHookAdd(SNES,PetscErrorCode (*)(SNES,SNES,void*),void*); 615 PETSC_EXTERN PetscErrorCode SNESRestrictHooksRun(SNES,SNES); 616 617 PETSC_DEPRECATED("Use SNESGetLineSearch()") PETSC_STATIC_INLINE PetscErrorCode SNESGetSNESLineSearch(SNES snes,SNESLineSearch *ls) {return SNESGetLineSearch(snes,ls);} 618 PETSC_DEPRECATED("Use SNESSetLineSearch()") PETSC_STATIC_INLINE PetscErrorCode SNESSetSNESLineSearch(SNES snes,SNESLineSearch ls) {return SNESSetLineSearch(snes,ls);} 619 620 PETSC_EXTERN PetscErrorCode SNESSetUpMatrices(SNES); 621 PETSC_EXTERN PetscErrorCode DMSNESSetFunction(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),void*); 622 PETSC_EXTERN PetscErrorCode DMSNESGetFunction(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),void**); 623 PETSC_EXTERN PetscErrorCode DMSNESSetNGS(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),void*); 624 PETSC_EXTERN PetscErrorCode DMSNESGetNGS(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),void**); 625 PETSC_EXTERN PetscErrorCode DMSNESSetJacobian(DM,PetscErrorCode(*)(SNES,Vec,Mat,Mat,void*),void*); 626 PETSC_EXTERN PetscErrorCode DMSNESGetJacobian(DM,PetscErrorCode(**)(SNES,Vec,Mat,Mat,void*),void**); 627 PETSC_EXTERN PetscErrorCode DMSNESSetPicard(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),PetscErrorCode(*)(SNES,Vec,Mat,Mat,void*),void*); 628 PETSC_EXTERN PetscErrorCode DMSNESGetPicard(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),PetscErrorCode(**)(SNES,Vec,Mat,Mat,void*),void**); 629 PETSC_EXTERN PetscErrorCode DMSNESSetObjective(DM,PetscErrorCode (*)(SNES,Vec,PetscReal *,void*),void*); 630 PETSC_EXTERN PetscErrorCode DMSNESGetObjective(DM,PetscErrorCode (**)(SNES,Vec,PetscReal *,void*),void**); 631 632 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESFunction)(DMDALocalInfo*,void*,void*,void*); 633 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESJacobian)(DMDALocalInfo*,void*,Mat,Mat,void*); 634 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDASNESObjective)(DMDALocalInfo*,void*,PetscReal*,void*); 635 636 PETSC_EXTERN PetscErrorCode DMDASNESSetFunctionLocal(DM,InsertMode,DMDASNESFunction,void*); 637 PETSC_EXTERN PetscErrorCode DMDASNESSetJacobianLocal(DM,DMDASNESJacobian,void*); 638 PETSC_EXTERN PetscErrorCode DMDASNESSetObjectiveLocal(DM,DMDASNESObjective,void*); 639 PETSC_EXTERN PetscErrorCode DMDASNESSetPicardLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,void*,void*,void*),PetscErrorCode (*)(DMDALocalInfo*,void*,Mat,Mat,void*),void*); 640 641 PETSC_EXTERN PetscErrorCode DMPlexSNESGetGeometryFEM(DM,Vec*); 642 PETSC_EXTERN PetscErrorCode DMPlexSNESGetGeometryFVM(DM,Vec*,Vec*,PetscReal*); 643 PETSC_EXTERN PetscErrorCode DMPlexSNESGetGradientDM(DM,PetscFV,DM*); 644 PETSC_EXTERN PetscErrorCode DMPlexGetCellFields(DM, PetscInt, PetscInt, Vec, Vec, Vec, PetscScalar **, PetscScalar **, PetscScalar **); 645 PETSC_EXTERN PetscErrorCode DMPlexRestoreCellFields(DM, PetscInt, PetscInt, Vec, Vec, Vec, PetscScalar **, PetscScalar **, PetscScalar **); 646 PETSC_EXTERN PetscErrorCode DMPlexGetFaceFields(DM, PetscInt, PetscInt, Vec, Vec, Vec, Vec, Vec, PetscScalar **, PetscScalar **); 647 PETSC_EXTERN PetscErrorCode DMPlexRestoreFaceFields(DM, PetscInt, PetscInt, Vec, Vec, Vec, Vec, Vec, PetscScalar **, PetscScalar **); 648 PETSC_EXTERN PetscErrorCode DMPlexGetFaceGeometry(DM, PetscInt, PetscInt, Vec, Vec, PetscFVFaceGeom **, PetscReal **); 649 PETSC_EXTERN PetscErrorCode DMPlexRestoreFaceGeometry(DM, PetscInt, PetscInt, Vec, Vec, PetscFVFaceGeom **, PetscReal **); 650 651 PETSC_EXTERN PetscErrorCode DMSNESSetFunctionLocal(DM,PetscErrorCode (*)(DM,Vec,Vec,void*),void*); 652 PETSC_EXTERN PetscErrorCode DMSNESSetJacobianLocal(DM,PetscErrorCode (*)(DM,Vec,Mat,Mat,void*),void*); 653 654 /* Routines for Multiblock solver */ 655 PETSC_EXTERN PetscErrorCode SNESMultiblockSetFields(SNES, const char [], PetscInt, const PetscInt *); 656 PETSC_EXTERN PetscErrorCode SNESMultiblockSetIS(SNES, const char [], IS); 657 PETSC_EXTERN PetscErrorCode SNESMultiblockSetBlockSize(SNES, PetscInt); 658 PETSC_EXTERN PetscErrorCode SNESMultiblockSetType(SNES, PCCompositeType); 659 660 /*J 661 SNESMSType - String with the name of a PETSc SNESMS method. 662 663 Level: intermediate 664 665 .seealso: SNESMSSetType(), SNES 666 J*/ 667 typedef const char* SNESMSType; 668 #define SNESMSM62 "m62" 669 #define SNESMSEULER "euler" 670 #define SNESMSJAMESON83 "jameson83" 671 #define SNESMSVLTP21 "vltp21" 672 #define SNESMSVLTP31 "vltp31" 673 #define SNESMSVLTP41 "vltp41" 674 #define SNESMSVLTP51 "vltp51" 675 #define SNESMSVLTP61 "vltp61" 676 677 PETSC_EXTERN PetscErrorCode SNESMSRegister(SNESMSType,PetscInt,PetscInt,PetscReal,const PetscReal[],const PetscReal[],const PetscReal[]); 678 PETSC_EXTERN PetscErrorCode SNESMSSetType(SNES,SNESMSType); 679 PETSC_EXTERN PetscErrorCode SNESMSFinalizePackage(void); 680 PETSC_EXTERN PetscErrorCode SNESMSInitializePackage(void); 681 PETSC_EXTERN PetscErrorCode SNESMSRegisterDestroy(void); 682 PETSC_EXTERN PetscErrorCode SNESMSRegisterAll(void); 683 684 /* routines for NGMRES solver */ 685 686 typedef enum { 687 SNES_NGMRES_RESTART_NONE = 0, 688 SNES_NGMRES_RESTART_PERIODIC = 1, 689 SNES_NGMRES_RESTART_DIFFERENCE = 2} SNESNGMRESRestartType; 690 PETSC_EXTERN const char *const SNESNGMRESRestartTypes[]; 691 692 typedef enum { 693 SNES_NGMRES_SELECT_NONE = 0, 694 SNES_NGMRES_SELECT_DIFFERENCE = 1, 695 SNES_NGMRES_SELECT_LINESEARCH = 2} SNESNGMRESSelectType; 696 PETSC_EXTERN const char *const SNESNGMRESSelectTypes[]; 697 698 PETSC_EXTERN PetscErrorCode SNESNGMRESSetRestartType(SNES, SNESNGMRESRestartType); 699 PETSC_EXTERN PetscErrorCode SNESNGMRESSetSelectType(SNES, SNESNGMRESSelectType); 700 701 /* routines for NCG solver */ 702 703 typedef enum { 704 SNES_NCG_FR = 0, 705 SNES_NCG_PRP = 1, 706 SNES_NCG_HS = 2, 707 SNES_NCG_DY = 3, 708 SNES_NCG_CD = 4} SNESNCGType; 709 PETSC_EXTERN const char *const SNESNCGTypes[]; 710 711 PETSC_EXTERN PetscErrorCode SNESNCGSetType(SNES, SNESNCGType); 712 713 typedef enum {SNES_QN_SCALE_DEFAULT = 0, 714 SNES_QN_SCALE_NONE = 1, 715 SNES_QN_SCALE_SHANNO = 2, 716 SNES_QN_SCALE_LINESEARCH = 3, 717 SNES_QN_SCALE_JACOBIAN = 4} SNESQNScaleType; 718 PETSC_EXTERN const char *const SNESQNScaleTypes[]; 719 typedef enum {SNES_QN_RESTART_DEFAULT = 0, 720 SNES_QN_RESTART_NONE = 1, 721 SNES_QN_RESTART_POWELL = 2, 722 SNES_QN_RESTART_PERIODIC = 3} SNESQNRestartType; 723 PETSC_EXTERN const char *const SNESQNRestartTypes[]; 724 typedef enum {SNES_QN_LBFGS = 0, 725 SNES_QN_BROYDEN = 1, 726 SNES_QN_BADBROYDEN = 2 727 } SNESQNType; 728 PETSC_EXTERN const char *const SNESQNTypes[]; 729 730 PETSC_EXTERN PetscErrorCode SNESQNSetType(SNES, SNESQNType); 731 PETSC_EXTERN PetscErrorCode SNESQNSetScaleType(SNES, SNESQNScaleType); 732 PETSC_EXTERN PetscErrorCode SNESQNSetRestartType(SNES, SNESQNRestartType); 733 734 PETSC_EXTERN PetscErrorCode SNESNASMGetType(SNES,PCASMType*); 735 PETSC_EXTERN PetscErrorCode SNESNASMSetType(SNES,PCASMType); 736 PETSC_EXTERN PetscErrorCode SNESNASMGetSubdomains(SNES,PetscInt*,SNES**,VecScatter**,VecScatter**,VecScatter**); 737 PETSC_EXTERN PetscErrorCode SNESNASMSetSubdomains(SNES,PetscInt,SNES*,VecScatter*,VecScatter*,VecScatter*); 738 PETSC_EXTERN PetscErrorCode SNESNASMSetDamping(SNES,PetscReal); 739 PETSC_EXTERN PetscErrorCode SNESNASMGetDamping(SNES,PetscReal*); 740 PETSC_EXTERN PetscErrorCode SNESNASMGetSubdomainVecs(SNES,PetscInt*,Vec**,Vec**,Vec**,Vec**); 741 PETSC_EXTERN PetscErrorCode SNESNASMSetComputeFinalJacobian(SNES,PetscBool); 742 743 typedef enum {SNES_COMPOSITE_ADDITIVE,SNES_COMPOSITE_MULTIPLICATIVE,SNES_COMPOSITE_ADDITIVEOPTIMAL} SNESCompositeType; 744 PETSC_EXTERN const char *const SNESCompositeTypes[]; 745 746 PETSC_EXTERN PetscErrorCode SNESCompositeSetType(SNES,SNESCompositeType); 747 PETSC_EXTERN PetscErrorCode SNESCompositeAddSNES(SNES,SNESType); 748 PETSC_EXTERN PetscErrorCode SNESCompositeGetSNES(SNES,PetscInt,SNES *); 749 PETSC_EXTERN PetscErrorCode SNESCompositeGetNumber(SNES,PetscInt*); 750 PETSC_EXTERN PetscErrorCode SNESCompositeSetDamping(SNES,PetscInt,PetscReal); 751 752 /*E 753 SNESFASType - Determines the type of nonlinear multigrid method that is run. 754 755 Level: beginner 756 757 Values: 758 + SNES_FAS_MULTIPLICATIVE (default) - traditional V or W cycle as determined by SNESFASSetCycles() 759 . SNES_FAS_ADDITIVE - additive FAS cycle 760 . SNES_FAS_FULL - full FAS cycle 761 - SNES_FAS_KASKADE - Kaskade FAS cycle 762 .seealso: PCMGSetType(), PCMGType 763 764 E*/ 765 typedef enum { SNES_FAS_MULTIPLICATIVE, SNES_FAS_ADDITIVE, SNES_FAS_FULL, SNES_FAS_KASKADE } SNESFASType; 766 PETSC_EXTERN const char *const SNESFASTypes[]; 767 768 /* called on the finest level FAS instance*/ 769 PETSC_EXTERN PetscErrorCode SNESFASSetType(SNES, SNESFASType); 770 PETSC_EXTERN PetscErrorCode SNESFASGetType(SNES, SNESFASType*); 771 PETSC_EXTERN PetscErrorCode SNESFASSetLevels(SNES, PetscInt, MPI_Comm *); 772 PETSC_EXTERN PetscErrorCode SNESFASGetLevels(SNES, PetscInt *); 773 PETSC_EXTERN PetscErrorCode SNESFASGetCycleSNES(SNES, PetscInt, SNES*); 774 PETSC_EXTERN PetscErrorCode SNESFASSetNumberSmoothUp(SNES, PetscInt); 775 PETSC_EXTERN PetscErrorCode SNESFASSetNumberSmoothDown(SNES, PetscInt); 776 PETSC_EXTERN PetscErrorCode SNESFASSetCycles(SNES, PetscInt); 777 PETSC_EXTERN PetscErrorCode SNESFASSetMonitor(SNES, PetscBool); 778 PETSC_EXTERN PetscErrorCode SNESFASSetLog(SNES, PetscBool); 779 780 PETSC_EXTERN PetscErrorCode SNESFASSetGalerkin(SNES, PetscBool); 781 PETSC_EXTERN PetscErrorCode SNESFASGetGalerkin(SNES, PetscBool*); 782 783 /* called on any level -- "Cycle" FAS instance */ 784 PETSC_EXTERN PetscErrorCode SNESFASCycleGetSmoother(SNES, SNES*); 785 PETSC_EXTERN PetscErrorCode SNESFASCycleGetSmootherUp(SNES, SNES*); 786 PETSC_EXTERN PetscErrorCode SNESFASCycleGetSmootherDown(SNES, SNES*); 787 PETSC_EXTERN PetscErrorCode SNESFASCycleGetCorrection(SNES, SNES*); 788 PETSC_EXTERN PetscErrorCode SNESFASCycleGetInterpolation(SNES, Mat*); 789 PETSC_EXTERN PetscErrorCode SNESFASCycleGetRestriction(SNES, Mat*); 790 PETSC_EXTERN PetscErrorCode SNESFASCycleGetInjection(SNES, Mat*); 791 PETSC_EXTERN PetscErrorCode SNESFASCycleGetRScale(SNES, Vec*); 792 PETSC_EXTERN PetscErrorCode SNESFASCycleSetCycles(SNES, PetscInt); 793 PETSC_EXTERN PetscErrorCode SNESFASCycleIsFine(SNES, PetscBool*); 794 795 /* called on the (outer) finest level FAS to set/get parameters on any level instance */ 796 PETSC_EXTERN PetscErrorCode SNESFASSetInterpolation(SNES, PetscInt, Mat); 797 PETSC_EXTERN PetscErrorCode SNESFASGetInterpolation(SNES, PetscInt, Mat*); 798 PETSC_EXTERN PetscErrorCode SNESFASSetRestriction(SNES, PetscInt, Mat); 799 PETSC_EXTERN PetscErrorCode SNESFASGetRestriction(SNES, PetscInt, Mat*); 800 PETSC_EXTERN PetscErrorCode SNESFASSetInjection(SNES, PetscInt, Mat); 801 PETSC_EXTERN PetscErrorCode SNESFASGetInjection(SNES, PetscInt, Mat*); 802 PETSC_EXTERN PetscErrorCode SNESFASSetRScale(SNES, PetscInt, Vec); 803 PETSC_EXTERN PetscErrorCode SNESFASGetRScale(SNES, PetscInt, Vec*); 804 PETSC_EXTERN PetscErrorCode SNESFASSetContinuation(SNES,PetscBool); 805 806 PETSC_EXTERN PetscErrorCode SNESFASGetSmoother(SNES, PetscInt, SNES*); 807 PETSC_EXTERN PetscErrorCode SNESFASGetSmootherUp(SNES, PetscInt, SNES*); 808 PETSC_EXTERN PetscErrorCode SNESFASGetSmootherDown(SNES, PetscInt, SNES*); 809 PETSC_EXTERN PetscErrorCode SNESFASGetCoarseSolve(SNES, SNES*); 810 811 /* parameters for full FAS */ 812 PETSC_EXTERN PetscErrorCode SNESFASFullSetDownSweep(SNES,PetscBool); 813 PETSC_EXTERN PetscErrorCode SNESFASCreateCoarseVec(SNES,Vec*); 814 PETSC_EXTERN PetscErrorCode SNESFASRestrict(SNES,Vec,Vec); 815 816 #endif 817