1 /* $Id: snes.h,v 1.33 1995/10/12 04:21:53 bsmith Exp bsmith $ */ 2 /* 3 User interface for the nonlinear solvers package. 4 */ 5 #if !defined(__SNES_PACKAGE) 6 #define __SNES_PACKAGE 7 #include "sles.h" 8 9 typedef struct _SNES* SNES; 10 #define SNES_COOKIE PETSC_COOKIE+13 11 12 typedef enum { SNES_UNKNOWN_METHOD=-1, 13 SNES_EQ_NLS, 14 SNES_EQ_NTR, 15 SNES_EQ_NTR_DOG_LEG, 16 SNES_EQ_NTR2_LIN, 17 SNES_EQ_NTEST, 18 SNES_UM_NLS, 19 SNES_UM_NTR 20 } SNESMethod; 21 22 typedef enum { POSITIVE_FUNCTION_VALUE, NEGATIVE_FUNCTION_VALUE} SNESFunctionSign; 23 24 typedef enum { SNES_NONLINEAR_EQUATIONS, SNES_UNCONSTRAINED_MINIMIZATION} SNESType; 25 26 extern int SNESCreate(MPI_Comm,SNESType,SNES*); 27 extern int SNESSetMethod(SNES,SNESMethod); 28 extern int SNESSetMonitor(SNES,int(*)(SNES,int,double,void*),void *); 29 extern int SNESSetSolution(SNES,Vec,int(*)(SNES,Vec,void*),void *); 30 extern int SNESSetFunction(SNES,Vec,int(*)(SNES,Vec,Vec,void*),void *,SNESFunctionSign); 31 extern int SNESSetJacobian(SNES,Mat,Mat,int(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *); 32 extern int SNESDestroy(SNES); 33 extern int SNESSetUp(SNES); 34 extern int SNESSolve(SNES,int*); 35 extern int SNESRegister(int,char*,int(*)(SNES)); 36 extern int SNESRegisterDestroy(); 37 extern int SNESRegisterAll(); 38 extern int SNESGetSLES(SNES,SLES*); 39 extern int SNESNoLineSearch(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 40 extern int SNESCubicLineSearch(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 41 extern int SNESQuadraticLineSearch(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 42 extern int SNESSetLineSearchRoutine(SNES,int(*)(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*)); 43 44 extern int SNESGetSolution(SNES,Vec*); 45 extern int SNESGetSolutionUpdate(SNES,Vec*); 46 extern int SNESGetFunction(SNES,Vec*); 47 48 extern int SNESPrintHelp(SNES); 49 extern int SNESView(SNES,Viewer); 50 extern int SNESSetFromOptions(SNES); 51 extern int SNESGetMethodName(SNESMethod,char **); 52 extern int SNESGetMethodFromContext(SNES,SNESMethod*); 53 extern int SNESDefaultMonitor(SNES,int,double,void *); 54 extern int SNESDefaultSMonitor(SNES,int,double,void *); 55 extern int SNESDefaultConverged(SNES,double,double,double,void*); 56 extern int SNESTrustRegionDefaultConverged(SNES,double,double,double,void*); 57 extern int SNESSetSolutionTolerance(SNES,double); 58 extern int SNESSetAbsoluteTolerance(SNES,double); 59 extern int SNESSetRelativeTolerance(SNES,double); 60 extern int SNESSetTruncationTolerance(SNES,double); 61 extern int SNESSetTrustRegionTolerance(SNES,double); 62 extern int SNESSetMaxIterations(SNES,int); 63 extern int SNESSetMaxFunctionEvaluations(SNES,int); 64 extern int SNESGetIterationNumber(SNES,int*); 65 extern int SNESGetFunctionNorm(SNES,Scalar*); 66 extern int SNESGetNumberUnsuccessfulSteps(SNES,int*); 67 extern int SNES_KSP_SetParametersEW(SNES,int,double,double,double,double,double,double); 68 extern int SNES_KSP_SetConvergenceTestEW(SNES); 69 70 #if defined(__DRAW_PACKAGE) 71 #define SNESLGMonitorCreate KSPLGMonitorCreate 72 #define SNESLGMonitorDestroy KSPLGMonitorDestroy 73 #define SNESLGMonitor ((int (*)(SNES,int,double,void*))KSPLGMonitor) 74 #endif 75 76 extern int SNESComputeInitialGuess(SNES,Vec); 77 78 extern int SNESDefaultComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 79 extern int SNESDefaultMatrixFreeMatCreate(SNES,Vec x,Mat*); 80 81 extern int SNESComputeFunction(SNES,Vec,Vec); 82 extern int SNESDestroy(SNES); 83 84 extern int SNESSetApplicationContext(SNES,void *); 85 extern int SNESGetApplicationContext(SNES,void **); 86 extern int SNESSetConvergenceTest(SNES,int (*)(SNES,double,double,double,void*),void*); 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