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