1 /* $Id: snes.h,v 1.74 1998/10/31 23:07:33 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); 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_Private(char*,char*,char*,int(*)(SNES)); 38 #if defined(USE_DYNAMIC_LIBRARIES) 39 #define SNESRegister(a,b,c,d) SNESRegister_Private(a,b,c,0) 40 #else 41 #define SNESRegister(a,b,c,d) SNESRegister_Private(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*); 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 SNESAddOptionsChecker(int (*)(SNES)); 56 57 extern int SNESDefaultMatrixFreeCreate(SNES,Vec x,Mat*); 58 extern int SNESDefaultMatrixFreeAddNullSpace(Mat,int,int,Vec *); 59 extern int SNESDefaultMatrixFreeSetHHistory(Mat,Scalar *,int); 60 extern int SNESDefaultMatrixFreeResetHHistory(Mat,Scalar *,int); 61 extern int SNESDefaultMatrixFreeSetParameters(Mat,double,double); 62 extern int SNESDefaultMatrixFreeGetH(Mat,Scalar *); 63 extern int SNESDefaultMatrixFreeKSPMonitor(KSP,int,double,void *); 64 65 extern int SNESGetType(SNES,SNESType*); 66 extern int SNESDefaultMonitor(SNES,int,double,void *); 67 extern int SNESDefaultSMonitor(SNES,int,double,void *); 68 extern int SNESSetTolerances(SNES,double,double,double,int,int); 69 extern int SNESGetTolerances(SNES,double*,double*,double*,int*,int*); 70 extern int SNESSetTrustRegionTolerance(SNES,double); 71 extern int SNESGetIterationNumber(SNES,int*); 72 extern int SNESGetFunctionNorm(SNES,Scalar*); 73 extern int SNESGetNumberUnsuccessfulSteps(SNES,int*); 74 extern int SNESGetNumberLinearIterations(SNES,int*); 75 extern int SNES_KSP_SetParametersEW(SNES,int,double,double,double,double,double,double); 76 extern int SNES_KSP_SetConvergenceTestEW(SNES); 77 78 /* 79 Reuse the default KSP monitor routines for SNES 80 */ 81 #define SNESLGMonitorCreate KSPLGMonitorCreate 82 #define SNESLGMonitorDestroy KSPLGMonitorDestroy 83 #define SNESLGMonitor ((int (*)(SNES,int,double,void*))KSPLGMonitor) 84 85 extern int SNESSetApplicationContext(SNES,void *); 86 extern int SNESGetApplicationContext(SNES,void **); 87 extern int SNESSetConvergenceTest(SNES,int (*)(SNES,double,double,double,void*),void*); 88 89 /* --------- Solving systems of nonlinear equations --------------- */ 90 extern int SNESSetFunction(SNES,Vec,int(*)(SNES,Vec,Vec,void*),void *); 91 extern int SNESComputeFunction(SNES,Vec,Vec); 92 extern int SNESSetJacobian(SNES,Mat,Mat,int(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *); 93 extern int SNESGetJacobian(SNES,Mat*,Mat*,void **); 94 extern int SNESDefaultComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 95 extern int SNESDefaultComputeJacobianWithColoring(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 96 extern int SNESConverged_EQ_LS(SNES,double,double,double,void*); 97 extern int SNESConverged_EQ_TR(SNES,double,double,double,void*); 98 extern int SNESSetLineSearch(SNES,int(*)(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*)); 99 extern int SNESNoLineSearch(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 100 extern int SNESNoLineSearchNoNorms(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 101 extern int SNESCubicLineSearch(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 102 extern int SNESQuadraticLineSearch(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 103 104 /* --------- Unconstrained minimization routines --------------------------------*/ 105 extern int SNESSetHessian(SNES,Mat,Mat,int(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *); 106 extern int SNESGetHessian(SNES,Mat*,Mat*,void **); 107 extern int SNESDefaultComputeHessian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 108 extern int SNESSetGradient(SNES,Vec,int(*)(SNES,Vec,Vec,void*),void*); 109 extern int SNESGetGradient(SNES,Vec*); 110 extern int SNESGetGradientNorm(SNES,Scalar*); 111 extern int SNESComputeGradient(SNES,Vec,Vec); 112 extern int SNESSetMinimizationFunction(SNES,int(*)(SNES,Vec,double*,void*),void*); 113 extern int SNESComputeMinimizationFunction(SNES,Vec,double*); 114 extern int SNESGetMinimizationFunction(SNES,double*); 115 extern int SNESSetMinimizationFunctionTolerance(SNES,double); 116 extern int SNESLineSearchSetDampingParameter(SNES,Scalar*); 117 extern int SNESConverged_UM_LS(SNES,double,double,double,void*); 118 extern int SNESConverged_UM_TR(SNES,double,double,double,void*); 119 120 121 /* Should these 2 routines be private? */ 122 extern int SNESComputeHessian(SNES,Vec,Mat*,Mat*,MatStructure*); 123 extern int SNESComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*); 124 125 #endif 126 127