1 /* $Id: snes.h,v 1.80 1999/03/01 04:49:35 bsmith Exp bsmith $ */ 2 /* 3 User interface for the nonlinear solvers and unconstrained minimization package. 4 */ 5 #if !defined(__SNES_H) 6 #define __SNES_H 7 #include "sles.h" 8 9 typedef struct _p_SNES* SNES; 10 #define SNES_COOKIE PETSC_COOKIE+13 11 12 #define SNES_EQ_LS "ls" 13 #define SNES_EQ_TR "tr" 14 #define SNES_EQ_TR_DOG_LEG 15 #define SNES_EQ_TR2_LIN 16 #define SNES_EQ_TEST "test" 17 #define SNES_UM_LS "umls" 18 #define SNES_UM_TR "umtr" 19 20 typedef char *SNESType; 21 22 typedef enum {SNES_NONLINEAR_EQUATIONS, SNES_UNCONSTRAINED_MINIMIZATION, SNES_LEAST_SQUARES} SNESProblemType; 23 24 extern int SNESCreate(MPI_Comm,SNESProblemType,SNES*); 25 extern int SNESDestroy(SNES); 26 extern int SNESSetType(SNES,SNESType); 27 extern int SNESSetMonitor(SNES,int(*)(SNES,int,double,void*),void *); 28 extern int SNESClearMonitor(SNES); 29 extern int SNESSetConvergenceHistory(SNES,double*,int *,int,PetscTruth); 30 extern int SNESGetConvergenceHistory(SNES,double**,int **,int *); 31 extern int SNESSetUp(SNES,Vec); 32 extern int SNESSolve(SNES,Vec,int*); 33 34 extern FList SNESList; 35 extern int SNESRegisterDestroy(void); 36 extern int SNESRegisterAll(char *); 37 38 extern int SNESRegister_Private(char*,char*,char*,int(*)(SNES)); 39 #if defined(USE_DYNAMIC_LIBRARIES) 40 #define SNESRegister(a,b,c,d) SNESRegister_Private(a,b,c,0) 41 #else 42 #define SNESRegister(a,b,c,d) SNESRegister_Private(a,b,c,d) 43 #endif 44 45 extern int SNESGetSLES(SNES,SLES*); 46 extern int SNESGetSolution(SNES,Vec*); 47 extern int SNESGetSolutionUpdate(SNES,Vec*); 48 extern int SNESGetFunction(SNES,Vec*); 49 extern int SNESPrintHelp(SNES); 50 extern int SNESView(SNES,Viewer); 51 52 extern int SNESSetOptionsPrefix(SNES,char*); 53 extern int SNESAppendOptionsPrefix(SNES,char*); 54 extern int SNESGetOptionsPrefix(SNES,char**); 55 extern int SNESSetFromOptions(SNES); 56 extern int SNESAddOptionsChecker(int (*)(SNES)); 57 58 extern int MatCreateSNESFDMF(SNES,Vec x,Mat*); 59 extern int MatSNESFDMFAddNullSpace(Mat,int,int,Vec *); 60 extern int MatSNESFDMFSetHHistory(Mat,Scalar *,int); 61 extern int MatSNESFDMFResetHHistory(Mat); 62 extern int MatSNESFDMFSetFunctionError(Mat,double); 63 extern int MatSNESFDMFGetH(Mat,Scalar *); 64 extern int MatSNESFDMFKSPMonitor(KSP,int,double,void *); 65 extern int MatSNESFDMFSetFromOptions(Mat); 66 typedef struct _p_MatSNESFDMFCtx *MatSNESFDMFCtx; 67 extern int MatSNESFDMFSetType(Mat,char*); 68 extern int MatSNESFDMFRegister_Private(char *,char *,char *,int (*)(MatSNESFDMFCtx)); 69 #if defined(USE_DYNAMIC_LIBRARIES) 70 #define MatSNESFDMFRegister(a,b,c,d) MatSNESFDMFRegister_Private(a,b,c,0) 71 #else 72 #define MatSNESFDMFRegister(a,b,c,d) MatSNESFDMFRegister_Private(a,b,c,d) 73 #endif 74 extern int MatSNESFDMFRegisterAll(char *); 75 extern int MatSNESFDMFRegisterDestroy(void); 76 extern int MatSNESFDMFDefaultSetUmin(Mat,double); 77 extern int MatSNESFDMFWPSetComputeNormA(Mat,PetscTruth); 78 extern int MatSNESFDMFWPSetComputeNormU(Mat,PetscTruth); 79 80 extern int SNESGetType(SNES,SNESType*); 81 extern int SNESDefaultMonitor(SNES,int,double,void *); 82 extern int SNESVecViewMonitor(SNES,int,double,void *); 83 extern int SNESDefaultSMonitor(SNES,int,double,void *); 84 extern int SNESSetTolerances(SNES,double,double,double,int,int); 85 extern int SNESGetTolerances(SNES,double*,double*,double*,int*,int*); 86 extern int SNESSetTrustRegionTolerance(SNES,double); 87 extern int SNESGetIterationNumber(SNES,int*); 88 extern int SNESGetFunctionNorm(SNES,Scalar*); 89 extern int SNESGetNumberUnsuccessfulSteps(SNES,int*); 90 extern int SNESGetNumberLinearIterations(SNES,int*); 91 extern int SNES_KSP_SetParametersEW(SNES,int,double,double,double,double,double,double); 92 extern int SNES_KSP_SetConvergenceTestEW(SNES); 93 94 /* 95 Reuse the default KSP monitor routines for SNES 96 */ 97 #define SNESLGMonitorCreate KSPLGMonitorCreate 98 #define SNESLGMonitorDestroy KSPLGMonitorDestroy 99 extern int SNESLGMonitor(SNES,int,double,void*); 100 101 extern int SNESSetApplicationContext(SNES,void *); 102 extern int SNESGetApplicationContext(SNES,void **); 103 extern int SNESSetConvergenceTest(SNES,int (*)(SNES,double,double,double,void*),void*); 104 105 /* --------- Solving systems of nonlinear equations --------------- */ 106 extern int SNESSetFunction(SNES,Vec,int(*)(SNES,Vec,Vec,void*),void *); 107 extern int SNESComputeFunction(SNES,Vec,Vec); 108 extern int SNESSetJacobian(SNES,Mat,Mat,int(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *); 109 extern int SNESGetJacobian(SNES,Mat*,Mat*,void **); 110 extern int SNESDefaultComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 111 extern int SNESDefaultComputeJacobianColor(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 112 extern int SNESConverged_EQ_LS(SNES,double,double,double,void*); 113 extern int SNESConverged_EQ_TR(SNES,double,double,double,void*); 114 extern int SNESSetLineSearch(SNES,int(*)(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*)); 115 extern int SNESNoLineSearch(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 116 extern int SNESNoLineSearchNoNorms(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 117 extern int SNESCubicLineSearch(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 118 extern int SNESQuadraticLineSearch(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 119 120 /* --------- Unconstrained minimization routines --------------------------------*/ 121 extern int SNESSetHessian(SNES,Mat,Mat,int(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *); 122 extern int SNESGetHessian(SNES,Mat*,Mat*,void **); 123 extern int SNESDefaultComputeHessian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 124 extern int SNESSetGradient(SNES,Vec,int(*)(SNES,Vec,Vec,void*),void*); 125 extern int SNESGetGradient(SNES,Vec*); 126 extern int SNESGetGradientNorm(SNES,Scalar*); 127 extern int SNESComputeGradient(SNES,Vec,Vec); 128 extern int SNESSetMinimizationFunction(SNES,int(*)(SNES,Vec,double*,void*),void*); 129 extern int SNESComputeMinimizationFunction(SNES,Vec,double*); 130 extern int SNESGetMinimizationFunction(SNES,double*); 131 extern int SNESSetMinimizationFunctionTolerance(SNES,double); 132 extern int SNESLineSearchSetDampingParameter(SNES,Scalar*); 133 extern int SNESConverged_UM_LS(SNES,double,double,double,void*); 134 extern int SNESConverged_UM_TR(SNES,double,double,double,void*); 135 136 137 /* Should these 2 routines be private? */ 138 extern int SNESComputeHessian(SNES,Vec,Mat*,Mat*,MatStructure*); 139 extern int SNESComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*); 140 141 #endif 142 143