1 /* $Id: ts.h,v 1.29 1998/06/11 19:59:10 bsmith Exp curfman $ */ 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_H) 7 #define __TS_H 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 TSClearMonitor(TS); 29 extern int TSGetType(TS,TSType*); 30 31 extern int TSSetOptionsPrefix(TS, char *); 32 extern int TSAppendOptionsPrefix(TS, char *); 33 extern int TSGetOptionsPrefix(TS, char **); 34 extern int TSSetFromOptions(TS); 35 extern int TSSetUp(TS); 36 37 extern int TSSetSolution(TS,Vec); 38 extern int TSGetSolution(TS,Vec*); 39 40 extern int TSSetDuration(TS,int,double); 41 extern int TSPrintHelp(TS); 42 43 extern int TSDefaultMonitor(TS,int,double,Vec,void*); 44 extern int TSStep(TS,int *,double*); 45 46 extern int TSSetInitialTimeStep(TS,double,double); 47 extern int TSGetTimeStep(TS,double*); 48 extern int TSGetTime(TS,double*); 49 extern int TSGetTimeStepNumber(TS,int*); 50 extern int TSSetTimeStep(TS,double); 51 52 extern int TSSetRHSFunction(TS,int (*)(TS,double,Vec,Vec,void*),void*); 53 extern int TSSetRHSMatrix(TS,Mat,Mat,int (*)(TS,double,Mat*,Mat*,MatStructure*,void*),void*); 54 extern int TSSetRHSJacobian(TS,Mat,Mat,int(*)(TS,double,Vec,Mat*,Mat*,MatStructure*,void*),void*); 55 56 extern int TSDefaultComputeJacobianWithColoring(TS,double,Vec,Mat*,Mat*,MatStructure*,void*); 57 extern int TSSetRHSJacobianDefault(TS,MatFDColoring,Mat,Mat); 58 extern int TSDefaultComputeJacobianSlow(TS,double,Vec,Mat*,Mat*,MatStructure*,void*); 59 60 extern int TSGetRHSMatrix(TS,Mat*,Mat*,void**); 61 extern int TSGetRHSJacobian(TS,Mat*,Mat*,void**); 62 63 extern int TSPseudoSetTimeStep(TS,int(*)(TS,double*,void*),void*); 64 extern int TSPseudoDefaultTimeStep(TS,double*,void* ); 65 extern int TSPseudoComputeTimeStep(TS,double *); 66 67 extern int TSPseudoSetVerifyTimeStep(TS,int(*)(TS,Vec,void*,double*,int*),void*); 68 extern int TSPseudoDefaultVerifyTimeStep(TS,Vec,void*,double*,int*); 69 extern int TSPseudoVerifyTimeStep(TS,Vec,double*,int*); 70 extern int TSPseudoSetTimeStepIncrement(TS,double); 71 extern int TSPseudoIncrementDtFromInitialDt(TS); 72 73 extern int TSComputeRHSFunction(TS,double,Vec,Vec); 74 75 extern DLList TSList; 76 extern int TSRegisterAll(char*); 77 extern int TSRegisterDestroy(void); 78 extern int TSRegisterAllCalled; 79 80 extern int TSRegister_Private(char*,char*,char*,int(*)(TS)); 81 #if defined(USE_DYNAMIC_LIBRARIES) 82 #define TSRegister(a,b,c,d) TSRegister_Private(a,b,c,0) 83 #else 84 #define TSRegister(a,b,c,d) TSRegister_Private(a,b,c,d) 85 #endif 86 87 extern int TSGetSNES(TS,SNES*); 88 extern int TSGetSLES(TS,SLES*); 89 90 extern int TSView(TS,Viewer); 91 92 extern int TSSetApplicationContext(TS,void *); 93 extern int TSGetApplicationContext(TS,void **); 94 95 extern int TSLGMonitorCreate(char *,char *,int,int,int,int, DrawLG *); 96 extern int TSLGMonitor(TS,int,double,Vec,void *); 97 extern int TSLGMonitorDestroy(DrawLG); 98 99 /* 100 PETSc interface to PVode 101 */ 102 #define PVODE_UNMODIFIED_GS PVODE_CLASSICAL_GS 103 typedef enum { PVODE_ADAMS, PVODE_BDF } TSPVodeType; 104 typedef enum { PVODE_MODIFIED_GS = 0, PVODE_CLASSICAL_GS = 1 } TSPVodeGramSchmidtType; 105 extern int TSPVodeSetType(TS,TSPVodeType); 106 extern int TSPVodeGetPC(TS,PC*); 107 extern int TSPVodeSetTolerance(TS,double,double); 108 extern int TSPVodeGetIterations(TS,int *,int *); 109 extern int TSPVodeSetGramSchmidtType(TS,TSPVodeGramSchmidtType); 110 extern int TSPVodeSetGMRESRestart(TS,int); 111 extern int TSPVodeSetLinearTolerance(TS,double); 112 extern int TSPVodeSetExactFinalTime(TS, PetscTruth); 113 114 #endif 115 116 117 118 119 120