xref: /petsc/src/ts/interface/ts.c (revision 362cd11c71af8ac3336c772f4633f23c2b20d4d6)
163dd3a1aSKris Buschelman 
2c6db04a5SJed Brown #include <private/tsimpl.h>        /*I "petscts.h"  I*/
3d763cef2SBarry Smith 
4d5ba7fb7SMatthew Knepley /* Logging support */
57087cfbeSBarry Smith PetscClassId  TS_CLASSID;
6166c7f25SBarry Smith PetscLogEvent  TS_Step, TS_PseudoComputeTimeStep, TS_FunctionEval, TS_JacobianEval;
7d405a339SMatthew Knepley 
84a2ae208SSatish Balay #undef __FUNCT__
9bdad233fSMatthew Knepley #define __FUNCT__ "TSSetTypeFromOptions"
10bdad233fSMatthew Knepley /*
11bdad233fSMatthew Knepley   TSSetTypeFromOptions - Sets the type of ts from user options.
12bdad233fSMatthew Knepley 
13bdad233fSMatthew Knepley   Collective on TS
14bdad233fSMatthew Knepley 
15bdad233fSMatthew Knepley   Input Parameter:
16bdad233fSMatthew Knepley . ts - The ts
17bdad233fSMatthew Knepley 
18bdad233fSMatthew Knepley   Level: intermediate
19bdad233fSMatthew Knepley 
20bdad233fSMatthew Knepley .keywords: TS, set, options, database, type
21bdad233fSMatthew Knepley .seealso: TSSetFromOptions(), TSSetType()
22bdad233fSMatthew Knepley */
236849ba73SBarry Smith static PetscErrorCode TSSetTypeFromOptions(TS ts)
24bdad233fSMatthew Knepley {
25ace3abfcSBarry Smith   PetscBool      opt;
262fc52814SBarry Smith   const char     *defaultType;
27bdad233fSMatthew Knepley   char           typeName[256];
28dfbe8321SBarry Smith   PetscErrorCode ierr;
29bdad233fSMatthew Knepley 
30bdad233fSMatthew Knepley   PetscFunctionBegin;
317adad957SLisandro Dalcin   if (((PetscObject)ts)->type_name) {
327adad957SLisandro Dalcin     defaultType = ((PetscObject)ts)->type_name;
33bdad233fSMatthew Knepley   } else {
349596e0b4SJed Brown     defaultType = TSEULER;
35bdad233fSMatthew Knepley   }
36bdad233fSMatthew Knepley 
37cce0b1b2SLisandro Dalcin   if (!TSRegisterAllCalled) {ierr = TSRegisterAll(PETSC_NULL);CHKERRQ(ierr);}
38bdad233fSMatthew Knepley   ierr = PetscOptionsList("-ts_type", "TS method"," TSSetType", TSList, defaultType, typeName, 256, &opt);CHKERRQ(ierr);
39a7cc72afSBarry Smith   if (opt) {
40bdad233fSMatthew Knepley     ierr = TSSetType(ts, typeName);CHKERRQ(ierr);
41bdad233fSMatthew Knepley   } else {
42bdad233fSMatthew Knepley     ierr = TSSetType(ts, defaultType);CHKERRQ(ierr);
43bdad233fSMatthew Knepley   }
44bdad233fSMatthew Knepley   PetscFunctionReturn(0);
45bdad233fSMatthew Knepley }
46bdad233fSMatthew Knepley 
47bdad233fSMatthew Knepley #undef __FUNCT__
48bdad233fSMatthew Knepley #define __FUNCT__ "TSSetFromOptions"
49bdad233fSMatthew Knepley /*@
50bdad233fSMatthew Knepley    TSSetFromOptions - Sets various TS parameters from user options.
51bdad233fSMatthew Knepley 
52bdad233fSMatthew Knepley    Collective on TS
53bdad233fSMatthew Knepley 
54bdad233fSMatthew Knepley    Input Parameter:
55bdad233fSMatthew Knepley .  ts - the TS context obtained from TSCreate()
56bdad233fSMatthew Knepley 
57bdad233fSMatthew Knepley    Options Database Keys:
584d91e141SJed Brown +  -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSGL, TSSSP
59bdad233fSMatthew Knepley .  -ts_max_steps maxsteps - maximum number of time-steps to take
60bdad233fSMatthew Knepley .  -ts_max_time time - maximum time to compute to
61bdad233fSMatthew Knepley .  -ts_dt dt - initial time step
62bdad233fSMatthew Knepley .  -ts_monitor - print information at each timestep
63a6570f20SBarry Smith -  -ts_monitor_draw - plot information at each timestep
64bdad233fSMatthew Knepley 
65bdad233fSMatthew Knepley    Level: beginner
66bdad233fSMatthew Knepley 
67bdad233fSMatthew Knepley .keywords: TS, timestep, set, options, database
68bdad233fSMatthew Knepley 
69a313700dSBarry Smith .seealso: TSGetType()
70bdad233fSMatthew Knepley @*/
717087cfbeSBarry Smith PetscErrorCode  TSSetFromOptions(TS ts)
72bdad233fSMatthew Knepley {
73bdad233fSMatthew Knepley   PetscReal      dt;
74ace3abfcSBarry Smith   PetscBool      opt,flg;
75dfbe8321SBarry Smith   PetscErrorCode ierr;
76649052a6SBarry Smith   PetscViewer    monviewer;
77eabae89aSBarry Smith   char           monfilename[PETSC_MAX_PATH_LEN];
78089b2837SJed Brown   SNES           snes;
79bdad233fSMatthew Knepley 
80bdad233fSMatthew Knepley   PetscFunctionBegin;
810700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
823194b578SJed Brown   ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr);
83a43b19c4SJed Brown     /* Handle TS type options */
84a43b19c4SJed Brown     ierr = TSSetTypeFromOptions(ts);CHKERRQ(ierr);
85bdad233fSMatthew Knepley 
86bdad233fSMatthew Knepley     /* Handle generic TS options */
87bdad233fSMatthew Knepley     ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetDuration",ts->max_steps,&ts->max_steps,PETSC_NULL);CHKERRQ(ierr);
88bdad233fSMatthew Knepley     ierr = PetscOptionsReal("-ts_max_time","Time to run to","TSSetDuration",ts->max_time,&ts->max_time,PETSC_NULL);CHKERRQ(ierr);
89cdbf8f93SLisandro Dalcin     ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,PETSC_NULL);CHKERRQ(ierr);
90cdbf8f93SLisandro Dalcin     ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&ts->time_step,PETSC_NULL);CHKERRQ(ierr);
91a43b19c4SJed Brown     opt = ts->exact_final_time == PETSC_DECIDE ? PETSC_FALSE : (PetscBool)ts->exact_final_time;
92a43b19c4SJed Brown     ierr = PetscOptionsBool("-ts_exact_final_time","Interpolate output to stop exactly at the final time","TSSetExactFinalTime",opt,&opt,&flg);CHKERRQ(ierr);
93461e00b3SSean Farley     if (flg) {ierr = TSSetExactFinalTime(ts,opt);CHKERRQ(ierr);}
94193ac0bcSJed Brown     ierr = PetscOptionsInt("-ts_max_snes_failures","Maximum number of nonlinear solve failures","",ts->max_snes_failures,&ts->max_snes_failures,PETSC_NULL);CHKERRQ(ierr);
95193ac0bcSJed Brown     ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections","",ts->max_reject,&ts->max_reject,PETSC_NULL);CHKERRQ(ierr);
96193ac0bcSJed Brown     ierr = PetscOptionsBool("-ts_error_if_step_failed","Error if no step succeeds","",ts->errorifstepfailed,&ts->errorifstepfailed,PETSC_NULL);CHKERRQ(ierr);
97bdad233fSMatthew Knepley 
98bdad233fSMatthew Knepley     /* Monitor options */
99a6570f20SBarry Smith     ierr = PetscOptionsString("-ts_monitor","Monitor timestep size","TSMonitorDefault","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
100eabae89aSBarry Smith     if (flg) {
101649052a6SBarry Smith       ierr = PetscViewerASCIIOpen(((PetscObject)ts)->comm,monfilename,&monviewer);CHKERRQ(ierr);
102649052a6SBarry Smith       ierr = TSMonitorSet(ts,TSMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
103bdad233fSMatthew Knepley     }
1045180491cSLisandro Dalcin     ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
1055180491cSLisandro Dalcin     if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);}
1065180491cSLisandro Dalcin 
10790d69ab7SBarry Smith     opt  = PETSC_FALSE;
108acfcf0e5SJed Brown     ierr = PetscOptionsBool("-ts_monitor_draw","Monitor timestep size graphically","TSMonitorLG",opt,&opt,PETSC_NULL);CHKERRQ(ierr);
109a7cc72afSBarry Smith     if (opt) {
110a6570f20SBarry Smith       ierr = TSMonitorSet(ts,TSMonitorLG,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
111bdad233fSMatthew Knepley     }
11290d69ab7SBarry Smith     opt  = PETSC_FALSE;
113acfcf0e5SJed Brown     ierr = PetscOptionsBool("-ts_monitor_solution","Monitor solution graphically","TSMonitorSolution",opt,&opt,PETSC_NULL);CHKERRQ(ierr);
114a7cc72afSBarry Smith     if (opt) {
1156083293cSBarry Smith       void *ctx;
1166083293cSBarry Smith       ierr = TSMonitorSolutionCreate(ts,PETSC_NULL,&ctx);CHKERRQ(ierr);
1176083293cSBarry Smith       ierr = TSMonitorSet(ts,TSMonitorSolution,ctx,TSMonitorSolutionDestroy);CHKERRQ(ierr);
118bdad233fSMatthew Knepley     }
119bdad233fSMatthew Knepley 
120d52bd9f3SBarry Smith     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
121d52bd9f3SBarry Smith     if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);}
122d52bd9f3SBarry Smith 
123bdad233fSMatthew Knepley     /* Handle specific TS options */
124abc0a331SBarry Smith     if (ts->ops->setfromoptions) {
125bdad233fSMatthew Knepley       ierr = (*ts->ops->setfromoptions)(ts);CHKERRQ(ierr);
126bdad233fSMatthew Knepley     }
1275d973c19SBarry Smith 
1285d973c19SBarry Smith     /* process any options handlers added with PetscObjectAddOptionsHandler() */
1295d973c19SBarry Smith     ierr = PetscObjectProcessOptionsHandlers((PetscObject)ts);CHKERRQ(ierr);
130bdad233fSMatthew Knepley   ierr = PetscOptionsEnd();CHKERRQ(ierr);
131bdad233fSMatthew Knepley   PetscFunctionReturn(0);
132bdad233fSMatthew Knepley }
133bdad233fSMatthew Knepley 
134bdad233fSMatthew Knepley #undef __FUNCT__
135cdcf91faSSean Farley #undef __FUNCT__
1364a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSJacobian"
137a7a1495cSBarry Smith /*@
1388c385f81SBarry Smith    TSComputeRHSJacobian - Computes the Jacobian matrix that has been
139a7a1495cSBarry Smith       set with TSSetRHSJacobian().
140a7a1495cSBarry Smith 
141a7a1495cSBarry Smith    Collective on TS and Vec
142a7a1495cSBarry Smith 
143a7a1495cSBarry Smith    Input Parameters:
144316643e7SJed Brown +  ts - the TS context
145a7a1495cSBarry Smith .  t - current timestep
146a7a1495cSBarry Smith -  x - input vector
147a7a1495cSBarry Smith 
148a7a1495cSBarry Smith    Output Parameters:
149a7a1495cSBarry Smith +  A - Jacobian matrix
150a7a1495cSBarry Smith .  B - optional preconditioning matrix
151a7a1495cSBarry Smith -  flag - flag indicating matrix structure
152a7a1495cSBarry Smith 
153a7a1495cSBarry Smith    Notes:
154a7a1495cSBarry Smith    Most users should not need to explicitly call this routine, as it
155a7a1495cSBarry Smith    is used internally within the nonlinear solvers.
156a7a1495cSBarry Smith 
15794b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the
158a7a1495cSBarry Smith    flag parameter.
159a7a1495cSBarry Smith 
160a7a1495cSBarry Smith    Level: developer
161a7a1495cSBarry Smith 
162a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix
163a7a1495cSBarry Smith 
16494b7f48cSBarry Smith .seealso:  TSSetRHSJacobian(), KSPSetOperators()
165a7a1495cSBarry Smith @*/
1667087cfbeSBarry Smith PetscErrorCode  TSComputeRHSJacobian(TS ts,PetscReal t,Vec X,Mat *A,Mat *B,MatStructure *flg)
167a7a1495cSBarry Smith {
168dfbe8321SBarry Smith   PetscErrorCode ierr;
1690e4ef248SJed Brown   PetscInt Xstate;
170a7a1495cSBarry Smith 
171a7a1495cSBarry Smith   PetscFunctionBegin;
1720700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1730700a824SBarry Smith   PetscValidHeaderSpecific(X,VEC_CLASSID,3);
174c9780b6fSBarry Smith   PetscCheckSameComm(ts,1,X,3);
1750e4ef248SJed Brown   ierr = PetscObjectStateQuery((PetscObject)X,&Xstate);CHKERRQ(ierr);
1760e4ef248SJed Brown   if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.X == X && ts->rhsjacobian.Xstate == Xstate))) {
1770e4ef248SJed Brown     *flg = ts->rhsjacobian.mstructure;
1780e4ef248SJed Brown     PetscFunctionReturn(0);
179f8ede8e7SJed Brown   }
180d90be118SSean Farley 
1813b5f76d0SSean Farley   if (!ts->userops->rhsjacobian && !ts->userops->ijacobian) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
182d90be118SSean Farley 
1833b5f76d0SSean Farley   if (ts->userops->rhsjacobian) {
184d5ba7fb7SMatthew Knepley     ierr = PetscLogEventBegin(TS_JacobianEval,ts,X,*A,*B);CHKERRQ(ierr);
185a7a1495cSBarry Smith     *flg = DIFFERENT_NONZERO_PATTERN;
186a7a1495cSBarry Smith     PetscStackPush("TS user Jacobian function");
1873b5f76d0SSean Farley     ierr = (*ts->userops->rhsjacobian)(ts,t,X,A,B,flg,ts->jacP);CHKERRQ(ierr);
188a7a1495cSBarry Smith     PetscStackPop;
189d5ba7fb7SMatthew Knepley     ierr = PetscLogEventEnd(TS_JacobianEval,ts,X,*A,*B);CHKERRQ(ierr);
190a7a1495cSBarry Smith     /* make sure user returned a correct Jacobian and preconditioner */
1910700a824SBarry Smith     PetscValidHeaderSpecific(*A,MAT_CLASSID,4);
1920700a824SBarry Smith     PetscValidHeaderSpecific(*B,MAT_CLASSID,5);
193ef66eb69SBarry Smith   } else {
194214bc6a2SJed Brown     ierr = MatZeroEntries(*A);CHKERRQ(ierr);
195214bc6a2SJed Brown     if (*A != *B) {ierr = MatZeroEntries(*B);CHKERRQ(ierr);}
196214bc6a2SJed Brown     *flg = SAME_NONZERO_PATTERN;
197ef66eb69SBarry Smith   }
1980e4ef248SJed Brown   ts->rhsjacobian.time = t;
1990e4ef248SJed Brown   ts->rhsjacobian.X = X;
2000e4ef248SJed Brown   ierr = PetscObjectStateQuery((PetscObject)X,&ts->rhsjacobian.Xstate);CHKERRQ(ierr);
2010e4ef248SJed Brown   ts->rhsjacobian.mstructure = *flg;
202a7a1495cSBarry Smith   PetscFunctionReturn(0);
203a7a1495cSBarry Smith }
204a7a1495cSBarry Smith 
2054a2ae208SSatish Balay #undef __FUNCT__
2064a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSFunction"
207316643e7SJed Brown /*@
208d763cef2SBarry Smith    TSComputeRHSFunction - Evaluates the right-hand-side function.
209d763cef2SBarry Smith 
210316643e7SJed Brown    Collective on TS and Vec
211316643e7SJed Brown 
212316643e7SJed Brown    Input Parameters:
213316643e7SJed Brown +  ts - the TS context
214316643e7SJed Brown .  t - current time
215316643e7SJed Brown -  x - state vector
216316643e7SJed Brown 
217316643e7SJed Brown    Output Parameter:
218316643e7SJed Brown .  y - right hand side
219316643e7SJed Brown 
220316643e7SJed Brown    Note:
221316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
222316643e7SJed Brown    is used internally within the nonlinear solvers.
223316643e7SJed Brown 
224316643e7SJed Brown    Level: developer
225316643e7SJed Brown 
226316643e7SJed Brown .keywords: TS, compute
227316643e7SJed Brown 
228316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction()
229316643e7SJed Brown @*/
230dfbe8321SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec x,Vec y)
231d763cef2SBarry Smith {
232dfbe8321SBarry Smith   PetscErrorCode ierr;
233d763cef2SBarry Smith 
234d763cef2SBarry Smith   PetscFunctionBegin;
2350700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2360700a824SBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,3);
2370700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,4);
238d763cef2SBarry Smith 
2393b5f76d0SSean Farley   if (!ts->userops->rhsfunction && !ts->userops->ifunction) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
240d763cef2SBarry Smith 
241d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(TS_FunctionEval,ts,x,y,0);CHKERRQ(ierr);
2423b5f76d0SSean Farley   if (ts->userops->rhsfunction) {
243d763cef2SBarry Smith     PetscStackPush("TS user right-hand-side function");
2443b5f76d0SSean Farley     ierr = (*ts->userops->rhsfunction)(ts,t,x,y,ts->funP);CHKERRQ(ierr);
245d763cef2SBarry Smith     PetscStackPop;
246214bc6a2SJed Brown   } else {
247214bc6a2SJed Brown     ierr = VecZeroEntries(y);CHKERRQ(ierr);
248b2cd27e8SJed Brown   }
24944a41b28SSean Farley 
250d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(TS_FunctionEval,ts,x,y,0);CHKERRQ(ierr);
251d763cef2SBarry Smith   PetscFunctionReturn(0);
252d763cef2SBarry Smith }
253d763cef2SBarry Smith 
2544a2ae208SSatish Balay #undef __FUNCT__
255214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSVec_Private"
256214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs)
257214bc6a2SJed Brown {
2582dd45cf8SJed Brown   Vec            F;
259214bc6a2SJed Brown   PetscErrorCode ierr;
260214bc6a2SJed Brown 
261214bc6a2SJed Brown   PetscFunctionBegin;
2620da9a4f0SJed Brown   *Frhs = PETSC_NULL;
2632dd45cf8SJed Brown   ierr = TSGetIFunction(ts,&F,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
264214bc6a2SJed Brown   if (!ts->Frhs) {
2652dd45cf8SJed Brown     ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr);
266214bc6a2SJed Brown   }
267214bc6a2SJed Brown   *Frhs = ts->Frhs;
268214bc6a2SJed Brown   PetscFunctionReturn(0);
269214bc6a2SJed Brown }
270214bc6a2SJed Brown 
271214bc6a2SJed Brown #undef __FUNCT__
272214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSMats_Private"
273214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs)
274214bc6a2SJed Brown {
275214bc6a2SJed Brown   Mat            A,B;
2762dd45cf8SJed Brown   PetscErrorCode ierr;
277214bc6a2SJed Brown 
278214bc6a2SJed Brown   PetscFunctionBegin;
279214bc6a2SJed Brown   ierr = TSGetIJacobian(ts,&A,&B,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
280214bc6a2SJed Brown   if (Arhs) {
281214bc6a2SJed Brown     if (!ts->Arhs) {
282214bc6a2SJed Brown       ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr);
283214bc6a2SJed Brown     }
284214bc6a2SJed Brown     *Arhs = ts->Arhs;
285214bc6a2SJed Brown   }
286214bc6a2SJed Brown   if (Brhs) {
287214bc6a2SJed Brown     if (!ts->Brhs) {
288214bc6a2SJed Brown       ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr);
289214bc6a2SJed Brown     }
290214bc6a2SJed Brown     *Brhs = ts->Brhs;
291214bc6a2SJed Brown   }
292214bc6a2SJed Brown   PetscFunctionReturn(0);
293214bc6a2SJed Brown }
294214bc6a2SJed Brown 
295214bc6a2SJed Brown #undef __FUNCT__
296316643e7SJed Brown #define __FUNCT__ "TSComputeIFunction"
297316643e7SJed Brown /*@
298316643e7SJed Brown    TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,X,Xdot)=0
299316643e7SJed Brown 
300316643e7SJed Brown    Collective on TS and Vec
301316643e7SJed Brown 
302316643e7SJed Brown    Input Parameters:
303316643e7SJed Brown +  ts - the TS context
304316643e7SJed Brown .  t - current time
305316643e7SJed Brown .  X - state vector
306214bc6a2SJed Brown .  Xdot - time derivative of state vector
307214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate
308316643e7SJed Brown 
309316643e7SJed Brown    Output Parameter:
310316643e7SJed Brown .  Y - right hand side
311316643e7SJed Brown 
312316643e7SJed Brown    Note:
313316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
314316643e7SJed Brown    is used internally within the nonlinear solvers.
315316643e7SJed Brown 
316316643e7SJed Brown    If the user did did not write their equations in implicit form, this
317316643e7SJed Brown    function recasts them in implicit form.
318316643e7SJed Brown 
319316643e7SJed Brown    Level: developer
320316643e7SJed Brown 
321316643e7SJed Brown .keywords: TS, compute
322316643e7SJed Brown 
323316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction()
324316643e7SJed Brown @*/
325214bc6a2SJed Brown PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec X,Vec Xdot,Vec Y,PetscBool imex)
326316643e7SJed Brown {
327316643e7SJed Brown   PetscErrorCode ierr;
328316643e7SJed Brown 
329316643e7SJed Brown   PetscFunctionBegin;
3300700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3310700a824SBarry Smith   PetscValidHeaderSpecific(X,VEC_CLASSID,3);
3320700a824SBarry Smith   PetscValidHeaderSpecific(Xdot,VEC_CLASSID,4);
3330700a824SBarry Smith   PetscValidHeaderSpecific(Y,VEC_CLASSID,5);
334316643e7SJed Brown 
335d90be118SSean Farley   if (!ts->userops->rhsfunction && !ts->userops->ifunction) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
336d90be118SSean Farley 
337316643e7SJed Brown   ierr = PetscLogEventBegin(TS_FunctionEval,ts,X,Xdot,Y);CHKERRQ(ierr);
3383b5f76d0SSean Farley   if (ts->userops->ifunction) {
339316643e7SJed Brown     PetscStackPush("TS user implicit function");
3403b5f76d0SSean Farley     ierr = (*ts->userops->ifunction)(ts,t,X,Xdot,Y,ts->funP);CHKERRQ(ierr);
341316643e7SJed Brown     PetscStackPop;
342214bc6a2SJed Brown   }
343214bc6a2SJed Brown   if (imex) {
3443b5f76d0SSean Farley     if (!ts->userops->ifunction) {
3452dd45cf8SJed Brown       ierr = VecCopy(Xdot,Y);CHKERRQ(ierr);
3462dd45cf8SJed Brown     }
3472dd45cf8SJed Brown   } else if (ts->userops->rhsfunction) {
3482dd45cf8SJed Brown     if (ts->userops->ifunction) {
349214bc6a2SJed Brown       Vec Frhs;
350214bc6a2SJed Brown       ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
351214bc6a2SJed Brown       ierr = TSComputeRHSFunction(ts,t,X,Frhs);CHKERRQ(ierr);
352214bc6a2SJed Brown       ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr);
3532dd45cf8SJed Brown     } else {
3542dd45cf8SJed Brown       ierr = TSComputeRHSFunction(ts,t,X,Y);CHKERRQ(ierr);
3552dd45cf8SJed Brown       ierr = VecAYPX(Y,-1,Xdot);CHKERRQ(ierr);
356316643e7SJed Brown     }
3574a6899ffSJed Brown   }
358316643e7SJed Brown   ierr = PetscLogEventEnd(TS_FunctionEval,ts,X,Xdot,Y);CHKERRQ(ierr);
359316643e7SJed Brown   PetscFunctionReturn(0);
360316643e7SJed Brown }
361316643e7SJed Brown 
362316643e7SJed Brown #undef __FUNCT__
363316643e7SJed Brown #define __FUNCT__ "TSComputeIJacobian"
364316643e7SJed Brown /*@
365316643e7SJed Brown    TSComputeIJacobian - Evaluates the Jacobian of the DAE
366316643e7SJed Brown 
367316643e7SJed Brown    Collective on TS and Vec
368316643e7SJed Brown 
369316643e7SJed Brown    Input
370316643e7SJed Brown       Input Parameters:
371316643e7SJed Brown +  ts - the TS context
372316643e7SJed Brown .  t - current timestep
373316643e7SJed Brown .  X - state vector
374316643e7SJed Brown .  Xdot - time derivative of state vector
375214bc6a2SJed Brown .  shift - shift to apply, see note below
376214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate
377316643e7SJed Brown 
378316643e7SJed Brown    Output Parameters:
379316643e7SJed Brown +  A - Jacobian matrix
380316643e7SJed Brown .  B - optional preconditioning matrix
381316643e7SJed Brown -  flag - flag indicating matrix structure
382316643e7SJed Brown 
383316643e7SJed Brown    Notes:
384316643e7SJed Brown    If F(t,X,Xdot)=0 is the DAE, the required Jacobian is
385316643e7SJed Brown 
386316643e7SJed Brown    dF/dX + shift*dF/dXdot
387316643e7SJed Brown 
388316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
389316643e7SJed Brown    is used internally within the nonlinear solvers.
390316643e7SJed Brown 
391316643e7SJed Brown    Level: developer
392316643e7SJed Brown 
393316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix
394316643e7SJed Brown 
395316643e7SJed Brown .seealso:  TSSetIJacobian()
39663495f91SJed Brown @*/
397214bc6a2SJed Brown PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec X,Vec Xdot,PetscReal shift,Mat *A,Mat *B,MatStructure *flg,PetscBool imex)
398316643e7SJed Brown {
3990026cea9SSean Farley   PetscInt Xstate, Xdotstate;
400316643e7SJed Brown   PetscErrorCode ierr;
401316643e7SJed Brown 
402316643e7SJed Brown   PetscFunctionBegin;
4030700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4040700a824SBarry Smith   PetscValidHeaderSpecific(X,VEC_CLASSID,3);
4050700a824SBarry Smith   PetscValidHeaderSpecific(Xdot,VEC_CLASSID,4);
406316643e7SJed Brown   PetscValidPointer(A,6);
4070700a824SBarry Smith   PetscValidHeaderSpecific(*A,MAT_CLASSID,6);
408316643e7SJed Brown   PetscValidPointer(B,7);
4090700a824SBarry Smith   PetscValidHeaderSpecific(*B,MAT_CLASSID,7);
410316643e7SJed Brown   PetscValidPointer(flg,8);
4110026cea9SSean Farley   ierr = PetscObjectStateQuery((PetscObject)X,&Xstate);CHKERRQ(ierr);
4120026cea9SSean Farley   ierr = PetscObjectStateQuery((PetscObject)Xdot,&Xdotstate);CHKERRQ(ierr);
4130026cea9SSean Farley   if (ts->ijacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->ijacobian.X == X && ts->ijacobian.Xstate == Xstate && ts->ijacobian.Xdot == Xdot && ts->ijacobian.Xdotstate == Xdotstate && ts->ijacobian.imex == imex))) {
4140026cea9SSean Farley     *flg = ts->ijacobian.mstructure;
4150026cea9SSean Farley     ierr = MatScale(*A, shift / ts->ijacobian.shift);CHKERRQ(ierr);
4160026cea9SSean Farley     PetscFunctionReturn(0);
4170026cea9SSean Farley   }
418316643e7SJed Brown 
4193b5f76d0SSean Farley   if (!ts->userops->rhsjacobian && !ts->userops->ijacobian) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
420316643e7SJed Brown 
4214e684422SJed Brown   *flg = SAME_NONZERO_PATTERN;  /* In case we're solving a linear problem in which case it wouldn't get initialized below. */
422316643e7SJed Brown   ierr = PetscLogEventBegin(TS_JacobianEval,ts,X,*A,*B);CHKERRQ(ierr);
4233b5f76d0SSean Farley   if (ts->userops->ijacobian) {
4242dd45cf8SJed Brown     *flg = DIFFERENT_NONZERO_PATTERN;
425316643e7SJed Brown     PetscStackPush("TS user implicit Jacobian");
4263b5f76d0SSean Farley     ierr = (*ts->userops->ijacobian)(ts,t,X,Xdot,shift,A,B,flg,ts->jacP);CHKERRQ(ierr);
427316643e7SJed Brown     PetscStackPop;
428214bc6a2SJed Brown     /* make sure user returned a correct Jacobian and preconditioner */
429214bc6a2SJed Brown     PetscValidHeaderSpecific(*A,MAT_CLASSID,4);
430214bc6a2SJed Brown     PetscValidHeaderSpecific(*B,MAT_CLASSID,5);
4314a6899ffSJed Brown   }
432214bc6a2SJed Brown   if (imex) {
4333b5f76d0SSean Farley     if (!ts->userops->ijacobian) {  /* system was written as Xdot = F(t,X) */
434214bc6a2SJed Brown       ierr = MatZeroEntries(*A);CHKERRQ(ierr);
4352dd45cf8SJed Brown       ierr = MatShift(*A,shift);CHKERRQ(ierr);
436214bc6a2SJed Brown       if (*A != *B) {
437214bc6a2SJed Brown         ierr = MatZeroEntries(*B);CHKERRQ(ierr);
438214bc6a2SJed Brown         ierr = MatShift(*B,shift);CHKERRQ(ierr);
439214bc6a2SJed Brown       }
440214bc6a2SJed Brown       *flg = SAME_PRECONDITIONER;
441214bc6a2SJed Brown     }
442214bc6a2SJed Brown   } else {
4433b5f76d0SSean Farley     if (!ts->userops->ijacobian) {
444214bc6a2SJed Brown       ierr = TSComputeRHSJacobian(ts,t,X,A,B,flg);CHKERRQ(ierr);
445214bc6a2SJed Brown       ierr = MatScale(*A,-1);CHKERRQ(ierr);
446214bc6a2SJed Brown       ierr = MatShift(*A,shift);CHKERRQ(ierr);
447316643e7SJed Brown       if (*A != *B) {
448316643e7SJed Brown         ierr = MatScale(*B,-1);CHKERRQ(ierr);
449316643e7SJed Brown         ierr = MatShift(*B,shift);CHKERRQ(ierr);
450316643e7SJed Brown       }
4513b5f76d0SSean Farley     } else if (ts->userops->rhsjacobian) {
452214bc6a2SJed Brown       Mat Arhs,Brhs;
453214bc6a2SJed Brown       MatStructure axpy,flg2 = DIFFERENT_NONZERO_PATTERN;
454214bc6a2SJed Brown       ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
455214bc6a2SJed Brown       ierr = TSComputeRHSJacobian(ts,t,X,&Arhs,&Brhs,&flg2);CHKERRQ(ierr);
456214bc6a2SJed Brown       axpy = (*flg == flg2) ? SAME_NONZERO_PATTERN : DIFFERENT_NONZERO_PATTERN;
457214bc6a2SJed Brown       ierr = MatAXPY(*A,-1,Arhs,axpy);CHKERRQ(ierr);
458214bc6a2SJed Brown       if (*A != *B) {
459214bc6a2SJed Brown         ierr = MatAXPY(*B,-1,Brhs,axpy);CHKERRQ(ierr);
460214bc6a2SJed Brown       }
461214bc6a2SJed Brown       *flg = PetscMin(*flg,flg2);
462214bc6a2SJed Brown     }
463316643e7SJed Brown   }
4640026cea9SSean Farley 
4650026cea9SSean Farley   ts->ijacobian.time = t;
4660026cea9SSean Farley   ts->ijacobian.X = X;
4670026cea9SSean Farley   ts->ijacobian.Xdot = Xdot;
4680026cea9SSean Farley   ierr = PetscObjectStateQuery((PetscObject)X,&ts->ijacobian.Xstate);CHKERRQ(ierr);
4690026cea9SSean Farley   ierr = PetscObjectStateQuery((PetscObject)Xdot,&ts->ijacobian.Xdotstate);CHKERRQ(ierr);
4700026cea9SSean Farley   ts->ijacobian.shift = shift;
4710026cea9SSean Farley   ts->ijacobian.imex = imex;
4720026cea9SSean Farley   ts->ijacobian.mstructure = *flg;
473316643e7SJed Brown   ierr = PetscLogEventEnd(TS_JacobianEval,ts,X,*A,*B);CHKERRQ(ierr);
474316643e7SJed Brown   PetscFunctionReturn(0);
475316643e7SJed Brown }
476316643e7SJed Brown 
477316643e7SJed Brown #undef __FUNCT__
4784a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSFunction"
479d763cef2SBarry Smith /*@C
480d763cef2SBarry Smith     TSSetRHSFunction - Sets the routine for evaluating the function,
481d763cef2SBarry Smith     F(t,u), where U_t = F(t,u).
482d763cef2SBarry Smith 
4833f9fe445SBarry Smith     Logically Collective on TS
484d763cef2SBarry Smith 
485d763cef2SBarry Smith     Input Parameters:
486d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
487ca94891dSJed Brown .   r - vector to put the computed right hand side (or PETSC_NULL to have it created)
488d763cef2SBarry Smith .   f - routine for evaluating the right-hand-side function
489d763cef2SBarry Smith -   ctx - [optional] user-defined context for private data for the
490d763cef2SBarry Smith           function evaluation routine (may be PETSC_NULL)
491d763cef2SBarry Smith 
492d763cef2SBarry Smith     Calling sequence of func:
49387828ca2SBarry Smith $     func (TS ts,PetscReal t,Vec u,Vec F,void *ctx);
494d763cef2SBarry Smith 
495d763cef2SBarry Smith +   t - current timestep
496d763cef2SBarry Smith .   u - input vector
497d763cef2SBarry Smith .   F - function vector
498d763cef2SBarry Smith -   ctx - [optional] user-defined function context
499d763cef2SBarry Smith 
500d763cef2SBarry Smith     Important:
50176f2fa84SHong Zhang     The user MUST call either this routine or TSSetMatrices().
502d763cef2SBarry Smith 
503d763cef2SBarry Smith     Level: beginner
504d763cef2SBarry Smith 
505d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
506d763cef2SBarry Smith 
50776f2fa84SHong Zhang .seealso: TSSetMatrices()
508d763cef2SBarry Smith @*/
509089b2837SJed Brown PetscErrorCode  TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx)
510d763cef2SBarry Smith {
511089b2837SJed Brown   PetscErrorCode ierr;
512089b2837SJed Brown   SNES           snes;
513d763cef2SBarry Smith 
514089b2837SJed Brown   PetscFunctionBegin;
5150700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
516ca94891dSJed Brown   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
5173b5f76d0SSean Farley   if (f)   ts->userops->rhsfunction = f;
5184e684422SJed Brown   if (ctx) ts->funP                 = ctx;
519089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
520089b2837SJed Brown   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
521d763cef2SBarry Smith   PetscFunctionReturn(0);
522d763cef2SBarry Smith }
523d763cef2SBarry Smith 
5244a2ae208SSatish Balay #undef __FUNCT__
5254a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSJacobian"
526d763cef2SBarry Smith /*@C
527d763cef2SBarry Smith    TSSetRHSJacobian - Sets the function to compute the Jacobian of F,
528d763cef2SBarry Smith    where U_t = F(U,t), as well as the location to store the matrix.
52976f2fa84SHong Zhang    Use TSSetMatrices() for linear problems.
530d763cef2SBarry Smith 
5313f9fe445SBarry Smith    Logically Collective on TS
532d763cef2SBarry Smith 
533d763cef2SBarry Smith    Input Parameters:
534d763cef2SBarry Smith +  ts  - the TS context obtained from TSCreate()
535d763cef2SBarry Smith .  A   - Jacobian matrix
536d763cef2SBarry Smith .  B   - preconditioner matrix (usually same as A)
537d763cef2SBarry Smith .  f   - the Jacobian evaluation routine
538d763cef2SBarry Smith -  ctx - [optional] user-defined context for private data for the
539d763cef2SBarry Smith          Jacobian evaluation routine (may be PETSC_NULL)
540d763cef2SBarry Smith 
541d763cef2SBarry Smith    Calling sequence of func:
54287828ca2SBarry Smith $     func (TS ts,PetscReal t,Vec u,Mat *A,Mat *B,MatStructure *flag,void *ctx);
543d763cef2SBarry Smith 
544d763cef2SBarry Smith +  t - current timestep
545d763cef2SBarry Smith .  u - input vector
546d763cef2SBarry Smith .  A - matrix A, where U_t = A(t)u
547d763cef2SBarry Smith .  B - preconditioner matrix, usually the same as A
548d763cef2SBarry Smith .  flag - flag indicating information about the preconditioner matrix
54994b7f48cSBarry Smith           structure (same as flag in KSPSetOperators())
550d763cef2SBarry Smith -  ctx - [optional] user-defined context for matrix evaluation routine
551d763cef2SBarry Smith 
552d763cef2SBarry Smith    Notes:
55394b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the flag
554d763cef2SBarry Smith    output parameter in the routine func().  Be sure to read this information!
555d763cef2SBarry Smith 
556d763cef2SBarry Smith    The routine func() takes Mat * as the matrix arguments rather than Mat.
557d763cef2SBarry Smith    This allows the matrix evaluation routine to replace A and/or B with a
55856335db2SHong Zhang    completely new matrix structure (not just different matrix elements)
559d763cef2SBarry Smith    when appropriate, for instance, if the nonzero structure is changing
560d763cef2SBarry Smith    throughout the global iterations.
561d763cef2SBarry Smith 
562d763cef2SBarry Smith    Level: beginner
563d763cef2SBarry Smith 
564d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian
565d763cef2SBarry Smith 
566d763cef2SBarry Smith .seealso: TSDefaultComputeJacobianColor(),
56776f2fa84SHong Zhang           SNESDefaultComputeJacobianColor(), TSSetRHSFunction(), TSSetMatrices()
568d763cef2SBarry Smith 
569d763cef2SBarry Smith @*/
570089b2837SJed Brown PetscErrorCode  TSSetRHSJacobian(TS ts,Mat A,Mat B,TSRHSJacobian f,void *ctx)
571d763cef2SBarry Smith {
572277b19d0SLisandro Dalcin   PetscErrorCode ierr;
573089b2837SJed Brown   SNES           snes;
574277b19d0SLisandro Dalcin 
575d763cef2SBarry Smith   PetscFunctionBegin;
5760700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
577277b19d0SLisandro Dalcin   if (A) PetscValidHeaderSpecific(A,MAT_CLASSID,2);
578277b19d0SLisandro Dalcin   if (B) PetscValidHeaderSpecific(B,MAT_CLASSID,3);
579277b19d0SLisandro Dalcin   if (A) PetscCheckSameComm(ts,1,A,2);
580277b19d0SLisandro Dalcin   if (B) PetscCheckSameComm(ts,1,B,3);
581d763cef2SBarry Smith 
5823b5f76d0SSean Farley   if (f)   ts->userops->rhsjacobian = f;
583277b19d0SLisandro Dalcin   if (ctx) ts->jacP                 = ctx;
584089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
585dabe61deSJed Brown   if (!ts->userops->ijacobian) {
586089b2837SJed Brown     ierr = SNESSetJacobian(snes,A,B,SNESTSFormJacobian,ts);CHKERRQ(ierr);
5870e4ef248SJed Brown   }
5880e4ef248SJed Brown   if (A) {
5890e4ef248SJed Brown     ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
5900e4ef248SJed Brown     ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
5910e4ef248SJed Brown     ts->Arhs = A;
5920e4ef248SJed Brown   }
5930e4ef248SJed Brown   if (B) {
5940e4ef248SJed Brown     ierr = PetscObjectReference((PetscObject)B);CHKERRQ(ierr);
5950e4ef248SJed Brown     ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
5960e4ef248SJed Brown     ts->Brhs = B;
5970e4ef248SJed Brown   }
598d763cef2SBarry Smith   PetscFunctionReturn(0);
599d763cef2SBarry Smith }
600d763cef2SBarry Smith 
601316643e7SJed Brown 
602316643e7SJed Brown #undef __FUNCT__
603316643e7SJed Brown #define __FUNCT__ "TSSetIFunction"
604316643e7SJed Brown /*@C
605316643e7SJed Brown    TSSetIFunction - Set the function to compute F(t,U,U_t) where F = 0 is the DAE to be solved.
606316643e7SJed Brown 
6073f9fe445SBarry Smith    Logically Collective on TS
608316643e7SJed Brown 
609316643e7SJed Brown    Input Parameters:
610316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
611ca94891dSJed Brown .  r   - vector to hold the residual (or PETSC_NULL to have it created internally)
612316643e7SJed Brown .  f   - the function evaluation routine
613316643e7SJed Brown -  ctx - user-defined context for private data for the function evaluation routine (may be PETSC_NULL)
614316643e7SJed Brown 
615316643e7SJed Brown    Calling sequence of f:
616316643e7SJed Brown $  f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx);
617316643e7SJed Brown 
618316643e7SJed Brown +  t   - time at step/stage being solved
619316643e7SJed Brown .  u   - state vector
620316643e7SJed Brown .  u_t - time derivative of state vector
621316643e7SJed Brown .  F   - function vector
622316643e7SJed Brown -  ctx - [optional] user-defined context for matrix evaluation routine
623316643e7SJed Brown 
624316643e7SJed Brown    Important:
625316643e7SJed Brown    The user MUST call either this routine, TSSetRHSFunction(), or TSSetMatrices().  This routine must be used when not solving an ODE.
626316643e7SJed Brown 
627316643e7SJed Brown    Level: beginner
628316643e7SJed Brown 
629316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian
630316643e7SJed Brown 
631316643e7SJed Brown .seealso: TSSetMatrices(), TSSetRHSFunction(), TSSetIJacobian()
632316643e7SJed Brown @*/
633089b2837SJed Brown PetscErrorCode  TSSetIFunction(TS ts,Vec res,TSIFunction f,void *ctx)
634316643e7SJed Brown {
635089b2837SJed Brown   PetscErrorCode ierr;
636089b2837SJed Brown   SNES           snes;
637316643e7SJed Brown 
638316643e7SJed Brown   PetscFunctionBegin;
6390700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
640ca94891dSJed Brown   if (res) PetscValidHeaderSpecific(res,VEC_CLASSID,2);
6413b5f76d0SSean Farley   if (f)   ts->userops->ifunction = f;
642089b2837SJed Brown   if (ctx) ts->funP           = ctx;
643089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
644089b2837SJed Brown   ierr = SNESSetFunction(snes,res,SNESTSFormFunction,ts);CHKERRQ(ierr);
645089b2837SJed Brown   PetscFunctionReturn(0);
646089b2837SJed Brown }
647089b2837SJed Brown 
648089b2837SJed Brown #undef __FUNCT__
649089b2837SJed Brown #define __FUNCT__ "TSGetIFunction"
650089b2837SJed Brown /*@C
651089b2837SJed Brown    TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it.
652089b2837SJed Brown 
653089b2837SJed Brown    Not Collective
654089b2837SJed Brown 
655089b2837SJed Brown    Input Parameter:
656089b2837SJed Brown .  ts - the TS context
657089b2837SJed Brown 
658089b2837SJed Brown    Output Parameter:
659089b2837SJed Brown +  r - vector to hold residual (or PETSC_NULL)
660089b2837SJed Brown .  func - the function to compute residual (or PETSC_NULL)
661089b2837SJed Brown -  ctx - the function context (or PETSC_NULL)
662089b2837SJed Brown 
663089b2837SJed Brown    Level: advanced
664089b2837SJed Brown 
665089b2837SJed Brown .keywords: TS, nonlinear, get, function
666089b2837SJed Brown 
667089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction()
668089b2837SJed Brown @*/
669089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx)
670089b2837SJed Brown {
671089b2837SJed Brown   PetscErrorCode ierr;
672089b2837SJed Brown   SNES snes;
673089b2837SJed Brown 
674089b2837SJed Brown   PetscFunctionBegin;
675089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
676089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
677089b2837SJed Brown   ierr = SNESGetFunction(snes,r,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
6783b5f76d0SSean Farley   if (func) *func = ts->userops->ifunction;
679089b2837SJed Brown   if (ctx)  *ctx  = ts->funP;
680089b2837SJed Brown   PetscFunctionReturn(0);
681089b2837SJed Brown }
682089b2837SJed Brown 
683089b2837SJed Brown #undef __FUNCT__
684089b2837SJed Brown #define __FUNCT__ "TSGetRHSFunction"
685089b2837SJed Brown /*@C
686089b2837SJed Brown    TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it.
687089b2837SJed Brown 
688089b2837SJed Brown    Not Collective
689089b2837SJed Brown 
690089b2837SJed Brown    Input Parameter:
691089b2837SJed Brown .  ts - the TS context
692089b2837SJed Brown 
693089b2837SJed Brown    Output Parameter:
694089b2837SJed Brown +  r - vector to hold computed right hand side (or PETSC_NULL)
695089b2837SJed Brown .  func - the function to compute right hand side (or PETSC_NULL)
696089b2837SJed Brown -  ctx - the function context (or PETSC_NULL)
697089b2837SJed Brown 
698089b2837SJed Brown    Level: advanced
699089b2837SJed Brown 
700089b2837SJed Brown .keywords: TS, nonlinear, get, function
701089b2837SJed Brown 
702089b2837SJed Brown .seealso: TSSetRhsfunction(), SNESGetFunction()
703089b2837SJed Brown @*/
704089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx)
705089b2837SJed Brown {
706089b2837SJed Brown   PetscErrorCode ierr;
707089b2837SJed Brown   SNES snes;
708089b2837SJed Brown 
709089b2837SJed Brown   PetscFunctionBegin;
710089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
711089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
712089b2837SJed Brown   ierr = SNESGetFunction(snes,r,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
7133b5f76d0SSean Farley   if (func) *func = ts->userops->rhsfunction;
714089b2837SJed Brown   if (ctx)  *ctx  = ts->funP;
715316643e7SJed Brown   PetscFunctionReturn(0);
716316643e7SJed Brown }
717316643e7SJed Brown 
718316643e7SJed Brown #undef __FUNCT__
719316643e7SJed Brown #define __FUNCT__ "TSSetIJacobian"
720316643e7SJed Brown /*@C
721a4f0a591SBarry Smith    TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function
722a4f0a591SBarry Smith         you provided with TSSetIFunction().
723316643e7SJed Brown 
7243f9fe445SBarry Smith    Logically Collective on TS
725316643e7SJed Brown 
726316643e7SJed Brown    Input Parameters:
727316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
728316643e7SJed Brown .  A   - Jacobian matrix
729316643e7SJed Brown .  B   - preconditioning matrix for A (may be same as A)
730316643e7SJed Brown .  f   - the Jacobian evaluation routine
731316643e7SJed Brown -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be PETSC_NULL)
732316643e7SJed Brown 
733316643e7SJed Brown    Calling sequence of f:
7341b4a444bSJed Brown $  f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat *A,Mat *B,MatStructure *flag,void *ctx);
735316643e7SJed Brown 
736316643e7SJed Brown +  t    - time at step/stage being solved
7371b4a444bSJed Brown .  U    - state vector
7381b4a444bSJed Brown .  U_t  - time derivative of state vector
739316643e7SJed Brown .  a    - shift
7401b4a444bSJed Brown .  A    - Jacobian of G(U) = F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t
741316643e7SJed Brown .  B    - preconditioning matrix for A, may be same as A
742316643e7SJed Brown .  flag - flag indicating information about the preconditioner matrix
743316643e7SJed Brown           structure (same as flag in KSPSetOperators())
744316643e7SJed Brown -  ctx  - [optional] user-defined context for matrix evaluation routine
745316643e7SJed Brown 
746316643e7SJed Brown    Notes:
747316643e7SJed Brown    The matrices A and B are exactly the matrices that are used by SNES for the nonlinear solve.
748316643e7SJed Brown 
749a4f0a591SBarry Smith    The matrix dF/dU + a*dF/dU_t you provide turns out to be
750a4f0a591SBarry Smith    the Jacobian of G(U) = F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved.
751a4f0a591SBarry Smith    The time integrator internally approximates U_t by W+a*U where the positive "shift"
752a4f0a591SBarry Smith    a and vector W depend on the integration method, step size, and past states. For example with
753a4f0a591SBarry Smith    the backward Euler method a = 1/dt and W = -a*U(previous timestep) so
754a4f0a591SBarry Smith    W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt
755a4f0a591SBarry Smith 
756316643e7SJed Brown    Level: beginner
757316643e7SJed Brown 
758316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian
759316643e7SJed Brown 
760316643e7SJed Brown .seealso: TSSetIFunction(), TSSetRHSJacobian()
761316643e7SJed Brown 
762316643e7SJed Brown @*/
7637087cfbeSBarry Smith PetscErrorCode  TSSetIJacobian(TS ts,Mat A,Mat B,TSIJacobian f,void *ctx)
764316643e7SJed Brown {
765316643e7SJed Brown   PetscErrorCode ierr;
766089b2837SJed Brown   SNES           snes;
767316643e7SJed Brown 
768316643e7SJed Brown   PetscFunctionBegin;
7690700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7700700a824SBarry Smith   if (A) PetscValidHeaderSpecific(A,MAT_CLASSID,2);
7710700a824SBarry Smith   if (B) PetscValidHeaderSpecific(B,MAT_CLASSID,3);
772316643e7SJed Brown   if (A) PetscCheckSameComm(ts,1,A,2);
773316643e7SJed Brown   if (B) PetscCheckSameComm(ts,1,B,3);
7743b5f76d0SSean Farley   if (f)   ts->userops->ijacobian = f;
775316643e7SJed Brown   if (ctx) ts->jacP           = ctx;
776089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
777089b2837SJed Brown   ierr = SNESSetJacobian(snes,A,B,SNESTSFormJacobian,ts);CHKERRQ(ierr);
778316643e7SJed Brown   PetscFunctionReturn(0);
779316643e7SJed Brown }
780316643e7SJed Brown 
7814a2ae208SSatish Balay #undef __FUNCT__
7824a2ae208SSatish Balay #define __FUNCT__ "TSView"
7837e2c5f70SBarry Smith /*@C
784d763cef2SBarry Smith     TSView - Prints the TS data structure.
785d763cef2SBarry Smith 
7864c49b128SBarry Smith     Collective on TS
787d763cef2SBarry Smith 
788d763cef2SBarry Smith     Input Parameters:
789d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
790d763cef2SBarry Smith -   viewer - visualization context
791d763cef2SBarry Smith 
792d763cef2SBarry Smith     Options Database Key:
793d763cef2SBarry Smith .   -ts_view - calls TSView() at end of TSStep()
794d763cef2SBarry Smith 
795d763cef2SBarry Smith     Notes:
796d763cef2SBarry Smith     The available visualization contexts include
797b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
798b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
799d763cef2SBarry Smith          output where only the first processor opens
800d763cef2SBarry Smith          the file.  All other processors send their
801d763cef2SBarry Smith          data to the first processor to print.
802d763cef2SBarry Smith 
803d763cef2SBarry Smith     The user can open an alternative visualization context with
804b0a32e0cSBarry Smith     PetscViewerASCIIOpen() - output to a specified file.
805d763cef2SBarry Smith 
806d763cef2SBarry Smith     Level: beginner
807d763cef2SBarry Smith 
808d763cef2SBarry Smith .keywords: TS, timestep, view
809d763cef2SBarry Smith 
810b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
811d763cef2SBarry Smith @*/
8127087cfbeSBarry Smith PetscErrorCode  TSView(TS ts,PetscViewer viewer)
813d763cef2SBarry Smith {
814dfbe8321SBarry Smith   PetscErrorCode ierr;
815a313700dSBarry Smith   const TSType   type;
816089b2837SJed Brown   PetscBool      iascii,isstring,isundials;
817d763cef2SBarry Smith 
818d763cef2SBarry Smith   PetscFunctionBegin;
8190700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
8203050cee2SBarry Smith   if (!viewer) {
8217adad957SLisandro Dalcin     ierr = PetscViewerASCIIGetStdout(((PetscObject)ts)->comm,&viewer);CHKERRQ(ierr);
8223050cee2SBarry Smith   }
8230700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
824c9780b6fSBarry Smith   PetscCheckSameComm(ts,1,viewer,2);
825fd16b177SBarry Smith 
8262692d6eeSBarry Smith   ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
8272692d6eeSBarry Smith   ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
82832077d6dSBarry Smith   if (iascii) {
829317d6ea6SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer,"TS Object");CHKERRQ(ierr);
83077431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr);
831a83599f4SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum time=%G\n",ts->max_time);CHKERRQ(ierr);
832d763cef2SBarry Smith     if (ts->problem_type == TS_NONLINEAR) {
83377431f27SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solver iterations=%D\n",ts->nonlinear_its);CHKERRQ(ierr);
834c610991cSLisandro Dalcin       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solve failures=%D\n",ts->num_snes_failures);CHKERRQ(ierr);
835d763cef2SBarry Smith     }
83677431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",ts->linear_its);CHKERRQ(ierr);
837193ac0bcSJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr);
838d52bd9f3SBarry Smith     if (ts->ops->view) {
839d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
840d52bd9f3SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
841d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
842d52bd9f3SBarry Smith     }
8430f5bd95cSBarry Smith   } else if (isstring) {
844a313700dSBarry Smith     ierr = TSGetType(ts,&type);CHKERRQ(ierr);
845b0a32e0cSBarry Smith     ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr);
846d763cef2SBarry Smith   }
847b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
848089b2837SJed Brown   ierr = PetscTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr);
849b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
850d763cef2SBarry Smith   PetscFunctionReturn(0);
851d763cef2SBarry Smith }
852d763cef2SBarry Smith 
853d763cef2SBarry Smith 
8544a2ae208SSatish Balay #undef __FUNCT__
8554a2ae208SSatish Balay #define __FUNCT__ "TSSetApplicationContext"
856b07ff414SBarry Smith /*@
857d763cef2SBarry Smith    TSSetApplicationContext - Sets an optional user-defined context for
858d763cef2SBarry Smith    the timesteppers.
859d763cef2SBarry Smith 
8603f9fe445SBarry Smith    Logically Collective on TS
861d763cef2SBarry Smith 
862d763cef2SBarry Smith    Input Parameters:
863d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
864d763cef2SBarry Smith -  usrP - optional user context
865d763cef2SBarry Smith 
866d763cef2SBarry Smith    Level: intermediate
867d763cef2SBarry Smith 
868d763cef2SBarry Smith .keywords: TS, timestep, set, application, context
869d763cef2SBarry Smith 
870d763cef2SBarry Smith .seealso: TSGetApplicationContext()
871d763cef2SBarry Smith @*/
8727087cfbeSBarry Smith PetscErrorCode  TSSetApplicationContext(TS ts,void *usrP)
873d763cef2SBarry Smith {
874d763cef2SBarry Smith   PetscFunctionBegin;
8750700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
876d763cef2SBarry Smith   ts->user = usrP;
877d763cef2SBarry Smith   PetscFunctionReturn(0);
878d763cef2SBarry Smith }
879d763cef2SBarry Smith 
8804a2ae208SSatish Balay #undef __FUNCT__
8814a2ae208SSatish Balay #define __FUNCT__ "TSGetApplicationContext"
882b07ff414SBarry Smith /*@
883d763cef2SBarry Smith     TSGetApplicationContext - Gets the user-defined context for the
884d763cef2SBarry Smith     timestepper.
885d763cef2SBarry Smith 
886d763cef2SBarry Smith     Not Collective
887d763cef2SBarry Smith 
888d763cef2SBarry Smith     Input Parameter:
889d763cef2SBarry Smith .   ts - the TS context obtained from TSCreate()
890d763cef2SBarry Smith 
891d763cef2SBarry Smith     Output Parameter:
892d763cef2SBarry Smith .   usrP - user context
893d763cef2SBarry Smith 
894d763cef2SBarry Smith     Level: intermediate
895d763cef2SBarry Smith 
896d763cef2SBarry Smith .keywords: TS, timestep, get, application, context
897d763cef2SBarry Smith 
898d763cef2SBarry Smith .seealso: TSSetApplicationContext()
899d763cef2SBarry Smith @*/
900e71120c6SJed Brown PetscErrorCode  TSGetApplicationContext(TS ts,void *usrP)
901d763cef2SBarry Smith {
902d763cef2SBarry Smith   PetscFunctionBegin;
9030700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
904e71120c6SJed Brown   *(void**)usrP = ts->user;
905d763cef2SBarry Smith   PetscFunctionReturn(0);
906d763cef2SBarry Smith }
907d763cef2SBarry Smith 
9084a2ae208SSatish Balay #undef __FUNCT__
9094a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStepNumber"
910d763cef2SBarry Smith /*@
911d763cef2SBarry Smith    TSGetTimeStepNumber - Gets the current number of timesteps.
912d763cef2SBarry Smith 
913d763cef2SBarry Smith    Not Collective
914d763cef2SBarry Smith 
915d763cef2SBarry Smith    Input Parameter:
916d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
917d763cef2SBarry Smith 
918d763cef2SBarry Smith    Output Parameter:
919d763cef2SBarry Smith .  iter - number steps so far
920d763cef2SBarry Smith 
921d763cef2SBarry Smith    Level: intermediate
922d763cef2SBarry Smith 
923d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number
924d763cef2SBarry Smith @*/
9257087cfbeSBarry Smith PetscErrorCode  TSGetTimeStepNumber(TS ts,PetscInt* iter)
926d763cef2SBarry Smith {
927d763cef2SBarry Smith   PetscFunctionBegin;
9280700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
9294482741eSBarry Smith   PetscValidIntPointer(iter,2);
930d763cef2SBarry Smith   *iter = ts->steps;
931d763cef2SBarry Smith   PetscFunctionReturn(0);
932d763cef2SBarry Smith }
933d763cef2SBarry Smith 
9344a2ae208SSatish Balay #undef __FUNCT__
9354a2ae208SSatish Balay #define __FUNCT__ "TSSetInitialTimeStep"
936d763cef2SBarry Smith /*@
937d763cef2SBarry Smith    TSSetInitialTimeStep - Sets the initial timestep to be used,
938d763cef2SBarry Smith    as well as the initial time.
939d763cef2SBarry Smith 
9403f9fe445SBarry Smith    Logically Collective on TS
941d763cef2SBarry Smith 
942d763cef2SBarry Smith    Input Parameters:
943d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
944d763cef2SBarry Smith .  initial_time - the initial time
945d763cef2SBarry Smith -  time_step - the size of the timestep
946d763cef2SBarry Smith 
947d763cef2SBarry Smith    Level: intermediate
948d763cef2SBarry Smith 
949d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep()
950d763cef2SBarry Smith 
951d763cef2SBarry Smith .keywords: TS, set, initial, timestep
952d763cef2SBarry Smith @*/
9537087cfbeSBarry Smith PetscErrorCode  TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step)
954d763cef2SBarry Smith {
955e144a568SJed Brown   PetscErrorCode ierr;
956e144a568SJed Brown 
957d763cef2SBarry Smith   PetscFunctionBegin;
9580700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
959e144a568SJed Brown   ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
960cdbf8f93SLisandro Dalcin   ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr);
961d763cef2SBarry Smith   PetscFunctionReturn(0);
962d763cef2SBarry Smith }
963d763cef2SBarry Smith 
9644a2ae208SSatish Balay #undef __FUNCT__
9654a2ae208SSatish Balay #define __FUNCT__ "TSSetTimeStep"
966d763cef2SBarry Smith /*@
967d763cef2SBarry Smith    TSSetTimeStep - Allows one to reset the timestep at any time,
968d763cef2SBarry Smith    useful for simple pseudo-timestepping codes.
969d763cef2SBarry Smith 
9703f9fe445SBarry Smith    Logically Collective on TS
971d763cef2SBarry Smith 
972d763cef2SBarry Smith    Input Parameters:
973d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
974d763cef2SBarry Smith -  time_step - the size of the timestep
975d763cef2SBarry Smith 
976d763cef2SBarry Smith    Level: intermediate
977d763cef2SBarry Smith 
978d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
979d763cef2SBarry Smith 
980d763cef2SBarry Smith .keywords: TS, set, timestep
981d763cef2SBarry Smith @*/
9827087cfbeSBarry Smith PetscErrorCode  TSSetTimeStep(TS ts,PetscReal time_step)
983d763cef2SBarry Smith {
984d763cef2SBarry Smith   PetscFunctionBegin;
9850700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
986c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,time_step,2);
987d763cef2SBarry Smith   ts->time_step = time_step;
988d763cef2SBarry Smith   PetscFunctionReturn(0);
989d763cef2SBarry Smith }
990d763cef2SBarry Smith 
9914a2ae208SSatish Balay #undef __FUNCT__
992a43b19c4SJed Brown #define __FUNCT__ "TSSetExactFinalTime"
993a43b19c4SJed Brown /*@
994a43b19c4SJed Brown    TSSetExactFinalTime - Determines whether to interpolate solution to the
995a43b19c4SJed Brown       exact final time requested by the user or just returns it at the final time
996a43b19c4SJed Brown       it computed.
997a43b19c4SJed Brown 
998a43b19c4SJed Brown   Logically Collective on TS
999a43b19c4SJed Brown 
1000a43b19c4SJed Brown    Input Parameter:
1001a43b19c4SJed Brown +   ts - the time-step context
1002a43b19c4SJed Brown -   ft - PETSC_TRUE if interpolates, else PETSC_FALSE
1003a43b19c4SJed Brown 
1004a43b19c4SJed Brown    Level: beginner
1005a43b19c4SJed Brown 
1006a43b19c4SJed Brown .seealso: TSSetDuration()
1007a43b19c4SJed Brown @*/
1008a43b19c4SJed Brown PetscErrorCode  TSSetExactFinalTime(TS ts,PetscBool flg)
1009a43b19c4SJed Brown {
1010a43b19c4SJed Brown 
1011a43b19c4SJed Brown   PetscFunctionBegin;
1012a43b19c4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1013cdbf8f93SLisandro Dalcin   PetscValidLogicalCollectiveBool(ts,flg,2);
1014a43b19c4SJed Brown   ts->exact_final_time = flg;
1015a43b19c4SJed Brown   PetscFunctionReturn(0);
1016a43b19c4SJed Brown }
1017a43b19c4SJed Brown 
1018a43b19c4SJed Brown #undef __FUNCT__
10194a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStep"
1020d763cef2SBarry Smith /*@
1021d763cef2SBarry Smith    TSGetTimeStep - Gets the current timestep size.
1022d763cef2SBarry Smith 
1023d763cef2SBarry Smith    Not Collective
1024d763cef2SBarry Smith 
1025d763cef2SBarry Smith    Input Parameter:
1026d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1027d763cef2SBarry Smith 
1028d763cef2SBarry Smith    Output Parameter:
1029d763cef2SBarry Smith .  dt - the current timestep size
1030d763cef2SBarry Smith 
1031d763cef2SBarry Smith    Level: intermediate
1032d763cef2SBarry Smith 
1033d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
1034d763cef2SBarry Smith 
1035d763cef2SBarry Smith .keywords: TS, get, timestep
1036d763cef2SBarry Smith @*/
10377087cfbeSBarry Smith PetscErrorCode  TSGetTimeStep(TS ts,PetscReal* dt)
1038d763cef2SBarry Smith {
1039d763cef2SBarry Smith   PetscFunctionBegin;
10400700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
10414482741eSBarry Smith   PetscValidDoublePointer(dt,2);
1042d763cef2SBarry Smith   *dt = ts->time_step;
1043d763cef2SBarry Smith   PetscFunctionReturn(0);
1044d763cef2SBarry Smith }
1045d763cef2SBarry Smith 
10464a2ae208SSatish Balay #undef __FUNCT__
10474a2ae208SSatish Balay #define __FUNCT__ "TSGetSolution"
1048d8e5e3e6SSatish Balay /*@
1049d763cef2SBarry Smith    TSGetSolution - Returns the solution at the present timestep. It
1050d763cef2SBarry Smith    is valid to call this routine inside the function that you are evaluating
1051d763cef2SBarry Smith    in order to move to the new timestep. This vector not changed until
1052d763cef2SBarry Smith    the solution at the next timestep has been calculated.
1053d763cef2SBarry Smith 
1054d763cef2SBarry Smith    Not Collective, but Vec returned is parallel if TS is parallel
1055d763cef2SBarry Smith 
1056d763cef2SBarry Smith    Input Parameter:
1057d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1058d763cef2SBarry Smith 
1059d763cef2SBarry Smith    Output Parameter:
1060d763cef2SBarry Smith .  v - the vector containing the solution
1061d763cef2SBarry Smith 
1062d763cef2SBarry Smith    Level: intermediate
1063d763cef2SBarry Smith 
1064d763cef2SBarry Smith .seealso: TSGetTimeStep()
1065d763cef2SBarry Smith 
1066d763cef2SBarry Smith .keywords: TS, timestep, get, solution
1067d763cef2SBarry Smith @*/
10687087cfbeSBarry Smith PetscErrorCode  TSGetSolution(TS ts,Vec *v)
1069d763cef2SBarry Smith {
1070d763cef2SBarry Smith   PetscFunctionBegin;
10710700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
10724482741eSBarry Smith   PetscValidPointer(v,2);
10738737fe31SLisandro Dalcin   *v = ts->vec_sol;
1074d763cef2SBarry Smith   PetscFunctionReturn(0);
1075d763cef2SBarry Smith }
1076d763cef2SBarry Smith 
1077bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */
10784a2ae208SSatish Balay #undef __FUNCT__
1079bdad233fSMatthew Knepley #define __FUNCT__ "TSSetProblemType"
1080d8e5e3e6SSatish Balay /*@
1081bdad233fSMatthew Knepley   TSSetProblemType - Sets the type of problem to be solved.
1082d763cef2SBarry Smith 
1083bdad233fSMatthew Knepley   Not collective
1084d763cef2SBarry Smith 
1085bdad233fSMatthew Knepley   Input Parameters:
1086bdad233fSMatthew Knepley + ts   - The TS
1087bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1088d763cef2SBarry Smith .vb
1089d763cef2SBarry Smith          U_t = A U
1090d763cef2SBarry Smith          U_t = A(t) U
1091d763cef2SBarry Smith          U_t = F(t,U)
1092d763cef2SBarry Smith .ve
1093d763cef2SBarry Smith 
1094d763cef2SBarry Smith    Level: beginner
1095d763cef2SBarry Smith 
1096bdad233fSMatthew Knepley .keywords: TS, problem type
1097bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
1098d763cef2SBarry Smith @*/
10997087cfbeSBarry Smith PetscErrorCode  TSSetProblemType(TS ts, TSProblemType type)
1100a7cc72afSBarry Smith {
11019e2a6581SJed Brown   PetscErrorCode ierr;
11029e2a6581SJed Brown 
1103d763cef2SBarry Smith   PetscFunctionBegin;
11040700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1105bdad233fSMatthew Knepley   ts->problem_type = type;
11069e2a6581SJed Brown   if (type == TS_LINEAR) {
11079e2a6581SJed Brown     SNES snes;
11089e2a6581SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
11099e2a6581SJed Brown     ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);
11109e2a6581SJed Brown   }
1111d763cef2SBarry Smith   PetscFunctionReturn(0);
1112d763cef2SBarry Smith }
1113d763cef2SBarry Smith 
1114bdad233fSMatthew Knepley #undef __FUNCT__
1115bdad233fSMatthew Knepley #define __FUNCT__ "TSGetProblemType"
1116bdad233fSMatthew Knepley /*@C
1117bdad233fSMatthew Knepley   TSGetProblemType - Gets the type of problem to be solved.
1118bdad233fSMatthew Knepley 
1119bdad233fSMatthew Knepley   Not collective
1120bdad233fSMatthew Knepley 
1121bdad233fSMatthew Knepley   Input Parameter:
1122bdad233fSMatthew Knepley . ts   - The TS
1123bdad233fSMatthew Knepley 
1124bdad233fSMatthew Knepley   Output Parameter:
1125bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1126bdad233fSMatthew Knepley .vb
1127089b2837SJed Brown          M U_t = A U
1128089b2837SJed Brown          M(t) U_t = A(t) U
1129bdad233fSMatthew Knepley          U_t = F(t,U)
1130bdad233fSMatthew Knepley .ve
1131bdad233fSMatthew Knepley 
1132bdad233fSMatthew Knepley    Level: beginner
1133bdad233fSMatthew Knepley 
1134bdad233fSMatthew Knepley .keywords: TS, problem type
1135bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
1136bdad233fSMatthew Knepley @*/
11377087cfbeSBarry Smith PetscErrorCode  TSGetProblemType(TS ts, TSProblemType *type)
1138a7cc72afSBarry Smith {
1139bdad233fSMatthew Knepley   PetscFunctionBegin;
11400700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
11414482741eSBarry Smith   PetscValidIntPointer(type,2);
1142bdad233fSMatthew Knepley   *type = ts->problem_type;
1143bdad233fSMatthew Knepley   PetscFunctionReturn(0);
1144bdad233fSMatthew Knepley }
1145d763cef2SBarry Smith 
11464a2ae208SSatish Balay #undef __FUNCT__
11474a2ae208SSatish Balay #define __FUNCT__ "TSSetUp"
1148d763cef2SBarry Smith /*@
1149d763cef2SBarry Smith    TSSetUp - Sets up the internal data structures for the later use
1150d763cef2SBarry Smith    of a timestepper.
1151d763cef2SBarry Smith 
1152d763cef2SBarry Smith    Collective on TS
1153d763cef2SBarry Smith 
1154d763cef2SBarry Smith    Input Parameter:
1155d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1156d763cef2SBarry Smith 
1157d763cef2SBarry Smith    Notes:
1158d763cef2SBarry Smith    For basic use of the TS solvers the user need not explicitly call
1159d763cef2SBarry Smith    TSSetUp(), since these actions will automatically occur during
1160d763cef2SBarry Smith    the call to TSStep().  However, if one wishes to control this
1161d763cef2SBarry Smith    phase separately, TSSetUp() should be called after TSCreate()
1162d763cef2SBarry Smith    and optional routines of the form TSSetXXX(), but before TSStep().
1163d763cef2SBarry Smith 
1164d763cef2SBarry Smith    Level: advanced
1165d763cef2SBarry Smith 
1166d763cef2SBarry Smith .keywords: TS, timestep, setup
1167d763cef2SBarry Smith 
1168d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy()
1169d763cef2SBarry Smith @*/
11707087cfbeSBarry Smith PetscErrorCode  TSSetUp(TS ts)
1171d763cef2SBarry Smith {
1172dfbe8321SBarry Smith   PetscErrorCode ierr;
1173d763cef2SBarry Smith 
1174d763cef2SBarry Smith   PetscFunctionBegin;
11750700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1176277b19d0SLisandro Dalcin   if (ts->setupcalled) PetscFunctionReturn(0);
1177277b19d0SLisandro Dalcin 
11787adad957SLisandro Dalcin   if (!((PetscObject)ts)->type_name) {
11799596e0b4SJed Brown     ierr = TSSetType(ts,TSEULER);CHKERRQ(ierr);
1180d763cef2SBarry Smith   }
1181a43b19c4SJed Brown   if (ts->exact_final_time == PETSC_DECIDE) ts->exact_final_time = PETSC_FALSE;
1182277b19d0SLisandro Dalcin 
1183277b19d0SLisandro Dalcin   if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first");
1184277b19d0SLisandro Dalcin 
1185277b19d0SLisandro Dalcin   if (ts->ops->setup) {
1186000e7ae3SMatthew Knepley     ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr);
1187277b19d0SLisandro Dalcin   }
1188277b19d0SLisandro Dalcin 
1189277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_TRUE;
1190277b19d0SLisandro Dalcin   PetscFunctionReturn(0);
1191277b19d0SLisandro Dalcin }
1192277b19d0SLisandro Dalcin 
1193277b19d0SLisandro Dalcin #undef __FUNCT__
1194277b19d0SLisandro Dalcin #define __FUNCT__ "TSReset"
1195277b19d0SLisandro Dalcin /*@
1196277b19d0SLisandro Dalcin    TSReset - Resets a TS context and removes any allocated Vecs and Mats.
1197277b19d0SLisandro Dalcin 
1198277b19d0SLisandro Dalcin    Collective on TS
1199277b19d0SLisandro Dalcin 
1200277b19d0SLisandro Dalcin    Input Parameter:
1201277b19d0SLisandro Dalcin .  ts - the TS context obtained from TSCreate()
1202277b19d0SLisandro Dalcin 
1203277b19d0SLisandro Dalcin    Level: beginner
1204277b19d0SLisandro Dalcin 
1205277b19d0SLisandro Dalcin .keywords: TS, timestep, reset
1206277b19d0SLisandro Dalcin 
1207277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy()
1208277b19d0SLisandro Dalcin @*/
1209277b19d0SLisandro Dalcin PetscErrorCode  TSReset(TS ts)
1210277b19d0SLisandro Dalcin {
1211277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1212277b19d0SLisandro Dalcin 
1213277b19d0SLisandro Dalcin   PetscFunctionBegin;
1214277b19d0SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1215277b19d0SLisandro Dalcin   if (ts->ops->reset) {
1216277b19d0SLisandro Dalcin     ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr);
1217277b19d0SLisandro Dalcin   }
1218277b19d0SLisandro Dalcin   if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);}
12194e684422SJed Brown   ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
12204e684422SJed Brown   ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1221214bc6a2SJed Brown   ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr);
12226bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
122338637c2eSJed Brown   ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr);
1224277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_FALSE;
1225d763cef2SBarry Smith   PetscFunctionReturn(0);
1226d763cef2SBarry Smith }
1227d763cef2SBarry Smith 
12284a2ae208SSatish Balay #undef __FUNCT__
12294a2ae208SSatish Balay #define __FUNCT__ "TSDestroy"
1230d8e5e3e6SSatish Balay /*@
1231d763cef2SBarry Smith    TSDestroy - Destroys the timestepper context that was created
1232d763cef2SBarry Smith    with TSCreate().
1233d763cef2SBarry Smith 
1234d763cef2SBarry Smith    Collective on TS
1235d763cef2SBarry Smith 
1236d763cef2SBarry Smith    Input Parameter:
1237d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1238d763cef2SBarry Smith 
1239d763cef2SBarry Smith    Level: beginner
1240d763cef2SBarry Smith 
1241d763cef2SBarry Smith .keywords: TS, timestepper, destroy
1242d763cef2SBarry Smith 
1243d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve()
1244d763cef2SBarry Smith @*/
12456bf464f9SBarry Smith PetscErrorCode  TSDestroy(TS *ts)
1246d763cef2SBarry Smith {
12476849ba73SBarry Smith   PetscErrorCode ierr;
1248d763cef2SBarry Smith 
1249d763cef2SBarry Smith   PetscFunctionBegin;
12506bf464f9SBarry Smith   if (!*ts) PetscFunctionReturn(0);
12516bf464f9SBarry Smith   PetscValidHeaderSpecific((*ts),TS_CLASSID,1);
12526bf464f9SBarry Smith   if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);}
1253d763cef2SBarry Smith 
12546bf464f9SBarry Smith   ierr = TSReset((*ts));CHKERRQ(ierr);
1255277b19d0SLisandro Dalcin 
1256be0abb6dSBarry Smith   /* if memory was published with AMS then destroy it */
12576bf464f9SBarry Smith   ierr = PetscObjectDepublish((*ts));CHKERRQ(ierr);
12586bf464f9SBarry Smith   if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);}
12596d4c513bSLisandro Dalcin 
12606bf464f9SBarry Smith   ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr);
12616bf464f9SBarry Smith   ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr);
12626bf464f9SBarry Smith   ierr = TSMonitorCancel((*ts));CHKERRQ(ierr);
12636d4c513bSLisandro Dalcin 
12643b5f76d0SSean Farley   ierr = PetscFree((*ts)->userops);
12653b5f76d0SSean Farley 
1266a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr);
1267d763cef2SBarry Smith   PetscFunctionReturn(0);
1268d763cef2SBarry Smith }
1269d763cef2SBarry Smith 
12704a2ae208SSatish Balay #undef __FUNCT__
12714a2ae208SSatish Balay #define __FUNCT__ "TSGetSNES"
1272d8e5e3e6SSatish Balay /*@
1273d763cef2SBarry Smith    TSGetSNES - Returns the SNES (nonlinear solver) associated with
1274d763cef2SBarry Smith    a TS (timestepper) context. Valid only for nonlinear problems.
1275d763cef2SBarry Smith 
1276d763cef2SBarry Smith    Not Collective, but SNES is parallel if TS is parallel
1277d763cef2SBarry Smith 
1278d763cef2SBarry Smith    Input Parameter:
1279d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1280d763cef2SBarry Smith 
1281d763cef2SBarry Smith    Output Parameter:
1282d763cef2SBarry Smith .  snes - the nonlinear solver context
1283d763cef2SBarry Smith 
1284d763cef2SBarry Smith    Notes:
1285d763cef2SBarry Smith    The user can then directly manipulate the SNES context to set various
1286d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
128794b7f48cSBarry Smith    KSP, KSP, and PC contexts as well.
1288d763cef2SBarry Smith 
1289d763cef2SBarry Smith    TSGetSNES() does not work for integrators that do not use SNES; in
1290d763cef2SBarry Smith    this case TSGetSNES() returns PETSC_NULL in snes.
1291d763cef2SBarry Smith 
1292d763cef2SBarry Smith    Level: beginner
1293d763cef2SBarry Smith 
1294d763cef2SBarry Smith .keywords: timestep, get, SNES
1295d763cef2SBarry Smith @*/
12967087cfbeSBarry Smith PetscErrorCode  TSGetSNES(TS ts,SNES *snes)
1297d763cef2SBarry Smith {
1298d372ba47SLisandro Dalcin   PetscErrorCode ierr;
1299d372ba47SLisandro Dalcin 
1300d763cef2SBarry Smith   PetscFunctionBegin;
13010700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
13024482741eSBarry Smith   PetscValidPointer(snes,2);
1303d372ba47SLisandro Dalcin   if (!ts->snes) {
1304d372ba47SLisandro Dalcin     ierr = SNESCreate(((PetscObject)ts)->comm,&ts->snes);CHKERRQ(ierr);
1305d372ba47SLisandro Dalcin     ierr = PetscLogObjectParent(ts,ts->snes);CHKERRQ(ierr);
1306d372ba47SLisandro Dalcin     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr);
13079e2a6581SJed Brown     if (ts->problem_type == TS_LINEAR) {
13089e2a6581SJed Brown       ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);
13099e2a6581SJed Brown     }
1310d372ba47SLisandro Dalcin   }
1311d763cef2SBarry Smith   *snes = ts->snes;
1312d763cef2SBarry Smith   PetscFunctionReturn(0);
1313d763cef2SBarry Smith }
1314d763cef2SBarry Smith 
13154a2ae208SSatish Balay #undef __FUNCT__
131694b7f48cSBarry Smith #define __FUNCT__ "TSGetKSP"
1317d8e5e3e6SSatish Balay /*@
131894b7f48cSBarry Smith    TSGetKSP - Returns the KSP (linear solver) associated with
1319d763cef2SBarry Smith    a TS (timestepper) context.
1320d763cef2SBarry Smith 
132194b7f48cSBarry Smith    Not Collective, but KSP is parallel if TS is parallel
1322d763cef2SBarry Smith 
1323d763cef2SBarry Smith    Input Parameter:
1324d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1325d763cef2SBarry Smith 
1326d763cef2SBarry Smith    Output Parameter:
132794b7f48cSBarry Smith .  ksp - the nonlinear solver context
1328d763cef2SBarry Smith 
1329d763cef2SBarry Smith    Notes:
133094b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
1331d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
1332d763cef2SBarry Smith    KSP and PC contexts as well.
1333d763cef2SBarry Smith 
133494b7f48cSBarry Smith    TSGetKSP() does not work for integrators that do not use KSP;
133594b7f48cSBarry Smith    in this case TSGetKSP() returns PETSC_NULL in ksp.
1336d763cef2SBarry Smith 
1337d763cef2SBarry Smith    Level: beginner
1338d763cef2SBarry Smith 
133994b7f48cSBarry Smith .keywords: timestep, get, KSP
1340d763cef2SBarry Smith @*/
13417087cfbeSBarry Smith PetscErrorCode  TSGetKSP(TS ts,KSP *ksp)
1342d763cef2SBarry Smith {
1343d372ba47SLisandro Dalcin   PetscErrorCode ierr;
1344089b2837SJed Brown   SNES           snes;
1345d372ba47SLisandro Dalcin 
1346d763cef2SBarry Smith   PetscFunctionBegin;
13470700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
13484482741eSBarry Smith   PetscValidPointer(ksp,2);
134917186662SBarry Smith   if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first");
1350e32f2f54SBarry Smith   if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()");
1351089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1352089b2837SJed Brown   ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr);
1353d763cef2SBarry Smith   PetscFunctionReturn(0);
1354d763cef2SBarry Smith }
1355d763cef2SBarry Smith 
1356d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */
1357d763cef2SBarry Smith 
13584a2ae208SSatish Balay #undef __FUNCT__
1359adb62b0dSMatthew Knepley #define __FUNCT__ "TSGetDuration"
1360adb62b0dSMatthew Knepley /*@
1361adb62b0dSMatthew Knepley    TSGetDuration - Gets the maximum number of timesteps to use and
1362adb62b0dSMatthew Knepley    maximum time for iteration.
1363adb62b0dSMatthew Knepley 
13643f9fe445SBarry Smith    Not Collective
1365adb62b0dSMatthew Knepley 
1366adb62b0dSMatthew Knepley    Input Parameters:
1367adb62b0dSMatthew Knepley +  ts       - the TS context obtained from TSCreate()
1368adb62b0dSMatthew Knepley .  maxsteps - maximum number of iterations to use, or PETSC_NULL
1369adb62b0dSMatthew Knepley -  maxtime  - final time to iterate to, or PETSC_NULL
1370adb62b0dSMatthew Knepley 
1371adb62b0dSMatthew Knepley    Level: intermediate
1372adb62b0dSMatthew Knepley 
1373adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time
1374adb62b0dSMatthew Knepley @*/
13757087cfbeSBarry Smith PetscErrorCode  TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
1376adb62b0dSMatthew Knepley {
1377adb62b0dSMatthew Knepley   PetscFunctionBegin;
13780700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1379abc0a331SBarry Smith   if (maxsteps) {
13804482741eSBarry Smith     PetscValidIntPointer(maxsteps,2);
1381adb62b0dSMatthew Knepley     *maxsteps = ts->max_steps;
1382adb62b0dSMatthew Knepley   }
1383abc0a331SBarry Smith   if (maxtime) {
13844482741eSBarry Smith     PetscValidScalarPointer(maxtime,3);
1385adb62b0dSMatthew Knepley     *maxtime  = ts->max_time;
1386adb62b0dSMatthew Knepley   }
1387adb62b0dSMatthew Knepley   PetscFunctionReturn(0);
1388adb62b0dSMatthew Knepley }
1389adb62b0dSMatthew Knepley 
1390adb62b0dSMatthew Knepley #undef __FUNCT__
13914a2ae208SSatish Balay #define __FUNCT__ "TSSetDuration"
1392d763cef2SBarry Smith /*@
1393d763cef2SBarry Smith    TSSetDuration - Sets the maximum number of timesteps to use and
1394d763cef2SBarry Smith    maximum time for iteration.
1395d763cef2SBarry Smith 
13963f9fe445SBarry Smith    Logically Collective on TS
1397d763cef2SBarry Smith 
1398d763cef2SBarry Smith    Input Parameters:
1399d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1400d763cef2SBarry Smith .  maxsteps - maximum number of iterations to use
1401d763cef2SBarry Smith -  maxtime - final time to iterate to
1402d763cef2SBarry Smith 
1403d763cef2SBarry Smith    Options Database Keys:
1404d763cef2SBarry Smith .  -ts_max_steps <maxsteps> - Sets maxsteps
1405d763cef2SBarry Smith .  -ts_max_time <maxtime> - Sets maxtime
1406d763cef2SBarry Smith 
1407d763cef2SBarry Smith    Notes:
1408d763cef2SBarry Smith    The default maximum number of iterations is 5000. Default time is 5.0
1409d763cef2SBarry Smith 
1410d763cef2SBarry Smith    Level: intermediate
1411d763cef2SBarry Smith 
1412d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations
1413a43b19c4SJed Brown 
1414a43b19c4SJed Brown .seealso: TSSetExactFinalTime()
1415d763cef2SBarry Smith @*/
14167087cfbeSBarry Smith PetscErrorCode  TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
1417d763cef2SBarry Smith {
1418d763cef2SBarry Smith   PetscFunctionBegin;
14190700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1420c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
1421c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,maxtime,2);
142239b7ec4bSSean Farley   if (maxsteps >= 0) ts->max_steps = maxsteps;
142339b7ec4bSSean Farley   if (maxtime != PETSC_DEFAULT) ts->max_time  = maxtime;
1424d763cef2SBarry Smith   PetscFunctionReturn(0);
1425d763cef2SBarry Smith }
1426d763cef2SBarry Smith 
14274a2ae208SSatish Balay #undef __FUNCT__
14284a2ae208SSatish Balay #define __FUNCT__ "TSSetSolution"
1429d763cef2SBarry Smith /*@
1430d763cef2SBarry Smith    TSSetSolution - Sets the initial solution vector
1431d763cef2SBarry Smith    for use by the TS routines.
1432d763cef2SBarry Smith 
14333f9fe445SBarry Smith    Logically Collective on TS and Vec
1434d763cef2SBarry Smith 
1435d763cef2SBarry Smith    Input Parameters:
1436d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1437d763cef2SBarry Smith -  x - the solution vector
1438d763cef2SBarry Smith 
1439d763cef2SBarry Smith    Level: beginner
1440d763cef2SBarry Smith 
1441d763cef2SBarry Smith .keywords: TS, timestep, set, solution, initial conditions
1442d763cef2SBarry Smith @*/
14437087cfbeSBarry Smith PetscErrorCode  TSSetSolution(TS ts,Vec x)
1444d763cef2SBarry Smith {
14458737fe31SLisandro Dalcin   PetscErrorCode ierr;
14468737fe31SLisandro Dalcin 
1447d763cef2SBarry Smith   PetscFunctionBegin;
14480700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
14490700a824SBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
14508737fe31SLisandro Dalcin   ierr = PetscObjectReference((PetscObject)x);CHKERRQ(ierr);
14516bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
14528737fe31SLisandro Dalcin   ts->vec_sol = x;
1453d763cef2SBarry Smith   PetscFunctionReturn(0);
1454d763cef2SBarry Smith }
1455d763cef2SBarry Smith 
1456e74ef692SMatthew Knepley #undef __FUNCT__
1457e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPreStep"
1458ac226902SBarry Smith /*@C
1459000e7ae3SMatthew Knepley   TSSetPreStep - Sets the general-purpose function
14603f2090d5SJed Brown   called once at the beginning of each time step.
1461000e7ae3SMatthew Knepley 
14623f9fe445SBarry Smith   Logically Collective on TS
1463000e7ae3SMatthew Knepley 
1464000e7ae3SMatthew Knepley   Input Parameters:
1465000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
1466000e7ae3SMatthew Knepley - func - The function
1467000e7ae3SMatthew Knepley 
1468000e7ae3SMatthew Knepley   Calling sequence of func:
1469000e7ae3SMatthew Knepley . func (TS ts);
1470000e7ae3SMatthew Knepley 
1471000e7ae3SMatthew Knepley   Level: intermediate
1472000e7ae3SMatthew Knepley 
1473000e7ae3SMatthew Knepley .keywords: TS, timestep
1474000e7ae3SMatthew Knepley @*/
14757087cfbeSBarry Smith PetscErrorCode  TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
1476000e7ae3SMatthew Knepley {
1477000e7ae3SMatthew Knepley   PetscFunctionBegin;
14780700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1479000e7ae3SMatthew Knepley   ts->ops->prestep = func;
1480000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
1481000e7ae3SMatthew Knepley }
1482000e7ae3SMatthew Knepley 
1483e74ef692SMatthew Knepley #undef __FUNCT__
14843f2090d5SJed Brown #define __FUNCT__ "TSPreStep"
14853f2090d5SJed Brown /*@C
14863f2090d5SJed Brown   TSPreStep - Runs the user-defined pre-step function.
14873f2090d5SJed Brown 
14883f2090d5SJed Brown   Collective on TS
14893f2090d5SJed Brown 
14903f2090d5SJed Brown   Input Parameters:
14913f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
14923f2090d5SJed Brown 
14933f2090d5SJed Brown   Notes:
14943f2090d5SJed Brown   TSPreStep() is typically used within time stepping implementations,
14953f2090d5SJed Brown   so most users would not generally call this routine themselves.
14963f2090d5SJed Brown 
14973f2090d5SJed Brown   Level: developer
14983f2090d5SJed Brown 
14993f2090d5SJed Brown .keywords: TS, timestep
15003f2090d5SJed Brown @*/
15017087cfbeSBarry Smith PetscErrorCode  TSPreStep(TS ts)
15023f2090d5SJed Brown {
15033f2090d5SJed Brown   PetscErrorCode ierr;
15043f2090d5SJed Brown 
15053f2090d5SJed Brown   PetscFunctionBegin;
15060700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
150772ac3e02SJed Brown   if (ts->ops->prestep) {
15083f2090d5SJed Brown     PetscStackPush("TS PreStep function");
15093f2090d5SJed Brown     ierr = (*ts->ops->prestep)(ts);CHKERRQ(ierr);
15103f2090d5SJed Brown     PetscStackPop;
1511312ce896SJed Brown   }
15123f2090d5SJed Brown   PetscFunctionReturn(0);
15133f2090d5SJed Brown }
15143f2090d5SJed Brown 
15153f2090d5SJed Brown #undef __FUNCT__
1516e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPostStep"
1517ac226902SBarry Smith /*@C
1518000e7ae3SMatthew Knepley   TSSetPostStep - Sets the general-purpose function
15193f2090d5SJed Brown   called once at the end of each time step.
1520000e7ae3SMatthew Knepley 
15213f9fe445SBarry Smith   Logically Collective on TS
1522000e7ae3SMatthew Knepley 
1523000e7ae3SMatthew Knepley   Input Parameters:
1524000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
1525000e7ae3SMatthew Knepley - func - The function
1526000e7ae3SMatthew Knepley 
1527000e7ae3SMatthew Knepley   Calling sequence of func:
1528000e7ae3SMatthew Knepley . func (TS ts);
1529000e7ae3SMatthew Knepley 
1530000e7ae3SMatthew Knepley   Level: intermediate
1531000e7ae3SMatthew Knepley 
1532000e7ae3SMatthew Knepley .keywords: TS, timestep
1533000e7ae3SMatthew Knepley @*/
15347087cfbeSBarry Smith PetscErrorCode  TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
1535000e7ae3SMatthew Knepley {
1536000e7ae3SMatthew Knepley   PetscFunctionBegin;
15370700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1538000e7ae3SMatthew Knepley   ts->ops->poststep = func;
1539000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
1540000e7ae3SMatthew Knepley }
1541000e7ae3SMatthew Knepley 
1542e74ef692SMatthew Knepley #undef __FUNCT__
15433f2090d5SJed Brown #define __FUNCT__ "TSPostStep"
15443f2090d5SJed Brown /*@C
15453f2090d5SJed Brown   TSPostStep - Runs the user-defined post-step function.
15463f2090d5SJed Brown 
15473f2090d5SJed Brown   Collective on TS
15483f2090d5SJed Brown 
15493f2090d5SJed Brown   Input Parameters:
15503f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
15513f2090d5SJed Brown 
15523f2090d5SJed Brown   Notes:
15533f2090d5SJed Brown   TSPostStep() is typically used within time stepping implementations,
15543f2090d5SJed Brown   so most users would not generally call this routine themselves.
15553f2090d5SJed Brown 
15563f2090d5SJed Brown   Level: developer
15573f2090d5SJed Brown 
15583f2090d5SJed Brown .keywords: TS, timestep
15593f2090d5SJed Brown @*/
15607087cfbeSBarry Smith PetscErrorCode  TSPostStep(TS ts)
15613f2090d5SJed Brown {
15623f2090d5SJed Brown   PetscErrorCode ierr;
15633f2090d5SJed Brown 
15643f2090d5SJed Brown   PetscFunctionBegin;
15650700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
156672ac3e02SJed Brown   if (ts->ops->poststep) {
15673f2090d5SJed Brown     PetscStackPush("TS PostStep function");
15683f2090d5SJed Brown     ierr = (*ts->ops->poststep)(ts);CHKERRQ(ierr);
15693f2090d5SJed Brown     PetscStackPop;
157072ac3e02SJed Brown   }
15713f2090d5SJed Brown   PetscFunctionReturn(0);
15723f2090d5SJed Brown }
15733f2090d5SJed Brown 
1574d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
1575d763cef2SBarry Smith 
15764a2ae208SSatish Balay #undef __FUNCT__
1577a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSet"
1578d763cef2SBarry Smith /*@C
1579a6570f20SBarry Smith    TSMonitorSet - Sets an ADDITIONAL function that is to be used at every
1580d763cef2SBarry Smith    timestep to display the iteration's  progress.
1581d763cef2SBarry Smith 
15823f9fe445SBarry Smith    Logically Collective on TS
1583d763cef2SBarry Smith 
1584d763cef2SBarry Smith    Input Parameters:
1585d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1586e213d8f1SJed Brown .  monitor - monitoring routine
1587329f5518SBarry Smith .  mctx - [optional] user-defined context for private data for the
1588b3006f0bSLois Curfman McInnes              monitor routine (use PETSC_NULL if no context is desired)
1589b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
1590b3006f0bSLois Curfman McInnes           (may be PETSC_NULL)
1591d763cef2SBarry Smith 
1592e213d8f1SJed Brown    Calling sequence of monitor:
1593e213d8f1SJed Brown $    int monitor(TS ts,PetscInt steps,PetscReal time,Vec x,void *mctx)
1594d763cef2SBarry Smith 
1595d763cef2SBarry Smith +    ts - the TS context
1596d763cef2SBarry Smith .    steps - iteration number
15971f06c33eSBarry Smith .    time - current time
1598d763cef2SBarry Smith .    x - current iterate
1599d763cef2SBarry Smith -    mctx - [optional] monitoring context
1600d763cef2SBarry Smith 
1601d763cef2SBarry Smith    Notes:
1602d763cef2SBarry Smith    This routine adds an additional monitor to the list of monitors that
1603d763cef2SBarry Smith    already has been loaded.
1604d763cef2SBarry Smith 
1605025f1a04SBarry Smith    Fortran notes: Only a single monitor function can be set for each TS object
1606025f1a04SBarry Smith 
1607d763cef2SBarry Smith    Level: intermediate
1608d763cef2SBarry Smith 
1609d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
1610d763cef2SBarry Smith 
1611a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel()
1612d763cef2SBarry Smith @*/
1613c2efdce3SBarry Smith PetscErrorCode  TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**))
1614d763cef2SBarry Smith {
1615d763cef2SBarry Smith   PetscFunctionBegin;
16160700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
161717186662SBarry Smith   if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
1618d763cef2SBarry Smith   ts->monitor[ts->numbermonitors]           = monitor;
1619329f5518SBarry Smith   ts->mdestroy[ts->numbermonitors]          = mdestroy;
1620d763cef2SBarry Smith   ts->monitorcontext[ts->numbermonitors++]  = (void*)mctx;
1621d763cef2SBarry Smith   PetscFunctionReturn(0);
1622d763cef2SBarry Smith }
1623d763cef2SBarry Smith 
16244a2ae208SSatish Balay #undef __FUNCT__
1625a6570f20SBarry Smith #define __FUNCT__ "TSMonitorCancel"
1626d763cef2SBarry Smith /*@C
1627a6570f20SBarry Smith    TSMonitorCancel - Clears all the monitors that have been set on a time-step object.
1628d763cef2SBarry Smith 
16293f9fe445SBarry Smith    Logically Collective on TS
1630d763cef2SBarry Smith 
1631d763cef2SBarry Smith    Input Parameters:
1632d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1633d763cef2SBarry Smith 
1634d763cef2SBarry Smith    Notes:
1635d763cef2SBarry Smith    There is no way to remove a single, specific monitor.
1636d763cef2SBarry Smith 
1637d763cef2SBarry Smith    Level: intermediate
1638d763cef2SBarry Smith 
1639d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
1640d763cef2SBarry Smith 
1641a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet()
1642d763cef2SBarry Smith @*/
16437087cfbeSBarry Smith PetscErrorCode  TSMonitorCancel(TS ts)
1644d763cef2SBarry Smith {
1645d952e501SBarry Smith   PetscErrorCode ierr;
1646d952e501SBarry Smith   PetscInt       i;
1647d952e501SBarry Smith 
1648d763cef2SBarry Smith   PetscFunctionBegin;
16490700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1650d952e501SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
1651d952e501SBarry Smith     if (ts->mdestroy[i]) {
16523c4aec1bSBarry Smith       ierr = (*ts->mdestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr);
1653d952e501SBarry Smith     }
1654d952e501SBarry Smith   }
1655d763cef2SBarry Smith   ts->numbermonitors = 0;
1656d763cef2SBarry Smith   PetscFunctionReturn(0);
1657d763cef2SBarry Smith }
1658d763cef2SBarry Smith 
16594a2ae208SSatish Balay #undef __FUNCT__
1660a6570f20SBarry Smith #define __FUNCT__ "TSMonitorDefault"
1661d8e5e3e6SSatish Balay /*@
1662a6570f20SBarry Smith    TSMonitorDefault - Sets the Default monitor
16635516499fSSatish Balay 
16645516499fSSatish Balay    Level: intermediate
166541251cbbSSatish Balay 
16665516499fSSatish Balay .keywords: TS, set, monitor
16675516499fSSatish Balay 
166841251cbbSSatish Balay .seealso: TSMonitorDefault(), TSMonitorSet()
166941251cbbSSatish Balay @*/
1670649052a6SBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,void *dummy)
1671d763cef2SBarry Smith {
1672dfbe8321SBarry Smith   PetscErrorCode ierr;
1673649052a6SBarry Smith   PetscViewer    viewer = dummy ? (PetscViewer) dummy : PETSC_VIEWER_STDOUT_(((PetscObject)ts)->comm);
1674d132466eSBarry Smith 
1675d763cef2SBarry Smith   PetscFunctionBegin;
1676649052a6SBarry Smith   ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
1677649052a6SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %G time %G\n",step,ts->time_step,ptime);CHKERRQ(ierr);
1678649052a6SBarry Smith   ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
1679d763cef2SBarry Smith   PetscFunctionReturn(0);
1680d763cef2SBarry Smith }
1681d763cef2SBarry Smith 
16824a2ae208SSatish Balay #undef __FUNCT__
1683cd652676SJed Brown #define __FUNCT__ "TSSetRetainStages"
1684cd652676SJed Brown /*@
1685cd652676SJed Brown    TSSetRetainStages - Request that all stages in the upcoming step be stored so that interpolation will be available.
1686cd652676SJed Brown 
1687cd652676SJed Brown    Logically Collective on TS
1688cd652676SJed Brown 
1689cd652676SJed Brown    Input Argument:
1690cd652676SJed Brown .  ts - time stepping context
1691cd652676SJed Brown 
1692cd652676SJed Brown    Output Argument:
1693cd652676SJed Brown .  flg - PETSC_TRUE or PETSC_FALSE
1694cd652676SJed Brown 
1695cd652676SJed Brown    Level: intermediate
1696cd652676SJed Brown 
1697cd652676SJed Brown .keywords: TS, set
1698cd652676SJed Brown 
1699cd652676SJed Brown .seealso: TSInterpolate(), TSSetPostStep()
1700cd652676SJed Brown @*/
1701cd652676SJed Brown PetscErrorCode TSSetRetainStages(TS ts,PetscBool flg)
1702cd652676SJed Brown {
1703cd652676SJed Brown 
1704cd652676SJed Brown   PetscFunctionBegin;
1705cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1706cd652676SJed Brown   ts->retain_stages = flg;
1707cd652676SJed Brown   PetscFunctionReturn(0);
1708cd652676SJed Brown }
1709cd652676SJed Brown 
1710cd652676SJed Brown #undef __FUNCT__
1711cd652676SJed Brown #define __FUNCT__ "TSInterpolate"
1712cd652676SJed Brown /*@
1713cd652676SJed Brown    TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
1714cd652676SJed Brown 
1715cd652676SJed Brown    Collective on TS
1716cd652676SJed Brown 
1717cd652676SJed Brown    Input Argument:
1718cd652676SJed Brown +  ts - time stepping context
1719cd652676SJed Brown -  t - time to interpolate to
1720cd652676SJed Brown 
1721cd652676SJed Brown    Output Argument:
1722cd652676SJed Brown .  X - state at given time
1723cd652676SJed Brown 
1724cd652676SJed Brown    Notes:
1725cd652676SJed Brown    The user should call TSSetRetainStages() before taking a step in which interpolation will be requested.
1726cd652676SJed Brown 
1727cd652676SJed Brown    Level: intermediate
1728cd652676SJed Brown 
1729cd652676SJed Brown    Developer Notes:
1730cd652676SJed Brown    TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
1731cd652676SJed Brown 
1732cd652676SJed Brown .keywords: TS, set
1733cd652676SJed Brown 
1734cd652676SJed Brown .seealso: TSSetRetainStages(), TSSetPostStep()
1735cd652676SJed Brown @*/
1736cd652676SJed Brown PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec X)
1737cd652676SJed Brown {
1738cd652676SJed Brown   PetscErrorCode ierr;
1739cd652676SJed Brown 
1740cd652676SJed Brown   PetscFunctionBegin;
1741cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1742cdbf8f93SLisandro Dalcin   if (t < ts->ptime - ts->time_step_prev || t > ts->ptime) SETERRQ3(((PetscObject)ts)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Requested time %G not in last time steps [%G,%G]",t,ts->ptime-ts->time_step_prev,ts->ptime);
1743cd652676SJed Brown   if (!ts->ops->interpolate) SETERRQ1(((PetscObject)ts)->comm,PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
1744cd652676SJed Brown   ierr = (*ts->ops->interpolate)(ts,t,X);CHKERRQ(ierr);
1745cd652676SJed Brown   PetscFunctionReturn(0);
1746cd652676SJed Brown }
1747cd652676SJed Brown 
1748cd652676SJed Brown #undef __FUNCT__
17494a2ae208SSatish Balay #define __FUNCT__ "TSStep"
1750d763cef2SBarry Smith /*@
17516d9e5789SSean Farley    TSStep - Steps one time step
1752d763cef2SBarry Smith 
1753d763cef2SBarry Smith    Collective on TS
1754d763cef2SBarry Smith 
1755d763cef2SBarry Smith    Input Parameter:
1756d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1757d763cef2SBarry Smith 
17586d9e5789SSean Farley    Level: intermediate
1759d763cef2SBarry Smith 
1760d763cef2SBarry Smith .keywords: TS, timestep, solve
1761d763cef2SBarry Smith 
17626d9e5789SSean Farley .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve()
1763d763cef2SBarry Smith @*/
1764193ac0bcSJed Brown PetscErrorCode  TSStep(TS ts)
1765d763cef2SBarry Smith {
1766*362cd11cSLisandro Dalcin   PetscReal      ptime_prev;
1767dfbe8321SBarry Smith   PetscErrorCode ierr;
1768d763cef2SBarry Smith 
1769d763cef2SBarry Smith   PetscFunctionBegin;
17700700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1771d405a339SMatthew Knepley   ierr = TSSetUp(ts);CHKERRQ(ierr);
1772d405a339SMatthew Knepley 
1773*362cd11cSLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
1774*362cd11cSLisandro Dalcin 
1775*362cd11cSLisandro Dalcin   ptime_prev = ts->ptime;
1776d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
1777193ac0bcSJed Brown   ierr = (*ts->ops->step)(ts);CHKERRQ(ierr);
1778d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
1779*362cd11cSLisandro Dalcin   ts->time_step_prev = ts->ptime - ptime_prev;
1780*362cd11cSLisandro Dalcin 
1781*362cd11cSLisandro Dalcin   if (ts->reason < 0) {
1782*362cd11cSLisandro Dalcin     if (ts->errorifstepfailed) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_NOT_CONVERGED,"TSStep has failed");
1783*362cd11cSLisandro Dalcin   } else if (!ts->reason) {
1784*362cd11cSLisandro Dalcin     if (ts->steps >= ts->max_steps)
1785*362cd11cSLisandro Dalcin       ts->reason = TS_CONVERGED_ITS;
1786*362cd11cSLisandro Dalcin     else if (ts->ptime >= ts->max_time)
1787*362cd11cSLisandro Dalcin       ts->reason = TS_CONVERGED_TIME;
1788*362cd11cSLisandro Dalcin   }
1789*362cd11cSLisandro Dalcin 
1790d763cef2SBarry Smith   PetscFunctionReturn(0);
1791d763cef2SBarry Smith }
1792d763cef2SBarry Smith 
17934a2ae208SSatish Balay #undef __FUNCT__
17946a4d4014SLisandro Dalcin #define __FUNCT__ "TSSolve"
17956a4d4014SLisandro Dalcin /*@
17966a4d4014SLisandro Dalcin    TSSolve - Steps the requested number of timesteps.
17976a4d4014SLisandro Dalcin 
17986a4d4014SLisandro Dalcin    Collective on TS
17996a4d4014SLisandro Dalcin 
18006a4d4014SLisandro Dalcin    Input Parameter:
18016a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
1802*362cd11cSLisandro Dalcin -  x - the solution vector
18036a4d4014SLisandro Dalcin 
18045a3a76d0SJed Brown    Output Parameter:
18055a3a76d0SJed Brown .  ftime - time of the state vector x upon completion
18065a3a76d0SJed Brown 
18076a4d4014SLisandro Dalcin    Level: beginner
18086a4d4014SLisandro Dalcin 
18095a3a76d0SJed Brown    Notes:
18105a3a76d0SJed Brown    The final time returned by this function may be different from the time of the internally
18115a3a76d0SJed Brown    held state accessible by TSGetSolution() and TSGetTime() because the method may have
18125a3a76d0SJed Brown    stepped over the final time.
18135a3a76d0SJed Brown 
18146a4d4014SLisandro Dalcin .keywords: TS, timestep, solve
18156a4d4014SLisandro Dalcin 
18166a4d4014SLisandro Dalcin .seealso: TSCreate(), TSSetSolution(), TSStep()
18176a4d4014SLisandro Dalcin @*/
18185a3a76d0SJed Brown PetscErrorCode TSSolve(TS ts,Vec x,PetscReal *ftime)
18196a4d4014SLisandro Dalcin {
18204d7d938eSLisandro Dalcin   PetscBool      flg;
18214d7d938eSLisandro Dalcin   char           filename[PETSC_MAX_PATH_LEN];
18224d7d938eSLisandro Dalcin   PetscViewer    viewer;
18236a4d4014SLisandro Dalcin   PetscErrorCode ierr;
1824f22f69f0SBarry Smith 
18256a4d4014SLisandro Dalcin   PetscFunctionBegin;
18260700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1827193ac0bcSJed Brown   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
18285a3a76d0SJed Brown   if (ts->exact_final_time) {   /* Need ts->vec_sol to be distinct so it is not overwritten when we interpolate at the end */
18295a3a76d0SJed Brown     if (!ts->vec_sol || x == ts->vec_sol) {
18305a3a76d0SJed Brown       Vec y;
18315a3a76d0SJed Brown       ierr = VecDuplicate(x,&y);CHKERRQ(ierr);
18325a3a76d0SJed Brown       ierr = TSSetSolution(ts,y);CHKERRQ(ierr);
18335a3a76d0SJed Brown       ierr = VecDestroy(&y);CHKERRQ(ierr); /* grant ownership */
18345a3a76d0SJed Brown     }
1835*362cd11cSLisandro Dalcin     ierr = VecCopy(x,ts->vec_sol);CHKERRQ(ierr);
18365a3a76d0SJed Brown   } else {
1837193ac0bcSJed Brown     ierr = TSSetSolution(ts,x);CHKERRQ(ierr);
18385a3a76d0SJed Brown   }
1839b5d403baSSean Farley   ierr = TSSetUp(ts);CHKERRQ(ierr);
18406a4d4014SLisandro Dalcin   /* reset time step and iteration counters */
1841193ac0bcSJed Brown   ts->steps = 0;
1842193ac0bcSJed Brown   ts->linear_its = 0;
1843193ac0bcSJed Brown   ts->nonlinear_its = 0;
1844c610991cSLisandro Dalcin   ts->num_snes_failures = 0;
1845c610991cSLisandro Dalcin   ts->reject = 0;
1846193ac0bcSJed Brown   ts->reason = TS_CONVERGED_ITERATING;
1847193ac0bcSJed Brown 
1848193ac0bcSJed Brown   if (ts->ops->solve) {         /* This private interface is transitional and should be removed when all implementations are updated. */
1849193ac0bcSJed Brown     ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr);
18505a3a76d0SJed Brown     ierr = VecCopy(ts->vec_sol,x);CHKERRQ(ierr);
1851a5b82c69SSean Farley     if (ftime) *ftime = ts->ptime;
1852193ac0bcSJed Brown   } else {
18536a4d4014SLisandro Dalcin     /* steps the requested number of timesteps. */
1854*362cd11cSLisandro Dalcin     ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
1855*362cd11cSLisandro Dalcin     if (ts->steps >= ts->max_steps)
1856*362cd11cSLisandro Dalcin       ts->reason = TS_CONVERGED_ITS;
1857*362cd11cSLisandro Dalcin     else if (ts->ptime >= ts->max_time)
1858*362cd11cSLisandro Dalcin       ts->reason = TS_CONVERGED_TIME;
1859e1a7a14fSJed Brown     while (!ts->reason) {
1860193ac0bcSJed Brown       ierr = TSPreStep(ts);CHKERRQ(ierr);
1861193ac0bcSJed Brown       ierr = TSStep(ts);CHKERRQ(ierr);
1862193ac0bcSJed Brown       ierr = TSPostStep(ts);CHKERRQ(ierr);
1863193ac0bcSJed Brown       ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
1864193ac0bcSJed Brown     }
1865*362cd11cSLisandro Dalcin     if (ts->exact_final_time && ts->ptime > ts->max_time) {
1866a43b19c4SJed Brown       ierr = TSInterpolate(ts,ts->max_time,x);CHKERRQ(ierr);
18675a3a76d0SJed Brown       if (ftime) *ftime = ts->max_time;
18680574a7fbSJed Brown     } else {
18690574a7fbSJed Brown       ierr = VecCopy(ts->vec_sol,x);CHKERRQ(ierr);
18700574a7fbSJed Brown       if (ftime) *ftime = ts->ptime;
18710574a7fbSJed Brown     }
1872193ac0bcSJed Brown   }
18734d7d938eSLisandro Dalcin   ierr = PetscOptionsGetString(((PetscObject)ts)->prefix,"-ts_view",filename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
18744d7d938eSLisandro Dalcin   if (flg && !PetscPreLoadingOn) {
18754d7d938eSLisandro Dalcin     ierr = PetscViewerASCIIOpen(((PetscObject)ts)->comm,filename,&viewer);CHKERRQ(ierr);
18764d7d938eSLisandro Dalcin     ierr = TSView(ts,viewer);CHKERRQ(ierr);
18774d7d938eSLisandro Dalcin     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1878193ac0bcSJed Brown   }
18796a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
18806a4d4014SLisandro Dalcin }
18816a4d4014SLisandro Dalcin 
18826a4d4014SLisandro Dalcin #undef __FUNCT__
18834a2ae208SSatish Balay #define __FUNCT__ "TSMonitor"
1884d763cef2SBarry Smith /*
1885d763cef2SBarry Smith      Runs the user provided monitor routines, if they exists.
1886d763cef2SBarry Smith */
1887a7cc72afSBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec x)
1888d763cef2SBarry Smith {
18896849ba73SBarry Smith   PetscErrorCode ierr;
1890a7cc72afSBarry Smith   PetscInt       i,n = ts->numbermonitors;
1891d763cef2SBarry Smith 
1892d763cef2SBarry Smith   PetscFunctionBegin;
1893d763cef2SBarry Smith   for (i=0; i<n; i++) {
1894142b95e3SSatish Balay     ierr = (*ts->monitor[i])(ts,step,ptime,x,ts->monitorcontext[i]);CHKERRQ(ierr);
1895d763cef2SBarry Smith   }
1896d763cef2SBarry Smith   PetscFunctionReturn(0);
1897d763cef2SBarry Smith }
1898d763cef2SBarry Smith 
1899d763cef2SBarry Smith /* ------------------------------------------------------------------------*/
1900d763cef2SBarry Smith 
19014a2ae208SSatish Balay #undef __FUNCT__
1902a6570f20SBarry Smith #define __FUNCT__ "TSMonitorLGCreate"
1903d763cef2SBarry Smith /*@C
1904a6570f20SBarry Smith    TSMonitorLGCreate - Creates a line graph context for use with
1905d763cef2SBarry Smith    TS to monitor convergence of preconditioned residual norms.
1906d763cef2SBarry Smith 
1907d763cef2SBarry Smith    Collective on TS
1908d763cef2SBarry Smith 
1909d763cef2SBarry Smith    Input Parameters:
1910d763cef2SBarry Smith +  host - the X display to open, or null for the local machine
1911d763cef2SBarry Smith .  label - the title to put in the title bar
19127c922b88SBarry Smith .  x, y - the screen coordinates of the upper left coordinate of the window
1913d763cef2SBarry Smith -  m, n - the screen width and height in pixels
1914d763cef2SBarry Smith 
1915d763cef2SBarry Smith    Output Parameter:
1916d763cef2SBarry Smith .  draw - the drawing context
1917d763cef2SBarry Smith 
1918d763cef2SBarry Smith    Options Database Key:
1919a6570f20SBarry Smith .  -ts_monitor_draw - automatically sets line graph monitor
1920d763cef2SBarry Smith 
1921d763cef2SBarry Smith    Notes:
1922a6570f20SBarry Smith    Use TSMonitorLGDestroy() to destroy this line graph, not PetscDrawLGDestroy().
1923d763cef2SBarry Smith 
1924d763cef2SBarry Smith    Level: intermediate
1925d763cef2SBarry Smith 
19267c922b88SBarry Smith .keywords: TS, monitor, line graph, residual, seealso
1927d763cef2SBarry Smith 
1928a6570f20SBarry Smith .seealso: TSMonitorLGDestroy(), TSMonitorSet()
19297c922b88SBarry Smith 
1930d763cef2SBarry Smith @*/
19317087cfbeSBarry Smith PetscErrorCode  TSMonitorLGCreate(const char host[],const char label[],int x,int y,int m,int n,PetscDrawLG *draw)
1932d763cef2SBarry Smith {
1933b0a32e0cSBarry Smith   PetscDraw      win;
1934dfbe8321SBarry Smith   PetscErrorCode ierr;
1935d763cef2SBarry Smith 
1936d763cef2SBarry Smith   PetscFunctionBegin;
1937b0a32e0cSBarry Smith   ierr = PetscDrawCreate(PETSC_COMM_SELF,host,label,x,y,m,n,&win);CHKERRQ(ierr);
1938b0a32e0cSBarry Smith   ierr = PetscDrawSetType(win,PETSC_DRAW_X);CHKERRQ(ierr);
1939b0a32e0cSBarry Smith   ierr = PetscDrawLGCreate(win,1,draw);CHKERRQ(ierr);
1940b0a32e0cSBarry Smith   ierr = PetscDrawLGIndicateDataPoints(*draw);CHKERRQ(ierr);
1941d763cef2SBarry Smith 
194252e6d16bSBarry Smith   ierr = PetscLogObjectParent(*draw,win);CHKERRQ(ierr);
1943d763cef2SBarry Smith   PetscFunctionReturn(0);
1944d763cef2SBarry Smith }
1945d763cef2SBarry Smith 
19464a2ae208SSatish Balay #undef __FUNCT__
1947a6570f20SBarry Smith #define __FUNCT__ "TSMonitorLG"
1948a6570f20SBarry Smith PetscErrorCode TSMonitorLG(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
1949d763cef2SBarry Smith {
1950b0a32e0cSBarry Smith   PetscDrawLG    lg = (PetscDrawLG) monctx;
195187828ca2SBarry Smith   PetscReal      x,y = ptime;
1952dfbe8321SBarry Smith   PetscErrorCode ierr;
1953d763cef2SBarry Smith 
1954d763cef2SBarry Smith   PetscFunctionBegin;
19557c922b88SBarry Smith   if (!monctx) {
19567c922b88SBarry Smith     MPI_Comm    comm;
1957b0a32e0cSBarry Smith     PetscViewer viewer;
19587c922b88SBarry Smith 
19597c922b88SBarry Smith     ierr   = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
1960b0a32e0cSBarry Smith     viewer = PETSC_VIEWER_DRAW_(comm);
1961b0a32e0cSBarry Smith     ierr   = PetscViewerDrawGetDrawLG(viewer,0,&lg);CHKERRQ(ierr);
19627c922b88SBarry Smith   }
19637c922b88SBarry Smith 
1964b0a32e0cSBarry Smith   if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);}
196587828ca2SBarry Smith   x = (PetscReal)n;
1966b0a32e0cSBarry Smith   ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr);
1967d763cef2SBarry Smith   if (n < 20 || (n % 5)) {
1968b0a32e0cSBarry Smith     ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr);
1969d763cef2SBarry Smith   }
1970d763cef2SBarry Smith   PetscFunctionReturn(0);
1971d763cef2SBarry Smith }
1972d763cef2SBarry Smith 
19734a2ae208SSatish Balay #undef __FUNCT__
1974a6570f20SBarry Smith #define __FUNCT__ "TSMonitorLGDestroy"
1975d763cef2SBarry Smith /*@C
1976a6570f20SBarry Smith    TSMonitorLGDestroy - Destroys a line graph context that was created
1977a6570f20SBarry Smith    with TSMonitorLGCreate().
1978d763cef2SBarry Smith 
1979b0a32e0cSBarry Smith    Collective on PetscDrawLG
1980d763cef2SBarry Smith 
1981d763cef2SBarry Smith    Input Parameter:
1982d763cef2SBarry Smith .  draw - the drawing context
1983d763cef2SBarry Smith 
1984d763cef2SBarry Smith    Level: intermediate
1985d763cef2SBarry Smith 
1986d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy
1987d763cef2SBarry Smith 
1988a6570f20SBarry Smith .seealso: TSMonitorLGCreate(),  TSMonitorSet(), TSMonitorLG();
1989d763cef2SBarry Smith @*/
19906bf464f9SBarry Smith PetscErrorCode  TSMonitorLGDestroy(PetscDrawLG *drawlg)
1991d763cef2SBarry Smith {
1992b0a32e0cSBarry Smith   PetscDraw      draw;
1993dfbe8321SBarry Smith   PetscErrorCode ierr;
1994d763cef2SBarry Smith 
1995d763cef2SBarry Smith   PetscFunctionBegin;
19966bf464f9SBarry Smith   ierr = PetscDrawLGGetDraw(*drawlg,&draw);CHKERRQ(ierr);
19976bf464f9SBarry Smith   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
1998b0a32e0cSBarry Smith   ierr = PetscDrawLGDestroy(drawlg);CHKERRQ(ierr);
1999d763cef2SBarry Smith   PetscFunctionReturn(0);
2000d763cef2SBarry Smith }
2001d763cef2SBarry Smith 
20024a2ae208SSatish Balay #undef __FUNCT__
20034a2ae208SSatish Balay #define __FUNCT__ "TSGetTime"
2004d763cef2SBarry Smith /*@
2005d763cef2SBarry Smith    TSGetTime - Gets the current time.
2006d763cef2SBarry Smith 
2007d763cef2SBarry Smith    Not Collective
2008d763cef2SBarry Smith 
2009d763cef2SBarry Smith    Input Parameter:
2010d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2011d763cef2SBarry Smith 
2012d763cef2SBarry Smith    Output Parameter:
2013d763cef2SBarry Smith .  t  - the current time
2014d763cef2SBarry Smith 
2015d763cef2SBarry Smith    Level: beginner
2016d763cef2SBarry Smith 
2017d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
2018d763cef2SBarry Smith 
2019d763cef2SBarry Smith .keywords: TS, get, time
2020d763cef2SBarry Smith @*/
20217087cfbeSBarry Smith PetscErrorCode  TSGetTime(TS ts,PetscReal* t)
2022d763cef2SBarry Smith {
2023d763cef2SBarry Smith   PetscFunctionBegin;
20240700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
20254482741eSBarry Smith   PetscValidDoublePointer(t,2);
2026d763cef2SBarry Smith   *t = ts->ptime;
2027d763cef2SBarry Smith   PetscFunctionReturn(0);
2028d763cef2SBarry Smith }
2029d763cef2SBarry Smith 
20304a2ae208SSatish Balay #undef __FUNCT__
20316a4d4014SLisandro Dalcin #define __FUNCT__ "TSSetTime"
20326a4d4014SLisandro Dalcin /*@
20336a4d4014SLisandro Dalcin    TSSetTime - Allows one to reset the time.
20346a4d4014SLisandro Dalcin 
20353f9fe445SBarry Smith    Logically Collective on TS
20366a4d4014SLisandro Dalcin 
20376a4d4014SLisandro Dalcin    Input Parameters:
20386a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
20396a4d4014SLisandro Dalcin -  time - the time
20406a4d4014SLisandro Dalcin 
20416a4d4014SLisandro Dalcin    Level: intermediate
20426a4d4014SLisandro Dalcin 
20436a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration()
20446a4d4014SLisandro Dalcin 
20456a4d4014SLisandro Dalcin .keywords: TS, set, time
20466a4d4014SLisandro Dalcin @*/
20477087cfbeSBarry Smith PetscErrorCode  TSSetTime(TS ts, PetscReal t)
20486a4d4014SLisandro Dalcin {
20496a4d4014SLisandro Dalcin   PetscFunctionBegin;
20500700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2051c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,t,2);
20526a4d4014SLisandro Dalcin   ts->ptime = t;
20536a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
20546a4d4014SLisandro Dalcin }
20556a4d4014SLisandro Dalcin 
20566a4d4014SLisandro Dalcin #undef __FUNCT__
20574a2ae208SSatish Balay #define __FUNCT__ "TSSetOptionsPrefix"
2058d763cef2SBarry Smith /*@C
2059d763cef2SBarry Smith    TSSetOptionsPrefix - Sets the prefix used for searching for all
2060d763cef2SBarry Smith    TS options in the database.
2061d763cef2SBarry Smith 
20623f9fe445SBarry Smith    Logically Collective on TS
2063d763cef2SBarry Smith 
2064d763cef2SBarry Smith    Input Parameter:
2065d763cef2SBarry Smith +  ts     - The TS context
2066d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
2067d763cef2SBarry Smith 
2068d763cef2SBarry Smith    Notes:
2069d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
2070d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
2071d763cef2SBarry Smith    hyphen.
2072d763cef2SBarry Smith 
2073d763cef2SBarry Smith    Level: advanced
2074d763cef2SBarry Smith 
2075d763cef2SBarry Smith .keywords: TS, set, options, prefix, database
2076d763cef2SBarry Smith 
2077d763cef2SBarry Smith .seealso: TSSetFromOptions()
2078d763cef2SBarry Smith 
2079d763cef2SBarry Smith @*/
20807087cfbeSBarry Smith PetscErrorCode  TSSetOptionsPrefix(TS ts,const char prefix[])
2081d763cef2SBarry Smith {
2082dfbe8321SBarry Smith   PetscErrorCode ierr;
2083089b2837SJed Brown   SNES           snes;
2084d763cef2SBarry Smith 
2085d763cef2SBarry Smith   PetscFunctionBegin;
20860700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2087d763cef2SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
2088089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2089089b2837SJed Brown   ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr);
2090d763cef2SBarry Smith   PetscFunctionReturn(0);
2091d763cef2SBarry Smith }
2092d763cef2SBarry Smith 
2093d763cef2SBarry Smith 
20944a2ae208SSatish Balay #undef __FUNCT__
20954a2ae208SSatish Balay #define __FUNCT__ "TSAppendOptionsPrefix"
2096d763cef2SBarry Smith /*@C
2097d763cef2SBarry Smith    TSAppendOptionsPrefix - Appends to the prefix used for searching for all
2098d763cef2SBarry Smith    TS options in the database.
2099d763cef2SBarry Smith 
21003f9fe445SBarry Smith    Logically Collective on TS
2101d763cef2SBarry Smith 
2102d763cef2SBarry Smith    Input Parameter:
2103d763cef2SBarry Smith +  ts     - The TS context
2104d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
2105d763cef2SBarry Smith 
2106d763cef2SBarry Smith    Notes:
2107d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
2108d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
2109d763cef2SBarry Smith    hyphen.
2110d763cef2SBarry Smith 
2111d763cef2SBarry Smith    Level: advanced
2112d763cef2SBarry Smith 
2113d763cef2SBarry Smith .keywords: TS, append, options, prefix, database
2114d763cef2SBarry Smith 
2115d763cef2SBarry Smith .seealso: TSGetOptionsPrefix()
2116d763cef2SBarry Smith 
2117d763cef2SBarry Smith @*/
21187087cfbeSBarry Smith PetscErrorCode  TSAppendOptionsPrefix(TS ts,const char prefix[])
2119d763cef2SBarry Smith {
2120dfbe8321SBarry Smith   PetscErrorCode ierr;
2121089b2837SJed Brown   SNES           snes;
2122d763cef2SBarry Smith 
2123d763cef2SBarry Smith   PetscFunctionBegin;
21240700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2125d763cef2SBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
2126089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2127089b2837SJed Brown   ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr);
2128d763cef2SBarry Smith   PetscFunctionReturn(0);
2129d763cef2SBarry Smith }
2130d763cef2SBarry Smith 
21314a2ae208SSatish Balay #undef __FUNCT__
21324a2ae208SSatish Balay #define __FUNCT__ "TSGetOptionsPrefix"
2133d763cef2SBarry Smith /*@C
2134d763cef2SBarry Smith    TSGetOptionsPrefix - Sets the prefix used for searching for all
2135d763cef2SBarry Smith    TS options in the database.
2136d763cef2SBarry Smith 
2137d763cef2SBarry Smith    Not Collective
2138d763cef2SBarry Smith 
2139d763cef2SBarry Smith    Input Parameter:
2140d763cef2SBarry Smith .  ts - The TS context
2141d763cef2SBarry Smith 
2142d763cef2SBarry Smith    Output Parameter:
2143d763cef2SBarry Smith .  prefix - A pointer to the prefix string used
2144d763cef2SBarry Smith 
2145d763cef2SBarry Smith    Notes: On the fortran side, the user should pass in a string 'prifix' of
2146d763cef2SBarry Smith    sufficient length to hold the prefix.
2147d763cef2SBarry Smith 
2148d763cef2SBarry Smith    Level: intermediate
2149d763cef2SBarry Smith 
2150d763cef2SBarry Smith .keywords: TS, get, options, prefix, database
2151d763cef2SBarry Smith 
2152d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix()
2153d763cef2SBarry Smith @*/
21547087cfbeSBarry Smith PetscErrorCode  TSGetOptionsPrefix(TS ts,const char *prefix[])
2155d763cef2SBarry Smith {
2156dfbe8321SBarry Smith   PetscErrorCode ierr;
2157d763cef2SBarry Smith 
2158d763cef2SBarry Smith   PetscFunctionBegin;
21590700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
21604482741eSBarry Smith   PetscValidPointer(prefix,2);
2161d763cef2SBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
2162d763cef2SBarry Smith   PetscFunctionReturn(0);
2163d763cef2SBarry Smith }
2164d763cef2SBarry Smith 
21654a2ae208SSatish Balay #undef __FUNCT__
21664a2ae208SSatish Balay #define __FUNCT__ "TSGetRHSJacobian"
2167d763cef2SBarry Smith /*@C
2168d763cef2SBarry Smith    TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
2169d763cef2SBarry Smith 
2170d763cef2SBarry Smith    Not Collective, but parallel objects are returned if TS is parallel
2171d763cef2SBarry Smith 
2172d763cef2SBarry Smith    Input Parameter:
2173d763cef2SBarry Smith .  ts  - The TS context obtained from TSCreate()
2174d763cef2SBarry Smith 
2175d763cef2SBarry Smith    Output Parameters:
2176d763cef2SBarry Smith +  J   - The Jacobian J of F, where U_t = F(U,t)
2177d763cef2SBarry Smith .  M   - The preconditioner matrix, usually the same as J
2178089b2837SJed Brown .  func - Function to compute the Jacobian of the RHS
2179d763cef2SBarry Smith -  ctx - User-defined context for Jacobian evaluation routine
2180d763cef2SBarry Smith 
2181d763cef2SBarry Smith    Notes: You can pass in PETSC_NULL for any return argument you do not need.
2182d763cef2SBarry Smith 
2183d763cef2SBarry Smith    Level: intermediate
2184d763cef2SBarry Smith 
218526d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
2186d763cef2SBarry Smith 
2187d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian
2188d763cef2SBarry Smith @*/
2189089b2837SJed Brown PetscErrorCode  TSGetRHSJacobian(TS ts,Mat *J,Mat *M,TSRHSJacobian *func,void **ctx)
2190d763cef2SBarry Smith {
2191089b2837SJed Brown   PetscErrorCode ierr;
2192089b2837SJed Brown   SNES           snes;
2193089b2837SJed Brown 
2194d763cef2SBarry Smith   PetscFunctionBegin;
2195089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2196089b2837SJed Brown   ierr = SNESGetJacobian(snes,J,M,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
21973b5f76d0SSean Farley   if (func) *func = ts->userops->rhsjacobian;
219826d46c62SHong Zhang   if (ctx) *ctx = ts->jacP;
2199d763cef2SBarry Smith   PetscFunctionReturn(0);
2200d763cef2SBarry Smith }
2201d763cef2SBarry Smith 
22021713a123SBarry Smith #undef __FUNCT__
22032eca1d9cSJed Brown #define __FUNCT__ "TSGetIJacobian"
22042eca1d9cSJed Brown /*@C
22052eca1d9cSJed Brown    TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
22062eca1d9cSJed Brown 
22072eca1d9cSJed Brown    Not Collective, but parallel objects are returned if TS is parallel
22082eca1d9cSJed Brown 
22092eca1d9cSJed Brown    Input Parameter:
22102eca1d9cSJed Brown .  ts  - The TS context obtained from TSCreate()
22112eca1d9cSJed Brown 
22122eca1d9cSJed Brown    Output Parameters:
22132eca1d9cSJed Brown +  A   - The Jacobian of F(t,U,U_t)
22142eca1d9cSJed Brown .  B   - The preconditioner matrix, often the same as A
22152eca1d9cSJed Brown .  f   - The function to compute the matrices
22162eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine
22172eca1d9cSJed Brown 
22182eca1d9cSJed Brown    Notes: You can pass in PETSC_NULL for any return argument you do not need.
22192eca1d9cSJed Brown 
22202eca1d9cSJed Brown    Level: advanced
22212eca1d9cSJed Brown 
22222eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
22232eca1d9cSJed Brown 
22242eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian
22252eca1d9cSJed Brown @*/
22267087cfbeSBarry Smith PetscErrorCode  TSGetIJacobian(TS ts,Mat *A,Mat *B,TSIJacobian *f,void **ctx)
22272eca1d9cSJed Brown {
2228089b2837SJed Brown   PetscErrorCode ierr;
2229089b2837SJed Brown   SNES           snes;
2230089b2837SJed Brown 
22312eca1d9cSJed Brown   PetscFunctionBegin;
2232089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2233089b2837SJed Brown   ierr = SNESGetJacobian(snes,A,B,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
22343b5f76d0SSean Farley   if (f) *f = ts->userops->ijacobian;
22352eca1d9cSJed Brown   if (ctx) *ctx = ts->jacP;
22362eca1d9cSJed Brown   PetscFunctionReturn(0);
22372eca1d9cSJed Brown }
22382eca1d9cSJed Brown 
22396083293cSBarry Smith typedef struct {
22406083293cSBarry Smith   PetscViewer viewer;
22416083293cSBarry Smith   Vec         initialsolution;
22426083293cSBarry Smith   PetscBool   showinitial;
22436083293cSBarry Smith } TSMonitorSolutionCtx;
22446083293cSBarry Smith 
22452eca1d9cSJed Brown #undef __FUNCT__
2246a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSolution"
22471713a123SBarry Smith /*@C
2248a6570f20SBarry Smith    TSMonitorSolution - Monitors progress of the TS solvers by calling
22491713a123SBarry Smith    VecView() for the solution at each timestep
22501713a123SBarry Smith 
22511713a123SBarry Smith    Collective on TS
22521713a123SBarry Smith 
22531713a123SBarry Smith    Input Parameters:
22541713a123SBarry Smith +  ts - the TS context
22551713a123SBarry Smith .  step - current time-step
2256142b95e3SSatish Balay .  ptime - current time
22571713a123SBarry Smith -  dummy - either a viewer or PETSC_NULL
22581713a123SBarry Smith 
22591713a123SBarry Smith    Level: intermediate
22601713a123SBarry Smith 
22611713a123SBarry Smith .keywords: TS,  vector, monitor, view
22621713a123SBarry Smith 
2263a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
22641713a123SBarry Smith @*/
22657087cfbeSBarry Smith PetscErrorCode  TSMonitorSolution(TS ts,PetscInt step,PetscReal ptime,Vec x,void *dummy)
22661713a123SBarry Smith {
2267dfbe8321SBarry Smith   PetscErrorCode       ierr;
22686083293cSBarry Smith   TSMonitorSolutionCtx *ictx = (TSMonitorSolutionCtx*)dummy;
22691713a123SBarry Smith 
22701713a123SBarry Smith   PetscFunctionBegin;
22716083293cSBarry Smith   if (!step && ictx->showinitial) {
22726083293cSBarry Smith     if (!ictx->initialsolution) {
22736083293cSBarry Smith       ierr = VecDuplicate(x,&ictx->initialsolution);CHKERRQ(ierr);
22741713a123SBarry Smith     }
22756083293cSBarry Smith     ierr = VecCopy(x,ictx->initialsolution);CHKERRQ(ierr);
22766083293cSBarry Smith   }
22776083293cSBarry Smith   if (ictx->showinitial) {
22786083293cSBarry Smith     PetscReal pause;
22796083293cSBarry Smith     ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr);
22806083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr);
22816083293cSBarry Smith     ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr);
22826083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr);
22836083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr);
22846083293cSBarry Smith   }
22856083293cSBarry Smith   ierr = VecView(x,ictx->viewer);CHKERRQ(ierr);
22866083293cSBarry Smith   if (ictx->showinitial) {
22876083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr);
22886083293cSBarry Smith   }
22891713a123SBarry Smith   PetscFunctionReturn(0);
22901713a123SBarry Smith }
22911713a123SBarry Smith 
22921713a123SBarry Smith 
22936c699258SBarry Smith #undef __FUNCT__
22946083293cSBarry Smith #define __FUNCT__ "TSMonitorSolutionDestroy"
22956083293cSBarry Smith /*@C
22966083293cSBarry Smith    TSMonitorSolutionDestroy - Destroys the monitor context for TSMonitorSolution
22976083293cSBarry Smith 
22986083293cSBarry Smith    Collective on TS
22996083293cSBarry Smith 
23006083293cSBarry Smith    Input Parameters:
23016083293cSBarry Smith .    ctx - the monitor context
23026083293cSBarry Smith 
23036083293cSBarry Smith    Level: intermediate
23046083293cSBarry Smith 
23056083293cSBarry Smith .keywords: TS,  vector, monitor, view
23066083293cSBarry Smith 
23076083293cSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorSolution()
23086083293cSBarry Smith @*/
23096083293cSBarry Smith PetscErrorCode  TSMonitorSolutionDestroy(void **ctx)
23106083293cSBarry Smith {
23116083293cSBarry Smith   PetscErrorCode       ierr;
23126083293cSBarry Smith   TSMonitorSolutionCtx *ictx = *(TSMonitorSolutionCtx**)ctx;
23136083293cSBarry Smith 
23146083293cSBarry Smith   PetscFunctionBegin;
23156083293cSBarry Smith   ierr = PetscViewerDestroy(&ictx->viewer);CHKERRQ(ierr);
23166083293cSBarry Smith   ierr = VecDestroy(&ictx->initialsolution);CHKERRQ(ierr);
23176083293cSBarry Smith   ierr = PetscFree(ictx);CHKERRQ(ierr);
23186083293cSBarry Smith   PetscFunctionReturn(0);
23196083293cSBarry Smith }
23206083293cSBarry Smith 
23216083293cSBarry Smith #undef __FUNCT__
23226083293cSBarry Smith #define __FUNCT__ "TSMonitorSolutionCreate"
23236083293cSBarry Smith /*@C
23246083293cSBarry Smith    TSMonitorSolutionCreate - Creates the monitor context for TSMonitorSolution
23256083293cSBarry Smith 
23266083293cSBarry Smith    Collective on TS
23276083293cSBarry Smith 
23286083293cSBarry Smith    Input Parameter:
23296083293cSBarry Smith .    ts - time-step context
23306083293cSBarry Smith 
23316083293cSBarry Smith    Output Patameter:
23326083293cSBarry Smith .    ctx - the monitor context
23336083293cSBarry Smith 
23346083293cSBarry Smith    Level: intermediate
23356083293cSBarry Smith 
23366083293cSBarry Smith .keywords: TS,  vector, monitor, view
23376083293cSBarry Smith 
23386083293cSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorSolution()
23396083293cSBarry Smith @*/
23406083293cSBarry Smith PetscErrorCode  TSMonitorSolutionCreate(TS ts,PetscViewer viewer,void **ctx)
23416083293cSBarry Smith {
23426083293cSBarry Smith   PetscErrorCode       ierr;
23436083293cSBarry Smith   TSMonitorSolutionCtx *ictx;
23446083293cSBarry Smith 
23456083293cSBarry Smith   PetscFunctionBegin;
23466083293cSBarry Smith   ierr = PetscNew(TSMonitorSolutionCtx,&ictx);CHKERRQ(ierr);
23476083293cSBarry Smith   *ctx = (void*)ictx;
23486083293cSBarry Smith   if (!viewer) {
23496083293cSBarry Smith     viewer = PETSC_VIEWER_DRAW_(((PetscObject)ts)->comm);
23506083293cSBarry Smith   }
23516083293cSBarry Smith   ierr = PetscObjectReference((PetscObject)viewer);CHKERRQ(ierr);
23526083293cSBarry Smith   ictx->viewer      = viewer;
23536083293cSBarry Smith   ictx->showinitial = PETSC_FALSE;
23546083293cSBarry Smith   ierr = PetscOptionsGetBool(((PetscObject)ts)->prefix,"-ts_monitor_solution_initial",&ictx->showinitial,PETSC_NULL);CHKERRQ(ierr);
23556083293cSBarry Smith   PetscFunctionReturn(0);
23566083293cSBarry Smith }
23576083293cSBarry Smith 
23586083293cSBarry Smith #undef __FUNCT__
23596c699258SBarry Smith #define __FUNCT__ "TSSetDM"
23606c699258SBarry Smith /*@
23616c699258SBarry Smith    TSSetDM - Sets the DM that may be used by some preconditioners
23626c699258SBarry Smith 
23633f9fe445SBarry Smith    Logically Collective on TS and DM
23646c699258SBarry Smith 
23656c699258SBarry Smith    Input Parameters:
23666c699258SBarry Smith +  ts - the preconditioner context
23676c699258SBarry Smith -  dm - the dm
23686c699258SBarry Smith 
23696c699258SBarry Smith    Level: intermediate
23706c699258SBarry Smith 
23716c699258SBarry Smith 
23726c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
23736c699258SBarry Smith @*/
23747087cfbeSBarry Smith PetscErrorCode  TSSetDM(TS ts,DM dm)
23756c699258SBarry Smith {
23766c699258SBarry Smith   PetscErrorCode ierr;
2377089b2837SJed Brown   SNES           snes;
23786c699258SBarry Smith 
23796c699258SBarry Smith   PetscFunctionBegin;
23800700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
238170663e4aSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);
23826bf464f9SBarry Smith   ierr = DMDestroy(&ts->dm);CHKERRQ(ierr);
23836c699258SBarry Smith   ts->dm = dm;
2384089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2385089b2837SJed Brown   ierr = SNESSetDM(snes,dm);CHKERRQ(ierr);
23866c699258SBarry Smith   PetscFunctionReturn(0);
23876c699258SBarry Smith }
23886c699258SBarry Smith 
23896c699258SBarry Smith #undef __FUNCT__
23906c699258SBarry Smith #define __FUNCT__ "TSGetDM"
23916c699258SBarry Smith /*@
23926c699258SBarry Smith    TSGetDM - Gets the DM that may be used by some preconditioners
23936c699258SBarry Smith 
23943f9fe445SBarry Smith    Not Collective
23956c699258SBarry Smith 
23966c699258SBarry Smith    Input Parameter:
23976c699258SBarry Smith . ts - the preconditioner context
23986c699258SBarry Smith 
23996c699258SBarry Smith    Output Parameter:
24006c699258SBarry Smith .  dm - the dm
24016c699258SBarry Smith 
24026c699258SBarry Smith    Level: intermediate
24036c699258SBarry Smith 
24046c699258SBarry Smith 
24056c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
24066c699258SBarry Smith @*/
24077087cfbeSBarry Smith PetscErrorCode  TSGetDM(TS ts,DM *dm)
24086c699258SBarry Smith {
24096c699258SBarry Smith   PetscFunctionBegin;
24100700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
24116c699258SBarry Smith   *dm = ts->dm;
24126c699258SBarry Smith   PetscFunctionReturn(0);
24136c699258SBarry Smith }
24141713a123SBarry Smith 
24150f5c6efeSJed Brown #undef __FUNCT__
24160f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormFunction"
24170f5c6efeSJed Brown /*@
24180f5c6efeSJed Brown    SNESTSFormFunction - Function to evaluate nonlinear residual
24190f5c6efeSJed Brown 
24203f9fe445SBarry Smith    Logically Collective on SNES
24210f5c6efeSJed Brown 
24220f5c6efeSJed Brown    Input Parameter:
2423d42a1c89SJed Brown + snes - nonlinear solver
24240f5c6efeSJed Brown . X - the current state at which to evaluate the residual
2425d42a1c89SJed Brown - ctx - user context, must be a TS
24260f5c6efeSJed Brown 
24270f5c6efeSJed Brown    Output Parameter:
24280f5c6efeSJed Brown . F - the nonlinear residual
24290f5c6efeSJed Brown 
24300f5c6efeSJed Brown    Notes:
24310f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
24320f5c6efeSJed Brown    It is most frequently passed to MatFDColoringSetFunction().
24330f5c6efeSJed Brown 
24340f5c6efeSJed Brown    Level: advanced
24350f5c6efeSJed Brown 
24360f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction()
24370f5c6efeSJed Brown @*/
24387087cfbeSBarry Smith PetscErrorCode  SNESTSFormFunction(SNES snes,Vec X,Vec F,void *ctx)
24390f5c6efeSJed Brown {
24400f5c6efeSJed Brown   TS ts = (TS)ctx;
24410f5c6efeSJed Brown   PetscErrorCode ierr;
24420f5c6efeSJed Brown 
24430f5c6efeSJed Brown   PetscFunctionBegin;
24440f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
24450f5c6efeSJed Brown   PetscValidHeaderSpecific(X,VEC_CLASSID,2);
24460f5c6efeSJed Brown   PetscValidHeaderSpecific(F,VEC_CLASSID,3);
24470f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,4);
24480f5c6efeSJed Brown   ierr = (ts->ops->snesfunction)(snes,X,F,ts);CHKERRQ(ierr);
24490f5c6efeSJed Brown   PetscFunctionReturn(0);
24500f5c6efeSJed Brown }
24510f5c6efeSJed Brown 
24520f5c6efeSJed Brown #undef __FUNCT__
24530f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormJacobian"
24540f5c6efeSJed Brown /*@
24550f5c6efeSJed Brown    SNESTSFormJacobian - Function to evaluate the Jacobian
24560f5c6efeSJed Brown 
24570f5c6efeSJed Brown    Collective on SNES
24580f5c6efeSJed Brown 
24590f5c6efeSJed Brown    Input Parameter:
24600f5c6efeSJed Brown + snes - nonlinear solver
24610f5c6efeSJed Brown . X - the current state at which to evaluate the residual
24620f5c6efeSJed Brown - ctx - user context, must be a TS
24630f5c6efeSJed Brown 
24640f5c6efeSJed Brown    Output Parameter:
24650f5c6efeSJed Brown + A - the Jacobian
24660f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A)
24670f5c6efeSJed Brown - flag - indicates any structure change in the matrix
24680f5c6efeSJed Brown 
24690f5c6efeSJed Brown    Notes:
24700f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
24710f5c6efeSJed Brown 
24720f5c6efeSJed Brown    Level: developer
24730f5c6efeSJed Brown 
24740f5c6efeSJed Brown .seealso: SNESSetJacobian()
24750f5c6efeSJed Brown @*/
24767087cfbeSBarry Smith PetscErrorCode  SNESTSFormJacobian(SNES snes,Vec X,Mat *A,Mat *B,MatStructure *flag,void *ctx)
24770f5c6efeSJed Brown {
24780f5c6efeSJed Brown   TS ts = (TS)ctx;
24790f5c6efeSJed Brown   PetscErrorCode ierr;
24800f5c6efeSJed Brown 
24810f5c6efeSJed Brown   PetscFunctionBegin;
24820f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
24830f5c6efeSJed Brown   PetscValidHeaderSpecific(X,VEC_CLASSID,2);
24840f5c6efeSJed Brown   PetscValidPointer(A,3);
24850f5c6efeSJed Brown   PetscValidHeaderSpecific(*A,MAT_CLASSID,3);
24860f5c6efeSJed Brown   PetscValidPointer(B,4);
24870f5c6efeSJed Brown   PetscValidHeaderSpecific(*B,MAT_CLASSID,4);
24880f5c6efeSJed Brown   PetscValidPointer(flag,5);
24890f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,6);
24900f5c6efeSJed Brown   ierr = (ts->ops->snesjacobian)(snes,X,A,B,flag,ts);CHKERRQ(ierr);
24910f5c6efeSJed Brown   PetscFunctionReturn(0);
24920f5c6efeSJed Brown }
2493325fc9f4SBarry Smith 
24940e4ef248SJed Brown #undef __FUNCT__
24950e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSFunctionLinear"
24960e4ef248SJed Brown /*@C
24970e4ef248SJed Brown    TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems only
24980e4ef248SJed Brown 
24990e4ef248SJed Brown    Collective on TS
25000e4ef248SJed Brown 
25010e4ef248SJed Brown    Input Arguments:
25020e4ef248SJed Brown +  ts - time stepping context
25030e4ef248SJed Brown .  t - time at which to evaluate
25040e4ef248SJed Brown .  X - state at which to evaluate
25050e4ef248SJed Brown -  ctx - context
25060e4ef248SJed Brown 
25070e4ef248SJed Brown    Output Arguments:
25080e4ef248SJed Brown .  F - right hand side
25090e4ef248SJed Brown 
25100e4ef248SJed Brown    Level: intermediate
25110e4ef248SJed Brown 
25120e4ef248SJed Brown    Notes:
25130e4ef248SJed Brown    This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
25140e4ef248SJed Brown    The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
25150e4ef248SJed Brown 
25160e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
25170e4ef248SJed Brown @*/
25180e4ef248SJed Brown PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec X,Vec F,void *ctx)
25190e4ef248SJed Brown {
25200e4ef248SJed Brown   PetscErrorCode ierr;
25210e4ef248SJed Brown   Mat Arhs,Brhs;
25220e4ef248SJed Brown   MatStructure flg2;
25230e4ef248SJed Brown 
25240e4ef248SJed Brown   PetscFunctionBegin;
25250e4ef248SJed Brown   ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
25260e4ef248SJed Brown   ierr = TSComputeRHSJacobian(ts,t,X,&Arhs,&Brhs,&flg2);CHKERRQ(ierr);
25270e4ef248SJed Brown   ierr = MatMult(Arhs,X,F);CHKERRQ(ierr);
25280e4ef248SJed Brown   PetscFunctionReturn(0);
25290e4ef248SJed Brown }
25300e4ef248SJed Brown 
25310e4ef248SJed Brown #undef __FUNCT__
25320e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSJacobianConstant"
25330e4ef248SJed Brown /*@C
25340e4ef248SJed Brown    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
25350e4ef248SJed Brown 
25360e4ef248SJed Brown    Collective on TS
25370e4ef248SJed Brown 
25380e4ef248SJed Brown    Input Arguments:
25390e4ef248SJed Brown +  ts - time stepping context
25400e4ef248SJed Brown .  t - time at which to evaluate
25410e4ef248SJed Brown .  X - state at which to evaluate
25420e4ef248SJed Brown -  ctx - context
25430e4ef248SJed Brown 
25440e4ef248SJed Brown    Output Arguments:
25450e4ef248SJed Brown +  A - pointer to operator
25460e4ef248SJed Brown .  B - pointer to preconditioning matrix
25470e4ef248SJed Brown -  flg - matrix structure flag
25480e4ef248SJed Brown 
25490e4ef248SJed Brown    Level: intermediate
25500e4ef248SJed Brown 
25510e4ef248SJed Brown    Notes:
25520e4ef248SJed Brown    This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
25530e4ef248SJed Brown 
25540e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
25550e4ef248SJed Brown @*/
25560e4ef248SJed Brown PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec X,Mat *A,Mat *B,MatStructure *flg,void *ctx)
25570e4ef248SJed Brown {
25580e4ef248SJed Brown 
25590e4ef248SJed Brown   PetscFunctionBegin;
25600e4ef248SJed Brown   *flg = SAME_PRECONDITIONER;
25610e4ef248SJed Brown   PetscFunctionReturn(0);
25620e4ef248SJed Brown }
25630e4ef248SJed Brown 
25640026cea9SSean Farley #undef __FUNCT__
25650026cea9SSean Farley #define __FUNCT__ "TSComputeIFunctionLinear"
25660026cea9SSean Farley /*@C
25670026cea9SSean Farley    TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
25680026cea9SSean Farley 
25690026cea9SSean Farley    Collective on TS
25700026cea9SSean Farley 
25710026cea9SSean Farley    Input Arguments:
25720026cea9SSean Farley +  ts - time stepping context
25730026cea9SSean Farley .  t - time at which to evaluate
25740026cea9SSean Farley .  X - state at which to evaluate
25750026cea9SSean Farley .  Xdot - time derivative of state vector
25760026cea9SSean Farley -  ctx - context
25770026cea9SSean Farley 
25780026cea9SSean Farley    Output Arguments:
25790026cea9SSean Farley .  F - left hand side
25800026cea9SSean Farley 
25810026cea9SSean Farley    Level: intermediate
25820026cea9SSean Farley 
25830026cea9SSean Farley    Notes:
25840026cea9SSean Farley    The assumption here is that the left hand side is of the form A*Xdot (and not A*Xdot + B*X). For other cases, the
25850026cea9SSean Farley    user is required to write their own TSComputeIFunction.
25860026cea9SSean Farley    This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
25870026cea9SSean Farley    The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
25880026cea9SSean Farley 
25890026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant()
25900026cea9SSean Farley @*/
25910026cea9SSean Farley PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec X,Vec Xdot,Vec F,void *ctx)
25920026cea9SSean Farley {
25930026cea9SSean Farley   PetscErrorCode ierr;
25940026cea9SSean Farley   Mat A,B;
25950026cea9SSean Farley   MatStructure flg2;
25960026cea9SSean Farley 
25970026cea9SSean Farley   PetscFunctionBegin;
25980026cea9SSean Farley   ierr = TSGetIJacobian(ts,&A,&B,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
25990026cea9SSean Farley   ierr = TSComputeIJacobian(ts,t,X,Xdot,1.0,&A,&B,&flg2,PETSC_TRUE);CHKERRQ(ierr);
26000026cea9SSean Farley   ierr = MatMult(A,Xdot,F);CHKERRQ(ierr);
26010026cea9SSean Farley   PetscFunctionReturn(0);
26020026cea9SSean Farley }
26030026cea9SSean Farley 
26040026cea9SSean Farley #undef __FUNCT__
26050026cea9SSean Farley #define __FUNCT__ "TSComputeIJacobianConstant"
26060026cea9SSean Farley /*@C
26070026cea9SSean Farley    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
26080026cea9SSean Farley 
26090026cea9SSean Farley    Collective on TS
26100026cea9SSean Farley 
26110026cea9SSean Farley    Input Arguments:
26120026cea9SSean Farley +  ts - time stepping context
26130026cea9SSean Farley .  t - time at which to evaluate
26140026cea9SSean Farley .  X - state at which to evaluate
26150026cea9SSean Farley .  Xdot - time derivative of state vector
26160026cea9SSean Farley .  shift - shift to apply
26170026cea9SSean Farley -  ctx - context
26180026cea9SSean Farley 
26190026cea9SSean Farley    Output Arguments:
26200026cea9SSean Farley +  A - pointer to operator
26210026cea9SSean Farley .  B - pointer to preconditioning matrix
26220026cea9SSean Farley -  flg - matrix structure flag
26230026cea9SSean Farley 
26240026cea9SSean Farley    Level: intermediate
26250026cea9SSean Farley 
26260026cea9SSean Farley    Notes:
26270026cea9SSean Farley    This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
26280026cea9SSean Farley 
26290026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
26300026cea9SSean Farley @*/
26310026cea9SSean Farley PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec X,Vec Xdot,PetscReal shift,Mat *A,Mat *B,MatStructure *flg,void *ctx)
26320026cea9SSean Farley {
26330026cea9SSean Farley 
26340026cea9SSean Farley   PetscFunctionBegin;
26350026cea9SSean Farley   *flg = SAME_PRECONDITIONER;
26360026cea9SSean Farley   PetscFunctionReturn(0);
26370026cea9SSean Farley }
26380026cea9SSean Farley 
26394af1b03aSJed Brown 
26404af1b03aSJed Brown #undef __FUNCT__
26414af1b03aSJed Brown #define __FUNCT__ "TSGetConvergedReason"
26424af1b03aSJed Brown /*@
26434af1b03aSJed Brown    TSGetConvergedReason - Gets the reason the TS iteration was stopped.
26444af1b03aSJed Brown 
26454af1b03aSJed Brown    Not Collective
26464af1b03aSJed Brown 
26474af1b03aSJed Brown    Input Parameter:
26484af1b03aSJed Brown .  ts - the TS context
26494af1b03aSJed Brown 
26504af1b03aSJed Brown    Output Parameter:
26514af1b03aSJed Brown .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
26524af1b03aSJed Brown             manual pages for the individual convergence tests for complete lists
26534af1b03aSJed Brown 
26544af1b03aSJed Brown    Level: intermediate
26554af1b03aSJed Brown 
2656cd652676SJed Brown    Notes:
2657cd652676SJed Brown    Can only be called after the call to TSSolve() is complete.
26584af1b03aSJed Brown 
26594af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test
26604af1b03aSJed Brown 
26614af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason
26624af1b03aSJed Brown @*/
26634af1b03aSJed Brown PetscErrorCode  TSGetConvergedReason(TS ts,TSConvergedReason *reason)
26644af1b03aSJed Brown {
26654af1b03aSJed Brown   PetscFunctionBegin;
26664af1b03aSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
26674af1b03aSJed Brown   PetscValidPointer(reason,2);
26684af1b03aSJed Brown   *reason = ts->reason;
26694af1b03aSJed Brown   PetscFunctionReturn(0);
26704af1b03aSJed Brown }
26714af1b03aSJed Brown 
2672d6ebe24aSShri Abhyankar 
2673d6ebe24aSShri Abhyankar #undef __FUNCT__
2674d6ebe24aSShri Abhyankar #define __FUNCT__ "TSVISetVariableBounds"
2675d6ebe24aSShri Abhyankar /*@
2676d6ebe24aSShri Abhyankar    TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
2677d6ebe24aSShri Abhyankar 
2678d6ebe24aSShri Abhyankar    Input Parameters:
2679d6ebe24aSShri Abhyankar .  ts   - the TS context.
2680d6ebe24aSShri Abhyankar .  xl   - lower bound.
2681d6ebe24aSShri Abhyankar .  xu   - upper bound.
2682d6ebe24aSShri Abhyankar 
2683d6ebe24aSShri Abhyankar    Notes:
2684d6ebe24aSShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
2685d6ebe24aSShri Abhyankar    SNES_VI_INF and SNES_VI_NINF respectively during SNESSetUp().
2686d6ebe24aSShri Abhyankar 
2687d6ebe24aSShri Abhyankar @*/
2688d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
2689d6ebe24aSShri Abhyankar {
2690d6ebe24aSShri Abhyankar   PetscErrorCode ierr;
2691d6ebe24aSShri Abhyankar   SNES           snes;
2692d6ebe24aSShri Abhyankar 
2693d6ebe24aSShri Abhyankar   PetscFunctionBegin;
2694d6ebe24aSShri Abhyankar   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2695d6ebe24aSShri Abhyankar   ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr);
2696d6ebe24aSShri Abhyankar   PetscFunctionReturn(0);
2697d6ebe24aSShri Abhyankar }
2698d6ebe24aSShri Abhyankar 
2699325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
2700c6db04a5SJed Brown #include <mex.h>
2701325fc9f4SBarry Smith 
2702325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext;
2703325fc9f4SBarry Smith 
2704325fc9f4SBarry Smith #undef __FUNCT__
2705325fc9f4SBarry Smith #define __FUNCT__ "TSComputeFunction_Matlab"
2706325fc9f4SBarry Smith /*
2707325fc9f4SBarry Smith    TSComputeFunction_Matlab - Calls the function that has been set with
2708325fc9f4SBarry Smith                          TSSetFunctionMatlab().
2709325fc9f4SBarry Smith 
2710325fc9f4SBarry Smith    Collective on TS
2711325fc9f4SBarry Smith 
2712325fc9f4SBarry Smith    Input Parameters:
2713325fc9f4SBarry Smith +  snes - the TS context
2714325fc9f4SBarry Smith -  x - input vector
2715325fc9f4SBarry Smith 
2716325fc9f4SBarry Smith    Output Parameter:
2717325fc9f4SBarry Smith .  y - function vector, as set by TSSetFunction()
2718325fc9f4SBarry Smith 
2719325fc9f4SBarry Smith    Notes:
2720325fc9f4SBarry Smith    TSComputeFunction() is typically used within nonlinear solvers
2721325fc9f4SBarry Smith    implementations, so most users would not generally call this routine
2722325fc9f4SBarry Smith    themselves.
2723325fc9f4SBarry Smith 
2724325fc9f4SBarry Smith    Level: developer
2725325fc9f4SBarry Smith 
2726325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
2727325fc9f4SBarry Smith 
2728325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
2729325fc9f4SBarry Smith */
27307087cfbeSBarry Smith PetscErrorCode  TSComputeFunction_Matlab(TS snes,PetscReal time,Vec x,Vec xdot,Vec y, void *ctx)
2731325fc9f4SBarry Smith {
2732325fc9f4SBarry Smith   PetscErrorCode   ierr;
2733325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext *)ctx;
2734325fc9f4SBarry Smith   int              nlhs = 1,nrhs = 7;
2735325fc9f4SBarry Smith   mxArray          *plhs[1],*prhs[7];
2736325fc9f4SBarry Smith   long long int    lx = 0,lxdot = 0,ly = 0,ls = 0;
2737325fc9f4SBarry Smith 
2738325fc9f4SBarry Smith   PetscFunctionBegin;
2739325fc9f4SBarry Smith   PetscValidHeaderSpecific(snes,TS_CLASSID,1);
2740325fc9f4SBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,3);
2741325fc9f4SBarry Smith   PetscValidHeaderSpecific(xdot,VEC_CLASSID,4);
2742325fc9f4SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,5);
2743325fc9f4SBarry Smith   PetscCheckSameComm(snes,1,x,3);
2744325fc9f4SBarry Smith   PetscCheckSameComm(snes,1,y,5);
2745325fc9f4SBarry Smith 
2746325fc9f4SBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
2747325fc9f4SBarry Smith   ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr);
2748880f3077SBarry Smith   ierr = PetscMemcpy(&lxdot,&xdot,sizeof(xdot));CHKERRQ(ierr);
2749325fc9f4SBarry Smith   ierr = PetscMemcpy(&ly,&y,sizeof(x));CHKERRQ(ierr);
2750325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
2751325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar(time);
2752325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
2753325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
2754325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)ly);
2755325fc9f4SBarry Smith   prhs[5] =  mxCreateString(sctx->funcname);
2756325fc9f4SBarry Smith   prhs[6] =  sctx->ctx;
2757325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr);
2758325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
2759325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
2760325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
2761325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
2762325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
2763325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
2764325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
2765325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
2766325fc9f4SBarry Smith   PetscFunctionReturn(0);
2767325fc9f4SBarry Smith }
2768325fc9f4SBarry Smith 
2769325fc9f4SBarry Smith 
2770325fc9f4SBarry Smith #undef __FUNCT__
2771325fc9f4SBarry Smith #define __FUNCT__ "TSSetFunctionMatlab"
2772325fc9f4SBarry Smith /*
2773325fc9f4SBarry Smith    TSSetFunctionMatlab - Sets the function evaluation routine and function
2774325fc9f4SBarry Smith    vector for use by the TS routines in solving ODEs
2775e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
2776325fc9f4SBarry Smith 
2777325fc9f4SBarry Smith    Logically Collective on TS
2778325fc9f4SBarry Smith 
2779325fc9f4SBarry Smith    Input Parameters:
2780325fc9f4SBarry Smith +  ts - the TS context
2781325fc9f4SBarry Smith -  func - function evaluation routine
2782325fc9f4SBarry Smith 
2783325fc9f4SBarry Smith    Calling sequence of func:
2784325fc9f4SBarry Smith $    func (TS ts,PetscReal time,Vec x,Vec xdot,Vec f,void *ctx);
2785325fc9f4SBarry Smith 
2786325fc9f4SBarry Smith    Level: beginner
2787325fc9f4SBarry Smith 
2788325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
2789325fc9f4SBarry Smith 
2790325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
2791325fc9f4SBarry Smith */
2792cdcf91faSSean Farley PetscErrorCode  TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx)
2793325fc9f4SBarry Smith {
2794325fc9f4SBarry Smith   PetscErrorCode  ierr;
2795325fc9f4SBarry Smith   TSMatlabContext *sctx;
2796325fc9f4SBarry Smith 
2797325fc9f4SBarry Smith   PetscFunctionBegin;
2798325fc9f4SBarry Smith   /* currently sctx is memory bleed */
2799325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
2800325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
2801325fc9f4SBarry Smith   /*
2802325fc9f4SBarry Smith      This should work, but it doesn't
2803325fc9f4SBarry Smith   sctx->ctx = ctx;
2804325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
2805325fc9f4SBarry Smith   */
2806325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
2807cdcf91faSSean Farley   ierr = TSSetIFunction(ts,PETSC_NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr);
2808325fc9f4SBarry Smith   PetscFunctionReturn(0);
2809325fc9f4SBarry Smith }
2810325fc9f4SBarry Smith 
2811325fc9f4SBarry Smith #undef __FUNCT__
2812325fc9f4SBarry Smith #define __FUNCT__ "TSComputeJacobian_Matlab"
2813325fc9f4SBarry Smith /*
2814325fc9f4SBarry Smith    TSComputeJacobian_Matlab - Calls the function that has been set with
2815325fc9f4SBarry Smith                          TSSetJacobianMatlab().
2816325fc9f4SBarry Smith 
2817325fc9f4SBarry Smith    Collective on TS
2818325fc9f4SBarry Smith 
2819325fc9f4SBarry Smith    Input Parameters:
2820cdcf91faSSean Farley +  ts - the TS context
2821325fc9f4SBarry Smith .  x - input vector
2822325fc9f4SBarry Smith .  A, B - the matrices
2823325fc9f4SBarry Smith -  ctx - user context
2824325fc9f4SBarry Smith 
2825325fc9f4SBarry Smith    Output Parameter:
2826325fc9f4SBarry Smith .  flag - structure of the matrix
2827325fc9f4SBarry Smith 
2828325fc9f4SBarry Smith    Level: developer
2829325fc9f4SBarry Smith 
2830325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
2831325fc9f4SBarry Smith 
2832325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
2833325fc9f4SBarry Smith @*/
2834cdcf91faSSean Farley PetscErrorCode  TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec x,Vec xdot,PetscReal shift,Mat *A,Mat *B,MatStructure *flag, void *ctx)
2835325fc9f4SBarry Smith {
2836325fc9f4SBarry Smith   PetscErrorCode  ierr;
2837325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext *)ctx;
2838325fc9f4SBarry Smith   int             nlhs = 2,nrhs = 9;
2839325fc9f4SBarry Smith   mxArray         *plhs[2],*prhs[9];
2840325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0;
2841325fc9f4SBarry Smith 
2842325fc9f4SBarry Smith   PetscFunctionBegin;
2843cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2844325fc9f4SBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,3);
2845325fc9f4SBarry Smith 
2846325fc9f4SBarry Smith   /* call Matlab function in ctx with arguments x and y */
2847325fc9f4SBarry Smith 
2848cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
2849325fc9f4SBarry Smith   ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr);
2850325fc9f4SBarry Smith   ierr = PetscMemcpy(&lxdot,&xdot,sizeof(x));CHKERRQ(ierr);
2851325fc9f4SBarry Smith   ierr = PetscMemcpy(&lA,A,sizeof(x));CHKERRQ(ierr);
2852325fc9f4SBarry Smith   ierr = PetscMemcpy(&lB,B,sizeof(x));CHKERRQ(ierr);
2853325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
2854325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)time);
2855325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
2856325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
2857325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)shift);
2858325fc9f4SBarry Smith   prhs[5] =  mxCreateDoubleScalar((double)lA);
2859325fc9f4SBarry Smith   prhs[6] =  mxCreateDoubleScalar((double)lB);
2860325fc9f4SBarry Smith   prhs[7] =  mxCreateString(sctx->funcname);
2861325fc9f4SBarry Smith   prhs[8] =  sctx->ctx;
2862325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr);
2863325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
2864325fc9f4SBarry Smith   *flag   =  (MatStructure) mxGetScalar(plhs[1]);CHKERRQ(ierr);
2865325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
2866325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
2867325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
2868325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
2869325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
2870325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
2871325fc9f4SBarry Smith   mxDestroyArray(prhs[6]);
2872325fc9f4SBarry Smith   mxDestroyArray(prhs[7]);
2873325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
2874325fc9f4SBarry Smith   mxDestroyArray(plhs[1]);
2875325fc9f4SBarry Smith   PetscFunctionReturn(0);
2876325fc9f4SBarry Smith }
2877325fc9f4SBarry Smith 
2878325fc9f4SBarry Smith 
2879325fc9f4SBarry Smith #undef __FUNCT__
2880325fc9f4SBarry Smith #define __FUNCT__ "TSSetJacobianMatlab"
2881325fc9f4SBarry Smith /*
2882325fc9f4SBarry Smith    TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
2883e3c5b3baSBarry Smith    vector for use by the TS routines in solving ODEs from MATLAB. Here the function is a string containing the name of a MATLAB function
2884325fc9f4SBarry Smith 
2885325fc9f4SBarry Smith    Logically Collective on TS
2886325fc9f4SBarry Smith 
2887325fc9f4SBarry Smith    Input Parameters:
2888cdcf91faSSean Farley +  ts - the TS context
2889325fc9f4SBarry Smith .  A,B - Jacobian matrices
2890325fc9f4SBarry Smith .  func - function evaluation routine
2891325fc9f4SBarry Smith -  ctx - user context
2892325fc9f4SBarry Smith 
2893325fc9f4SBarry Smith    Calling sequence of func:
2894cdcf91faSSean Farley $    flag = func (TS ts,PetscReal time,Vec x,Vec xdot,Mat A,Mat B,void *ctx);
2895325fc9f4SBarry Smith 
2896325fc9f4SBarry Smith 
2897325fc9f4SBarry Smith    Level: developer
2898325fc9f4SBarry Smith 
2899325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
2900325fc9f4SBarry Smith 
2901325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
2902325fc9f4SBarry Smith */
2903cdcf91faSSean Farley PetscErrorCode  TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx)
2904325fc9f4SBarry Smith {
2905325fc9f4SBarry Smith   PetscErrorCode    ierr;
2906325fc9f4SBarry Smith   TSMatlabContext *sctx;
2907325fc9f4SBarry Smith 
2908325fc9f4SBarry Smith   PetscFunctionBegin;
2909325fc9f4SBarry Smith   /* currently sctx is memory bleed */
2910325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
2911325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
2912325fc9f4SBarry Smith   /*
2913325fc9f4SBarry Smith      This should work, but it doesn't
2914325fc9f4SBarry Smith   sctx->ctx = ctx;
2915325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
2916325fc9f4SBarry Smith   */
2917325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
2918cdcf91faSSean Farley   ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
2919325fc9f4SBarry Smith   PetscFunctionReturn(0);
2920325fc9f4SBarry Smith }
2921325fc9f4SBarry Smith 
2922b5b1a830SBarry Smith #undef __FUNCT__
2923b5b1a830SBarry Smith #define __FUNCT__ "TSMonitor_Matlab"
2924b5b1a830SBarry Smith /*
2925b5b1a830SBarry Smith    TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab().
2926b5b1a830SBarry Smith 
2927b5b1a830SBarry Smith    Collective on TS
2928b5b1a830SBarry Smith 
2929b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
2930b5b1a830SBarry Smith @*/
2931cdcf91faSSean Farley PetscErrorCode  TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec x, void *ctx)
2932b5b1a830SBarry Smith {
2933b5b1a830SBarry Smith   PetscErrorCode  ierr;
2934b5b1a830SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext *)ctx;
2935a530c242SBarry Smith   int             nlhs = 1,nrhs = 6;
2936b5b1a830SBarry Smith   mxArray         *plhs[1],*prhs[6];
2937b5b1a830SBarry Smith   long long int   lx = 0,ls = 0;
2938b5b1a830SBarry Smith 
2939b5b1a830SBarry Smith   PetscFunctionBegin;
2940cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2941b5b1a830SBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,4);
2942b5b1a830SBarry Smith 
2943cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
2944b5b1a830SBarry Smith   ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr);
2945b5b1a830SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
2946b5b1a830SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)it);
2947b5b1a830SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)time);
2948b5b1a830SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lx);
2949b5b1a830SBarry Smith   prhs[4] =  mxCreateString(sctx->funcname);
2950b5b1a830SBarry Smith   prhs[5] =  sctx->ctx;
2951b5b1a830SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr);
2952b5b1a830SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
2953b5b1a830SBarry Smith   mxDestroyArray(prhs[0]);
2954b5b1a830SBarry Smith   mxDestroyArray(prhs[1]);
2955b5b1a830SBarry Smith   mxDestroyArray(prhs[2]);
2956b5b1a830SBarry Smith   mxDestroyArray(prhs[3]);
2957b5b1a830SBarry Smith   mxDestroyArray(prhs[4]);
2958b5b1a830SBarry Smith   mxDestroyArray(plhs[0]);
2959b5b1a830SBarry Smith   PetscFunctionReturn(0);
2960b5b1a830SBarry Smith }
2961b5b1a830SBarry Smith 
2962b5b1a830SBarry Smith 
2963b5b1a830SBarry Smith #undef __FUNCT__
2964b5b1a830SBarry Smith #define __FUNCT__ "TSMonitorSetMatlab"
2965b5b1a830SBarry Smith /*
2966b5b1a830SBarry Smith    TSMonitorSetMatlab - Sets the monitor function from Matlab
2967b5b1a830SBarry Smith 
2968b5b1a830SBarry Smith    Level: developer
2969b5b1a830SBarry Smith 
2970b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function
2971b5b1a830SBarry Smith 
2972b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
2973b5b1a830SBarry Smith */
2974cdcf91faSSean Farley PetscErrorCode  TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx)
2975b5b1a830SBarry Smith {
2976b5b1a830SBarry Smith   PetscErrorCode    ierr;
2977b5b1a830SBarry Smith   TSMatlabContext *sctx;
2978b5b1a830SBarry Smith 
2979b5b1a830SBarry Smith   PetscFunctionBegin;
2980b5b1a830SBarry Smith   /* currently sctx is memory bleed */
2981b5b1a830SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
2982b5b1a830SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
2983b5b1a830SBarry Smith   /*
2984b5b1a830SBarry Smith      This should work, but it doesn't
2985b5b1a830SBarry Smith   sctx->ctx = ctx;
2986b5b1a830SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
2987b5b1a830SBarry Smith   */
2988b5b1a830SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
2989cdcf91faSSean Farley   ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,PETSC_NULL);CHKERRQ(ierr);
2990b5b1a830SBarry Smith   PetscFunctionReturn(0);
2991b5b1a830SBarry Smith }
2992325fc9f4SBarry Smith #endif
2993