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