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