1 /* $Id: petscsnes.h,v 1.111 2001/08/06 21:17:05 bsmith Exp $ */ 2 /* 3 User interface for the nonlinear solvers 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 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 SNESLS "ls" 30 #define SNESTR "tr" 31 #define SNESTEST "test" 32 typedef char *SNESType; 33 34 /* Logging support */ 35 extern int SNES_COOKIE; 36 extern int MATSNESMFCTX_COOKIE; 37 extern int SNES_Solve, SNES_LineSearch, SNES_FunctionEval, SNES_JacobianEval; 38 39 40 EXTERN int SNESInitializePackage(char *); 41 42 EXTERN int SNESCreate(MPI_Comm,SNES*); 43 EXTERN int SNESDestroy(SNES); 44 EXTERN int SNESSetType(SNES,SNESType); 45 EXTERN int SNESSetMonitor(SNES,int(*)(SNES,int,PetscReal,void*),void *,int (*)(void *)); 46 EXTERN int SNESClearMonitor(SNES); 47 EXTERN int SNESSetConvergenceHistory(SNES,PetscReal*,int *,int,PetscTruth); 48 EXTERN int SNESGetConvergenceHistory(SNES,PetscReal**,int **,int *); 49 EXTERN int SNESSetUp(SNES,Vec); 50 EXTERN int SNESSolve(SNES,Vec,int*); 51 52 EXTERN int SNESAddOptionsChecker(int (*)(SNES)); 53 54 EXTERN int SNESSetRhsBC(SNES, int (*)(SNES, Vec, void *)); 55 EXTERN int SNESDefaultRhsBC(SNES, Vec, void *); 56 EXTERN int SNESSetSolutionBC(SNES, int (*)(SNES, Vec, void *)); 57 EXTERN int SNESDefaultSolutionBC(SNES, Vec, void *); 58 EXTERN int SNESSetUpdate(SNES, int (*)(SNES, int)); 59 EXTERN int SNESDefaultUpdate(SNES, int); 60 61 extern PetscFList SNESList; 62 EXTERN int SNESRegisterDestroy(void); 63 EXTERN int SNESRegisterAll(char *); 64 65 EXTERN int SNESRegister(char*,char*,char*,int(*)(SNES)); 66 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 67 #define SNESRegisterDynamic(a,b,c,d) SNESRegister(a,b,c,0) 68 #else 69 #define SNESRegisterDynamic(a,b,c,d) SNESRegister(a,b,c,d) 70 #endif 71 72 EXTERN int SNESGetSLES(SNES,SLES*); 73 EXTERN int SNESGetSolution(SNES,Vec*); 74 EXTERN int SNESGetSolutionUpdate(SNES,Vec*); 75 EXTERN int SNESGetFunction(SNES,Vec*,void**,int(**)(SNES,Vec,Vec,void*)); 76 EXTERN int SNESView(SNES,PetscViewer); 77 78 EXTERN int SNESSetOptionsPrefix(SNES,char*); 79 EXTERN int SNESAppendOptionsPrefix(SNES,char*); 80 EXTERN int SNESGetOptionsPrefix(SNES,char**); 81 EXTERN int SNESSetFromOptions(SNES); 82 83 EXTERN int MatCreateSNESMF(SNES,Vec,Mat*); 84 EXTERN int MatCreateMF(Vec,Mat*); 85 EXTERN int MatSNESMFSetBase(Mat,Vec); 86 EXTERN int MatSNESMFComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 87 EXTERN int MatSNESMFSetFunction(Mat,Vec,int(*)(SNES,Vec,Vec,void*),void*); 88 EXTERN int MatSNESMFSetFunctioni(Mat,int (*)(int,Vec,PetscScalar*,void*)); 89 EXTERN int MatSNESMFSetFunctioniBase(Mat,int (*)(Vec,void*)); 90 EXTERN int MatSNESMFAddNullSpace(Mat,MatNullSpace); 91 EXTERN int MatSNESMFSetHHistory(Mat,PetscScalar *,int); 92 EXTERN int MatSNESMFResetHHistory(Mat); 93 EXTERN int MatSNESMFSetFunctionError(Mat,PetscReal); 94 EXTERN int MatSNESMFSetPeriod(Mat,int); 95 EXTERN int MatSNESMFGetH(Mat,PetscScalar *); 96 EXTERN int MatSNESMFKSPMonitor(KSP,int,PetscReal,void *); 97 EXTERN int MatSNESMFSetFromOptions(Mat); 98 typedef struct _p_MatSNESMFCtx *MatSNESMFCtx; 99 100 #define MATSNESMF_DEFAULT "default" 101 #define MATSNESMF_WP "wp" 102 typedef char* MatSNESMFType; 103 EXTERN int MatSNESMFSetType(Mat,MatSNESMFType); 104 EXTERN int MatSNESMFRegister(char *,char *,char *,int (*)(MatSNESMFCtx)); 105 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 106 #define MatSNESMFRegisterDynamic(a,b,c,d) MatSNESMFRegister(a,b,c,0) 107 #else 108 #define MatSNESMFRegisterDynamic(a,b,c,d) MatSNESMFRegister(a,b,c,d) 109 #endif 110 EXTERN int MatSNESMFRegisterAll(char *); 111 EXTERN int MatSNESMFRegisterDestroy(void); 112 EXTERN int MatSNESMFDefaultSetUmin(Mat,PetscReal); 113 EXTERN int MatSNESMFWPSetComputeNormA(Mat,PetscTruth); 114 EXTERN int MatSNESMFWPSetComputeNormU(Mat,PetscTruth); 115 116 EXTERN int MatDAADSetSNES(Mat,SNES); 117 118 EXTERN int SNESGetType(SNES,SNESType*); 119 EXTERN int SNESDefaultMonitor(SNES,int,PetscReal,void *); 120 EXTERN int SNESRatioMonitor(SNES,int,PetscReal,void *); 121 EXTERN int SNESSetRatioMonitor(SNES); 122 EXTERN int SNESVecViewMonitor(SNES,int,PetscReal,void *); 123 EXTERN int SNESVecViewResidualMonitor(SNES,int,PetscReal,void *); 124 EXTERN int SNESVecViewUpdateMonitor(SNES,int,PetscReal,void *); 125 EXTERN int SNESDefaultSMonitor(SNES,int,PetscReal,void *); 126 EXTERN int SNESSetTolerances(SNES,PetscReal,PetscReal,PetscReal,int,int); 127 EXTERN int SNESGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,int*,int*); 128 EXTERN int SNESSetTrustRegionTolerance(SNES,PetscReal); 129 EXTERN int SNESGetIterationNumber(SNES,int*); 130 EXTERN int SNESGetFunctionNorm(SNES,PetscScalar*); 131 EXTERN int SNESGetNumberUnsuccessfulSteps(SNES,int*); 132 EXTERN int SNESSetMaximumUnsuccessfulSteps(SNES,int); 133 EXTERN int SNESGetMaximumUnsuccessfulSteps(SNES,int*); 134 EXTERN int SNESGetNumberLinearIterations(SNES,int*); 135 EXTERN int SNES_KSP_SetParametersEW(SNES,int,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal); 136 EXTERN int SNES_KSP_SetConvergenceTestEW(SNES); 137 138 /* 139 Reuse the default KSP monitor routines for SNES 140 */ 141 EXTERN int SNESLGMonitorCreate(char*,char*,int,int,int,int,PetscDrawLG*); 142 EXTERN int SNESLGMonitor(SNES,int,PetscReal,void*); 143 EXTERN int SNESLGMonitorDestroy(PetscDrawLG); 144 145 EXTERN int SNESSetApplicationContext(SNES,void *); 146 EXTERN int SNESGetApplicationContext(SNES,void **); 147 148 /*E 149 SNESConvergedReason - reason a SNES method was said to 150 have converged or diverged 151 152 Level: beginner 153 154 Notes: this must match finclude/petscsnes.h 155 156 .seealso: SNESSolve(), SNESGetConvergedReason(), KSPConvergedReason, SNESSetConvergenceTest() 157 E*/ 158 typedef enum {/* converged */ 159 SNES_CONVERGED_FNORM_ABS = 2, /* F < F_minabs */ 160 SNES_CONVERGED_FNORM_RELATIVE = 3, /* F < F_mintol*F_initial */ 161 SNES_CONVERGED_PNORM_RELATIVE = 4, /* step size small */ 162 SNES_CONVERGED_GNORM_ABS = 5, /* grad F < grad F_min */ 163 SNES_CONVERGED_TR_REDUCTION = 6, 164 SNES_CONVERGED_TR_DELTA = 7, 165 /* diverged */ 166 SNES_DIVERGED_FUNCTION_COUNT = -2, 167 SNES_DIVERGED_FNORM_NAN = -4, 168 SNES_DIVERGED_MAX_IT = -5, 169 SNES_DIVERGED_LS_FAILURE = -6, 170 SNES_DIVERGED_TR_REDUCTION = -7, 171 SNES_DIVERGED_LOCAL_MIN = -8, /* || J^T b || is small, implies converged to local minimum of F() */ 172 SNES_CONVERGED_ITERATING = 0} SNESConvergedReason; 173 174 EXTERN int SNESSetConvergenceTest(SNES,int (*)(SNES,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void*); 175 EXTERN int SNESConverged_LS(SNES,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*); 176 EXTERN int SNESConverged_TR(SNES,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*); 177 EXTERN int SNESGetConvergedReason(SNES,SNESConvergedReason*); 178 179 EXTERN int SNESDAFormFunction(SNES,Vec,Vec,void*); 180 EXTERN int SNESDAComputeJacobianWithAdic(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 181 EXTERN int SNESDAComputeJacobianWithAdifor(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 182 EXTERN int SNESDAComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 183 184 /* --------- Solving systems of nonlinear equations --------------- */ 185 EXTERN int SNESSetFunction(SNES,Vec,int(*)(SNES,Vec,Vec,void*),void *); 186 EXTERN int SNESComputeFunction(SNES,Vec,Vec); 187 EXTERN int SNESSetJacobian(SNES,Mat,Mat,int(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *); 188 EXTERN int SNESGetJacobian(SNES,Mat*,Mat*,void **,int(**)(SNES,Vec,Mat*,Mat*,MatStructure*,void*)); 189 EXTERN int SNESDefaultComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 190 EXTERN int SNESDefaultComputeJacobianColor(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 191 EXTERN int SNESSetLineSearch(SNES,int(*)(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,int*),void*); 192 EXTERN int SNESNoLineSearch(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,int*); 193 EXTERN int SNESNoLineSearchNoNorms(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,int*); 194 EXTERN int SNESCubicLineSearch(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,int*); 195 EXTERN int SNESQuadraticLineSearch(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,int*); 196 EXTERN int SNESSetLineSearchCheck(SNES,int(*)(SNES,void*,Vec,PetscTruth*),void*); 197 EXTERN int SNESSetLineSearchParams(SNES,PetscReal,PetscReal,PetscReal); 198 EXTERN int SNESGetLineSearchParams(SNES,PetscReal*,PetscReal*,PetscReal*); 199 200 /* Should this routine be private? */ 201 EXTERN int SNESComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*); 202 203 #endif 204 205