1 /* $Id: snes.h,v 1.29 1995/08/02 04:19:29 bsmith Exp curfman $ */ 2 3 #if !defined(__SNES_PACKAGE) 4 #define __SNES_PACKAGE 5 #include "sles.h" 6 7 typedef struct _SNES* SNES; 8 #define SNES_COOKIE PETSC_COOKIE+13 9 10 typedef enum { SNES_UNKNOWN_METHOD=-1, 11 SNES_EQ_NLS, 12 SNES_EQ_NTR, 13 SNES_EQ_NTR_DOG_LEG, 14 SNES_EQ_NTR2_LIN, 15 SNES_EQ_NTEST, 16 SNES_UM_NLS, 17 SNES_UM_NTR } 18 SNESMethod; 19 20 #define SNES_NLS SNES_EQ_NLS 21 #define SNES_NTR SNES_EQ_NTR 22 #define SNES_NTR2_LIN SNES_EQ_NTR2_LIN 23 #define SNES_NTR_DOG_LEG SNES_EQ_NTR_DOG_LEG 24 #define SNES_NTEST SNES_EQ_NTEST 25 26 typedef enum { SNES_NONLINEAR_EQUATIONS, SNES_UNCONSTRAINED_MINIMIZATION } 27 SNESType; 28 29 extern int SNESCreate(MPI_Comm,SNESType,SNES*); 30 extern int SNESSetMethod(SNES,SNESMethod); 31 extern int SNESSetMonitor(SNES,int(*)(SNES,int,double,void*),void *); 32 extern int SNESSetSolution(SNES,Vec,int(*)(SNES,Vec,void*),void *); 33 extern int SNESSetFunction(SNES,Vec,int(*)(SNES,Vec,Vec,void*),void *,int); 34 extern int SNESSetJacobian(SNES,Mat,Mat,int(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *); 35 extern int SNESDestroy(SNES); 36 extern int SNESSetUp(SNES); 37 extern int SNESSolve(SNES,int*); 38 extern int SNESRegister(int,char*,int(*)(SNES)); 39 extern int SNESRegisterAll(); 40 extern int SNESGetSLES(SNES,SLES*); 41 extern int SNESNoLineSearch(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 42 extern int SNESCubicLineSearch(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 43 extern int SNESQuadraticLineSearch(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 44 extern int SNESSetLineSearchRoutine(SNES,int(*)(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*)); 45 46 extern int SNESGetSolution(SNES,Vec*); 47 extern int SNESGetSolutionUpdate(SNES,Vec*); 48 extern int SNESGetFunction(SNES,Vec*); 49 50 extern int SNESPrintHelp(SNES); 51 extern int SNESView(SNES,Viewer); 52 extern int SNESSetFromOptions(SNES); 53 extern int SNESGetMethodName(SNESMethod,char **); 54 extern int SNESGetMethodFromContext(SNES,SNESMethod*); 55 extern int SNESDefaultMonitor(SNES,int,double,void *); 56 extern int SNESDefaultSMonitor(SNES,int,double,void *); 57 extern int SNESDefaultConverged(SNES,double,double,double,void*); 58 extern int SNESDefaultTrustRegionConverged(SNES,double,double,double,void*); 59 60 extern int SNESSetSolutionTolerance(SNES,double); 61 extern int SNESSetAbsoluteTolerance(SNES,double); 62 extern int SNESSetRelativeTolerance(SNES,double); 63 extern int SNESSetTruncationTolerance(SNES,double); 64 extern int SNESSetTrustRegionTolerance(SNES,double); 65 extern int SNESSetMaxIterations(SNES,int); 66 extern int SNESSetMaxFunctionEvaluations(SNES,int); 67 extern int SNESGetIterationNumber(SNES,int*); 68 extern int SNESGetFunctionNorm(SNES,Scalar*); 69 extern int SNESGetNumberUnsuccessfulSteps(SNES,int*); 70 extern int SNES_KSP_SetParametersEW(SNES,int,double,double,double,double,double,double); 71 extern int SNES_KSP_SetConvergenceTestEW(SNES); 72 73 #if defined(__DRAW_PACKAGE) 74 #define SNESLGMonitorCreate KSPLGMonitorCreate 75 #define SNESLGMonitorDestroy KSPLGMonitorDestroy 76 #define SNESLGMonitor ((int (*)(SNES,int,double,void*))KSPLGMonitor) 77 #endif 78 79 extern int SNESComputeInitialGuess(SNES,Vec); 80 81 extern int SNESDefaultComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 82 extern int SNESDefaultMatrixFreeMatCreate(SNES,Vec x,Mat*); 83 84 extern int SNESComputeFunction(SNES,Vec,Vec); 85 extern int SNESDestroy(SNES); 86 87 88 /* Unconstrained minimization routines */ 89 90 extern int SNESSetHessian(SNES,Mat,Mat,int(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *); 91 extern int SNESSetGradient(SNES,Vec,int(*)(SNES,Vec,Vec,void*),void*); 92 extern int SNESGetGradient(SNES,Vec*); 93 extern int SNESGetGradientNorm(SNES,Scalar*); 94 extern int SNESComputeGradient(SNES,Vec,Vec); 95 extern int SNESSetMinimizationFunction(SNES,int(*)(SNES,Vec,double*,void*),void*); 96 extern int SNESComputeMinimizationFunction(SNES,Vec,double*); 97 extern int SNESGetMinimizationFunction(SNES,double*); 98 extern int SNESSetMinFunctionTolerance(SNES,double); 99 extern int SNESGetLineSearchDampingParameter(SNES,double*); 100 101 /* Should these 2 routines be private? */ 102 extern int SNESComputeHessian(SNES,Vec,Mat*,Mat*,MatStructure*); 103 extern int SNESComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*); 104 105 #endif 106 107