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