1 /* $Id: snes.h,v 1.65 1998/03/23 21:27:32 bsmith Exp bsmith $ */ 2 /* 3 User interface for the nonlinear solvers and unconstrained minimization package. 4 */ 5 #if !defined(__SNES_PACKAGE) 6 #define __SNES_PACKAGE 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 #define SNES_LS_LM "lslm" 20 21 typedef char *SNESType; 22 23 typedef enum {SNES_NONLINEAR_EQUATIONS, SNES_UNCONSTRAINED_MINIMIZATION, SNES_LEAST_SQUARES} SNESProblemType; 24 25 /* temporarily add this declaration here */ 26 extern int JorgeQuadraticMinimizer(SNES,Vec,Vec,double,Vec,int*); 27 28 extern int SNESCreate(MPI_Comm,SNESProblemType,SNES*); 29 extern int SNESDestroy(SNES); 30 extern int SNESSetType(SNES,SNESType); 31 extern int SNESSetMonitor(SNES,int(*)(SNES,int,double,void*),void *); 32 extern int SNESClearMonitor(SNES); 33 extern int SNESSetConvergenceHistory(SNES,double*,int); 34 extern int SNESSetUp(SNES,Vec); 35 extern int SNESSolve(SNES,Vec,int*); 36 37 extern DLList SNESList; 38 extern int SNESRegisterDestroy(void); 39 extern int SNESRegisterAll(char *); 40 41 extern int SNESGetSLES(SNES,SLES*); 42 extern int SNESGetSolution(SNES,Vec*); 43 extern int SNESGetSolutionUpdate(SNES,Vec*); 44 extern int SNESGetFunction(SNES,Vec*); 45 extern int SNESPrintHelp(SNES); 46 extern int SNESView(SNES,Viewer); 47 48 extern int SNESSetOptionsPrefix(SNES,char*); 49 extern int SNESAppendOptionsPrefix(SNES,char*); 50 extern int SNESGetOptionsPrefix(SNES,char**); 51 extern int SNESSetFromOptions(SNES); 52 extern int SNESAddOptionsChecker(int (*)(SNES)); 53 54 extern int SNESDefaultMatrixFreeMatCreate(SNES,Vec x,Mat*); 55 extern int SNESSetMatrixFreeParameters(SNES,double,double); 56 extern int SNESGetType(SNES,SNESType*); 57 extern int SNESDefaultMonitor(SNES,int,double,void *); 58 extern int SNESDefaultSMonitor(SNES,int,double,void *); 59 extern int SNESSetTolerances(SNES,double,double,double,int,int); 60 extern int SNESGetTolerances(SNES,double*,double*,double*,int*,int*); 61 extern int SNESSetTrustRegionTolerance(SNES,double); 62 extern int SNESGetIterationNumber(SNES,int*); 63 extern int SNESGetFunctionNorm(SNES,Scalar*); 64 extern int SNESGetNumberUnsuccessfulSteps(SNES,int*); 65 extern int SNESGetNumberLinearIterations(SNES,int*); 66 extern int SNES_KSP_SetParametersEW(SNES,int,double,double,double,double,double,double); 67 extern int SNES_KSP_SetConvergenceTestEW(SNES); 68 69 /* 70 Reuse the default KSP monitor routines for SNES 71 */ 72 #define SNESLGMonitorCreate KSPLGMonitorCreate 73 #define SNESLGMonitorDestroy KSPLGMonitorDestroy 74 #define SNESLGMonitor ((int (*)(SNES,int,double,void*))KSPLGMonitor) 75 76 extern int SNESSetApplicationContext(SNES,void *); 77 extern int SNESGetApplicationContext(SNES,void **); 78 extern int SNESSetConvergenceTest(SNES,int (*)(SNES,double,double,double,void*),void*); 79 80 /* --------- Solving systems of nonlinear equations --------------- */ 81 extern int SNESSetFunction(SNES,Vec,int(*)(SNES,Vec,Vec,void*),void *); 82 extern int SNESComputeFunction(SNES,Vec,Vec); 83 extern int SNESSetJacobian(SNES,Mat,Mat,int(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *); 84 extern int SNESGetJacobian(SNES,Mat*,Mat*,void **); 85 extern int SNESDefaultComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 86 extern int SNESDefaultComputeJacobianWithColoring(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 87 extern int SNESConverged_EQ_LS(SNES,double,double,double,void*); 88 extern int SNESConverged_EQ_TR(SNES,double,double,double,void*); 89 extern int SNESSetLineSearch(SNES,int(*)(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*)); 90 extern int SNESNoLineSearch(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 91 extern int SNESNoLineSearchNoNorms(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 92 extern int SNESCubicLineSearch(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 93 extern int SNESQuadraticLineSearch(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 94 95 /* --------- Unconstrained minimization routines --------------------------------*/ 96 extern int SNESSetHessian(SNES,Mat,Mat,int(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *); 97 extern int SNESGetHessian(SNES,Mat*,Mat*,void **); 98 extern int SNESDefaultComputeHessian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 99 extern int SNESSetGradient(SNES,Vec,int(*)(SNES,Vec,Vec,void*),void*); 100 extern int SNESGetGradient(SNES,Vec*); 101 extern int SNESGetGradientNorm(SNES,Scalar*); 102 extern int SNESComputeGradient(SNES,Vec,Vec); 103 extern int SNESSetMinimizationFunction(SNES,int(*)(SNES,Vec,double*,void*),void*); 104 extern int SNESComputeMinimizationFunction(SNES,Vec,double*); 105 extern int SNESGetMinimizationFunction(SNES,double*); 106 extern int SNESSetMinimizationFunctionTolerance(SNES,double); 107 extern int SNESLineSearchSetDampingParameter(SNES,Scalar*); 108 extern int SNESConverged_UM_LS(SNES,double,double,double,void*); 109 extern int SNESConverged_UM_TR(SNES,double,double,double,void*); 110 111 extern int SNESDefaultMatrixFreeMatAddNullSpace(Mat,int,int,Vec *); 112 113 /* Should these 2 routines be private? */ 114 extern int SNESComputeHessian(SNES,Vec,Mat*,Mat*,MatStructure*); 115 extern int SNESComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*); 116 117 #endif 118 119