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