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