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