1 /* $Id: ts.h,v 1.21 1998/01/14 02:47:08 bsmith Exp bsmith $ */ 2 /* 3 User interface for the timestepping package. This is package 4 is for use in solving time-dependent PDEs. 5 */ 6 #if !defined(__TS_PACKAGE) 7 #define __TS_PACKAGE 8 #include "snes.h" 9 10 typedef struct _p_TS* TS; 11 #define TS_COOKIE PETSC_COOKIE+18 12 13 typedef enum { TS_UNKNOWN = -1,TS_EULER, TS_BEULER, TS_PSEUDO, TS_PVODE, TS_NEW} TSType; 14 typedef enum { TS_LINEAR, TS_NONLINEAR} TSProblemType; 15 16 extern int TSCreate(MPI_Comm,TSProblemType,TS*); 17 extern int TSSetType(TS,TSType); 18 extern int TSGetProblemType(TS,TSProblemType*); 19 extern int TSDestroy(TS); 20 21 extern int TSSetMonitor(TS,int(*)(TS,int,double,Vec,void*),void *); 22 extern int TSGetType(TS,TSType*,char**); 23 24 extern int TSSetOptionsPrefix(TS, char *); 25 extern int TSAppendOptionsPrefix(TS, char *); 26 extern int TSGetOptionsPrefix(TS, char **); 27 extern int TSSetFromOptions(TS); 28 extern int TSSetUp(TS); 29 30 extern int TSSetSolution(TS,Vec); 31 extern int TSGetSolution(TS,Vec*); 32 33 extern int TSSetDuration(TS,int,double); 34 extern int TSPrintHelp(TS); 35 36 extern int TSDefaultMonitor(TS,int,double,Vec,void*); 37 extern int TSStep(TS,int *,double*); 38 39 extern int TSSetInitialTimeStep(TS,double,double); 40 extern int TSGetTimeStep(TS,double*); 41 extern int TSGetTime(TS,double*); 42 extern int TSGetTimeStepNumber(TS,int*); 43 extern int TSSetTimeStep(TS,double); 44 45 extern int TSSetRHSFunction(TS,int (*)(TS,double,Vec,Vec,void*),void*); 46 extern int TSSetRHSMatrix(TS,Mat,Mat,int (*)(TS,double,Mat*,Mat*,MatStructure*,void*),void*); 47 extern int TSSetRHSJacobian(TS,Mat,Mat,int(*)(TS,double,Vec,Mat*,Mat*,MatStructure*,void*),void*); 48 49 extern int TSDefaultComputeJacobianWithColoring(TS,double,Vec,Mat*,Mat*,MatStructure*,void*); 50 extern int TSSetRHSJacobianDefault(TS,MatFDColoring,Mat,Mat); 51 extern int TSDefaultComputeJacobianSlow(TS,double,Vec,Mat*,Mat*,MatStructure*,void*); 52 53 extern int TSGetRHSMatrix(TS,Mat*,Mat*,void**); 54 extern int TSGetRHSJacobian(TS,Mat*,Mat*,void**); 55 56 extern int TSPseudoSetTimeStep(TS,int(*)(TS,double*,void*),void*); 57 extern int TSPseudoDefaultTimeStep(TS,double*,void* ); 58 extern int TSPseudoComputeTimeStep(TS,double *); 59 60 extern int TSPseudoSetVerifyTimeStep(TS,int(*)(TS,Vec,void*,double*,int*),void*); 61 extern int TSPseudoDefaultVerifyTimeStep(TS,Vec,void*,double*,int*); 62 extern int TSPseudoVerifyTimeStep(TS,Vec,double*,int*); 63 extern int TSPseudoSetTimeStepIncrement(TS,double); 64 extern int TSPseudoIncrementDtFromInitialDt(TS); 65 66 extern int TSComputeRHSFunction(TS,double,Vec,Vec); 67 68 extern int TSRegisterAll(); 69 extern int TSRegisterDestroy(); 70 extern int TSRegisterAllCalled; 71 extern int TSRegister_Private(TSType,char *,char *,int (*)(TS),TSType*); 72 #if defined(USE_DYNAMIC_LIBRARIES) 73 #define TSRegister(a,b,c,d,e) TSRegister_Private(a,b,c,0,e) 74 #else 75 #define TSRegister(a,b,c,d,e) TSRegister_Private(a,b,c,d,e) 76 #endif 77 78 extern int TSGetSNES(TS,SNES*); 79 extern int TSGetSLES(TS,SLES*); 80 81 extern int TSView(TS,Viewer); 82 83 extern int TSSetApplicationContext(TS,void *); 84 extern int TSGetApplicationContext(TS,void **); 85 86 extern int TSLGMonitorCreate(char *,char *,int,int,int,int, DrawLG *); 87 extern int TSLGMonitor(TS,int,double,Vec,void *); 88 extern int TSLGMonitorDestroy(DrawLG); 89 90 /* 91 PETSc interface to PVode 92 */ 93 typedef enum { PVODE_ADAMS, PVODE_BDF } TSPVodeType; 94 extern int TSPVodeSetType(TS,TSPVodeType); 95 extern int TSPVodeGetPC(TS,PC*); 96 extern int TSPVodeSetTolerance(TS,double,double); 97 typedef enum { PVODE_MODIFIED_GS = 0, PVODE_CLASSICAL_GS = 1 } TSPVodeGramSchmidtType; 98 #define PVODE_UNMODIFIED_GS PVODE_CLASSICAL_GS 99 extern int TSPVodeSetGramSchmidtType(TS,TSPVodeGramSchmidtType); 100 extern int TSPVodeSetGMRESRestart(TS,int); 101 extern int TSPVodeSetLinearTolerance(TS,double); 102 103 #endif 104 105 106 107 108 109