xref: /petsc/include/petscts.h (revision 0513a670233e070c0fc2d7ef3dc22f950deb2ce6)
1*0513a670SBarry Smith /* $Id: ts.h,v 1.10 1996/09/30 20:58:00 bsmith Exp bsmith $ */
2818ad0c1SBarry Smith /*
3f64a0f93SLois Curfman McInnes    User interface for the timestepping package. This is package
4f64a0f93SLois Curfman McInnes    is for use in solving time-dependent PDEs.
5818ad0c1SBarry Smith */
66d84be18SBarry Smith #if !defined(__TS_PACKAGE)
76d84be18SBarry Smith #define __TS_PACKAGE
86d84be18SBarry Smith #include "snes.h"
9818ad0c1SBarry Smith 
106d84be18SBarry Smith typedef struct _TS* TS;
116d84be18SBarry Smith #define TS_COOKIE PETSC_COOKIE+18
12818ad0c1SBarry Smith 
13d8345c25SBarry Smith typedef enum { TS_EULER, TS_BEULER, TS_PSEUDO} TSType;
1419bcc07fSBarry Smith typedef enum { TS_LINEAR, TS_NONLINEAR} TSProblemType;
15818ad0c1SBarry Smith 
166d84be18SBarry Smith extern int TSCreate(MPI_Comm,TSProblemType,TS*);
176d84be18SBarry Smith extern int TSSetType(TS,TSType);
186d84be18SBarry Smith extern int TSDestroy(TS);
19818ad0c1SBarry Smith 
2021c89e3eSBarry Smith extern int TSSetMonitor(TS,int(*)(TS,int,double,Vec,void*),void *);
216d84be18SBarry Smith extern int TSGetType(TS,TSType*,char**);
22818ad0c1SBarry Smith 
236d84be18SBarry Smith extern int TSSetFromOptions(TS);
246d84be18SBarry Smith extern int TSSetUp(TS);
25818ad0c1SBarry Smith 
266d84be18SBarry Smith extern int TSSetSolution(TS,Vec);
276d84be18SBarry Smith extern int TSGetSolution(TS,Vec*);
28818ad0c1SBarry Smith 
2921c89e3eSBarry Smith extern int TSSetDuration(TS,int,double);
306d84be18SBarry Smith extern int TSPrintHelp(TS);
31818ad0c1SBarry Smith 
3221c89e3eSBarry Smith extern int TSDefaultMonitor(TS,int,double,Vec,void*);
3321c89e3eSBarry Smith extern int TSStep(TS,int *,double*);
34818ad0c1SBarry Smith 
35c3e30b67SBarry Smith extern int TSSetInitialTimeStep(TS,double,double);
36c3e30b67SBarry Smith extern int TSGetTimeStep(TS,double*);
3721c89e3eSBarry Smith extern int TSGetTimeStepNumber(TS,int*);
38c3e30b67SBarry Smith extern int TSSetTimeStep(TS,double);
39818ad0c1SBarry Smith 
4021c89e3eSBarry Smith extern int TSSetRHSFunction(TS,int (*)(TS,double,Vec,Vec,void*),void*);
41c3e30b67SBarry Smith extern int TSSetRHSMatrix(TS,Mat,Mat,int (*)(TS,double,Mat*,Mat*,MatStructure*,void*),void*);
42c3e30b67SBarry Smith extern int TSSetRHSJacobian(TS,Mat,Mat,int(*)(TS,double,Vec,Mat*,Mat*,MatStructure*,void*),void*);
43818ad0c1SBarry Smith 
44d8345c25SBarry Smith extern int TSPseudoSetTimeStep(TS,int(*)(TS,double*,void*),void*);
45d8345c25SBarry Smith extern int TSPseudoDefaultTimeStep(TS,double*,void* );
46d8345c25SBarry Smith extern int TSPseudoComputeTimeStep(TS,double *);
47d8345c25SBarry Smith 
48d8345c25SBarry Smith extern int TSPseudoSetVerifyTimeStep(TS,int(*)(TS,Vec,void*,double*,int*),void*);
49d8345c25SBarry Smith extern int TSPseudoDefaultVerifyTimeStep(TS,Vec,void*,double*,int*);
50d8345c25SBarry Smith extern int TSPseudoVerifyTimeStep(TS,Vec,double*,int*);
51bc223fc0SBarry Smith extern int TSPseudoSetTimeStepIncrement(TS,double);
52*0513a670SBarry Smith extern int TSPseudoIncrementDtFromInitialDt(TS);
5321c89e3eSBarry Smith 
54c3e30b67SBarry Smith extern int TSComputeRHSFunction(TS,double,Vec,Vec);
55818ad0c1SBarry Smith 
566d84be18SBarry Smith extern int TSRegisterAll();
576d84be18SBarry Smith extern int TSRegister(int,char*,int (*)(TS));
58818ad0c1SBarry Smith 
596d84be18SBarry Smith extern int TSGetSNES(TS,SNES*);
606d84be18SBarry Smith extern int TSGetSLES(TS,SLES*);
61818ad0c1SBarry Smith 
62c3e30b67SBarry Smith extern int TSView(TS,Viewer);
6321c89e3eSBarry Smith 
6421c89e3eSBarry Smith extern int TSSetApplicationContext(TS,void *);
6521c89e3eSBarry Smith extern int TSGetApplicationContext(TS,void **);
6621c89e3eSBarry Smith 
67818ad0c1SBarry Smith #endif
68818ad0c1SBarry Smith 
6921c89e3eSBarry Smith 
7021c89e3eSBarry Smith 
7121c89e3eSBarry Smith 
7221c89e3eSBarry Smith 
73