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 "petscksp.h" 8 PETSC_EXTERN_CXX_BEGIN 9 10 /*S 11 SNES - Abstract PETSc object that manages all nonlinear solves 12 13 Level: beginner 14 15 Concepts: nonlinear solvers 16 17 .seealso: SNESCreate(), SNESSetType(), SNESType, TS, KSP, KSP, PC 18 S*/ 19 typedef struct _p_SNES* SNES; 20 21 /*E 22 SNESType - String with the name of a PETSc SNES method or the creation function 23 with an optional dynamic library name, for example 24 http://www.mcs.anl.gov/petsc/lib.a:mysnescreate() 25 26 Level: beginner 27 28 .seealso: SNESSetType(), SNES 29 E*/ 30 #define SNESLS "ls" 31 #define SNESTR "tr" 32 #define SNESTEST "test" 33 #define SNESType char* 34 35 /* Logging support */ 36 extern int SNES_COOKIE; 37 extern int SNES_Solve, SNES_LineSearch, SNES_FunctionEval, SNES_JacobianEval; 38 39 40 EXTERN int SNESInitializePackage(const char[]); 41 42 EXTERN int SNESCreate(MPI_Comm,SNES*); 43 EXTERN int SNESDestroy(SNES); 44 EXTERN int SNESSetType(SNES,const 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(const char[]); 64 65 EXTERN int SNESRegister(const char[],const char[],const char[],int(*)(SNES)); 66 67 /*MC 68 SNESRegisterDynamic - Adds a method to the nonlinear solver package. 69 70 Synopsis: 71 int SNESRegisterDynamic(char *name_solver,char *path,char *name_create,int (*routine_create)(SNES)) 72 73 Not collective 74 75 Input Parameters: 76 + name_solver - name of a new user-defined solver 77 . path - path (either absolute or relative) the library containing this solver 78 . name_create - name of routine to create method context 79 - routine_create - routine to create method context 80 81 Notes: 82 SNESRegisterDynamic() may be called multiple times to add several user-defined solvers. 83 84 If dynamic libraries are used, then the fourth input argument (routine_create) 85 is ignored. 86 87 Environmental variables such as ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR}, ${BOPT}, 88 and others of the form ${any_environmental_variable} occuring in pathname will be 89 replaced with appropriate values. 90 91 Sample usage: 92 .vb 93 SNESRegisterDynamic("my_solver",/home/username/my_lib/lib/libg/solaris/mylib.a, 94 "MySolverCreate",MySolverCreate); 95 .ve 96 97 Then, your solver can be chosen with the procedural interface via 98 $ SNESSetType(snes,"my_solver") 99 or at runtime via the option 100 $ -snes_type my_solver 101 102 Level: advanced 103 104 Note: If your function is not being put into a shared library then use SNESRegister() instead 105 106 .keywords: SNES, nonlinear, register 107 108 .seealso: SNESRegisterAll(), SNESRegisterDestroy() 109 M*/ 110 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 111 #define SNESRegisterDynamic(a,b,c,d) SNESRegister(a,b,c,0) 112 #else 113 #define SNESRegisterDynamic(a,b,c,d) SNESRegister(a,b,c,d) 114 #endif 115 116 EXTERN int SNESGetKSP(SNES,KSP*); 117 EXTERN int SNESGetSolution(SNES,Vec*); 118 EXTERN int SNESGetSolutionUpdate(SNES,Vec*); 119 EXTERN int SNESGetFunction(SNES,Vec*,void**,int(**)(SNES,Vec,Vec,void*)); 120 EXTERN int SNESView(SNES,PetscViewer); 121 122 EXTERN int SNESSetOptionsPrefix(SNES,const char[]); 123 EXTERN int SNESAppendOptionsPrefix(SNES,const char[]); 124 EXTERN int SNESGetOptionsPrefix(SNES,char*[]); 125 EXTERN int SNESSetFromOptions(SNES); 126 127 EXTERN int MatCreateSNESMF(SNES,Vec,Mat*); 128 EXTERN int MatCreateMF(Vec,Mat*); 129 EXTERN int MatSNESMFSetBase(Mat,Vec); 130 EXTERN int MatSNESMFComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 131 EXTERN_C_BEGIN 132 EXTERN int MatSNESMFSetFunction(Mat,Vec,int(*)(SNES,Vec,Vec,void*),void*); 133 EXTERN_C_END 134 EXTERN int MatSNESMFSetFunctioni(Mat,int (*)(int,Vec,PetscScalar*,void*)); 135 EXTERN int MatSNESMFSetFunctioniBase(Mat,int (*)(Vec,void*)); 136 EXTERN int MatSNESMFAddNullSpace(Mat,MatNullSpace); 137 EXTERN int MatSNESMFSetHHistory(Mat,PetscScalar[],int); 138 EXTERN int MatSNESMFResetHHistory(Mat); 139 EXTERN int MatSNESMFSetFunctionError(Mat,PetscReal); 140 EXTERN int MatSNESMFSetPeriod(Mat,int); 141 EXTERN int MatSNESMFGetH(Mat,PetscScalar *); 142 EXTERN int MatSNESMFKSPMonitor(KSP,int,PetscReal,void *); 143 EXTERN int MatSNESMFSetFromOptions(Mat); 144 EXTERN int MatSNESMFCheckPositivity(Vec,Vec,PetscScalar*,void*); 145 EXTERN int MatSNESMFSetCheckh(Mat,int (*)(Vec,Vec,PetscScalar*,void*),void*); 146 147 typedef struct _p_MatSNESMFCtx *MatSNESMFCtx; 148 149 #define MATSNESMF_DEFAULT "default" 150 #define MATSNESMF_WP "wp" 151 #define MatSNESMFType char* 152 EXTERN int MatSNESMFSetType(Mat,const MatSNESMFType); 153 EXTERN int MatSNESMFRegister(const char[],const char[],const char[],int (*)(MatSNESMFCtx)); 154 155 /*MC 156 MatSNESMFRegisterDynamic - Adds a method to the MatSNESMF registry. 157 158 Synopsis: 159 int MatSNESMFRegisterDynamic(char *name_solver,char *path,char *name_create,int (*routine_create)(MatSNESMF)) 160 161 Not Collective 162 163 Input Parameters: 164 + name_solver - name of a new user-defined compute-h module 165 . path - path (either absolute or relative) the library containing this solver 166 . name_create - name of routine to create method context 167 - routine_create - routine to create method context 168 169 Level: developer 170 171 Notes: 172 MatSNESMFRegisterDynamic) may be called multiple times to add several user-defined solvers. 173 174 If dynamic libraries are used, then the fourth input argument (routine_create) 175 is ignored. 176 177 Sample usage: 178 .vb 179 MatSNESMFRegisterDynamic"my_h",/home/username/my_lib/lib/libO/solaris/mylib.a, 180 "MyHCreate",MyHCreate); 181 .ve 182 183 Then, your solver can be chosen with the procedural interface via 184 $ MatSNESMFSetType(mfctx,"my_h") 185 or at runtime via the option 186 $ -snes_mf_type my_h 187 188 .keywords: MatSNESMF, register 189 190 .seealso: MatSNESMFRegisterAll(), MatSNESMFRegisterDestroy() 191 M*/ 192 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 193 #define MatSNESMFRegisterDynamic(a,b,c,d) MatSNESMFRegister(a,b,c,0) 194 #else 195 #define MatSNESMFRegisterDynamic(a,b,c,d) MatSNESMFRegister(a,b,c,d) 196 #endif 197 198 EXTERN int MatSNESMFRegisterAll(const char[]); 199 EXTERN int MatSNESMFRegisterDestroy(void); 200 EXTERN int MatSNESMFDefaultSetUmin(Mat,PetscReal); 201 EXTERN int MatSNESMFWPSetComputeNormA(Mat,PetscTruth); 202 EXTERN int MatSNESMFWPSetComputeNormU(Mat,PetscTruth); 203 204 EXTERN int MatDAADSetSNES(Mat,SNES); 205 206 EXTERN int SNESGetType(SNES,SNESType*); 207 EXTERN int SNESDefaultMonitor(SNES,int,PetscReal,void *); 208 EXTERN int SNESRatioMonitor(SNES,int,PetscReal,void *); 209 EXTERN int SNESSetRatioMonitor(SNES); 210 EXTERN int SNESVecViewMonitor(SNES,int,PetscReal,void *); 211 EXTERN int SNESVecViewResidualMonitor(SNES,int,PetscReal,void *); 212 EXTERN int SNESVecViewUpdateMonitor(SNES,int,PetscReal,void *); 213 EXTERN int SNESDefaultSMonitor(SNES,int,PetscReal,void *); 214 EXTERN int SNESSetTolerances(SNES,PetscReal,PetscReal,PetscReal,int,int); 215 EXTERN int SNESGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,int*,int*); 216 EXTERN int SNESSetTrustRegionTolerance(SNES,PetscReal); 217 EXTERN int SNESGetIterationNumber(SNES,int*); 218 EXTERN int SNESGetFunctionNorm(SNES,PetscScalar*); 219 EXTERN int SNESGetNumberUnsuccessfulSteps(SNES,int*); 220 EXTERN int SNESSetMaximumUnsuccessfulSteps(SNES,int); 221 EXTERN int SNESGetMaximumUnsuccessfulSteps(SNES,int*); 222 EXTERN int SNESGetNumberLinearIterations(SNES,int*); 223 EXTERN int SNES_KSP_SetParametersEW(SNES,int,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal); 224 EXTERN int SNES_KSP_SetConvergenceTestEW(SNES); 225 226 /* 227 Reuse the default KSP monitor routines for SNES 228 */ 229 EXTERN int SNESLGMonitorCreate(const char[],const char[],int,int,int,int,PetscDrawLG*); 230 EXTERN int SNESLGMonitor(SNES,int,PetscReal,void*); 231 EXTERN int SNESLGMonitorDestroy(PetscDrawLG); 232 233 EXTERN int SNESSetApplicationContext(SNES,void *); 234 EXTERN int SNESGetApplicationContext(SNES,void **); 235 236 /*E 237 SNESConvergedReason - reason a SNES method was said to 238 have converged or diverged 239 240 Level: beginner 241 242 Notes: this must match finclude/petscsnes.h 243 244 .seealso: SNESSolve(), SNESGetConvergedReason(), KSPConvergedReason, SNESSetConvergenceTest() 245 E*/ 246 typedef enum {/* converged */ 247 SNES_CONVERGED_FNORM_ABS = 2, /* F < F_minabs */ 248 SNES_CONVERGED_FNORM_RELATIVE = 3, /* F < F_mintol*F_initial */ 249 SNES_CONVERGED_PNORM_RELATIVE = 4, /* step size small */ 250 SNES_CONVERGED_GNORM_ABS = 5, /* grad F < grad F_min */ 251 SNES_CONVERGED_TR_REDUCTION = 6, 252 SNES_CONVERGED_TR_DELTA = 7, 253 /* diverged */ 254 SNES_DIVERGED_FUNCTION_COUNT = -2, 255 SNES_DIVERGED_FNORM_NAN = -4, 256 SNES_DIVERGED_MAX_IT = -5, 257 SNES_DIVERGED_LS_FAILURE = -6, 258 SNES_DIVERGED_TR_REDUCTION = -7, 259 SNES_DIVERGED_LOCAL_MIN = -8, /* || J^T b || is small, implies converged to local minimum of F() */ 260 SNES_CONVERGED_ITERATING = 0} SNESConvergedReason; 261 262 EXTERN int SNESSetConvergenceTest(SNES,int (*)(SNES,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void*); 263 EXTERN int SNESConverged_LS(SNES,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*); 264 EXTERN int SNESConverged_TR(SNES,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*); 265 EXTERN int SNESGetConvergedReason(SNES,SNESConvergedReason*); 266 267 EXTERN int SNESDAFormFunction(SNES,Vec,Vec,void*); 268 EXTERN int SNESDAComputeJacobianWithAdic(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 269 EXTERN int SNESDAComputeJacobianWithAdifor(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 270 EXTERN int SNESDAComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 271 272 /* --------- Solving systems of nonlinear equations --------------- */ 273 EXTERN int SNESSetFunction(SNES,Vec,int(*)(SNES,Vec,Vec,void*),void *); 274 EXTERN int SNESComputeFunction(SNES,Vec,Vec); 275 EXTERN int SNESSetJacobian(SNES,Mat,Mat,int(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *); 276 EXTERN int SNESGetJacobian(SNES,Mat*,Mat*,void **,int(**)(SNES,Vec,Mat*,Mat*,MatStructure*,void*)); 277 EXTERN int SNESDefaultComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 278 EXTERN int SNESDefaultComputeJacobianColor(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 279 280 EXTERN_C_BEGIN 281 EXTERN int SNESSetLineSearch(SNES,int(*)(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,int*),void*); 282 EXTERN int SNESNoLineSearch(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,int*); 283 EXTERN int SNESNoLineSearchNoNorms(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,int*); 284 EXTERN int SNESCubicLineSearch(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,int*); 285 EXTERN int SNESQuadraticLineSearch(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,int*); 286 EXTERN_C_END 287 288 EXTERN int SNESSetLineSearchCheck(SNES,int(*)(SNES,void*,Vec,PetscTruth*),void*); 289 EXTERN int SNESSetLineSearchParams(SNES,PetscReal,PetscReal,PetscReal); 290 EXTERN int SNESGetLineSearchParams(SNES,PetscReal*,PetscReal*,PetscReal*); 291 292 EXTERN int SNESTestLocalMin(SNES snes); 293 294 /* Should this routine be private? */ 295 EXTERN int SNESComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*); 296 297 PETSC_EXTERN_CXX_END 298 #endif 299