xref: /petsc/include/petscts.h (revision 83e2fdc756c13f964f3ed5aaff42e3626c5b72bc)
1 /* $Id: ts.h,v 1.14 1997/05/23 18:33:48 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 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 TSDestroy(TS);
19 
20 extern int TSSetMonitor(TS,int(*)(TS,int,double,Vec,void*),void *);
21 extern int TSGetType(TS,TSType*,char**);
22 
23 extern int TSSetFromOptions(TS);
24 extern int TSSetUp(TS);
25 
26 extern int TSSetSolution(TS,Vec);
27 extern int TSGetSolution(TS,Vec*);
28 
29 extern int TSSetDuration(TS,int,double);
30 extern int TSPrintHelp(TS);
31 
32 extern int TSDefaultMonitor(TS,int,double,Vec,void*);
33 extern int TSStep(TS,int *,double*);
34 
35 extern int TSSetInitialTimeStep(TS,double,double);
36 extern int TSGetTimeStep(TS,double*);
37 extern int TSGetTimeStepNumber(TS,int*);
38 extern int TSSetTimeStep(TS,double);
39 
40 extern int TSSetRHSFunction(TS,int (*)(TS,double,Vec,Vec,void*),void*);
41 extern int TSSetRHSMatrix(TS,Mat,Mat,int (*)(TS,double,Mat*,Mat*,MatStructure*,void*),void*);
42 extern int TSSetRHSJacobian(TS,Mat,Mat,int(*)(TS,double,Vec,Mat*,Mat*,MatStructure*,void*),void*);
43 
44 extern int TSPseudoSetTimeStep(TS,int(*)(TS,double*,void*),void*);
45 extern int TSPseudoDefaultTimeStep(TS,double*,void* );
46 extern int TSPseudoComputeTimeStep(TS,double *);
47 
48 extern int TSPseudoSetVerifyTimeStep(TS,int(*)(TS,Vec,void*,double*,int*),void*);
49 extern int TSPseudoDefaultVerifyTimeStep(TS,Vec,void*,double*,int*);
50 extern int TSPseudoVerifyTimeStep(TS,Vec,double*,int*);
51 extern int TSPseudoSetTimeStepIncrement(TS,double);
52 extern int TSPseudoIncrementDtFromInitialDt(TS);
53 
54 extern int TSComputeRHSFunction(TS,double,Vec,Vec);
55 
56 extern int TSRegister(TSType,TSType*,char*,int (*)(TS));
57 extern int TSRegisterAll();
58 extern int TSRegisterDestroy();
59 extern int TSRegisterAllCalled;
60 
61 extern int TSGetSNES(TS,SNES*);
62 extern int TSGetSLES(TS,SLES*);
63 
64 extern int TSView(TS,Viewer);
65 
66 extern int TSSetApplicationContext(TS,void *);
67 extern int TSGetApplicationContext(TS,void **);
68 
69 /*
70        PETSc interface to PVode
71 */
72 typedef enum { PVODE_ADAMS, PVODE_BDF } TSPVodeMethod;
73 
74 extern int TSPVodeSetPCType(TS,PCType);
75 extern int TSPVodeGetPC(TS,PC*);
76 
77 extern int TSPVodeKSPSetType(TS,KSPType);
78 extern int TSPVodeSetMethod(TS,TSPVodeMethod);
79 extern int TSPVodeSetRHSFunction(TS,double,Vec,Vec,void *);
80 extern int TSPVodeSetRHSJacobian(TS,double,Vec,Mat*,Mat*,MatStructure*,void *);
81 extern int TSComputeRHSJacobianForPVODE(TS,double,Vec,Mat*,
82                                         Mat*,MatStructure*,void*);
83 extern int TSComputeRHSFunctionForPVODE(TS,double,Vec,Vec,void*);
84 extern int TSPVodeGetUserData(TS, void*);
85 
86 #endif
87 
88 
89 
90 
91 
92