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