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