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