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