1 /* $Id: ts.h,v 1.25 1998/03/24 00:41:45 balay 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 #define TS_EULER "euler" 14 #define TS_BEULER "beuler" 15 #define TS_PSEUDO "pseudo" 16 #define TS_PVODE "pvode" 17 18 typedef char *TSType; 19 20 typedef enum { TS_LINEAR, TS_NONLINEAR} TSProblemType; 21 22 extern int TSCreate(MPI_Comm,TSProblemType,TS*); 23 extern int TSSetType(TS,TSType); 24 extern int TSGetProblemType(TS,TSProblemType*); 25 extern int TSDestroy(TS); 26 27 extern int TSSetMonitor(TS,int(*)(TS,int,double,Vec,void*),void *); 28 extern int TSGetType(TS,TSType*); 29 30 extern int TSSetOptionsPrefix(TS, char *); 31 extern int TSAppendOptionsPrefix(TS, char *); 32 extern int TSGetOptionsPrefix(TS, char **); 33 extern int TSSetFromOptions(TS); 34 extern int TSSetUp(TS); 35 36 extern int TSSetSolution(TS,Vec); 37 extern int TSGetSolution(TS,Vec*); 38 39 extern int TSSetDuration(TS,int,double); 40 extern int TSPrintHelp(TS); 41 42 extern int TSDefaultMonitor(TS,int,double,Vec,void*); 43 extern int TSStep(TS,int *,double*); 44 45 extern int TSSetInitialTimeStep(TS,double,double); 46 extern int TSGetTimeStep(TS,double*); 47 extern int TSGetTime(TS,double*); 48 extern int TSGetTimeStepNumber(TS,int*); 49 extern int TSSetTimeStep(TS,double); 50 51 extern int TSSetRHSFunction(TS,int (*)(TS,double,Vec,Vec,void*),void*); 52 extern int TSSetRHSMatrix(TS,Mat,Mat,int (*)(TS,double,Mat*,Mat*,MatStructure*,void*),void*); 53 extern int TSSetRHSJacobian(TS,Mat,Mat,int(*)(TS,double,Vec,Mat*,Mat*,MatStructure*,void*),void*); 54 55 extern int TSDefaultComputeJacobianWithColoring(TS,double,Vec,Mat*,Mat*,MatStructure*,void*); 56 extern int TSSetRHSJacobianDefault(TS,MatFDColoring,Mat,Mat); 57 extern int TSDefaultComputeJacobianSlow(TS,double,Vec,Mat*,Mat*,MatStructure*,void*); 58 59 extern int TSGetRHSMatrix(TS,Mat*,Mat*,void**); 60 extern int TSGetRHSJacobian(TS,Mat*,Mat*,void**); 61 62 extern int TSPseudoSetTimeStep(TS,int(*)(TS,double*,void*),void*); 63 extern int TSPseudoDefaultTimeStep(TS,double*,void* ); 64 extern int TSPseudoComputeTimeStep(TS,double *); 65 66 extern int TSPseudoSetVerifyTimeStep(TS,int(*)(TS,Vec,void*,double*,int*),void*); 67 extern int TSPseudoDefaultVerifyTimeStep(TS,Vec,void*,double*,int*); 68 extern int TSPseudoVerifyTimeStep(TS,Vec,double*,int*); 69 extern int TSPseudoSetTimeStepIncrement(TS,double); 70 extern int TSPseudoIncrementDtFromInitialDt(TS); 71 72 extern int TSComputeRHSFunction(TS,double,Vec,Vec); 73 74 extern DLList TSList; 75 extern int TSRegisterAll(char*); 76 extern int TSRegisterDestroy(void); 77 extern int TSRegisterAllCalled; 78 79 extern int TSGetSNES(TS,SNES*); 80 extern int TSGetSLES(TS,SLES*); 81 82 extern int TSView(TS,Viewer); 83 84 extern int TSSetApplicationContext(TS,void *); 85 extern int TSGetApplicationContext(TS,void **); 86 87 extern int TSLGMonitorCreate(char *,char *,int,int,int,int, DrawLG *); 88 extern int TSLGMonitor(TS,int,double,Vec,void *); 89 extern int TSLGMonitorDestroy(DrawLG); 90 91 /* 92 PETSc interface to PVode 93 */ 94 #define PVODE_UNMODIFIED_GS PVODE_CLASSICAL_GS 95 typedef enum { PVODE_ADAMS, PVODE_BDF } TSPVodeType; 96 typedef enum { PVODE_MODIFIED_GS = 0, PVODE_CLASSICAL_GS = 1 } TSPVodeGramSchmidtType; 97 extern int TSPVodeSetType(TS,TSPVodeType); 98 extern int TSPVodeGetPC(TS,PC*); 99 extern int TSPVodeSetTolerance(TS,double,double); 100 extern int TSPVodeGetIterations(TS,int *,int *); 101 extern int TSPVodeSetGramSchmidtType(TS,TSPVodeGramSchmidtType); 102 extern int TSPVodeSetGMRESRestart(TS,int); 103 extern int TSPVodeSetLinearTolerance(TS,double); 104 extern int TSPVodeSetExactFinalTime(TS, PetscTruth); 105 106 #endif 107 108 109 110 111 112