1 /* $Id: ts.h,v 1.39 2000/02/02 21:21:25 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_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_CRANK_NICHOLSON "crank-nicholson" 17 #define TS_PVODE "pvode" 18 19 typedef char *TSType; 20 21 typedef enum {TS_LINEAR,TS_NONLINEAR} TSProblemType; 22 23 extern int TSCreate(MPI_Comm,TSProblemType,TS*); 24 extern int TSSetType(TS,TSType); 25 extern int TSGetProblemType(TS,TSProblemType*); 26 extern int TSDestroy(TS); 27 28 extern int TSSetMonitor(TS,int(*)(TS,int,double,Vec,void*),void *,int (*)(void*)); 29 extern int TSClearMonitor(TS); 30 extern int TSGetType(TS,TSType*); 31 32 extern int TSSetOptionsPrefix(TS,char *); 33 extern int TSAppendOptionsPrefix(TS,char *); 34 extern int TSGetOptionsPrefix(TS,char **); 35 extern int TSSetFromOptions(TS); 36 extern int TSSetTypeFromOptions(TS); 37 extern int TSSetUp(TS); 38 39 extern int TSSetSolution(TS,Vec); 40 extern int TSGetSolution(TS,Vec*); 41 42 extern int TSSetDuration(TS,int,double); 43 extern int TSPrintHelp(TS); 44 45 extern int TSDefaultMonitor(TS,int,double,Vec,void*); 46 extern int TSStep(TS,int *,double*); 47 48 extern int TSSetInitialTimeStep(TS,double,double); 49 extern int TSGetTimeStep(TS,double*); 50 extern int TSGetTime(TS,double*); 51 extern int TSGetTimeStepNumber(TS,int*); 52 extern int TSSetTimeStep(TS,double); 53 54 extern int TSSetRHSFunction(TS,int (*)(TS,double,Vec,Vec,void*),void*); 55 extern int TSSetRHSMatrix(TS,Mat,Mat,int (*)(TS,double,Mat*,Mat*,MatStructure*,void*),void*); 56 extern int TSSetRHSJacobian(TS,Mat,Mat,int(*)(TS,double,Vec,Mat*,Mat*,MatStructure*,void*),void*); 57 extern int TSSetRHSBoundaryConditions(TS,int (*)(TS,double,Vec,void*),void*); 58 59 extern int TSDefaultComputeJacobianColor(TS,double,Vec,Mat*,Mat*,MatStructure*,void*); 60 extern int TSDefaultComputeJacobian(TS,double,Vec,Mat*,Mat*,MatStructure*,void*); 61 62 extern int TSGetRHSMatrix(TS,Mat*,Mat*,void**); 63 extern int TSGetRHSJacobian(TS,Mat*,Mat*,void**); 64 65 extern int TSPseudoSetTimeStep(TS,int(*)(TS,double*,void*),void*); 66 extern int TSPseudoDefaultTimeStep(TS,double*,void*); 67 extern int TSPseudoComputeTimeStep(TS,double *); 68 69 extern int TSPseudoSetVerifyTimeStep(TS,int(*)(TS,Vec,void*,double*,int*),void*); 70 extern int TSPseudoDefaultVerifyTimeStep(TS,Vec,void*,double*,int*); 71 extern int TSPseudoVerifyTimeStep(TS,Vec,double*,int*); 72 extern int TSPseudoSetTimeStepIncrement(TS,double); 73 extern int TSPseudoIncrementDtFromInitialDt(TS); 74 75 extern int TSComputeRHSFunction(TS,double,Vec,Vec); 76 extern int TSComputeRHSBoundaryConditions(TS,double,Vec); 77 extern int TSComputeRHSJacobian(TS,double,Vec,Mat*,Mat*,MatStructure*); 78 79 extern FList TSList; 80 extern int TSRegisterAll(char*); 81 extern int TSRegisterDestroy(void); 82 extern PetscTruth TSRegisterAllCalled; 83 84 extern int TSRegister(char*,char*,char*,int(*)(TS)); 85 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 86 #define TSRegisterDynamic(a,b,c,d) TSRegister(a,b,c,0) 87 #else 88 #define TSRegisterDynamic(a,b,c,d) TSRegister(a,b,c,d) 89 #endif 90 91 extern int TSGetSNES(TS,SNES*); 92 extern int TSGetSLES(TS,SLES*); 93 94 extern int TSView(TS,Viewer); 95 96 extern int TSSetApplicationContext(TS,void *); 97 extern int TSGetApplicationContext(TS,void **); 98 99 extern int TSLGMonitorCreate(char *,char *,int,int,int,int,DrawLG *); 100 extern int TSLGMonitor(TS,int,double,Vec,void *); 101 extern int TSLGMonitorDestroy(DrawLG); 102 103 /* 104 PETSc interface to PVode 105 */ 106 #define PVODE_UNMODIFIED_GS PVODE_CLASSICAL_GS 107 typedef enum { PVODE_ADAMS,PVODE_BDF } TSPVodeType; 108 typedef enum { PVODE_MODIFIED_GS = 0,PVODE_CLASSICAL_GS = 1 } TSPVodeGramSchmidtType; 109 extern int TSPVodeSetType(TS,TSPVodeType); 110 extern int TSPVodeGetPC(TS,PC*); 111 extern int TSPVodeSetTolerance(TS,double,double); 112 extern int TSPVodeGetIterations(TS,int *,int *); 113 extern int TSPVodeSetGramSchmidtType(TS,TSPVodeGramSchmidtType); 114 extern int TSPVodeSetGMRESRestart(TS,int); 115 extern int TSPVodeSetLinearTolerance(TS,double); 116 extern int TSPVodeSetExactFinalTime(TS,PetscTruth); 117 118 #endif 119 120 121 122 123 124