1 /* $Id: petscsnes.h,v 1.108 2001/06/21 21:18:34 bsmith Exp bsmith $ */ 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,double,void*),void *,int (*)(void *)); 53 EXTERN int SNESClearMonitor(SNES); 54 EXTERN int SNESSetConvergenceHistory(SNES,double*,int *,int,PetscTruth); 55 EXTERN int SNESGetConvergenceHistory(SNES,double**,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 EXTERN int SNESSetTypeFromOptions(SNES); 81 82 EXTERN int MatCreateSNESMF(SNES,Vec,Mat*); 83 EXTERN int MatCreateMF(Vec,Mat*); 84 EXTERN int MatSNESMFSetBase(Mat,Vec); 85 EXTERN int MatSNESMFComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 86 EXTERN int MatSNESMFSetFunction(Mat,Vec,int(*)(SNES,Vec,Vec,void*),void*); 87 EXTERN int MatSNESMFSetFunctioni(Mat,int (*)(int,Vec,Scalar*,void*)); 88 EXTERN int MatSNESMFSetFunctioniBase(Mat,int (*)(Vec,void*)); 89 EXTERN int MatSNESMFAddNullSpace(Mat,MatNullSpace); 90 EXTERN int MatSNESMFSetHHistory(Mat,Scalar *,int); 91 EXTERN int MatSNESMFResetHHistory(Mat); 92 EXTERN int MatSNESMFSetFunctionError(Mat,double); 93 EXTERN int MatSNESMFSetPeriod(Mat,int); 94 EXTERN int MatSNESMFGetH(Mat,Scalar *); 95 EXTERN int MatSNESMFKSPMonitor(KSP,int,double,void *); 96 EXTERN int MatSNESMFSetFromOptions(Mat); 97 typedef struct _p_MatSNESMFCtx *MatSNESMFCtx; 98 99 #define MATSNESMF_DEFAULT "default" 100 #define MATSNESMF_WP "wp" 101 typedef char* MatSNESMFType; 102 EXTERN int MatSNESMFSetType(Mat,MatSNESMFType); 103 EXTERN int MatSNESMFRegister(char *,char *,char *,int (*)(MatSNESMFCtx)); 104 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 105 #define MatSNESMFRegisterDynamic(a,b,c,d) MatSNESMFRegister(a,b,c,0) 106 #else 107 #define MatSNESMFRegisterDynamic(a,b,c,d) MatSNESMFRegister(a,b,c,d) 108 #endif 109 EXTERN int MatSNESMFRegisterAll(char *); 110 EXTERN int MatSNESMFRegisterDestroy(void); 111 EXTERN int MatSNESMFDefaultSetUmin(Mat,PetscReal); 112 EXTERN int MatSNESMFWPSetComputeNormA(Mat,PetscTruth); 113 EXTERN int MatSNESMFWPSetComputeNormU(Mat,PetscTruth); 114 115 EXTERN int MatDAADSetSNES(Mat,SNES); 116 117 EXTERN int SNESGetType(SNES,SNESType*); 118 EXTERN int SNESDefaultMonitor(SNES,int,double,void *); 119 EXTERN int SNESRatioMonitor(SNES,int,double,void *); 120 EXTERN int SNESSetRatioMonitor(SNES); 121 EXTERN int SNESVecViewMonitor(SNES,int,double,void *); 122 EXTERN int SNESVecViewUpdateMonitor(SNES,int,double,void *); 123 EXTERN int SNESDefaultSMonitor(SNES,int,double,void *); 124 EXTERN int SNESSetTolerances(SNES,double,double,double,int,int); 125 EXTERN int SNESGetTolerances(SNES,double*,double*,double*,int*,int*); 126 EXTERN int SNESSetTrustRegionTolerance(SNES,double); 127 EXTERN int SNESGetIterationNumber(SNES,int*); 128 EXTERN int SNESGetFunctionNorm(SNES,Scalar*); 129 EXTERN int SNESGetNumberUnsuccessfulSteps(SNES,int*); 130 EXTERN int SNESGetNumberLinearIterations(SNES,int*); 131 EXTERN int SNES_KSP_SetParametersEW(SNES,int,double,double,double,double,double,double); 132 EXTERN int SNES_KSP_SetConvergenceTestEW(SNES); 133 134 /* 135 Reuse the default KSP monitor routines for SNES 136 */ 137 EXTERN int SNESLGMonitorCreate(char*,char*,int,int,int,int,PetscDrawLG*); 138 EXTERN int SNESLGMonitor(SNES,int,double,void*); 139 EXTERN int SNESLGMonitorDestroy(PetscDrawLG); 140 141 EXTERN int SNESSetApplicationContext(SNES,void *); 142 EXTERN int SNESGetApplicationContext(SNES,void **); 143 144 /*E 145 SNESConvergedReason - reason a SNES method was said to 146 have converged or diverged 147 148 Level: beginner 149 150 Notes: this must match finclude/petscsnes.h 151 152 .seealso: SNESSolve(), SNESGetConvergedReason(), KSPConvergedReason, SNESSetConvergenceTest() 153 E*/ 154 typedef enum {/* converged */ 155 SNES_CONVERGED_FNORM_ABS = 2, /* F < F_minabs */ 156 SNES_CONVERGED_FNORM_RELATIVE = 3, /* F < F_mintol*F_initial */ 157 SNES_CONVERGED_PNORM_RELATIVE = 4, /* step size small */ 158 SNES_CONVERGED_GNORM_ABS = 5, /* grad F < grad F_min */ 159 SNES_CONVERGED_TR_REDUCTION = 6, 160 SNES_CONVERGED_TR_DELTA = 7, 161 /* diverged */ 162 SNES_DIVERGED_FUNCTION_COUNT = -2, 163 SNES_DIVERGED_FNORM_NAN = -4, 164 SNES_DIVERGED_MAX_IT = -5, 165 SNES_DIVERGED_LS_FAILURE = -6, 166 SNES_DIVERGED_TR_REDUCTION = -7, 167 SNES_DIVERGED_LOCAL_MIN = -8, /* || J^T b || is small, implies converged to local minimum of F() */ 168 SNES_CONVERGED_ITERATING = 0} SNESConvergedReason; 169 170 EXTERN int SNESSetConvergenceTest(SNES,int (*)(SNES,double,double,double,SNESConvergedReason*,void*),void*); 171 EXTERN int SNESConverged_UM_LS(SNES,double,double,double,SNESConvergedReason*,void*); 172 EXTERN int SNESConverged_UM_TR(SNES,double,double,double,SNESConvergedReason*,void*); 173 EXTERN int SNESConverged_EQ_LS(SNES,double,double,double,SNESConvergedReason*,void*); 174 EXTERN int SNESConverged_EQ_TR(SNES,double,double,double,SNESConvergedReason*,void*); 175 EXTERN int SNESGetConvergedReason(SNES,SNESConvergedReason*); 176 177 EXTERN int SNESDAFormFunction(SNES,Vec,Vec,void*); 178 EXTERN int SNESDAComputeJacobianWithAdic(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 179 EXTERN int SNESDAComputeJacobianWithAdifor(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 180 EXTERN int SNESDAComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 181 182 /* --------- Solving systems of nonlinear equations --------------- */ 183 EXTERN int SNESSetFunction(SNES,Vec,int(*)(SNES,Vec,Vec,void*),void *); 184 EXTERN int SNESComputeFunction(SNES,Vec,Vec); 185 EXTERN int SNESSetJacobian(SNES,Mat,Mat,int(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *); 186 EXTERN int SNESGetJacobian(SNES,Mat*,Mat*,void **,int(**)(SNES,Vec,Mat*,Mat*,MatStructure*,void*)); 187 EXTERN int SNESDefaultComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 188 EXTERN int SNESDefaultComputeJacobianColor(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 189 EXTERN int SNESSetLineSearch(SNES,int(*)(SNES,void*,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*),void*); 190 EXTERN int SNESNoLineSearch(SNES,void*,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 191 EXTERN int SNESNoLineSearchNoNorms(SNES,void*,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 192 EXTERN int SNESCubicLineSearch(SNES,void*,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 193 EXTERN int SNESQuadraticLineSearch(SNES,void*,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 194 EXTERN int SNESSetLineSearchCheck(SNES,int(*)(SNES,void*,Vec,PetscTruth*),void*); 195 EXTERN int SNESSetLineSearchParams(SNES,double,double,double); 196 EXTERN int SNESGetLineSearchParams(SNES,double*,double*,double*); 197 198 /* --------- Unconstrained minimization routines --------------------------------*/ 199 EXTERN int SNESSetHessian(SNES,Mat,Mat,int(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *); 200 EXTERN int SNESGetHessian(SNES,Mat*,Mat*,void **); 201 EXTERN int SNESDefaultComputeHessian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 202 EXTERN int SNESDefaultComputeHessianColor(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 203 EXTERN int SNESSetGradient(SNES,Vec,int(*)(SNES,Vec,Vec,void*),void*); 204 EXTERN int SNESGetGradient(SNES,Vec*,void**); 205 EXTERN int SNESGetGradientNorm(SNES,Scalar*); 206 EXTERN int SNESComputeGradient(SNES,Vec,Vec); 207 EXTERN int SNESSetMinimizationFunction(SNES,int(*)(SNES,Vec,double*,void*),void*); 208 EXTERN int SNESComputeMinimizationFunction(SNES,Vec,double*); 209 EXTERN int SNESGetMinimizationFunction(SNES,double*,void**); 210 EXTERN int SNESSetMinimizationFunctionTolerance(SNES,double); 211 EXTERN int SNESLineSearchSetDampingParameter(SNES,Scalar*); 212 213 214 /* Should these 2 routines be private? */ 215 EXTERN int SNESComputeHessian(SNES,Vec,Mat*,Mat*,MatStructure*); 216 EXTERN int SNESComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*); 217 218 #endif 219 220