1 /* $Id: petscsnes.h,v 1.102 2000/07/21 19:42:25 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 typedef struct _p_SNES* SNES; 10 #define SNES_COOKIE PETSC_COOKIE+13 11 #define MATSNESMFCTX_COOKIE PETSC_COOKIE+29 12 13 #define SNESEQLS "ls" 14 #define SNESEQTR "tr" 15 #define SNESEQTEST "test" 16 #define SNESUMLS "umls" 17 #define SNESUMTR "umtr" 18 19 typedef char *SNESType; 20 21 typedef enum {SNES_NONLINEAR_EQUATIONS,SNES_UNCONSTRAINED_MINIMIZATION,SNES_LEAST_SQUARES} SNESProblemType; 22 23 EXTERN int SNESCreate(MPI_Comm,SNESProblemType,SNES*); 24 EXTERN int SNESDestroy(SNES); 25 EXTERN int SNESSetType(SNES,SNESType); 26 EXTERN int SNESSetMonitor(SNES,int(*)(SNES,int,double,void*),void *,int (*)(void *)); 27 EXTERN int SNESClearMonitor(SNES); 28 EXTERN int SNESSetConvergenceHistory(SNES,double*,int *,int,PetscTruth); 29 EXTERN int SNESGetConvergenceHistory(SNES,double**,int **,int *); 30 EXTERN int SNESSetUp(SNES,Vec); 31 EXTERN int SNESSolve(SNES,Vec,int*); 32 33 extern FList SNESList; 34 EXTERN int SNESRegisterDestroy(void); 35 EXTERN int SNESRegisterAll(char *); 36 37 EXTERN int SNESRegister(char*,char*,char*,int(*)(SNES)); 38 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 39 #define SNESRegisterDynamic(a,b,c,d) SNESRegister(a,b,c,0) 40 #else 41 #define SNESRegisterDynamic(a,b,c,d) SNESRegister(a,b,c,d) 42 #endif 43 44 EXTERN int SNESGetSLES(SNES,SLES*); 45 EXTERN int SNESGetSolution(SNES,Vec*); 46 EXTERN int SNESGetSolutionUpdate(SNES,Vec*); 47 EXTERN int SNESGetFunction(SNES,Vec*,void**,int(**)(SNES,Vec,Vec,void*)); 48 EXTERN int SNESPrintHelp(SNES); 49 EXTERN int SNESView(SNES,Viewer); 50 51 EXTERN int SNESSetOptionsPrefix(SNES,char*); 52 EXTERN int SNESAppendOptionsPrefix(SNES,char*); 53 EXTERN int SNESGetOptionsPrefix(SNES,char**); 54 EXTERN int SNESSetFromOptions(SNES); 55 EXTERN int SNESSetTypeFromOptions(SNES); 56 EXTERN int SNESAddOptionsChecker(int (*)(SNES)); 57 58 #define MATSNESMF_DEFAULT "default" 59 #define MATSNESMF_WP "wp" 60 EXTERN int MatCreateSNESMF(SNES,Vec,Mat*); 61 EXTERN int MatSNESMFSetFunction(Mat,Vec,int(*)(SNES,Vec,Vec,void*),void *); 62 EXTERN int MatSNESMFAddNullSpace(Mat,MatNullSpace); 63 EXTERN int MatSNESMFSetHHistory(Mat,Scalar *,int); 64 EXTERN int MatSNESMFResetHHistory(Mat); 65 EXTERN int MatSNESMFSetFunctionError(Mat,double); 66 EXTERN int MatSNESMFSetPeriod(Mat,int); 67 EXTERN int MatSNESMFGetH(Mat,Scalar *); 68 EXTERN int MatSNESMFKSPMonitor(KSP,int,double,void *); 69 EXTERN int MatSNESMFSetFromOptions(Mat); 70 typedef struct _p_MatSNESMFCtx *MatSNESMFCtx; 71 typedef char* MatSNESMFType; 72 EXTERN int MatSNESMFSetType(Mat,MatSNESMFType); 73 EXTERN int MatSNESMFRegister(char *,char *,char *,int (*)(MatSNESMFCtx)); 74 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 75 #define MatSNESMFRegisterDynamic(a,b,c,d) MatSNESMFRegister(a,b,c,0) 76 #else 77 #define MatSNESMFRegisterDynamic(a,b,c,d) MatSNESMFRegister(a,b,c,d) 78 #endif 79 EXTERN int MatSNESMFRegisterAll(char *); 80 EXTERN int MatSNESMFRegisterDestroy(void); 81 EXTERN int MatSNESMFDefaultSetUmin(Mat,double); 82 EXTERN int MatSNESMFWPSetComputeNormA(Mat,PetscTruth); 83 EXTERN int MatSNESMFWPSetComputeNormU(Mat,PetscTruth); 84 85 EXTERN int SNESGetType(SNES,SNESType*); 86 EXTERN int SNESDefaultMonitor(SNES,int,double,void *); 87 EXTERN int SNESVecViewMonitor(SNES,int,double,void *); 88 EXTERN int SNESVecViewUpdateMonitor(SNES,int,double,void *); 89 EXTERN int SNESDefaultSMonitor(SNES,int,double,void *); 90 EXTERN int SNESSetTolerances(SNES,double,double,double,int,int); 91 EXTERN int SNESGetTolerances(SNES,double*,double*,double*,int*,int*); 92 EXTERN int SNESSetTrustRegionTolerance(SNES,double); 93 EXTERN int SNESGetIterationNumber(SNES,int*); 94 EXTERN int SNESGetFunctionNorm(SNES,Scalar*); 95 EXTERN int SNESGetNumberUnsuccessfulSteps(SNES,int*); 96 EXTERN int SNESGetNumberLinearIterations(SNES,int*); 97 EXTERN int SNES_KSP_SetParametersEW(SNES,int,double,double,double,double,double,double); 98 EXTERN int SNES_KSP_SetConvergenceTestEW(SNES); 99 100 /* 101 Reuse the default KSP monitor routines for SNES 102 */ 103 EXTERN int SNESLGMonitorCreate(char*,char*,int,int,int,int,DrawLG*); 104 EXTERN int SNESLGMonitor(SNES,int,double,void*); 105 EXTERN int SNESLGMonitorDestroy(DrawLG); 106 107 EXTERN int SNESSetApplicationContext(SNES,void *); 108 EXTERN int SNESGetApplicationContext(SNES,void **); 109 110 typedef enum {/* converged */ 111 SNES_CONVERGED_FNORM_ABS = 2, /* F < F_minabs */ 112 SNES_CONVERGED_FNORM_RELATIVE = 3, /* F < F_mintol*F_initial */ 113 SNES_CONVERGED_PNORM_RELATIVE = 4, /* step size small */ 114 SNES_CONVERGED_GNORM_ABS = 5, /* grad F < grad F_min */ 115 SNES_CONVERGED_TR_REDUCTION = 6, 116 SNES_CONVERGED_TR_DELTA = 7, 117 /* diverged */ 118 SNES_DIVERGED_FUNCTION_COUNT = -2, 119 SNES_DIVERGED_FNORM_NAN = -4, 120 SNES_DIVERGED_MAX_IT = -5, 121 SNES_DIVERGED_LS_FAILURE = -6, 122 SNES_DIVERGED_TR_REDUCTION = -7, 123 SNES_DIVERGED_LOCAL_MIN = -8, /* || J^T b || is small, implies converged to local minimum of F() */ 124 SNES_CONVERGED_ITERATING = 0} SNESConvergedReason; 125 126 EXTERN int SNESSetConvergenceTest(SNES,int (*)(SNES,double,double,double,SNESConvergedReason*,void*),void*); 127 EXTERN int SNESConverged_UM_LS(SNES,double,double,double,SNESConvergedReason*,void*); 128 EXTERN int SNESConverged_UM_TR(SNES,double,double,double,SNESConvergedReason*,void*); 129 EXTERN int SNESConverged_EQ_LS(SNES,double,double,double,SNESConvergedReason*,void*); 130 EXTERN int SNESConverged_EQ_TR(SNES,double,double,double,SNESConvergedReason*,void*); 131 EXTERN int SNESGetConvergedReason(SNES,SNESConvergedReason*); 132 133 /* --------- Solving systems of nonlinear equations --------------- */ 134 EXTERN int SNESSetFunction(SNES,Vec,int(*)(SNES,Vec,Vec,void*),void *); 135 EXTERN int SNESComputeFunction(SNES,Vec,Vec); 136 EXTERN int SNESSetJacobian(SNES,Mat,Mat,int(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *); 137 EXTERN int SNESGetJacobian(SNES,Mat*,Mat*,void **,int(**)(SNES,Vec,Mat*,Mat*,MatStructure*,void*)); 138 EXTERN int SNESDefaultComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 139 EXTERN int SNESDefaultComputeJacobianColor(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 140 EXTERN int SNESSetLineSearch(SNES,int(*)(SNES,void*,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*),void*); 141 EXTERN int SNESNoLineSearch(SNES,void*,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 142 EXTERN int SNESNoLineSearchNoNorms(SNES,void*,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 143 EXTERN int SNESCubicLineSearch(SNES,void*,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 144 EXTERN int SNESQuadraticLineSearch(SNES,void*,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 145 EXTERN int SNESSetLineSearchCheck(SNES,int(*)(SNES,void*,Vec,PetscTruth*),void*); 146 EXTERN int SNESSetLineSearchParams(SNES,double,double,double); 147 EXTERN int SNESGetLineSearchParams(SNES,double*,double*,double*); 148 149 /* --------- Unconstrained minimization routines --------------------------------*/ 150 EXTERN int SNESSetHessian(SNES,Mat,Mat,int(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *); 151 EXTERN int SNESGetHessian(SNES,Mat*,Mat*,void **); 152 EXTERN int SNESDefaultComputeHessian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 153 EXTERN int SNESDefaultComputeHessianColor(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 154 EXTERN int SNESSetGradient(SNES,Vec,int(*)(SNES,Vec,Vec,void*),void*); 155 EXTERN int SNESGetGradient(SNES,Vec*,void**); 156 EXTERN int SNESGetGradientNorm(SNES,Scalar*); 157 EXTERN int SNESComputeGradient(SNES,Vec,Vec); 158 EXTERN int SNESSetMinimizationFunction(SNES,int(*)(SNES,Vec,double*,void*),void*); 159 EXTERN int SNESComputeMinimizationFunction(SNES,Vec,double*); 160 EXTERN int SNESGetMinimizationFunction(SNES,double*,void**); 161 EXTERN int SNESSetMinimizationFunctionTolerance(SNES,double); 162 EXTERN int SNESLineSearchSetDampingParameter(SNES,Scalar*); 163 164 165 /* Should these 2 routines be private? */ 166 EXTERN int SNESComputeHessian(SNES,Vec,Mat*,Mat*,MatStructure*); 167 EXTERN int SNESComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*); 168 169 #endif 170 171