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