xref: /petsc/src/ts/interface/ts.c (revision 5a3a76d07e72bd733c23cdbf132d31c2a5ff3d88)
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);
827adad957SLisandro Dalcin   ierr = PetscOptionsBegin(((PetscObject)ts)->comm, ((PetscObject)ts)->prefix, "Time step options", "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);
89bdad233fSMatthew Knepley     ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetInitialTime", ts->ptime, &ts->ptime, PETSC_NULL);CHKERRQ(ierr);
90bdad233fSMatthew Knepley     ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetInitialTimeStep",ts->initial_time_step,&dt,&opt);CHKERRQ(ierr);
913daf2de8SJed Brown     if (opt) {ierr = TSSetInitialTimeStep(ts,ts->ptime,dt);CHKERRQ(ierr);}
92a43b19c4SJed Brown     opt = ts->exact_final_time == PETSC_DECIDE ? PETSC_FALSE : (PetscBool)ts->exact_final_time;
93a43b19c4SJed Brown     ierr = PetscOptionsBool("-ts_exact_final_time","Interpolate output to stop exactly at the final time","TSSetExactFinalTime",opt,&opt,&flg);CHKERRQ(ierr);
94a43b19c4SJed Brown     if (flg) {ierr = TSSetExactFinalTime(ts,flg);CHKERRQ(ierr);}
95193ac0bcSJed 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);
96193ac0bcSJed Brown     ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections","",ts->max_reject,&ts->max_reject,PETSC_NULL);CHKERRQ(ierr);
97193ac0bcSJed Brown     ierr = PetscOptionsBool("-ts_error_if_step_failed","Error if no step succeeds","",ts->errorifstepfailed,&ts->errorifstepfailed,PETSC_NULL);CHKERRQ(ierr);
98bdad233fSMatthew Knepley 
99bdad233fSMatthew Knepley     /* Monitor options */
100a6570f20SBarry Smith     ierr = PetscOptionsString("-ts_monitor","Monitor timestep size","TSMonitorDefault","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
101eabae89aSBarry Smith     if (flg) {
102649052a6SBarry Smith       ierr = PetscViewerASCIIOpen(((PetscObject)ts)->comm,monfilename,&monviewer);CHKERRQ(ierr);
103649052a6SBarry Smith       ierr = TSMonitorSet(ts,TSMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
104bdad233fSMatthew Knepley     }
1055180491cSLisandro Dalcin     ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
1065180491cSLisandro Dalcin     if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);}
1075180491cSLisandro Dalcin 
10890d69ab7SBarry Smith     opt  = PETSC_FALSE;
109acfcf0e5SJed Brown     ierr = PetscOptionsBool("-ts_monitor_draw","Monitor timestep size graphically","TSMonitorLG",opt,&opt,PETSC_NULL);CHKERRQ(ierr);
110a7cc72afSBarry Smith     if (opt) {
111a6570f20SBarry Smith       ierr = TSMonitorSet(ts,TSMonitorLG,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
112bdad233fSMatthew Knepley     }
11390d69ab7SBarry Smith     opt  = PETSC_FALSE;
114acfcf0e5SJed Brown     ierr = PetscOptionsBool("-ts_monitor_solution","Monitor solution graphically","TSMonitorSolution",opt,&opt,PETSC_NULL);CHKERRQ(ierr);
115a7cc72afSBarry Smith     if (opt) {
116a6570f20SBarry Smith       ierr = TSMonitorSet(ts,TSMonitorSolution,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
117bdad233fSMatthew Knepley     }
118bdad233fSMatthew Knepley 
119bdad233fSMatthew Knepley     /* Handle specific TS options */
120abc0a331SBarry Smith     if (ts->ops->setfromoptions) {
121bdad233fSMatthew Knepley       ierr = (*ts->ops->setfromoptions)(ts);CHKERRQ(ierr);
122bdad233fSMatthew Knepley     }
1235d973c19SBarry Smith 
1245d973c19SBarry Smith     /* process any options handlers added with PetscObjectAddOptionsHandler() */
1255d973c19SBarry Smith     ierr = PetscObjectProcessOptionsHandlers((PetscObject)ts);CHKERRQ(ierr);
126bdad233fSMatthew Knepley   ierr = PetscOptionsEnd();CHKERRQ(ierr);
127bdad233fSMatthew Knepley 
128089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
129bdad233fSMatthew Knepley   /* Handle subobject options */
130089b2837SJed Brown   if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);}
131089b2837SJed Brown   ierr = SNESSetFromOptions(snes);CHKERRQ(ierr);
132bdad233fSMatthew Knepley   PetscFunctionReturn(0);
133bdad233fSMatthew Knepley }
134bdad233fSMatthew Knepley 
135bdad233fSMatthew Knepley #undef __FUNCT__
136cdcf91faSSean Farley #undef __FUNCT__
1374a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSJacobian"
138a7a1495cSBarry Smith /*@
1398c385f81SBarry Smith    TSComputeRHSJacobian - Computes the Jacobian matrix that has been
140a7a1495cSBarry Smith       set with TSSetRHSJacobian().
141a7a1495cSBarry Smith 
142a7a1495cSBarry Smith    Collective on TS and Vec
143a7a1495cSBarry Smith 
144a7a1495cSBarry Smith    Input Parameters:
145316643e7SJed Brown +  ts - the TS context
146a7a1495cSBarry Smith .  t - current timestep
147a7a1495cSBarry Smith -  x - input vector
148a7a1495cSBarry Smith 
149a7a1495cSBarry Smith    Output Parameters:
150a7a1495cSBarry Smith +  A - Jacobian matrix
151a7a1495cSBarry Smith .  B - optional preconditioning matrix
152a7a1495cSBarry Smith -  flag - flag indicating matrix structure
153a7a1495cSBarry Smith 
154a7a1495cSBarry Smith    Notes:
155a7a1495cSBarry Smith    Most users should not need to explicitly call this routine, as it
156a7a1495cSBarry Smith    is used internally within the nonlinear solvers.
157a7a1495cSBarry Smith 
15894b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the
159a7a1495cSBarry Smith    flag parameter.
160a7a1495cSBarry Smith 
161a7a1495cSBarry Smith    Level: developer
162a7a1495cSBarry Smith 
163a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix
164a7a1495cSBarry Smith 
16594b7f48cSBarry Smith .seealso:  TSSetRHSJacobian(), KSPSetOperators()
166a7a1495cSBarry Smith @*/
1677087cfbeSBarry Smith PetscErrorCode  TSComputeRHSJacobian(TS ts,PetscReal t,Vec X,Mat *A,Mat *B,MatStructure *flg)
168a7a1495cSBarry Smith {
169dfbe8321SBarry Smith   PetscErrorCode ierr;
1700e4ef248SJed Brown   PetscInt Xstate;
171a7a1495cSBarry Smith 
172a7a1495cSBarry Smith   PetscFunctionBegin;
1730700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1740700a824SBarry Smith   PetscValidHeaderSpecific(X,VEC_CLASSID,3);
175c9780b6fSBarry Smith   PetscCheckSameComm(ts,1,X,3);
1760e4ef248SJed Brown   ierr = PetscObjectStateQuery((PetscObject)X,&Xstate);CHKERRQ(ierr);
1770e4ef248SJed Brown   if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.X == X && ts->rhsjacobian.Xstate == Xstate))) {
1780e4ef248SJed Brown     *flg = ts->rhsjacobian.mstructure;
1790e4ef248SJed Brown     PetscFunctionReturn(0);
180f8ede8e7SJed Brown   }
181d90be118SSean Farley 
1823b5f76d0SSean Farley   if (!ts->userops->rhsjacobian && !ts->userops->ijacobian) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
183d90be118SSean Farley 
1843b5f76d0SSean Farley   if (ts->userops->rhsjacobian) {
185d5ba7fb7SMatthew Knepley     ierr = PetscLogEventBegin(TS_JacobianEval,ts,X,*A,*B);CHKERRQ(ierr);
186a7a1495cSBarry Smith     *flg = DIFFERENT_NONZERO_PATTERN;
187a7a1495cSBarry Smith     PetscStackPush("TS user Jacobian function");
1883b5f76d0SSean Farley     ierr = (*ts->userops->rhsjacobian)(ts,t,X,A,B,flg,ts->jacP);CHKERRQ(ierr);
189a7a1495cSBarry Smith     PetscStackPop;
190d5ba7fb7SMatthew Knepley     ierr = PetscLogEventEnd(TS_JacobianEval,ts,X,*A,*B);CHKERRQ(ierr);
191a7a1495cSBarry Smith     /* make sure user returned a correct Jacobian and preconditioner */
1920700a824SBarry Smith     PetscValidHeaderSpecific(*A,MAT_CLASSID,4);
1930700a824SBarry Smith     PetscValidHeaderSpecific(*B,MAT_CLASSID,5);
194ef66eb69SBarry Smith   } else {
195214bc6a2SJed Brown     ierr = MatZeroEntries(*A);CHKERRQ(ierr);
196214bc6a2SJed Brown     if (*A != *B) {ierr = MatZeroEntries(*B);CHKERRQ(ierr);}
197214bc6a2SJed Brown     *flg = SAME_NONZERO_PATTERN;
198ef66eb69SBarry Smith   }
1990e4ef248SJed Brown   ts->rhsjacobian.time = t;
2000e4ef248SJed Brown   ts->rhsjacobian.X = X;
2010e4ef248SJed Brown   ierr = PetscObjectStateQuery((PetscObject)X,&ts->rhsjacobian.Xstate);CHKERRQ(ierr);
2020e4ef248SJed Brown   ts->rhsjacobian.mstructure = *flg;
203a7a1495cSBarry Smith   PetscFunctionReturn(0);
204a7a1495cSBarry Smith }
205a7a1495cSBarry Smith 
2064a2ae208SSatish Balay #undef __FUNCT__
2074a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSFunction"
208316643e7SJed Brown /*@
209d763cef2SBarry Smith    TSComputeRHSFunction - Evaluates the right-hand-side function.
210d763cef2SBarry Smith 
211316643e7SJed Brown    Collective on TS and Vec
212316643e7SJed Brown 
213316643e7SJed Brown    Input Parameters:
214316643e7SJed Brown +  ts - the TS context
215316643e7SJed Brown .  t - current time
216316643e7SJed Brown -  x - state vector
217316643e7SJed Brown 
218316643e7SJed Brown    Output Parameter:
219316643e7SJed Brown .  y - right hand side
220316643e7SJed Brown 
221316643e7SJed Brown    Note:
222316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
223316643e7SJed Brown    is used internally within the nonlinear solvers.
224316643e7SJed Brown 
225316643e7SJed Brown    Level: developer
226316643e7SJed Brown 
227316643e7SJed Brown .keywords: TS, compute
228316643e7SJed Brown 
229316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction()
230316643e7SJed Brown @*/
231dfbe8321SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec x,Vec y)
232d763cef2SBarry Smith {
233dfbe8321SBarry Smith   PetscErrorCode ierr;
234d763cef2SBarry Smith 
235d763cef2SBarry Smith   PetscFunctionBegin;
2360700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2370700a824SBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,3);
2380700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,4);
239d763cef2SBarry Smith 
2403b5f76d0SSean Farley   if (!ts->userops->rhsfunction && !ts->userops->ifunction) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
241d763cef2SBarry Smith 
242d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(TS_FunctionEval,ts,x,y,0);CHKERRQ(ierr);
2433b5f76d0SSean Farley   if (ts->userops->rhsfunction) {
244d763cef2SBarry Smith     PetscStackPush("TS user right-hand-side function");
2453b5f76d0SSean Farley     ierr = (*ts->userops->rhsfunction)(ts,t,x,y,ts->funP);CHKERRQ(ierr);
246d763cef2SBarry Smith     PetscStackPop;
247214bc6a2SJed Brown   } else {
248214bc6a2SJed Brown     ierr = VecZeroEntries(y);CHKERRQ(ierr);
249b2cd27e8SJed Brown   }
25044a41b28SSean Farley 
251d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(TS_FunctionEval,ts,x,y,0);CHKERRQ(ierr);
252d763cef2SBarry Smith   PetscFunctionReturn(0);
253d763cef2SBarry Smith }
254d763cef2SBarry Smith 
2554a2ae208SSatish Balay #undef __FUNCT__
256214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSVec_Private"
257214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs)
258214bc6a2SJed Brown {
2592dd45cf8SJed Brown   Vec            F;
260214bc6a2SJed Brown   PetscErrorCode ierr;
261214bc6a2SJed Brown 
262214bc6a2SJed Brown   PetscFunctionBegin;
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);
830000e7ae3SMatthew Knepley     if (ts->ops->view) {
831b0a32e0cSBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
832000e7ae3SMatthew Knepley       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
833b0a32e0cSBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
834d763cef2SBarry Smith     }
83577431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr);
836a83599f4SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum time=%G\n",ts->max_time);CHKERRQ(ierr);
837d763cef2SBarry Smith     if (ts->problem_type == TS_NONLINEAR) {
83877431f27SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solver iterations=%D\n",ts->nonlinear_its);CHKERRQ(ierr);
839193ac0bcSJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solve failures=%D\n",ts->max_snes_failures);CHKERRQ(ierr);
840d763cef2SBarry Smith     }
84177431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",ts->linear_its);CHKERRQ(ierr);
842193ac0bcSJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr);
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);
849089b2837SJed Brown   if (!isundials && ts->snes) {ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr);}
850b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
851d763cef2SBarry Smith   PetscFunctionReturn(0);
852d763cef2SBarry Smith }
853d763cef2SBarry Smith 
854d763cef2SBarry Smith 
8554a2ae208SSatish Balay #undef __FUNCT__
8564a2ae208SSatish Balay #define __FUNCT__ "TSSetApplicationContext"
857b07ff414SBarry Smith /*@
858d763cef2SBarry Smith    TSSetApplicationContext - Sets an optional user-defined context for
859d763cef2SBarry Smith    the timesteppers.
860d763cef2SBarry Smith 
8613f9fe445SBarry Smith    Logically Collective on TS
862d763cef2SBarry Smith 
863d763cef2SBarry Smith    Input Parameters:
864d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
865d763cef2SBarry Smith -  usrP - optional user context
866d763cef2SBarry Smith 
867d763cef2SBarry Smith    Level: intermediate
868d763cef2SBarry Smith 
869d763cef2SBarry Smith .keywords: TS, timestep, set, application, context
870d763cef2SBarry Smith 
871d763cef2SBarry Smith .seealso: TSGetApplicationContext()
872d763cef2SBarry Smith @*/
8737087cfbeSBarry Smith PetscErrorCode  TSSetApplicationContext(TS ts,void *usrP)
874d763cef2SBarry Smith {
875d763cef2SBarry Smith   PetscFunctionBegin;
8760700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
877d763cef2SBarry Smith   ts->user = usrP;
878d763cef2SBarry Smith   PetscFunctionReturn(0);
879d763cef2SBarry Smith }
880d763cef2SBarry Smith 
8814a2ae208SSatish Balay #undef __FUNCT__
8824a2ae208SSatish Balay #define __FUNCT__ "TSGetApplicationContext"
883b07ff414SBarry Smith /*@
884d763cef2SBarry Smith     TSGetApplicationContext - Gets the user-defined context for the
885d763cef2SBarry Smith     timestepper.
886d763cef2SBarry Smith 
887d763cef2SBarry Smith     Not Collective
888d763cef2SBarry Smith 
889d763cef2SBarry Smith     Input Parameter:
890d763cef2SBarry Smith .   ts - the TS context obtained from TSCreate()
891d763cef2SBarry Smith 
892d763cef2SBarry Smith     Output Parameter:
893d763cef2SBarry Smith .   usrP - user context
894d763cef2SBarry Smith 
895d763cef2SBarry Smith     Level: intermediate
896d763cef2SBarry Smith 
897d763cef2SBarry Smith .keywords: TS, timestep, get, application, context
898d763cef2SBarry Smith 
899d763cef2SBarry Smith .seealso: TSSetApplicationContext()
900d763cef2SBarry Smith @*/
901e71120c6SJed Brown PetscErrorCode  TSGetApplicationContext(TS ts,void *usrP)
902d763cef2SBarry Smith {
903d763cef2SBarry Smith   PetscFunctionBegin;
9040700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
905e71120c6SJed Brown   *(void**)usrP = ts->user;
906d763cef2SBarry Smith   PetscFunctionReturn(0);
907d763cef2SBarry Smith }
908d763cef2SBarry Smith 
9094a2ae208SSatish Balay #undef __FUNCT__
9104a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStepNumber"
911d763cef2SBarry Smith /*@
912d763cef2SBarry Smith    TSGetTimeStepNumber - Gets the current number of timesteps.
913d763cef2SBarry Smith 
914d763cef2SBarry Smith    Not Collective
915d763cef2SBarry Smith 
916d763cef2SBarry Smith    Input Parameter:
917d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
918d763cef2SBarry Smith 
919d763cef2SBarry Smith    Output Parameter:
920d763cef2SBarry Smith .  iter - number steps so far
921d763cef2SBarry Smith 
922d763cef2SBarry Smith    Level: intermediate
923d763cef2SBarry Smith 
924d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number
925d763cef2SBarry Smith @*/
9267087cfbeSBarry Smith PetscErrorCode  TSGetTimeStepNumber(TS ts,PetscInt* iter)
927d763cef2SBarry Smith {
928d763cef2SBarry Smith   PetscFunctionBegin;
9290700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
9304482741eSBarry Smith   PetscValidIntPointer(iter,2);
931d763cef2SBarry Smith   *iter = ts->steps;
932d763cef2SBarry Smith   PetscFunctionReturn(0);
933d763cef2SBarry Smith }
934d763cef2SBarry Smith 
9354a2ae208SSatish Balay #undef __FUNCT__
9364a2ae208SSatish Balay #define __FUNCT__ "TSSetInitialTimeStep"
937d763cef2SBarry Smith /*@
938d763cef2SBarry Smith    TSSetInitialTimeStep - Sets the initial timestep to be used,
939d763cef2SBarry Smith    as well as the initial time.
940d763cef2SBarry Smith 
9413f9fe445SBarry Smith    Logically Collective on TS
942d763cef2SBarry Smith 
943d763cef2SBarry Smith    Input Parameters:
944d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
945d763cef2SBarry Smith .  initial_time - the initial time
946d763cef2SBarry Smith -  time_step - the size of the timestep
947d763cef2SBarry Smith 
948d763cef2SBarry Smith    Level: intermediate
949d763cef2SBarry Smith 
950d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep()
951d763cef2SBarry Smith 
952d763cef2SBarry Smith .keywords: TS, set, initial, timestep
953d763cef2SBarry Smith @*/
9547087cfbeSBarry Smith PetscErrorCode  TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step)
955d763cef2SBarry Smith {
956e144a568SJed Brown   PetscErrorCode ierr;
957e144a568SJed Brown 
958d763cef2SBarry Smith   PetscFunctionBegin;
9590700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
960e144a568SJed Brown   ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
961d763cef2SBarry Smith   ts->initial_time_step = time_step;
962d763cef2SBarry Smith   ts->ptime             = initial_time;
963d763cef2SBarry Smith   PetscFunctionReturn(0);
964d763cef2SBarry Smith }
965d763cef2SBarry Smith 
9664a2ae208SSatish Balay #undef __FUNCT__
9674a2ae208SSatish Balay #define __FUNCT__ "TSSetTimeStep"
968d763cef2SBarry Smith /*@
969d763cef2SBarry Smith    TSSetTimeStep - Allows one to reset the timestep at any time,
970d763cef2SBarry Smith    useful for simple pseudo-timestepping codes.
971d763cef2SBarry Smith 
9723f9fe445SBarry Smith    Logically Collective on TS
973d763cef2SBarry Smith 
974d763cef2SBarry Smith    Input Parameters:
975d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
976d763cef2SBarry Smith -  time_step - the size of the timestep
977d763cef2SBarry Smith 
978d763cef2SBarry Smith    Level: intermediate
979d763cef2SBarry Smith 
980d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
981d763cef2SBarry Smith 
982d763cef2SBarry Smith .keywords: TS, set, timestep
983d763cef2SBarry Smith @*/
9847087cfbeSBarry Smith PetscErrorCode  TSSetTimeStep(TS ts,PetscReal time_step)
985d763cef2SBarry Smith {
986d763cef2SBarry Smith   PetscFunctionBegin;
9870700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
988c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,time_step,2);
989d763cef2SBarry Smith   ts->time_step      = time_step;
990193ac0bcSJed Brown   ts->next_time_step = time_step;
991d763cef2SBarry Smith   PetscFunctionReturn(0);
992d763cef2SBarry Smith }
993d763cef2SBarry Smith 
9944a2ae208SSatish Balay #undef __FUNCT__
995a43b19c4SJed Brown #define __FUNCT__ "TSSetExactFinalTime"
996a43b19c4SJed Brown /*@
997a43b19c4SJed Brown    TSSetExactFinalTime - Determines whether to interpolate solution to the
998a43b19c4SJed Brown       exact final time requested by the user or just returns it at the final time
999a43b19c4SJed Brown       it computed.
1000a43b19c4SJed Brown 
1001a43b19c4SJed Brown   Logically Collective on TS
1002a43b19c4SJed Brown 
1003a43b19c4SJed Brown    Input Parameter:
1004a43b19c4SJed Brown +   ts - the time-step context
1005a43b19c4SJed Brown -   ft - PETSC_TRUE if interpolates, else PETSC_FALSE
1006a43b19c4SJed Brown 
1007a43b19c4SJed Brown    Level: beginner
1008a43b19c4SJed Brown 
1009a43b19c4SJed Brown .seealso: TSSetDuration()
1010a43b19c4SJed Brown @*/
1011a43b19c4SJed Brown PetscErrorCode  TSSetExactFinalTime(TS ts,PetscBool flg)
1012a43b19c4SJed Brown {
1013a43b19c4SJed Brown 
1014a43b19c4SJed Brown   PetscFunctionBegin;
1015a43b19c4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1016a43b19c4SJed Brown   ts->exact_final_time = flg;
1017a43b19c4SJed Brown   PetscFunctionReturn(0);
1018a43b19c4SJed Brown }
1019a43b19c4SJed Brown 
1020a43b19c4SJed Brown #undef __FUNCT__
10214a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStep"
1022d763cef2SBarry Smith /*@
1023d763cef2SBarry Smith    TSGetTimeStep - Gets the current timestep size.
1024d763cef2SBarry Smith 
1025d763cef2SBarry Smith    Not Collective
1026d763cef2SBarry Smith 
1027d763cef2SBarry Smith    Input Parameter:
1028d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1029d763cef2SBarry Smith 
1030d763cef2SBarry Smith    Output Parameter:
1031d763cef2SBarry Smith .  dt - the current timestep size
1032d763cef2SBarry Smith 
1033d763cef2SBarry Smith    Level: intermediate
1034d763cef2SBarry Smith 
1035d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
1036d763cef2SBarry Smith 
1037d763cef2SBarry Smith .keywords: TS, get, timestep
1038d763cef2SBarry Smith @*/
10397087cfbeSBarry Smith PetscErrorCode  TSGetTimeStep(TS ts,PetscReal* dt)
1040d763cef2SBarry Smith {
1041d763cef2SBarry Smith   PetscFunctionBegin;
10420700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
10434482741eSBarry Smith   PetscValidDoublePointer(dt,2);
1044d763cef2SBarry Smith   *dt = ts->time_step;
1045d763cef2SBarry Smith   PetscFunctionReturn(0);
1046d763cef2SBarry Smith }
1047d763cef2SBarry Smith 
10484a2ae208SSatish Balay #undef __FUNCT__
10494a2ae208SSatish Balay #define __FUNCT__ "TSGetSolution"
1050d8e5e3e6SSatish Balay /*@
1051d763cef2SBarry Smith    TSGetSolution - Returns the solution at the present timestep. It
1052d763cef2SBarry Smith    is valid to call this routine inside the function that you are evaluating
1053d763cef2SBarry Smith    in order to move to the new timestep. This vector not changed until
1054d763cef2SBarry Smith    the solution at the next timestep has been calculated.
1055d763cef2SBarry Smith 
1056d763cef2SBarry Smith    Not Collective, but Vec returned is parallel if TS is parallel
1057d763cef2SBarry Smith 
1058d763cef2SBarry Smith    Input Parameter:
1059d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1060d763cef2SBarry Smith 
1061d763cef2SBarry Smith    Output Parameter:
1062d763cef2SBarry Smith .  v - the vector containing the solution
1063d763cef2SBarry Smith 
1064d763cef2SBarry Smith    Level: intermediate
1065d763cef2SBarry Smith 
1066d763cef2SBarry Smith .seealso: TSGetTimeStep()
1067d763cef2SBarry Smith 
1068d763cef2SBarry Smith .keywords: TS, timestep, get, solution
1069d763cef2SBarry Smith @*/
10707087cfbeSBarry Smith PetscErrorCode  TSGetSolution(TS ts,Vec *v)
1071d763cef2SBarry Smith {
1072d763cef2SBarry Smith   PetscFunctionBegin;
10730700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
10744482741eSBarry Smith   PetscValidPointer(v,2);
10758737fe31SLisandro Dalcin   *v = ts->vec_sol;
1076d763cef2SBarry Smith   PetscFunctionReturn(0);
1077d763cef2SBarry Smith }
1078d763cef2SBarry Smith 
1079bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */
10804a2ae208SSatish Balay #undef __FUNCT__
1081bdad233fSMatthew Knepley #define __FUNCT__ "TSSetProblemType"
1082d8e5e3e6SSatish Balay /*@
1083bdad233fSMatthew Knepley   TSSetProblemType - Sets the type of problem to be solved.
1084d763cef2SBarry Smith 
1085bdad233fSMatthew Knepley   Not collective
1086d763cef2SBarry Smith 
1087bdad233fSMatthew Knepley   Input Parameters:
1088bdad233fSMatthew Knepley + ts   - The TS
1089bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1090d763cef2SBarry Smith .vb
1091d763cef2SBarry Smith          U_t = A U
1092d763cef2SBarry Smith          U_t = A(t) U
1093d763cef2SBarry Smith          U_t = F(t,U)
1094d763cef2SBarry Smith .ve
1095d763cef2SBarry Smith 
1096d763cef2SBarry Smith    Level: beginner
1097d763cef2SBarry Smith 
1098bdad233fSMatthew Knepley .keywords: TS, problem type
1099bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
1100d763cef2SBarry Smith @*/
11017087cfbeSBarry Smith PetscErrorCode  TSSetProblemType(TS ts, TSProblemType type)
1102a7cc72afSBarry Smith {
11039e2a6581SJed Brown   PetscErrorCode ierr;
11049e2a6581SJed Brown 
1105d763cef2SBarry Smith   PetscFunctionBegin;
11060700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1107bdad233fSMatthew Knepley   ts->problem_type = type;
11089e2a6581SJed Brown   if (type == TS_LINEAR) {
11099e2a6581SJed Brown     SNES snes;
11109e2a6581SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
11119e2a6581SJed Brown     ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);
11129e2a6581SJed Brown   }
1113d763cef2SBarry Smith   PetscFunctionReturn(0);
1114d763cef2SBarry Smith }
1115d763cef2SBarry Smith 
1116bdad233fSMatthew Knepley #undef __FUNCT__
1117bdad233fSMatthew Knepley #define __FUNCT__ "TSGetProblemType"
1118bdad233fSMatthew Knepley /*@C
1119bdad233fSMatthew Knepley   TSGetProblemType - Gets the type of problem to be solved.
1120bdad233fSMatthew Knepley 
1121bdad233fSMatthew Knepley   Not collective
1122bdad233fSMatthew Knepley 
1123bdad233fSMatthew Knepley   Input Parameter:
1124bdad233fSMatthew Knepley . ts   - The TS
1125bdad233fSMatthew Knepley 
1126bdad233fSMatthew Knepley   Output Parameter:
1127bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1128bdad233fSMatthew Knepley .vb
1129089b2837SJed Brown          M U_t = A U
1130089b2837SJed Brown          M(t) U_t = A(t) U
1131bdad233fSMatthew Knepley          U_t = F(t,U)
1132bdad233fSMatthew Knepley .ve
1133bdad233fSMatthew Knepley 
1134bdad233fSMatthew Knepley    Level: beginner
1135bdad233fSMatthew Knepley 
1136bdad233fSMatthew Knepley .keywords: TS, problem type
1137bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
1138bdad233fSMatthew Knepley @*/
11397087cfbeSBarry Smith PetscErrorCode  TSGetProblemType(TS ts, TSProblemType *type)
1140a7cc72afSBarry Smith {
1141bdad233fSMatthew Knepley   PetscFunctionBegin;
11420700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
11434482741eSBarry Smith   PetscValidIntPointer(type,2);
1144bdad233fSMatthew Knepley   *type = ts->problem_type;
1145bdad233fSMatthew Knepley   PetscFunctionReturn(0);
1146bdad233fSMatthew Knepley }
1147d763cef2SBarry Smith 
11484a2ae208SSatish Balay #undef __FUNCT__
11494a2ae208SSatish Balay #define __FUNCT__ "TSSetUp"
1150d763cef2SBarry Smith /*@
1151d763cef2SBarry Smith    TSSetUp - Sets up the internal data structures for the later use
1152d763cef2SBarry Smith    of a timestepper.
1153d763cef2SBarry Smith 
1154d763cef2SBarry Smith    Collective on TS
1155d763cef2SBarry Smith 
1156d763cef2SBarry Smith    Input Parameter:
1157d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1158d763cef2SBarry Smith 
1159d763cef2SBarry Smith    Notes:
1160d763cef2SBarry Smith    For basic use of the TS solvers the user need not explicitly call
1161d763cef2SBarry Smith    TSSetUp(), since these actions will automatically occur during
1162d763cef2SBarry Smith    the call to TSStep().  However, if one wishes to control this
1163d763cef2SBarry Smith    phase separately, TSSetUp() should be called after TSCreate()
1164d763cef2SBarry Smith    and optional routines of the form TSSetXXX(), but before TSStep().
1165d763cef2SBarry Smith 
1166d763cef2SBarry Smith    Level: advanced
1167d763cef2SBarry Smith 
1168d763cef2SBarry Smith .keywords: TS, timestep, setup
1169d763cef2SBarry Smith 
1170d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy()
1171d763cef2SBarry Smith @*/
11727087cfbeSBarry Smith PetscErrorCode  TSSetUp(TS ts)
1173d763cef2SBarry Smith {
1174dfbe8321SBarry Smith   PetscErrorCode ierr;
1175d763cef2SBarry Smith 
1176d763cef2SBarry Smith   PetscFunctionBegin;
11770700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1178277b19d0SLisandro Dalcin   if (ts->setupcalled) PetscFunctionReturn(0);
1179277b19d0SLisandro Dalcin 
11807adad957SLisandro Dalcin   if (!((PetscObject)ts)->type_name) {
11819596e0b4SJed Brown     ierr = TSSetType(ts,TSEULER);CHKERRQ(ierr);
1182d763cef2SBarry Smith   }
1183a43b19c4SJed Brown   if (ts->exact_final_time == PETSC_DECIDE) ts->exact_final_time = PETSC_FALSE;
1184277b19d0SLisandro Dalcin 
1185277b19d0SLisandro Dalcin   if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first");
1186277b19d0SLisandro Dalcin 
1187277b19d0SLisandro Dalcin   if (ts->ops->setup) {
1188000e7ae3SMatthew Knepley     ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr);
1189277b19d0SLisandro Dalcin   }
1190277b19d0SLisandro Dalcin 
1191277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_TRUE;
1192277b19d0SLisandro Dalcin   PetscFunctionReturn(0);
1193277b19d0SLisandro Dalcin }
1194277b19d0SLisandro Dalcin 
1195277b19d0SLisandro Dalcin #undef __FUNCT__
1196277b19d0SLisandro Dalcin #define __FUNCT__ "TSReset"
1197277b19d0SLisandro Dalcin /*@
1198277b19d0SLisandro Dalcin    TSReset - Resets a TS context and removes any allocated Vecs and Mats.
1199277b19d0SLisandro Dalcin 
1200277b19d0SLisandro Dalcin    Collective on TS
1201277b19d0SLisandro Dalcin 
1202277b19d0SLisandro Dalcin    Input Parameter:
1203277b19d0SLisandro Dalcin .  ts - the TS context obtained from TSCreate()
1204277b19d0SLisandro Dalcin 
1205277b19d0SLisandro Dalcin    Level: beginner
1206277b19d0SLisandro Dalcin 
1207277b19d0SLisandro Dalcin .keywords: TS, timestep, reset
1208277b19d0SLisandro Dalcin 
1209277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy()
1210277b19d0SLisandro Dalcin @*/
1211277b19d0SLisandro Dalcin PetscErrorCode  TSReset(TS ts)
1212277b19d0SLisandro Dalcin {
1213277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1214277b19d0SLisandro Dalcin 
1215277b19d0SLisandro Dalcin   PetscFunctionBegin;
1216277b19d0SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1217277b19d0SLisandro Dalcin   if (ts->ops->reset) {
1218277b19d0SLisandro Dalcin     ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr);
1219277b19d0SLisandro Dalcin   }
1220277b19d0SLisandro Dalcin   if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);}
12214e684422SJed Brown   ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
12224e684422SJed Brown   ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1223214bc6a2SJed Brown   ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr);
12246bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
1225277b19d0SLisandro Dalcin   if (ts->work) {ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr);}
1226277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_FALSE;
1227d763cef2SBarry Smith   PetscFunctionReturn(0);
1228d763cef2SBarry Smith }
1229d763cef2SBarry Smith 
12304a2ae208SSatish Balay #undef __FUNCT__
12314a2ae208SSatish Balay #define __FUNCT__ "TSDestroy"
1232d8e5e3e6SSatish Balay /*@
1233d763cef2SBarry Smith    TSDestroy - Destroys the timestepper context that was created
1234d763cef2SBarry Smith    with TSCreate().
1235d763cef2SBarry Smith 
1236d763cef2SBarry Smith    Collective on TS
1237d763cef2SBarry Smith 
1238d763cef2SBarry Smith    Input Parameter:
1239d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1240d763cef2SBarry Smith 
1241d763cef2SBarry Smith    Level: beginner
1242d763cef2SBarry Smith 
1243d763cef2SBarry Smith .keywords: TS, timestepper, destroy
1244d763cef2SBarry Smith 
1245d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve()
1246d763cef2SBarry Smith @*/
12476bf464f9SBarry Smith PetscErrorCode  TSDestroy(TS *ts)
1248d763cef2SBarry Smith {
12496849ba73SBarry Smith   PetscErrorCode ierr;
1250d763cef2SBarry Smith 
1251d763cef2SBarry Smith   PetscFunctionBegin;
12526bf464f9SBarry Smith   if (!*ts) PetscFunctionReturn(0);
12536bf464f9SBarry Smith   PetscValidHeaderSpecific((*ts),TS_CLASSID,1);
12546bf464f9SBarry Smith   if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);}
1255d763cef2SBarry Smith 
12566bf464f9SBarry Smith   ierr = TSReset((*ts));CHKERRQ(ierr);
1257277b19d0SLisandro Dalcin 
1258be0abb6dSBarry Smith   /* if memory was published with AMS then destroy it */
12596bf464f9SBarry Smith   ierr = PetscObjectDepublish((*ts));CHKERRQ(ierr);
12606bf464f9SBarry Smith   if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);}
12616d4c513bSLisandro Dalcin 
12626bf464f9SBarry Smith   ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr);
12636bf464f9SBarry Smith   ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr);
12646bf464f9SBarry Smith   ierr = TSMonitorCancel((*ts));CHKERRQ(ierr);
12656d4c513bSLisandro Dalcin 
12663b5f76d0SSean Farley   ierr = PetscFree((*ts)->userops);
12673b5f76d0SSean Farley 
1268a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr);
1269d763cef2SBarry Smith   PetscFunctionReturn(0);
1270d763cef2SBarry Smith }
1271d763cef2SBarry Smith 
12724a2ae208SSatish Balay #undef __FUNCT__
12734a2ae208SSatish Balay #define __FUNCT__ "TSGetSNES"
1274d8e5e3e6SSatish Balay /*@
1275d763cef2SBarry Smith    TSGetSNES - Returns the SNES (nonlinear solver) associated with
1276d763cef2SBarry Smith    a TS (timestepper) context. Valid only for nonlinear problems.
1277d763cef2SBarry Smith 
1278d763cef2SBarry Smith    Not Collective, but SNES is parallel if TS is parallel
1279d763cef2SBarry Smith 
1280d763cef2SBarry Smith    Input Parameter:
1281d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1282d763cef2SBarry Smith 
1283d763cef2SBarry Smith    Output Parameter:
1284d763cef2SBarry Smith .  snes - the nonlinear solver context
1285d763cef2SBarry Smith 
1286d763cef2SBarry Smith    Notes:
1287d763cef2SBarry Smith    The user can then directly manipulate the SNES context to set various
1288d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
128994b7f48cSBarry Smith    KSP, KSP, and PC contexts as well.
1290d763cef2SBarry Smith 
1291d763cef2SBarry Smith    TSGetSNES() does not work for integrators that do not use SNES; in
1292d763cef2SBarry Smith    this case TSGetSNES() returns PETSC_NULL in snes.
1293d763cef2SBarry Smith 
1294d763cef2SBarry Smith    Level: beginner
1295d763cef2SBarry Smith 
1296d763cef2SBarry Smith .keywords: timestep, get, SNES
1297d763cef2SBarry Smith @*/
12987087cfbeSBarry Smith PetscErrorCode  TSGetSNES(TS ts,SNES *snes)
1299d763cef2SBarry Smith {
1300d372ba47SLisandro Dalcin   PetscErrorCode ierr;
1301d372ba47SLisandro Dalcin 
1302d763cef2SBarry Smith   PetscFunctionBegin;
13030700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
13044482741eSBarry Smith   PetscValidPointer(snes,2);
1305d372ba47SLisandro Dalcin   if (!ts->snes) {
1306d372ba47SLisandro Dalcin     ierr = SNESCreate(((PetscObject)ts)->comm,&ts->snes);CHKERRQ(ierr);
1307d372ba47SLisandro Dalcin     ierr = PetscLogObjectParent(ts,ts->snes);CHKERRQ(ierr);
1308d372ba47SLisandro Dalcin     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr);
13099e2a6581SJed Brown     if (ts->problem_type == TS_LINEAR) {
13109e2a6581SJed Brown       ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);
13119e2a6581SJed Brown     }
1312d372ba47SLisandro Dalcin   }
1313d763cef2SBarry Smith   *snes = ts->snes;
1314d763cef2SBarry Smith   PetscFunctionReturn(0);
1315d763cef2SBarry Smith }
1316d763cef2SBarry Smith 
13174a2ae208SSatish Balay #undef __FUNCT__
131894b7f48cSBarry Smith #define __FUNCT__ "TSGetKSP"
1319d8e5e3e6SSatish Balay /*@
132094b7f48cSBarry Smith    TSGetKSP - Returns the KSP (linear solver) associated with
1321d763cef2SBarry Smith    a TS (timestepper) context.
1322d763cef2SBarry Smith 
132394b7f48cSBarry Smith    Not Collective, but KSP is parallel if TS is parallel
1324d763cef2SBarry Smith 
1325d763cef2SBarry Smith    Input Parameter:
1326d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1327d763cef2SBarry Smith 
1328d763cef2SBarry Smith    Output Parameter:
132994b7f48cSBarry Smith .  ksp - the nonlinear solver context
1330d763cef2SBarry Smith 
1331d763cef2SBarry Smith    Notes:
133294b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
1333d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
1334d763cef2SBarry Smith    KSP and PC contexts as well.
1335d763cef2SBarry Smith 
133694b7f48cSBarry Smith    TSGetKSP() does not work for integrators that do not use KSP;
133794b7f48cSBarry Smith    in this case TSGetKSP() returns PETSC_NULL in ksp.
1338d763cef2SBarry Smith 
1339d763cef2SBarry Smith    Level: beginner
1340d763cef2SBarry Smith 
134194b7f48cSBarry Smith .keywords: timestep, get, KSP
1342d763cef2SBarry Smith @*/
13437087cfbeSBarry Smith PetscErrorCode  TSGetKSP(TS ts,KSP *ksp)
1344d763cef2SBarry Smith {
1345d372ba47SLisandro Dalcin   PetscErrorCode ierr;
1346089b2837SJed Brown   SNES           snes;
1347d372ba47SLisandro Dalcin 
1348d763cef2SBarry Smith   PetscFunctionBegin;
13490700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
13504482741eSBarry Smith   PetscValidPointer(ksp,2);
135117186662SBarry Smith   if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first");
1352e32f2f54SBarry Smith   if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()");
1353089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1354089b2837SJed Brown   ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr);
1355d763cef2SBarry Smith   PetscFunctionReturn(0);
1356d763cef2SBarry Smith }
1357d763cef2SBarry Smith 
1358d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */
1359d763cef2SBarry Smith 
13604a2ae208SSatish Balay #undef __FUNCT__
1361adb62b0dSMatthew Knepley #define __FUNCT__ "TSGetDuration"
1362adb62b0dSMatthew Knepley /*@
1363adb62b0dSMatthew Knepley    TSGetDuration - Gets the maximum number of timesteps to use and
1364adb62b0dSMatthew Knepley    maximum time for iteration.
1365adb62b0dSMatthew Knepley 
13663f9fe445SBarry Smith    Not Collective
1367adb62b0dSMatthew Knepley 
1368adb62b0dSMatthew Knepley    Input Parameters:
1369adb62b0dSMatthew Knepley +  ts       - the TS context obtained from TSCreate()
1370adb62b0dSMatthew Knepley .  maxsteps - maximum number of iterations to use, or PETSC_NULL
1371adb62b0dSMatthew Knepley -  maxtime  - final time to iterate to, or PETSC_NULL
1372adb62b0dSMatthew Knepley 
1373adb62b0dSMatthew Knepley    Level: intermediate
1374adb62b0dSMatthew Knepley 
1375adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time
1376adb62b0dSMatthew Knepley @*/
13777087cfbeSBarry Smith PetscErrorCode  TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
1378adb62b0dSMatthew Knepley {
1379adb62b0dSMatthew Knepley   PetscFunctionBegin;
13800700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1381abc0a331SBarry Smith   if (maxsteps) {
13824482741eSBarry Smith     PetscValidIntPointer(maxsteps,2);
1383adb62b0dSMatthew Knepley     *maxsteps = ts->max_steps;
1384adb62b0dSMatthew Knepley   }
1385abc0a331SBarry Smith   if (maxtime ) {
13864482741eSBarry Smith     PetscValidScalarPointer(maxtime,3);
1387adb62b0dSMatthew Knepley     *maxtime  = ts->max_time;
1388adb62b0dSMatthew Knepley   }
1389adb62b0dSMatthew Knepley   PetscFunctionReturn(0);
1390adb62b0dSMatthew Knepley }
1391adb62b0dSMatthew Knepley 
1392adb62b0dSMatthew Knepley #undef __FUNCT__
13934a2ae208SSatish Balay #define __FUNCT__ "TSSetDuration"
1394d763cef2SBarry Smith /*@
1395d763cef2SBarry Smith    TSSetDuration - Sets the maximum number of timesteps to use and
1396d763cef2SBarry Smith    maximum time for iteration.
1397d763cef2SBarry Smith 
13983f9fe445SBarry Smith    Logically Collective on TS
1399d763cef2SBarry Smith 
1400d763cef2SBarry Smith    Input Parameters:
1401d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1402d763cef2SBarry Smith .  maxsteps - maximum number of iterations to use
1403d763cef2SBarry Smith -  maxtime - final time to iterate to
1404d763cef2SBarry Smith 
1405d763cef2SBarry Smith    Options Database Keys:
1406d763cef2SBarry Smith .  -ts_max_steps <maxsteps> - Sets maxsteps
1407d763cef2SBarry Smith .  -ts_max_time <maxtime> - Sets maxtime
1408d763cef2SBarry Smith 
1409d763cef2SBarry Smith    Notes:
1410d763cef2SBarry Smith    The default maximum number of iterations is 5000. Default time is 5.0
1411d763cef2SBarry Smith 
1412d763cef2SBarry Smith    Level: intermediate
1413d763cef2SBarry Smith 
1414d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations
1415a43b19c4SJed Brown 
1416a43b19c4SJed Brown .seealso: TSSetExactFinalTime()
1417d763cef2SBarry Smith @*/
14187087cfbeSBarry Smith PetscErrorCode  TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
1419d763cef2SBarry Smith {
1420d763cef2SBarry Smith   PetscFunctionBegin;
14210700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1422c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
1423c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,maxtime,2);
142439b7ec4bSSean Farley   if (maxsteps >= 0) ts->max_steps = maxsteps;
142539b7ec4bSSean Farley   if (maxtime != PETSC_DEFAULT) ts->max_time  = maxtime;
1426d763cef2SBarry Smith   PetscFunctionReturn(0);
1427d763cef2SBarry Smith }
1428d763cef2SBarry Smith 
14294a2ae208SSatish Balay #undef __FUNCT__
14304a2ae208SSatish Balay #define __FUNCT__ "TSSetSolution"
1431d763cef2SBarry Smith /*@
1432d763cef2SBarry Smith    TSSetSolution - Sets the initial solution vector
1433d763cef2SBarry Smith    for use by the TS routines.
1434d763cef2SBarry Smith 
14353f9fe445SBarry Smith    Logically Collective on TS and Vec
1436d763cef2SBarry Smith 
1437d763cef2SBarry Smith    Input Parameters:
1438d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1439d763cef2SBarry Smith -  x - the solution vector
1440d763cef2SBarry Smith 
1441d763cef2SBarry Smith    Level: beginner
1442d763cef2SBarry Smith 
1443d763cef2SBarry Smith .keywords: TS, timestep, set, solution, initial conditions
1444d763cef2SBarry Smith @*/
14457087cfbeSBarry Smith PetscErrorCode  TSSetSolution(TS ts,Vec x)
1446d763cef2SBarry Smith {
14478737fe31SLisandro Dalcin   PetscErrorCode ierr;
14488737fe31SLisandro Dalcin 
1449d763cef2SBarry Smith   PetscFunctionBegin;
14500700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
14510700a824SBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
14528737fe31SLisandro Dalcin   ierr = PetscObjectReference((PetscObject)x);CHKERRQ(ierr);
14536bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
14548737fe31SLisandro Dalcin   ts->vec_sol = x;
1455d763cef2SBarry Smith   PetscFunctionReturn(0);
1456d763cef2SBarry Smith }
1457d763cef2SBarry Smith 
1458e74ef692SMatthew Knepley #undef __FUNCT__
1459e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPreStep"
1460ac226902SBarry Smith /*@C
1461000e7ae3SMatthew Knepley   TSSetPreStep - Sets the general-purpose function
14623f2090d5SJed Brown   called once at the beginning of each time step.
1463000e7ae3SMatthew Knepley 
14643f9fe445SBarry Smith   Logically Collective on TS
1465000e7ae3SMatthew Knepley 
1466000e7ae3SMatthew Knepley   Input Parameters:
1467000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
1468000e7ae3SMatthew Knepley - func - The function
1469000e7ae3SMatthew Knepley 
1470000e7ae3SMatthew Knepley   Calling sequence of func:
1471000e7ae3SMatthew Knepley . func (TS ts);
1472000e7ae3SMatthew Knepley 
1473000e7ae3SMatthew Knepley   Level: intermediate
1474000e7ae3SMatthew Knepley 
1475000e7ae3SMatthew Knepley .keywords: TS, timestep
1476000e7ae3SMatthew Knepley @*/
14777087cfbeSBarry Smith PetscErrorCode  TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
1478000e7ae3SMatthew Knepley {
1479000e7ae3SMatthew Knepley   PetscFunctionBegin;
14800700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1481000e7ae3SMatthew Knepley   ts->ops->prestep = func;
1482000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
1483000e7ae3SMatthew Knepley }
1484000e7ae3SMatthew Knepley 
1485e74ef692SMatthew Knepley #undef __FUNCT__
14863f2090d5SJed Brown #define __FUNCT__ "TSPreStep"
14873f2090d5SJed Brown /*@C
14883f2090d5SJed Brown   TSPreStep - Runs the user-defined pre-step function.
14893f2090d5SJed Brown 
14903f2090d5SJed Brown   Collective on TS
14913f2090d5SJed Brown 
14923f2090d5SJed Brown   Input Parameters:
14933f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
14943f2090d5SJed Brown 
14953f2090d5SJed Brown   Notes:
14963f2090d5SJed Brown   TSPreStep() is typically used within time stepping implementations,
14973f2090d5SJed Brown   so most users would not generally call this routine themselves.
14983f2090d5SJed Brown 
14993f2090d5SJed Brown   Level: developer
15003f2090d5SJed Brown 
15013f2090d5SJed Brown .keywords: TS, timestep
15023f2090d5SJed Brown @*/
15037087cfbeSBarry Smith PetscErrorCode  TSPreStep(TS ts)
15043f2090d5SJed Brown {
15053f2090d5SJed Brown   PetscErrorCode ierr;
15063f2090d5SJed Brown 
15073f2090d5SJed Brown   PetscFunctionBegin;
15080700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
150972ac3e02SJed Brown   if (ts->ops->prestep) {
15103f2090d5SJed Brown     PetscStackPush("TS PreStep function");
15113f2090d5SJed Brown     ierr = (*ts->ops->prestep)(ts);CHKERRQ(ierr);
15123f2090d5SJed Brown     PetscStackPop;
1513312ce896SJed Brown   }
15143f2090d5SJed Brown   PetscFunctionReturn(0);
15153f2090d5SJed Brown }
15163f2090d5SJed Brown 
15173f2090d5SJed Brown #undef __FUNCT__
1518e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPostStep"
1519ac226902SBarry Smith /*@C
1520000e7ae3SMatthew Knepley   TSSetPostStep - Sets the general-purpose function
15213f2090d5SJed Brown   called once at the end of each time step.
1522000e7ae3SMatthew Knepley 
15233f9fe445SBarry Smith   Logically Collective on TS
1524000e7ae3SMatthew Knepley 
1525000e7ae3SMatthew Knepley   Input Parameters:
1526000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
1527000e7ae3SMatthew Knepley - func - The function
1528000e7ae3SMatthew Knepley 
1529000e7ae3SMatthew Knepley   Calling sequence of func:
1530000e7ae3SMatthew Knepley . func (TS ts);
1531000e7ae3SMatthew Knepley 
1532000e7ae3SMatthew Knepley   Level: intermediate
1533000e7ae3SMatthew Knepley 
1534000e7ae3SMatthew Knepley .keywords: TS, timestep
1535000e7ae3SMatthew Knepley @*/
15367087cfbeSBarry Smith PetscErrorCode  TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
1537000e7ae3SMatthew Knepley {
1538000e7ae3SMatthew Knepley   PetscFunctionBegin;
15390700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1540000e7ae3SMatthew Knepley   ts->ops->poststep = func;
1541000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
1542000e7ae3SMatthew Knepley }
1543000e7ae3SMatthew Knepley 
1544e74ef692SMatthew Knepley #undef __FUNCT__
15453f2090d5SJed Brown #define __FUNCT__ "TSPostStep"
15463f2090d5SJed Brown /*@C
15473f2090d5SJed Brown   TSPostStep - Runs the user-defined post-step function.
15483f2090d5SJed Brown 
15493f2090d5SJed Brown   Collective on TS
15503f2090d5SJed Brown 
15513f2090d5SJed Brown   Input Parameters:
15523f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
15533f2090d5SJed Brown 
15543f2090d5SJed Brown   Notes:
15553f2090d5SJed Brown   TSPostStep() is typically used within time stepping implementations,
15563f2090d5SJed Brown   so most users would not generally call this routine themselves.
15573f2090d5SJed Brown 
15583f2090d5SJed Brown   Level: developer
15593f2090d5SJed Brown 
15603f2090d5SJed Brown .keywords: TS, timestep
15613f2090d5SJed Brown @*/
15627087cfbeSBarry Smith PetscErrorCode  TSPostStep(TS ts)
15633f2090d5SJed Brown {
15643f2090d5SJed Brown   PetscErrorCode ierr;
15653f2090d5SJed Brown 
15663f2090d5SJed Brown   PetscFunctionBegin;
15670700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
156872ac3e02SJed Brown   if (ts->ops->poststep) {
15693f2090d5SJed Brown     PetscStackPush("TS PostStep function");
15703f2090d5SJed Brown     ierr = (*ts->ops->poststep)(ts);CHKERRQ(ierr);
15713f2090d5SJed Brown     PetscStackPop;
157272ac3e02SJed Brown   }
15733f2090d5SJed Brown   PetscFunctionReturn(0);
15743f2090d5SJed Brown }
15753f2090d5SJed Brown 
1576d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
1577d763cef2SBarry Smith 
15784a2ae208SSatish Balay #undef __FUNCT__
1579a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSet"
1580d763cef2SBarry Smith /*@C
1581a6570f20SBarry Smith    TSMonitorSet - Sets an ADDITIONAL function that is to be used at every
1582d763cef2SBarry Smith    timestep to display the iteration's  progress.
1583d763cef2SBarry Smith 
15843f9fe445SBarry Smith    Logically Collective on TS
1585d763cef2SBarry Smith 
1586d763cef2SBarry Smith    Input Parameters:
1587d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1588d763cef2SBarry Smith .  func - monitoring routine
1589329f5518SBarry Smith .  mctx - [optional] user-defined context for private data for the
1590b3006f0bSLois Curfman McInnes              monitor routine (use PETSC_NULL if no context is desired)
1591b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
1592b3006f0bSLois Curfman McInnes           (may be PETSC_NULL)
1593d763cef2SBarry Smith 
1594d763cef2SBarry Smith    Calling sequence of func:
1595a7cc72afSBarry Smith $    int func(TS ts,PetscInt steps,PetscReal time,Vec x,void *mctx)
1596d763cef2SBarry Smith 
1597d763cef2SBarry Smith +    ts - the TS context
1598d763cef2SBarry Smith .    steps - iteration number
15991f06c33eSBarry Smith .    time - current time
1600d763cef2SBarry Smith .    x - current iterate
1601d763cef2SBarry Smith -    mctx - [optional] monitoring context
1602d763cef2SBarry Smith 
1603d763cef2SBarry Smith    Notes:
1604d763cef2SBarry Smith    This routine adds an additional monitor to the list of monitors that
1605d763cef2SBarry Smith    already has been loaded.
1606d763cef2SBarry Smith 
1607025f1a04SBarry Smith    Fortran notes: Only a single monitor function can be set for each TS object
1608025f1a04SBarry Smith 
1609d763cef2SBarry Smith    Level: intermediate
1610d763cef2SBarry Smith 
1611d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
1612d763cef2SBarry Smith 
1613a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel()
1614d763cef2SBarry Smith @*/
1615c2efdce3SBarry Smith PetscErrorCode  TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**))
1616d763cef2SBarry Smith {
1617d763cef2SBarry Smith   PetscFunctionBegin;
16180700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
161917186662SBarry Smith   if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
1620d763cef2SBarry Smith   ts->monitor[ts->numbermonitors]           = monitor;
1621329f5518SBarry Smith   ts->mdestroy[ts->numbermonitors]          = mdestroy;
1622d763cef2SBarry Smith   ts->monitorcontext[ts->numbermonitors++]  = (void*)mctx;
1623d763cef2SBarry Smith   PetscFunctionReturn(0);
1624d763cef2SBarry Smith }
1625d763cef2SBarry Smith 
16264a2ae208SSatish Balay #undef __FUNCT__
1627a6570f20SBarry Smith #define __FUNCT__ "TSMonitorCancel"
1628d763cef2SBarry Smith /*@C
1629a6570f20SBarry Smith    TSMonitorCancel - Clears all the monitors that have been set on a time-step object.
1630d763cef2SBarry Smith 
16313f9fe445SBarry Smith    Logically Collective on TS
1632d763cef2SBarry Smith 
1633d763cef2SBarry Smith    Input Parameters:
1634d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1635d763cef2SBarry Smith 
1636d763cef2SBarry Smith    Notes:
1637d763cef2SBarry Smith    There is no way to remove a single, specific monitor.
1638d763cef2SBarry Smith 
1639d763cef2SBarry Smith    Level: intermediate
1640d763cef2SBarry Smith 
1641d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
1642d763cef2SBarry Smith 
1643a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet()
1644d763cef2SBarry Smith @*/
16457087cfbeSBarry Smith PetscErrorCode  TSMonitorCancel(TS ts)
1646d763cef2SBarry Smith {
1647d952e501SBarry Smith   PetscErrorCode ierr;
1648d952e501SBarry Smith   PetscInt       i;
1649d952e501SBarry Smith 
1650d763cef2SBarry Smith   PetscFunctionBegin;
16510700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1652d952e501SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
1653d952e501SBarry Smith     if (ts->mdestroy[i]) {
16543c4aec1bSBarry Smith       ierr = (*ts->mdestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr);
1655d952e501SBarry Smith     }
1656d952e501SBarry Smith   }
1657d763cef2SBarry Smith   ts->numbermonitors = 0;
1658d763cef2SBarry Smith   PetscFunctionReturn(0);
1659d763cef2SBarry Smith }
1660d763cef2SBarry Smith 
16614a2ae208SSatish Balay #undef __FUNCT__
1662a6570f20SBarry Smith #define __FUNCT__ "TSMonitorDefault"
1663d8e5e3e6SSatish Balay /*@
1664a6570f20SBarry Smith    TSMonitorDefault - Sets the Default monitor
16655516499fSSatish Balay 
16665516499fSSatish Balay    Level: intermediate
166741251cbbSSatish Balay 
16685516499fSSatish Balay .keywords: TS, set, monitor
16695516499fSSatish Balay 
167041251cbbSSatish Balay .seealso: TSMonitorDefault(), TSMonitorSet()
167141251cbbSSatish Balay @*/
1672649052a6SBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,void *dummy)
1673d763cef2SBarry Smith {
1674dfbe8321SBarry Smith   PetscErrorCode ierr;
1675649052a6SBarry Smith   PetscViewer    viewer = dummy ? (PetscViewer) dummy : PETSC_VIEWER_STDOUT_(((PetscObject)ts)->comm);
1676d132466eSBarry Smith 
1677d763cef2SBarry Smith   PetscFunctionBegin;
1678649052a6SBarry Smith   ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
1679649052a6SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %G time %G\n",step,ts->time_step,ptime);CHKERRQ(ierr);
1680649052a6SBarry Smith   ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
1681d763cef2SBarry Smith   PetscFunctionReturn(0);
1682d763cef2SBarry Smith }
1683d763cef2SBarry Smith 
16844a2ae208SSatish Balay #undef __FUNCT__
1685cd652676SJed Brown #define __FUNCT__ "TSSetRetainStages"
1686cd652676SJed Brown /*@
1687cd652676SJed Brown    TSSetRetainStages - Request that all stages in the upcoming step be stored so that interpolation will be available.
1688cd652676SJed Brown 
1689cd652676SJed Brown    Logically Collective on TS
1690cd652676SJed Brown 
1691cd652676SJed Brown    Input Argument:
1692cd652676SJed Brown .  ts - time stepping context
1693cd652676SJed Brown 
1694cd652676SJed Brown    Output Argument:
1695cd652676SJed Brown .  flg - PETSC_TRUE or PETSC_FALSE
1696cd652676SJed Brown 
1697cd652676SJed Brown    Level: intermediate
1698cd652676SJed Brown 
1699cd652676SJed Brown .keywords: TS, set
1700cd652676SJed Brown 
1701cd652676SJed Brown .seealso: TSInterpolate(), TSSetPostStep()
1702cd652676SJed Brown @*/
1703cd652676SJed Brown PetscErrorCode TSSetRetainStages(TS ts,PetscBool flg)
1704cd652676SJed Brown {
1705cd652676SJed Brown 
1706cd652676SJed Brown   PetscFunctionBegin;
1707cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1708cd652676SJed Brown   ts->retain_stages = flg;
1709cd652676SJed Brown   PetscFunctionReturn(0);
1710cd652676SJed Brown }
1711cd652676SJed Brown 
1712cd652676SJed Brown #undef __FUNCT__
1713cd652676SJed Brown #define __FUNCT__ "TSInterpolate"
1714cd652676SJed Brown /*@
1715cd652676SJed Brown    TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
1716cd652676SJed Brown 
1717cd652676SJed Brown    Collective on TS
1718cd652676SJed Brown 
1719cd652676SJed Brown    Input Argument:
1720cd652676SJed Brown +  ts - time stepping context
1721cd652676SJed Brown -  t - time to interpolate to
1722cd652676SJed Brown 
1723cd652676SJed Brown    Output Argument:
1724cd652676SJed Brown .  X - state at given time
1725cd652676SJed Brown 
1726cd652676SJed Brown    Notes:
1727cd652676SJed Brown    The user should call TSSetRetainStages() before taking a step in which interpolation will be requested.
1728cd652676SJed Brown 
1729cd652676SJed Brown    Level: intermediate
1730cd652676SJed Brown 
1731cd652676SJed Brown    Developer Notes:
1732cd652676SJed Brown    TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
1733cd652676SJed Brown 
1734cd652676SJed Brown .keywords: TS, set
1735cd652676SJed Brown 
1736cd652676SJed Brown .seealso: TSSetRetainStages(), TSSetPostStep()
1737cd652676SJed Brown @*/
1738cd652676SJed Brown PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec X)
1739cd652676SJed Brown {
1740cd652676SJed Brown   PetscErrorCode ierr;
1741cd652676SJed Brown 
1742cd652676SJed Brown   PetscFunctionBegin;
1743cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1744cd652676SJed Brown   if (t < ts->ptime - ts->time_step || ts->ptime < t) SETERRQ3(((PetscObject)ts)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Requested time %G not in last time steps [%G,%G]",t,ts->ptime-ts->time_step,ts->ptime);
1745cd652676SJed Brown   if (!ts->ops->interpolate) SETERRQ1(((PetscObject)ts)->comm,PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
1746cd652676SJed Brown   ierr = (*ts->ops->interpolate)(ts,t,X);CHKERRQ(ierr);
1747cd652676SJed Brown   PetscFunctionReturn(0);
1748cd652676SJed Brown }
1749cd652676SJed Brown 
1750cd652676SJed Brown #undef __FUNCT__
17514a2ae208SSatish Balay #define __FUNCT__ "TSStep"
1752d763cef2SBarry Smith /*@
1753d763cef2SBarry Smith    TSStep - Steps the requested number of timesteps.
1754d763cef2SBarry Smith 
1755d763cef2SBarry Smith    Collective on TS
1756d763cef2SBarry Smith 
1757d763cef2SBarry Smith    Input Parameter:
1758d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1759d763cef2SBarry Smith 
1760d763cef2SBarry Smith    Output Parameters:
1761d763cef2SBarry Smith +  steps - number of iterations until termination
1762142b95e3SSatish Balay -  ptime - time until termination
1763d763cef2SBarry Smith 
1764d763cef2SBarry Smith    Level: beginner
1765d763cef2SBarry Smith 
1766d763cef2SBarry Smith .keywords: TS, timestep, solve
1767d763cef2SBarry Smith 
1768d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSDestroy()
1769d763cef2SBarry Smith @*/
1770193ac0bcSJed Brown PetscErrorCode  TSStep(TS ts)
1771d763cef2SBarry Smith {
1772dfbe8321SBarry Smith   PetscErrorCode ierr;
1773d763cef2SBarry Smith 
1774d763cef2SBarry Smith   PetscFunctionBegin;
17750700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1776277b19d0SLisandro Dalcin 
1777d405a339SMatthew Knepley   ierr = TSSetUp(ts);CHKERRQ(ierr);
1778d405a339SMatthew Knepley 
1779d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(TS_Step, ts, 0, 0, 0);CHKERRQ(ierr);
1780193ac0bcSJed Brown   ierr = (*ts->ops->step)(ts);CHKERRQ(ierr);
1781d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(TS_Step, ts, 0, 0, 0);CHKERRQ(ierr);
1782d763cef2SBarry Smith   PetscFunctionReturn(0);
1783d763cef2SBarry Smith }
1784d763cef2SBarry Smith 
17854a2ae208SSatish Balay #undef __FUNCT__
17866a4d4014SLisandro Dalcin #define __FUNCT__ "TSSolve"
17876a4d4014SLisandro Dalcin /*@
17886a4d4014SLisandro Dalcin    TSSolve - Steps the requested number of timesteps.
17896a4d4014SLisandro Dalcin 
17906a4d4014SLisandro Dalcin    Collective on TS
17916a4d4014SLisandro Dalcin 
17926a4d4014SLisandro Dalcin    Input Parameter:
17936a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
17946a4d4014SLisandro Dalcin -  x - the solution vector, or PETSC_NULL if it was set with TSSetSolution()
17956a4d4014SLisandro Dalcin 
1796*5a3a76d0SJed Brown    Output Parameter:
1797*5a3a76d0SJed Brown .  ftime - time of the state vector x upon completion
1798*5a3a76d0SJed Brown 
17996a4d4014SLisandro Dalcin    Level: beginner
18006a4d4014SLisandro Dalcin 
1801*5a3a76d0SJed Brown    Notes:
1802*5a3a76d0SJed Brown    The final time returned by this function may be different from the time of the internally
1803*5a3a76d0SJed Brown    held state accessible by TSGetSolution() and TSGetTime() because the method may have
1804*5a3a76d0SJed Brown    stepped over the final time.
1805*5a3a76d0SJed Brown 
18066a4d4014SLisandro Dalcin .keywords: TS, timestep, solve
18076a4d4014SLisandro Dalcin 
18086a4d4014SLisandro Dalcin .seealso: TSCreate(), TSSetSolution(), TSStep()
18096a4d4014SLisandro Dalcin @*/
1810*5a3a76d0SJed Brown PetscErrorCode TSSolve(TS ts,Vec x,PetscReal *ftime)
18116a4d4014SLisandro Dalcin {
1812193ac0bcSJed Brown   PetscInt       i;
18134d7d938eSLisandro Dalcin   PetscBool      flg;
18144d7d938eSLisandro Dalcin   char           filename[PETSC_MAX_PATH_LEN];
18154d7d938eSLisandro Dalcin   PetscViewer    viewer;
18166a4d4014SLisandro Dalcin   PetscErrorCode ierr;
1817f22f69f0SBarry Smith 
18186a4d4014SLisandro Dalcin   PetscFunctionBegin;
18190700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1820193ac0bcSJed Brown   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
1821*5a3a76d0SJed Brown   if (ts->exact_final_time) {   /* Need ts->vec_sol to be distinct so it is not overwritten when we interpolate at the end */
1822*5a3a76d0SJed Brown     if (!ts->vec_sol || x == ts->vec_sol) {
1823*5a3a76d0SJed Brown       Vec y;
1824*5a3a76d0SJed Brown       ierr = VecDuplicate(x,&y);CHKERRQ(ierr);
1825*5a3a76d0SJed Brown       ierr = VecCopy(x,y);CHKERRQ(ierr);
1826*5a3a76d0SJed Brown       ierr = TSSetSolution(ts,y);CHKERRQ(ierr);
1827*5a3a76d0SJed Brown       ierr = VecDestroy(&y);CHKERRQ(ierr); /* grant ownership */
1828*5a3a76d0SJed Brown     } else {
1829*5a3a76d0SJed Brown       ierr = VecCopy(x,ts->vec_sol);CHKERRQ(ierr);
1830*5a3a76d0SJed Brown     }
1831*5a3a76d0SJed Brown   } else {
1832193ac0bcSJed Brown     ierr = TSSetSolution(ts,x);CHKERRQ(ierr);
1833*5a3a76d0SJed Brown   }
1834b5d403baSSean Farley   ierr = TSSetUp(ts);CHKERRQ(ierr);
18356a4d4014SLisandro Dalcin   /* reset time step and iteration counters */
1836193ac0bcSJed Brown   ts->steps = 0;
1837193ac0bcSJed Brown   ts->linear_its = 0;
1838193ac0bcSJed Brown   ts->nonlinear_its = 0;
1839193ac0bcSJed Brown   ts->reason = TS_CONVERGED_ITERATING;
1840193ac0bcSJed Brown   ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
1841193ac0bcSJed Brown 
1842193ac0bcSJed Brown   if (ts->ops->solve) {         /* This private interface is transitional and should be removed when all implementations are updated. */
1843193ac0bcSJed Brown     ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr);
1844*5a3a76d0SJed Brown     ierr = VecCopy(ts->vec_sol,x);CHKERRQ(ierr);
1845*5a3a76d0SJed Brown     if (*ftime) *ftime = ts->ptime;
1846193ac0bcSJed Brown   } else {
1847e1a7a14fSJed Brown     i = 0;
1848e1a7a14fSJed Brown     if (i >= ts->max_steps) ts->reason = TS_CONVERGED_ITS;
1849e1a7a14fSJed Brown     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
18506a4d4014SLisandro Dalcin     /* steps the requested number of timesteps. */
1851e1a7a14fSJed Brown     while (!ts->reason) {
1852193ac0bcSJed Brown       ierr = TSPreStep(ts);CHKERRQ(ierr);
1853193ac0bcSJed Brown       ierr = TSStep(ts);CHKERRQ(ierr);
1854193ac0bcSJed Brown       if (ts->reason < 0) {
1855193ac0bcSJed Brown         if (ts->errorifstepfailed) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_NOT_CONVERGED,"TSStep has failed");
18563daf2de8SJed Brown       } else if (++i >= ts->max_steps) {
1857193ac0bcSJed Brown         ts->reason = TS_CONVERGED_ITS;
1858193ac0bcSJed Brown       } else if (ts->ptime >= ts->max_time) {
1859193ac0bcSJed Brown         ts->reason = TS_CONVERGED_TIME;
1860193ac0bcSJed Brown       }
1861193ac0bcSJed Brown       ierr = TSPostStep(ts);CHKERRQ(ierr);
1862193ac0bcSJed Brown       ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
1863193ac0bcSJed Brown     }
1864a43b19c4SJed Brown     if (ts->ptime >= ts->max_time) {
1865a43b19c4SJed Brown       ierr = TSInterpolate(ts,ts->max_time,x);CHKERRQ(ierr);
1866*5a3a76d0SJed Brown       if (ftime) *ftime = ts->max_time;
1867*5a3a76d0SJed Brown     } else if (ftime) *ftime = ts->ptime;
1868193ac0bcSJed Brown   }
18694d7d938eSLisandro Dalcin   ierr = PetscOptionsGetString(((PetscObject)ts)->prefix,"-ts_view",filename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
18704d7d938eSLisandro Dalcin   if (flg && !PetscPreLoadingOn) {
18714d7d938eSLisandro Dalcin     ierr = PetscViewerASCIIOpen(((PetscObject)ts)->comm,filename,&viewer);CHKERRQ(ierr);
18724d7d938eSLisandro Dalcin     ierr = TSView(ts,viewer);CHKERRQ(ierr);
18734d7d938eSLisandro Dalcin     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1874193ac0bcSJed Brown   }
18756a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
18766a4d4014SLisandro Dalcin }
18776a4d4014SLisandro Dalcin 
18786a4d4014SLisandro Dalcin #undef __FUNCT__
18794a2ae208SSatish Balay #define __FUNCT__ "TSMonitor"
1880d763cef2SBarry Smith /*
1881d763cef2SBarry Smith      Runs the user provided monitor routines, if they exists.
1882d763cef2SBarry Smith */
1883a7cc72afSBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec x)
1884d763cef2SBarry Smith {
18856849ba73SBarry Smith   PetscErrorCode ierr;
1886a7cc72afSBarry Smith   PetscInt       i,n = ts->numbermonitors;
1887d763cef2SBarry Smith 
1888d763cef2SBarry Smith   PetscFunctionBegin;
1889d763cef2SBarry Smith   for (i=0; i<n; i++) {
1890142b95e3SSatish Balay     ierr = (*ts->monitor[i])(ts,step,ptime,x,ts->monitorcontext[i]);CHKERRQ(ierr);
1891d763cef2SBarry Smith   }
1892d763cef2SBarry Smith   PetscFunctionReturn(0);
1893d763cef2SBarry Smith }
1894d763cef2SBarry Smith 
1895d763cef2SBarry Smith /* ------------------------------------------------------------------------*/
1896d763cef2SBarry Smith 
18974a2ae208SSatish Balay #undef __FUNCT__
1898a6570f20SBarry Smith #define __FUNCT__ "TSMonitorLGCreate"
1899d763cef2SBarry Smith /*@C
1900a6570f20SBarry Smith    TSMonitorLGCreate - Creates a line graph context for use with
1901d763cef2SBarry Smith    TS to monitor convergence of preconditioned residual norms.
1902d763cef2SBarry Smith 
1903d763cef2SBarry Smith    Collective on TS
1904d763cef2SBarry Smith 
1905d763cef2SBarry Smith    Input Parameters:
1906d763cef2SBarry Smith +  host - the X display to open, or null for the local machine
1907d763cef2SBarry Smith .  label - the title to put in the title bar
19087c922b88SBarry Smith .  x, y - the screen coordinates of the upper left coordinate of the window
1909d763cef2SBarry Smith -  m, n - the screen width and height in pixels
1910d763cef2SBarry Smith 
1911d763cef2SBarry Smith    Output Parameter:
1912d763cef2SBarry Smith .  draw - the drawing context
1913d763cef2SBarry Smith 
1914d763cef2SBarry Smith    Options Database Key:
1915a6570f20SBarry Smith .  -ts_monitor_draw - automatically sets line graph monitor
1916d763cef2SBarry Smith 
1917d763cef2SBarry Smith    Notes:
1918a6570f20SBarry Smith    Use TSMonitorLGDestroy() to destroy this line graph, not PetscDrawLGDestroy().
1919d763cef2SBarry Smith 
1920d763cef2SBarry Smith    Level: intermediate
1921d763cef2SBarry Smith 
19227c922b88SBarry Smith .keywords: TS, monitor, line graph, residual, seealso
1923d763cef2SBarry Smith 
1924a6570f20SBarry Smith .seealso: TSMonitorLGDestroy(), TSMonitorSet()
19257c922b88SBarry Smith 
1926d763cef2SBarry Smith @*/
19277087cfbeSBarry Smith PetscErrorCode  TSMonitorLGCreate(const char host[],const char label[],int x,int y,int m,int n,PetscDrawLG *draw)
1928d763cef2SBarry Smith {
1929b0a32e0cSBarry Smith   PetscDraw      win;
1930dfbe8321SBarry Smith   PetscErrorCode ierr;
1931d763cef2SBarry Smith 
1932d763cef2SBarry Smith   PetscFunctionBegin;
1933b0a32e0cSBarry Smith   ierr = PetscDrawCreate(PETSC_COMM_SELF,host,label,x,y,m,n,&win);CHKERRQ(ierr);
1934b0a32e0cSBarry Smith   ierr = PetscDrawSetType(win,PETSC_DRAW_X);CHKERRQ(ierr);
1935b0a32e0cSBarry Smith   ierr = PetscDrawLGCreate(win,1,draw);CHKERRQ(ierr);
1936b0a32e0cSBarry Smith   ierr = PetscDrawLGIndicateDataPoints(*draw);CHKERRQ(ierr);
1937d763cef2SBarry Smith 
193852e6d16bSBarry Smith   ierr = PetscLogObjectParent(*draw,win);CHKERRQ(ierr);
1939d763cef2SBarry Smith   PetscFunctionReturn(0);
1940d763cef2SBarry Smith }
1941d763cef2SBarry Smith 
19424a2ae208SSatish Balay #undef __FUNCT__
1943a6570f20SBarry Smith #define __FUNCT__ "TSMonitorLG"
1944a6570f20SBarry Smith PetscErrorCode TSMonitorLG(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
1945d763cef2SBarry Smith {
1946b0a32e0cSBarry Smith   PetscDrawLG    lg = (PetscDrawLG) monctx;
194787828ca2SBarry Smith   PetscReal      x,y = ptime;
1948dfbe8321SBarry Smith   PetscErrorCode ierr;
1949d763cef2SBarry Smith 
1950d763cef2SBarry Smith   PetscFunctionBegin;
19517c922b88SBarry Smith   if (!monctx) {
19527c922b88SBarry Smith     MPI_Comm    comm;
1953b0a32e0cSBarry Smith     PetscViewer viewer;
19547c922b88SBarry Smith 
19557c922b88SBarry Smith     ierr   = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
1956b0a32e0cSBarry Smith     viewer = PETSC_VIEWER_DRAW_(comm);
1957b0a32e0cSBarry Smith     ierr   = PetscViewerDrawGetDrawLG(viewer,0,&lg);CHKERRQ(ierr);
19587c922b88SBarry Smith   }
19597c922b88SBarry Smith 
1960b0a32e0cSBarry Smith   if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);}
196187828ca2SBarry Smith   x = (PetscReal)n;
1962b0a32e0cSBarry Smith   ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr);
1963d763cef2SBarry Smith   if (n < 20 || (n % 5)) {
1964b0a32e0cSBarry Smith     ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr);
1965d763cef2SBarry Smith   }
1966d763cef2SBarry Smith   PetscFunctionReturn(0);
1967d763cef2SBarry Smith }
1968d763cef2SBarry Smith 
19694a2ae208SSatish Balay #undef __FUNCT__
1970a6570f20SBarry Smith #define __FUNCT__ "TSMonitorLGDestroy"
1971d763cef2SBarry Smith /*@C
1972a6570f20SBarry Smith    TSMonitorLGDestroy - Destroys a line graph context that was created
1973a6570f20SBarry Smith    with TSMonitorLGCreate().
1974d763cef2SBarry Smith 
1975b0a32e0cSBarry Smith    Collective on PetscDrawLG
1976d763cef2SBarry Smith 
1977d763cef2SBarry Smith    Input Parameter:
1978d763cef2SBarry Smith .  draw - the drawing context
1979d763cef2SBarry Smith 
1980d763cef2SBarry Smith    Level: intermediate
1981d763cef2SBarry Smith 
1982d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy
1983d763cef2SBarry Smith 
1984a6570f20SBarry Smith .seealso: TSMonitorLGCreate(),  TSMonitorSet(), TSMonitorLG();
1985d763cef2SBarry Smith @*/
19866bf464f9SBarry Smith PetscErrorCode  TSMonitorLGDestroy(PetscDrawLG *drawlg)
1987d763cef2SBarry Smith {
1988b0a32e0cSBarry Smith   PetscDraw      draw;
1989dfbe8321SBarry Smith   PetscErrorCode ierr;
1990d763cef2SBarry Smith 
1991d763cef2SBarry Smith   PetscFunctionBegin;
19926bf464f9SBarry Smith   ierr = PetscDrawLGGetDraw(*drawlg,&draw);CHKERRQ(ierr);
19936bf464f9SBarry Smith   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
1994b0a32e0cSBarry Smith   ierr = PetscDrawLGDestroy(drawlg);CHKERRQ(ierr);
1995d763cef2SBarry Smith   PetscFunctionReturn(0);
1996d763cef2SBarry Smith }
1997d763cef2SBarry Smith 
19984a2ae208SSatish Balay #undef __FUNCT__
19994a2ae208SSatish Balay #define __FUNCT__ "TSGetTime"
2000d763cef2SBarry Smith /*@
2001d763cef2SBarry Smith    TSGetTime - Gets the current time.
2002d763cef2SBarry Smith 
2003d763cef2SBarry Smith    Not Collective
2004d763cef2SBarry Smith 
2005d763cef2SBarry Smith    Input Parameter:
2006d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2007d763cef2SBarry Smith 
2008d763cef2SBarry Smith    Output Parameter:
2009d763cef2SBarry Smith .  t  - the current time
2010d763cef2SBarry Smith 
2011d763cef2SBarry Smith    Level: beginner
2012d763cef2SBarry Smith 
2013d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
2014d763cef2SBarry Smith 
2015d763cef2SBarry Smith .keywords: TS, get, time
2016d763cef2SBarry Smith @*/
20177087cfbeSBarry Smith PetscErrorCode  TSGetTime(TS ts,PetscReal* t)
2018d763cef2SBarry Smith {
2019d763cef2SBarry Smith   PetscFunctionBegin;
20200700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
20214482741eSBarry Smith   PetscValidDoublePointer(t,2);
2022d763cef2SBarry Smith   *t = ts->ptime;
2023d763cef2SBarry Smith   PetscFunctionReturn(0);
2024d763cef2SBarry Smith }
2025d763cef2SBarry Smith 
20264a2ae208SSatish Balay #undef __FUNCT__
20276a4d4014SLisandro Dalcin #define __FUNCT__ "TSSetTime"
20286a4d4014SLisandro Dalcin /*@
20296a4d4014SLisandro Dalcin    TSSetTime - Allows one to reset the time.
20306a4d4014SLisandro Dalcin 
20313f9fe445SBarry Smith    Logically Collective on TS
20326a4d4014SLisandro Dalcin 
20336a4d4014SLisandro Dalcin    Input Parameters:
20346a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
20356a4d4014SLisandro Dalcin -  time - the time
20366a4d4014SLisandro Dalcin 
20376a4d4014SLisandro Dalcin    Level: intermediate
20386a4d4014SLisandro Dalcin 
20396a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration()
20406a4d4014SLisandro Dalcin 
20416a4d4014SLisandro Dalcin .keywords: TS, set, time
20426a4d4014SLisandro Dalcin @*/
20437087cfbeSBarry Smith PetscErrorCode  TSSetTime(TS ts, PetscReal t)
20446a4d4014SLisandro Dalcin {
20456a4d4014SLisandro Dalcin   PetscFunctionBegin;
20460700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2047c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,t,2);
20486a4d4014SLisandro Dalcin   ts->ptime = t;
20496a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
20506a4d4014SLisandro Dalcin }
20516a4d4014SLisandro Dalcin 
20526a4d4014SLisandro Dalcin #undef __FUNCT__
20534a2ae208SSatish Balay #define __FUNCT__ "TSSetOptionsPrefix"
2054d763cef2SBarry Smith /*@C
2055d763cef2SBarry Smith    TSSetOptionsPrefix - Sets the prefix used for searching for all
2056d763cef2SBarry Smith    TS options in the database.
2057d763cef2SBarry Smith 
20583f9fe445SBarry Smith    Logically Collective on TS
2059d763cef2SBarry Smith 
2060d763cef2SBarry Smith    Input Parameter:
2061d763cef2SBarry Smith +  ts     - The TS context
2062d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
2063d763cef2SBarry Smith 
2064d763cef2SBarry Smith    Notes:
2065d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
2066d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
2067d763cef2SBarry Smith    hyphen.
2068d763cef2SBarry Smith 
2069d763cef2SBarry Smith    Level: advanced
2070d763cef2SBarry Smith 
2071d763cef2SBarry Smith .keywords: TS, set, options, prefix, database
2072d763cef2SBarry Smith 
2073d763cef2SBarry Smith .seealso: TSSetFromOptions()
2074d763cef2SBarry Smith 
2075d763cef2SBarry Smith @*/
20767087cfbeSBarry Smith PetscErrorCode  TSSetOptionsPrefix(TS ts,const char prefix[])
2077d763cef2SBarry Smith {
2078dfbe8321SBarry Smith   PetscErrorCode ierr;
2079089b2837SJed Brown   SNES           snes;
2080d763cef2SBarry Smith 
2081d763cef2SBarry Smith   PetscFunctionBegin;
20820700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2083d763cef2SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
2084089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2085089b2837SJed Brown   ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr);
2086d763cef2SBarry Smith   PetscFunctionReturn(0);
2087d763cef2SBarry Smith }
2088d763cef2SBarry Smith 
2089d763cef2SBarry Smith 
20904a2ae208SSatish Balay #undef __FUNCT__
20914a2ae208SSatish Balay #define __FUNCT__ "TSAppendOptionsPrefix"
2092d763cef2SBarry Smith /*@C
2093d763cef2SBarry Smith    TSAppendOptionsPrefix - Appends to the prefix used for searching for all
2094d763cef2SBarry Smith    TS options in the database.
2095d763cef2SBarry Smith 
20963f9fe445SBarry Smith    Logically Collective on TS
2097d763cef2SBarry Smith 
2098d763cef2SBarry Smith    Input Parameter:
2099d763cef2SBarry Smith +  ts     - The TS context
2100d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
2101d763cef2SBarry Smith 
2102d763cef2SBarry Smith    Notes:
2103d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
2104d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
2105d763cef2SBarry Smith    hyphen.
2106d763cef2SBarry Smith 
2107d763cef2SBarry Smith    Level: advanced
2108d763cef2SBarry Smith 
2109d763cef2SBarry Smith .keywords: TS, append, options, prefix, database
2110d763cef2SBarry Smith 
2111d763cef2SBarry Smith .seealso: TSGetOptionsPrefix()
2112d763cef2SBarry Smith 
2113d763cef2SBarry Smith @*/
21147087cfbeSBarry Smith PetscErrorCode  TSAppendOptionsPrefix(TS ts,const char prefix[])
2115d763cef2SBarry Smith {
2116dfbe8321SBarry Smith   PetscErrorCode ierr;
2117089b2837SJed Brown   SNES           snes;
2118d763cef2SBarry Smith 
2119d763cef2SBarry Smith   PetscFunctionBegin;
21200700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2121d763cef2SBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
2122089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2123089b2837SJed Brown   ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr);
2124d763cef2SBarry Smith   PetscFunctionReturn(0);
2125d763cef2SBarry Smith }
2126d763cef2SBarry Smith 
21274a2ae208SSatish Balay #undef __FUNCT__
21284a2ae208SSatish Balay #define __FUNCT__ "TSGetOptionsPrefix"
2129d763cef2SBarry Smith /*@C
2130d763cef2SBarry Smith    TSGetOptionsPrefix - Sets the prefix used for searching for all
2131d763cef2SBarry Smith    TS options in the database.
2132d763cef2SBarry Smith 
2133d763cef2SBarry Smith    Not Collective
2134d763cef2SBarry Smith 
2135d763cef2SBarry Smith    Input Parameter:
2136d763cef2SBarry Smith .  ts - The TS context
2137d763cef2SBarry Smith 
2138d763cef2SBarry Smith    Output Parameter:
2139d763cef2SBarry Smith .  prefix - A pointer to the prefix string used
2140d763cef2SBarry Smith 
2141d763cef2SBarry Smith    Notes: On the fortran side, the user should pass in a string 'prifix' of
2142d763cef2SBarry Smith    sufficient length to hold the prefix.
2143d763cef2SBarry Smith 
2144d763cef2SBarry Smith    Level: intermediate
2145d763cef2SBarry Smith 
2146d763cef2SBarry Smith .keywords: TS, get, options, prefix, database
2147d763cef2SBarry Smith 
2148d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix()
2149d763cef2SBarry Smith @*/
21507087cfbeSBarry Smith PetscErrorCode  TSGetOptionsPrefix(TS ts,const char *prefix[])
2151d763cef2SBarry Smith {
2152dfbe8321SBarry Smith   PetscErrorCode ierr;
2153d763cef2SBarry Smith 
2154d763cef2SBarry Smith   PetscFunctionBegin;
21550700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
21564482741eSBarry Smith   PetscValidPointer(prefix,2);
2157d763cef2SBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
2158d763cef2SBarry Smith   PetscFunctionReturn(0);
2159d763cef2SBarry Smith }
2160d763cef2SBarry Smith 
21614a2ae208SSatish Balay #undef __FUNCT__
21624a2ae208SSatish Balay #define __FUNCT__ "TSGetRHSJacobian"
2163d763cef2SBarry Smith /*@C
2164d763cef2SBarry Smith    TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
2165d763cef2SBarry Smith 
2166d763cef2SBarry Smith    Not Collective, but parallel objects are returned if TS is parallel
2167d763cef2SBarry Smith 
2168d763cef2SBarry Smith    Input Parameter:
2169d763cef2SBarry Smith .  ts  - The TS context obtained from TSCreate()
2170d763cef2SBarry Smith 
2171d763cef2SBarry Smith    Output Parameters:
2172d763cef2SBarry Smith +  J   - The Jacobian J of F, where U_t = F(U,t)
2173d763cef2SBarry Smith .  M   - The preconditioner matrix, usually the same as J
2174089b2837SJed Brown .  func - Function to compute the Jacobian of the RHS
2175d763cef2SBarry Smith -  ctx - User-defined context for Jacobian evaluation routine
2176d763cef2SBarry Smith 
2177d763cef2SBarry Smith    Notes: You can pass in PETSC_NULL for any return argument you do not need.
2178d763cef2SBarry Smith 
2179d763cef2SBarry Smith    Level: intermediate
2180d763cef2SBarry Smith 
218126d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
2182d763cef2SBarry Smith 
2183d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian
2184d763cef2SBarry Smith @*/
2185089b2837SJed Brown PetscErrorCode  TSGetRHSJacobian(TS ts,Mat *J,Mat *M,TSRHSJacobian *func,void **ctx)
2186d763cef2SBarry Smith {
2187089b2837SJed Brown   PetscErrorCode ierr;
2188089b2837SJed Brown   SNES           snes;
2189089b2837SJed Brown 
2190d763cef2SBarry Smith   PetscFunctionBegin;
2191089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2192089b2837SJed Brown   ierr = SNESGetJacobian(snes,J,M,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
21933b5f76d0SSean Farley   if (func) *func = ts->userops->rhsjacobian;
219426d46c62SHong Zhang   if (ctx) *ctx = ts->jacP;
2195d763cef2SBarry Smith   PetscFunctionReturn(0);
2196d763cef2SBarry Smith }
2197d763cef2SBarry Smith 
21981713a123SBarry Smith #undef __FUNCT__
21992eca1d9cSJed Brown #define __FUNCT__ "TSGetIJacobian"
22002eca1d9cSJed Brown /*@C
22012eca1d9cSJed Brown    TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
22022eca1d9cSJed Brown 
22032eca1d9cSJed Brown    Not Collective, but parallel objects are returned if TS is parallel
22042eca1d9cSJed Brown 
22052eca1d9cSJed Brown    Input Parameter:
22062eca1d9cSJed Brown .  ts  - The TS context obtained from TSCreate()
22072eca1d9cSJed Brown 
22082eca1d9cSJed Brown    Output Parameters:
22092eca1d9cSJed Brown +  A   - The Jacobian of F(t,U,U_t)
22102eca1d9cSJed Brown .  B   - The preconditioner matrix, often the same as A
22112eca1d9cSJed Brown .  f   - The function to compute the matrices
22122eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine
22132eca1d9cSJed Brown 
22142eca1d9cSJed Brown    Notes: You can pass in PETSC_NULL for any return argument you do not need.
22152eca1d9cSJed Brown 
22162eca1d9cSJed Brown    Level: advanced
22172eca1d9cSJed Brown 
22182eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
22192eca1d9cSJed Brown 
22202eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian
22212eca1d9cSJed Brown @*/
22227087cfbeSBarry Smith PetscErrorCode  TSGetIJacobian(TS ts,Mat *A,Mat *B,TSIJacobian *f,void **ctx)
22232eca1d9cSJed Brown {
2224089b2837SJed Brown   PetscErrorCode ierr;
2225089b2837SJed Brown   SNES           snes;
2226089b2837SJed Brown 
22272eca1d9cSJed Brown   PetscFunctionBegin;
2228089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2229089b2837SJed Brown   ierr = SNESGetJacobian(snes,A,B,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
22303b5f76d0SSean Farley   if (f) *f = ts->userops->ijacobian;
22312eca1d9cSJed Brown   if (ctx) *ctx = ts->jacP;
22322eca1d9cSJed Brown   PetscFunctionReturn(0);
22332eca1d9cSJed Brown }
22342eca1d9cSJed Brown 
22352eca1d9cSJed Brown #undef __FUNCT__
2236a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSolution"
22371713a123SBarry Smith /*@C
2238a6570f20SBarry Smith    TSMonitorSolution - Monitors progress of the TS solvers by calling
22391713a123SBarry Smith    VecView() for the solution at each timestep
22401713a123SBarry Smith 
22411713a123SBarry Smith    Collective on TS
22421713a123SBarry Smith 
22431713a123SBarry Smith    Input Parameters:
22441713a123SBarry Smith +  ts - the TS context
22451713a123SBarry Smith .  step - current time-step
2246142b95e3SSatish Balay .  ptime - current time
22471713a123SBarry Smith -  dummy - either a viewer or PETSC_NULL
22481713a123SBarry Smith 
22491713a123SBarry Smith    Level: intermediate
22501713a123SBarry Smith 
22511713a123SBarry Smith .keywords: TS,  vector, monitor, view
22521713a123SBarry Smith 
2253a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
22541713a123SBarry Smith @*/
22557087cfbeSBarry Smith PetscErrorCode  TSMonitorSolution(TS ts,PetscInt step,PetscReal ptime,Vec x,void *dummy)
22561713a123SBarry Smith {
2257dfbe8321SBarry Smith   PetscErrorCode ierr;
22581713a123SBarry Smith   PetscViewer    viewer = (PetscViewer) dummy;
22591713a123SBarry Smith 
22601713a123SBarry Smith   PetscFunctionBegin;
2261a34d58ebSBarry Smith   if (!dummy) {
22627adad957SLisandro Dalcin     viewer = PETSC_VIEWER_DRAW_(((PetscObject)ts)->comm);
22631713a123SBarry Smith   }
22641713a123SBarry Smith   ierr = VecView(x,viewer);CHKERRQ(ierr);
22651713a123SBarry Smith   PetscFunctionReturn(0);
22661713a123SBarry Smith }
22671713a123SBarry Smith 
22681713a123SBarry Smith 
22696c699258SBarry Smith #undef __FUNCT__
22706c699258SBarry Smith #define __FUNCT__ "TSSetDM"
22716c699258SBarry Smith /*@
22726c699258SBarry Smith    TSSetDM - Sets the DM that may be used by some preconditioners
22736c699258SBarry Smith 
22743f9fe445SBarry Smith    Logically Collective on TS and DM
22756c699258SBarry Smith 
22766c699258SBarry Smith    Input Parameters:
22776c699258SBarry Smith +  ts - the preconditioner context
22786c699258SBarry Smith -  dm - the dm
22796c699258SBarry Smith 
22806c699258SBarry Smith    Level: intermediate
22816c699258SBarry Smith 
22826c699258SBarry Smith 
22836c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
22846c699258SBarry Smith @*/
22857087cfbeSBarry Smith PetscErrorCode  TSSetDM(TS ts,DM dm)
22866c699258SBarry Smith {
22876c699258SBarry Smith   PetscErrorCode ierr;
2288089b2837SJed Brown   SNES           snes;
22896c699258SBarry Smith 
22906c699258SBarry Smith   PetscFunctionBegin;
22910700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
229270663e4aSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);
22936bf464f9SBarry Smith   ierr = DMDestroy(&ts->dm);CHKERRQ(ierr);
22946c699258SBarry Smith   ts->dm = dm;
2295089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2296089b2837SJed Brown   ierr = SNESSetDM(snes,dm);CHKERRQ(ierr);
22976c699258SBarry Smith   PetscFunctionReturn(0);
22986c699258SBarry Smith }
22996c699258SBarry Smith 
23006c699258SBarry Smith #undef __FUNCT__
23016c699258SBarry Smith #define __FUNCT__ "TSGetDM"
23026c699258SBarry Smith /*@
23036c699258SBarry Smith    TSGetDM - Gets the DM that may be used by some preconditioners
23046c699258SBarry Smith 
23053f9fe445SBarry Smith    Not Collective
23066c699258SBarry Smith 
23076c699258SBarry Smith    Input Parameter:
23086c699258SBarry Smith . ts - the preconditioner context
23096c699258SBarry Smith 
23106c699258SBarry Smith    Output Parameter:
23116c699258SBarry Smith .  dm - the dm
23126c699258SBarry Smith 
23136c699258SBarry Smith    Level: intermediate
23146c699258SBarry Smith 
23156c699258SBarry Smith 
23166c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
23176c699258SBarry Smith @*/
23187087cfbeSBarry Smith PetscErrorCode  TSGetDM(TS ts,DM *dm)
23196c699258SBarry Smith {
23206c699258SBarry Smith   PetscFunctionBegin;
23210700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
23226c699258SBarry Smith   *dm = ts->dm;
23236c699258SBarry Smith   PetscFunctionReturn(0);
23246c699258SBarry Smith }
23251713a123SBarry Smith 
23260f5c6efeSJed Brown #undef __FUNCT__
23270f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormFunction"
23280f5c6efeSJed Brown /*@
23290f5c6efeSJed Brown    SNESTSFormFunction - Function to evaluate nonlinear residual
23300f5c6efeSJed Brown 
23313f9fe445SBarry Smith    Logically Collective on SNES
23320f5c6efeSJed Brown 
23330f5c6efeSJed Brown    Input Parameter:
2334d42a1c89SJed Brown + snes - nonlinear solver
23350f5c6efeSJed Brown . X - the current state at which to evaluate the residual
2336d42a1c89SJed Brown - ctx - user context, must be a TS
23370f5c6efeSJed Brown 
23380f5c6efeSJed Brown    Output Parameter:
23390f5c6efeSJed Brown . F - the nonlinear residual
23400f5c6efeSJed Brown 
23410f5c6efeSJed Brown    Notes:
23420f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
23430f5c6efeSJed Brown    It is most frequently passed to MatFDColoringSetFunction().
23440f5c6efeSJed Brown 
23450f5c6efeSJed Brown    Level: advanced
23460f5c6efeSJed Brown 
23470f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction()
23480f5c6efeSJed Brown @*/
23497087cfbeSBarry Smith PetscErrorCode  SNESTSFormFunction(SNES snes,Vec X,Vec F,void *ctx)
23500f5c6efeSJed Brown {
23510f5c6efeSJed Brown   TS ts = (TS)ctx;
23520f5c6efeSJed Brown   PetscErrorCode ierr;
23530f5c6efeSJed Brown 
23540f5c6efeSJed Brown   PetscFunctionBegin;
23550f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
23560f5c6efeSJed Brown   PetscValidHeaderSpecific(X,VEC_CLASSID,2);
23570f5c6efeSJed Brown   PetscValidHeaderSpecific(F,VEC_CLASSID,3);
23580f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,4);
23590f5c6efeSJed Brown   ierr = (ts->ops->snesfunction)(snes,X,F,ts);CHKERRQ(ierr);
23600f5c6efeSJed Brown   PetscFunctionReturn(0);
23610f5c6efeSJed Brown }
23620f5c6efeSJed Brown 
23630f5c6efeSJed Brown #undef __FUNCT__
23640f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormJacobian"
23650f5c6efeSJed Brown /*@
23660f5c6efeSJed Brown    SNESTSFormJacobian - Function to evaluate the Jacobian
23670f5c6efeSJed Brown 
23680f5c6efeSJed Brown    Collective on SNES
23690f5c6efeSJed Brown 
23700f5c6efeSJed Brown    Input Parameter:
23710f5c6efeSJed Brown + snes - nonlinear solver
23720f5c6efeSJed Brown . X - the current state at which to evaluate the residual
23730f5c6efeSJed Brown - ctx - user context, must be a TS
23740f5c6efeSJed Brown 
23750f5c6efeSJed Brown    Output Parameter:
23760f5c6efeSJed Brown + A - the Jacobian
23770f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A)
23780f5c6efeSJed Brown - flag - indicates any structure change in the matrix
23790f5c6efeSJed Brown 
23800f5c6efeSJed Brown    Notes:
23810f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
23820f5c6efeSJed Brown 
23830f5c6efeSJed Brown    Level: developer
23840f5c6efeSJed Brown 
23850f5c6efeSJed Brown .seealso: SNESSetJacobian()
23860f5c6efeSJed Brown @*/
23877087cfbeSBarry Smith PetscErrorCode  SNESTSFormJacobian(SNES snes,Vec X,Mat *A,Mat *B,MatStructure *flag,void *ctx)
23880f5c6efeSJed Brown {
23890f5c6efeSJed Brown   TS ts = (TS)ctx;
23900f5c6efeSJed Brown   PetscErrorCode ierr;
23910f5c6efeSJed Brown 
23920f5c6efeSJed Brown   PetscFunctionBegin;
23930f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
23940f5c6efeSJed Brown   PetscValidHeaderSpecific(X,VEC_CLASSID,2);
23950f5c6efeSJed Brown   PetscValidPointer(A,3);
23960f5c6efeSJed Brown   PetscValidHeaderSpecific(*A,MAT_CLASSID,3);
23970f5c6efeSJed Brown   PetscValidPointer(B,4);
23980f5c6efeSJed Brown   PetscValidHeaderSpecific(*B,MAT_CLASSID,4);
23990f5c6efeSJed Brown   PetscValidPointer(flag,5);
24000f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,6);
24010f5c6efeSJed Brown   ierr = (ts->ops->snesjacobian)(snes,X,A,B,flag,ts);CHKERRQ(ierr);
24020f5c6efeSJed Brown   PetscFunctionReturn(0);
24030f5c6efeSJed Brown }
2404325fc9f4SBarry Smith 
24050e4ef248SJed Brown #undef __FUNCT__
24060e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSFunctionLinear"
24070e4ef248SJed Brown /*@C
24080e4ef248SJed Brown    TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems only
24090e4ef248SJed Brown 
24100e4ef248SJed Brown    Collective on TS
24110e4ef248SJed Brown 
24120e4ef248SJed Brown    Input Arguments:
24130e4ef248SJed Brown +  ts - time stepping context
24140e4ef248SJed Brown .  t - time at which to evaluate
24150e4ef248SJed Brown .  X - state at which to evaluate
24160e4ef248SJed Brown -  ctx - context
24170e4ef248SJed Brown 
24180e4ef248SJed Brown    Output Arguments:
24190e4ef248SJed Brown .  F - right hand side
24200e4ef248SJed Brown 
24210e4ef248SJed Brown    Level: intermediate
24220e4ef248SJed Brown 
24230e4ef248SJed Brown    Notes:
24240e4ef248SJed Brown    This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
24250e4ef248SJed Brown    The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
24260e4ef248SJed Brown 
24270e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
24280e4ef248SJed Brown @*/
24290e4ef248SJed Brown PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec X,Vec F,void *ctx)
24300e4ef248SJed Brown {
24310e4ef248SJed Brown   PetscErrorCode ierr;
24320e4ef248SJed Brown   Mat Arhs,Brhs;
24330e4ef248SJed Brown   MatStructure flg2;
24340e4ef248SJed Brown 
24350e4ef248SJed Brown   PetscFunctionBegin;
24360e4ef248SJed Brown   ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
24370e4ef248SJed Brown   ierr = TSComputeRHSJacobian(ts,t,X,&Arhs,&Brhs,&flg2);CHKERRQ(ierr);
24380e4ef248SJed Brown   ierr = MatMult(Arhs,X,F);CHKERRQ(ierr);
24390e4ef248SJed Brown   PetscFunctionReturn(0);
24400e4ef248SJed Brown }
24410e4ef248SJed Brown 
24420e4ef248SJed Brown #undef __FUNCT__
24430e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSJacobianConstant"
24440e4ef248SJed Brown /*@C
24450e4ef248SJed Brown    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
24460e4ef248SJed Brown 
24470e4ef248SJed Brown    Collective on TS
24480e4ef248SJed Brown 
24490e4ef248SJed Brown    Input Arguments:
24500e4ef248SJed Brown +  ts - time stepping context
24510e4ef248SJed Brown .  t - time at which to evaluate
24520e4ef248SJed Brown .  X - state at which to evaluate
24530e4ef248SJed Brown -  ctx - context
24540e4ef248SJed Brown 
24550e4ef248SJed Brown    Output Arguments:
24560e4ef248SJed Brown +  A - pointer to operator
24570e4ef248SJed Brown .  B - pointer to preconditioning matrix
24580e4ef248SJed Brown -  flg - matrix structure flag
24590e4ef248SJed Brown 
24600e4ef248SJed Brown    Level: intermediate
24610e4ef248SJed Brown 
24620e4ef248SJed Brown    Notes:
24630e4ef248SJed Brown    This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
24640e4ef248SJed Brown 
24650e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
24660e4ef248SJed Brown @*/
24670e4ef248SJed Brown PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec X,Mat *A,Mat *B,MatStructure *flg,void *ctx)
24680e4ef248SJed Brown {
24690e4ef248SJed Brown 
24700e4ef248SJed Brown   PetscFunctionBegin;
24710e4ef248SJed Brown   *flg = SAME_PRECONDITIONER;
24720e4ef248SJed Brown   PetscFunctionReturn(0);
24730e4ef248SJed Brown }
24740e4ef248SJed Brown 
24750026cea9SSean Farley #undef __FUNCT__
24760026cea9SSean Farley #define __FUNCT__ "TSComputeIFunctionLinear"
24770026cea9SSean Farley /*@C
24780026cea9SSean Farley    TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
24790026cea9SSean Farley 
24800026cea9SSean Farley    Collective on TS
24810026cea9SSean Farley 
24820026cea9SSean Farley    Input Arguments:
24830026cea9SSean Farley +  ts - time stepping context
24840026cea9SSean Farley .  t - time at which to evaluate
24850026cea9SSean Farley .  X - state at which to evaluate
24860026cea9SSean Farley .  Xdot - time derivative of state vector
24870026cea9SSean Farley -  ctx - context
24880026cea9SSean Farley 
24890026cea9SSean Farley    Output Arguments:
24900026cea9SSean Farley .  F - left hand side
24910026cea9SSean Farley 
24920026cea9SSean Farley    Level: intermediate
24930026cea9SSean Farley 
24940026cea9SSean Farley    Notes:
24950026cea9SSean 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
24960026cea9SSean Farley    user is required to write their own TSComputeIFunction.
24970026cea9SSean Farley    This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
24980026cea9SSean Farley    The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
24990026cea9SSean Farley 
25000026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant()
25010026cea9SSean Farley @*/
25020026cea9SSean Farley PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec X,Vec Xdot,Vec F,void *ctx)
25030026cea9SSean Farley {
25040026cea9SSean Farley   PetscErrorCode ierr;
25050026cea9SSean Farley   Mat A,B;
25060026cea9SSean Farley   MatStructure flg2;
25070026cea9SSean Farley 
25080026cea9SSean Farley   PetscFunctionBegin;
25090026cea9SSean Farley   ierr = TSGetIJacobian(ts,&A,&B,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
25100026cea9SSean Farley   ierr = TSComputeIJacobian(ts,t,X,Xdot,1.0,&A,&B,&flg2,PETSC_TRUE);CHKERRQ(ierr);
25110026cea9SSean Farley   ierr = MatMult(A,Xdot,F);CHKERRQ(ierr);
25120026cea9SSean Farley   PetscFunctionReturn(0);
25130026cea9SSean Farley }
25140026cea9SSean Farley 
25150026cea9SSean Farley #undef __FUNCT__
25160026cea9SSean Farley #define __FUNCT__ "TSComputeIJacobianConstant"
25170026cea9SSean Farley /*@C
25180026cea9SSean Farley    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
25190026cea9SSean Farley 
25200026cea9SSean Farley    Collective on TS
25210026cea9SSean Farley 
25220026cea9SSean Farley    Input Arguments:
25230026cea9SSean Farley +  ts - time stepping context
25240026cea9SSean Farley .  t - time at which to evaluate
25250026cea9SSean Farley .  X - state at which to evaluate
25260026cea9SSean Farley .  Xdot - time derivative of state vector
25270026cea9SSean Farley .  shift - shift to apply
25280026cea9SSean Farley -  ctx - context
25290026cea9SSean Farley 
25300026cea9SSean Farley    Output Arguments:
25310026cea9SSean Farley +  A - pointer to operator
25320026cea9SSean Farley .  B - pointer to preconditioning matrix
25330026cea9SSean Farley -  flg - matrix structure flag
25340026cea9SSean Farley 
25350026cea9SSean Farley    Level: intermediate
25360026cea9SSean Farley 
25370026cea9SSean Farley    Notes:
25380026cea9SSean Farley    This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
25390026cea9SSean Farley 
25400026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
25410026cea9SSean Farley @*/
25420026cea9SSean Farley PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec X,Vec Xdot,PetscReal shift,Mat *A,Mat *B,MatStructure *flg,void *ctx)
25430026cea9SSean Farley {
25440026cea9SSean Farley 
25450026cea9SSean Farley   PetscFunctionBegin;
25460026cea9SSean Farley   *flg = SAME_PRECONDITIONER;
25470026cea9SSean Farley   PetscFunctionReturn(0);
25480026cea9SSean Farley }
25490026cea9SSean Farley 
25504af1b03aSJed Brown 
25514af1b03aSJed Brown #undef __FUNCT__
25524af1b03aSJed Brown #define __FUNCT__ "TSGetConvergedReason"
25534af1b03aSJed Brown /*@
25544af1b03aSJed Brown    TSGetConvergedReason - Gets the reason the TS iteration was stopped.
25554af1b03aSJed Brown 
25564af1b03aSJed Brown    Not Collective
25574af1b03aSJed Brown 
25584af1b03aSJed Brown    Input Parameter:
25594af1b03aSJed Brown .  ts - the TS context
25604af1b03aSJed Brown 
25614af1b03aSJed Brown    Output Parameter:
25624af1b03aSJed Brown .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
25634af1b03aSJed Brown             manual pages for the individual convergence tests for complete lists
25644af1b03aSJed Brown 
25654af1b03aSJed Brown    Level: intermediate
25664af1b03aSJed Brown 
2567cd652676SJed Brown    Notes:
2568cd652676SJed Brown    Can only be called after the call to TSSolve() is complete.
25694af1b03aSJed Brown 
25704af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test
25714af1b03aSJed Brown 
25724af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason
25734af1b03aSJed Brown @*/
25744af1b03aSJed Brown PetscErrorCode  TSGetConvergedReason(TS ts,TSConvergedReason *reason)
25754af1b03aSJed Brown {
25764af1b03aSJed Brown   PetscFunctionBegin;
25774af1b03aSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
25784af1b03aSJed Brown   PetscValidPointer(reason,2);
25794af1b03aSJed Brown   *reason = ts->reason;
25804af1b03aSJed Brown   PetscFunctionReturn(0);
25814af1b03aSJed Brown }
25824af1b03aSJed Brown 
2583325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
2584c6db04a5SJed Brown #include <mex.h>
2585325fc9f4SBarry Smith 
2586325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext;
2587325fc9f4SBarry Smith 
2588325fc9f4SBarry Smith #undef __FUNCT__
2589325fc9f4SBarry Smith #define __FUNCT__ "TSComputeFunction_Matlab"
2590325fc9f4SBarry Smith /*
2591325fc9f4SBarry Smith    TSComputeFunction_Matlab - Calls the function that has been set with
2592325fc9f4SBarry Smith                          TSSetFunctionMatlab().
2593325fc9f4SBarry Smith 
2594325fc9f4SBarry Smith    Collective on TS
2595325fc9f4SBarry Smith 
2596325fc9f4SBarry Smith    Input Parameters:
2597325fc9f4SBarry Smith +  snes - the TS context
2598325fc9f4SBarry Smith -  x - input vector
2599325fc9f4SBarry Smith 
2600325fc9f4SBarry Smith    Output Parameter:
2601325fc9f4SBarry Smith .  y - function vector, as set by TSSetFunction()
2602325fc9f4SBarry Smith 
2603325fc9f4SBarry Smith    Notes:
2604325fc9f4SBarry Smith    TSComputeFunction() is typically used within nonlinear solvers
2605325fc9f4SBarry Smith    implementations, so most users would not generally call this routine
2606325fc9f4SBarry Smith    themselves.
2607325fc9f4SBarry Smith 
2608325fc9f4SBarry Smith    Level: developer
2609325fc9f4SBarry Smith 
2610325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
2611325fc9f4SBarry Smith 
2612325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
2613325fc9f4SBarry Smith */
26147087cfbeSBarry Smith PetscErrorCode  TSComputeFunction_Matlab(TS snes,PetscReal time,Vec x,Vec xdot,Vec y, void *ctx)
2615325fc9f4SBarry Smith {
2616325fc9f4SBarry Smith   PetscErrorCode   ierr;
2617325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext *)ctx;
2618325fc9f4SBarry Smith   int              nlhs = 1,nrhs = 7;
2619325fc9f4SBarry Smith   mxArray          *plhs[1],*prhs[7];
2620325fc9f4SBarry Smith   long long int    lx = 0,lxdot = 0,ly = 0,ls = 0;
2621325fc9f4SBarry Smith 
2622325fc9f4SBarry Smith   PetscFunctionBegin;
2623325fc9f4SBarry Smith   PetscValidHeaderSpecific(snes,TS_CLASSID,1);
2624325fc9f4SBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,3);
2625325fc9f4SBarry Smith   PetscValidHeaderSpecific(xdot,VEC_CLASSID,4);
2626325fc9f4SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,5);
2627325fc9f4SBarry Smith   PetscCheckSameComm(snes,1,x,3);
2628325fc9f4SBarry Smith   PetscCheckSameComm(snes,1,y,5);
2629325fc9f4SBarry Smith 
2630325fc9f4SBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
2631325fc9f4SBarry Smith   ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr);
2632880f3077SBarry Smith   ierr = PetscMemcpy(&lxdot,&xdot,sizeof(xdot));CHKERRQ(ierr);
2633325fc9f4SBarry Smith   ierr = PetscMemcpy(&ly,&y,sizeof(x));CHKERRQ(ierr);
2634325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
2635325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar(time);
2636325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
2637325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
2638325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)ly);
2639325fc9f4SBarry Smith   prhs[5] =  mxCreateString(sctx->funcname);
2640325fc9f4SBarry Smith   prhs[6] =  sctx->ctx;
2641325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr);
2642325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
2643325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
2644325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
2645325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
2646325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
2647325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
2648325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
2649325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
2650325fc9f4SBarry Smith   PetscFunctionReturn(0);
2651325fc9f4SBarry Smith }
2652325fc9f4SBarry Smith 
2653325fc9f4SBarry Smith 
2654325fc9f4SBarry Smith #undef __FUNCT__
2655325fc9f4SBarry Smith #define __FUNCT__ "TSSetFunctionMatlab"
2656325fc9f4SBarry Smith /*
2657325fc9f4SBarry Smith    TSSetFunctionMatlab - Sets the function evaluation routine and function
2658325fc9f4SBarry Smith    vector for use by the TS routines in solving ODEs
2659e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
2660325fc9f4SBarry Smith 
2661325fc9f4SBarry Smith    Logically Collective on TS
2662325fc9f4SBarry Smith 
2663325fc9f4SBarry Smith    Input Parameters:
2664325fc9f4SBarry Smith +  ts - the TS context
2665325fc9f4SBarry Smith -  func - function evaluation routine
2666325fc9f4SBarry Smith 
2667325fc9f4SBarry Smith    Calling sequence of func:
2668325fc9f4SBarry Smith $    func (TS ts,PetscReal time,Vec x,Vec xdot,Vec f,void *ctx);
2669325fc9f4SBarry Smith 
2670325fc9f4SBarry Smith    Level: beginner
2671325fc9f4SBarry Smith 
2672325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
2673325fc9f4SBarry Smith 
2674325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
2675325fc9f4SBarry Smith */
2676cdcf91faSSean Farley PetscErrorCode  TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx)
2677325fc9f4SBarry Smith {
2678325fc9f4SBarry Smith   PetscErrorCode  ierr;
2679325fc9f4SBarry Smith   TSMatlabContext *sctx;
2680325fc9f4SBarry Smith 
2681325fc9f4SBarry Smith   PetscFunctionBegin;
2682325fc9f4SBarry Smith   /* currently sctx is memory bleed */
2683325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
2684325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
2685325fc9f4SBarry Smith   /*
2686325fc9f4SBarry Smith      This should work, but it doesn't
2687325fc9f4SBarry Smith   sctx->ctx = ctx;
2688325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
2689325fc9f4SBarry Smith   */
2690325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
2691cdcf91faSSean Farley   ierr = TSSetIFunction(ts,PETSC_NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr);
2692325fc9f4SBarry Smith   PetscFunctionReturn(0);
2693325fc9f4SBarry Smith }
2694325fc9f4SBarry Smith 
2695325fc9f4SBarry Smith #undef __FUNCT__
2696325fc9f4SBarry Smith #define __FUNCT__ "TSComputeJacobian_Matlab"
2697325fc9f4SBarry Smith /*
2698325fc9f4SBarry Smith    TSComputeJacobian_Matlab - Calls the function that has been set with
2699325fc9f4SBarry Smith                          TSSetJacobianMatlab().
2700325fc9f4SBarry Smith 
2701325fc9f4SBarry Smith    Collective on TS
2702325fc9f4SBarry Smith 
2703325fc9f4SBarry Smith    Input Parameters:
2704cdcf91faSSean Farley +  ts - the TS context
2705325fc9f4SBarry Smith .  x - input vector
2706325fc9f4SBarry Smith .  A, B - the matrices
2707325fc9f4SBarry Smith -  ctx - user context
2708325fc9f4SBarry Smith 
2709325fc9f4SBarry Smith    Output Parameter:
2710325fc9f4SBarry Smith .  flag - structure of the matrix
2711325fc9f4SBarry Smith 
2712325fc9f4SBarry Smith    Level: developer
2713325fc9f4SBarry Smith 
2714325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
2715325fc9f4SBarry Smith 
2716325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
2717325fc9f4SBarry Smith @*/
2718cdcf91faSSean Farley PetscErrorCode  TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec x,Vec xdot,PetscReal shift,Mat *A,Mat *B,MatStructure *flag, void *ctx)
2719325fc9f4SBarry Smith {
2720325fc9f4SBarry Smith   PetscErrorCode  ierr;
2721325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext *)ctx;
2722325fc9f4SBarry Smith   int             nlhs = 2,nrhs = 9;
2723325fc9f4SBarry Smith   mxArray         *plhs[2],*prhs[9];
2724325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0;
2725325fc9f4SBarry Smith 
2726325fc9f4SBarry Smith   PetscFunctionBegin;
2727cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2728325fc9f4SBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,3);
2729325fc9f4SBarry Smith 
2730325fc9f4SBarry Smith   /* call Matlab function in ctx with arguments x and y */
2731325fc9f4SBarry Smith 
2732cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
2733325fc9f4SBarry Smith   ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr);
2734325fc9f4SBarry Smith   ierr = PetscMemcpy(&lxdot,&xdot,sizeof(x));CHKERRQ(ierr);
2735325fc9f4SBarry Smith   ierr = PetscMemcpy(&lA,A,sizeof(x));CHKERRQ(ierr);
2736325fc9f4SBarry Smith   ierr = PetscMemcpy(&lB,B,sizeof(x));CHKERRQ(ierr);
2737325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
2738325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)time);
2739325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
2740325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
2741325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)shift);
2742325fc9f4SBarry Smith   prhs[5] =  mxCreateDoubleScalar((double)lA);
2743325fc9f4SBarry Smith   prhs[6] =  mxCreateDoubleScalar((double)lB);
2744325fc9f4SBarry Smith   prhs[7] =  mxCreateString(sctx->funcname);
2745325fc9f4SBarry Smith   prhs[8] =  sctx->ctx;
2746325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr);
2747325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
2748325fc9f4SBarry Smith   *flag   =  (MatStructure) mxGetScalar(plhs[1]);CHKERRQ(ierr);
2749325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
2750325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
2751325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
2752325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
2753325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
2754325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
2755325fc9f4SBarry Smith   mxDestroyArray(prhs[6]);
2756325fc9f4SBarry Smith   mxDestroyArray(prhs[7]);
2757325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
2758325fc9f4SBarry Smith   mxDestroyArray(plhs[1]);
2759325fc9f4SBarry Smith   PetscFunctionReturn(0);
2760325fc9f4SBarry Smith }
2761325fc9f4SBarry Smith 
2762325fc9f4SBarry Smith 
2763325fc9f4SBarry Smith #undef __FUNCT__
2764325fc9f4SBarry Smith #define __FUNCT__ "TSSetJacobianMatlab"
2765325fc9f4SBarry Smith /*
2766325fc9f4SBarry Smith    TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
2767e3c5b3baSBarry 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
2768325fc9f4SBarry Smith 
2769325fc9f4SBarry Smith    Logically Collective on TS
2770325fc9f4SBarry Smith 
2771325fc9f4SBarry Smith    Input Parameters:
2772cdcf91faSSean Farley +  ts - the TS context
2773325fc9f4SBarry Smith .  A,B - Jacobian matrices
2774325fc9f4SBarry Smith .  func - function evaluation routine
2775325fc9f4SBarry Smith -  ctx - user context
2776325fc9f4SBarry Smith 
2777325fc9f4SBarry Smith    Calling sequence of func:
2778cdcf91faSSean Farley $    flag = func (TS ts,PetscReal time,Vec x,Vec xdot,Mat A,Mat B,void *ctx);
2779325fc9f4SBarry Smith 
2780325fc9f4SBarry Smith 
2781325fc9f4SBarry Smith    Level: developer
2782325fc9f4SBarry Smith 
2783325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
2784325fc9f4SBarry Smith 
2785325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
2786325fc9f4SBarry Smith */
2787cdcf91faSSean Farley PetscErrorCode  TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx)
2788325fc9f4SBarry Smith {
2789325fc9f4SBarry Smith   PetscErrorCode    ierr;
2790325fc9f4SBarry Smith   TSMatlabContext *sctx;
2791325fc9f4SBarry Smith 
2792325fc9f4SBarry Smith   PetscFunctionBegin;
2793325fc9f4SBarry Smith   /* currently sctx is memory bleed */
2794325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
2795325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
2796325fc9f4SBarry Smith   /*
2797325fc9f4SBarry Smith      This should work, but it doesn't
2798325fc9f4SBarry Smith   sctx->ctx = ctx;
2799325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
2800325fc9f4SBarry Smith   */
2801325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
2802cdcf91faSSean Farley   ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
2803325fc9f4SBarry Smith   PetscFunctionReturn(0);
2804325fc9f4SBarry Smith }
2805325fc9f4SBarry Smith 
2806b5b1a830SBarry Smith #undef __FUNCT__
2807b5b1a830SBarry Smith #define __FUNCT__ "TSMonitor_Matlab"
2808b5b1a830SBarry Smith /*
2809b5b1a830SBarry Smith    TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab().
2810b5b1a830SBarry Smith 
2811b5b1a830SBarry Smith    Collective on TS
2812b5b1a830SBarry Smith 
2813b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
2814b5b1a830SBarry Smith @*/
2815cdcf91faSSean Farley PetscErrorCode  TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec x, void *ctx)
2816b5b1a830SBarry Smith {
2817b5b1a830SBarry Smith   PetscErrorCode  ierr;
2818b5b1a830SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext *)ctx;
2819a530c242SBarry Smith   int             nlhs = 1,nrhs = 6;
2820b5b1a830SBarry Smith   mxArray         *plhs[1],*prhs[6];
2821b5b1a830SBarry Smith   long long int   lx = 0,ls = 0;
2822b5b1a830SBarry Smith 
2823b5b1a830SBarry Smith   PetscFunctionBegin;
2824cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2825b5b1a830SBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,4);
2826b5b1a830SBarry Smith 
2827cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
2828b5b1a830SBarry Smith   ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr);
2829b5b1a830SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
2830b5b1a830SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)it);
2831b5b1a830SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)time);
2832b5b1a830SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lx);
2833b5b1a830SBarry Smith   prhs[4] =  mxCreateString(sctx->funcname);
2834b5b1a830SBarry Smith   prhs[5] =  sctx->ctx;
2835b5b1a830SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr);
2836b5b1a830SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
2837b5b1a830SBarry Smith   mxDestroyArray(prhs[0]);
2838b5b1a830SBarry Smith   mxDestroyArray(prhs[1]);
2839b5b1a830SBarry Smith   mxDestroyArray(prhs[2]);
2840b5b1a830SBarry Smith   mxDestroyArray(prhs[3]);
2841b5b1a830SBarry Smith   mxDestroyArray(prhs[4]);
2842b5b1a830SBarry Smith   mxDestroyArray(plhs[0]);
2843b5b1a830SBarry Smith   PetscFunctionReturn(0);
2844b5b1a830SBarry Smith }
2845b5b1a830SBarry Smith 
2846b5b1a830SBarry Smith 
2847b5b1a830SBarry Smith #undef __FUNCT__
2848b5b1a830SBarry Smith #define __FUNCT__ "TSMonitorSetMatlab"
2849b5b1a830SBarry Smith /*
2850b5b1a830SBarry Smith    TSMonitorSetMatlab - Sets the monitor function from Matlab
2851b5b1a830SBarry Smith 
2852b5b1a830SBarry Smith    Level: developer
2853b5b1a830SBarry Smith 
2854b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function
2855b5b1a830SBarry Smith 
2856b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
2857b5b1a830SBarry Smith */
2858cdcf91faSSean Farley PetscErrorCode  TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx)
2859b5b1a830SBarry Smith {
2860b5b1a830SBarry Smith   PetscErrorCode    ierr;
2861b5b1a830SBarry Smith   TSMatlabContext *sctx;
2862b5b1a830SBarry Smith 
2863b5b1a830SBarry Smith   PetscFunctionBegin;
2864b5b1a830SBarry Smith   /* currently sctx is memory bleed */
2865b5b1a830SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
2866b5b1a830SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
2867b5b1a830SBarry Smith   /*
2868b5b1a830SBarry Smith      This should work, but it doesn't
2869b5b1a830SBarry Smith   sctx->ctx = ctx;
2870b5b1a830SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
2871b5b1a830SBarry Smith   */
2872b5b1a830SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
2873cdcf91faSSean Farley   ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,PETSC_NULL);CHKERRQ(ierr);
2874b5b1a830SBarry Smith   PetscFunctionReturn(0);
2875b5b1a830SBarry Smith }
2876b5b1a830SBarry Smith 
2877325fc9f4SBarry Smith #endif
2878