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 "petscdmda.h" 8 PETSC_EXTERN_CXX_BEGIN 9 10 /*S 11 SNES - Abstract PETSc object that manages all nonlinear solves 12 13 Level: beginner 14 15 Concepts: nonlinear solvers 16 17 .seealso: SNESCreate(), SNESSetType(), SNESType, TS, KSP, KSP, PC 18 S*/ 19 typedef struct _p_SNES* SNES; 20 21 /*J 22 SNESType - String with the name of a PETSc SNES method or the creation function 23 with an optional dynamic library name, for example 24 http://www.mcs.anl.gov/petsc/lib.a:mysnescreate() 25 26 Level: beginner 27 28 .seealso: SNESSetType(), SNES 29 J*/ 30 #define SNESType char* 31 #define SNESLS "ls" 32 #define SNESTR "tr" 33 #define SNESPYTHON "python" 34 #define SNESTEST "test" 35 #define SNESNRICHARDSON "nrichardson" 36 #define SNESKSPONLY "ksponly" 37 #define SNESVIRS "virs" 38 #define SNESVISS "viss" 39 #define SNESNGMRES "ngmres" 40 #define SNESQN "qn" 41 #define SNESSHELL "shell" 42 #define SNESGS "gs" 43 #define SNESNCG "ncg" 44 #define SNESSORQN "sorqn" 45 #define SNESFAS "fas" 46 #define SNESMS "ms" 47 48 /* Logging support */ 49 extern PetscClassId SNES_CLASSID; 50 51 extern PetscErrorCode SNESInitializePackage(const char[]); 52 53 extern PetscErrorCode SNESCreate(MPI_Comm,SNES*); 54 extern PetscErrorCode SNESReset(SNES); 55 extern PetscErrorCode SNESDestroy(SNES*); 56 extern PetscErrorCode SNESSetType(SNES,const SNESType); 57 extern PetscErrorCode SNESMonitor(SNES,PetscInt,PetscReal); 58 extern PetscErrorCode SNESMonitorSet(SNES,PetscErrorCode(*)(SNES,PetscInt,PetscReal,void*),void *,PetscErrorCode (*)(void**)); 59 extern PetscErrorCode SNESMonitorCancel(SNES); 60 extern PetscErrorCode SNESSetConvergenceHistory(SNES,PetscReal[],PetscInt[],PetscInt,PetscBool ); 61 extern PetscErrorCode SNESGetConvergenceHistory(SNES,PetscReal*[],PetscInt *[],PetscInt *); 62 extern PetscErrorCode SNESSetUp(SNES); 63 extern PetscErrorCode SNESSolve(SNES,Vec,Vec); 64 extern PetscErrorCode SNESSetErrorIfNotConverged(SNES,PetscBool ); 65 extern PetscErrorCode SNESGetErrorIfNotConverged(SNES,PetscBool *); 66 67 68 extern PetscErrorCode SNESAddOptionsChecker(PetscErrorCode (*)(SNES)); 69 70 extern PetscErrorCode SNESSetUpdate(SNES, PetscErrorCode (*)(SNES, PetscInt)); 71 extern PetscErrorCode SNESDefaultUpdate(SNES, PetscInt); 72 73 extern PetscFList SNESList; 74 extern PetscErrorCode SNESRegisterDestroy(void); 75 extern PetscErrorCode SNESRegisterAll(const char[]); 76 77 extern PetscErrorCode SNESRegister(const char[],const char[],const char[],PetscErrorCode (*)(SNES)); 78 79 /*MC 80 SNESRegisterDynamic - Adds a method to the nonlinear solver package. 81 82 Synopsis: 83 PetscErrorCode SNESRegisterDynamic(const char *name_solver,const char *path,const char *name_create,PetscErrorCode (*routine_create)(SNES)) 84 85 Not collective 86 87 Input Parameters: 88 + name_solver - name of a new user-defined solver 89 . path - path (either absolute or relative) the library containing this solver 90 . name_create - name of routine to create method context 91 - routine_create - routine to create method context 92 93 Notes: 94 SNESRegisterDynamic() may be called multiple times to add several user-defined solvers. 95 96 If dynamic libraries are used, then the fourth input argument (routine_create) 97 is ignored. 98 99 Environmental variables such as ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR}, 100 and others of the form ${any_environmental_variable} occuring in pathname will be 101 replaced with appropriate values. 102 103 Sample usage: 104 .vb 105 SNESRegisterDynamic("my_solver",/home/username/my_lib/lib/libg/solaris/mylib.a, 106 "MySolverCreate",MySolverCreate); 107 .ve 108 109 Then, your solver can be chosen with the procedural interface via 110 $ SNESSetType(snes,"my_solver") 111 or at runtime via the option 112 $ -snes_type my_solver 113 114 Level: advanced 115 116 Note: If your function is not being put into a shared library then use SNESRegister() instead 117 118 .keywords: SNES, nonlinear, register 119 120 .seealso: SNESRegisterAll(), SNESRegisterDestroy() 121 M*/ 122 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 123 #define SNESRegisterDynamic(a,b,c,d) SNESRegister(a,b,c,0) 124 #else 125 #define SNESRegisterDynamic(a,b,c,d) SNESRegister(a,b,c,d) 126 #endif 127 128 extern PetscErrorCode SNESGetKSP(SNES,KSP*); 129 extern PetscErrorCode SNESSetKSP(SNES,KSP); 130 extern PetscErrorCode SNESGetSolution(SNES,Vec*); 131 extern PetscErrorCode SNESGetSolutionUpdate(SNES,Vec*); 132 extern PetscErrorCode SNESGetRhs(SNES,Vec*); 133 extern PetscErrorCode SNESView(SNES,PetscViewer); 134 135 extern PetscErrorCode SNESSetOptionsPrefix(SNES,const char[]); 136 extern PetscErrorCode SNESAppendOptionsPrefix(SNES,const char[]); 137 extern PetscErrorCode SNESGetOptionsPrefix(SNES,const char*[]); 138 extern PetscErrorCode SNESSetFromOptions(SNES); 139 extern PetscErrorCode SNESDefaultGetWork(SNES,PetscInt); 140 141 extern PetscErrorCode MatCreateSNESMF(SNES,Mat*); 142 extern PetscErrorCode MatMFFDComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 143 144 extern PetscErrorCode MatDAADSetSNES(Mat,SNES); 145 146 extern PetscErrorCode SNESGetType(SNES,const SNESType*); 147 extern PetscErrorCode SNESMonitorDefault(SNES,PetscInt,PetscReal,void *); 148 extern PetscErrorCode SNESMonitorRange(SNES,PetscInt,PetscReal,void *); 149 extern PetscErrorCode SNESMonitorRatio(SNES,PetscInt,PetscReal,void *); 150 extern PetscErrorCode SNESMonitorSetRatio(SNES,PetscViewer); 151 extern PetscErrorCode SNESMonitorSolution(SNES,PetscInt,PetscReal,void *); 152 extern PetscErrorCode SNESMonitorResidual(SNES,PetscInt,PetscReal,void *); 153 extern PetscErrorCode SNESMonitorSolutionUpdate(SNES,PetscInt,PetscReal,void *); 154 extern PetscErrorCode SNESMonitorDefaultShort(SNES,PetscInt,PetscReal,void *); 155 extern PetscErrorCode SNESSetTolerances(SNES,PetscReal,PetscReal,PetscReal,PetscInt,PetscInt); 156 extern PetscErrorCode SNESGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,PetscInt*,PetscInt*); 157 extern PetscErrorCode SNESSetTrustRegionTolerance(SNES,PetscReal); 158 extern PetscErrorCode SNESGetFunctionNorm(SNES,PetscReal*); 159 extern PetscErrorCode SNESSetFunctionNorm(SNES,PetscReal); 160 extern PetscErrorCode SNESGetIterationNumber(SNES,PetscInt*); 161 extern PetscErrorCode SNESSetIterationNumber(SNES,PetscInt); 162 163 extern PetscErrorCode SNESGetNonlinearStepFailures(SNES,PetscInt*); 164 extern PetscErrorCode SNESSetMaxNonlinearStepFailures(SNES,PetscInt); 165 extern PetscErrorCode SNESGetMaxNonlinearStepFailures(SNES,PetscInt*); 166 extern PetscErrorCode SNESGetNumberFunctionEvals(SNES,PetscInt*); 167 168 extern PetscErrorCode SNESSetLagPreconditioner(SNES,PetscInt); 169 extern PetscErrorCode SNESGetLagPreconditioner(SNES,PetscInt*); 170 extern PetscErrorCode SNESSetLagJacobian(SNES,PetscInt); 171 extern PetscErrorCode SNESGetLagJacobian(SNES,PetscInt*); 172 extern PetscErrorCode SNESSetGridSequence(SNES,PetscInt); 173 174 extern PetscErrorCode SNESGetLinearSolveIterations(SNES,PetscInt*); 175 extern PetscErrorCode SNESGetLinearSolveFailures(SNES,PetscInt*); 176 extern PetscErrorCode SNESSetMaxLinearSolveFailures(SNES,PetscInt); 177 extern PetscErrorCode SNESGetMaxLinearSolveFailures(SNES,PetscInt*); 178 179 extern PetscErrorCode SNESKSPSetUseEW(SNES,PetscBool ); 180 extern PetscErrorCode SNESKSPGetUseEW(SNES,PetscBool *); 181 extern PetscErrorCode SNESKSPSetParametersEW(SNES,PetscInt,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal); 182 extern PetscErrorCode SNESKSPGetParametersEW(SNES,PetscInt*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*); 183 184 extern PetscErrorCode SNESMonitorLGCreate(const char[],const char[],int,int,int,int,PetscDrawLG*); 185 extern PetscErrorCode SNESMonitorLG(SNES,PetscInt,PetscReal,void*); 186 extern PetscErrorCode SNESMonitorLGDestroy(PetscDrawLG*); 187 extern PetscErrorCode SNESMonitorLGRangeCreate(const char[],const char[],int,int,int,int,PetscDrawLG*); 188 extern PetscErrorCode SNESMonitorLGRange(SNES,PetscInt,PetscReal,void*); 189 extern PetscErrorCode SNESMonitorLGRangeDestroy(PetscDrawLG*); 190 191 extern PetscErrorCode SNESSetApplicationContext(SNES,void *); 192 extern PetscErrorCode SNESGetApplicationContext(SNES,void *); 193 extern PetscErrorCode SNESSetComputeApplicationContext(SNES,PetscErrorCode (*)(SNES,void**),PetscErrorCode (*)(void**)); 194 195 extern PetscErrorCode SNESPythonSetType(SNES,const char[]); 196 197 extern PetscErrorCode SNESSetFunctionDomainError(SNES); 198 extern PetscErrorCode SNESGetFunctionDomainError(SNES, PetscBool *); 199 200 /*E 201 SNESConvergedReason - reason a SNES method was said to 202 have converged or diverged 203 204 Level: beginner 205 206 The two most common reasons for divergence are 207 $ 1) an incorrectly coded or computed Jacobian or 208 $ 2) failure or lack of convergence in the linear system (in this case we recommend 209 $ testing with -pc_type lu to eliminate the linear solver as the cause of the problem). 210 211 Diverged Reasons: 212 . SNES_DIVERGED_LOCAL_MIN - this can only occur when using the line-search variant of SNES. 213 The line search wants to minimize Q(alpha) = 1/2 || F(x + alpha s) ||^2_2 this occurs 214 at Q'(alpha) = s^T F'(x+alpha s)^T F(x+alpha s) = 0. If s is the Newton direction - F'(x)^(-1)F(x) then 215 you get Q'(alpha) = -F(x)^T F'(x)^(-1)^T F'(x+alpha s)F(x+alpha s); when alpha = 0 216 Q'(0) = - ||F(x)||^2_2 which is always NEGATIVE if F'(x) is invertible. This means the Newton 217 direction is a descent direction and the line search should succeed if alpha is small enough. 218 219 If F'(x) is NOT invertible AND F'(x)^T F(x) = 0 then Q'(0) = 0 and the Newton direction 220 is NOT a descent direction so the line search will fail. All one can do at this point 221 is change the initial guess and try again. 222 223 An alternative explanation: Newton's method can be regarded as replacing the function with 224 its linear approximation and minimizing the 2-norm of that. That is F(x+s) approx F(x) + F'(x)s 225 so we minimize || F(x) + F'(x) s ||^2_2; do this using Least Squares. If F'(x) is invertible then 226 s = - F'(x)^(-1)F(x) otherwise F'(x)^T F'(x) s = -F'(x)^T F(x). If F'(x)^T F(x) is NOT zero then there 227 exists a nontrival (that is F'(x)s != 0) solution to the equation and this direction is 228 s = - [F'(x)^T F'(x)]^(-1) F'(x)^T F(x) so Q'(0) = - F(x)^T F'(x) [F'(x)^T F'(x)]^(-T) F'(x)^T F(x) 229 = - (F'(x)^T F(x)) [F'(x)^T F'(x)]^(-T) (F'(x)^T F(x)). Since we are assuming (F'(x)^T F(x)) != 0 230 and F'(x)^T F'(x) has no negative eigenvalues Q'(0) < 0 so s is a descent direction and the line 231 search should succeed for small enough alpha. 232 233 Note that this RARELY happens in practice. Far more likely the linear system is not being solved 234 (well enough?) or the Jacobian is wrong. 235 236 SNES_DIVERGED_MAX_IT means that the solver reached the maximum number of iterations without satisfying any 237 convergence criteria. SNES_CONVERGED_ITS means that SNESSkipConverged() was chosen as the convergence test; 238 thus the usual convergence criteria have not been checked and may or may not be satisfied. 239 240 Developer Notes: this must match finclude/petscsnes.h 241 242 The string versions of these are in SNESConvergedReason, if you change any value here you must 243 also adjust that array. 244 245 Each reason has its own manual page. 246 247 .seealso: SNESSolve(), SNESGetConvergedReason(), KSPConvergedReason, SNESSetConvergenceTest() 248 E*/ 249 typedef enum {/* converged */ 250 SNES_CONVERGED_FNORM_ABS = 2, /* ||F|| < atol */ 251 SNES_CONVERGED_FNORM_RELATIVE = 3, /* ||F|| < rtol*||F_initial|| */ 252 SNES_CONVERGED_PNORM_RELATIVE = 4, /* Newton computed step size small; || delta x || < stol */ 253 SNES_CONVERGED_ITS = 5, /* maximum iterations reached */ 254 SNES_CONVERGED_TR_DELTA = 7, 255 /* diverged */ 256 SNES_DIVERGED_FUNCTION_DOMAIN = -1, /* the new x location passed the function is not in the domain of F */ 257 SNES_DIVERGED_FUNCTION_COUNT = -2, 258 SNES_DIVERGED_LINEAR_SOLVE = -3, /* the linear solve failed */ 259 SNES_DIVERGED_FNORM_NAN = -4, 260 SNES_DIVERGED_MAX_IT = -5, 261 SNES_DIVERGED_LINE_SEARCH = -6, /* the line search failed */ 262 SNES_DIVERGED_INNER = -7, /* inner solve failed */ 263 SNES_DIVERGED_LOCAL_MIN = -8, /* || J^T b || is small, implies converged to local minimum of F() */ 264 SNES_CONVERGED_ITERATING = 0} SNESConvergedReason; 265 extern const char *const*SNESConvergedReasons; 266 267 /*MC 268 SNES_CONVERGED_FNORM_ABS - 2-norm(F) <= abstol 269 270 Level: beginner 271 272 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 273 274 M*/ 275 276 /*MC 277 SNES_CONVERGED_FNORM_RELATIVE - 2-norm(F) <= rtol*2-norm(F(x_0)) where x_0 is the initial guess 278 279 Level: beginner 280 281 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 282 283 M*/ 284 285 /*MC 286 SNES_CONVERGED_PNORM_RELATIVE - The 2-norm of the last step <= stol * 2-norm(x) where x is the current 287 solution and stol is the 4th argument to SNESSetTolerances() 288 289 Level: beginner 290 291 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 292 293 M*/ 294 295 /*MC 296 SNES_DIVERGED_FUNCTION_COUNT - The user provided function has been called more times then the final 297 argument to SNESSetTolerances() 298 299 Level: beginner 300 301 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 302 303 M*/ 304 305 /*MC 306 SNES_DIVERGED_FNORM_NAN - the 2-norm of the current function evaluation is not-a-number (NaN), this 307 is usually caused by a division of 0 by 0. 308 309 Level: beginner 310 311 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 312 313 M*/ 314 315 /*MC 316 SNES_DIVERGED_MAX_IT - SNESSolve() has reached the maximum number of iterations requested 317 318 Level: beginner 319 320 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 321 322 M*/ 323 324 /*MC 325 SNES_DIVERGED_LINE_SEARCH - The line search has failed. This only occurs for a SNESType of SNESLS 326 327 Level: beginner 328 329 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 330 331 M*/ 332 333 /*MC 334 SNES_DIVERGED_LOCAL_MIN - the algorithm seems to have stagnated at a local minimum that is not zero. 335 See the manual page for SNESConvergedReason for more details 336 337 Level: beginner 338 339 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 340 341 M*/ 342 343 /*MC 344 SNES_CONERGED_ITERATING - this only occurs if SNESGetConvergedReason() is called during the SNESSolve() 345 346 Level: beginner 347 348 .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 349 350 M*/ 351 352 extern PetscErrorCode SNESSetConvergenceTest(SNES,PetscErrorCode (*)(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void*,PetscErrorCode (*)(void*)); 353 extern PetscErrorCode SNESDefaultConverged(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*); 354 extern PetscErrorCode SNESSkipConverged(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*); 355 extern PetscErrorCode SNESGetConvergedReason(SNES,SNESConvergedReason*); 356 357 extern PetscErrorCode SNESDMDAComputeFunction(SNES,Vec,Vec,void*); 358 extern PetscErrorCode SNESDMDAComputeJacobianWithAdic(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 359 extern PetscErrorCode SNESDMDAComputeJacobianWithAdifor(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 360 extern PetscErrorCode SNESDMDAComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 361 362 extern PetscErrorCode SNESDMMeshComputeFunction(SNES,Vec,Vec,void*); 363 extern PetscErrorCode SNESDMMeshComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 364 extern PetscErrorCode SNESDMComplexComputeFunction(SNES,Vec,Vec,void *); 365 extern PetscErrorCode SNESDMComplexComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 366 367 /* --------- Solving systems of nonlinear equations --------------- */ 368 typedef PetscErrorCode (*SNESFunction)(SNES,Vec,Vec,void*); 369 typedef PetscErrorCode (*SNESJacobian)(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 370 typedef PetscErrorCode (*SNESGSFunction)(SNES,Vec,Vec,void*); 371 extern PetscErrorCode SNESSetFunction(SNES,Vec,SNESFunction,void*); 372 extern PetscErrorCode SNESGetFunction(SNES,Vec*,SNESFunction*,void**); 373 extern PetscErrorCode SNESComputeFunction(SNES,Vec,Vec); 374 extern PetscErrorCode SNESSetJacobian(SNES,Mat,Mat,SNESJacobian,void*); 375 extern PetscErrorCode SNESGetJacobian(SNES,Mat*,Mat*,SNESJacobian*,void**); 376 extern PetscErrorCode SNESDefaultComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 377 extern PetscErrorCode SNESDefaultComputeJacobianColor(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 378 extern PetscErrorCode SNESSetComputeInitialGuess(SNES,PetscErrorCode (*)(SNES,Vec,void*),void*); 379 extern PetscErrorCode SNESSetPicard(SNES,Vec,SNESFunction,Mat,Mat,SNESJacobian,void*); 380 extern PetscErrorCode SNESGetPicard(SNES,Vec*,SNESFunction*,Mat*,SNESJacobian*,void**); 381 382 extern PetscErrorCode SNESSetGS(SNES,SNESGSFunction,void*); 383 extern PetscErrorCode SNESGetGS(SNES,SNESGSFunction*,void**); 384 extern PetscErrorCode SNESSetUseGS(SNES,PetscBool); 385 extern PetscErrorCode SNESGetUseGS(SNES,PetscBool *); 386 extern PetscErrorCode SNESSetGSSweeps(SNES,PetscInt); 387 extern PetscErrorCode SNESGetGSSweeps(SNES,PetscInt *); 388 extern PetscErrorCode SNESComputeGS(SNES,Vec,Vec); 389 390 extern PetscErrorCode SNESShellGetContext(SNES,void**); 391 extern PetscErrorCode SNESShellSetContext(SNES,void*); 392 extern PetscErrorCode SNESShellSetSolve(SNES,PetscErrorCode (*)(SNES,Vec)); 393 394 /* --------- Routines specifically for line search methods --------------- */ 395 396 typedef struct _p_LineSearch* SNESLineSearch; 397 398 /* 399 User interface for Line Searches 400 */ 401 402 #define SNESLineSearchType char* 403 #define SNES_LINESEARCH_BT "bt" 404 #define SNES_LINESEARCH_BASIC "basic" 405 #define SNES_LINESEARCH_L2 "l2" 406 #define SNES_LINESEARCH_CP "cp" 407 #define SNES_LINESEARCH_SHELL "shell" 408 409 extern PetscClassId SNESLINESEARCH_CLASSID; 410 extern PetscBool SNESLineSearchRegisterAllCalled; 411 extern PetscFList SNESLineSearchList; 412 extern PetscLogEvent SNESLineSearch_Apply; 413 414 typedef PetscErrorCode (*SNESLineSearchPreCheckFunc)(SNESLineSearch,Vec,Vec,PetscBool*,void*); 415 typedef PetscErrorCode (*SNESLineSearchVIProjectFunc)(SNES,Vec); 416 typedef PetscErrorCode (*SNESLineSearchVINormFunc)(SNES,Vec,Vec,PetscReal *); 417 typedef PetscErrorCode (*SNESLineSearchPostCheckFunc)(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *,void*); 418 typedef PetscErrorCode (*SNESLineSearchApplyFunc)(SNESLineSearch); 419 typedef PetscErrorCode (*SNESLineSearchUserFunc)(SNESLineSearch, void *); 420 421 extern PetscErrorCode SNESLineSearchCreate(MPI_Comm, SNESLineSearch*); 422 extern PetscErrorCode SNESLineSearchReset(SNESLineSearch); 423 extern PetscErrorCode SNESLineSearchView(SNESLineSearch); 424 extern PetscErrorCode SNESLineSearchDestroy(SNESLineSearch *); 425 extern PetscErrorCode SNESLineSearchSetType(SNESLineSearch, const SNESLineSearchType); 426 extern PetscErrorCode SNESLineSearchSetFromOptions(SNESLineSearch); 427 extern PetscErrorCode SNESLineSearchSetUp(SNESLineSearch); 428 extern PetscErrorCode SNESLineSearchApply(SNESLineSearch, Vec, Vec, PetscReal *, Vec); 429 extern PetscErrorCode SNESLineSearchPreCheck(SNESLineSearch, PetscBool *); 430 extern PetscErrorCode SNESLineSearchPostCheck(SNESLineSearch, PetscBool *, PetscBool *); 431 extern PetscErrorCode SNESLineSearchGetWork(SNESLineSearch, PetscInt); 432 433 /* set the functions for precheck and postcheck */ 434 435 extern PetscErrorCode SNESLineSearchSetPreCheck(SNESLineSearch, SNESLineSearchPreCheckFunc, void *ctx); 436 extern PetscErrorCode SNESLineSearchSetPostCheck(SNESLineSearch, SNESLineSearchPostCheckFunc, void *ctx); 437 438 extern PetscErrorCode SNESLineSearchGetPreCheck(SNESLineSearch, SNESLineSearchPreCheckFunc*, void **ctx); 439 extern PetscErrorCode SNESLineSearchGetPostCheck(SNESLineSearch, SNESLineSearchPostCheckFunc*, void **ctx); 440 441 /* set the functions for VI-specific line search operations */ 442 443 extern PetscErrorCode SNESLineSearchSetVIFunctions(SNESLineSearch, SNESLineSearchVIProjectFunc, SNESLineSearchVINormFunc); 444 extern PetscErrorCode SNESLineSearchGetVIFunctions(SNESLineSearch, SNESLineSearchVIProjectFunc*, SNESLineSearchVINormFunc*); 445 446 /* pointers to the associated SNES in order to be able to get the function evaluation out */ 447 extern PetscErrorCode SNESLineSearchSetSNES(SNESLineSearch,SNES); 448 extern PetscErrorCode SNESLineSearchGetSNES(SNESLineSearch,SNES*); 449 450 /* set and get the parameters and vectors */ 451 extern PetscErrorCode SNESLineSearchGetTolerances(SNESLineSearch,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscInt*); 452 extern PetscErrorCode SNESLineSearchSetTolerances(SNESLineSearch,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscInt); 453 454 extern PetscErrorCode SNESLineSearchPreCheckPicard(SNESLineSearch,Vec,Vec,PetscBool*,void*); 455 456 extern PetscErrorCode SNESLineSearchGetLambda(SNESLineSearch,PetscReal*); 457 extern PetscErrorCode SNESLineSearchSetLambda(SNESLineSearch,PetscReal); 458 459 extern PetscErrorCode SNESLineSearchGetDamping(SNESLineSearch,PetscReal*); 460 extern PetscErrorCode SNESLineSearchSetDamping(SNESLineSearch,PetscReal); 461 462 extern PetscErrorCode SNESLineSearchGetSuccess(SNESLineSearch, PetscBool*); 463 extern PetscErrorCode SNESLineSearchSetSuccess(SNESLineSearch, PetscBool); 464 465 extern PetscErrorCode SNESLineSearchGetVecs(SNESLineSearch,Vec*,Vec*,Vec*,Vec*,Vec*); 466 extern PetscErrorCode SNESLineSearchSetVecs(SNESLineSearch,Vec,Vec,Vec,Vec,Vec); 467 468 extern PetscErrorCode SNESLineSearchGetNorms(SNESLineSearch, PetscReal *, PetscReal *, PetscReal *); 469 extern PetscErrorCode SNESLineSearchSetNorms(SNESLineSearch, PetscReal, PetscReal, PetscReal); 470 extern PetscErrorCode SNESLineSearchComputeNorms(SNESLineSearch); 471 472 extern PetscErrorCode SNESLineSearchSetMonitor(SNESLineSearch, PetscBool); 473 extern PetscErrorCode SNESLineSearchGetMonitor(SNESLineSearch, PetscViewer*); 474 475 extern PetscErrorCode SNESLineSearchAppendOptionsPrefix(SNESLineSearch, const char prefix[]); 476 extern PetscErrorCode SNESLineSearchGetOptionsPrefix(SNESLineSearch, const char *prefix[]); 477 478 479 /* Shell interface functions */ 480 extern PetscErrorCode SNESLineSearchShellSetUserFunc(SNESLineSearch,SNESLineSearchUserFunc,void*); 481 extern PetscErrorCode SNESLineSearchShellGetUserFunc(SNESLineSearch,SNESLineSearchUserFunc*,void**); 482 483 /*register line search types */ 484 extern PetscErrorCode SNESLineSearchRegister(const char[],const char[],const char[],PetscErrorCode(*)(SNESLineSearch)); 485 extern PetscErrorCode SNESLineSearchRegisterAll(const char path[]); 486 extern PetscErrorCode SNESLineSearchRegisterDestroy(void); 487 488 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 489 #define SNESLineSearchRegisterDynamic(a,b,c,d) SNESLineSearchRegister(a,b,c,0) 490 #else 491 #define SNESLineSearchRegisterDynamic(a,b,c,d) SNESLineSearchRegister(a,b,c,d) 492 #endif 493 494 /* Routines for VI solver */ 495 extern PetscErrorCode SNESVISetVariableBounds(SNES,Vec,Vec); 496 extern PetscErrorCode SNESVISetComputeVariableBounds(SNES, PetscErrorCode (*)(SNES,Vec,Vec)); 497 extern PetscErrorCode SNESVIGetInactiveSet(SNES,IS*); 498 extern PetscErrorCode SNESVIGetActiveSetIS(SNES,Vec,Vec,IS*); 499 extern PetscErrorCode SNESVIComputeInactiveSetFnorm(SNES,Vec,Vec,PetscReal*); 500 extern PetscErrorCode SNESVISetRedundancyCheck(SNES,PetscErrorCode(*)(SNES,IS,IS*,void*),void*); 501 #define SNES_VI_INF 1.0e20 502 #define SNES_VI_NINF -1.0e20 503 504 extern PetscErrorCode SNESTestLocalMin(SNES); 505 506 /* Should this routine be private? */ 507 extern PetscErrorCode SNESComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*); 508 509 extern PetscErrorCode SNESSetDM(SNES,DM); 510 extern PetscErrorCode SNESGetDM(SNES,DM*); 511 extern PetscErrorCode SNESSetPC(SNES,SNES); 512 extern PetscErrorCode SNESGetPC(SNES,SNES*); 513 extern PetscErrorCode SNESSetSNESLineSearch(SNES,SNESLineSearch); 514 extern PetscErrorCode SNESGetSNESLineSearch(SNES,SNESLineSearch*); 515 extern PetscErrorCode SNESRestrictHookAdd(SNES,PetscErrorCode (*)(SNES,SNES,void*),void*); 516 extern PetscErrorCode SNESRestrictHooksRun(SNES,SNES); 517 518 extern PetscErrorCode SNESSetUpMatrices(SNES); 519 extern PetscErrorCode DMSNESSetFunction(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),void*); 520 extern PetscErrorCode DMSNESGetFunction(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),void**); 521 extern PetscErrorCode DMSNESSetGS(DM,PetscErrorCode(*)(SNES,Vec,Vec,void*),void*); 522 extern PetscErrorCode DMSNESGetGS(DM,PetscErrorCode(**)(SNES,Vec,Vec,void*),void**); 523 extern PetscErrorCode DMSNESSetJacobian(DM,PetscErrorCode(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void*); 524 extern PetscErrorCode DMSNESGetJacobian(DM,PetscErrorCode(**)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void**); 525 526 extern PetscErrorCode DMDASNESSetFunctionLocal(DM,PetscErrorCode(*)(DMDALocalInfo*,void*,void*,void*),void*); 527 extern PetscErrorCode DMDASNESSetJacobianLocal(DM,PetscErrorCode(*)(DMDALocalInfo*,void*,Mat,Mat,MatStructure*,void*),void*); 528 529 /* Routines for Multiblock solver */ 530 extern PetscErrorCode SNESMultiblockSetFields(SNES, const char [], PetscInt, const PetscInt *); 531 extern PetscErrorCode SNESMultiblockSetIS(SNES, const char [], IS); 532 extern PetscErrorCode SNESMultiblockSetBlockSize(SNES, PetscInt); 533 extern PetscErrorCode SNESMultiblockSetType(SNES, PCCompositeType); 534 535 /*J 536 SNESMSType - String with the name of a PETSc SNESMS method. 537 538 Level: intermediate 539 540 .seealso: SNESMSSetType(), SNES 541 J*/ 542 #define SNESMSType char* 543 #define SNESMSM62 "m62" 544 #define SNESMSEULER "euler" 545 #define SNESMSJAMESON83 "jameson83" 546 #define SNESMSVLTP21 "vltp21" 547 #define SNESMSVLTP31 "vltp31" 548 #define SNESMSVLTP41 "vltp41" 549 #define SNESMSVLTP51 "vltp51" 550 #define SNESMSVLTP61 "vltp61" 551 552 extern PetscErrorCode SNESMSRegister(const SNESMSType,PetscInt,PetscInt,PetscReal,const PetscReal[],const PetscReal[],const PetscReal[]); 553 extern PetscErrorCode SNESMSSetType(SNES,const SNESMSType); 554 extern PetscErrorCode SNESMSFinalizePackage(void); 555 extern PetscErrorCode SNESMSInitializePackage(const char path[]); 556 extern PetscErrorCode SNESMSRegisterDestroy(void); 557 extern PetscErrorCode SNESMSRegisterAll(void); 558 559 PETSC_EXTERN_CXX_END 560 #endif 561