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