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