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 #ifdef PETSC_USE_NEW_LOGGING 40 /* Logging support */ 41 extern int SNES_COOKIE; 42 enum {SNES_Solve, SNES_LineSearch, SNES_FunctionEval, SNES_JacobianEval, SNES_MinimizationFunctionEval, SNES_GradientEval, 43 SNES_HessianEval, SNES_KrylovOrthogonalization, SNES_MAX_EVENTS}; 44 extern int SNESEvents[SNES_MAX_EVENTS]; 45 #define SNESLogEventBegin(e,o1,o2,o3,o4) PetscLogEventBegin(SNESEvents[e],o1,o2,o3,o4) 46 #define SNESLogEventEnd(e,o1,o2,o3,o4) PetscLogEventEnd(SNESEvents[e],o1,o2,o3,o4) 47 48 #else 49 50 #define SNESLogEventBegin(e,o1,o2,o3,o4) PetscLogEventBegin(e,o1,o2,o3,o4) 51 #define SNESLogEventEnd(e,o1,o2,o3,o4) PetscLogEventEnd(e,o1,o2,o3,o4) 52 #endif 53 54 /*E 55 SNESProblemType - Determines the type of problem this SNES object is to be used to solve 56 57 Level: beginner 58 59 .seealso: SNESCreate(), SNESGetProblemType() 60 E*/ 61 typedef enum {SNES_NONLINEAR_EQUATIONS,SNES_UNCONSTRAINED_MINIMIZATION,SNES_LEAST_SQUARES} SNESProblemType; 62 63 EXTERN int SNESCreate(MPI_Comm,SNESProblemType,SNES*); 64 EXTERN int SNESGetProblemType(SNES,SNESProblemType*); 65 EXTERN int SNESDestroy(SNES); 66 EXTERN int SNESSetType(SNES,SNESType); 67 EXTERN int SNESSetMonitor(SNES,int(*)(SNES,int,PetscReal,void*),void *,int (*)(void *)); 68 EXTERN int SNESClearMonitor(SNES); 69 EXTERN int SNESSetConvergenceHistory(SNES,PetscReal*,int *,int,PetscTruth); 70 EXTERN int SNESGetConvergenceHistory(SNES,PetscReal**,int **,int *); 71 EXTERN int SNESSetUp(SNES,Vec); 72 EXTERN int SNESSolve(SNES,Vec,int*); 73 74 extern PetscFList SNESList; 75 EXTERN int SNESRegisterDestroy(void); 76 EXTERN int SNESRegisterAll(char *); 77 78 EXTERN int SNESRegister(char*,char*,char*,int(*)(SNES)); 79 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 80 #define SNESRegisterDynamic(a,b,c,d) SNESRegister(a,b,c,0) 81 #else 82 #define SNESRegisterDynamic(a,b,c,d) SNESRegister(a,b,c,d) 83 #endif 84 85 EXTERN int SNESGetSLES(SNES,SLES*); 86 EXTERN int SNESGetSolution(SNES,Vec*); 87 EXTERN int SNESGetSolutionUpdate(SNES,Vec*); 88 EXTERN int SNESGetFunction(SNES,Vec*,void**,int(**)(SNES,Vec,Vec,void*)); 89 EXTERN int SNESView(SNES,PetscViewer); 90 91 EXTERN int SNESSetOptionsPrefix(SNES,char*); 92 EXTERN int SNESAppendOptionsPrefix(SNES,char*); 93 EXTERN int SNESGetOptionsPrefix(SNES,char**); 94 EXTERN int SNESSetFromOptions(SNES); 95 96 EXTERN int MatCreateSNESMF(SNES,Vec,Mat*); 97 EXTERN int MatCreateMF(Vec,Mat*); 98 EXTERN int MatSNESMFSetBase(Mat,Vec); 99 EXTERN int MatSNESMFComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 100 EXTERN int MatSNESMFSetFunction(Mat,Vec,int(*)(SNES,Vec,Vec,void*),void*); 101 EXTERN int MatSNESMFSetFunctioni(Mat,int (*)(int,Vec,PetscScalar*,void*)); 102 EXTERN int MatSNESMFSetFunctioniBase(Mat,int (*)(Vec,void*)); 103 EXTERN int MatSNESMFAddNullSpace(Mat,MatNullSpace); 104 EXTERN int MatSNESMFSetHHistory(Mat,PetscScalar *,int); 105 EXTERN int MatSNESMFResetHHistory(Mat); 106 EXTERN int MatSNESMFSetFunctionError(Mat,PetscReal); 107 EXTERN int MatSNESMFSetPeriod(Mat,int); 108 EXTERN int MatSNESMFGetH(Mat,PetscScalar *); 109 EXTERN int MatSNESMFKSPMonitor(KSP,int,PetscReal,void *); 110 EXTERN int MatSNESMFSetFromOptions(Mat); 111 typedef struct _p_MatSNESMFCtx *MatSNESMFCtx; 112 113 #define MATSNESMF_DEFAULT "default" 114 #define MATSNESMF_WP "wp" 115 typedef char* MatSNESMFType; 116 EXTERN int MatSNESMFSetType(Mat,MatSNESMFType); 117 EXTERN int MatSNESMFRegister(char *,char *,char *,int (*)(MatSNESMFCtx)); 118 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 119 #define MatSNESMFRegisterDynamic(a,b,c,d) MatSNESMFRegister(a,b,c,0) 120 #else 121 #define MatSNESMFRegisterDynamic(a,b,c,d) MatSNESMFRegister(a,b,c,d) 122 #endif 123 EXTERN int MatSNESMFRegisterAll(char *); 124 EXTERN int MatSNESMFRegisterDestroy(void); 125 EXTERN int MatSNESMFDefaultSetUmin(Mat,PetscReal); 126 EXTERN int MatSNESMFWPSetComputeNormA(Mat,PetscTruth); 127 EXTERN int MatSNESMFWPSetComputeNormU(Mat,PetscTruth); 128 129 EXTERN int MatDAADSetSNES(Mat,SNES); 130 131 EXTERN int SNESGetType(SNES,SNESType*); 132 EXTERN int SNESDefaultMonitor(SNES,int,PetscReal,void *); 133 EXTERN int SNESRatioMonitor(SNES,int,PetscReal,void *); 134 EXTERN int SNESSetRatioMonitor(SNES); 135 EXTERN int SNESVecViewMonitor(SNES,int,PetscReal,void *); 136 EXTERN int SNESVecViewUpdateMonitor(SNES,int,PetscReal,void *); 137 EXTERN int SNESDefaultSMonitor(SNES,int,PetscReal,void *); 138 EXTERN int SNESSetTolerances(SNES,PetscReal,PetscReal,PetscReal,int,int); 139 EXTERN int SNESGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,int*,int*); 140 EXTERN int SNESSetTrustRegionTolerance(SNES,PetscReal); 141 EXTERN int SNESGetIterationNumber(SNES,int*); 142 EXTERN int SNESGetFunctionNorm(SNES,PetscScalar*); 143 EXTERN int SNESGetNumberUnsuccessfulSteps(SNES,int*); 144 EXTERN int SNESGetNumberLinearIterations(SNES,int*); 145 EXTERN int SNES_KSP_SetParametersEW(SNES,int,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal); 146 EXTERN int SNES_KSP_SetConvergenceTestEW(SNES); 147 148 /* 149 Reuse the default KSP monitor routines for SNES 150 */ 151 EXTERN int SNESLGMonitorCreate(char*,char*,int,int,int,int,PetscDrawLG*); 152 EXTERN int SNESLGMonitor(SNES,int,PetscReal,void*); 153 EXTERN int SNESLGMonitorDestroy(PetscDrawLG); 154 155 EXTERN int SNESSetApplicationContext(SNES,void *); 156 EXTERN int SNESGetApplicationContext(SNES,void **); 157 158 /*E 159 SNESConvergedReason - reason a SNES method was said to 160 have converged or diverged 161 162 Level: beginner 163 164 Notes: this must match finclude/petscsnes.h 165 166 .seealso: SNESSolve(), SNESGetConvergedReason(), KSPConvergedReason, SNESSetConvergenceTest() 167 E*/ 168 typedef enum {/* converged */ 169 SNES_CONVERGED_FNORM_ABS = 2, /* F < F_minabs */ 170 SNES_CONVERGED_FNORM_RELATIVE = 3, /* F < F_mintol*F_initial */ 171 SNES_CONVERGED_PNORM_RELATIVE = 4, /* step size small */ 172 SNES_CONVERGED_GNORM_ABS = 5, /* grad F < grad F_min */ 173 SNES_CONVERGED_TR_REDUCTION = 6, 174 SNES_CONVERGED_TR_DELTA = 7, 175 /* diverged */ 176 SNES_DIVERGED_FUNCTION_COUNT = -2, 177 SNES_DIVERGED_FNORM_NAN = -4, 178 SNES_DIVERGED_MAX_IT = -5, 179 SNES_DIVERGED_LS_FAILURE = -6, 180 SNES_DIVERGED_TR_REDUCTION = -7, 181 SNES_DIVERGED_LOCAL_MIN = -8, /* || J^T b || is small, implies converged to local minimum of F() */ 182 SNES_CONVERGED_ITERATING = 0} SNESConvergedReason; 183 184 EXTERN int SNESSetConvergenceTest(SNES,int (*)(SNES,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void*); 185 EXTERN int SNESConverged_UM_LS(SNES,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*); 186 EXTERN int SNESConverged_UM_TR(SNES,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*); 187 EXTERN int SNESConverged_EQ_LS(SNES,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*); 188 EXTERN int SNESConverged_EQ_TR(SNES,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*); 189 EXTERN int SNESGetConvergedReason(SNES,SNESConvergedReason*); 190 191 EXTERN int SNESDAFormFunction(SNES,Vec,Vec,void*); 192 EXTERN int SNESDAComputeJacobianWithAdic(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 193 EXTERN int SNESDAComputeJacobianWithAdifor(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 194 EXTERN int SNESDAComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 195 196 /* --------- Solving systems of nonlinear equations --------------- */ 197 EXTERN int SNESSetFunction(SNES,Vec,int(*)(SNES,Vec,Vec,void*),void *); 198 EXTERN int SNESComputeFunction(SNES,Vec,Vec); 199 EXTERN int SNESSetJacobian(SNES,Mat,Mat,int(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *); 200 EXTERN int SNESGetJacobian(SNES,Mat*,Mat*,void **,int(**)(SNES,Vec,Mat*,Mat*,MatStructure*,void*)); 201 EXTERN int SNESDefaultComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 202 EXTERN int SNESDefaultComputeJacobianColor(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 203 EXTERN int SNESSetLineSearch(SNES,int(*)(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,int*),void*); 204 EXTERN int SNESNoLineSearch(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,int*); 205 EXTERN int SNESNoLineSearchNoNorms(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,int*); 206 EXTERN int SNESCubicLineSearch(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,int*); 207 EXTERN int SNESQuadraticLineSearch(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,int*); 208 EXTERN int SNESSetLineSearchCheck(SNES,int(*)(SNES,void*,Vec,PetscTruth*),void*); 209 EXTERN int SNESSetLineSearchParams(SNES,PetscReal,PetscReal,PetscReal); 210 EXTERN int SNESGetLineSearchParams(SNES,PetscReal*,PetscReal*,PetscReal*); 211 212 /* --------- Unconstrained minimization routines --------------------------------*/ 213 EXTERN int SNESSetHessian(SNES,Mat,Mat,int(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *); 214 EXTERN int SNESGetHessian(SNES,Mat*,Mat*,void **); 215 EXTERN int SNESDefaultComputeHessian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 216 EXTERN int SNESDefaultComputeHessianColor(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 217 EXTERN int SNESSetGradient(SNES,Vec,int(*)(SNES,Vec,Vec,void*),void*); 218 EXTERN int SNESGetGradient(SNES,Vec*,void**); 219 EXTERN int SNESGetGradientNorm(SNES,PetscScalar*); 220 EXTERN int SNESComputeGradient(SNES,Vec,Vec); 221 EXTERN int SNESSetMinimizationFunction(SNES,int(*)(SNES,Vec,PetscReal*,void*),void*); 222 EXTERN int SNESComputeMinimizationFunction(SNES,Vec,PetscReal*); 223 EXTERN int SNESGetMinimizationFunction(SNES,PetscReal*,void**); 224 EXTERN int SNESSetMinimizationFunctionTolerance(SNES,PetscReal); 225 EXTERN int SNESLineSearchSetDampingParameter(SNES,PetscScalar*); 226 227 228 /* Should these 2 routines be private? */ 229 EXTERN int SNESComputeHessian(SNES,Vec,Mat*,Mat*,MatStructure*); 230 EXTERN int SNESComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*); 231 232 #endif 233 234