1 /* $Id: snes.h,v 1.20 1995/06/14 02:10:31 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_NLS, 11 SNES_NTR, 12 SNES_NTR_DOG_LEG, 13 SNES_NTR2_LIN, 14 SUMS_NLS, 15 SUMS_NTR, 16 SNES_NTEST } 17 SNESMethod; 18 19 typedef enum { SNES_T, SUMS_T } SNESType; 20 21 extern int SNESCreate(MPI_Comm,SNES*); 22 extern int SNESSetMethod(SNES,SNESMethod); 23 extern int SNESSetMonitor(SNES, int (*)(SNES,int,double,void*),void *); 24 extern int SNESSetSolution(SNES,Vec,int (*)(SNES,Vec,void*),void *); 25 extern int SNESSetFunction(SNES, Vec, int (*)(SNES,Vec,Vec,void*),void *,int); 26 extern int SNESSetJacobian(SNES,Mat,Mat,int(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *); 27 extern int SNESDestroy(SNES); 28 extern int SNESSetUp(SNES); 29 extern int SNESSolve(SNES,int*); 30 extern int SNESRegister(int, char*, int (*)(SNES)); 31 extern int SNESRegisterAll(); 32 extern int SNESGetSLES(SNES,SLES*); 33 extern int SNESNoLineSearch(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 34 extern int SNESCubicLineSearch(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 35 extern int SNESQuadraticLineSearch(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 36 extern int SNESSetLineSearchRoutine(SNES,int(*)(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*)); 37 38 extern int SNESGetSolution(SNES,Vec*); 39 extern int SNESGetSolutionUpdate(SNES,Vec*); 40 extern int SNESGetFunction(SNES,Vec*); 41 42 extern int SNESPrintHelp(SNES); 43 extern int SNESSetFromOptions(SNES); 44 extern int SNESGetMethodName(SNESMethod,char **); 45 extern int SNESDefaultMonitor(SNES,int,double,void *); 46 extern int SNESDefaultSMonitor(SNES,int,double,void *); 47 extern int SNESDefaultConverged(SNES,double,double,double,void*); 48 49 extern int SNESSetSolutionTolerance(SNES,double); 50 extern int SNESSetAbsoluteTolerance(SNES,double); 51 extern int SNESSetRelativeTolerance(SNES,double); 52 extern int SNESSetTruncationTolerance(SNES,double); 53 extern int SNESSetMaxIterations(SNES,int); 54 extern int SNESSetMaxFunctionEvaluations(SNES,int); 55 extern int SNESGetIterationNumber(SNES,int*); 56 57 #if defined(__DRAW_PACKAGE) 58 #define SNESLGMonitorCreate KSPLGMonitorCreate 59 #define SNESLGMonitorDestroy KSPLGMonitorDestroy 60 #define SNESLGMonitor ((int (*)(SNES,int,double,void*))KSPLGMonitor) 61 #endif 62 63 extern int SNESComputeInitialGuess(SNES,Vec); 64 65 extern int SNESDefaultComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 66 extern int SNESDefaultMatrixFreeComputeJacobian(SNES,Vec,Mat*,Mat*, 67 MatStructure*,void*); 68 extern int SNESDefaultMatrixFreeMatCreate(SNES,Vec x,Mat*); 69 70 extern int SNESComputeFunction(SNES,Vec,Vec); 71 extern int SNESComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void *); 72 #endif 73 74