1*761aaf1bSLois Curfman McInnes /* $Id: snes.h,v 1.20 1995/06/14 02:10:31 bsmith Exp curfman $ */ 2b1f5cb9dSBarry Smith 3f03417d3SBarry Smith #if !defined(__SNES_PACKAGE) 4f03417d3SBarry Smith #define __SNES_PACKAGE 5ce3d82beSBarry Smith #include "sles.h" 6b1f5cb9dSBarry Smith 7353a3ba4SBarry Smith typedef struct _SNES* SNES; 8ce3d82beSBarry Smith #define SNES_COOKIE PETSC_COOKIE+13 9b1f5cb9dSBarry Smith 10ce3d82beSBarry Smith typedef enum { SNES_NLS, 11ce3d82beSBarry Smith SNES_NTR, 12ce3d82beSBarry Smith SNES_NTR_DOG_LEG, 13353a3ba4SBarry Smith SNES_NTR2_LIN, 14ce3d82beSBarry Smith SUMS_NLS, 15c6abb9f5SBarry Smith SUMS_NTR, 16748e9f0dSBarry Smith SNES_NTEST } 1794a5d57cSLois Curfman McInnes SNESMethod; 18b1f5cb9dSBarry Smith 1906259719SBarry Smith typedef enum { SNES_T, SUMS_T } SNESType; 20f03417d3SBarry Smith 21ce3d82beSBarry Smith extern int SNESCreate(MPI_Comm,SNES*); 2294a5d57cSLois Curfman McInnes extern int SNESSetMethod(SNES,SNESMethod); 23eafb4bcbSBarry Smith extern int SNESSetMonitor(SNES, int (*)(SNES,int,double,void*),void *); 244d08eca6SBarry Smith extern int SNESSetSolution(SNES,Vec,int (*)(SNES,Vec,void*),void *); 254d08eca6SBarry Smith extern int SNESSetFunction(SNES, Vec, int (*)(SNES,Vec,Vec,void*),void *,int); 26722fc279SLois Curfman McInnes extern int SNESSetJacobian(SNES,Mat,Mat,int(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *); 27ce3d82beSBarry Smith extern int SNESDestroy(SNES); 28353a3ba4SBarry Smith extern int SNESSetUp(SNES); 29ce3d82beSBarry Smith extern int SNESSolve(SNES,int*); 30ce3d82beSBarry Smith extern int SNESRegister(int, char*, int (*)(SNES)); 31ce3d82beSBarry Smith extern int SNESRegisterAll(); 32ce3d82beSBarry Smith extern int SNESGetSLES(SNES,SLES*); 33*761aaf1bSLois Curfman McInnes extern int SNESNoLineSearch(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 34*761aaf1bSLois Curfman McInnes extern int SNESCubicLineSearch(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 35*761aaf1bSLois Curfman McInnes extern int SNESQuadraticLineSearch(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*); 36*761aaf1bSLois Curfman McInnes extern int SNESSetLineSearchRoutine(SNES,int(*)(SNES,Vec,Vec,Vec,Vec,Vec,double,double*,double*,int*)); 37ce3d82beSBarry Smith 38ce3d82beSBarry Smith extern int SNESGetSolution(SNES,Vec*); 39e81d6643SLois Curfman McInnes extern int SNESGetSolutionUpdate(SNES,Vec*); 40eafb4bcbSBarry Smith extern int SNESGetFunction(SNES,Vec*); 41ce3d82beSBarry Smith 42ce3d82beSBarry Smith extern int SNESPrintHelp(SNES); 43ce3d82beSBarry Smith extern int SNESSetFromOptions(SNES); 4494a5d57cSLois Curfman McInnes extern int SNESGetMethodName(SNESMethod,char **); 45eafb4bcbSBarry Smith extern int SNESDefaultMonitor(SNES,int,double,void *); 46c512e24aSBarry Smith extern int SNESDefaultSMonitor(SNES,int,double,void *); 47ce3d82beSBarry Smith extern int SNESDefaultConverged(SNES,double,double,double,void*); 48ce3d82beSBarry Smith 490de89847SLois Curfman McInnes extern int SNESSetSolutionTolerance(SNES,double); 500de89847SLois Curfman McInnes extern int SNESSetAbsoluteTolerance(SNES,double); 510de89847SLois Curfman McInnes extern int SNESSetRelativeTolerance(SNES,double); 520de89847SLois Curfman McInnes extern int SNESSetTruncationTolerance(SNES,double); 530de89847SLois Curfman McInnes extern int SNESSetMaxIterations(SNES,int); 5406be10caSBarry Smith extern int SNESSetMaxFunctionEvaluations(SNES,int); 557e984346SBarry Smith extern int SNESGetIterationNumber(SNES,int*); 56eafb4bcbSBarry Smith 57eafb4bcbSBarry Smith #if defined(__DRAW_PACKAGE) 58eafb4bcbSBarry Smith #define SNESLGMonitorCreate KSPLGMonitorCreate 59eafb4bcbSBarry Smith #define SNESLGMonitorDestroy KSPLGMonitorDestroy 60eafb4bcbSBarry Smith #define SNESLGMonitor ((int (*)(SNES,int,double,void*))KSPLGMonitor) 61eafb4bcbSBarry Smith #endif 62eafb4bcbSBarry Smith 63748e9f0dSBarry Smith extern int SNESComputeInitialGuess(SNES,Vec); 64df60cc22SBarry Smith 65722fc279SLois Curfman McInnes extern int SNESDefaultComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 66722fc279SLois Curfman McInnes extern int SNESDefaultMatrixFreeComputeJacobian(SNES,Vec,Mat*,Mat*, 67722fc279SLois Curfman McInnes MatStructure*,void*); 687e984346SBarry Smith extern int SNESDefaultMatrixFreeMatCreate(SNES,Vec x,Mat*); 69748e9f0dSBarry Smith 707f813858SBarry Smith extern int SNESComputeFunction(SNES,Vec,Vec); 717f813858SBarry Smith extern int SNESComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void *); 72ce3d82beSBarry Smith #endif 73b1f5cb9dSBarry Smith 74