xref: /petsc/src/ts/interface/ts.c (revision 2d53ad75667bd9af5ca32c6f75ade56f24a4fbe1)
163dd3a1aSKris Buschelman 
2b45d2f2cSJed Brown #include <petsc-private/tsimpl.h>        /*I "petscts.h"  I*/
3496e6a7aSJed Brown #include <petscdmshell.h>
4d763cef2SBarry Smith 
5d5ba7fb7SMatthew Knepley /* Logging support */
6d74926cbSBarry Smith PetscClassId  TS_CLASSID, DMTS_CLASSID;
7166c7f25SBarry Smith PetscLogEvent  TS_Step, TS_PseudoComputeTimeStep, TS_FunctionEval, TS_JacobianEval;
8d405a339SMatthew Knepley 
94a2ae208SSatish Balay #undef __FUNCT__
10bdad233fSMatthew Knepley #define __FUNCT__ "TSSetTypeFromOptions"
11bdad233fSMatthew Knepley /*
12bdad233fSMatthew Knepley   TSSetTypeFromOptions - Sets the type of ts from user options.
13bdad233fSMatthew Knepley 
14bdad233fSMatthew Knepley   Collective on TS
15bdad233fSMatthew Knepley 
16bdad233fSMatthew Knepley   Input Parameter:
17bdad233fSMatthew Knepley . ts - The ts
18bdad233fSMatthew Knepley 
19bdad233fSMatthew Knepley   Level: intermediate
20bdad233fSMatthew Knepley 
21bdad233fSMatthew Knepley .keywords: TS, set, options, database, type
22bdad233fSMatthew Knepley .seealso: TSSetFromOptions(), TSSetType()
23bdad233fSMatthew Knepley */
246849ba73SBarry Smith static PetscErrorCode TSSetTypeFromOptions(TS ts)
25bdad233fSMatthew Knepley {
26ace3abfcSBarry Smith   PetscBool      opt;
272fc52814SBarry Smith   const char     *defaultType;
28bdad233fSMatthew Knepley   char           typeName[256];
29dfbe8321SBarry Smith   PetscErrorCode ierr;
30bdad233fSMatthew Knepley 
31bdad233fSMatthew Knepley   PetscFunctionBegin;
327adad957SLisandro Dalcin   if (((PetscObject)ts)->type_name) {
337adad957SLisandro Dalcin     defaultType = ((PetscObject)ts)->type_name;
34bdad233fSMatthew Knepley   } else {
359596e0b4SJed Brown     defaultType = TSEULER;
36bdad233fSMatthew Knepley   }
37bdad233fSMatthew Knepley 
38cce0b1b2SLisandro Dalcin   if (!TSRegisterAllCalled) {ierr = TSRegisterAll(PETSC_NULL);CHKERRQ(ierr);}
39bdad233fSMatthew Knepley   ierr = PetscOptionsList("-ts_type", "TS method"," TSSetType", TSList, defaultType, typeName, 256, &opt);CHKERRQ(ierr);
40a7cc72afSBarry Smith   if (opt) {
41bdad233fSMatthew Knepley     ierr = TSSetType(ts, typeName);CHKERRQ(ierr);
42bdad233fSMatthew Knepley   } else {
43bdad233fSMatthew Knepley     ierr = TSSetType(ts, defaultType);CHKERRQ(ierr);
44bdad233fSMatthew Knepley   }
45bdad233fSMatthew Knepley   PetscFunctionReturn(0);
46bdad233fSMatthew Knepley }
47bdad233fSMatthew Knepley 
48bdad233fSMatthew Knepley #undef __FUNCT__
49bdad233fSMatthew Knepley #define __FUNCT__ "TSSetFromOptions"
50bdad233fSMatthew Knepley /*@
51bdad233fSMatthew Knepley    TSSetFromOptions - Sets various TS parameters from user options.
52bdad233fSMatthew Knepley 
53bdad233fSMatthew Knepley    Collective on TS
54bdad233fSMatthew Knepley 
55bdad233fSMatthew Knepley    Input Parameter:
56bdad233fSMatthew Knepley .  ts - the TS context obtained from TSCreate()
57bdad233fSMatthew Knepley 
58bdad233fSMatthew Knepley    Options Database Keys:
594d91e141SJed Brown +  -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSGL, TSSSP
60bdad233fSMatthew Knepley .  -ts_max_steps maxsteps - maximum number of time-steps to take
613bca7d26SBarry Smith .  -ts_final_time time - maximum time to compute to
62bdad233fSMatthew Knepley .  -ts_dt dt - initial time step
63bdad233fSMatthew Knepley .  -ts_monitor - print information at each timestep
64de06c3feSJed Brown .  -ts_monitor_lg_timestep - Monitor timestep size graphically
65de06c3feSJed Brown .  -ts_monitor_lg_solution - Monitor solution graphically
66de06c3feSJed Brown .  -ts_monitor_lg_error - Monitor error graphically
67de06c3feSJed Brown .  -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically
68de06c3feSJed Brown .  -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically
69de06c3feSJed Brown .  -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically
70de06c3feSJed Brown .  -ts_monitor_draw_solution - Monitor solution graphically
71de06c3feSJed Brown .  -ts_monitor_draw_solution - Monitor solution graphically
72de06c3feSJed Brown .  -ts_monitor_draw_error - Monitor error graphically
73de06c3feSJed Brown .  -ts_monitor_draw_solution_binary <filename> - Save each solution to a binary file
74de06c3feSJed Brown -  -ts_monitor_draw_solution_vtk <filename.vts> - Save each time step to a binary file, use filename-%%03D.vts
75bdad233fSMatthew Knepley 
76bdad233fSMatthew Knepley    Level: beginner
77bdad233fSMatthew Knepley 
78bdad233fSMatthew Knepley .keywords: TS, timestep, set, options, database
79bdad233fSMatthew Knepley 
80a313700dSBarry Smith .seealso: TSGetType()
81bdad233fSMatthew Knepley @*/
827087cfbeSBarry Smith PetscErrorCode  TSSetFromOptions(TS ts)
83bdad233fSMatthew Knepley {
84ace3abfcSBarry Smith   PetscBool      opt,flg;
85dfbe8321SBarry Smith   PetscErrorCode ierr;
86649052a6SBarry Smith   PetscViewer    monviewer;
87eabae89aSBarry Smith   char           monfilename[PETSC_MAX_PATH_LEN];
88089b2837SJed Brown   SNES           snes;
891c3436cfSJed Brown   TSAdapt        adapt;
9031748224SBarry Smith   PetscReal      time_step;
91bdad233fSMatthew Knepley 
92bdad233fSMatthew Knepley   PetscFunctionBegin;
930700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
943194b578SJed Brown   ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr);
95a43b19c4SJed Brown     /* Handle TS type options */
96a43b19c4SJed Brown     ierr = TSSetTypeFromOptions(ts);CHKERRQ(ierr);
97bdad233fSMatthew Knepley 
98bdad233fSMatthew Knepley     /* Handle generic TS options */
99bdad233fSMatthew Knepley     ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetDuration",ts->max_steps,&ts->max_steps,PETSC_NULL);CHKERRQ(ierr);
1003bca7d26SBarry Smith     ierr = PetscOptionsReal("-ts_final_time","Time to run to","TSSetDuration",ts->max_time,&ts->max_time,PETSC_NULL);CHKERRQ(ierr);
101d8cd7023SBarry Smith     ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,PETSC_NULL);CHKERRQ(ierr);
10231748224SBarry Smith     ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr);
10331748224SBarry Smith     if (flg) {
10431748224SBarry Smith       ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
10531748224SBarry Smith     }
106a43b19c4SJed Brown     opt = ts->exact_final_time == PETSC_DECIDE ? PETSC_FALSE : (PetscBool)ts->exact_final_time;
107a43b19c4SJed Brown     ierr = PetscOptionsBool("-ts_exact_final_time","Interpolate output to stop exactly at the final time","TSSetExactFinalTime",opt,&opt,&flg);CHKERRQ(ierr);
108461e00b3SSean Farley     if (flg) {ierr = TSSetExactFinalTime(ts,opt);CHKERRQ(ierr);}
109cef5090cSJed Brown     ierr = PetscOptionsInt("-ts_max_snes_failures","Maximum number of nonlinear solve failures","TSSetMaxSNESFailures",ts->max_snes_failures,&ts->max_snes_failures,PETSC_NULL);CHKERRQ(ierr);
110cef5090cSJed Brown     ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,PETSC_NULL);CHKERRQ(ierr);
111cef5090cSJed Brown     ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,PETSC_NULL);CHKERRQ(ierr);
1121c3436cfSJed Brown     ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,PETSC_NULL);CHKERRQ(ierr);
1131c3436cfSJed Brown     ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,PETSC_NULL);CHKERRQ(ierr);
114bdad233fSMatthew Knepley 
115bdad233fSMatthew Knepley     /* Monitor options */
116a6570f20SBarry Smith     ierr = PetscOptionsString("-ts_monitor","Monitor timestep size","TSMonitorDefault","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
117eabae89aSBarry Smith     if (flg) {
118649052a6SBarry Smith       ierr = PetscViewerASCIIOpen(((PetscObject)ts)->comm,monfilename,&monviewer);CHKERRQ(ierr);
119649052a6SBarry Smith       ierr = TSMonitorSet(ts,TSMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
120bdad233fSMatthew Knepley     }
1215180491cSLisandro Dalcin     ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
1225180491cSLisandro Dalcin     if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);}
1235180491cSLisandro Dalcin 
1244f09c107SBarry Smith     ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr);
125a7cc72afSBarry Smith     if (opt) {
1260b039ecaSBarry Smith       TSMonitorLGCtx ctx;
1273923b477SBarry Smith       PetscInt       howoften = 1;
128a80ad3e0SBarry Smith 
1294f09c107SBarry Smith       ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,PETSC_NULL);CHKERRQ(ierr);
1301d1e9da1SBarry Smith       ierr = TSMonitorLGCtxCreate(((PetscObject)ts)->comm,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
1314f09c107SBarry Smith       ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
132b3603a34SBarry Smith     }
1334f09c107SBarry Smith     ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr);
134b3603a34SBarry Smith     if (opt) {
1350b039ecaSBarry Smith       TSMonitorLGCtx ctx;
1363923b477SBarry Smith       PetscInt       howoften = 1;
137b3603a34SBarry Smith 
1384f09c107SBarry Smith       ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,PETSC_NULL);CHKERRQ(ierr);
1393923b477SBarry Smith       ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);
1404f09c107SBarry Smith       ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
141bdad233fSMatthew Knepley     }
1424f09c107SBarry Smith     ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr);
143ef20d060SBarry Smith     if (opt) {
1440b039ecaSBarry Smith       TSMonitorLGCtx ctx;
1453923b477SBarry Smith       PetscInt       howoften = 1;
146ef20d060SBarry Smith 
1474f09c107SBarry Smith       ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,PETSC_NULL);CHKERRQ(ierr);
1483923b477SBarry Smith       ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);
1494f09c107SBarry Smith       ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
150ef20d060SBarry Smith     }
151201da799SBarry Smith     ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr);
152201da799SBarry Smith     if (opt) {
153201da799SBarry Smith       TSMonitorLGCtx ctx;
154201da799SBarry Smith       PetscInt       howoften = 1;
155201da799SBarry Smith 
156201da799SBarry Smith       ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,PETSC_NULL);CHKERRQ(ierr);
157201da799SBarry Smith       ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);
158201da799SBarry Smith       ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
159201da799SBarry Smith     }
160201da799SBarry Smith     ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr);
161201da799SBarry Smith     if (opt) {
162201da799SBarry Smith       TSMonitorLGCtx ctx;
163201da799SBarry Smith       PetscInt       howoften = 1;
164201da799SBarry Smith 
165201da799SBarry Smith       ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,PETSC_NULL);CHKERRQ(ierr);
166201da799SBarry Smith       ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);
167201da799SBarry Smith       ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
168201da799SBarry Smith     }
1698189c53fSBarry Smith     ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr);
1708189c53fSBarry Smith     if (opt) {
1718189c53fSBarry Smith       TSMonitorSPEigCtx ctx;
1728189c53fSBarry Smith       PetscInt          howoften = 1;
1738189c53fSBarry Smith 
1748189c53fSBarry Smith       ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,PETSC_NULL);CHKERRQ(ierr);
1758189c53fSBarry Smith       ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);
1768189c53fSBarry Smith       ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr);
1778189c53fSBarry Smith     }
178ef20d060SBarry Smith     opt  = PETSC_FALSE;
1790dcf80beSBarry Smith     ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr);
180a7cc72afSBarry Smith     if (opt) {
18183a4ac43SBarry Smith       TSMonitorDrawCtx ctx;
18283a4ac43SBarry Smith       PetscInt         howoften = 1;
183a80ad3e0SBarry Smith 
18483a4ac43SBarry Smith       ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,PETSC_NULL);CHKERRQ(ierr);
18583a4ac43SBarry Smith       ierr = TSMonitorDrawCtxCreate(((PetscObject)ts)->comm,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);
18683a4ac43SBarry Smith       ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
187bdad233fSMatthew Knepley     }
188fb1732b5SBarry Smith     opt  = PETSC_FALSE;
1890dcf80beSBarry Smith     ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr);
1903a471f94SBarry Smith     if (opt) {
19183a4ac43SBarry Smith       TSMonitorDrawCtx ctx;
19283a4ac43SBarry Smith       PetscInt         howoften = 1;
1933a471f94SBarry Smith 
19483a4ac43SBarry Smith       ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,PETSC_NULL);CHKERRQ(ierr);
19583a4ac43SBarry Smith       ierr = TSMonitorDrawCtxCreate(((PetscObject)ts)->comm,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);
19683a4ac43SBarry Smith       ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
1973a471f94SBarry Smith     }
1983a471f94SBarry Smith     opt  = PETSC_FALSE;
199de06c3feSJed Brown     ierr = PetscOptionsString("-ts_monitor_draw_solution_binary","Save each solution to a binary file","TSMonitorSolutionBinary",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
200fb1732b5SBarry Smith     if (flg) {
201fb1732b5SBarry Smith       PetscViewer ctx;
202fb1732b5SBarry Smith       if (monfilename[0]) {
203fb1732b5SBarry Smith         ierr = PetscViewerBinaryOpen(((PetscObject)ts)->comm,monfilename,FILE_MODE_WRITE,&ctx);CHKERRQ(ierr);
204fb1732b5SBarry Smith       } else {
205fb1732b5SBarry Smith         ctx = PETSC_VIEWER_BINARY_(((PetscObject)ts)->comm);
206fb1732b5SBarry Smith       }
207fb1732b5SBarry Smith       ierr = TSMonitorSet(ts,TSMonitorSolutionBinary,ctx,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
208fb1732b5SBarry Smith     }
209ed81e22dSJed Brown     opt  = PETSC_FALSE;
210de06c3feSJed Brown     ierr = PetscOptionsString("-ts_monitor_draw_solution_vtk","Save each time step to a binary file, use filename-%%03D.vts","TSMonitorSolutionVTK",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
211ed81e22dSJed Brown     if (flg) {
212ed81e22dSJed Brown       const char *ptr,*ptr2;
213ed81e22dSJed Brown       char *filetemplate;
214de06c3feSJed Brown       if (!monfilename[0]) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"-ts_monitor_draw_solution_vtk requires a file template, e.g. filename-%%03D.vts");
215ed81e22dSJed Brown       /* Do some cursory validation of the input. */
216ed81e22dSJed Brown       ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr);
217de06c3feSJed Brown       if (!ptr) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"-ts_monitor_draw_solution_vtk requires a file template, e.g. filename-%%03D.vts");
218ed81e22dSJed Brown       for (ptr++ ; ptr && *ptr; ptr++) {
219ed81e22dSJed Brown         ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr);
220de06c3feSJed Brown         if (!ptr2 && (*ptr < '0' || '9' < *ptr)) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"Invalid file template argument to -ts_monitor_draw_solution_vtk, should look like filename-%%03D.vts");
221ed81e22dSJed Brown         if (ptr2) break;
222ed81e22dSJed Brown       }
223ed81e22dSJed Brown       ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr);
224ed81e22dSJed Brown       ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr);
225ed81e22dSJed Brown     }
226bdad233fSMatthew Knepley 
2271c3436cfSJed Brown     ierr = TSGetAdapt(ts,&adapt);CHKERRQ(ierr);
2281c3436cfSJed Brown     ierr = TSAdaptSetFromOptions(adapt);CHKERRQ(ierr);
2291c3436cfSJed Brown 
230d52bd9f3SBarry Smith     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
231d52bd9f3SBarry Smith     if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);}
232d52bd9f3SBarry Smith 
233bdad233fSMatthew Knepley     /* Handle specific TS options */
234abc0a331SBarry Smith     if (ts->ops->setfromoptions) {
235bdad233fSMatthew Knepley       ierr = (*ts->ops->setfromoptions)(ts);CHKERRQ(ierr);
236bdad233fSMatthew Knepley     }
2375d973c19SBarry Smith 
2385d973c19SBarry Smith     /* process any options handlers added with PetscObjectAddOptionsHandler() */
2395d973c19SBarry Smith     ierr = PetscObjectProcessOptionsHandlers((PetscObject)ts);CHKERRQ(ierr);
240bdad233fSMatthew Knepley   ierr = PetscOptionsEnd();CHKERRQ(ierr);
241bdad233fSMatthew Knepley   PetscFunctionReturn(0);
242bdad233fSMatthew Knepley }
243bdad233fSMatthew Knepley 
244bdad233fSMatthew Knepley #undef __FUNCT__
245cdcf91faSSean Farley #undef __FUNCT__
2464a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSJacobian"
247a7a1495cSBarry Smith /*@
2488c385f81SBarry Smith    TSComputeRHSJacobian - Computes the Jacobian matrix that has been
249a7a1495cSBarry Smith       set with TSSetRHSJacobian().
250a7a1495cSBarry Smith 
251a7a1495cSBarry Smith    Collective on TS and Vec
252a7a1495cSBarry Smith 
253a7a1495cSBarry Smith    Input Parameters:
254316643e7SJed Brown +  ts - the TS context
255a7a1495cSBarry Smith .  t - current timestep
2560910c330SBarry Smith -  U - input vector
257a7a1495cSBarry Smith 
258a7a1495cSBarry Smith    Output Parameters:
259a7a1495cSBarry Smith +  A - Jacobian matrix
260a7a1495cSBarry Smith .  B - optional preconditioning matrix
261a7a1495cSBarry Smith -  flag - flag indicating matrix structure
262a7a1495cSBarry Smith 
263a7a1495cSBarry Smith    Notes:
264a7a1495cSBarry Smith    Most users should not need to explicitly call this routine, as it
265a7a1495cSBarry Smith    is used internally within the nonlinear solvers.
266a7a1495cSBarry Smith 
26794b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the
268a7a1495cSBarry Smith    flag parameter.
269a7a1495cSBarry Smith 
270a7a1495cSBarry Smith    Level: developer
271a7a1495cSBarry Smith 
272a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix
273a7a1495cSBarry Smith 
27494b7f48cSBarry Smith .seealso:  TSSetRHSJacobian(), KSPSetOperators()
275a7a1495cSBarry Smith @*/
2760910c330SBarry Smith PetscErrorCode  TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat *A,Mat *B,MatStructure *flg)
277a7a1495cSBarry Smith {
278dfbe8321SBarry Smith   PetscErrorCode ierr;
2790910c330SBarry Smith   PetscInt       Ustate;
28024989b8cSPeter Brune   DM             dm;
281942e3340SBarry Smith   DMTS           tsdm;
28224989b8cSPeter Brune   TSRHSJacobian  rhsjacobianfunc;
28324989b8cSPeter Brune   void           *ctx;
28424989b8cSPeter Brune   TSIJacobian    ijacobianfunc;
285a7a1495cSBarry Smith 
286a7a1495cSBarry Smith   PetscFunctionBegin;
2870700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2880910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
2890910c330SBarry Smith   PetscCheckSameComm(ts,1,U,3);
29024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
291942e3340SBarry Smith   ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr);
29224989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr);
29324989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,&ijacobianfunc,PETSC_NULL);CHKERRQ(ierr);
2940910c330SBarry Smith   ierr = PetscObjectStateQuery((PetscObject)U,&Ustate);CHKERRQ(ierr);
2950910c330SBarry Smith   if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.X == U && ts->rhsjacobian.Xstate == Ustate))) {
2960e4ef248SJed Brown     *flg = ts->rhsjacobian.mstructure;
2970e4ef248SJed Brown     PetscFunctionReturn(0);
298f8ede8e7SJed Brown   }
299d90be118SSean Farley 
30024989b8cSPeter Brune   if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
301d90be118SSean Farley 
30224989b8cSPeter Brune   if (rhsjacobianfunc) {
3030910c330SBarry Smith     ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,*A,*B);CHKERRQ(ierr);
304a7a1495cSBarry Smith     *flg = DIFFERENT_NONZERO_PATTERN;
305a7a1495cSBarry Smith     PetscStackPush("TS user Jacobian function");
3060910c330SBarry Smith     ierr = (*rhsjacobianfunc)(ts,t,U,A,B,flg,ctx);CHKERRQ(ierr);
307a7a1495cSBarry Smith     PetscStackPop;
3080910c330SBarry Smith     ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,*A,*B);CHKERRQ(ierr);
309a7a1495cSBarry Smith     /* make sure user returned a correct Jacobian and preconditioner */
3100700a824SBarry Smith     PetscValidHeaderSpecific(*A,MAT_CLASSID,4);
3110700a824SBarry Smith     PetscValidHeaderSpecific(*B,MAT_CLASSID,5);
312ef66eb69SBarry Smith   } else {
313214bc6a2SJed Brown     ierr = MatZeroEntries(*A);CHKERRQ(ierr);
314214bc6a2SJed Brown     if (*A != *B) {ierr = MatZeroEntries(*B);CHKERRQ(ierr);}
315214bc6a2SJed Brown     *flg = SAME_NONZERO_PATTERN;
316ef66eb69SBarry Smith   }
3170e4ef248SJed Brown   ts->rhsjacobian.time = t;
3180910c330SBarry Smith   ts->rhsjacobian.X = U;
3190910c330SBarry Smith   ierr = PetscObjectStateQuery((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr);
3200e4ef248SJed Brown   ts->rhsjacobian.mstructure = *flg;
321a7a1495cSBarry Smith   PetscFunctionReturn(0);
322a7a1495cSBarry Smith }
323a7a1495cSBarry Smith 
3244a2ae208SSatish Balay #undef __FUNCT__
3254a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSFunction"
326316643e7SJed Brown /*@
327d763cef2SBarry Smith    TSComputeRHSFunction - Evaluates the right-hand-side function.
328d763cef2SBarry Smith 
329316643e7SJed Brown    Collective on TS and Vec
330316643e7SJed Brown 
331316643e7SJed Brown    Input Parameters:
332316643e7SJed Brown +  ts - the TS context
333316643e7SJed Brown .  t - current time
3340910c330SBarry Smith -  U - state vector
335316643e7SJed Brown 
336316643e7SJed Brown    Output Parameter:
337316643e7SJed Brown .  y - right hand side
338316643e7SJed Brown 
339316643e7SJed Brown    Note:
340316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
341316643e7SJed Brown    is used internally within the nonlinear solvers.
342316643e7SJed Brown 
343316643e7SJed Brown    Level: developer
344316643e7SJed Brown 
345316643e7SJed Brown .keywords: TS, compute
346316643e7SJed Brown 
347316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction()
348316643e7SJed Brown @*/
3490910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y)
350d763cef2SBarry Smith {
351dfbe8321SBarry Smith   PetscErrorCode ierr;
35224989b8cSPeter Brune   TSRHSFunction  rhsfunction;
35324989b8cSPeter Brune   TSIFunction    ifunction;
35424989b8cSPeter Brune   void           *ctx;
35524989b8cSPeter Brune   DM             dm;
35624989b8cSPeter Brune 
357d763cef2SBarry Smith   PetscFunctionBegin;
3580700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3590910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
3600700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,4);
36124989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
36224989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
36324989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,&ifunction,PETSC_NULL);CHKERRQ(ierr);
364d763cef2SBarry Smith 
36524989b8cSPeter Brune   if (!rhsfunction && !ifunction) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
366d763cef2SBarry Smith 
3670910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
36824989b8cSPeter Brune   if (rhsfunction) {
369d763cef2SBarry Smith     PetscStackPush("TS user right-hand-side function");
3700910c330SBarry Smith     ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr);
371d763cef2SBarry Smith     PetscStackPop;
372214bc6a2SJed Brown   } else {
373214bc6a2SJed Brown     ierr = VecZeroEntries(y);CHKERRQ(ierr);
374b2cd27e8SJed Brown   }
37544a41b28SSean Farley 
3760910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
377d763cef2SBarry Smith   PetscFunctionReturn(0);
378d763cef2SBarry Smith }
379d763cef2SBarry Smith 
3804a2ae208SSatish Balay #undef __FUNCT__
381ef20d060SBarry Smith #define __FUNCT__ "TSComputeSolutionFunction"
382ef20d060SBarry Smith /*@
383ef20d060SBarry Smith    TSComputeSolutionFunction - Evaluates the solution function.
384ef20d060SBarry Smith 
385ef20d060SBarry Smith    Collective on TS and Vec
386ef20d060SBarry Smith 
387ef20d060SBarry Smith    Input Parameters:
388ef20d060SBarry Smith +  ts - the TS context
389ef20d060SBarry Smith -  t - current time
390ef20d060SBarry Smith 
391ef20d060SBarry Smith    Output Parameter:
3920910c330SBarry Smith .  U - the solution
393ef20d060SBarry Smith 
394ef20d060SBarry Smith    Note:
395ef20d060SBarry Smith    Most users should not need to explicitly call this routine, as it
396ef20d060SBarry Smith    is used internally within the nonlinear solvers.
397ef20d060SBarry Smith 
398ef20d060SBarry Smith    Level: developer
399ef20d060SBarry Smith 
400ef20d060SBarry Smith .keywords: TS, compute
401ef20d060SBarry Smith 
402abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
403ef20d060SBarry Smith @*/
4040910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U)
405ef20d060SBarry Smith {
406ef20d060SBarry Smith   PetscErrorCode     ierr;
407ef20d060SBarry Smith   TSSolutionFunction solutionfunction;
408ef20d060SBarry Smith   void               *ctx;
409ef20d060SBarry Smith   DM                 dm;
410ef20d060SBarry Smith 
411ef20d060SBarry Smith   PetscFunctionBegin;
412ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4130910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
414ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
415ef20d060SBarry Smith   ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr);
416ef20d060SBarry Smith 
417ef20d060SBarry Smith   if (solutionfunction) {
418ef20d060SBarry Smith     PetscStackPush("TS user right-hand-side function");
4190910c330SBarry Smith     ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr);
420ef20d060SBarry Smith     PetscStackPop;
421ef20d060SBarry Smith   }
422ef20d060SBarry Smith   PetscFunctionReturn(0);
423ef20d060SBarry Smith }
424ef20d060SBarry Smith 
425ef20d060SBarry Smith #undef __FUNCT__
426214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSVec_Private"
427214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs)
428214bc6a2SJed Brown {
4292dd45cf8SJed Brown   Vec            F;
430214bc6a2SJed Brown   PetscErrorCode ierr;
431214bc6a2SJed Brown 
432214bc6a2SJed Brown   PetscFunctionBegin;
4330da9a4f0SJed Brown   *Frhs = PETSC_NULL;
4342dd45cf8SJed Brown   ierr = TSGetIFunction(ts,&F,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
435214bc6a2SJed Brown   if (!ts->Frhs) {
4362dd45cf8SJed Brown     ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr);
437214bc6a2SJed Brown   }
438214bc6a2SJed Brown   *Frhs = ts->Frhs;
439214bc6a2SJed Brown   PetscFunctionReturn(0);
440214bc6a2SJed Brown }
441214bc6a2SJed Brown 
442214bc6a2SJed Brown #undef __FUNCT__
443214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSMats_Private"
444214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs)
445214bc6a2SJed Brown {
446214bc6a2SJed Brown   Mat            A,B;
4472dd45cf8SJed Brown   PetscErrorCode ierr;
448214bc6a2SJed Brown 
449214bc6a2SJed Brown   PetscFunctionBegin;
450214bc6a2SJed Brown   ierr = TSGetIJacobian(ts,&A,&B,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
451214bc6a2SJed Brown   if (Arhs) {
452214bc6a2SJed Brown     if (!ts->Arhs) {
453214bc6a2SJed Brown       ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr);
454214bc6a2SJed Brown     }
455214bc6a2SJed Brown     *Arhs = ts->Arhs;
456214bc6a2SJed Brown   }
457214bc6a2SJed Brown   if (Brhs) {
458214bc6a2SJed Brown     if (!ts->Brhs) {
459214bc6a2SJed Brown       ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr);
460214bc6a2SJed Brown     }
461214bc6a2SJed Brown     *Brhs = ts->Brhs;
462214bc6a2SJed Brown   }
463214bc6a2SJed Brown   PetscFunctionReturn(0);
464214bc6a2SJed Brown }
465214bc6a2SJed Brown 
466214bc6a2SJed Brown #undef __FUNCT__
467316643e7SJed Brown #define __FUNCT__ "TSComputeIFunction"
468316643e7SJed Brown /*@
4690910c330SBarry Smith    TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0
470316643e7SJed Brown 
471316643e7SJed Brown    Collective on TS and Vec
472316643e7SJed Brown 
473316643e7SJed Brown    Input Parameters:
474316643e7SJed Brown +  ts - the TS context
475316643e7SJed Brown .  t - current time
4760910c330SBarry Smith .  U - state vector
4770910c330SBarry Smith .  Udot - time derivative of state vector
478214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate
479316643e7SJed Brown 
480316643e7SJed Brown    Output Parameter:
481316643e7SJed Brown .  Y - right hand side
482316643e7SJed Brown 
483316643e7SJed Brown    Note:
484316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
485316643e7SJed Brown    is used internally within the nonlinear solvers.
486316643e7SJed Brown 
487316643e7SJed Brown    If the user did did not write their equations in implicit form, this
488316643e7SJed Brown    function recasts them in implicit form.
489316643e7SJed Brown 
490316643e7SJed Brown    Level: developer
491316643e7SJed Brown 
492316643e7SJed Brown .keywords: TS, compute
493316643e7SJed Brown 
494316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction()
495316643e7SJed Brown @*/
4960910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex)
497316643e7SJed Brown {
498316643e7SJed Brown   PetscErrorCode ierr;
49924989b8cSPeter Brune   TSIFunction    ifunction;
50024989b8cSPeter Brune   TSRHSFunction  rhsfunction;
50124989b8cSPeter Brune   void           *ctx;
50224989b8cSPeter Brune   DM             dm;
503316643e7SJed Brown 
504316643e7SJed Brown   PetscFunctionBegin;
5050700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5060910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
5070910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
5080700a824SBarry Smith   PetscValidHeaderSpecific(Y,VEC_CLASSID,5);
509316643e7SJed Brown 
51024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
51124989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr);
51224989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,&rhsfunction,PETSC_NULL);CHKERRQ(ierr);
51324989b8cSPeter Brune 
51424989b8cSPeter Brune   if (!rhsfunction && !ifunction) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
515d90be118SSean Farley 
5160910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
51724989b8cSPeter Brune   if (ifunction) {
518316643e7SJed Brown     PetscStackPush("TS user implicit function");
5190910c330SBarry Smith     ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr);
520316643e7SJed Brown     PetscStackPop;
521214bc6a2SJed Brown   }
522214bc6a2SJed Brown   if (imex) {
52324989b8cSPeter Brune     if (!ifunction) {
5240910c330SBarry Smith       ierr = VecCopy(Udot,Y);CHKERRQ(ierr);
5252dd45cf8SJed Brown     }
52624989b8cSPeter Brune   } else if (rhsfunction) {
52724989b8cSPeter Brune     if (ifunction) {
528214bc6a2SJed Brown       Vec Frhs;
529214bc6a2SJed Brown       ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
5300910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
531214bc6a2SJed Brown       ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr);
5322dd45cf8SJed Brown     } else {
5330910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr);
5340910c330SBarry Smith       ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr);
535316643e7SJed Brown     }
5364a6899ffSJed Brown   }
5370910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
538316643e7SJed Brown   PetscFunctionReturn(0);
539316643e7SJed Brown }
540316643e7SJed Brown 
541316643e7SJed Brown #undef __FUNCT__
542316643e7SJed Brown #define __FUNCT__ "TSComputeIJacobian"
543316643e7SJed Brown /*@
544316643e7SJed Brown    TSComputeIJacobian - Evaluates the Jacobian of the DAE
545316643e7SJed Brown 
546316643e7SJed Brown    Collective on TS and Vec
547316643e7SJed Brown 
548316643e7SJed Brown    Input
549316643e7SJed Brown       Input Parameters:
550316643e7SJed Brown +  ts - the TS context
551316643e7SJed Brown .  t - current timestep
5520910c330SBarry Smith .  U - state vector
5530910c330SBarry Smith .  Udot - time derivative of state vector
554214bc6a2SJed Brown .  shift - shift to apply, see note below
555214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate
556316643e7SJed Brown 
557316643e7SJed Brown    Output Parameters:
558316643e7SJed Brown +  A - Jacobian matrix
559316643e7SJed Brown .  B - optional preconditioning matrix
560316643e7SJed Brown -  flag - flag indicating matrix structure
561316643e7SJed Brown 
562316643e7SJed Brown    Notes:
5630910c330SBarry Smith    If F(t,U,Udot)=0 is the DAE, the required Jacobian is
564316643e7SJed Brown 
5650910c330SBarry Smith    dF/dU + shift*dF/dUdot
566316643e7SJed Brown 
567316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
568316643e7SJed Brown    is used internally within the nonlinear solvers.
569316643e7SJed Brown 
570316643e7SJed Brown    Level: developer
571316643e7SJed Brown 
572316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix
573316643e7SJed Brown 
574316643e7SJed Brown .seealso:  TSSetIJacobian()
57563495f91SJed Brown @*/
5760910c330SBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat *A,Mat *B,MatStructure *flg,PetscBool imex)
577316643e7SJed Brown {
5780910c330SBarry Smith   PetscInt       Ustate, Udotstate;
579316643e7SJed Brown   PetscErrorCode ierr;
58024989b8cSPeter Brune   TSIJacobian    ijacobian;
58124989b8cSPeter Brune   TSRHSJacobian  rhsjacobian;
58224989b8cSPeter Brune   DM             dm;
58324989b8cSPeter Brune   void           *ctx;
584316643e7SJed Brown 
585316643e7SJed Brown   PetscFunctionBegin;
58624989b8cSPeter Brune 
5870700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5880910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
5890910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
590316643e7SJed Brown   PetscValidPointer(A,6);
5910700a824SBarry Smith   PetscValidHeaderSpecific(*A,MAT_CLASSID,6);
592316643e7SJed Brown   PetscValidPointer(B,7);
5930700a824SBarry Smith   PetscValidHeaderSpecific(*B,MAT_CLASSID,7);
594316643e7SJed Brown   PetscValidPointer(flg,8);
59524989b8cSPeter Brune 
59624989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
59724989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr);
59824989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,PETSC_NULL);CHKERRQ(ierr);
59924989b8cSPeter Brune 
6000910c330SBarry Smith   ierr = PetscObjectStateQuery((PetscObject)U,&Ustate);CHKERRQ(ierr);
6010910c330SBarry Smith   ierr = PetscObjectStateQuery((PetscObject)Udot,&Udotstate);CHKERRQ(ierr);
6020910c330SBarry Smith   if (ts->ijacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->ijacobian.X == U && ts->ijacobian.Xstate == Ustate && ts->ijacobian.Xdot == Udot && ts->ijacobian.Xdotstate == Udotstate && ts->ijacobian.imex == imex))) {
6030026cea9SSean Farley     *flg = ts->ijacobian.mstructure;
6040026cea9SSean Farley     ierr = MatScale(*A, shift / ts->ijacobian.shift);CHKERRQ(ierr);
6050026cea9SSean Farley     PetscFunctionReturn(0);
6060026cea9SSean Farley   }
607316643e7SJed Brown 
60824989b8cSPeter Brune   if (!rhsjacobian && !ijacobian) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
609316643e7SJed Brown 
6104e684422SJed Brown   *flg = SAME_NONZERO_PATTERN;  /* In case we're solving a linear problem in which case it wouldn't get initialized below. */
6110910c330SBarry Smith   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,*A,*B);CHKERRQ(ierr);
61224989b8cSPeter Brune   if (ijacobian) {
6132dd45cf8SJed Brown     *flg = DIFFERENT_NONZERO_PATTERN;
614316643e7SJed Brown     PetscStackPush("TS user implicit Jacobian");
6150910c330SBarry Smith     ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,flg,ctx);CHKERRQ(ierr);
616316643e7SJed Brown     PetscStackPop;
617214bc6a2SJed Brown     /* make sure user returned a correct Jacobian and preconditioner */
618214bc6a2SJed Brown     PetscValidHeaderSpecific(*A,MAT_CLASSID,4);
619214bc6a2SJed Brown     PetscValidHeaderSpecific(*B,MAT_CLASSID,5);
6204a6899ffSJed Brown   }
621214bc6a2SJed Brown   if (imex) {
622b5abc632SBarry Smith     if (!ijacobian) {  /* system was written as Udot = G(t,U) */
623214bc6a2SJed Brown       ierr = MatZeroEntries(*A);CHKERRQ(ierr);
6242dd45cf8SJed Brown       ierr = MatShift(*A,shift);CHKERRQ(ierr);
625214bc6a2SJed Brown       if (*A != *B) {
626214bc6a2SJed Brown         ierr = MatZeroEntries(*B);CHKERRQ(ierr);
627214bc6a2SJed Brown         ierr = MatShift(*B,shift);CHKERRQ(ierr);
628214bc6a2SJed Brown       }
629214bc6a2SJed Brown       *flg = SAME_PRECONDITIONER;
630214bc6a2SJed Brown     }
631214bc6a2SJed Brown   } else {
63224989b8cSPeter Brune     if (!ijacobian) {
6330910c330SBarry Smith       ierr = TSComputeRHSJacobian(ts,t,U,A,B,flg);CHKERRQ(ierr);
634214bc6a2SJed Brown       ierr = MatScale(*A,-1);CHKERRQ(ierr);
635214bc6a2SJed Brown       ierr = MatShift(*A,shift);CHKERRQ(ierr);
636316643e7SJed Brown       if (*A != *B) {
637316643e7SJed Brown         ierr = MatScale(*B,-1);CHKERRQ(ierr);
638316643e7SJed Brown         ierr = MatShift(*B,shift);CHKERRQ(ierr);
639316643e7SJed Brown       }
64024989b8cSPeter Brune     } else if (rhsjacobian) {
641214bc6a2SJed Brown       Mat Arhs,Brhs;
642214bc6a2SJed Brown       MatStructure axpy,flg2 = DIFFERENT_NONZERO_PATTERN;
643214bc6a2SJed Brown       ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
6440910c330SBarry Smith       ierr = TSComputeRHSJacobian(ts,t,U,&Arhs,&Brhs,&flg2);CHKERRQ(ierr);
645214bc6a2SJed Brown       axpy = (*flg == flg2) ? SAME_NONZERO_PATTERN : DIFFERENT_NONZERO_PATTERN;
646214bc6a2SJed Brown       ierr = MatAXPY(*A,-1,Arhs,axpy);CHKERRQ(ierr);
647214bc6a2SJed Brown       if (*A != *B) {
648214bc6a2SJed Brown         ierr = MatAXPY(*B,-1,Brhs,axpy);CHKERRQ(ierr);
649214bc6a2SJed Brown       }
650214bc6a2SJed Brown       *flg = PetscMin(*flg,flg2);
651214bc6a2SJed Brown     }
652316643e7SJed Brown   }
6530026cea9SSean Farley 
6540026cea9SSean Farley   ts->ijacobian.time = t;
6550910c330SBarry Smith   ts->ijacobian.X = U;
6560910c330SBarry Smith   ts->ijacobian.Xdot = Udot;
6570910c330SBarry Smith   ierr = PetscObjectStateQuery((PetscObject)U,&ts->ijacobian.Xstate);CHKERRQ(ierr);
6580910c330SBarry Smith   ierr = PetscObjectStateQuery((PetscObject)Udot,&ts->ijacobian.Xdotstate);CHKERRQ(ierr);
6590026cea9SSean Farley   ts->ijacobian.shift = shift;
6600026cea9SSean Farley   ts->ijacobian.imex = imex;
6610026cea9SSean Farley   ts->ijacobian.mstructure = *flg;
6620910c330SBarry Smith   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,*A,*B);CHKERRQ(ierr);
663316643e7SJed Brown   PetscFunctionReturn(0);
664316643e7SJed Brown }
665316643e7SJed Brown 
666316643e7SJed Brown #undef __FUNCT__
6674a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSFunction"
668d763cef2SBarry Smith /*@C
669d763cef2SBarry Smith     TSSetRHSFunction - Sets the routine for evaluating the function,
670b5abc632SBarry Smith     where U_t = G(t,u).
671d763cef2SBarry Smith 
6723f9fe445SBarry Smith     Logically Collective on TS
673d763cef2SBarry Smith 
674d763cef2SBarry Smith     Input Parameters:
675d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
676ca94891dSJed Brown .   r - vector to put the computed right hand side (or PETSC_NULL to have it created)
677d763cef2SBarry Smith .   f - routine for evaluating the right-hand-side function
678d763cef2SBarry Smith -   ctx - [optional] user-defined context for private data for the
679d763cef2SBarry Smith           function evaluation routine (may be PETSC_NULL)
680d763cef2SBarry Smith 
681d763cef2SBarry Smith     Calling sequence of func:
68287828ca2SBarry Smith $     func (TS ts,PetscReal t,Vec u,Vec F,void *ctx);
683d763cef2SBarry Smith 
684d763cef2SBarry Smith +   t - current timestep
685d763cef2SBarry Smith .   u - input vector
686d763cef2SBarry Smith .   F - function vector
687d763cef2SBarry Smith -   ctx - [optional] user-defined function context
688d763cef2SBarry Smith 
689d763cef2SBarry Smith     Level: beginner
690d763cef2SBarry Smith 
691d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
692d763cef2SBarry Smith 
693d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian()
694d763cef2SBarry Smith @*/
695089b2837SJed Brown PetscErrorCode  TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx)
696d763cef2SBarry Smith {
697089b2837SJed Brown   PetscErrorCode ierr;
698089b2837SJed Brown   SNES           snes;
699e856ceecSJed Brown   Vec            ralloc = PETSC_NULL;
70024989b8cSPeter Brune   DM             dm;
701d763cef2SBarry Smith 
702089b2837SJed Brown   PetscFunctionBegin;
7030700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
704ca94891dSJed Brown   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
70524989b8cSPeter Brune 
70624989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
70724989b8cSPeter Brune   ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr);
708089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
709e856ceecSJed Brown   if (!r && !ts->dm && ts->vec_sol) {
710e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
711e856ceecSJed Brown     r = ralloc;
712e856ceecSJed Brown   }
713089b2837SJed Brown   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
714e856ceecSJed Brown   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
715d763cef2SBarry Smith   PetscFunctionReturn(0);
716d763cef2SBarry Smith }
717d763cef2SBarry Smith 
7184a2ae208SSatish Balay #undef __FUNCT__
719ef20d060SBarry Smith #define __FUNCT__ "TSSetSolutionFunction"
720ef20d060SBarry Smith /*@C
721abd5a294SJed Brown     TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE
722ef20d060SBarry Smith 
723ef20d060SBarry Smith     Logically Collective on TS
724ef20d060SBarry Smith 
725ef20d060SBarry Smith     Input Parameters:
726ef20d060SBarry Smith +   ts - the TS context obtained from TSCreate()
727ef20d060SBarry Smith .   f - routine for evaluating the solution
728ef20d060SBarry Smith -   ctx - [optional] user-defined context for private data for the
729ef20d060SBarry Smith           function evaluation routine (may be PETSC_NULL)
730ef20d060SBarry Smith 
731ef20d060SBarry Smith     Calling sequence of func:
732ef20d060SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
733ef20d060SBarry Smith 
734ef20d060SBarry Smith +   t - current timestep
735ef20d060SBarry Smith .   u - output vector
736ef20d060SBarry Smith -   ctx - [optional] user-defined function context
737ef20d060SBarry Smith 
738abd5a294SJed Brown     Notes:
739abd5a294SJed Brown     This routine is used for testing accuracy of time integration schemes when you already know the solution.
740abd5a294SJed Brown     If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to
741abd5a294SJed Brown     create closed-form solutions with non-physical forcing terms.
742abd5a294SJed Brown 
7434f09c107SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
744abd5a294SJed Brown 
745ef20d060SBarry Smith     Level: beginner
746ef20d060SBarry Smith 
747ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
748ef20d060SBarry Smith 
749abd5a294SJed Brown .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction()
750ef20d060SBarry Smith @*/
751ef20d060SBarry Smith PetscErrorCode  TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
752ef20d060SBarry Smith {
753ef20d060SBarry Smith   PetscErrorCode ierr;
754ef20d060SBarry Smith   DM             dm;
755ef20d060SBarry Smith 
756ef20d060SBarry Smith   PetscFunctionBegin;
757ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
758ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
759ef20d060SBarry Smith   ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr);
760ef20d060SBarry Smith   PetscFunctionReturn(0);
761ef20d060SBarry Smith }
762ef20d060SBarry Smith 
763ef20d060SBarry Smith #undef __FUNCT__
7644a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSJacobian"
765d763cef2SBarry Smith /*@C
766d763cef2SBarry Smith    TSSetRHSJacobian - Sets the function to compute the Jacobian of F,
767b5abc632SBarry Smith    where U_t = G(U,t), as well as the location to store the matrix.
768d763cef2SBarry Smith 
7693f9fe445SBarry Smith    Logically Collective on TS
770d763cef2SBarry Smith 
771d763cef2SBarry Smith    Input Parameters:
772d763cef2SBarry Smith +  ts  - the TS context obtained from TSCreate()
773d763cef2SBarry Smith .  A   - Jacobian matrix
774d763cef2SBarry Smith .  B   - preconditioner matrix (usually same as A)
775d763cef2SBarry Smith .  f   - the Jacobian evaluation routine
776d763cef2SBarry Smith -  ctx - [optional] user-defined context for private data for the
777d763cef2SBarry Smith          Jacobian evaluation routine (may be PETSC_NULL)
778d763cef2SBarry Smith 
779d763cef2SBarry Smith    Calling sequence of func:
78087828ca2SBarry Smith $     func (TS ts,PetscReal t,Vec u,Mat *A,Mat *B,MatStructure *flag,void *ctx);
781d763cef2SBarry Smith 
782d763cef2SBarry Smith +  t - current timestep
783d763cef2SBarry Smith .  u - input vector
784d763cef2SBarry Smith .  A - matrix A, where U_t = A(t)u
785d763cef2SBarry Smith .  B - preconditioner matrix, usually the same as A
786d763cef2SBarry Smith .  flag - flag indicating information about the preconditioner matrix
78794b7f48cSBarry Smith           structure (same as flag in KSPSetOperators())
788d763cef2SBarry Smith -  ctx - [optional] user-defined context for matrix evaluation routine
789d763cef2SBarry Smith 
790d763cef2SBarry Smith    Notes:
79194b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the flag
792d763cef2SBarry Smith    output parameter in the routine func().  Be sure to read this information!
793d763cef2SBarry Smith 
794d763cef2SBarry Smith    The routine func() takes Mat * as the matrix arguments rather than Mat.
795d763cef2SBarry Smith    This allows the matrix evaluation routine to replace A and/or B with a
79656335db2SHong Zhang    completely new matrix structure (not just different matrix elements)
797d763cef2SBarry Smith    when appropriate, for instance, if the nonzero structure is changing
798d763cef2SBarry Smith    throughout the global iterations.
799d763cef2SBarry Smith 
800d763cef2SBarry Smith    Level: beginner
801d763cef2SBarry Smith 
802d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian
803d763cef2SBarry Smith 
804ab637aeaSJed Brown .seealso: SNESDefaultComputeJacobianColor(), TSSetRHSFunction()
805d763cef2SBarry Smith 
806d763cef2SBarry Smith @*/
807089b2837SJed Brown PetscErrorCode  TSSetRHSJacobian(TS ts,Mat A,Mat B,TSRHSJacobian f,void *ctx)
808d763cef2SBarry Smith {
809277b19d0SLisandro Dalcin   PetscErrorCode ierr;
810089b2837SJed Brown   SNES           snes;
81124989b8cSPeter Brune   DM             dm;
81224989b8cSPeter Brune   TSIJacobian    ijacobian;
813277b19d0SLisandro Dalcin 
814d763cef2SBarry Smith   PetscFunctionBegin;
8150700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
816277b19d0SLisandro Dalcin   if (A) PetscValidHeaderSpecific(A,MAT_CLASSID,2);
817277b19d0SLisandro Dalcin   if (B) PetscValidHeaderSpecific(B,MAT_CLASSID,3);
818277b19d0SLisandro Dalcin   if (A) PetscCheckSameComm(ts,1,A,2);
819277b19d0SLisandro Dalcin   if (B) PetscCheckSameComm(ts,1,B,3);
820d763cef2SBarry Smith 
82124989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
82224989b8cSPeter Brune   ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr);
82324989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,&ijacobian,PETSC_NULL);CHKERRQ(ierr);
82424989b8cSPeter Brune 
825089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
8265f659677SPeter Brune   if (!ijacobian) {
827089b2837SJed Brown     ierr = SNESSetJacobian(snes,A,B,SNESTSFormJacobian,ts);CHKERRQ(ierr);
8280e4ef248SJed Brown   }
8290e4ef248SJed Brown   if (A) {
8300e4ef248SJed Brown     ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
8310e4ef248SJed Brown     ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
8320e4ef248SJed Brown     ts->Arhs = A;
8330e4ef248SJed Brown   }
8340e4ef248SJed Brown   if (B) {
8350e4ef248SJed Brown     ierr = PetscObjectReference((PetscObject)B);CHKERRQ(ierr);
8360e4ef248SJed Brown     ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
8370e4ef248SJed Brown     ts->Brhs = B;
8380e4ef248SJed Brown   }
839d763cef2SBarry Smith   PetscFunctionReturn(0);
840d763cef2SBarry Smith }
841d763cef2SBarry Smith 
842316643e7SJed Brown 
843316643e7SJed Brown #undef __FUNCT__
844316643e7SJed Brown #define __FUNCT__ "TSSetIFunction"
845316643e7SJed Brown /*@C
846b5abc632SBarry Smith    TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved.
847316643e7SJed Brown 
8483f9fe445SBarry Smith    Logically Collective on TS
849316643e7SJed Brown 
850316643e7SJed Brown    Input Parameters:
851316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
852ca94891dSJed Brown .  r   - vector to hold the residual (or PETSC_NULL to have it created internally)
853316643e7SJed Brown .  f   - the function evaluation routine
854316643e7SJed Brown -  ctx - user-defined context for private data for the function evaluation routine (may be PETSC_NULL)
855316643e7SJed Brown 
856316643e7SJed Brown    Calling sequence of f:
857316643e7SJed Brown $  f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx);
858316643e7SJed Brown 
859316643e7SJed Brown +  t   - time at step/stage being solved
860316643e7SJed Brown .  u   - state vector
861316643e7SJed Brown .  u_t - time derivative of state vector
862316643e7SJed Brown .  F   - function vector
863316643e7SJed Brown -  ctx - [optional] user-defined context for matrix evaluation routine
864316643e7SJed Brown 
865316643e7SJed Brown    Important:
866d6cbdb99SBarry Smith    The user MUST call either this routine, TSSetRHSFunction().  This routine must be used when not solving an ODE, for example a DAE.
867316643e7SJed Brown 
868316643e7SJed Brown    Level: beginner
869316643e7SJed Brown 
870316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian
871316643e7SJed Brown 
872d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian()
873316643e7SJed Brown @*/
874089b2837SJed Brown PetscErrorCode  TSSetIFunction(TS ts,Vec res,TSIFunction f,void *ctx)
875316643e7SJed Brown {
876089b2837SJed Brown   PetscErrorCode ierr;
877089b2837SJed Brown   SNES           snes;
878e856ceecSJed Brown   Vec            resalloc = PETSC_NULL;
87924989b8cSPeter Brune   DM             dm;
880316643e7SJed Brown 
881316643e7SJed Brown   PetscFunctionBegin;
8820700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
883ca94891dSJed Brown   if (res) PetscValidHeaderSpecific(res,VEC_CLASSID,2);
88424989b8cSPeter Brune 
88524989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
88624989b8cSPeter Brune   ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr);
88724989b8cSPeter Brune 
888089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
889e856ceecSJed Brown   if (!res && !ts->dm && ts->vec_sol) {
890e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&resalloc);CHKERRQ(ierr);
891e856ceecSJed Brown     res = resalloc;
892e856ceecSJed Brown   }
893089b2837SJed Brown   ierr = SNESSetFunction(snes,res,SNESTSFormFunction,ts);CHKERRQ(ierr);
894e856ceecSJed Brown   ierr = VecDestroy(&resalloc);CHKERRQ(ierr);
89524989b8cSPeter Brune 
896089b2837SJed Brown   PetscFunctionReturn(0);
897089b2837SJed Brown }
898089b2837SJed Brown 
899089b2837SJed Brown #undef __FUNCT__
900089b2837SJed Brown #define __FUNCT__ "TSGetIFunction"
901089b2837SJed Brown /*@C
902089b2837SJed Brown    TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it.
903089b2837SJed Brown 
904089b2837SJed Brown    Not Collective
905089b2837SJed Brown 
906089b2837SJed Brown    Input Parameter:
907089b2837SJed Brown .  ts - the TS context
908089b2837SJed Brown 
909089b2837SJed Brown    Output Parameter:
910089b2837SJed Brown +  r - vector to hold residual (or PETSC_NULL)
911089b2837SJed Brown .  func - the function to compute residual (or PETSC_NULL)
912089b2837SJed Brown -  ctx - the function context (or PETSC_NULL)
913089b2837SJed Brown 
914089b2837SJed Brown    Level: advanced
915089b2837SJed Brown 
916089b2837SJed Brown .keywords: TS, nonlinear, get, function
917089b2837SJed Brown 
918089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction()
919089b2837SJed Brown @*/
920089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx)
921089b2837SJed Brown {
922089b2837SJed Brown   PetscErrorCode ierr;
923089b2837SJed Brown   SNES           snes;
92424989b8cSPeter Brune   DM             dm;
925089b2837SJed Brown 
926089b2837SJed Brown   PetscFunctionBegin;
927089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
928089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
929089b2837SJed Brown   ierr = SNESGetFunction(snes,r,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
93024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
93124989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr);
932089b2837SJed Brown   PetscFunctionReturn(0);
933089b2837SJed Brown }
934089b2837SJed Brown 
935089b2837SJed Brown #undef __FUNCT__
936089b2837SJed Brown #define __FUNCT__ "TSGetRHSFunction"
937089b2837SJed Brown /*@C
938089b2837SJed Brown    TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it.
939089b2837SJed Brown 
940089b2837SJed Brown    Not Collective
941089b2837SJed Brown 
942089b2837SJed Brown    Input Parameter:
943089b2837SJed Brown .  ts - the TS context
944089b2837SJed Brown 
945089b2837SJed Brown    Output Parameter:
946089b2837SJed Brown +  r - vector to hold computed right hand side (or PETSC_NULL)
947089b2837SJed Brown .  func - the function to compute right hand side (or PETSC_NULL)
948089b2837SJed Brown -  ctx - the function context (or PETSC_NULL)
949089b2837SJed Brown 
950089b2837SJed Brown    Level: advanced
951089b2837SJed Brown 
952089b2837SJed Brown .keywords: TS, nonlinear, get, function
953089b2837SJed Brown 
954089b2837SJed Brown .seealso: TSSetRhsfunction(), SNESGetFunction()
955089b2837SJed Brown @*/
956089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx)
957089b2837SJed Brown {
958089b2837SJed Brown   PetscErrorCode ierr;
959089b2837SJed Brown   SNES           snes;
96024989b8cSPeter Brune   DM             dm;
961089b2837SJed Brown 
962089b2837SJed Brown   PetscFunctionBegin;
963089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
964089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
965089b2837SJed Brown   ierr = SNESGetFunction(snes,r,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
96624989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
96724989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr);
968316643e7SJed Brown   PetscFunctionReturn(0);
969316643e7SJed Brown }
970316643e7SJed Brown 
971316643e7SJed Brown #undef __FUNCT__
972316643e7SJed Brown #define __FUNCT__ "TSSetIJacobian"
973316643e7SJed Brown /*@C
974a4f0a591SBarry Smith    TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function
975a4f0a591SBarry Smith         you provided with TSSetIFunction().
976316643e7SJed Brown 
9773f9fe445SBarry Smith    Logically Collective on TS
978316643e7SJed Brown 
979316643e7SJed Brown    Input Parameters:
980316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
981316643e7SJed Brown .  A   - Jacobian matrix
982316643e7SJed Brown .  B   - preconditioning matrix for A (may be same as A)
983316643e7SJed Brown .  f   - the Jacobian evaluation routine
984316643e7SJed Brown -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be PETSC_NULL)
985316643e7SJed Brown 
986316643e7SJed Brown    Calling sequence of f:
9871b4a444bSJed Brown $  f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat *A,Mat *B,MatStructure *flag,void *ctx);
988316643e7SJed Brown 
989316643e7SJed Brown +  t    - time at step/stage being solved
9901b4a444bSJed Brown .  U    - state vector
9911b4a444bSJed Brown .  U_t  - time derivative of state vector
992316643e7SJed Brown .  a    - shift
993b5abc632SBarry Smith .  A    - Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t
994316643e7SJed Brown .  B    - preconditioning matrix for A, may be same as A
995316643e7SJed Brown .  flag - flag indicating information about the preconditioner matrix
996316643e7SJed Brown           structure (same as flag in KSPSetOperators())
997316643e7SJed Brown -  ctx  - [optional] user-defined context for matrix evaluation routine
998316643e7SJed Brown 
999316643e7SJed Brown    Notes:
1000316643e7SJed Brown    The matrices A and B are exactly the matrices that are used by SNES for the nonlinear solve.
1001316643e7SJed Brown 
1002a4f0a591SBarry Smith    The matrix dF/dU + a*dF/dU_t you provide turns out to be
1003b5abc632SBarry Smith    the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved.
1004a4f0a591SBarry Smith    The time integrator internally approximates U_t by W+a*U where the positive "shift"
1005a4f0a591SBarry Smith    a and vector W depend on the integration method, step size, and past states. For example with
1006a4f0a591SBarry Smith    the backward Euler method a = 1/dt and W = -a*U(previous timestep) so
1007a4f0a591SBarry Smith    W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt
1008a4f0a591SBarry Smith 
1009316643e7SJed Brown    Level: beginner
1010316643e7SJed Brown 
1011316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian
1012316643e7SJed Brown 
1013ab637aeaSJed Brown .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESDefaultComputeJacobianColor(), SNESDefaultComputeJacobian()
1014316643e7SJed Brown 
1015316643e7SJed Brown @*/
10167087cfbeSBarry Smith PetscErrorCode  TSSetIJacobian(TS ts,Mat A,Mat B,TSIJacobian f,void *ctx)
1017316643e7SJed Brown {
1018316643e7SJed Brown   PetscErrorCode ierr;
1019089b2837SJed Brown   SNES           snes;
102024989b8cSPeter Brune   DM             dm;
1021316643e7SJed Brown 
1022316643e7SJed Brown   PetscFunctionBegin;
10230700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
10240700a824SBarry Smith   if (A) PetscValidHeaderSpecific(A,MAT_CLASSID,2);
10250700a824SBarry Smith   if (B) PetscValidHeaderSpecific(B,MAT_CLASSID,3);
1026316643e7SJed Brown   if (A) PetscCheckSameComm(ts,1,A,2);
1027316643e7SJed Brown   if (B) PetscCheckSameComm(ts,1,B,3);
102824989b8cSPeter Brune 
102924989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
103024989b8cSPeter Brune   ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr);
103124989b8cSPeter Brune 
1032089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1033089b2837SJed Brown   ierr = SNESSetJacobian(snes,A,B,SNESTSFormJacobian,ts);CHKERRQ(ierr);
1034316643e7SJed Brown   PetscFunctionReturn(0);
1035316643e7SJed Brown }
1036316643e7SJed Brown 
10374a2ae208SSatish Balay #undef __FUNCT__
103855849f57SBarry Smith #define __FUNCT__ "TSLoad"
103955849f57SBarry Smith /*@C
104055849f57SBarry Smith   TSLoad - Loads a KSP that has been stored in binary  with KSPView().
104155849f57SBarry Smith 
104255849f57SBarry Smith   Collective on PetscViewer
104355849f57SBarry Smith 
104455849f57SBarry Smith   Input Parameters:
104555849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or
104655849f57SBarry Smith            some related function before a call to TSLoad().
104755849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen()
104855849f57SBarry Smith 
104955849f57SBarry Smith    Level: intermediate
105055849f57SBarry Smith 
105155849f57SBarry Smith   Notes:
105255849f57SBarry Smith    The type is determined by the data in the file, any type set into the TS before this call is ignored.
105355849f57SBarry Smith 
105455849f57SBarry Smith   Notes for advanced users:
105555849f57SBarry Smith   Most users should not need to know the details of the binary storage
105655849f57SBarry Smith   format, since TSLoad() and TSView() completely hide these details.
105755849f57SBarry Smith   But for anyone who's interested, the standard binary matrix storage
105855849f57SBarry Smith   format is
105955849f57SBarry Smith .vb
106055849f57SBarry Smith      has not yet been determined
106155849f57SBarry Smith .ve
106255849f57SBarry Smith 
106355849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad()
106455849f57SBarry Smith @*/
1065f2c2a1b9SBarry Smith PetscErrorCode  TSLoad(TS ts, PetscViewer viewer)
106655849f57SBarry Smith {
106755849f57SBarry Smith   PetscErrorCode ierr;
106855849f57SBarry Smith   PetscBool      isbinary;
106955849f57SBarry Smith   PetscInt       classid;
107055849f57SBarry Smith   char           type[256];
1071*2d53ad75SBarry Smith   DMTS           sdm;
107255849f57SBarry Smith 
107355849f57SBarry Smith   PetscFunctionBegin;
1074f2c2a1b9SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
107555849f57SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
107655849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
107755849f57SBarry Smith   if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
107855849f57SBarry Smith 
107955849f57SBarry Smith   ierr = PetscViewerBinaryRead(viewer,&classid,1,PETSC_INT);CHKERRQ(ierr);
1080f2c2a1b9SBarry Smith   if (classid != TS_FILE_CLASSID) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_ARG_WRONG,"Not TS next in file");
108155849f57SBarry Smith   ierr = PetscViewerBinaryRead(viewer,type,256,PETSC_CHAR);CHKERRQ(ierr);
1082f2c2a1b9SBarry Smith   ierr = TSSetType(ts, type);CHKERRQ(ierr);
1083f2c2a1b9SBarry Smith   if (ts->ops->load) {
1084f2c2a1b9SBarry Smith     ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr);
1085f2c2a1b9SBarry Smith   }
1086f2c2a1b9SBarry Smith   ierr = DMCreate(((PetscObject)ts)->comm,&ts->dm);CHKERRQ(ierr);
1087f2c2a1b9SBarry Smith   ierr = DMLoad(ts->dm,viewer);CHKERRQ(ierr);
1088f2c2a1b9SBarry Smith   ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr);
1089f2c2a1b9SBarry Smith   ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr);
1090*2d53ad75SBarry Smith   ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
1091*2d53ad75SBarry Smith   ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr);
109255849f57SBarry Smith   PetscFunctionReturn(0);
109355849f57SBarry Smith }
109455849f57SBarry Smith 
109555849f57SBarry Smith #undef __FUNCT__
10964a2ae208SSatish Balay #define __FUNCT__ "TSView"
10977e2c5f70SBarry Smith /*@C
1098d763cef2SBarry Smith     TSView - Prints the TS data structure.
1099d763cef2SBarry Smith 
11004c49b128SBarry Smith     Collective on TS
1101d763cef2SBarry Smith 
1102d763cef2SBarry Smith     Input Parameters:
1103d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
1104d763cef2SBarry Smith -   viewer - visualization context
1105d763cef2SBarry Smith 
1106d763cef2SBarry Smith     Options Database Key:
1107d763cef2SBarry Smith .   -ts_view - calls TSView() at end of TSStep()
1108d763cef2SBarry Smith 
1109d763cef2SBarry Smith     Notes:
1110d763cef2SBarry Smith     The available visualization contexts include
1111b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
1112b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
1113d763cef2SBarry Smith          output where only the first processor opens
1114d763cef2SBarry Smith          the file.  All other processors send their
1115d763cef2SBarry Smith          data to the first processor to print.
1116d763cef2SBarry Smith 
1117d763cef2SBarry Smith     The user can open an alternative visualization context with
1118b0a32e0cSBarry Smith     PetscViewerASCIIOpen() - output to a specified file.
1119d763cef2SBarry Smith 
1120d763cef2SBarry Smith     Level: beginner
1121d763cef2SBarry Smith 
1122d763cef2SBarry Smith .keywords: TS, timestep, view
1123d763cef2SBarry Smith 
1124b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
1125d763cef2SBarry Smith @*/
11267087cfbeSBarry Smith PetscErrorCode  TSView(TS ts,PetscViewer viewer)
1127d763cef2SBarry Smith {
1128dfbe8321SBarry Smith   PetscErrorCode ierr;
112919fd82e9SBarry Smith   TSType         type;
11302b0a91c0SBarry Smith   PetscBool      iascii,isstring,isundials,isbinary,isdraw;
1131*2d53ad75SBarry Smith   DMTS           sdm;
1132d763cef2SBarry Smith 
1133d763cef2SBarry Smith   PetscFunctionBegin;
11340700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
11353050cee2SBarry Smith   if (!viewer) {
11367adad957SLisandro Dalcin     ierr = PetscViewerASCIIGetStdout(((PetscObject)ts)->comm,&viewer);CHKERRQ(ierr);
11373050cee2SBarry Smith   }
11380700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1139c9780b6fSBarry Smith   PetscCheckSameComm(ts,1,viewer,2);
1140fd16b177SBarry Smith 
1141251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1142251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
114355849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
11442b0a91c0SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
114532077d6dSBarry Smith   if (iascii) {
1146317d6ea6SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer,"TS Object");CHKERRQ(ierr);
114777431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr);
1148a83599f4SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum time=%G\n",ts->max_time);CHKERRQ(ierr);
1149d763cef2SBarry Smith     if (ts->problem_type == TS_NONLINEAR) {
11505ef26d82SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr);
1151c610991cSLisandro Dalcin       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solve failures=%D\n",ts->num_snes_failures);CHKERRQ(ierr);
1152d763cef2SBarry Smith     }
11535ef26d82SJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr);
1154193ac0bcSJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr);
1155*2d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
1156*2d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
1157d52bd9f3SBarry Smith     if (ts->ops->view) {
1158d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1159d52bd9f3SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
1160d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1161d52bd9f3SBarry Smith     }
11620f5bd95cSBarry Smith   } else if (isstring) {
1163a313700dSBarry Smith     ierr = TSGetType(ts,&type);CHKERRQ(ierr);
1164b0a32e0cSBarry Smith     ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr);
116555849f57SBarry Smith   } else if (isbinary) {
116655849f57SBarry Smith     PetscInt         classid = TS_FILE_CLASSID;
116755849f57SBarry Smith     MPI_Comm         comm;
116855849f57SBarry Smith     PetscMPIInt      rank;
116955849f57SBarry Smith     char             type[256];
117055849f57SBarry Smith 
117155849f57SBarry Smith     ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
117255849f57SBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
117355849f57SBarry Smith     if (!rank) {
117455849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
117555849f57SBarry Smith       ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr);
117655849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr);
117755849f57SBarry Smith     }
117855849f57SBarry Smith     if (ts->ops->view) {
117955849f57SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
118055849f57SBarry Smith     }
1181f2c2a1b9SBarry Smith     ierr = DMView(ts->dm,viewer);CHKERRQ(ierr);
1182f2c2a1b9SBarry Smith     ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr);
1183*2d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
1184*2d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
11852b0a91c0SBarry Smith   } else if (isdraw) {
11862b0a91c0SBarry Smith     PetscDraw draw;
11872b0a91c0SBarry Smith     char      str[36];
118889fd9fafSBarry Smith     PetscReal x,y,bottom,h;
11892b0a91c0SBarry Smith 
11902b0a91c0SBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
11912b0a91c0SBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
11922b0a91c0SBarry Smith     ierr = PetscStrcpy(str,"TS: ");CHKERRQ(ierr);
11932b0a91c0SBarry Smith     ierr = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr);
119489fd9fafSBarry Smith     ierr = PetscDrawBoxedString(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,PETSC_NULL,&h);CHKERRQ(ierr);
119589fd9fafSBarry Smith     bottom = y - h;
11962b0a91c0SBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr);
11972b0a91c0SBarry Smith     if (ts->ops->view) {
11982b0a91c0SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
11992b0a91c0SBarry Smith     }
12002b0a91c0SBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
1201d763cef2SBarry Smith   }
1202b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1203251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr);
1204b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1205d763cef2SBarry Smith   PetscFunctionReturn(0);
1206d763cef2SBarry Smith }
1207d763cef2SBarry Smith 
1208d763cef2SBarry Smith 
12094a2ae208SSatish Balay #undef __FUNCT__
12104a2ae208SSatish Balay #define __FUNCT__ "TSSetApplicationContext"
1211b07ff414SBarry Smith /*@
1212d763cef2SBarry Smith    TSSetApplicationContext - Sets an optional user-defined context for
1213d763cef2SBarry Smith    the timesteppers.
1214d763cef2SBarry Smith 
12153f9fe445SBarry Smith    Logically Collective on TS
1216d763cef2SBarry Smith 
1217d763cef2SBarry Smith    Input Parameters:
1218d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1219d763cef2SBarry Smith -  usrP - optional user context
1220d763cef2SBarry Smith 
1221d763cef2SBarry Smith    Level: intermediate
1222d763cef2SBarry Smith 
1223d763cef2SBarry Smith .keywords: TS, timestep, set, application, context
1224d763cef2SBarry Smith 
1225d763cef2SBarry Smith .seealso: TSGetApplicationContext()
1226d763cef2SBarry Smith @*/
12277087cfbeSBarry Smith PetscErrorCode  TSSetApplicationContext(TS ts,void *usrP)
1228d763cef2SBarry Smith {
1229d763cef2SBarry Smith   PetscFunctionBegin;
12300700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1231d763cef2SBarry Smith   ts->user = usrP;
1232d763cef2SBarry Smith   PetscFunctionReturn(0);
1233d763cef2SBarry Smith }
1234d763cef2SBarry Smith 
12354a2ae208SSatish Balay #undef __FUNCT__
12364a2ae208SSatish Balay #define __FUNCT__ "TSGetApplicationContext"
1237b07ff414SBarry Smith /*@
1238d763cef2SBarry Smith     TSGetApplicationContext - Gets the user-defined context for the
1239d763cef2SBarry Smith     timestepper.
1240d763cef2SBarry Smith 
1241d763cef2SBarry Smith     Not Collective
1242d763cef2SBarry Smith 
1243d763cef2SBarry Smith     Input Parameter:
1244d763cef2SBarry Smith .   ts - the TS context obtained from TSCreate()
1245d763cef2SBarry Smith 
1246d763cef2SBarry Smith     Output Parameter:
1247d763cef2SBarry Smith .   usrP - user context
1248d763cef2SBarry Smith 
1249d763cef2SBarry Smith     Level: intermediate
1250d763cef2SBarry Smith 
1251d763cef2SBarry Smith .keywords: TS, timestep, get, application, context
1252d763cef2SBarry Smith 
1253d763cef2SBarry Smith .seealso: TSSetApplicationContext()
1254d763cef2SBarry Smith @*/
1255e71120c6SJed Brown PetscErrorCode  TSGetApplicationContext(TS ts,void *usrP)
1256d763cef2SBarry Smith {
1257d763cef2SBarry Smith   PetscFunctionBegin;
12580700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1259e71120c6SJed Brown   *(void**)usrP = ts->user;
1260d763cef2SBarry Smith   PetscFunctionReturn(0);
1261d763cef2SBarry Smith }
1262d763cef2SBarry Smith 
12634a2ae208SSatish Balay #undef __FUNCT__
12644a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStepNumber"
1265d763cef2SBarry Smith /*@
1266b8123daeSJed Brown    TSGetTimeStepNumber - Gets the number of time steps completed.
1267d763cef2SBarry Smith 
1268d763cef2SBarry Smith    Not Collective
1269d763cef2SBarry Smith 
1270d763cef2SBarry Smith    Input Parameter:
1271d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1272d763cef2SBarry Smith 
1273d763cef2SBarry Smith    Output Parameter:
1274b8123daeSJed Brown .  iter - number of steps completed so far
1275d763cef2SBarry Smith 
1276d763cef2SBarry Smith    Level: intermediate
1277d763cef2SBarry Smith 
1278d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number
1279b8123daeSJed Brown .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStep()
1280d763cef2SBarry Smith @*/
12817087cfbeSBarry Smith PetscErrorCode  TSGetTimeStepNumber(TS ts,PetscInt* iter)
1282d763cef2SBarry Smith {
1283d763cef2SBarry Smith   PetscFunctionBegin;
12840700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
12854482741eSBarry Smith   PetscValidIntPointer(iter,2);
1286d763cef2SBarry Smith   *iter = ts->steps;
1287d763cef2SBarry Smith   PetscFunctionReturn(0);
1288d763cef2SBarry Smith }
1289d763cef2SBarry Smith 
12904a2ae208SSatish Balay #undef __FUNCT__
12914a2ae208SSatish Balay #define __FUNCT__ "TSSetInitialTimeStep"
1292d763cef2SBarry Smith /*@
1293d763cef2SBarry Smith    TSSetInitialTimeStep - Sets the initial timestep to be used,
1294d763cef2SBarry Smith    as well as the initial time.
1295d763cef2SBarry Smith 
12963f9fe445SBarry Smith    Logically Collective on TS
1297d763cef2SBarry Smith 
1298d763cef2SBarry Smith    Input Parameters:
1299d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1300d763cef2SBarry Smith .  initial_time - the initial time
1301d763cef2SBarry Smith -  time_step - the size of the timestep
1302d763cef2SBarry Smith 
1303d763cef2SBarry Smith    Level: intermediate
1304d763cef2SBarry Smith 
1305d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep()
1306d763cef2SBarry Smith 
1307d763cef2SBarry Smith .keywords: TS, set, initial, timestep
1308d763cef2SBarry Smith @*/
13097087cfbeSBarry Smith PetscErrorCode  TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step)
1310d763cef2SBarry Smith {
1311e144a568SJed Brown   PetscErrorCode ierr;
1312e144a568SJed Brown 
1313d763cef2SBarry Smith   PetscFunctionBegin;
13140700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1315e144a568SJed Brown   ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
1316d8cd7023SBarry Smith   ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr);
1317d763cef2SBarry Smith   PetscFunctionReturn(0);
1318d763cef2SBarry Smith }
1319d763cef2SBarry Smith 
13204a2ae208SSatish Balay #undef __FUNCT__
13214a2ae208SSatish Balay #define __FUNCT__ "TSSetTimeStep"
1322d763cef2SBarry Smith /*@
1323d763cef2SBarry Smith    TSSetTimeStep - Allows one to reset the timestep at any time,
1324d763cef2SBarry Smith    useful for simple pseudo-timestepping codes.
1325d763cef2SBarry Smith 
13263f9fe445SBarry Smith    Logically Collective on TS
1327d763cef2SBarry Smith 
1328d763cef2SBarry Smith    Input Parameters:
1329d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1330d763cef2SBarry Smith -  time_step - the size of the timestep
1331d763cef2SBarry Smith 
1332d763cef2SBarry Smith    Level: intermediate
1333d763cef2SBarry Smith 
1334d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
1335d763cef2SBarry Smith 
1336d763cef2SBarry Smith .keywords: TS, set, timestep
1337d763cef2SBarry Smith @*/
13387087cfbeSBarry Smith PetscErrorCode  TSSetTimeStep(TS ts,PetscReal time_step)
1339d763cef2SBarry Smith {
1340d763cef2SBarry Smith   PetscFunctionBegin;
13410700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1342c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,time_step,2);
1343d763cef2SBarry Smith   ts->time_step = time_step;
134431748224SBarry Smith   ts->time_step_orig = time_step;
1345d763cef2SBarry Smith   PetscFunctionReturn(0);
1346d763cef2SBarry Smith }
1347d763cef2SBarry Smith 
13484a2ae208SSatish Balay #undef __FUNCT__
1349a43b19c4SJed Brown #define __FUNCT__ "TSSetExactFinalTime"
1350a43b19c4SJed Brown /*@
1351a43b19c4SJed Brown    TSSetExactFinalTime - Determines whether to interpolate solution to the
1352a43b19c4SJed Brown       exact final time requested by the user or just returns it at the final time
1353a43b19c4SJed Brown       it computed.
1354a43b19c4SJed Brown 
1355a43b19c4SJed Brown   Logically Collective on TS
1356a43b19c4SJed Brown 
1357a43b19c4SJed Brown    Input Parameter:
1358a43b19c4SJed Brown +   ts - the time-step context
1359a43b19c4SJed Brown -   ft - PETSC_TRUE if interpolates, else PETSC_FALSE
1360a43b19c4SJed Brown 
1361a43b19c4SJed Brown    Level: beginner
1362a43b19c4SJed Brown 
1363a43b19c4SJed Brown .seealso: TSSetDuration()
1364a43b19c4SJed Brown @*/
1365a43b19c4SJed Brown PetscErrorCode  TSSetExactFinalTime(TS ts,PetscBool flg)
1366a43b19c4SJed Brown {
1367a43b19c4SJed Brown   PetscFunctionBegin;
1368a43b19c4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1369d8cd7023SBarry Smith   PetscValidLogicalCollectiveBool(ts,flg,2);
1370a43b19c4SJed Brown   ts->exact_final_time = flg;
1371a43b19c4SJed Brown   PetscFunctionReturn(0);
1372a43b19c4SJed Brown }
1373a43b19c4SJed Brown 
1374a43b19c4SJed Brown #undef __FUNCT__
13754a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStep"
1376d763cef2SBarry Smith /*@
1377d763cef2SBarry Smith    TSGetTimeStep - Gets the current timestep size.
1378d763cef2SBarry Smith 
1379d763cef2SBarry Smith    Not Collective
1380d763cef2SBarry Smith 
1381d763cef2SBarry Smith    Input Parameter:
1382d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1383d763cef2SBarry Smith 
1384d763cef2SBarry Smith    Output Parameter:
1385d763cef2SBarry Smith .  dt - the current timestep size
1386d763cef2SBarry Smith 
1387d763cef2SBarry Smith    Level: intermediate
1388d763cef2SBarry Smith 
1389d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
1390d763cef2SBarry Smith 
1391d763cef2SBarry Smith .keywords: TS, get, timestep
1392d763cef2SBarry Smith @*/
13937087cfbeSBarry Smith PetscErrorCode  TSGetTimeStep(TS ts,PetscReal* dt)
1394d763cef2SBarry Smith {
1395d763cef2SBarry Smith   PetscFunctionBegin;
13960700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1397f7cf8827SBarry Smith   PetscValidRealPointer(dt,2);
1398d763cef2SBarry Smith   *dt = ts->time_step;
1399d763cef2SBarry Smith   PetscFunctionReturn(0);
1400d763cef2SBarry Smith }
1401d763cef2SBarry Smith 
14024a2ae208SSatish Balay #undef __FUNCT__
14034a2ae208SSatish Balay #define __FUNCT__ "TSGetSolution"
1404d8e5e3e6SSatish Balay /*@
1405d763cef2SBarry Smith    TSGetSolution - Returns the solution at the present timestep. It
1406d763cef2SBarry Smith    is valid to call this routine inside the function that you are evaluating
1407d763cef2SBarry Smith    in order to move to the new timestep. This vector not changed until
1408d763cef2SBarry Smith    the solution at the next timestep has been calculated.
1409d763cef2SBarry Smith 
1410d763cef2SBarry Smith    Not Collective, but Vec returned is parallel if TS is parallel
1411d763cef2SBarry Smith 
1412d763cef2SBarry Smith    Input Parameter:
1413d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1414d763cef2SBarry Smith 
1415d763cef2SBarry Smith    Output Parameter:
1416d763cef2SBarry Smith .  v - the vector containing the solution
1417d763cef2SBarry Smith 
1418d763cef2SBarry Smith    Level: intermediate
1419d763cef2SBarry Smith 
1420d763cef2SBarry Smith .seealso: TSGetTimeStep()
1421d763cef2SBarry Smith 
1422d763cef2SBarry Smith .keywords: TS, timestep, get, solution
1423d763cef2SBarry Smith @*/
14247087cfbeSBarry Smith PetscErrorCode  TSGetSolution(TS ts,Vec *v)
1425d763cef2SBarry Smith {
1426d763cef2SBarry Smith   PetscFunctionBegin;
14270700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
14284482741eSBarry Smith   PetscValidPointer(v,2);
14298737fe31SLisandro Dalcin   *v = ts->vec_sol;
1430d763cef2SBarry Smith   PetscFunctionReturn(0);
1431d763cef2SBarry Smith }
1432d763cef2SBarry Smith 
1433bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */
14344a2ae208SSatish Balay #undef __FUNCT__
1435bdad233fSMatthew Knepley #define __FUNCT__ "TSSetProblemType"
1436d8e5e3e6SSatish Balay /*@
1437bdad233fSMatthew Knepley   TSSetProblemType - Sets the type of problem to be solved.
1438d763cef2SBarry Smith 
1439bdad233fSMatthew Knepley   Not collective
1440d763cef2SBarry Smith 
1441bdad233fSMatthew Knepley   Input Parameters:
1442bdad233fSMatthew Knepley + ts   - The TS
1443bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1444d763cef2SBarry Smith .vb
14450910c330SBarry Smith          U_t - A U = 0      (linear)
14460910c330SBarry Smith          U_t - A(t) U = 0   (linear)
14470910c330SBarry Smith          F(t,U,U_t) = 0     (nonlinear)
1448d763cef2SBarry Smith .ve
1449d763cef2SBarry Smith 
1450d763cef2SBarry Smith    Level: beginner
1451d763cef2SBarry Smith 
1452bdad233fSMatthew Knepley .keywords: TS, problem type
1453bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
1454d763cef2SBarry Smith @*/
14557087cfbeSBarry Smith PetscErrorCode  TSSetProblemType(TS ts, TSProblemType type)
1456a7cc72afSBarry Smith {
14579e2a6581SJed Brown   PetscErrorCode ierr;
14589e2a6581SJed Brown 
1459d763cef2SBarry Smith   PetscFunctionBegin;
14600700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1461bdad233fSMatthew Knepley   ts->problem_type = type;
14629e2a6581SJed Brown   if (type == TS_LINEAR) {
14639e2a6581SJed Brown     SNES snes;
14649e2a6581SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
14659e2a6581SJed Brown     ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);
14669e2a6581SJed Brown   }
1467d763cef2SBarry Smith   PetscFunctionReturn(0);
1468d763cef2SBarry Smith }
1469d763cef2SBarry Smith 
1470bdad233fSMatthew Knepley #undef __FUNCT__
1471bdad233fSMatthew Knepley #define __FUNCT__ "TSGetProblemType"
1472bdad233fSMatthew Knepley /*@C
1473bdad233fSMatthew Knepley   TSGetProblemType - Gets the type of problem to be solved.
1474bdad233fSMatthew Knepley 
1475bdad233fSMatthew Knepley   Not collective
1476bdad233fSMatthew Knepley 
1477bdad233fSMatthew Knepley   Input Parameter:
1478bdad233fSMatthew Knepley . ts   - The TS
1479bdad233fSMatthew Knepley 
1480bdad233fSMatthew Knepley   Output Parameter:
1481bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1482bdad233fSMatthew Knepley .vb
1483089b2837SJed Brown          M U_t = A U
1484089b2837SJed Brown          M(t) U_t = A(t) U
1485b5abc632SBarry Smith          F(t,U,U_t)
1486bdad233fSMatthew Knepley .ve
1487bdad233fSMatthew Knepley 
1488bdad233fSMatthew Knepley    Level: beginner
1489bdad233fSMatthew Knepley 
1490bdad233fSMatthew Knepley .keywords: TS, problem type
1491bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
1492bdad233fSMatthew Knepley @*/
14937087cfbeSBarry Smith PetscErrorCode  TSGetProblemType(TS ts, TSProblemType *type)
1494a7cc72afSBarry Smith {
1495bdad233fSMatthew Knepley   PetscFunctionBegin;
14960700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
14974482741eSBarry Smith   PetscValidIntPointer(type,2);
1498bdad233fSMatthew Knepley   *type = ts->problem_type;
1499bdad233fSMatthew Knepley   PetscFunctionReturn(0);
1500bdad233fSMatthew Knepley }
1501d763cef2SBarry Smith 
15024a2ae208SSatish Balay #undef __FUNCT__
15034a2ae208SSatish Balay #define __FUNCT__ "TSSetUp"
1504d763cef2SBarry Smith /*@
1505d763cef2SBarry Smith    TSSetUp - Sets up the internal data structures for the later use
1506d763cef2SBarry Smith    of a timestepper.
1507d763cef2SBarry Smith 
1508d763cef2SBarry Smith    Collective on TS
1509d763cef2SBarry Smith 
1510d763cef2SBarry Smith    Input Parameter:
1511d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1512d763cef2SBarry Smith 
1513d763cef2SBarry Smith    Notes:
1514d763cef2SBarry Smith    For basic use of the TS solvers the user need not explicitly call
1515d763cef2SBarry Smith    TSSetUp(), since these actions will automatically occur during
1516d763cef2SBarry Smith    the call to TSStep().  However, if one wishes to control this
1517d763cef2SBarry Smith    phase separately, TSSetUp() should be called after TSCreate()
1518d763cef2SBarry Smith    and optional routines of the form TSSetXXX(), but before TSStep().
1519d763cef2SBarry Smith 
1520d763cef2SBarry Smith    Level: advanced
1521d763cef2SBarry Smith 
1522d763cef2SBarry Smith .keywords: TS, timestep, setup
1523d763cef2SBarry Smith 
1524d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy()
1525d763cef2SBarry Smith @*/
15267087cfbeSBarry Smith PetscErrorCode  TSSetUp(TS ts)
1527d763cef2SBarry Smith {
1528dfbe8321SBarry Smith   PetscErrorCode ierr;
15296c6b9e74SPeter Brune   DM             dm;
15306c6b9e74SPeter Brune   PetscErrorCode (*func)(SNES,Vec,Vec,void*);
15316c6b9e74SPeter Brune   PetscErrorCode (*jac)(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
15326c6b9e74SPeter Brune   TSIJacobian    ijac;
15336c6b9e74SPeter Brune   TSRHSJacobian  rhsjac;
1534d763cef2SBarry Smith 
1535d763cef2SBarry Smith   PetscFunctionBegin;
15360700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1537277b19d0SLisandro Dalcin   if (ts->setupcalled) PetscFunctionReturn(0);
1538277b19d0SLisandro Dalcin 
15397adad957SLisandro Dalcin   if (!((PetscObject)ts)->type_name) {
15409596e0b4SJed Brown     ierr = TSSetType(ts,TSEULER);CHKERRQ(ierr);
1541d763cef2SBarry Smith   }
1542a43b19c4SJed Brown   if (ts->exact_final_time == PETSC_DECIDE) ts->exact_final_time = PETSC_FALSE;
1543277b19d0SLisandro Dalcin 
1544277b19d0SLisandro Dalcin   if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first");
1545277b19d0SLisandro Dalcin 
15461c3436cfSJed Brown   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
15471c3436cfSJed Brown 
1548277b19d0SLisandro Dalcin   if (ts->ops->setup) {
1549000e7ae3SMatthew Knepley     ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr);
1550277b19d0SLisandro Dalcin   }
1551277b19d0SLisandro Dalcin 
15526c6b9e74SPeter Brune   /* in the case where we've set a DMTSFunction or what have you, we need the default SNESFunction
15536c6b9e74SPeter Brune    to be set right but can't do it elsewhere due to the overreliance on ctx=ts.
15546c6b9e74SPeter Brune    */
15556c6b9e74SPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
15566c6b9e74SPeter Brune   ierr = DMSNESGetFunction(dm,&func,PETSC_NULL);CHKERRQ(ierr);
15576c6b9e74SPeter Brune   if (!func) {
15586c6b9e74SPeter Brune     ierr =DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr);
15596c6b9e74SPeter Brune   }
15606c6b9e74SPeter Brune   /* if the SNES doesn't have a jacobian set and the TS has an ijacobian or rhsjacobian set, set the SNES to use it.
15616c6b9e74SPeter Brune      Otherwise, the SNES will use coloring internally to form the Jacobian.
15626c6b9e74SPeter Brune    */
15636c6b9e74SPeter Brune   ierr = DMSNESGetJacobian(dm,&jac,PETSC_NULL);CHKERRQ(ierr);
15646c6b9e74SPeter Brune   ierr = DMTSGetIJacobian(dm,&ijac,PETSC_NULL);CHKERRQ(ierr);
15656c6b9e74SPeter Brune   ierr = DMTSGetRHSJacobian(dm,&rhsjac,PETSC_NULL);CHKERRQ(ierr);
15666c6b9e74SPeter Brune   if (!jac && (ijac || rhsjac)) {
15676c6b9e74SPeter Brune     ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr);
15686c6b9e74SPeter Brune   }
1569277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_TRUE;
1570277b19d0SLisandro Dalcin   PetscFunctionReturn(0);
1571277b19d0SLisandro Dalcin }
1572277b19d0SLisandro Dalcin 
1573277b19d0SLisandro Dalcin #undef __FUNCT__
1574277b19d0SLisandro Dalcin #define __FUNCT__ "TSReset"
1575277b19d0SLisandro Dalcin /*@
1576277b19d0SLisandro Dalcin    TSReset - Resets a TS context and removes any allocated Vecs and Mats.
1577277b19d0SLisandro Dalcin 
1578277b19d0SLisandro Dalcin    Collective on TS
1579277b19d0SLisandro Dalcin 
1580277b19d0SLisandro Dalcin    Input Parameter:
1581277b19d0SLisandro Dalcin .  ts - the TS context obtained from TSCreate()
1582277b19d0SLisandro Dalcin 
1583277b19d0SLisandro Dalcin    Level: beginner
1584277b19d0SLisandro Dalcin 
1585277b19d0SLisandro Dalcin .keywords: TS, timestep, reset
1586277b19d0SLisandro Dalcin 
1587277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy()
1588277b19d0SLisandro Dalcin @*/
1589277b19d0SLisandro Dalcin PetscErrorCode  TSReset(TS ts)
1590277b19d0SLisandro Dalcin {
1591277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1592277b19d0SLisandro Dalcin 
1593277b19d0SLisandro Dalcin   PetscFunctionBegin;
1594277b19d0SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1595277b19d0SLisandro Dalcin   if (ts->ops->reset) {
1596277b19d0SLisandro Dalcin     ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr);
1597277b19d0SLisandro Dalcin   }
1598277b19d0SLisandro Dalcin   if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);}
15994e684422SJed Brown   ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
16004e684422SJed Brown   ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1601214bc6a2SJed Brown   ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr);
16026bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
1603e3d84a46SJed Brown   ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
1604e3d84a46SJed Brown   ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
160538637c2eSJed Brown   ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr);
1606277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_FALSE;
1607d763cef2SBarry Smith   PetscFunctionReturn(0);
1608d763cef2SBarry Smith }
1609d763cef2SBarry Smith 
16104a2ae208SSatish Balay #undef __FUNCT__
16114a2ae208SSatish Balay #define __FUNCT__ "TSDestroy"
1612d8e5e3e6SSatish Balay /*@
1613d763cef2SBarry Smith    TSDestroy - Destroys the timestepper context that was created
1614d763cef2SBarry Smith    with TSCreate().
1615d763cef2SBarry Smith 
1616d763cef2SBarry Smith    Collective on TS
1617d763cef2SBarry Smith 
1618d763cef2SBarry Smith    Input Parameter:
1619d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1620d763cef2SBarry Smith 
1621d763cef2SBarry Smith    Level: beginner
1622d763cef2SBarry Smith 
1623d763cef2SBarry Smith .keywords: TS, timestepper, destroy
1624d763cef2SBarry Smith 
1625d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve()
1626d763cef2SBarry Smith @*/
16276bf464f9SBarry Smith PetscErrorCode  TSDestroy(TS *ts)
1628d763cef2SBarry Smith {
16296849ba73SBarry Smith   PetscErrorCode ierr;
1630d763cef2SBarry Smith 
1631d763cef2SBarry Smith   PetscFunctionBegin;
16326bf464f9SBarry Smith   if (!*ts) PetscFunctionReturn(0);
16336bf464f9SBarry Smith   PetscValidHeaderSpecific((*ts),TS_CLASSID,1);
16346bf464f9SBarry Smith   if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);}
1635d763cef2SBarry Smith 
16366bf464f9SBarry Smith   ierr = TSReset((*ts));CHKERRQ(ierr);
1637277b19d0SLisandro Dalcin 
1638be0abb6dSBarry Smith   /* if memory was published with AMS then destroy it */
16396bf464f9SBarry Smith   ierr = PetscObjectDepublish((*ts));CHKERRQ(ierr);
16406bf464f9SBarry Smith   if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);}
16416d4c513bSLisandro Dalcin 
164284df9cb4SJed Brown   ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr);
16436bf464f9SBarry Smith   ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr);
16446bf464f9SBarry Smith   ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr);
16456bf464f9SBarry Smith   ierr = TSMonitorCancel((*ts));CHKERRQ(ierr);
16466d4c513bSLisandro Dalcin 
1647a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr);
1648d763cef2SBarry Smith   PetscFunctionReturn(0);
1649d763cef2SBarry Smith }
1650d763cef2SBarry Smith 
16514a2ae208SSatish Balay #undef __FUNCT__
16524a2ae208SSatish Balay #define __FUNCT__ "TSGetSNES"
1653d8e5e3e6SSatish Balay /*@
1654d763cef2SBarry Smith    TSGetSNES - Returns the SNES (nonlinear solver) associated with
1655d763cef2SBarry Smith    a TS (timestepper) context. Valid only for nonlinear problems.
1656d763cef2SBarry Smith 
1657d763cef2SBarry Smith    Not Collective, but SNES is parallel if TS is parallel
1658d763cef2SBarry Smith 
1659d763cef2SBarry Smith    Input Parameter:
1660d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1661d763cef2SBarry Smith 
1662d763cef2SBarry Smith    Output Parameter:
1663d763cef2SBarry Smith .  snes - the nonlinear solver context
1664d763cef2SBarry Smith 
1665d763cef2SBarry Smith    Notes:
1666d763cef2SBarry Smith    The user can then directly manipulate the SNES context to set various
1667d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
166894b7f48cSBarry Smith    KSP, KSP, and PC contexts as well.
1669d763cef2SBarry Smith 
1670d763cef2SBarry Smith    TSGetSNES() does not work for integrators that do not use SNES; in
1671d763cef2SBarry Smith    this case TSGetSNES() returns PETSC_NULL in snes.
1672d763cef2SBarry Smith 
1673d763cef2SBarry Smith    Level: beginner
1674d763cef2SBarry Smith 
1675d763cef2SBarry Smith .keywords: timestep, get, SNES
1676d763cef2SBarry Smith @*/
16777087cfbeSBarry Smith PetscErrorCode  TSGetSNES(TS ts,SNES *snes)
1678d763cef2SBarry Smith {
1679d372ba47SLisandro Dalcin   PetscErrorCode ierr;
1680d372ba47SLisandro Dalcin 
1681d763cef2SBarry Smith   PetscFunctionBegin;
16820700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
16834482741eSBarry Smith   PetscValidPointer(snes,2);
1684d372ba47SLisandro Dalcin   if (!ts->snes) {
1685d372ba47SLisandro Dalcin     ierr = SNESCreate(((PetscObject)ts)->comm,&ts->snes);CHKERRQ(ierr);
16866c6b9e74SPeter Brune     ierr = SNESSetFunction(ts->snes,PETSC_NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
1687d372ba47SLisandro Dalcin     ierr = PetscLogObjectParent(ts,ts->snes);CHKERRQ(ierr);
1688d372ba47SLisandro Dalcin     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr);
1689496e6a7aSJed Brown     if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
16909e2a6581SJed Brown     if (ts->problem_type == TS_LINEAR) {
16919e2a6581SJed Brown       ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);
16929e2a6581SJed Brown     }
1693d372ba47SLisandro Dalcin   }
1694d763cef2SBarry Smith   *snes = ts->snes;
1695d763cef2SBarry Smith   PetscFunctionReturn(0);
1696d763cef2SBarry Smith }
1697d763cef2SBarry Smith 
16984a2ae208SSatish Balay #undef __FUNCT__
169994b7f48cSBarry Smith #define __FUNCT__ "TSGetKSP"
1700d8e5e3e6SSatish Balay /*@
170194b7f48cSBarry Smith    TSGetKSP - Returns the KSP (linear solver) associated with
1702d763cef2SBarry Smith    a TS (timestepper) context.
1703d763cef2SBarry Smith 
170494b7f48cSBarry Smith    Not Collective, but KSP is parallel if TS is parallel
1705d763cef2SBarry Smith 
1706d763cef2SBarry Smith    Input Parameter:
1707d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1708d763cef2SBarry Smith 
1709d763cef2SBarry Smith    Output Parameter:
171094b7f48cSBarry Smith .  ksp - the nonlinear solver context
1711d763cef2SBarry Smith 
1712d763cef2SBarry Smith    Notes:
171394b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
1714d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
1715d763cef2SBarry Smith    KSP and PC contexts as well.
1716d763cef2SBarry Smith 
171794b7f48cSBarry Smith    TSGetKSP() does not work for integrators that do not use KSP;
171894b7f48cSBarry Smith    in this case TSGetKSP() returns PETSC_NULL in ksp.
1719d763cef2SBarry Smith 
1720d763cef2SBarry Smith    Level: beginner
1721d763cef2SBarry Smith 
172294b7f48cSBarry Smith .keywords: timestep, get, KSP
1723d763cef2SBarry Smith @*/
17247087cfbeSBarry Smith PetscErrorCode  TSGetKSP(TS ts,KSP *ksp)
1725d763cef2SBarry Smith {
1726d372ba47SLisandro Dalcin   PetscErrorCode ierr;
1727089b2837SJed Brown   SNES           snes;
1728d372ba47SLisandro Dalcin 
1729d763cef2SBarry Smith   PetscFunctionBegin;
17300700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
17314482741eSBarry Smith   PetscValidPointer(ksp,2);
173217186662SBarry Smith   if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first");
1733e32f2f54SBarry Smith   if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()");
1734089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1735089b2837SJed Brown   ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr);
1736d763cef2SBarry Smith   PetscFunctionReturn(0);
1737d763cef2SBarry Smith }
1738d763cef2SBarry Smith 
1739d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */
1740d763cef2SBarry Smith 
17414a2ae208SSatish Balay #undef __FUNCT__
1742adb62b0dSMatthew Knepley #define __FUNCT__ "TSGetDuration"
1743adb62b0dSMatthew Knepley /*@
1744adb62b0dSMatthew Knepley    TSGetDuration - Gets the maximum number of timesteps to use and
1745adb62b0dSMatthew Knepley    maximum time for iteration.
1746adb62b0dSMatthew Knepley 
17473f9fe445SBarry Smith    Not Collective
1748adb62b0dSMatthew Knepley 
1749adb62b0dSMatthew Knepley    Input Parameters:
1750adb62b0dSMatthew Knepley +  ts       - the TS context obtained from TSCreate()
1751adb62b0dSMatthew Knepley .  maxsteps - maximum number of iterations to use, or PETSC_NULL
1752adb62b0dSMatthew Knepley -  maxtime  - final time to iterate to, or PETSC_NULL
1753adb62b0dSMatthew Knepley 
1754adb62b0dSMatthew Knepley    Level: intermediate
1755adb62b0dSMatthew Knepley 
1756adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time
1757adb62b0dSMatthew Knepley @*/
17587087cfbeSBarry Smith PetscErrorCode  TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
1759adb62b0dSMatthew Knepley {
1760adb62b0dSMatthew Knepley   PetscFunctionBegin;
17610700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1762abc0a331SBarry Smith   if (maxsteps) {
17634482741eSBarry Smith     PetscValidIntPointer(maxsteps,2);
1764adb62b0dSMatthew Knepley     *maxsteps = ts->max_steps;
1765adb62b0dSMatthew Knepley   }
1766abc0a331SBarry Smith   if (maxtime) {
17674482741eSBarry Smith     PetscValidScalarPointer(maxtime,3);
1768adb62b0dSMatthew Knepley     *maxtime  = ts->max_time;
1769adb62b0dSMatthew Knepley   }
1770adb62b0dSMatthew Knepley   PetscFunctionReturn(0);
1771adb62b0dSMatthew Knepley }
1772adb62b0dSMatthew Knepley 
1773adb62b0dSMatthew Knepley #undef __FUNCT__
17744a2ae208SSatish Balay #define __FUNCT__ "TSSetDuration"
1775d763cef2SBarry Smith /*@
1776d763cef2SBarry Smith    TSSetDuration - Sets the maximum number of timesteps to use and
1777d763cef2SBarry Smith    maximum time for iteration.
1778d763cef2SBarry Smith 
17793f9fe445SBarry Smith    Logically Collective on TS
1780d763cef2SBarry Smith 
1781d763cef2SBarry Smith    Input Parameters:
1782d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1783d763cef2SBarry Smith .  maxsteps - maximum number of iterations to use
1784d763cef2SBarry Smith -  maxtime - final time to iterate to
1785d763cef2SBarry Smith 
1786d763cef2SBarry Smith    Options Database Keys:
1787d763cef2SBarry Smith .  -ts_max_steps <maxsteps> - Sets maxsteps
17883bca7d26SBarry Smith .  -ts_final_time <maxtime> - Sets maxtime
1789d763cef2SBarry Smith 
1790d763cef2SBarry Smith    Notes:
1791d763cef2SBarry Smith    The default maximum number of iterations is 5000. Default time is 5.0
1792d763cef2SBarry Smith 
1793d763cef2SBarry Smith    Level: intermediate
1794d763cef2SBarry Smith 
1795d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations
1796a43b19c4SJed Brown 
1797a43b19c4SJed Brown .seealso: TSSetExactFinalTime()
1798d763cef2SBarry Smith @*/
17997087cfbeSBarry Smith PetscErrorCode  TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
1800d763cef2SBarry Smith {
1801d763cef2SBarry Smith   PetscFunctionBegin;
18020700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1803c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
1804c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,maxtime,2);
180539b7ec4bSSean Farley   if (maxsteps >= 0) ts->max_steps = maxsteps;
180639b7ec4bSSean Farley   if (maxtime != PETSC_DEFAULT) ts->max_time  = maxtime;
1807d763cef2SBarry Smith   PetscFunctionReturn(0);
1808d763cef2SBarry Smith }
1809d763cef2SBarry Smith 
18104a2ae208SSatish Balay #undef __FUNCT__
18114a2ae208SSatish Balay #define __FUNCT__ "TSSetSolution"
1812d763cef2SBarry Smith /*@
1813d763cef2SBarry Smith    TSSetSolution - Sets the initial solution vector
1814d763cef2SBarry Smith    for use by the TS routines.
1815d763cef2SBarry Smith 
18163f9fe445SBarry Smith    Logically Collective on TS and Vec
1817d763cef2SBarry Smith 
1818d763cef2SBarry Smith    Input Parameters:
1819d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
18200910c330SBarry Smith -  u - the solution vector
1821d763cef2SBarry Smith 
1822d763cef2SBarry Smith    Level: beginner
1823d763cef2SBarry Smith 
1824d763cef2SBarry Smith .keywords: TS, timestep, set, solution, initial conditions
1825d763cef2SBarry Smith @*/
18260910c330SBarry Smith PetscErrorCode  TSSetSolution(TS ts,Vec u)
1827d763cef2SBarry Smith {
18288737fe31SLisandro Dalcin   PetscErrorCode ierr;
1829496e6a7aSJed Brown   DM             dm;
18308737fe31SLisandro Dalcin 
1831d763cef2SBarry Smith   PetscFunctionBegin;
18320700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
18330910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
18340910c330SBarry Smith   ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr);
18356bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
18360910c330SBarry Smith   ts->vec_sol = u;
1837496e6a7aSJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
18380910c330SBarry Smith   ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr);
1839d763cef2SBarry Smith   PetscFunctionReturn(0);
1840d763cef2SBarry Smith }
1841d763cef2SBarry Smith 
1842e74ef692SMatthew Knepley #undef __FUNCT__
1843e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPreStep"
1844ac226902SBarry Smith /*@C
1845000e7ae3SMatthew Knepley   TSSetPreStep - Sets the general-purpose function
18463f2090d5SJed Brown   called once at the beginning of each time step.
1847000e7ae3SMatthew Knepley 
18483f9fe445SBarry Smith   Logically Collective on TS
1849000e7ae3SMatthew Knepley 
1850000e7ae3SMatthew Knepley   Input Parameters:
1851000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
1852000e7ae3SMatthew Knepley - func - The function
1853000e7ae3SMatthew Knepley 
1854000e7ae3SMatthew Knepley   Calling sequence of func:
1855000e7ae3SMatthew Knepley . func (TS ts);
1856000e7ae3SMatthew Knepley 
1857000e7ae3SMatthew Knepley   Level: intermediate
1858000e7ae3SMatthew Knepley 
1859b8123daeSJed Brown   Note:
1860b8123daeSJed Brown   If a step is rejected, TSStep() will call this routine again before each attempt.
1861b8123daeSJed Brown   The last completed time step number can be queried using TSGetTimeStepNumber(), the
1862b8123daeSJed Brown   size of the step being attempted can be obtained using TSGetTimeStep().
1863b8123daeSJed Brown 
1864000e7ae3SMatthew Knepley .keywords: TS, timestep
1865b8123daeSJed Brown .seealso: TSSetPreStage(), TSSetPostStep(), TSStep()
1866000e7ae3SMatthew Knepley @*/
18677087cfbeSBarry Smith PetscErrorCode  TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
1868000e7ae3SMatthew Knepley {
1869000e7ae3SMatthew Knepley   PetscFunctionBegin;
18700700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1871000e7ae3SMatthew Knepley   ts->ops->prestep = func;
1872000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
1873000e7ae3SMatthew Knepley }
1874000e7ae3SMatthew Knepley 
1875e74ef692SMatthew Knepley #undef __FUNCT__
18763f2090d5SJed Brown #define __FUNCT__ "TSPreStep"
187709ee8438SJed Brown /*@
18783f2090d5SJed Brown   TSPreStep - Runs the user-defined pre-step function.
18793f2090d5SJed Brown 
18803f2090d5SJed Brown   Collective on TS
18813f2090d5SJed Brown 
18823f2090d5SJed Brown   Input Parameters:
18833f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
18843f2090d5SJed Brown 
18853f2090d5SJed Brown   Notes:
18863f2090d5SJed Brown   TSPreStep() is typically used within time stepping implementations,
18873f2090d5SJed Brown   so most users would not generally call this routine themselves.
18883f2090d5SJed Brown 
18893f2090d5SJed Brown   Level: developer
18903f2090d5SJed Brown 
18913f2090d5SJed Brown .keywords: TS, timestep
1892b8123daeSJed Brown .seealso: TSSetPreStep(), TSPreStage(), TSPostStep()
18933f2090d5SJed Brown @*/
18947087cfbeSBarry Smith PetscErrorCode  TSPreStep(TS ts)
18953f2090d5SJed Brown {
18963f2090d5SJed Brown   PetscErrorCode ierr;
18973f2090d5SJed Brown 
18983f2090d5SJed Brown   PetscFunctionBegin;
18990700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
190072ac3e02SJed Brown   if (ts->ops->prestep) {
19013f2090d5SJed Brown     PetscStackPush("TS PreStep function");
19023f2090d5SJed Brown     ierr = (*ts->ops->prestep)(ts);CHKERRQ(ierr);
19033f2090d5SJed Brown     PetscStackPop;
1904312ce896SJed Brown   }
19053f2090d5SJed Brown   PetscFunctionReturn(0);
19063f2090d5SJed Brown }
19073f2090d5SJed Brown 
19083f2090d5SJed Brown #undef __FUNCT__
1909b8123daeSJed Brown #define __FUNCT__ "TSSetPreStage"
1910b8123daeSJed Brown /*@C
1911b8123daeSJed Brown   TSSetPreStage - Sets the general-purpose function
1912b8123daeSJed Brown   called once at the beginning of each stage.
1913b8123daeSJed Brown 
1914b8123daeSJed Brown   Logically Collective on TS
1915b8123daeSJed Brown 
1916b8123daeSJed Brown   Input Parameters:
1917b8123daeSJed Brown + ts   - The TS context obtained from TSCreate()
1918b8123daeSJed Brown - func - The function
1919b8123daeSJed Brown 
1920b8123daeSJed Brown   Calling sequence of func:
1921b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime);
1922b8123daeSJed Brown 
1923b8123daeSJed Brown   Level: intermediate
1924b8123daeSJed Brown 
1925b8123daeSJed Brown   Note:
1926b8123daeSJed Brown   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
1927b8123daeSJed Brown   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
1928b8123daeSJed Brown   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
1929b8123daeSJed Brown 
1930b8123daeSJed Brown .keywords: TS, timestep
1931b8123daeSJed Brown .seealso: TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
1932b8123daeSJed Brown @*/
1933b8123daeSJed Brown PetscErrorCode  TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal))
1934b8123daeSJed Brown {
1935b8123daeSJed Brown   PetscFunctionBegin;
1936b8123daeSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1937b8123daeSJed Brown   ts->ops->prestage = func;
1938b8123daeSJed Brown   PetscFunctionReturn(0);
1939b8123daeSJed Brown }
1940b8123daeSJed Brown 
1941b8123daeSJed Brown #undef __FUNCT__
1942b8123daeSJed Brown #define __FUNCT__ "TSPreStage"
1943b8123daeSJed Brown /*@
1944b8123daeSJed Brown   TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage()
1945b8123daeSJed Brown 
1946b8123daeSJed Brown   Collective on TS
1947b8123daeSJed Brown 
1948b8123daeSJed Brown   Input Parameters:
1949b8123daeSJed Brown . ts   - The TS context obtained from TSCreate()
1950b8123daeSJed Brown 
1951b8123daeSJed Brown   Notes:
1952b8123daeSJed Brown   TSPreStage() is typically used within time stepping implementations,
1953b8123daeSJed Brown   most users would not generally call this routine themselves.
1954b8123daeSJed Brown 
1955b8123daeSJed Brown   Level: developer
1956b8123daeSJed Brown 
1957b8123daeSJed Brown .keywords: TS, timestep
1958b8123daeSJed Brown .seealso: TSSetPreStep(), TSPreStep(), TSPostStep()
1959b8123daeSJed Brown @*/
1960b8123daeSJed Brown PetscErrorCode  TSPreStage(TS ts, PetscReal stagetime)
1961b8123daeSJed Brown {
1962b8123daeSJed Brown   PetscErrorCode ierr;
1963b8123daeSJed Brown 
1964b8123daeSJed Brown   PetscFunctionBegin;
1965b8123daeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1966b8123daeSJed Brown   if (ts->ops->prestage) {
1967b8123daeSJed Brown     PetscStackPush("TS PreStage function");
1968b8123daeSJed Brown     ierr = (*ts->ops->prestage)(ts,stagetime);CHKERRQ(ierr);
1969b8123daeSJed Brown     PetscStackPop;
1970b8123daeSJed Brown   }
1971b8123daeSJed Brown   PetscFunctionReturn(0);
1972b8123daeSJed Brown }
1973b8123daeSJed Brown 
1974b8123daeSJed Brown #undef __FUNCT__
1975e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPostStep"
1976ac226902SBarry Smith /*@C
1977000e7ae3SMatthew Knepley   TSSetPostStep - Sets the general-purpose function
19783f2090d5SJed Brown   called once at the end of each time step.
1979000e7ae3SMatthew Knepley 
19803f9fe445SBarry Smith   Logically Collective on TS
1981000e7ae3SMatthew Knepley 
1982000e7ae3SMatthew Knepley   Input Parameters:
1983000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
1984000e7ae3SMatthew Knepley - func - The function
1985000e7ae3SMatthew Knepley 
1986000e7ae3SMatthew Knepley   Calling sequence of func:
1987b8123daeSJed Brown $ func (TS ts);
1988000e7ae3SMatthew Knepley 
1989000e7ae3SMatthew Knepley   Level: intermediate
1990000e7ae3SMatthew Knepley 
1991000e7ae3SMatthew Knepley .keywords: TS, timestep
1992b8123daeSJed Brown .seealso: TSSetPreStep(), TSSetPreStage(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime()
1993000e7ae3SMatthew Knepley @*/
19947087cfbeSBarry Smith PetscErrorCode  TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
1995000e7ae3SMatthew Knepley {
1996000e7ae3SMatthew Knepley   PetscFunctionBegin;
19970700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1998000e7ae3SMatthew Knepley   ts->ops->poststep = func;
1999000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
2000000e7ae3SMatthew Knepley }
2001000e7ae3SMatthew Knepley 
2002e74ef692SMatthew Knepley #undef __FUNCT__
20033f2090d5SJed Brown #define __FUNCT__ "TSPostStep"
200409ee8438SJed Brown /*@
20053f2090d5SJed Brown   TSPostStep - Runs the user-defined post-step function.
20063f2090d5SJed Brown 
20073f2090d5SJed Brown   Collective on TS
20083f2090d5SJed Brown 
20093f2090d5SJed Brown   Input Parameters:
20103f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
20113f2090d5SJed Brown 
20123f2090d5SJed Brown   Notes:
20133f2090d5SJed Brown   TSPostStep() is typically used within time stepping implementations,
20143f2090d5SJed Brown   so most users would not generally call this routine themselves.
20153f2090d5SJed Brown 
20163f2090d5SJed Brown   Level: developer
20173f2090d5SJed Brown 
20183f2090d5SJed Brown .keywords: TS, timestep
20193f2090d5SJed Brown @*/
20207087cfbeSBarry Smith PetscErrorCode  TSPostStep(TS ts)
20213f2090d5SJed Brown {
20223f2090d5SJed Brown   PetscErrorCode ierr;
20233f2090d5SJed Brown 
20243f2090d5SJed Brown   PetscFunctionBegin;
20250700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
202672ac3e02SJed Brown   if (ts->ops->poststep) {
20273f2090d5SJed Brown     PetscStackPush("TS PostStep function");
20283f2090d5SJed Brown     ierr = (*ts->ops->poststep)(ts);CHKERRQ(ierr);
20293f2090d5SJed Brown     PetscStackPop;
203072ac3e02SJed Brown   }
20313f2090d5SJed Brown   PetscFunctionReturn(0);
20323f2090d5SJed Brown }
20333f2090d5SJed Brown 
2034d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
2035d763cef2SBarry Smith 
20364a2ae208SSatish Balay #undef __FUNCT__
2037a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSet"
2038d763cef2SBarry Smith /*@C
2039a6570f20SBarry Smith    TSMonitorSet - Sets an ADDITIONAL function that is to be used at every
2040d763cef2SBarry Smith    timestep to display the iteration's  progress.
2041d763cef2SBarry Smith 
20423f9fe445SBarry Smith    Logically Collective on TS
2043d763cef2SBarry Smith 
2044d763cef2SBarry Smith    Input Parameters:
2045d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2046e213d8f1SJed Brown .  monitor - monitoring routine
2047329f5518SBarry Smith .  mctx - [optional] user-defined context for private data for the
2048b3006f0bSLois Curfman McInnes              monitor routine (use PETSC_NULL if no context is desired)
2049b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
2050b3006f0bSLois Curfman McInnes           (may be PETSC_NULL)
2051d763cef2SBarry Smith 
2052e213d8f1SJed Brown    Calling sequence of monitor:
20530910c330SBarry Smith $    int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx)
2054d763cef2SBarry Smith 
2055d763cef2SBarry Smith +    ts - the TS context
205688c05cc5SBarry Smith .    steps - iteration number (after the final time step the monitor routine is called with a step of -1, this is at the final time which may have
205788c05cc5SBarry Smith                                been interpolated to)
20581f06c33eSBarry Smith .    time - current time
20590910c330SBarry Smith .    u - current iterate
2060d763cef2SBarry Smith -    mctx - [optional] monitoring context
2061d763cef2SBarry Smith 
2062d763cef2SBarry Smith    Notes:
2063d763cef2SBarry Smith    This routine adds an additional monitor to the list of monitors that
2064d763cef2SBarry Smith    already has been loaded.
2065d763cef2SBarry Smith 
2066025f1a04SBarry Smith    Fortran notes: Only a single monitor function can be set for each TS object
2067025f1a04SBarry Smith 
2068d763cef2SBarry Smith    Level: intermediate
2069d763cef2SBarry Smith 
2070d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
2071d763cef2SBarry Smith 
2072a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel()
2073d763cef2SBarry Smith @*/
2074c2efdce3SBarry Smith PetscErrorCode  TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**))
2075d763cef2SBarry Smith {
2076d763cef2SBarry Smith   PetscFunctionBegin;
20770700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
207817186662SBarry Smith   if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
2079d763cef2SBarry Smith   ts->monitor[ts->numbermonitors]           = monitor;
20808704b422SBarry Smith   ts->monitordestroy[ts->numbermonitors]    = mdestroy;
2081d763cef2SBarry Smith   ts->monitorcontext[ts->numbermonitors++]  = (void*)mctx;
2082d763cef2SBarry Smith   PetscFunctionReturn(0);
2083d763cef2SBarry Smith }
2084d763cef2SBarry Smith 
20854a2ae208SSatish Balay #undef __FUNCT__
2086a6570f20SBarry Smith #define __FUNCT__ "TSMonitorCancel"
2087d763cef2SBarry Smith /*@C
2088a6570f20SBarry Smith    TSMonitorCancel - Clears all the monitors that have been set on a time-step object.
2089d763cef2SBarry Smith 
20903f9fe445SBarry Smith    Logically Collective on TS
2091d763cef2SBarry Smith 
2092d763cef2SBarry Smith    Input Parameters:
2093d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2094d763cef2SBarry Smith 
2095d763cef2SBarry Smith    Notes:
2096d763cef2SBarry Smith    There is no way to remove a single, specific monitor.
2097d763cef2SBarry Smith 
2098d763cef2SBarry Smith    Level: intermediate
2099d763cef2SBarry Smith 
2100d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
2101d763cef2SBarry Smith 
2102a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet()
2103d763cef2SBarry Smith @*/
21047087cfbeSBarry Smith PetscErrorCode  TSMonitorCancel(TS ts)
2105d763cef2SBarry Smith {
2106d952e501SBarry Smith   PetscErrorCode ierr;
2107d952e501SBarry Smith   PetscInt       i;
2108d952e501SBarry Smith 
2109d763cef2SBarry Smith   PetscFunctionBegin;
21100700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2111d952e501SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
21128704b422SBarry Smith     if (ts->monitordestroy[i]) {
21138704b422SBarry Smith       ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr);
2114d952e501SBarry Smith     }
2115d952e501SBarry Smith   }
2116d763cef2SBarry Smith   ts->numbermonitors = 0;
2117d763cef2SBarry Smith   PetscFunctionReturn(0);
2118d763cef2SBarry Smith }
2119d763cef2SBarry Smith 
21204a2ae208SSatish Balay #undef __FUNCT__
2121a6570f20SBarry Smith #define __FUNCT__ "TSMonitorDefault"
2122d8e5e3e6SSatish Balay /*@
2123a6570f20SBarry Smith    TSMonitorDefault - Sets the Default monitor
21245516499fSSatish Balay 
21255516499fSSatish Balay    Level: intermediate
212641251cbbSSatish Balay 
21275516499fSSatish Balay .keywords: TS, set, monitor
21285516499fSSatish Balay 
212941251cbbSSatish Balay .seealso: TSMonitorDefault(), TSMonitorSet()
213041251cbbSSatish Balay @*/
2131649052a6SBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,void *dummy)
2132d763cef2SBarry Smith {
2133dfbe8321SBarry Smith   PetscErrorCode ierr;
2134649052a6SBarry Smith   PetscViewer    viewer = dummy ? (PetscViewer) dummy : PETSC_VIEWER_STDOUT_(((PetscObject)ts)->comm);
2135d132466eSBarry Smith 
2136d763cef2SBarry Smith   PetscFunctionBegin;
2137649052a6SBarry Smith   ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
2138971832b6SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g\n",step,(double)ts->time_step,(double)ptime);CHKERRQ(ierr);
2139649052a6SBarry Smith   ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
2140d763cef2SBarry Smith   PetscFunctionReturn(0);
2141d763cef2SBarry Smith }
2142d763cef2SBarry Smith 
21434a2ae208SSatish Balay #undef __FUNCT__
2144cd652676SJed Brown #define __FUNCT__ "TSSetRetainStages"
2145cd652676SJed Brown /*@
2146cd652676SJed Brown    TSSetRetainStages - Request that all stages in the upcoming step be stored so that interpolation will be available.
2147cd652676SJed Brown 
2148cd652676SJed Brown    Logically Collective on TS
2149cd652676SJed Brown 
2150cd652676SJed Brown    Input Argument:
2151cd652676SJed Brown .  ts - time stepping context
2152cd652676SJed Brown 
2153cd652676SJed Brown    Output Argument:
2154cd652676SJed Brown .  flg - PETSC_TRUE or PETSC_FALSE
2155cd652676SJed Brown 
2156cd652676SJed Brown    Level: intermediate
2157cd652676SJed Brown 
2158cd652676SJed Brown .keywords: TS, set
2159cd652676SJed Brown 
2160cd652676SJed Brown .seealso: TSInterpolate(), TSSetPostStep()
2161cd652676SJed Brown @*/
2162cd652676SJed Brown PetscErrorCode TSSetRetainStages(TS ts,PetscBool flg)
2163cd652676SJed Brown {
2164cd652676SJed Brown   PetscFunctionBegin;
2165cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2166cd652676SJed Brown   ts->retain_stages = flg;
2167cd652676SJed Brown   PetscFunctionReturn(0);
2168cd652676SJed Brown }
2169cd652676SJed Brown 
2170cd652676SJed Brown #undef __FUNCT__
2171cd652676SJed Brown #define __FUNCT__ "TSInterpolate"
2172cd652676SJed Brown /*@
2173cd652676SJed Brown    TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
2174cd652676SJed Brown 
2175cd652676SJed Brown    Collective on TS
2176cd652676SJed Brown 
2177cd652676SJed Brown    Input Argument:
2178cd652676SJed Brown +  ts - time stepping context
2179cd652676SJed Brown -  t - time to interpolate to
2180cd652676SJed Brown 
2181cd652676SJed Brown    Output Argument:
21820910c330SBarry Smith .  U - state at given time
2183cd652676SJed Brown 
2184cd652676SJed Brown    Notes:
2185cd652676SJed Brown    The user should call TSSetRetainStages() before taking a step in which interpolation will be requested.
2186cd652676SJed Brown 
2187cd652676SJed Brown    Level: intermediate
2188cd652676SJed Brown 
2189cd652676SJed Brown    Developer Notes:
2190cd652676SJed Brown    TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
2191cd652676SJed Brown 
2192cd652676SJed Brown .keywords: TS, set
2193cd652676SJed Brown 
2194cd652676SJed Brown .seealso: TSSetRetainStages(), TSSetPostStep()
2195cd652676SJed Brown @*/
21960910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U)
2197cd652676SJed Brown {
2198cd652676SJed Brown   PetscErrorCode ierr;
2199cd652676SJed Brown 
2200cd652676SJed Brown   PetscFunctionBegin;
2201cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2202d8cd7023SBarry Smith   if (t < ts->ptime - ts->time_step_prev || t > ts->ptime) SETERRQ3(((PetscObject)ts)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Requested time %G not in last time steps [%G,%G]",t,ts->ptime-ts->time_step_prev,ts->ptime);
2203cd652676SJed Brown   if (!ts->ops->interpolate) SETERRQ1(((PetscObject)ts)->comm,PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
22040910c330SBarry Smith   ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr);
2205cd652676SJed Brown   PetscFunctionReturn(0);
2206cd652676SJed Brown }
2207cd652676SJed Brown 
2208cd652676SJed Brown #undef __FUNCT__
22094a2ae208SSatish Balay #define __FUNCT__ "TSStep"
2210d763cef2SBarry Smith /*@
22116d9e5789SSean Farley    TSStep - Steps one time step
2212d763cef2SBarry Smith 
2213d763cef2SBarry Smith    Collective on TS
2214d763cef2SBarry Smith 
2215d763cef2SBarry Smith    Input Parameter:
2216d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2217d763cef2SBarry Smith 
22186d9e5789SSean Farley    Level: intermediate
2219d763cef2SBarry Smith 
2220b8123daeSJed Brown    Notes:
2221b8123daeSJed Brown    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
2222b8123daeSJed Brown    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
2223b8123daeSJed Brown 
222425cb2221SBarry Smith    This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the
222525cb2221SBarry Smith    time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
222625cb2221SBarry Smith 
2227d763cef2SBarry Smith .keywords: TS, timestep, solve
2228d763cef2SBarry Smith 
222925cb2221SBarry Smith .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate()
2230d763cef2SBarry Smith @*/
2231193ac0bcSJed Brown PetscErrorCode  TSStep(TS ts)
2232d763cef2SBarry Smith {
2233362cd11cSLisandro Dalcin   PetscReal      ptime_prev;
2234dfbe8321SBarry Smith   PetscErrorCode ierr;
2235d763cef2SBarry Smith 
2236d763cef2SBarry Smith   PetscFunctionBegin;
22370700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2238d405a339SMatthew Knepley   ierr = TSSetUp(ts);CHKERRQ(ierr);
2239d405a339SMatthew Knepley 
2240362cd11cSLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
2241362cd11cSLisandro Dalcin 
2242362cd11cSLisandro Dalcin   ptime_prev = ts->ptime;
2243d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
2244193ac0bcSJed Brown   ierr = (*ts->ops->step)(ts);CHKERRQ(ierr);
2245d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
2246362cd11cSLisandro Dalcin   ts->time_step_prev = ts->ptime - ptime_prev;
2247362cd11cSLisandro Dalcin 
2248362cd11cSLisandro Dalcin   if (ts->reason < 0) {
2249cef5090cSJed Brown     if (ts->errorifstepfailed) {
2250cef5090cSJed Brown       if (ts->reason == TS_DIVERGED_NONLINEAR_SOLVE) {
2251cef5090cSJed Brown         SETERRQ1(((PetscObject)ts)->comm,PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s, increase -ts_max_snes_failures or make negative to attempt recovery",TSConvergedReasons[ts->reason]);
2252cef5090cSJed Brown       } else SETERRQ1(((PetscObject)ts)->comm,PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
2253cef5090cSJed Brown     }
2254362cd11cSLisandro Dalcin   } else if (!ts->reason) {
2255362cd11cSLisandro Dalcin     if (ts->steps >= ts->max_steps)
2256362cd11cSLisandro Dalcin       ts->reason = TS_CONVERGED_ITS;
2257362cd11cSLisandro Dalcin     else if (ts->ptime >= ts->max_time)
2258362cd11cSLisandro Dalcin       ts->reason = TS_CONVERGED_TIME;
2259362cd11cSLisandro Dalcin   }
2260362cd11cSLisandro Dalcin 
2261d763cef2SBarry Smith   PetscFunctionReturn(0);
2262d763cef2SBarry Smith }
2263d763cef2SBarry Smith 
22644a2ae208SSatish Balay #undef __FUNCT__
226505175c85SJed Brown #define __FUNCT__ "TSEvaluateStep"
226605175c85SJed Brown /*@
226705175c85SJed Brown    TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy.
226805175c85SJed Brown 
22691c3436cfSJed Brown    Collective on TS
227005175c85SJed Brown 
227105175c85SJed Brown    Input Arguments:
22721c3436cfSJed Brown +  ts - time stepping context
22731c3436cfSJed Brown .  order - desired order of accuracy
22741c3436cfSJed Brown -  done - whether the step was evaluated at this order (pass PETSC_NULL to generate an error if not available)
227505175c85SJed Brown 
227605175c85SJed Brown    Output Arguments:
22770910c330SBarry Smith .  U - state at the end of the current step
227805175c85SJed Brown 
227905175c85SJed Brown    Level: advanced
228005175c85SJed Brown 
2281108c343cSJed Brown    Notes:
2282108c343cSJed Brown    This function cannot be called until all stages have been evaluated.
2283108c343cSJed Brown    It is normally called by adaptive controllers before a step has been accepted and may also be called by the user after TSStep() has returned.
2284108c343cSJed Brown 
22851c3436cfSJed Brown .seealso: TSStep(), TSAdapt
228605175c85SJed Brown @*/
22870910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done)
228805175c85SJed Brown {
228905175c85SJed Brown   PetscErrorCode ierr;
229005175c85SJed Brown 
229105175c85SJed Brown   PetscFunctionBegin;
229205175c85SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
229305175c85SJed Brown   PetscValidType(ts,1);
22940910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
22951c3436cfSJed Brown   if (!ts->ops->evaluatestep) SETERRQ1(((PetscObject)ts)->comm,PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name);
22960910c330SBarry Smith   ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr);
229705175c85SJed Brown   PetscFunctionReturn(0);
229805175c85SJed Brown }
229905175c85SJed Brown 
230005175c85SJed Brown #undef __FUNCT__
23016a4d4014SLisandro Dalcin #define __FUNCT__ "TSSolve"
23026a4d4014SLisandro Dalcin /*@
23036a4d4014SLisandro Dalcin    TSSolve - Steps the requested number of timesteps.
23046a4d4014SLisandro Dalcin 
23056a4d4014SLisandro Dalcin    Collective on TS
23066a4d4014SLisandro Dalcin 
23076a4d4014SLisandro Dalcin    Input Parameter:
23086a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
2309cc708dedSBarry Smith -  u - the solution vector  (can be null if TSSetSolution() was used, otherwise must contain the initial conditions)
23105a3a76d0SJed Brown 
23116a4d4014SLisandro Dalcin    Level: beginner
23126a4d4014SLisandro Dalcin 
23135a3a76d0SJed Brown    Notes:
23145a3a76d0SJed Brown    The final time returned by this function may be different from the time of the internally
23155a3a76d0SJed Brown    held state accessible by TSGetSolution() and TSGetTime() because the method may have
23165a3a76d0SJed Brown    stepped over the final time.
23175a3a76d0SJed Brown 
23186a4d4014SLisandro Dalcin .keywords: TS, timestep, solve
23196a4d4014SLisandro Dalcin 
23206a4d4014SLisandro Dalcin .seealso: TSCreate(), TSSetSolution(), TSStep()
23216a4d4014SLisandro Dalcin @*/
2322cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u)
23236a4d4014SLisandro Dalcin {
23244d7d938eSLisandro Dalcin   PetscBool      flg;
23254d7d938eSLisandro Dalcin   char           filename[PETSC_MAX_PATH_LEN];
23264d7d938eSLisandro Dalcin   PetscViewer    viewer;
23276a4d4014SLisandro Dalcin   PetscErrorCode ierr;
2328f22f69f0SBarry Smith 
23296a4d4014SLisandro Dalcin   PetscFunctionBegin;
23300700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2331f2c2a1b9SBarry Smith   if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2);
23325a3a76d0SJed Brown   if (ts->exact_final_time) {   /* Need ts->vec_sol to be distinct so it is not overwritten when we interpolate at the end */
23330910c330SBarry Smith     if (!ts->vec_sol || u == ts->vec_sol) {
23345a3a76d0SJed Brown       Vec y;
23350910c330SBarry Smith       ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
23365a3a76d0SJed Brown       ierr = TSSetSolution(ts,y);CHKERRQ(ierr);
23375a3a76d0SJed Brown       ierr = VecDestroy(&y);CHKERRQ(ierr); /* grant ownership */
23385a3a76d0SJed Brown     }
2339f2c2a1b9SBarry Smith     if (u) {
23400910c330SBarry Smith       ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr);
2341f2c2a1b9SBarry Smith     }
23425a3a76d0SJed Brown   } else {
2343f2c2a1b9SBarry Smith     if (u) {
23440910c330SBarry Smith       ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
23455a3a76d0SJed Brown     }
2346f2c2a1b9SBarry Smith   }
2347b5d403baSSean Farley   ierr = TSSetUp(ts);CHKERRQ(ierr);
23486a4d4014SLisandro Dalcin   /* reset time step and iteration counters */
2349193ac0bcSJed Brown   ts->steps = 0;
23505ef26d82SJed Brown   ts->ksp_its = 0;
23515ef26d82SJed Brown   ts->snes_its = 0;
2352c610991cSLisandro Dalcin   ts->num_snes_failures = 0;
2353c610991cSLisandro Dalcin   ts->reject = 0;
2354193ac0bcSJed Brown   ts->reason = TS_CONVERGED_ITERATING;
2355193ac0bcSJed Brown 
2356193ac0bcSJed Brown   if (ts->ops->solve) {         /* This private interface is transitional and should be removed when all implementations are updated. */
2357193ac0bcSJed Brown     ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr);
23580910c330SBarry Smith     ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);
2359cc708dedSBarry Smith     ts->solvetime = ts->ptime;
2360193ac0bcSJed Brown   } else {
23616a4d4014SLisandro Dalcin     /* steps the requested number of timesteps. */
2362362cd11cSLisandro Dalcin     ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
2363362cd11cSLisandro Dalcin     if (ts->steps >= ts->max_steps)
2364362cd11cSLisandro Dalcin       ts->reason = TS_CONVERGED_ITS;
2365362cd11cSLisandro Dalcin     else if (ts->ptime >= ts->max_time)
2366362cd11cSLisandro Dalcin       ts->reason = TS_CONVERGED_TIME;
2367e1a7a14fSJed Brown     while (!ts->reason) {
2368193ac0bcSJed Brown       ierr = TSStep(ts);CHKERRQ(ierr);
2369193ac0bcSJed Brown       ierr = TSPostStep(ts);CHKERRQ(ierr);
2370193ac0bcSJed Brown       ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
2371193ac0bcSJed Brown     }
2372362cd11cSLisandro Dalcin     if (ts->exact_final_time && ts->ptime > ts->max_time) {
23730910c330SBarry Smith       ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr);
2374cc708dedSBarry Smith       ts->solvetime = ts->max_time;
23750574a7fbSJed Brown     } else {
23760910c330SBarry Smith       ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);
2377cc708dedSBarry Smith       ts->solvetime = ts->ptime;
23780574a7fbSJed Brown     }
2379193ac0bcSJed Brown   }
23803923b477SBarry Smith   ierr = TSMonitor(ts,-1,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
23814d7d938eSLisandro Dalcin   ierr = PetscOptionsGetString(((PetscObject)ts)->prefix,"-ts_view",filename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
23824d7d938eSLisandro Dalcin   if (flg && !PetscPreLoadingOn) {
23834d7d938eSLisandro Dalcin     ierr = PetscViewerASCIIOpen(((PetscObject)ts)->comm,filename,&viewer);CHKERRQ(ierr);
23844d7d938eSLisandro Dalcin     ierr = TSView(ts,viewer);CHKERRQ(ierr);
23854d7d938eSLisandro Dalcin     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
2386193ac0bcSJed Brown   }
23872b0a91c0SBarry Smith   flg = PETSC_FALSE;
23882b0a91c0SBarry Smith   ierr = PetscOptionsGetBool(((PetscObject)ts)->prefix,"-ts_view_draw",&flg,PETSC_NULL);CHKERRQ(ierr);
23892b0a91c0SBarry Smith   if (flg) {
23902b0a91c0SBarry Smith     ierr = PetscViewerDrawOpen(((PetscObject)ts)->comm,PETSC_NULL,"TS Solver",0,0,600,600,&viewer);CHKERRQ(ierr);
23912b0a91c0SBarry Smith     ierr = TSView(ts,viewer);CHKERRQ(ierr);
23922b0a91c0SBarry Smith     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
23932b0a91c0SBarry Smith   }
23946a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
23956a4d4014SLisandro Dalcin }
23966a4d4014SLisandro Dalcin 
23976a4d4014SLisandro Dalcin #undef __FUNCT__
23984a2ae208SSatish Balay #define __FUNCT__ "TSMonitor"
2399228d79bcSJed Brown /*@
2400228d79bcSJed Brown    TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet()
2401228d79bcSJed Brown 
2402228d79bcSJed Brown    Collective on TS
2403228d79bcSJed Brown 
2404228d79bcSJed Brown    Input Parameters:
2405228d79bcSJed Brown +  ts - time stepping context obtained from TSCreate()
2406228d79bcSJed Brown .  step - step number that has just completed
2407228d79bcSJed Brown .  ptime - model time of the state
24080910c330SBarry Smith -  u - state at the current model time
2409228d79bcSJed Brown 
2410228d79bcSJed Brown    Notes:
2411228d79bcSJed Brown    TSMonitor() is typically used within the time stepping implementations.
2412228d79bcSJed Brown    Users might call this function when using the TSStep() interface instead of TSSolve().
2413228d79bcSJed Brown 
2414228d79bcSJed Brown    Level: advanced
2415228d79bcSJed Brown 
2416228d79bcSJed Brown .keywords: TS, timestep
2417228d79bcSJed Brown @*/
24180910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u)
2419d763cef2SBarry Smith {
24206849ba73SBarry Smith   PetscErrorCode ierr;
2421a7cc72afSBarry Smith   PetscInt       i,n = ts->numbermonitors;
2422d763cef2SBarry Smith 
2423d763cef2SBarry Smith   PetscFunctionBegin;
2424d763cef2SBarry Smith   for (i=0; i<n; i++) {
24250910c330SBarry Smith     ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr);
2426d763cef2SBarry Smith   }
2427d763cef2SBarry Smith   PetscFunctionReturn(0);
2428d763cef2SBarry Smith }
2429d763cef2SBarry Smith 
2430d763cef2SBarry Smith /* ------------------------------------------------------------------------*/
24310b039ecaSBarry Smith struct _n_TSMonitorLGCtx {
24320b039ecaSBarry Smith   PetscDrawLG lg;
24330b039ecaSBarry Smith   PetscInt    howoften;  /* when > 0 uses step % howoften, when negative only final solution plotted */
2434201da799SBarry Smith   PetscInt    ksp_its,snes_its;
24350b039ecaSBarry Smith };
24360b039ecaSBarry Smith 
2437d763cef2SBarry Smith 
24384a2ae208SSatish Balay #undef __FUNCT__
2439a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxCreate"
2440d763cef2SBarry Smith /*@C
2441a9f9c1f6SBarry Smith    TSMonitorLGCtxCreate - Creates a line graph context for use with
2442a9f9c1f6SBarry Smith    TS to monitor the solution process graphically in various ways
2443d763cef2SBarry Smith 
2444d763cef2SBarry Smith    Collective on TS
2445d763cef2SBarry Smith 
2446d763cef2SBarry Smith    Input Parameters:
2447d763cef2SBarry Smith +  host - the X display to open, or null for the local machine
2448d763cef2SBarry Smith .  label - the title to put in the title bar
24497c922b88SBarry Smith .  x, y - the screen coordinates of the upper left coordinate of the window
2450a9f9c1f6SBarry Smith .  m, n - the screen width and height in pixels
2451a9f9c1f6SBarry Smith -  howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time
2452d763cef2SBarry Smith 
2453d763cef2SBarry Smith    Output Parameter:
24540b039ecaSBarry Smith .  ctx - the context
2455d763cef2SBarry Smith 
2456d763cef2SBarry Smith    Options Database Key:
24574f09c107SBarry Smith +  -ts_monitor_lg_timestep - automatically sets line graph monitor
24584f09c107SBarry Smith .  -ts_monitor_lg_solution -
245999fdda47SBarry Smith .  -ts_monitor_lg_error -
246099fdda47SBarry Smith .  -ts_monitor_lg_ksp_iterations -
246199fdda47SBarry Smith .  -ts_monitor_lg_snes_iterations -
246299fdda47SBarry Smith -  -lg_indicate_data_points <true,false> - indicate the data points (at each time step) on the plot; default is true
2463d763cef2SBarry Smith 
2464d763cef2SBarry Smith    Notes:
2465a9f9c1f6SBarry Smith    Use TSMonitorLGCtxDestroy() to destroy.
2466d763cef2SBarry Smith 
2467d763cef2SBarry Smith    Level: intermediate
2468d763cef2SBarry Smith 
24697c922b88SBarry Smith .keywords: TS, monitor, line graph, residual, seealso
2470d763cef2SBarry Smith 
24714f09c107SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
24727c922b88SBarry Smith 
2473d763cef2SBarry Smith @*/
2474a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx)
2475d763cef2SBarry Smith {
2476b0a32e0cSBarry Smith   PetscDraw      win;
2477dfbe8321SBarry Smith   PetscErrorCode ierr;
247899fdda47SBarry Smith   PetscBool      flg = PETSC_TRUE;
2479d763cef2SBarry Smith 
2480d763cef2SBarry Smith   PetscFunctionBegin;
2481201da799SBarry Smith   ierr = PetscNew(struct _n_TSMonitorLGCtx,ctx);CHKERRQ(ierr);
2482a80ad3e0SBarry Smith   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&win);CHKERRQ(ierr);
24833fbbecb0SBarry Smith   ierr = PetscDrawSetFromOptions(win);CHKERRQ(ierr);
24840b039ecaSBarry Smith   ierr = PetscDrawLGCreate(win,1,&(*ctx)->lg);CHKERRQ(ierr);
248599fdda47SBarry Smith   ierr = PetscOptionsGetBool(PETSC_NULL,"-lg_indicate_data_points",&flg,PETSC_NULL);CHKERRQ(ierr);
248699fdda47SBarry Smith   if (flg) {
24870b039ecaSBarry Smith     ierr = PetscDrawLGIndicateDataPoints((*ctx)->lg);CHKERRQ(ierr);
248899fdda47SBarry Smith   }
24890b039ecaSBarry Smith   ierr = PetscLogObjectParent((*ctx)->lg,win);CHKERRQ(ierr);
2490a9f9c1f6SBarry Smith   (*ctx)->howoften = howoften;
2491d763cef2SBarry Smith   PetscFunctionReturn(0);
2492d763cef2SBarry Smith }
2493d763cef2SBarry Smith 
24944a2ae208SSatish Balay #undef __FUNCT__
24954f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGTimeStep"
24964f09c107SBarry Smith PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
2497d763cef2SBarry Smith {
24980b039ecaSBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
2499c32365f1SBarry Smith   PetscReal      x = ptime,y;
2500dfbe8321SBarry Smith   PetscErrorCode ierr;
2501d763cef2SBarry Smith 
2502d763cef2SBarry Smith   PetscFunctionBegin;
2503a9f9c1f6SBarry Smith   if (!n) {
2504a9f9c1f6SBarry Smith     PetscDrawAxis  axis;
2505a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
2506a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time step");CHKERRQ(ierr);
2507a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
2508a9f9c1f6SBarry Smith   }
2509c32365f1SBarry Smith   ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr);
25100b039ecaSBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
251199fdda47SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften))) || ((ctx->howoften == -1) && (n == -1))){
25120b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
25133923b477SBarry Smith   }
2514d763cef2SBarry Smith   PetscFunctionReturn(0);
2515d763cef2SBarry Smith }
2516d763cef2SBarry Smith 
25174a2ae208SSatish Balay #undef __FUNCT__
2518a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxDestroy"
2519d763cef2SBarry Smith /*@C
2520a9f9c1f6SBarry Smith    TSMonitorLGCtxDestroy - Destroys a line graph context that was created
2521a9f9c1f6SBarry Smith    with TSMonitorLGCtxCreate().
2522d763cef2SBarry Smith 
25230b039ecaSBarry Smith    Collective on TSMonitorLGCtx
2524d763cef2SBarry Smith 
2525d763cef2SBarry Smith    Input Parameter:
25260b039ecaSBarry Smith .  ctx - the monitor context
2527d763cef2SBarry Smith 
2528d763cef2SBarry Smith    Level: intermediate
2529d763cef2SBarry Smith 
2530d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy
2531d763cef2SBarry Smith 
25324f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep();
2533d763cef2SBarry Smith @*/
2534a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx)
2535d763cef2SBarry Smith {
2536b0a32e0cSBarry Smith   PetscDraw      draw;
2537dfbe8321SBarry Smith   PetscErrorCode ierr;
2538d763cef2SBarry Smith 
2539d763cef2SBarry Smith   PetscFunctionBegin;
25400b039ecaSBarry Smith   ierr = PetscDrawLGGetDraw((*ctx)->lg,&draw);CHKERRQ(ierr);
25416bf464f9SBarry Smith   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
25420b039ecaSBarry Smith   ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr);
25430b039ecaSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
2544d763cef2SBarry Smith   PetscFunctionReturn(0);
2545d763cef2SBarry Smith }
2546d763cef2SBarry Smith 
25474a2ae208SSatish Balay #undef __FUNCT__
25484a2ae208SSatish Balay #define __FUNCT__ "TSGetTime"
2549d763cef2SBarry Smith /*@
2550b8123daeSJed Brown    TSGetTime - Gets the time of the most recently completed step.
2551d763cef2SBarry Smith 
2552d763cef2SBarry Smith    Not Collective
2553d763cef2SBarry Smith 
2554d763cef2SBarry Smith    Input Parameter:
2555d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2556d763cef2SBarry Smith 
2557d763cef2SBarry Smith    Output Parameter:
2558d763cef2SBarry Smith .  t  - the current time
2559d763cef2SBarry Smith 
2560d763cef2SBarry Smith    Level: beginner
2561d763cef2SBarry Smith 
2562b8123daeSJed Brown    Note:
2563b8123daeSJed Brown    When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(),
2564b8123daeSJed Brown    TSSetPreStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated.
2565b8123daeSJed Brown 
2566d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
2567d763cef2SBarry Smith 
2568d763cef2SBarry Smith .keywords: TS, get, time
2569d763cef2SBarry Smith @*/
25707087cfbeSBarry Smith PetscErrorCode  TSGetTime(TS ts,PetscReal* t)
2571d763cef2SBarry Smith {
2572d763cef2SBarry Smith   PetscFunctionBegin;
25730700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2574f7cf8827SBarry Smith   PetscValidRealPointer(t,2);
2575d763cef2SBarry Smith   *t = ts->ptime;
2576d763cef2SBarry Smith   PetscFunctionReturn(0);
2577d763cef2SBarry Smith }
2578d763cef2SBarry Smith 
25794a2ae208SSatish Balay #undef __FUNCT__
25806a4d4014SLisandro Dalcin #define __FUNCT__ "TSSetTime"
25816a4d4014SLisandro Dalcin /*@
25826a4d4014SLisandro Dalcin    TSSetTime - Allows one to reset the time.
25836a4d4014SLisandro Dalcin 
25843f9fe445SBarry Smith    Logically Collective on TS
25856a4d4014SLisandro Dalcin 
25866a4d4014SLisandro Dalcin    Input Parameters:
25876a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
25886a4d4014SLisandro Dalcin -  time - the time
25896a4d4014SLisandro Dalcin 
25906a4d4014SLisandro Dalcin    Level: intermediate
25916a4d4014SLisandro Dalcin 
25926a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration()
25936a4d4014SLisandro Dalcin 
25946a4d4014SLisandro Dalcin .keywords: TS, set, time
25956a4d4014SLisandro Dalcin @*/
25967087cfbeSBarry Smith PetscErrorCode  TSSetTime(TS ts, PetscReal t)
25976a4d4014SLisandro Dalcin {
25986a4d4014SLisandro Dalcin   PetscFunctionBegin;
25990700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2600c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,t,2);
26016a4d4014SLisandro Dalcin   ts->ptime = t;
26026a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
26036a4d4014SLisandro Dalcin }
26046a4d4014SLisandro Dalcin 
26056a4d4014SLisandro Dalcin #undef __FUNCT__
26064a2ae208SSatish Balay #define __FUNCT__ "TSSetOptionsPrefix"
2607d763cef2SBarry Smith /*@C
2608d763cef2SBarry Smith    TSSetOptionsPrefix - Sets the prefix used for searching for all
2609d763cef2SBarry Smith    TS options in the database.
2610d763cef2SBarry Smith 
26113f9fe445SBarry Smith    Logically Collective on TS
2612d763cef2SBarry Smith 
2613d763cef2SBarry Smith    Input Parameter:
2614d763cef2SBarry Smith +  ts     - The TS context
2615d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
2616d763cef2SBarry Smith 
2617d763cef2SBarry Smith    Notes:
2618d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
2619d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
2620d763cef2SBarry Smith    hyphen.
2621d763cef2SBarry Smith 
2622d763cef2SBarry Smith    Level: advanced
2623d763cef2SBarry Smith 
2624d763cef2SBarry Smith .keywords: TS, set, options, prefix, database
2625d763cef2SBarry Smith 
2626d763cef2SBarry Smith .seealso: TSSetFromOptions()
2627d763cef2SBarry Smith 
2628d763cef2SBarry Smith @*/
26297087cfbeSBarry Smith PetscErrorCode  TSSetOptionsPrefix(TS ts,const char prefix[])
2630d763cef2SBarry Smith {
2631dfbe8321SBarry Smith   PetscErrorCode ierr;
2632089b2837SJed Brown   SNES           snes;
2633d763cef2SBarry Smith 
2634d763cef2SBarry Smith   PetscFunctionBegin;
26350700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2636d763cef2SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
2637089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2638089b2837SJed Brown   ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr);
2639d763cef2SBarry Smith   PetscFunctionReturn(0);
2640d763cef2SBarry Smith }
2641d763cef2SBarry Smith 
2642d763cef2SBarry Smith 
26434a2ae208SSatish Balay #undef __FUNCT__
26444a2ae208SSatish Balay #define __FUNCT__ "TSAppendOptionsPrefix"
2645d763cef2SBarry Smith /*@C
2646d763cef2SBarry Smith    TSAppendOptionsPrefix - Appends to the prefix used for searching for all
2647d763cef2SBarry Smith    TS options in the database.
2648d763cef2SBarry Smith 
26493f9fe445SBarry Smith    Logically Collective on TS
2650d763cef2SBarry Smith 
2651d763cef2SBarry Smith    Input Parameter:
2652d763cef2SBarry Smith +  ts     - The TS context
2653d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
2654d763cef2SBarry Smith 
2655d763cef2SBarry Smith    Notes:
2656d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
2657d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
2658d763cef2SBarry Smith    hyphen.
2659d763cef2SBarry Smith 
2660d763cef2SBarry Smith    Level: advanced
2661d763cef2SBarry Smith 
2662d763cef2SBarry Smith .keywords: TS, append, options, prefix, database
2663d763cef2SBarry Smith 
2664d763cef2SBarry Smith .seealso: TSGetOptionsPrefix()
2665d763cef2SBarry Smith 
2666d763cef2SBarry Smith @*/
26677087cfbeSBarry Smith PetscErrorCode  TSAppendOptionsPrefix(TS ts,const char prefix[])
2668d763cef2SBarry Smith {
2669dfbe8321SBarry Smith   PetscErrorCode ierr;
2670089b2837SJed Brown   SNES           snes;
2671d763cef2SBarry Smith 
2672d763cef2SBarry Smith   PetscFunctionBegin;
26730700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2674d763cef2SBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
2675089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2676089b2837SJed Brown   ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr);
2677d763cef2SBarry Smith   PetscFunctionReturn(0);
2678d763cef2SBarry Smith }
2679d763cef2SBarry Smith 
26804a2ae208SSatish Balay #undef __FUNCT__
26814a2ae208SSatish Balay #define __FUNCT__ "TSGetOptionsPrefix"
2682d763cef2SBarry Smith /*@C
2683d763cef2SBarry Smith    TSGetOptionsPrefix - Sets the prefix used for searching for all
2684d763cef2SBarry Smith    TS options in the database.
2685d763cef2SBarry Smith 
2686d763cef2SBarry Smith    Not Collective
2687d763cef2SBarry Smith 
2688d763cef2SBarry Smith    Input Parameter:
2689d763cef2SBarry Smith .  ts - The TS context
2690d763cef2SBarry Smith 
2691d763cef2SBarry Smith    Output Parameter:
2692d763cef2SBarry Smith .  prefix - A pointer to the prefix string used
2693d763cef2SBarry Smith 
2694d763cef2SBarry Smith    Notes: On the fortran side, the user should pass in a string 'prifix' of
2695d763cef2SBarry Smith    sufficient length to hold the prefix.
2696d763cef2SBarry Smith 
2697d763cef2SBarry Smith    Level: intermediate
2698d763cef2SBarry Smith 
2699d763cef2SBarry Smith .keywords: TS, get, options, prefix, database
2700d763cef2SBarry Smith 
2701d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix()
2702d763cef2SBarry Smith @*/
27037087cfbeSBarry Smith PetscErrorCode  TSGetOptionsPrefix(TS ts,const char *prefix[])
2704d763cef2SBarry Smith {
2705dfbe8321SBarry Smith   PetscErrorCode ierr;
2706d763cef2SBarry Smith 
2707d763cef2SBarry Smith   PetscFunctionBegin;
27080700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
27094482741eSBarry Smith   PetscValidPointer(prefix,2);
2710d763cef2SBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
2711d763cef2SBarry Smith   PetscFunctionReturn(0);
2712d763cef2SBarry Smith }
2713d763cef2SBarry Smith 
27144a2ae208SSatish Balay #undef __FUNCT__
27154a2ae208SSatish Balay #define __FUNCT__ "TSGetRHSJacobian"
2716d763cef2SBarry Smith /*@C
2717d763cef2SBarry Smith    TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
2718d763cef2SBarry Smith 
2719d763cef2SBarry Smith    Not Collective, but parallel objects are returned if TS is parallel
2720d763cef2SBarry Smith 
2721d763cef2SBarry Smith    Input Parameter:
2722d763cef2SBarry Smith .  ts  - The TS context obtained from TSCreate()
2723d763cef2SBarry Smith 
2724d763cef2SBarry Smith    Output Parameters:
2725b5abc632SBarry Smith +  J   - The Jacobian J of F, where U_t = G(U,t)
2726d763cef2SBarry Smith .  M   - The preconditioner matrix, usually the same as J
2727089b2837SJed Brown .  func - Function to compute the Jacobian of the RHS
2728d763cef2SBarry Smith -  ctx - User-defined context for Jacobian evaluation routine
2729d763cef2SBarry Smith 
2730d763cef2SBarry Smith    Notes: You can pass in PETSC_NULL for any return argument you do not need.
2731d763cef2SBarry Smith 
2732d763cef2SBarry Smith    Level: intermediate
2733d763cef2SBarry Smith 
273426d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
2735d763cef2SBarry Smith 
2736d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian
2737d763cef2SBarry Smith @*/
2738089b2837SJed Brown PetscErrorCode  TSGetRHSJacobian(TS ts,Mat *J,Mat *M,TSRHSJacobian *func,void **ctx)
2739d763cef2SBarry Smith {
2740089b2837SJed Brown   PetscErrorCode ierr;
2741089b2837SJed Brown   SNES           snes;
274224989b8cSPeter Brune   DM             dm;
2743089b2837SJed Brown 
2744d763cef2SBarry Smith   PetscFunctionBegin;
2745089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2746089b2837SJed Brown   ierr = SNESGetJacobian(snes,J,M,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
274724989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
274824989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr);
2749d763cef2SBarry Smith   PetscFunctionReturn(0);
2750d763cef2SBarry Smith }
2751d763cef2SBarry Smith 
27521713a123SBarry Smith #undef __FUNCT__
27532eca1d9cSJed Brown #define __FUNCT__ "TSGetIJacobian"
27542eca1d9cSJed Brown /*@C
27552eca1d9cSJed Brown    TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
27562eca1d9cSJed Brown 
27572eca1d9cSJed Brown    Not Collective, but parallel objects are returned if TS is parallel
27582eca1d9cSJed Brown 
27592eca1d9cSJed Brown    Input Parameter:
27602eca1d9cSJed Brown .  ts  - The TS context obtained from TSCreate()
27612eca1d9cSJed Brown 
27622eca1d9cSJed Brown    Output Parameters:
27632eca1d9cSJed Brown +  A   - The Jacobian of F(t,U,U_t)
27642eca1d9cSJed Brown .  B   - The preconditioner matrix, often the same as A
27652eca1d9cSJed Brown .  f   - The function to compute the matrices
27662eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine
27672eca1d9cSJed Brown 
27682eca1d9cSJed Brown    Notes: You can pass in PETSC_NULL for any return argument you do not need.
27692eca1d9cSJed Brown 
27702eca1d9cSJed Brown    Level: advanced
27712eca1d9cSJed Brown 
27722eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
27732eca1d9cSJed Brown 
27742eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian
27752eca1d9cSJed Brown @*/
27767087cfbeSBarry Smith PetscErrorCode  TSGetIJacobian(TS ts,Mat *A,Mat *B,TSIJacobian *f,void **ctx)
27772eca1d9cSJed Brown {
2778089b2837SJed Brown   PetscErrorCode ierr;
2779089b2837SJed Brown   SNES           snes;
278024989b8cSPeter Brune   DM             dm;
27810910c330SBarry Smith 
27822eca1d9cSJed Brown   PetscFunctionBegin;
2783089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2784f7d39f7aSBarry Smith   ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
2785089b2837SJed Brown   ierr = SNESGetJacobian(snes,A,B,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
278624989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
278724989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr);
27882eca1d9cSJed Brown   PetscFunctionReturn(0);
27892eca1d9cSJed Brown }
27902eca1d9cSJed Brown 
279183a4ac43SBarry Smith struct _n_TSMonitorDrawCtx {
27926083293cSBarry Smith   PetscViewer viewer;
27936083293cSBarry Smith   Vec         initialsolution;
27946083293cSBarry Smith   PetscBool   showinitial;
279583a4ac43SBarry Smith   PetscInt    howoften;  /* when > 0 uses step % howoften, when negative only final solution plotted */
279683a4ac43SBarry Smith };
27976083293cSBarry Smith 
27982eca1d9cSJed Brown #undef __FUNCT__
279983a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawSolution"
28001713a123SBarry Smith /*@C
280183a4ac43SBarry Smith    TSMonitorDrawSolution - Monitors progress of the TS solvers by calling
28021713a123SBarry Smith    VecView() for the solution at each timestep
28031713a123SBarry Smith 
28041713a123SBarry Smith    Collective on TS
28051713a123SBarry Smith 
28061713a123SBarry Smith    Input Parameters:
28071713a123SBarry Smith +  ts - the TS context
28081713a123SBarry Smith .  step - current time-step
2809142b95e3SSatish Balay .  ptime - current time
28101713a123SBarry Smith -  dummy - either a viewer or PETSC_NULL
28111713a123SBarry Smith 
281299fdda47SBarry Smith    Options Database:
281399fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
281499fdda47SBarry Smith 
281599fdda47SBarry Smith    Notes: the initial solution and current solution are not displayed with a common axis scaling so generally the option -ts_monitor_draw_solution_initial
281699fdda47SBarry Smith        will look bad
281799fdda47SBarry Smith 
28181713a123SBarry Smith    Level: intermediate
28191713a123SBarry Smith 
28201713a123SBarry Smith .keywords: TS,  vector, monitor, view
28211713a123SBarry Smith 
2822a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
28231713a123SBarry Smith @*/
28240910c330SBarry Smith PetscErrorCode  TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
28251713a123SBarry Smith {
2826dfbe8321SBarry Smith   PetscErrorCode   ierr;
282783a4ac43SBarry Smith   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
28281713a123SBarry Smith 
28291713a123SBarry Smith   PetscFunctionBegin;
28306083293cSBarry Smith   if (!step && ictx->showinitial) {
28316083293cSBarry Smith     if (!ictx->initialsolution) {
28320910c330SBarry Smith       ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr);
28331713a123SBarry Smith     }
28340910c330SBarry Smith     ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr);
28356083293cSBarry Smith   }
28363fbbecb0SBarry Smith   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften)) && (step > -1)) || ((ictx->howoften == -1) && (step == -1)))) PetscFunctionReturn(0);
28370dcf80beSBarry Smith 
28386083293cSBarry Smith   if (ictx->showinitial) {
28396083293cSBarry Smith     PetscReal pause;
28406083293cSBarry Smith     ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr);
28416083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr);
28426083293cSBarry Smith     ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr);
28436083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr);
28446083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr);
28456083293cSBarry Smith   }
28460910c330SBarry Smith   ierr = VecView(u,ictx->viewer);CHKERRQ(ierr);
28476083293cSBarry Smith   if (ictx->showinitial) {
28486083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr);
28496083293cSBarry Smith   }
28501713a123SBarry Smith   PetscFunctionReturn(0);
28511713a123SBarry Smith }
28521713a123SBarry Smith 
28531713a123SBarry Smith 
28546c699258SBarry Smith #undef __FUNCT__
285583a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxDestroy"
28566083293cSBarry Smith /*@C
285783a4ac43SBarry Smith    TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution()
28586083293cSBarry Smith 
28596083293cSBarry Smith    Collective on TS
28606083293cSBarry Smith 
28616083293cSBarry Smith    Input Parameters:
28626083293cSBarry Smith .    ctx - the monitor context
28636083293cSBarry Smith 
28646083293cSBarry Smith    Level: intermediate
28656083293cSBarry Smith 
28666083293cSBarry Smith .keywords: TS,  vector, monitor, view
28676083293cSBarry Smith 
286883a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError()
28696083293cSBarry Smith @*/
287083a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx)
28716083293cSBarry Smith {
28726083293cSBarry Smith   PetscErrorCode       ierr;
28736083293cSBarry Smith 
28746083293cSBarry Smith   PetscFunctionBegin;
287583a4ac43SBarry Smith   ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr);
287683a4ac43SBarry Smith   ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr);
287783a4ac43SBarry Smith   ierr = PetscFree(*ictx);CHKERRQ(ierr);
28786083293cSBarry Smith   PetscFunctionReturn(0);
28796083293cSBarry Smith }
28806083293cSBarry Smith 
28816083293cSBarry Smith #undef __FUNCT__
288283a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxCreate"
28836083293cSBarry Smith /*@C
288483a4ac43SBarry Smith    TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx
28856083293cSBarry Smith 
28866083293cSBarry Smith    Collective on TS
28876083293cSBarry Smith 
28886083293cSBarry Smith    Input Parameter:
28896083293cSBarry Smith .    ts - time-step context
28906083293cSBarry Smith 
28916083293cSBarry Smith    Output Patameter:
28926083293cSBarry Smith .    ctx - the monitor context
28936083293cSBarry Smith 
289499fdda47SBarry Smith    Options Database:
289599fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
289699fdda47SBarry Smith 
28976083293cSBarry Smith    Level: intermediate
28986083293cSBarry Smith 
28996083293cSBarry Smith .keywords: TS,  vector, monitor, view
29006083293cSBarry Smith 
290183a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx()
29026083293cSBarry Smith @*/
290383a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx)
29046083293cSBarry Smith {
29056083293cSBarry Smith   PetscErrorCode   ierr;
29066083293cSBarry Smith 
29076083293cSBarry Smith   PetscFunctionBegin;
290883a4ac43SBarry Smith   ierr = PetscNew(struct _n_TSMonitorDrawCtx,ctx);CHKERRQ(ierr);
290983a4ac43SBarry Smith   ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr);
291083a4ac43SBarry Smith   (*ctx)->showinitial = PETSC_FALSE;
291183a4ac43SBarry Smith   (*ctx)->howoften    = howoften;
291299fdda47SBarry Smith   ierr = PetscOptionsGetBool(PETSC_NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,PETSC_NULL);CHKERRQ(ierr);
29136083293cSBarry Smith   PetscFunctionReturn(0);
29146083293cSBarry Smith }
29156083293cSBarry Smith 
29166083293cSBarry Smith #undef __FUNCT__
291783a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawError"
29183a471f94SBarry Smith /*@C
291983a4ac43SBarry Smith    TSMonitorDrawError - Monitors progress of the TS solvers by calling
29203a471f94SBarry Smith    VecView() for the error at each timestep
29213a471f94SBarry Smith 
29223a471f94SBarry Smith    Collective on TS
29233a471f94SBarry Smith 
29243a471f94SBarry Smith    Input Parameters:
29253a471f94SBarry Smith +  ts - the TS context
29263a471f94SBarry Smith .  step - current time-step
29273a471f94SBarry Smith .  ptime - current time
29283a471f94SBarry Smith -  dummy - either a viewer or PETSC_NULL
29293a471f94SBarry Smith 
29303a471f94SBarry Smith    Level: intermediate
29313a471f94SBarry Smith 
29323a471f94SBarry Smith .keywords: TS,  vector, monitor, view
29333a471f94SBarry Smith 
29343a471f94SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
29353a471f94SBarry Smith @*/
29360910c330SBarry Smith PetscErrorCode  TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
29373a471f94SBarry Smith {
29383a471f94SBarry Smith   PetscErrorCode   ierr;
293983a4ac43SBarry Smith   TSMonitorDrawCtx ctx = (TSMonitorDrawCtx)dummy;
294083a4ac43SBarry Smith   PetscViewer      viewer = ctx->viewer;
29413a471f94SBarry Smith   Vec              work;
29423a471f94SBarry Smith 
29433a471f94SBarry Smith   PetscFunctionBegin;
29443fbbecb0SBarry Smith   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften)) && (step > -1)) || ((ctx->howoften == -1) && (step == -1)))) PetscFunctionReturn(0);
29450910c330SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
29463a471f94SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
29470910c330SBarry Smith   ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr);
29483a471f94SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
29493a471f94SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
29503a471f94SBarry Smith   PetscFunctionReturn(0);
29513a471f94SBarry Smith }
29523a471f94SBarry Smith 
29532a34c10cSBarry Smith #include <petsc-private/dmimpl.h>
29543a471f94SBarry Smith #undef __FUNCT__
29556c699258SBarry Smith #define __FUNCT__ "TSSetDM"
29566c699258SBarry Smith /*@
29576c699258SBarry Smith    TSSetDM - Sets the DM that may be used by some preconditioners
29586c699258SBarry Smith 
29593f9fe445SBarry Smith    Logically Collective on TS and DM
29606c699258SBarry Smith 
29616c699258SBarry Smith    Input Parameters:
29626c699258SBarry Smith +  ts - the preconditioner context
29636c699258SBarry Smith -  dm - the dm
29646c699258SBarry Smith 
29656c699258SBarry Smith    Level: intermediate
29666c699258SBarry Smith 
29676c699258SBarry Smith 
29686c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
29696c699258SBarry Smith @*/
29707087cfbeSBarry Smith PetscErrorCode  TSSetDM(TS ts,DM dm)
29716c699258SBarry Smith {
29726c699258SBarry Smith   PetscErrorCode ierr;
2973089b2837SJed Brown   SNES           snes;
2974942e3340SBarry Smith   DMTS           tsdm;
29756c699258SBarry Smith 
29766c699258SBarry Smith   PetscFunctionBegin;
29770700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
297870663e4aSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);
2979942e3340SBarry Smith   if (ts->dm) {               /* Move the DMTS context over to the new DM unless the new DM already has one */
29802a34c10cSBarry Smith     if (ts->dm->dmts && !dm->dmts) {
2981942e3340SBarry Smith       ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr);
2982942e3340SBarry Smith       ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr);
298324989b8cSPeter Brune       if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */
298424989b8cSPeter Brune         tsdm->originaldm = dm;
298524989b8cSPeter Brune       }
298624989b8cSPeter Brune     }
29876bf464f9SBarry Smith     ierr = DMDestroy(&ts->dm);CHKERRQ(ierr);
298824989b8cSPeter Brune   }
29896c699258SBarry Smith   ts->dm = dm;
2990089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2991089b2837SJed Brown   ierr = SNESSetDM(snes,dm);CHKERRQ(ierr);
29926c699258SBarry Smith   PetscFunctionReturn(0);
29936c699258SBarry Smith }
29946c699258SBarry Smith 
29956c699258SBarry Smith #undef __FUNCT__
29966c699258SBarry Smith #define __FUNCT__ "TSGetDM"
29976c699258SBarry Smith /*@
29986c699258SBarry Smith    TSGetDM - Gets the DM that may be used by some preconditioners
29996c699258SBarry Smith 
30003f9fe445SBarry Smith    Not Collective
30016c699258SBarry Smith 
30026c699258SBarry Smith    Input Parameter:
30036c699258SBarry Smith . ts - the preconditioner context
30046c699258SBarry Smith 
30056c699258SBarry Smith    Output Parameter:
30066c699258SBarry Smith .  dm - the dm
30076c699258SBarry Smith 
30086c699258SBarry Smith    Level: intermediate
30096c699258SBarry Smith 
30106c699258SBarry Smith 
30116c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
30126c699258SBarry Smith @*/
30137087cfbeSBarry Smith PetscErrorCode  TSGetDM(TS ts,DM *dm)
30146c699258SBarry Smith {
3015496e6a7aSJed Brown   PetscErrorCode ierr;
3016496e6a7aSJed Brown 
30176c699258SBarry Smith   PetscFunctionBegin;
30180700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3019496e6a7aSJed Brown   if (!ts->dm) {
3020496e6a7aSJed Brown     ierr = DMShellCreate(((PetscObject)ts)->comm,&ts->dm);CHKERRQ(ierr);
3021496e6a7aSJed Brown     if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
3022496e6a7aSJed Brown   }
30236c699258SBarry Smith   *dm = ts->dm;
30246c699258SBarry Smith   PetscFunctionReturn(0);
30256c699258SBarry Smith }
30261713a123SBarry Smith 
30270f5c6efeSJed Brown #undef __FUNCT__
30280f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormFunction"
30290f5c6efeSJed Brown /*@
30300f5c6efeSJed Brown    SNESTSFormFunction - Function to evaluate nonlinear residual
30310f5c6efeSJed Brown 
30323f9fe445SBarry Smith    Logically Collective on SNES
30330f5c6efeSJed Brown 
30340f5c6efeSJed Brown    Input Parameter:
3035d42a1c89SJed Brown + snes - nonlinear solver
30360910c330SBarry Smith . U - the current state at which to evaluate the residual
3037d42a1c89SJed Brown - ctx - user context, must be a TS
30380f5c6efeSJed Brown 
30390f5c6efeSJed Brown    Output Parameter:
30400f5c6efeSJed Brown . F - the nonlinear residual
30410f5c6efeSJed Brown 
30420f5c6efeSJed Brown    Notes:
30430f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
30440f5c6efeSJed Brown    It is most frequently passed to MatFDColoringSetFunction().
30450f5c6efeSJed Brown 
30460f5c6efeSJed Brown    Level: advanced
30470f5c6efeSJed Brown 
30480f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction()
30490f5c6efeSJed Brown @*/
30500910c330SBarry Smith PetscErrorCode  SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx)
30510f5c6efeSJed Brown {
30520f5c6efeSJed Brown   TS             ts = (TS)ctx;
30530f5c6efeSJed Brown   PetscErrorCode ierr;
30540f5c6efeSJed Brown 
30550f5c6efeSJed Brown   PetscFunctionBegin;
30560f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
30570910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
30580f5c6efeSJed Brown   PetscValidHeaderSpecific(F,VEC_CLASSID,3);
30590f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,4);
30600910c330SBarry Smith   ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr);
30610f5c6efeSJed Brown   PetscFunctionReturn(0);
30620f5c6efeSJed Brown }
30630f5c6efeSJed Brown 
30640f5c6efeSJed Brown #undef __FUNCT__
30650f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormJacobian"
30660f5c6efeSJed Brown /*@
30670f5c6efeSJed Brown    SNESTSFormJacobian - Function to evaluate the Jacobian
30680f5c6efeSJed Brown 
30690f5c6efeSJed Brown    Collective on SNES
30700f5c6efeSJed Brown 
30710f5c6efeSJed Brown    Input Parameter:
30720f5c6efeSJed Brown + snes - nonlinear solver
30730910c330SBarry Smith . U - the current state at which to evaluate the residual
30740f5c6efeSJed Brown - ctx - user context, must be a TS
30750f5c6efeSJed Brown 
30760f5c6efeSJed Brown    Output Parameter:
30770f5c6efeSJed Brown + A - the Jacobian
30780f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A)
30790f5c6efeSJed Brown - flag - indicates any structure change in the matrix
30800f5c6efeSJed Brown 
30810f5c6efeSJed Brown    Notes:
30820f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
30830f5c6efeSJed Brown 
30840f5c6efeSJed Brown    Level: developer
30850f5c6efeSJed Brown 
30860f5c6efeSJed Brown .seealso: SNESSetJacobian()
30870f5c6efeSJed Brown @*/
30880910c330SBarry Smith PetscErrorCode  SNESTSFormJacobian(SNES snes,Vec U,Mat *A,Mat *B,MatStructure *flag,void *ctx)
30890f5c6efeSJed Brown {
30900f5c6efeSJed Brown   TS             ts = (TS)ctx;
30910f5c6efeSJed Brown   PetscErrorCode ierr;
30920f5c6efeSJed Brown 
30930f5c6efeSJed Brown   PetscFunctionBegin;
30940f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
30950910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
30960f5c6efeSJed Brown   PetscValidPointer(A,3);
30970f5c6efeSJed Brown   PetscValidHeaderSpecific(*A,MAT_CLASSID,3);
30980f5c6efeSJed Brown   PetscValidPointer(B,4);
30990f5c6efeSJed Brown   PetscValidHeaderSpecific(*B,MAT_CLASSID,4);
31000f5c6efeSJed Brown   PetscValidPointer(flag,5);
31010f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,6);
31020910c330SBarry Smith   ierr = (ts->ops->snesjacobian)(snes,U,A,B,flag,ts);CHKERRQ(ierr);
31030f5c6efeSJed Brown   PetscFunctionReturn(0);
31040f5c6efeSJed Brown }
3105325fc9f4SBarry Smith 
31060e4ef248SJed Brown #undef __FUNCT__
31070e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSFunctionLinear"
31080e4ef248SJed Brown /*@C
31090e4ef248SJed Brown    TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems only
31100e4ef248SJed Brown 
31110e4ef248SJed Brown    Collective on TS
31120e4ef248SJed Brown 
31130e4ef248SJed Brown    Input Arguments:
31140e4ef248SJed Brown +  ts - time stepping context
31150e4ef248SJed Brown .  t - time at which to evaluate
31160910c330SBarry Smith .  U - state at which to evaluate
31170e4ef248SJed Brown -  ctx - context
31180e4ef248SJed Brown 
31190e4ef248SJed Brown    Output Arguments:
31200e4ef248SJed Brown .  F - right hand side
31210e4ef248SJed Brown 
31220e4ef248SJed Brown    Level: intermediate
31230e4ef248SJed Brown 
31240e4ef248SJed Brown    Notes:
31250e4ef248SJed Brown    This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
31260e4ef248SJed Brown    The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
31270e4ef248SJed Brown 
31280e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
31290e4ef248SJed Brown @*/
31300910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx)
31310e4ef248SJed Brown {
31320e4ef248SJed Brown   PetscErrorCode ierr;
31330e4ef248SJed Brown   Mat            Arhs,Brhs;
31340e4ef248SJed Brown   MatStructure   flg2;
31350e4ef248SJed Brown 
31360e4ef248SJed Brown   PetscFunctionBegin;
31370e4ef248SJed Brown   ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
31380910c330SBarry Smith   ierr = TSComputeRHSJacobian(ts,t,U,&Arhs,&Brhs,&flg2);CHKERRQ(ierr);
31390910c330SBarry Smith   ierr = MatMult(Arhs,U,F);CHKERRQ(ierr);
31400e4ef248SJed Brown   PetscFunctionReturn(0);
31410e4ef248SJed Brown }
31420e4ef248SJed Brown 
31430e4ef248SJed Brown #undef __FUNCT__
31440e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSJacobianConstant"
31450e4ef248SJed Brown /*@C
31460e4ef248SJed Brown    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
31470e4ef248SJed Brown 
31480e4ef248SJed Brown    Collective on TS
31490e4ef248SJed Brown 
31500e4ef248SJed Brown    Input Arguments:
31510e4ef248SJed Brown +  ts - time stepping context
31520e4ef248SJed Brown .  t - time at which to evaluate
31530910c330SBarry Smith .  U - state at which to evaluate
31540e4ef248SJed Brown -  ctx - context
31550e4ef248SJed Brown 
31560e4ef248SJed Brown    Output Arguments:
31570e4ef248SJed Brown +  A - pointer to operator
31580e4ef248SJed Brown .  B - pointer to preconditioning matrix
31590e4ef248SJed Brown -  flg - matrix structure flag
31600e4ef248SJed Brown 
31610e4ef248SJed Brown    Level: intermediate
31620e4ef248SJed Brown 
31630e4ef248SJed Brown    Notes:
31640e4ef248SJed Brown    This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
31650e4ef248SJed Brown 
31660e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
31670e4ef248SJed Brown @*/
31680910c330SBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat *A,Mat *B,MatStructure *flg,void *ctx)
31690e4ef248SJed Brown {
31700e4ef248SJed Brown   PetscFunctionBegin;
31710e4ef248SJed Brown   *flg = SAME_PRECONDITIONER;
31720e4ef248SJed Brown   PetscFunctionReturn(0);
31730e4ef248SJed Brown }
31740e4ef248SJed Brown 
31750026cea9SSean Farley #undef __FUNCT__
31760026cea9SSean Farley #define __FUNCT__ "TSComputeIFunctionLinear"
31770026cea9SSean Farley /*@C
31780026cea9SSean Farley    TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
31790026cea9SSean Farley 
31800026cea9SSean Farley    Collective on TS
31810026cea9SSean Farley 
31820026cea9SSean Farley    Input Arguments:
31830026cea9SSean Farley +  ts - time stepping context
31840026cea9SSean Farley .  t - time at which to evaluate
31850910c330SBarry Smith .  U - state at which to evaluate
31860910c330SBarry Smith .  Udot - time derivative of state vector
31870026cea9SSean Farley -  ctx - context
31880026cea9SSean Farley 
31890026cea9SSean Farley    Output Arguments:
31900026cea9SSean Farley .  F - left hand side
31910026cea9SSean Farley 
31920026cea9SSean Farley    Level: intermediate
31930026cea9SSean Farley 
31940026cea9SSean Farley    Notes:
31950910c330SBarry Smith    The assumption here is that the left hand side is of the form A*Udot (and not A*Udot + B*U). For other cases, the
31960026cea9SSean Farley    user is required to write their own TSComputeIFunction.
31970026cea9SSean Farley    This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
31980026cea9SSean Farley    The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
31990026cea9SSean Farley 
32000026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant()
32010026cea9SSean Farley @*/
32020910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx)
32030026cea9SSean Farley {
32040026cea9SSean Farley   PetscErrorCode ierr;
32050026cea9SSean Farley   Mat            A,B;
32060026cea9SSean Farley   MatStructure   flg2;
32070026cea9SSean Farley 
32080026cea9SSean Farley   PetscFunctionBegin;
32090026cea9SSean Farley   ierr = TSGetIJacobian(ts,&A,&B,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
32100910c330SBarry Smith   ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,&A,&B,&flg2,PETSC_TRUE);CHKERRQ(ierr);
32110910c330SBarry Smith   ierr = MatMult(A,Udot,F);CHKERRQ(ierr);
32120026cea9SSean Farley   PetscFunctionReturn(0);
32130026cea9SSean Farley }
32140026cea9SSean Farley 
32150026cea9SSean Farley #undef __FUNCT__
32160026cea9SSean Farley #define __FUNCT__ "TSComputeIJacobianConstant"
32170026cea9SSean Farley /*@C
321824e94211SJed Brown    TSComputeIJacobianConstant - Reuses a Jacobian that is time-independent.
32190026cea9SSean Farley 
32200026cea9SSean Farley    Collective on TS
32210026cea9SSean Farley 
32220026cea9SSean Farley    Input Arguments:
32230026cea9SSean Farley +  ts - time stepping context
32240026cea9SSean Farley .  t - time at which to evaluate
32250910c330SBarry Smith .  U - state at which to evaluate
32260910c330SBarry Smith .  Udot - time derivative of state vector
32270026cea9SSean Farley .  shift - shift to apply
32280026cea9SSean Farley -  ctx - context
32290026cea9SSean Farley 
32300026cea9SSean Farley    Output Arguments:
32310026cea9SSean Farley +  A - pointer to operator
32320026cea9SSean Farley .  B - pointer to preconditioning matrix
32330026cea9SSean Farley -  flg - matrix structure flag
32340026cea9SSean Farley 
32350026cea9SSean Farley    Level: intermediate
32360026cea9SSean Farley 
32370026cea9SSean Farley    Notes:
32380026cea9SSean Farley    This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
32390026cea9SSean Farley 
32400026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
32410026cea9SSean Farley @*/
32420910c330SBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat *A,Mat *B,MatStructure *flg,void *ctx)
32430026cea9SSean Farley {
32440026cea9SSean Farley   PetscFunctionBegin;
32450026cea9SSean Farley   *flg = SAME_PRECONDITIONER;
32460026cea9SSean Farley   PetscFunctionReturn(0);
32470026cea9SSean Farley }
32480026cea9SSean Farley 
32494af1b03aSJed Brown #undef __FUNCT__
32504af1b03aSJed Brown #define __FUNCT__ "TSGetConvergedReason"
32514af1b03aSJed Brown /*@
32524af1b03aSJed Brown    TSGetConvergedReason - Gets the reason the TS iteration was stopped.
32534af1b03aSJed Brown 
32544af1b03aSJed Brown    Not Collective
32554af1b03aSJed Brown 
32564af1b03aSJed Brown    Input Parameter:
32574af1b03aSJed Brown .  ts - the TS context
32584af1b03aSJed Brown 
32594af1b03aSJed Brown    Output Parameter:
32604af1b03aSJed Brown .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
32614af1b03aSJed Brown             manual pages for the individual convergence tests for complete lists
32624af1b03aSJed Brown 
3263487e0bb9SJed Brown    Level: beginner
32644af1b03aSJed Brown 
3265cd652676SJed Brown    Notes:
3266cd652676SJed Brown    Can only be called after the call to TSSolve() is complete.
32674af1b03aSJed Brown 
32684af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test
32694af1b03aSJed Brown 
32704af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason
32714af1b03aSJed Brown @*/
32724af1b03aSJed Brown PetscErrorCode  TSGetConvergedReason(TS ts,TSConvergedReason *reason)
32734af1b03aSJed Brown {
32744af1b03aSJed Brown   PetscFunctionBegin;
32754af1b03aSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
32764af1b03aSJed Brown   PetscValidPointer(reason,2);
32774af1b03aSJed Brown   *reason = ts->reason;
32784af1b03aSJed Brown   PetscFunctionReturn(0);
32794af1b03aSJed Brown }
32804af1b03aSJed Brown 
3281fb1732b5SBarry Smith #undef __FUNCT__
3282cc708dedSBarry Smith #define __FUNCT__ "TSGetSolveTime"
3283cc708dedSBarry Smith /*@
3284cc708dedSBarry Smith    TSGetSolveTime - Gets the time after a call to TSSolve()
3285cc708dedSBarry Smith 
3286cc708dedSBarry Smith    Not Collective
3287cc708dedSBarry Smith 
3288cc708dedSBarry Smith    Input Parameter:
3289cc708dedSBarry Smith .  ts - the TS context
3290cc708dedSBarry Smith 
3291cc708dedSBarry Smith    Output Parameter:
3292cc708dedSBarry Smith .  ftime - the final time. This time should correspond to the final time set with TSSetDuration()
3293cc708dedSBarry Smith 
3294487e0bb9SJed Brown    Level: beginner
3295cc708dedSBarry Smith 
3296cc708dedSBarry Smith    Notes:
3297cc708dedSBarry Smith    Can only be called after the call to TSSolve() is complete.
3298cc708dedSBarry Smith 
3299cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test
3300cc708dedSBarry Smith 
3301cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
3302cc708dedSBarry Smith @*/
3303cc708dedSBarry Smith PetscErrorCode  TSGetSolveTime(TS ts,PetscReal *ftime)
3304cc708dedSBarry Smith {
3305cc708dedSBarry Smith   PetscFunctionBegin;
3306cc708dedSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3307cc708dedSBarry Smith   PetscValidPointer(ftime,2);
3308cc708dedSBarry Smith   *ftime = ts->solvetime;
3309cc708dedSBarry Smith   PetscFunctionReturn(0);
3310cc708dedSBarry Smith }
3311cc708dedSBarry Smith 
3312cc708dedSBarry Smith #undef __FUNCT__
33135ef26d82SJed Brown #define __FUNCT__ "TSGetSNESIterations"
33149f67acb7SJed Brown /*@
33155ef26d82SJed Brown    TSGetSNESIterations - Gets the total number of nonlinear iterations
33169f67acb7SJed Brown    used by the time integrator.
33179f67acb7SJed Brown 
33189f67acb7SJed Brown    Not Collective
33199f67acb7SJed Brown 
33209f67acb7SJed Brown    Input Parameter:
33219f67acb7SJed Brown .  ts - TS context
33229f67acb7SJed Brown 
33239f67acb7SJed Brown    Output Parameter:
33249f67acb7SJed Brown .  nits - number of nonlinear iterations
33259f67acb7SJed Brown 
33269f67acb7SJed Brown    Notes:
33279f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
33289f67acb7SJed Brown 
33299f67acb7SJed Brown    Level: intermediate
33309f67acb7SJed Brown 
33319f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations
33329f67acb7SJed Brown 
33335ef26d82SJed Brown .seealso:  TSGetKSPIterations()
33349f67acb7SJed Brown @*/
33355ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits)
33369f67acb7SJed Brown {
33379f67acb7SJed Brown   PetscFunctionBegin;
33389f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
33399f67acb7SJed Brown   PetscValidIntPointer(nits,2);
33405ef26d82SJed Brown   *nits = ts->snes_its;
33419f67acb7SJed Brown   PetscFunctionReturn(0);
33429f67acb7SJed Brown }
33439f67acb7SJed Brown 
33449f67acb7SJed Brown #undef __FUNCT__
33455ef26d82SJed Brown #define __FUNCT__ "TSGetKSPIterations"
33469f67acb7SJed Brown /*@
33475ef26d82SJed Brown    TSGetKSPIterations - Gets the total number of linear iterations
33489f67acb7SJed Brown    used by the time integrator.
33499f67acb7SJed Brown 
33509f67acb7SJed Brown    Not Collective
33519f67acb7SJed Brown 
33529f67acb7SJed Brown    Input Parameter:
33539f67acb7SJed Brown .  ts - TS context
33549f67acb7SJed Brown 
33559f67acb7SJed Brown    Output Parameter:
33569f67acb7SJed Brown .  lits - number of linear iterations
33579f67acb7SJed Brown 
33589f67acb7SJed Brown    Notes:
33599f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
33609f67acb7SJed Brown 
33619f67acb7SJed Brown    Level: intermediate
33629f67acb7SJed Brown 
33639f67acb7SJed Brown .keywords: TS, get, number, linear, iterations
33649f67acb7SJed Brown 
33655ef26d82SJed Brown .seealso:  TSGetSNESIterations(), SNESGetKSPIterations()
33669f67acb7SJed Brown @*/
33675ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits)
33689f67acb7SJed Brown {
33699f67acb7SJed Brown   PetscFunctionBegin;
33709f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
33719f67acb7SJed Brown   PetscValidIntPointer(lits,2);
33725ef26d82SJed Brown   *lits = ts->ksp_its;
33739f67acb7SJed Brown   PetscFunctionReturn(0);
33749f67acb7SJed Brown }
33759f67acb7SJed Brown 
33769f67acb7SJed Brown #undef __FUNCT__
3377cef5090cSJed Brown #define __FUNCT__ "TSGetStepRejections"
3378cef5090cSJed Brown /*@
3379cef5090cSJed Brown    TSGetStepRejections - Gets the total number of rejected steps.
3380cef5090cSJed Brown 
3381cef5090cSJed Brown    Not Collective
3382cef5090cSJed Brown 
3383cef5090cSJed Brown    Input Parameter:
3384cef5090cSJed Brown .  ts - TS context
3385cef5090cSJed Brown 
3386cef5090cSJed Brown    Output Parameter:
3387cef5090cSJed Brown .  rejects - number of steps rejected
3388cef5090cSJed Brown 
3389cef5090cSJed Brown    Notes:
3390cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
3391cef5090cSJed Brown 
3392cef5090cSJed Brown    Level: intermediate
3393cef5090cSJed Brown 
3394cef5090cSJed Brown .keywords: TS, get, number
3395cef5090cSJed Brown 
33965ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails()
3397cef5090cSJed Brown @*/
3398cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects)
3399cef5090cSJed Brown {
3400cef5090cSJed Brown   PetscFunctionBegin;
3401cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3402cef5090cSJed Brown   PetscValidIntPointer(rejects,2);
3403cef5090cSJed Brown   *rejects = ts->reject;
3404cef5090cSJed Brown   PetscFunctionReturn(0);
3405cef5090cSJed Brown }
3406cef5090cSJed Brown 
3407cef5090cSJed Brown #undef __FUNCT__
3408cef5090cSJed Brown #define __FUNCT__ "TSGetSNESFailures"
3409cef5090cSJed Brown /*@
3410cef5090cSJed Brown    TSGetSNESFailures - Gets the total number of failed SNES solves
3411cef5090cSJed Brown 
3412cef5090cSJed Brown    Not Collective
3413cef5090cSJed Brown 
3414cef5090cSJed Brown    Input Parameter:
3415cef5090cSJed Brown .  ts - TS context
3416cef5090cSJed Brown 
3417cef5090cSJed Brown    Output Parameter:
3418cef5090cSJed Brown .  fails - number of failed nonlinear solves
3419cef5090cSJed Brown 
3420cef5090cSJed Brown    Notes:
3421cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
3422cef5090cSJed Brown 
3423cef5090cSJed Brown    Level: intermediate
3424cef5090cSJed Brown 
3425cef5090cSJed Brown .keywords: TS, get, number
3426cef5090cSJed Brown 
34275ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures()
3428cef5090cSJed Brown @*/
3429cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails)
3430cef5090cSJed Brown {
3431cef5090cSJed Brown   PetscFunctionBegin;
3432cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3433cef5090cSJed Brown   PetscValidIntPointer(fails,2);
3434cef5090cSJed Brown   *fails = ts->num_snes_failures;
3435cef5090cSJed Brown   PetscFunctionReturn(0);
3436cef5090cSJed Brown }
3437cef5090cSJed Brown 
3438cef5090cSJed Brown #undef __FUNCT__
3439cef5090cSJed Brown #define __FUNCT__ "TSSetMaxStepRejections"
3440cef5090cSJed Brown /*@
3441cef5090cSJed Brown    TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails
3442cef5090cSJed Brown 
3443cef5090cSJed Brown    Not Collective
3444cef5090cSJed Brown 
3445cef5090cSJed Brown    Input Parameter:
3446cef5090cSJed Brown +  ts - TS context
3447cef5090cSJed Brown -  rejects - maximum number of rejected steps, pass -1 for unlimited
3448cef5090cSJed Brown 
3449cef5090cSJed Brown    Notes:
3450cef5090cSJed Brown    The counter is reset to zero for each step
3451cef5090cSJed Brown 
3452cef5090cSJed Brown    Options Database Key:
3453cef5090cSJed Brown  .  -ts_max_reject - Maximum number of step rejections before a step fails
3454cef5090cSJed Brown 
3455cef5090cSJed Brown    Level: intermediate
3456cef5090cSJed Brown 
3457cef5090cSJed Brown .keywords: TS, set, maximum, number
3458cef5090cSJed Brown 
34595ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
3460cef5090cSJed Brown @*/
3461cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects)
3462cef5090cSJed Brown {
3463cef5090cSJed Brown   PetscFunctionBegin;
3464cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3465cef5090cSJed Brown   ts->max_reject = rejects;
3466cef5090cSJed Brown   PetscFunctionReturn(0);
3467cef5090cSJed Brown }
3468cef5090cSJed Brown 
3469cef5090cSJed Brown #undef __FUNCT__
3470cef5090cSJed Brown #define __FUNCT__ "TSSetMaxSNESFailures"
3471cef5090cSJed Brown /*@
3472cef5090cSJed Brown    TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves
3473cef5090cSJed Brown 
3474cef5090cSJed Brown    Not Collective
3475cef5090cSJed Brown 
3476cef5090cSJed Brown    Input Parameter:
3477cef5090cSJed Brown +  ts - TS context
3478cef5090cSJed Brown -  fails - maximum number of failed nonlinear solves, pass -1 for unlimited
3479cef5090cSJed Brown 
3480cef5090cSJed Brown    Notes:
3481cef5090cSJed Brown    The counter is reset to zero for each successive call to TSSolve().
3482cef5090cSJed Brown 
3483cef5090cSJed Brown    Options Database Key:
3484cef5090cSJed Brown  .  -ts_max_snes_failures - Maximum number of nonlinear solve failures
3485cef5090cSJed Brown 
3486cef5090cSJed Brown    Level: intermediate
3487cef5090cSJed Brown 
3488cef5090cSJed Brown .keywords: TS, set, maximum, number
3489cef5090cSJed Brown 
34905ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason()
3491cef5090cSJed Brown @*/
3492cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails)
3493cef5090cSJed Brown {
3494cef5090cSJed Brown   PetscFunctionBegin;
3495cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3496cef5090cSJed Brown   ts->max_snes_failures = fails;
3497cef5090cSJed Brown   PetscFunctionReturn(0);
3498cef5090cSJed Brown }
3499cef5090cSJed Brown 
3500cef5090cSJed Brown #undef __FUNCT__
3501cef5090cSJed Brown #define __FUNCT__ "TSSetErrorIfStepFails()"
3502cef5090cSJed Brown /*@
3503cef5090cSJed Brown    TSSetErrorIfStepFails - Error if no step succeeds
3504cef5090cSJed Brown 
3505cef5090cSJed Brown    Not Collective
3506cef5090cSJed Brown 
3507cef5090cSJed Brown    Input Parameter:
3508cef5090cSJed Brown +  ts - TS context
3509cef5090cSJed Brown -  err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure
3510cef5090cSJed Brown 
3511cef5090cSJed Brown    Options Database Key:
3512cef5090cSJed Brown  .  -ts_error_if_step_fails - Error if no step succeeds
3513cef5090cSJed Brown 
3514cef5090cSJed Brown    Level: intermediate
3515cef5090cSJed Brown 
3516cef5090cSJed Brown .keywords: TS, set, error
3517cef5090cSJed Brown 
35185ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
3519cef5090cSJed Brown @*/
3520cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err)
3521cef5090cSJed Brown {
3522cef5090cSJed Brown   PetscFunctionBegin;
3523cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3524cef5090cSJed Brown   ts->errorifstepfailed = err;
3525cef5090cSJed Brown   PetscFunctionReturn(0);
3526cef5090cSJed Brown }
3527cef5090cSJed Brown 
3528cef5090cSJed Brown #undef __FUNCT__
3529fb1732b5SBarry Smith #define __FUNCT__ "TSMonitorSolutionBinary"
3530fb1732b5SBarry Smith /*@C
3531fb1732b5SBarry Smith    TSMonitorSolutionBinary - Monitors progress of the TS solvers by VecView() for the solution at each timestep. Normally the viewer is a binary file
3532fb1732b5SBarry Smith 
3533fb1732b5SBarry Smith    Collective on TS
3534fb1732b5SBarry Smith 
3535fb1732b5SBarry Smith    Input Parameters:
3536fb1732b5SBarry Smith +  ts - the TS context
3537fb1732b5SBarry Smith .  step - current time-step
3538fb1732b5SBarry Smith .  ptime - current time
35390910c330SBarry Smith .  u - current state
3540fb1732b5SBarry Smith -  viewer - binary viewer
3541fb1732b5SBarry Smith 
3542fb1732b5SBarry Smith    Level: intermediate
3543fb1732b5SBarry Smith 
3544fb1732b5SBarry Smith .keywords: TS,  vector, monitor, view
3545fb1732b5SBarry Smith 
3546fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
3547fb1732b5SBarry Smith @*/
35480910c330SBarry Smith PetscErrorCode  TSMonitorSolutionBinary(TS ts,PetscInt step,PetscReal ptime,Vec u,void *viewer)
3549fb1732b5SBarry Smith {
3550fb1732b5SBarry Smith   PetscErrorCode ierr;
3551ed81e22dSJed Brown   PetscViewer    v = (PetscViewer)viewer;
3552fb1732b5SBarry Smith 
3553fb1732b5SBarry Smith   PetscFunctionBegin;
35540910c330SBarry Smith   ierr = VecView(u,v);CHKERRQ(ierr);
3555ed81e22dSJed Brown   PetscFunctionReturn(0);
3556ed81e22dSJed Brown }
3557ed81e22dSJed Brown 
3558ed81e22dSJed Brown #undef __FUNCT__
3559ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTK"
3560ed81e22dSJed Brown /*@C
3561ed81e22dSJed Brown    TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep.
3562ed81e22dSJed Brown 
3563ed81e22dSJed Brown    Collective on TS
3564ed81e22dSJed Brown 
3565ed81e22dSJed Brown    Input Parameters:
3566ed81e22dSJed Brown +  ts - the TS context
3567ed81e22dSJed Brown .  step - current time-step
3568ed81e22dSJed Brown .  ptime - current time
35690910c330SBarry Smith .  u - current state
3570ed81e22dSJed Brown -  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
3571ed81e22dSJed Brown 
3572ed81e22dSJed Brown    Level: intermediate
3573ed81e22dSJed Brown 
3574ed81e22dSJed Brown    Notes:
3575ed81e22dSJed Brown    The VTK format does not allow writing multiple time steps in the same file, therefore a different file will be written for each time step.
3576ed81e22dSJed Brown    These are named according to the file name template.
3577ed81e22dSJed Brown 
3578ed81e22dSJed Brown    This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy().
3579ed81e22dSJed Brown 
3580ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
3581ed81e22dSJed Brown 
3582ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
3583ed81e22dSJed Brown @*/
35840910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate)
3585ed81e22dSJed Brown {
3586ed81e22dSJed Brown   PetscErrorCode ierr;
3587ed81e22dSJed Brown   char           filename[PETSC_MAX_PATH_LEN];
3588ed81e22dSJed Brown   PetscViewer    viewer;
3589ed81e22dSJed Brown 
3590ed81e22dSJed Brown   PetscFunctionBegin;
35918caf3d72SBarry Smith   ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr);
3592ed81e22dSJed Brown   ierr = PetscViewerVTKOpen(((PetscObject)ts)->comm,filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr);
35930910c330SBarry Smith   ierr = VecView(u,viewer);CHKERRQ(ierr);
3594ed81e22dSJed Brown   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
3595ed81e22dSJed Brown   PetscFunctionReturn(0);
3596ed81e22dSJed Brown }
3597ed81e22dSJed Brown 
3598ed81e22dSJed Brown #undef __FUNCT__
3599ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTKDestroy"
3600ed81e22dSJed Brown /*@C
3601ed81e22dSJed Brown    TSMonitorSolutionVTKDestroy - Destroy context for monitoring
3602ed81e22dSJed Brown 
3603ed81e22dSJed Brown    Collective on TS
3604ed81e22dSJed Brown 
3605ed81e22dSJed Brown    Input Parameters:
3606ed81e22dSJed Brown .  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
3607ed81e22dSJed Brown 
3608ed81e22dSJed Brown    Level: intermediate
3609ed81e22dSJed Brown 
3610ed81e22dSJed Brown    Note:
3611ed81e22dSJed Brown    This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK().
3612ed81e22dSJed Brown 
3613ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
3614ed81e22dSJed Brown 
3615ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK()
3616ed81e22dSJed Brown @*/
3617ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate)
3618ed81e22dSJed Brown {
3619ed81e22dSJed Brown   PetscErrorCode ierr;
3620ed81e22dSJed Brown 
3621ed81e22dSJed Brown   PetscFunctionBegin;
3622ed81e22dSJed Brown   ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr);
3623fb1732b5SBarry Smith   PetscFunctionReturn(0);
3624fb1732b5SBarry Smith }
3625fb1732b5SBarry Smith 
362684df9cb4SJed Brown #undef __FUNCT__
362784df9cb4SJed Brown #define __FUNCT__ "TSGetAdapt"
362884df9cb4SJed Brown /*@
362984df9cb4SJed Brown    TSGetAdapt - Get the adaptive controller context for the current method
363084df9cb4SJed Brown 
3631ed81e22dSJed Brown    Collective on TS if controller has not been created yet
363284df9cb4SJed Brown 
363384df9cb4SJed Brown    Input Arguments:
3634ed81e22dSJed Brown .  ts - time stepping context
363584df9cb4SJed Brown 
363684df9cb4SJed Brown    Output Arguments:
3637ed81e22dSJed Brown .  adapt - adaptive controller
363884df9cb4SJed Brown 
363984df9cb4SJed Brown    Level: intermediate
364084df9cb4SJed Brown 
3641ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose()
364284df9cb4SJed Brown @*/
364384df9cb4SJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt)
364484df9cb4SJed Brown {
364584df9cb4SJed Brown   PetscErrorCode ierr;
364684df9cb4SJed Brown 
364784df9cb4SJed Brown   PetscFunctionBegin;
364884df9cb4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
364984df9cb4SJed Brown   PetscValidPointer(adapt,2);
365084df9cb4SJed Brown   if (!ts->adapt) {
365184df9cb4SJed Brown     ierr = TSAdaptCreate(((PetscObject)ts)->comm,&ts->adapt);CHKERRQ(ierr);
36521c3436cfSJed Brown     ierr = PetscLogObjectParent(ts,ts->adapt);CHKERRQ(ierr);
36531c3436cfSJed Brown     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr);
365484df9cb4SJed Brown   }
365584df9cb4SJed Brown   *adapt = ts->adapt;
365684df9cb4SJed Brown   PetscFunctionReturn(0);
365784df9cb4SJed Brown }
3658d6ebe24aSShri Abhyankar 
3659d6ebe24aSShri Abhyankar #undef __FUNCT__
36601c3436cfSJed Brown #define __FUNCT__ "TSSetTolerances"
36611c3436cfSJed Brown /*@
36621c3436cfSJed Brown    TSSetTolerances - Set tolerances for local truncation error when using adaptive controller
36631c3436cfSJed Brown 
36641c3436cfSJed Brown    Logically Collective
36651c3436cfSJed Brown 
36661c3436cfSJed Brown    Input Arguments:
36671c3436cfSJed Brown +  ts - time integration context
36681c3436cfSJed Brown .  atol - scalar absolute tolerances, PETSC_DECIDE to leave current value
36691c3436cfSJed Brown .  vatol - vector of absolute tolerances or PETSC_NULL, used in preference to atol if present
36701c3436cfSJed Brown .  rtol - scalar relative tolerances, PETSC_DECIDE to leave current value
36711c3436cfSJed Brown -  vrtol - vector of relative tolerances or PETSC_NULL, used in preference to atol if present
36721c3436cfSJed Brown 
36731c3436cfSJed Brown    Level: beginner
36741c3436cfSJed Brown 
3675c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances()
36761c3436cfSJed Brown @*/
36771c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol)
36781c3436cfSJed Brown {
36791c3436cfSJed Brown   PetscErrorCode ierr;
36801c3436cfSJed Brown 
36811c3436cfSJed Brown   PetscFunctionBegin;
3682c5033834SJed Brown   if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol;
36831c3436cfSJed Brown   if (vatol) {
36841c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr);
36851c3436cfSJed Brown     ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
36861c3436cfSJed Brown     ts->vatol = vatol;
36871c3436cfSJed Brown   }
3688c5033834SJed Brown   if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol;
36891c3436cfSJed Brown   if (vrtol) {
36901c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr);
36911c3436cfSJed Brown     ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
36921c3436cfSJed Brown     ts->vrtol = vrtol;
36931c3436cfSJed Brown   }
36941c3436cfSJed Brown   PetscFunctionReturn(0);
36951c3436cfSJed Brown }
36961c3436cfSJed Brown 
36971c3436cfSJed Brown #undef __FUNCT__
3698c5033834SJed Brown #define __FUNCT__ "TSGetTolerances"
3699c5033834SJed Brown /*@
3700c5033834SJed Brown    TSGetTolerances - Get tolerances for local truncation error when using adaptive controller
3701c5033834SJed Brown 
3702c5033834SJed Brown    Logically Collective
3703c5033834SJed Brown 
3704c5033834SJed Brown    Input Arguments:
3705c5033834SJed Brown .  ts - time integration context
3706c5033834SJed Brown 
3707c5033834SJed Brown    Output Arguments:
3708c5033834SJed Brown +  atol - scalar absolute tolerances, PETSC_NULL to ignore
3709c5033834SJed Brown .  vatol - vector of absolute tolerances, PETSC_NULL to ignore
3710c5033834SJed Brown .  rtol - scalar relative tolerances, PETSC_NULL to ignore
3711c5033834SJed Brown -  vrtol - vector of relative tolerances, PETSC_NULL to ignore
3712c5033834SJed Brown 
3713c5033834SJed Brown    Level: beginner
3714c5033834SJed Brown 
3715c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances()
3716c5033834SJed Brown @*/
3717c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol)
3718c5033834SJed Brown {
3719c5033834SJed Brown   PetscFunctionBegin;
3720c5033834SJed Brown   if (atol)  *atol  = ts->atol;
3721c5033834SJed Brown   if (vatol) *vatol = ts->vatol;
3722c5033834SJed Brown   if (rtol)  *rtol  = ts->rtol;
3723c5033834SJed Brown   if (vrtol) *vrtol = ts->vrtol;
3724c5033834SJed Brown   PetscFunctionReturn(0);
3725c5033834SJed Brown }
3726c5033834SJed Brown 
3727c5033834SJed Brown #undef __FUNCT__
37281c3436cfSJed Brown #define __FUNCT__ "TSErrorNormWRMS"
37291c3436cfSJed Brown /*@
37301c3436cfSJed Brown    TSErrorNormWRMS - compute a weighted norm of the difference between a vector and the current state
37311c3436cfSJed Brown 
37321c3436cfSJed Brown    Collective on TS
37331c3436cfSJed Brown 
37341c3436cfSJed Brown    Input Arguments:
37351c3436cfSJed Brown +  ts - time stepping context
37361c3436cfSJed Brown -  Y - state vector to be compared to ts->vec_sol
37371c3436cfSJed Brown 
37381c3436cfSJed Brown    Output Arguments:
37391c3436cfSJed Brown .  norm - weighted norm, a value of 1.0 is considered small
37401c3436cfSJed Brown 
37411c3436cfSJed Brown    Level: developer
37421c3436cfSJed Brown 
37431c3436cfSJed Brown .seealso: TSSetTolerances()
37441c3436cfSJed Brown @*/
37451c3436cfSJed Brown PetscErrorCode TSErrorNormWRMS(TS ts,Vec Y,PetscReal *norm)
37461c3436cfSJed Brown {
37471c3436cfSJed Brown   PetscErrorCode    ierr;
37481c3436cfSJed Brown   PetscInt          i,n,N;
37490910c330SBarry Smith   const PetscScalar *u,*y;
37500910c330SBarry Smith   Vec               U;
37511c3436cfSJed Brown   PetscReal         sum,gsum;
37521c3436cfSJed Brown 
37531c3436cfSJed Brown   PetscFunctionBegin;
37541c3436cfSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
37551c3436cfSJed Brown   PetscValidHeaderSpecific(Y,VEC_CLASSID,2);
37561c3436cfSJed Brown   PetscValidPointer(norm,3);
37570910c330SBarry Smith   U = ts->vec_sol;
37580910c330SBarry Smith   PetscCheckSameTypeAndComm(U,1,Y,2);
37590910c330SBarry Smith   if (U == Y) SETERRQ(((PetscObject)U)->comm,PETSC_ERR_ARG_IDN,"Y cannot be the TS solution vector");
37601c3436cfSJed Brown 
37610910c330SBarry Smith   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
37620910c330SBarry Smith   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
37630910c330SBarry Smith   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
37641c3436cfSJed Brown   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
37651c3436cfSJed Brown   sum = 0.;
3766ceefc113SJed Brown   if (ts->vatol && ts->vrtol) {
3767ceefc113SJed Brown     const PetscScalar *atol,*rtol;
3768ceefc113SJed Brown     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
3769ceefc113SJed Brown     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
3770ceefc113SJed Brown     for (i=0; i<n; i++) {
37710910c330SBarry Smith       PetscReal tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
37720910c330SBarry Smith       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
3773ceefc113SJed Brown     }
3774ceefc113SJed Brown     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
3775ceefc113SJed Brown     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
3776ceefc113SJed Brown   } else if (ts->vatol) {       /* vector atol, scalar rtol */
3777ceefc113SJed Brown     const PetscScalar *atol;
3778ceefc113SJed Brown     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
3779ceefc113SJed Brown     for (i=0; i<n; i++) {
37800910c330SBarry Smith       PetscReal tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
37810910c330SBarry Smith       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
3782ceefc113SJed Brown     }
3783ceefc113SJed Brown     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
3784ceefc113SJed Brown   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
3785ceefc113SJed Brown     const PetscScalar *rtol;
3786ceefc113SJed Brown     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
3787ceefc113SJed Brown     for (i=0; i<n; i++) {
37880910c330SBarry Smith       PetscReal tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
37890910c330SBarry Smith       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
3790ceefc113SJed Brown     }
3791ceefc113SJed Brown     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
3792ceefc113SJed Brown   } else {                      /* scalar atol, scalar rtol */
37931c3436cfSJed Brown     for (i=0; i<n; i++) {
37940910c330SBarry Smith       PetscReal tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
37950910c330SBarry Smith       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
37961c3436cfSJed Brown     }
3797ceefc113SJed Brown   }
37980910c330SBarry Smith   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
37991c3436cfSJed Brown   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
38001c3436cfSJed Brown 
38011c3436cfSJed Brown   ierr = MPI_Allreduce(&sum,&gsum,1,MPIU_REAL,MPIU_SUM,((PetscObject)ts)->comm);CHKERRQ(ierr);
38021c3436cfSJed Brown   *norm = PetscSqrtReal(gsum / N);
38031c3436cfSJed Brown   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
38041c3436cfSJed Brown   PetscFunctionReturn(0);
38051c3436cfSJed Brown }
38061c3436cfSJed Brown 
38071c3436cfSJed Brown #undef __FUNCT__
38088d59e960SJed Brown #define __FUNCT__ "TSSetCFLTimeLocal"
38098d59e960SJed Brown /*@
38108d59e960SJed Brown    TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler
38118d59e960SJed Brown 
38128d59e960SJed Brown    Logically Collective on TS
38138d59e960SJed Brown 
38148d59e960SJed Brown    Input Arguments:
38158d59e960SJed Brown +  ts - time stepping context
38168d59e960SJed Brown -  cfltime - maximum stable time step if using forward Euler (value can be different on each process)
38178d59e960SJed Brown 
38188d59e960SJed Brown    Note:
38198d59e960SJed Brown    After calling this function, the global CFL time can be obtained by calling TSGetCFLTime()
38208d59e960SJed Brown 
38218d59e960SJed Brown    Level: intermediate
38228d59e960SJed Brown 
38238d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL
38248d59e960SJed Brown @*/
38258d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime)
38268d59e960SJed Brown {
38278d59e960SJed Brown   PetscFunctionBegin;
38288d59e960SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
38298d59e960SJed Brown   ts->cfltime_local = cfltime;
38308d59e960SJed Brown   ts->cfltime = -1.;
38318d59e960SJed Brown   PetscFunctionReturn(0);
38328d59e960SJed Brown }
38338d59e960SJed Brown 
38348d59e960SJed Brown #undef __FUNCT__
38358d59e960SJed Brown #define __FUNCT__ "TSGetCFLTime"
38368d59e960SJed Brown /*@
38378d59e960SJed Brown    TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler
38388d59e960SJed Brown 
38398d59e960SJed Brown    Collective on TS
38408d59e960SJed Brown 
38418d59e960SJed Brown    Input Arguments:
38428d59e960SJed Brown .  ts - time stepping context
38438d59e960SJed Brown 
38448d59e960SJed Brown    Output Arguments:
38458d59e960SJed Brown .  cfltime - maximum stable time step for forward Euler
38468d59e960SJed Brown 
38478d59e960SJed Brown    Level: advanced
38488d59e960SJed Brown 
38498d59e960SJed Brown .seealso: TSSetCFLTimeLocal()
38508d59e960SJed Brown @*/
38518d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime)
38528d59e960SJed Brown {
38538d59e960SJed Brown   PetscErrorCode ierr;
38548d59e960SJed Brown 
38558d59e960SJed Brown   PetscFunctionBegin;
38568d59e960SJed Brown   if (ts->cfltime < 0) {
38578d59e960SJed Brown     ierr = MPI_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,((PetscObject)ts)->comm);CHKERRQ(ierr);
38588d59e960SJed Brown   }
38598d59e960SJed Brown   *cfltime = ts->cfltime;
38608d59e960SJed Brown   PetscFunctionReturn(0);
38618d59e960SJed Brown }
38628d59e960SJed Brown 
38638d59e960SJed Brown #undef __FUNCT__
3864d6ebe24aSShri Abhyankar #define __FUNCT__ "TSVISetVariableBounds"
3865d6ebe24aSShri Abhyankar /*@
3866d6ebe24aSShri Abhyankar    TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
3867d6ebe24aSShri Abhyankar 
3868d6ebe24aSShri Abhyankar    Input Parameters:
3869d6ebe24aSShri Abhyankar .  ts   - the TS context.
3870d6ebe24aSShri Abhyankar .  xl   - lower bound.
3871d6ebe24aSShri Abhyankar .  xu   - upper bound.
3872d6ebe24aSShri Abhyankar 
3873d6ebe24aSShri Abhyankar    Notes:
3874d6ebe24aSShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
387533c0c2ddSJed Brown    SNES_VI_NINF and SNES_VI_INF respectively during SNESSetUp().
3876d6ebe24aSShri Abhyankar 
38772bd2b0e6SSatish Balay    Level: advanced
38782bd2b0e6SSatish Balay 
3879d6ebe24aSShri Abhyankar @*/
3880d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
3881d6ebe24aSShri Abhyankar {
3882d6ebe24aSShri Abhyankar   PetscErrorCode ierr;
3883d6ebe24aSShri Abhyankar   SNES           snes;
3884d6ebe24aSShri Abhyankar 
3885d6ebe24aSShri Abhyankar   PetscFunctionBegin;
3886d6ebe24aSShri Abhyankar   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3887d6ebe24aSShri Abhyankar   ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr);
3888d6ebe24aSShri Abhyankar   PetscFunctionReturn(0);
3889d6ebe24aSShri Abhyankar }
3890d6ebe24aSShri Abhyankar 
3891325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
3892c6db04a5SJed Brown #include <mex.h>
3893325fc9f4SBarry Smith 
3894325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext;
3895325fc9f4SBarry Smith 
3896325fc9f4SBarry Smith #undef __FUNCT__
3897325fc9f4SBarry Smith #define __FUNCT__ "TSComputeFunction_Matlab"
3898325fc9f4SBarry Smith /*
3899325fc9f4SBarry Smith    TSComputeFunction_Matlab - Calls the function that has been set with
3900325fc9f4SBarry Smith                          TSSetFunctionMatlab().
3901325fc9f4SBarry Smith 
3902325fc9f4SBarry Smith    Collective on TS
3903325fc9f4SBarry Smith 
3904325fc9f4SBarry Smith    Input Parameters:
3905325fc9f4SBarry Smith +  snes - the TS context
39060910c330SBarry Smith -  u - input vector
3907325fc9f4SBarry Smith 
3908325fc9f4SBarry Smith    Output Parameter:
3909325fc9f4SBarry Smith .  y - function vector, as set by TSSetFunction()
3910325fc9f4SBarry Smith 
3911325fc9f4SBarry Smith    Notes:
3912325fc9f4SBarry Smith    TSComputeFunction() is typically used within nonlinear solvers
3913325fc9f4SBarry Smith    implementations, so most users would not generally call this routine
3914325fc9f4SBarry Smith    themselves.
3915325fc9f4SBarry Smith 
3916325fc9f4SBarry Smith    Level: developer
3917325fc9f4SBarry Smith 
3918325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
3919325fc9f4SBarry Smith 
3920325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
3921325fc9f4SBarry Smith */
39220910c330SBarry Smith PetscErrorCode  TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx)
3923325fc9f4SBarry Smith {
3924325fc9f4SBarry Smith   PetscErrorCode   ierr;
3925325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext *)ctx;
3926325fc9f4SBarry Smith   int              nlhs = 1,nrhs = 7;
3927325fc9f4SBarry Smith   mxArray          *plhs[1],*prhs[7];
3928325fc9f4SBarry Smith   long long int    lx = 0,lxdot = 0,ly = 0,ls = 0;
3929325fc9f4SBarry Smith 
3930325fc9f4SBarry Smith   PetscFunctionBegin;
3931325fc9f4SBarry Smith   PetscValidHeaderSpecific(snes,TS_CLASSID,1);
39320910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
39330910c330SBarry Smith   PetscValidHeaderSpecific(udot,VEC_CLASSID,4);
3934325fc9f4SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,5);
39350910c330SBarry Smith   PetscCheckSameComm(snes,1,u,3);
3936325fc9f4SBarry Smith   PetscCheckSameComm(snes,1,y,5);
3937325fc9f4SBarry Smith 
3938325fc9f4SBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
39390910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
39400910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr);
39410910c330SBarry Smith   ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr);
3942325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
3943325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar(time);
3944325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
3945325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
3946325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)ly);
3947325fc9f4SBarry Smith   prhs[5] =  mxCreateString(sctx->funcname);
3948325fc9f4SBarry Smith   prhs[6] =  sctx->ctx;
3949325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr);
3950325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
3951325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
3952325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
3953325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
3954325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
3955325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
3956325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
3957325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
3958325fc9f4SBarry Smith   PetscFunctionReturn(0);
3959325fc9f4SBarry Smith }
3960325fc9f4SBarry Smith 
3961325fc9f4SBarry Smith 
3962325fc9f4SBarry Smith #undef __FUNCT__
3963325fc9f4SBarry Smith #define __FUNCT__ "TSSetFunctionMatlab"
3964325fc9f4SBarry Smith /*
3965325fc9f4SBarry Smith    TSSetFunctionMatlab - Sets the function evaluation routine and function
3966325fc9f4SBarry Smith    vector for use by the TS routines in solving ODEs
3967e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
3968325fc9f4SBarry Smith 
3969325fc9f4SBarry Smith    Logically Collective on TS
3970325fc9f4SBarry Smith 
3971325fc9f4SBarry Smith    Input Parameters:
3972325fc9f4SBarry Smith +  ts - the TS context
3973325fc9f4SBarry Smith -  func - function evaluation routine
3974325fc9f4SBarry Smith 
3975325fc9f4SBarry Smith    Calling sequence of func:
39760910c330SBarry Smith $    func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx);
3977325fc9f4SBarry Smith 
3978325fc9f4SBarry Smith    Level: beginner
3979325fc9f4SBarry Smith 
3980325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
3981325fc9f4SBarry Smith 
3982325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
3983325fc9f4SBarry Smith */
3984cdcf91faSSean Farley PetscErrorCode  TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx)
3985325fc9f4SBarry Smith {
3986325fc9f4SBarry Smith   PetscErrorCode  ierr;
3987325fc9f4SBarry Smith   TSMatlabContext *sctx;
3988325fc9f4SBarry Smith 
3989325fc9f4SBarry Smith   PetscFunctionBegin;
3990325fc9f4SBarry Smith   /* currently sctx is memory bleed */
3991325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
3992325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
3993325fc9f4SBarry Smith   /*
3994325fc9f4SBarry Smith      This should work, but it doesn't
3995325fc9f4SBarry Smith   sctx->ctx = ctx;
3996325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
3997325fc9f4SBarry Smith   */
3998325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
3999cdcf91faSSean Farley   ierr = TSSetIFunction(ts,PETSC_NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr);
4000325fc9f4SBarry Smith   PetscFunctionReturn(0);
4001325fc9f4SBarry Smith }
4002325fc9f4SBarry Smith 
4003325fc9f4SBarry Smith #undef __FUNCT__
4004325fc9f4SBarry Smith #define __FUNCT__ "TSComputeJacobian_Matlab"
4005325fc9f4SBarry Smith /*
4006325fc9f4SBarry Smith    TSComputeJacobian_Matlab - Calls the function that has been set with
4007325fc9f4SBarry Smith                          TSSetJacobianMatlab().
4008325fc9f4SBarry Smith 
4009325fc9f4SBarry Smith    Collective on TS
4010325fc9f4SBarry Smith 
4011325fc9f4SBarry Smith    Input Parameters:
4012cdcf91faSSean Farley +  ts - the TS context
40130910c330SBarry Smith .  u - input vector
4014325fc9f4SBarry Smith .  A, B - the matrices
4015325fc9f4SBarry Smith -  ctx - user context
4016325fc9f4SBarry Smith 
4017325fc9f4SBarry Smith    Output Parameter:
4018325fc9f4SBarry Smith .  flag - structure of the matrix
4019325fc9f4SBarry Smith 
4020325fc9f4SBarry Smith    Level: developer
4021325fc9f4SBarry Smith 
4022325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
4023325fc9f4SBarry Smith 
4024325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
4025325fc9f4SBarry Smith @*/
40260910c330SBarry Smith PetscErrorCode  TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat *A,Mat *B,MatStructure *flag, void *ctx)
4027325fc9f4SBarry Smith {
4028325fc9f4SBarry Smith   PetscErrorCode  ierr;
4029325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext *)ctx;
4030325fc9f4SBarry Smith   int             nlhs = 2,nrhs = 9;
4031325fc9f4SBarry Smith   mxArray         *plhs[2],*prhs[9];
4032325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0;
4033325fc9f4SBarry Smith 
4034325fc9f4SBarry Smith   PetscFunctionBegin;
4035cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
40360910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
4037325fc9f4SBarry Smith 
40380910c330SBarry Smith   /* call Matlab function in ctx with arguments u and y */
4039325fc9f4SBarry Smith 
4040cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
40410910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
40420910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr);
40430910c330SBarry Smith   ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr);
40440910c330SBarry Smith   ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr);
4045325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
4046325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)time);
4047325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
4048325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
4049325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)shift);
4050325fc9f4SBarry Smith   prhs[5] =  mxCreateDoubleScalar((double)lA);
4051325fc9f4SBarry Smith   prhs[6] =  mxCreateDoubleScalar((double)lB);
4052325fc9f4SBarry Smith   prhs[7] =  mxCreateString(sctx->funcname);
4053325fc9f4SBarry Smith   prhs[8] =  sctx->ctx;
4054325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr);
4055325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
4056325fc9f4SBarry Smith   *flag   =  (MatStructure) mxGetScalar(plhs[1]);CHKERRQ(ierr);
4057325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
4058325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
4059325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
4060325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
4061325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
4062325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
4063325fc9f4SBarry Smith   mxDestroyArray(prhs[6]);
4064325fc9f4SBarry Smith   mxDestroyArray(prhs[7]);
4065325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
4066325fc9f4SBarry Smith   mxDestroyArray(plhs[1]);
4067325fc9f4SBarry Smith   PetscFunctionReturn(0);
4068325fc9f4SBarry Smith }
4069325fc9f4SBarry Smith 
4070325fc9f4SBarry Smith 
4071325fc9f4SBarry Smith #undef __FUNCT__
4072325fc9f4SBarry Smith #define __FUNCT__ "TSSetJacobianMatlab"
4073325fc9f4SBarry Smith /*
4074325fc9f4SBarry Smith    TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
4075e3c5b3baSBarry 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
4076325fc9f4SBarry Smith 
4077325fc9f4SBarry Smith    Logically Collective on TS
4078325fc9f4SBarry Smith 
4079325fc9f4SBarry Smith    Input Parameters:
4080cdcf91faSSean Farley +  ts - the TS context
4081325fc9f4SBarry Smith .  A,B - Jacobian matrices
4082325fc9f4SBarry Smith .  func - function evaluation routine
4083325fc9f4SBarry Smith -  ctx - user context
4084325fc9f4SBarry Smith 
4085325fc9f4SBarry Smith    Calling sequence of func:
40860910c330SBarry Smith $    flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx);
4087325fc9f4SBarry Smith 
4088325fc9f4SBarry Smith 
4089325fc9f4SBarry Smith    Level: developer
4090325fc9f4SBarry Smith 
4091325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
4092325fc9f4SBarry Smith 
4093325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
4094325fc9f4SBarry Smith */
4095cdcf91faSSean Farley PetscErrorCode  TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx)
4096325fc9f4SBarry Smith {
4097325fc9f4SBarry Smith   PetscErrorCode    ierr;
4098325fc9f4SBarry Smith   TSMatlabContext *sctx;
4099325fc9f4SBarry Smith 
4100325fc9f4SBarry Smith   PetscFunctionBegin;
4101325fc9f4SBarry Smith   /* currently sctx is memory bleed */
4102325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
4103325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
4104325fc9f4SBarry Smith   /*
4105325fc9f4SBarry Smith      This should work, but it doesn't
4106325fc9f4SBarry Smith   sctx->ctx = ctx;
4107325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
4108325fc9f4SBarry Smith   */
4109325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
4110cdcf91faSSean Farley   ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
4111325fc9f4SBarry Smith   PetscFunctionReturn(0);
4112325fc9f4SBarry Smith }
4113325fc9f4SBarry Smith 
4114b5b1a830SBarry Smith #undef __FUNCT__
4115b5b1a830SBarry Smith #define __FUNCT__ "TSMonitor_Matlab"
4116b5b1a830SBarry Smith /*
4117b5b1a830SBarry Smith    TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab().
4118b5b1a830SBarry Smith 
4119b5b1a830SBarry Smith    Collective on TS
4120b5b1a830SBarry Smith 
4121b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
4122b5b1a830SBarry Smith @*/
41230910c330SBarry Smith PetscErrorCode  TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx)
4124b5b1a830SBarry Smith {
4125b5b1a830SBarry Smith   PetscErrorCode  ierr;
4126b5b1a830SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext *)ctx;
4127a530c242SBarry Smith   int             nlhs = 1,nrhs = 6;
4128b5b1a830SBarry Smith   mxArray         *plhs[1],*prhs[6];
4129b5b1a830SBarry Smith   long long int   lx = 0,ls = 0;
4130b5b1a830SBarry Smith 
4131b5b1a830SBarry Smith   PetscFunctionBegin;
4132cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
41330910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
4134b5b1a830SBarry Smith 
4135cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
41360910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
4137b5b1a830SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
4138b5b1a830SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)it);
4139b5b1a830SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)time);
4140b5b1a830SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lx);
4141b5b1a830SBarry Smith   prhs[4] =  mxCreateString(sctx->funcname);
4142b5b1a830SBarry Smith   prhs[5] =  sctx->ctx;
4143b5b1a830SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr);
4144b5b1a830SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
4145b5b1a830SBarry Smith   mxDestroyArray(prhs[0]);
4146b5b1a830SBarry Smith   mxDestroyArray(prhs[1]);
4147b5b1a830SBarry Smith   mxDestroyArray(prhs[2]);
4148b5b1a830SBarry Smith   mxDestroyArray(prhs[3]);
4149b5b1a830SBarry Smith   mxDestroyArray(prhs[4]);
4150b5b1a830SBarry Smith   mxDestroyArray(plhs[0]);
4151b5b1a830SBarry Smith   PetscFunctionReturn(0);
4152b5b1a830SBarry Smith }
4153b5b1a830SBarry Smith 
4154b5b1a830SBarry Smith 
4155b5b1a830SBarry Smith #undef __FUNCT__
4156b5b1a830SBarry Smith #define __FUNCT__ "TSMonitorSetMatlab"
4157b5b1a830SBarry Smith /*
4158b5b1a830SBarry Smith    TSMonitorSetMatlab - Sets the monitor function from Matlab
4159b5b1a830SBarry Smith 
4160b5b1a830SBarry Smith    Level: developer
4161b5b1a830SBarry Smith 
4162b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function
4163b5b1a830SBarry Smith 
4164b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
4165b5b1a830SBarry Smith */
4166cdcf91faSSean Farley PetscErrorCode  TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx)
4167b5b1a830SBarry Smith {
4168b5b1a830SBarry Smith   PetscErrorCode    ierr;
4169b5b1a830SBarry Smith   TSMatlabContext *sctx;
4170b5b1a830SBarry Smith 
4171b5b1a830SBarry Smith   PetscFunctionBegin;
4172b5b1a830SBarry Smith   /* currently sctx is memory bleed */
4173b5b1a830SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
4174b5b1a830SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
4175b5b1a830SBarry Smith   /*
4176b5b1a830SBarry Smith      This should work, but it doesn't
4177b5b1a830SBarry Smith   sctx->ctx = ctx;
4178b5b1a830SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
4179b5b1a830SBarry Smith   */
4180b5b1a830SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
4181cdcf91faSSean Farley   ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,PETSC_NULL);CHKERRQ(ierr);
4182b5b1a830SBarry Smith   PetscFunctionReturn(0);
4183b5b1a830SBarry Smith }
4184325fc9f4SBarry Smith #endif
4185b3603a34SBarry Smith 
41860b039ecaSBarry Smith 
41870b039ecaSBarry Smith 
4188b3603a34SBarry Smith #undef __FUNCT__
41894f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGSolution"
4190b3603a34SBarry Smith /*@C
41914f09c107SBarry Smith    TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector
4192b3603a34SBarry Smith        in a time based line graph
4193b3603a34SBarry Smith 
4194b3603a34SBarry Smith    Collective on TS
4195b3603a34SBarry Smith 
4196b3603a34SBarry Smith    Input Parameters:
4197b3603a34SBarry Smith +  ts - the TS context
4198b3603a34SBarry Smith .  step - current time-step
4199b3603a34SBarry Smith .  ptime - current time
4200b3603a34SBarry Smith -  lg - a line graph object
4201b3603a34SBarry Smith 
4202b3603a34SBarry Smith    Level: intermediate
4203b3603a34SBarry Smith 
42040b039ecaSBarry Smith     Notes: each process in a parallel run displays its component solutions in a separate window
4205b3603a34SBarry Smith 
4206b3603a34SBarry Smith .keywords: TS,  vector, monitor, view
4207b3603a34SBarry Smith 
4208b3603a34SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
4209b3603a34SBarry Smith @*/
42100910c330SBarry Smith PetscErrorCode  TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
4211b3603a34SBarry Smith {
4212b3603a34SBarry Smith   PetscErrorCode    ierr;
42130b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
4214b3603a34SBarry Smith   const PetscScalar *yy;
421558ff32f7SBarry Smith   PetscInt          dim;
4216b3603a34SBarry Smith 
4217b3603a34SBarry Smith   PetscFunctionBegin;
421858ff32f7SBarry Smith   if (!step) {
4219a9f9c1f6SBarry Smith     PetscDrawAxis  axis;
4220a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
4221a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr);
42220910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
42230b039ecaSBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
42240b039ecaSBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
422558ff32f7SBarry Smith   }
42260910c330SBarry Smith   ierr = VecGetArrayRead(u,&yy);CHKERRQ(ierr);
4227e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
4228e3efe391SJed Brown   {
4229e3efe391SJed Brown     PetscReal *yreal;
4230e3efe391SJed Brown     PetscInt i,n;
42310910c330SBarry Smith     ierr = VecGetLocalSize(u,&n);CHKERRQ(ierr);
4232e3efe391SJed Brown     ierr = PetscMalloc(n*sizeof(PetscReal),&yreal);CHKERRQ(ierr);
4233e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
42340b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
4235e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
4236e3efe391SJed Brown   }
4237e3efe391SJed Brown #else
42380b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
4239e3efe391SJed Brown #endif
42400910c330SBarry Smith   ierr = VecRestoreArrayRead(u,&yy);CHKERRQ(ierr);
42413fbbecb0SBarry Smith   if (((ctx->howoften > 0) && (!(step % ctx->howoften)) && (step > -1)) || ((ctx->howoften == -1) && (step == -1))){
42420b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
42433923b477SBarry Smith   }
4244b3603a34SBarry Smith   PetscFunctionReturn(0);
4245b3603a34SBarry Smith }
4246b3603a34SBarry Smith 
4247b3603a34SBarry Smith #undef __FUNCT__
42484f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGError"
4249ef20d060SBarry Smith /*@C
42504f09c107SBarry Smith    TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector
4251ef20d060SBarry Smith        in a time based line graph
4252ef20d060SBarry Smith 
4253ef20d060SBarry Smith    Collective on TS
4254ef20d060SBarry Smith 
4255ef20d060SBarry Smith    Input Parameters:
4256ef20d060SBarry Smith +  ts - the TS context
4257ef20d060SBarry Smith .  step - current time-step
4258ef20d060SBarry Smith .  ptime - current time
4259ef20d060SBarry Smith -  lg - a line graph object
4260ef20d060SBarry Smith 
4261ef20d060SBarry Smith    Level: intermediate
4262ef20d060SBarry Smith 
4263abd5a294SJed Brown    Notes:
4264abd5a294SJed Brown    Only for sequential solves.
4265abd5a294SJed Brown 
4266abd5a294SJed Brown    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
4267abd5a294SJed Brown 
4268abd5a294SJed Brown    Options Database Keys:
42694f09c107SBarry Smith .  -ts_monitor_lg_error - create a graphical monitor of error history
4270ef20d060SBarry Smith 
4271ef20d060SBarry Smith .keywords: TS,  vector, monitor, view
4272ef20d060SBarry Smith 
4273abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
4274ef20d060SBarry Smith @*/
42750910c330SBarry Smith PetscErrorCode  TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
4276ef20d060SBarry Smith {
4277ef20d060SBarry Smith   PetscErrorCode    ierr;
42780b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
4279ef20d060SBarry Smith   const PetscScalar *yy;
4280ef20d060SBarry Smith   Vec               y;
4281a9f9c1f6SBarry Smith   PetscInt          dim;
4282ef20d060SBarry Smith 
4283ef20d060SBarry Smith   PetscFunctionBegin;
4284a9f9c1f6SBarry Smith   if (!step) {
4285a9f9c1f6SBarry Smith     PetscDrawAxis  axis;
4286a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
42871ae185eaSBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr);
42880910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
4289a9f9c1f6SBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
4290a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
4291a9f9c1f6SBarry Smith   }
42920910c330SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
4293ef20d060SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
42940910c330SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
4295ef20d060SBarry Smith   ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr);
4296e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
4297e3efe391SJed Brown   {
4298e3efe391SJed Brown     PetscReal *yreal;
4299e3efe391SJed Brown     PetscInt  i,n;
4300e3efe391SJed Brown     ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr);
4301e3efe391SJed Brown     ierr = PetscMalloc(n*sizeof(PetscReal),&yreal);CHKERRQ(ierr);
4302e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
43030b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
4304e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
4305e3efe391SJed Brown   }
4306e3efe391SJed Brown #else
43070b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
4308e3efe391SJed Brown #endif
4309ef20d060SBarry Smith   ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr);
4310ef20d060SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
43113fbbecb0SBarry Smith   if (((ctx->howoften > 0) && (!(step % ctx->howoften)) && (step > -1)) || ((ctx->howoften == -1) && (step == -1))){
43120b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
43133923b477SBarry Smith   }
4314ef20d060SBarry Smith   PetscFunctionReturn(0);
4315ef20d060SBarry Smith }
4316ef20d060SBarry Smith 
4317201da799SBarry Smith #undef __FUNCT__
4318201da799SBarry Smith #define __FUNCT__ "TSMonitorLGSNESIterations"
4319201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
4320201da799SBarry Smith {
4321201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
4322201da799SBarry Smith   PetscReal      x = ptime,y;
4323201da799SBarry Smith   PetscErrorCode ierr;
4324201da799SBarry Smith   PetscInt       its;
4325201da799SBarry Smith 
4326201da799SBarry Smith   PetscFunctionBegin;
4327201da799SBarry Smith   if (!n) {
4328201da799SBarry Smith     PetscDrawAxis  axis;
4329201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
4330201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr);
4331201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
4332201da799SBarry Smith     ctx->snes_its  = 0;
4333201da799SBarry Smith   }
4334201da799SBarry Smith   ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr);
4335201da799SBarry Smith   y    = its - ctx->snes_its;
4336201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
43373fbbecb0SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))){
4338201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
4339201da799SBarry Smith   }
4340201da799SBarry Smith   ctx->snes_its = its;
4341201da799SBarry Smith   PetscFunctionReturn(0);
4342201da799SBarry Smith }
4343201da799SBarry Smith 
4344201da799SBarry Smith #undef __FUNCT__
4345201da799SBarry Smith #define __FUNCT__ "TSMonitorLGKSPIterations"
4346201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
4347201da799SBarry Smith {
4348201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
4349201da799SBarry Smith   PetscReal      x = ptime,y;
4350201da799SBarry Smith   PetscErrorCode ierr;
4351201da799SBarry Smith   PetscInt       its;
4352201da799SBarry Smith 
4353201da799SBarry Smith   PetscFunctionBegin;
4354201da799SBarry Smith   if (!n) {
4355201da799SBarry Smith     PetscDrawAxis  axis;
4356201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
4357201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr);
4358201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
4359201da799SBarry Smith     ctx->ksp_its = 0;
4360201da799SBarry Smith   }
4361201da799SBarry Smith   ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr);
4362201da799SBarry Smith   y    = its - ctx->ksp_its;
4363201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
436499fdda47SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))){
4365201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
4366201da799SBarry Smith   }
4367201da799SBarry Smith   ctx->ksp_its = its;
4368201da799SBarry Smith   PetscFunctionReturn(0);
4369201da799SBarry Smith }
4370f9c1d6abSBarry Smith 
4371f9c1d6abSBarry Smith #undef __FUNCT__
4372f9c1d6abSBarry Smith #define __FUNCT__ "TSComputeLinearStability"
4373f9c1d6abSBarry Smith /*@
4374f9c1d6abSBarry Smith    TSComputeLinearStability - computes the linear stability function at a point
4375f9c1d6abSBarry Smith 
4376f9c1d6abSBarry Smith    Collective on TS and Vec
4377f9c1d6abSBarry Smith 
4378f9c1d6abSBarry Smith    Input Parameters:
4379f9c1d6abSBarry Smith +  ts - the TS context
4380f9c1d6abSBarry Smith -  xr,xi - real and imaginary part of input arguments
4381f9c1d6abSBarry Smith 
4382f9c1d6abSBarry Smith    Output Parameters:
4383f9c1d6abSBarry Smith .  yr,yi - real and imaginary part of function value
4384f9c1d6abSBarry Smith 
4385f9c1d6abSBarry Smith    Level: developer
4386f9c1d6abSBarry Smith 
4387f9c1d6abSBarry Smith .keywords: TS, compute
4388f9c1d6abSBarry Smith 
4389f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction()
4390f9c1d6abSBarry Smith @*/
4391f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi)
4392f9c1d6abSBarry Smith {
4393f9c1d6abSBarry Smith   PetscErrorCode ierr;
4394f9c1d6abSBarry Smith 
4395f9c1d6abSBarry Smith   PetscFunctionBegin;
4396f9c1d6abSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4397f9c1d6abSBarry Smith   if (!ts->ops->linearstability) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_SUP,"Linearized stability function not provided for this method");
4398f9c1d6abSBarry Smith   ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr);
4399f9c1d6abSBarry Smith   PetscFunctionReturn(0);
4400f9c1d6abSBarry Smith }
4401