1 /* $Id: petscsnes.h,v 1.103 2000/08/01 20:58:40 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 MatCreateMF(Vec,Mat*); 62 EXTERN int MatSNESMFSetBase(Mat,Vec); 63 EXTERN int MatSNESMFFormJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 64 EXTERN int MatSNESMFSetFunction(Mat,Vec,int(*)(SNES,Vec,Vec,void*),void *); 65 EXTERN int MatSNESMFAddNullSpace(Mat,MatNullSpace); 66 EXTERN int MatSNESMFSetHHistory(Mat,Scalar *,int); 67 EXTERN int MatSNESMFResetHHistory(Mat); 68 EXTERN int MatSNESMFSetFunctionError(Mat,double); 69 EXTERN int MatSNESMFSetPeriod(Mat,int); 70 EXTERN int MatSNESMFGetH(Mat,Scalar *); 71 EXTERN int MatSNESMFKSPMonitor(KSP,int,double,void *); 72 EXTERN int MatSNESMFSetFromOptions(Mat); 73 typedef struct _p_MatSNESMFCtx *MatSNESMFCtx; 74 typedef char* MatSNESMFType; 75 EXTERN int MatSNESMFSetType(Mat,MatSNESMFType); 76 EXTERN int MatSNESMFRegister(char *,char *,char *,int (*)(MatSNESMFCtx)); 77 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 78 #define MatSNESMFRegisterDynamic(a,b,c,d) MatSNESMFRegister(a,b,c,0) 79 #else 80 #define MatSNESMFRegisterDynamic(a,b,c,d) MatSNESMFRegister(a,b,c,d) 81 #endif 82 EXTERN int MatSNESMFRegisterAll(char *); 83 EXTERN int MatSNESMFRegisterDestroy(void); 84 EXTERN int MatSNESMFDefaultSetUmin(Mat,double); 85 EXTERN int MatSNESMFWPSetComputeNormA(Mat,PetscTruth); 86 EXTERN int MatSNESMFWPSetComputeNormU(Mat,PetscTruth); 87 88 EXTERN int SNESGetType(SNES,SNESType*); 89 EXTERN int SNESDefaultMonitor(SNES,int,double,void *); 90 EXTERN int SNESVecViewMonitor(SNES,int,double,void *); 91 EXTERN int SNESVecViewUpdateMonitor(SNES,int,double,void *); 92 EXTERN int SNESDefaultSMonitor(SNES,int,double,void *); 93 EXTERN int SNESSetTolerances(SNES,double,double,double,int,int); 94 EXTERN int SNESGetTolerances(SNES,double*,double*,double*,int*,int*); 95 EXTERN int SNESSetTrustRegionTolerance(SNES,double); 96 EXTERN int SNESGetIterationNumber(SNES,int*); 97 EXTERN int SNESGetFunctionNorm(SNES,Scalar*); 98 EXTERN int SNESGetNumberUnsuccessfulSteps(SNES,int*); 99 EXTERN int SNESGetNumberLinearIterations(SNES,int*); 100 EXTERN int SNES_KSP_SetParametersEW(SNES,int,double,double,double,double,double,double); 101 EXTERN int SNES_KSP_SetConvergenceTestEW(SNES); 102 103 /* 104 Reuse the default KSP monitor routines for SNES 105 */ 106 EXTERN int SNESLGMonitorCreate(char*,char*,int,int,int,int,DrawLG*); 107 EXTERN int SNESLGMonitor(SNES,int,double,void*); 108 EXTERN int SNESLGMonitorDestroy(DrawLG); 109 110 EXTERN int SNESSetApplicationContext(SNES,void *); 111 EXTERN int SNESGetApplicationContext(SNES,void **); 112 113 typedef enum {/* converged */ 114 SNES_CONVERGED_FNORM_ABS = 2, /* F < F_minabs */ 115 SNES_CONVERGED_FNORM_RELATIVE = 3, /* F < F_mintol*F_initial */ 116 SNES_CONVERGED_PNORM_RELATIVE = 4, /* step size small */ 117 SNES_CONVERGED_GNORM_ABS = 5, /* grad F < grad F_min */ 118 SNES_CONVERGED_TR_REDUCTION = 6, 119 SNES_CONVERGED_TR_DELTA = 7, 120 /* diverged */ 121 SNES_DIVERGED_FUNCTION_COUNT = -2, 122 SNES_DIVERGED_FNORM_NAN = -4, 123 SNES_DIVERGED_MAX_IT = -5, 124 SNES_DIVERGED_LS_FAILURE = -6, 125 SNES_DIVERGED_TR_REDUCTION = -7, 126 SNES_DIVERGED_LOCAL_MIN = -8, /* || J^T b || is small, implies converged to local minimum of F() */ 127 SNES_CONVERGED_ITERATING = 0} SNESConvergedReason; 128 129 EXTERN int SNESSetConvergenceTest(SNES,int (*)(SNES,double,double,double,SNESConvergedReason*,void*),void*); 130 EXTERN int SNESConverged_UM_LS(SNES,double,double,double,SNESConvergedReason*,void*); 131 EXTERN int SNESConverged_UM_TR(SNES,double,double,double,SNESConvergedReason*,void*); 132 EXTERN int SNESConverged_EQ_LS(SNES,double,double,double,SNESConvergedReason*,void*); 133 EXTERN int SNESConverged_EQ_TR(SNES,double,double,double,SNESConvergedReason*,void*); 134 EXTERN int SNESGetConvergedReason(SNES,SNESConvergedReason*); 135 136 /* --------- Solving systems of nonlinear equations --------------- */ 137 EXTERN int SNESSetFunction(SNES,Vec,int(*)(SNES,Vec,Vec,void*),void *); 138 EXTERN int SNESComputeFunction(SNES,Vec,Vec); 139 EXTERN int SNESSetJacobian(SNES,Mat,Mat,int(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *); 140 EXTERN int SNESGetJacobian(SNES,Mat*,Mat*,void **,int(**)(SNES,Vec,Mat*,Mat*,MatStructure*,void*)); 141 EXTERN int SNESDefaultComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 142 EXTERN int SNESDefaultComputeJacobianColor(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 143 EXTERN int SNESSetLineSearch(SNES,int(*)(SNES,void*,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*),void*); 144 EXTERN int SNESNoLineSearch(SNES,void*,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 145 EXTERN int SNESNoLineSearchNoNorms(SNES,void*,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 146 EXTERN int SNESCubicLineSearch(SNES,void*,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 147 EXTERN int SNESQuadraticLineSearch(SNES,void*,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 148 EXTERN int SNESSetLineSearchCheck(SNES,int(*)(SNES,void*,Vec,PetscTruth*),void*); 149 EXTERN int SNESSetLineSearchParams(SNES,double,double,double); 150 EXTERN int SNESGetLineSearchParams(SNES,double*,double*,double*); 151 152 /* --------- Unconstrained minimization routines --------------------------------*/ 153 EXTERN int SNESSetHessian(SNES,Mat,Mat,int(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *); 154 EXTERN int SNESGetHessian(SNES,Mat*,Mat*,void **); 155 EXTERN int SNESDefaultComputeHessian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 156 EXTERN int SNESDefaultComputeHessianColor(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 157 EXTERN int SNESSetGradient(SNES,Vec,int(*)(SNES,Vec,Vec,void*),void*); 158 EXTERN int SNESGetGradient(SNES,Vec*,void**); 159 EXTERN int SNESGetGradientNorm(SNES,Scalar*); 160 EXTERN int SNESComputeGradient(SNES,Vec,Vec); 161 EXTERN int SNESSetMinimizationFunction(SNES,int(*)(SNES,Vec,double*,void*),void*); 162 EXTERN int SNESComputeMinimizationFunction(SNES,Vec,double*); 163 EXTERN int SNESGetMinimizationFunction(SNES,double*,void**); 164 EXTERN int SNESSetMinimizationFunctionTolerance(SNES,double); 165 EXTERN int SNESLineSearchSetDampingParameter(SNES,Scalar*); 166 167 168 /* Should these 2 routines be private? */ 169 EXTERN int SNESComputeHessian(SNES,Vec,Mat*,Mat*,MatStructure*); 170 EXTERN int SNESComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*); 171 172 #endif 173 174