1 /* $Id: ts.h,v 1.17 1997/08/22 15:20:23 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_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 51 extern int TSGetRHSMatrix(TS,Mat*,Mat*,void**); 52 extern int TSGetRHSJacobian(TS,Mat*,Mat*,void**); 53 54 extern int TSPseudoSetTimeStep(TS,int(*)(TS,double*,void*),void*); 55 extern int TSPseudoDefaultTimeStep(TS,double*,void* ); 56 extern int TSPseudoComputeTimeStep(TS,double *); 57 58 extern int TSPseudoSetVerifyTimeStep(TS,int(*)(TS,Vec,void*,double*,int*),void*); 59 extern int TSPseudoDefaultVerifyTimeStep(TS,Vec,void*,double*,int*); 60 extern int TSPseudoVerifyTimeStep(TS,Vec,double*,int*); 61 extern int TSPseudoSetTimeStepIncrement(TS,double); 62 extern int TSPseudoIncrementDtFromInitialDt(TS); 63 64 extern int TSComputeRHSFunction(TS,double,Vec,Vec); 65 66 extern int TSRegister(TSType,TSType*,char*,int (*)(TS)); 67 extern int TSRegisterAll(); 68 extern int TSRegisterDestroy(); 69 extern int TSRegisterAllCalled; 70 71 extern int TSGetSNES(TS,SNES*); 72 extern int TSGetSLES(TS,SLES*); 73 74 extern int TSView(TS,Viewer); 75 76 extern int TSSetApplicationContext(TS,void *); 77 extern int TSGetApplicationContext(TS,void **); 78 79 extern int TSLGMonitorCreate(char *,char *,int,int,int,int, DrawLG *); 80 extern int TSLGMonitor(TS,int,double,Vec,void *); 81 extern int TSLGMonitorDestroy(DrawLG); 82 83 /* 84 PETSc interface to PVode 85 */ 86 typedef enum { PVODE_ADAMS, PVODE_BDF } TSPVodeMethod; 87 88 extern int TSPVodeSetPCType(TS,PCType); 89 extern int TSPVodeGetPC(TS,PC*); 90 91 extern int TSPVodeKSPSetType(TS,KSPType); 92 extern int TSPVodeSetMethod(TS,TSPVodeMethod); 93 extern int TSPVodeSetRHSFunction(TS,double,Vec,Vec,void *); 94 extern int TSPVodeSetRHSJacobian(TS,double,Vec,Mat*,Mat*,MatStructure*,void *); 95 extern int TSComputeRHSJacobianForPVODE(TS,double,Vec,Mat*, 96 Mat*,MatStructure*,void*); 97 extern int TSComputeRHSFunctionForPVODE(TS,double,Vec,Vec,void*); 98 extern int TSPVodeGetUserData(TS, void*); 99 100 #endif 101 102 103 104 105 106