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