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