1 /* $Id: petscsnes.h,v 1.111 2001/08/06 21:17:05 bsmith Exp $ */ 2 /* 3 User interface for the nonlinear solvers and unconstrained minimization package. 4 */ 5 #if !defined(__PETSCSNES_H) 6 #define __PETSCSNES_H 7 #include "petscsles.h" 8 9 /*S 10 SNES - Abstract PETSc object that manages all nonlinear solves 11 12 Level: beginner 13 14 Concepts: nonlinear solvers 15 16 .seealso: SNESCreate(), SNESSetType(), SNESType, TS, SLES, KSP, PC, SNESProblemType 17 S*/ 18 typedef struct _p_SNES* SNES; 19 20 #define SNES_COOKIE PETSC_COOKIE+13 21 #define MATSNESMFCTX_COOKIE PETSC_COOKIE+29 22 23 /*E 24 SNESType - String with the name of a PETSc SNES method or the creation function 25 with an optional dynamic library name, for example 26 http://www.mcs.anl.gov/petsc/lib.a:mysnescreate() 27 28 Level: beginner 29 30 .seealso: SNESSetType(), SNES 31 E*/ 32 #define SNESEQLS "ls" 33 #define SNESEQTR "tr" 34 #define SNESEQTEST "test" 35 #define SNESUMLS "umls" 36 #define SNESUMTR "umtr" 37 typedef char *SNESType; 38 39 /*E 40 SNESProblemType - Determines the type of problem this SNES object is to be used to solve 41 42 Level: beginner 43 44 .seealso: SNESCreate(), SNESGetProblemType() 45 E*/ 46 typedef enum {SNES_NONLINEAR_EQUATIONS,SNES_UNCONSTRAINED_MINIMIZATION,SNES_LEAST_SQUARES} SNESProblemType; 47 48 EXTERN int SNESCreate(MPI_Comm,SNESProblemType,SNES*); 49 EXTERN int SNESGetProblemType(SNES,SNESProblemType*); 50 EXTERN int SNESDestroy(SNES); 51 EXTERN int SNESSetType(SNES,SNESType); 52 EXTERN int SNESSetMonitor(SNES,int(*)(SNES,int,PetscReal,void*),void *,int (*)(void *)); 53 EXTERN int SNESClearMonitor(SNES); 54 EXTERN int SNESSetConvergenceHistory(SNES,PetscReal*,int *,int,PetscTruth); 55 EXTERN int SNESGetConvergenceHistory(SNES,PetscReal**,int **,int *); 56 EXTERN int SNESSetUp(SNES,Vec); 57 EXTERN int SNESSolve(SNES,Vec,int*); 58 59 extern PetscFList SNESList; 60 EXTERN int SNESRegisterDestroy(void); 61 EXTERN int SNESRegisterAll(char *); 62 63 EXTERN int SNESRegister(char*,char*,char*,int(*)(SNES)); 64 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 65 #define SNESRegisterDynamic(a,b,c,d) SNESRegister(a,b,c,0) 66 #else 67 #define SNESRegisterDynamic(a,b,c,d) SNESRegister(a,b,c,d) 68 #endif 69 70 EXTERN int SNESGetSLES(SNES,SLES*); 71 EXTERN int SNESGetSolution(SNES,Vec*); 72 EXTERN int SNESGetSolutionUpdate(SNES,Vec*); 73 EXTERN int SNESGetFunction(SNES,Vec*,void**,int(**)(SNES,Vec,Vec,void*)); 74 EXTERN int SNESView(SNES,PetscViewer); 75 76 EXTERN int SNESSetOptionsPrefix(SNES,char*); 77 EXTERN int SNESAppendOptionsPrefix(SNES,char*); 78 EXTERN int SNESGetOptionsPrefix(SNES,char**); 79 EXTERN int SNESSetFromOptions(SNES); 80 81 EXTERN int MatCreateSNESMF(SNES,Vec,Mat*); 82 EXTERN int MatCreateMF(Vec,Mat*); 83 EXTERN int MatSNESMFSetBase(Mat,Vec); 84 EXTERN int MatSNESMFComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 85 EXTERN int MatSNESMFSetFunction(Mat,Vec,int(*)(SNES,Vec,Vec,void*),void*); 86 EXTERN int MatSNESMFSetFunctioni(Mat,int (*)(int,Vec,PetscScalar*,void*)); 87 EXTERN int MatSNESMFSetFunctioniBase(Mat,int (*)(Vec,void*)); 88 EXTERN int MatSNESMFAddNullSpace(Mat,MatNullSpace); 89 EXTERN int MatSNESMFSetHHistory(Mat,PetscScalar *,int); 90 EXTERN int MatSNESMFResetHHistory(Mat); 91 EXTERN int MatSNESMFSetFunctionError(Mat,PetscReal); 92 EXTERN int MatSNESMFSetPeriod(Mat,int); 93 EXTERN int MatSNESMFGetH(Mat,PetscScalar *); 94 EXTERN int MatSNESMFKSPMonitor(KSP,int,PetscReal,void *); 95 EXTERN int MatSNESMFSetFromOptions(Mat); 96 typedef struct _p_MatSNESMFCtx *MatSNESMFCtx; 97 98 #define MATSNESMF_DEFAULT "default" 99 #define MATSNESMF_WP "wp" 100 typedef char* MatSNESMFType; 101 EXTERN int MatSNESMFSetType(Mat,MatSNESMFType); 102 EXTERN int MatSNESMFRegister(char *,char *,char *,int (*)(MatSNESMFCtx)); 103 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 104 #define MatSNESMFRegisterDynamic(a,b,c,d) MatSNESMFRegister(a,b,c,0) 105 #else 106 #define MatSNESMFRegisterDynamic(a,b,c,d) MatSNESMFRegister(a,b,c,d) 107 #endif 108 EXTERN int MatSNESMFRegisterAll(char *); 109 EXTERN int MatSNESMFRegisterDestroy(void); 110 EXTERN int MatSNESMFDefaultSetUmin(Mat,PetscReal); 111 EXTERN int MatSNESMFWPSetComputeNormA(Mat,PetscTruth); 112 EXTERN int MatSNESMFWPSetComputeNormU(Mat,PetscTruth); 113 114 EXTERN int MatDAADSetSNES(Mat,SNES); 115 116 EXTERN int SNESGetType(SNES,SNESType*); 117 EXTERN int SNESDefaultMonitor(SNES,int,PetscReal,void *); 118 EXTERN int SNESRatioMonitor(SNES,int,PetscReal,void *); 119 EXTERN int SNESSetRatioMonitor(SNES); 120 EXTERN int SNESVecViewMonitor(SNES,int,PetscReal,void *); 121 EXTERN int SNESVecViewUpdateMonitor(SNES,int,PetscReal,void *); 122 EXTERN int SNESDefaultSMonitor(SNES,int,PetscReal,void *); 123 EXTERN int SNESSetTolerances(SNES,PetscReal,PetscReal,PetscReal,int,int); 124 EXTERN int SNESGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,int*,int*); 125 EXTERN int SNESSetTrustRegionTolerance(SNES,PetscReal); 126 EXTERN int SNESGetIterationNumber(SNES,int*); 127 EXTERN int SNESGetFunctionNorm(SNES,PetscScalar*); 128 EXTERN int SNESGetNumberUnsuccessfulSteps(SNES,int*); 129 EXTERN int SNESGetNumberLinearIterations(SNES,int*); 130 EXTERN int SNES_KSP_SetParametersEW(SNES,int,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal); 131 EXTERN int SNES_KSP_SetConvergenceTestEW(SNES); 132 133 /* 134 Reuse the default KSP monitor routines for SNES 135 */ 136 EXTERN int SNESLGMonitorCreate(char*,char*,int,int,int,int,PetscDrawLG*); 137 EXTERN int SNESLGMonitor(SNES,int,PetscReal,void*); 138 EXTERN int SNESLGMonitorDestroy(PetscDrawLG); 139 140 EXTERN int SNESSetApplicationContext(SNES,void *); 141 EXTERN int SNESGetApplicationContext(SNES,void **); 142 143 /*E 144 SNESConvergedReason - reason a SNES method was said to 145 have converged or diverged 146 147 Level: beginner 148 149 Notes: this must match finclude/petscsnes.h 150 151 .seealso: SNESSolve(), SNESGetConvergedReason(), KSPConvergedReason, SNESSetConvergenceTest() 152 E*/ 153 typedef enum {/* converged */ 154 SNES_CONVERGED_FNORM_ABS = 2, /* F < F_minabs */ 155 SNES_CONVERGED_FNORM_RELATIVE = 3, /* F < F_mintol*F_initial */ 156 SNES_CONVERGED_PNORM_RELATIVE = 4, /* step size small */ 157 SNES_CONVERGED_GNORM_ABS = 5, /* grad F < grad F_min */ 158 SNES_CONVERGED_TR_REDUCTION = 6, 159 SNES_CONVERGED_TR_DELTA = 7, 160 /* diverged */ 161 SNES_DIVERGED_FUNCTION_COUNT = -2, 162 SNES_DIVERGED_FNORM_NAN = -4, 163 SNES_DIVERGED_MAX_IT = -5, 164 SNES_DIVERGED_LS_FAILURE = -6, 165 SNES_DIVERGED_TR_REDUCTION = -7, 166 SNES_DIVERGED_LOCAL_MIN = -8, /* || J^T b || is small, implies converged to local minimum of F() */ 167 SNES_CONVERGED_ITERATING = 0} SNESConvergedReason; 168 169 EXTERN int SNESSetConvergenceTest(SNES,int (*)(SNES,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void*); 170 EXTERN int SNESConverged_UM_LS(SNES,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*); 171 EXTERN int SNESConverged_UM_TR(SNES,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*); 172 EXTERN int SNESConverged_EQ_LS(SNES,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*); 173 EXTERN int SNESConverged_EQ_TR(SNES,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*); 174 EXTERN int SNESGetConvergedReason(SNES,SNESConvergedReason*); 175 176 EXTERN int SNESDAFormFunction(SNES,Vec,Vec,void*); 177 EXTERN int SNESDAComputeJacobianWithAdic(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 178 EXTERN int SNESDAComputeJacobianWithAdifor(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 179 EXTERN int SNESDAComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 180 181 /* --------- Solving systems of nonlinear equations --------------- */ 182 EXTERN int SNESSetFunction(SNES,Vec,int(*)(SNES,Vec,Vec,void*),void *); 183 EXTERN int SNESComputeFunction(SNES,Vec,Vec); 184 EXTERN int SNESSetJacobian(SNES,Mat,Mat,int(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *); 185 EXTERN int SNESGetJacobian(SNES,Mat*,Mat*,void **,int(**)(SNES,Vec,Mat*,Mat*,MatStructure*,void*)); 186 EXTERN int SNESDefaultComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 187 EXTERN int SNESDefaultComputeJacobianColor(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 188 EXTERN int SNESSetLineSearch(SNES,int(*)(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,int*),void*); 189 EXTERN int SNESNoLineSearch(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,int*); 190 EXTERN int SNESNoLineSearchNoNorms(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,int*); 191 EXTERN int SNESCubicLineSearch(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,int*); 192 EXTERN int SNESQuadraticLineSearch(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,int*); 193 EXTERN int SNESSetLineSearchCheck(SNES,int(*)(SNES,void*,Vec,PetscTruth*),void*); 194 EXTERN int SNESSetLineSearchParams(SNES,PetscReal,PetscReal,PetscReal); 195 EXTERN int SNESGetLineSearchParams(SNES,PetscReal*,PetscReal*,PetscReal*); 196 197 /* --------- Unconstrained minimization routines --------------------------------*/ 198 EXTERN int SNESSetHessian(SNES,Mat,Mat,int(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *); 199 EXTERN int SNESGetHessian(SNES,Mat*,Mat*,void **); 200 EXTERN int SNESDefaultComputeHessian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 201 EXTERN int SNESDefaultComputeHessianColor(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 202 EXTERN int SNESSetGradient(SNES,Vec,int(*)(SNES,Vec,Vec,void*),void*); 203 EXTERN int SNESGetGradient(SNES,Vec*,void**); 204 EXTERN int SNESGetGradientNorm(SNES,PetscScalar*); 205 EXTERN int SNESComputeGradient(SNES,Vec,Vec); 206 EXTERN int SNESSetMinimizationFunction(SNES,int(*)(SNES,Vec,PetscReal*,void*),void*); 207 EXTERN int SNESComputeMinimizationFunction(SNES,Vec,PetscReal*); 208 EXTERN int SNESGetMinimizationFunction(SNES,PetscReal*,void**); 209 EXTERN int SNESSetMinimizationFunctionTolerance(SNES,PetscReal); 210 EXTERN int SNESLineSearchSetDampingParameter(SNES,PetscScalar*); 211 212 213 /* Should these 2 routines be private? */ 214 EXTERN int SNESComputeHessian(SNES,Vec,Mat*,Mat*,MatStructure*); 215 EXTERN int SNESComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*); 216 217 #endif 218 219