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