xref: /petsc/src/ts/interface/ts.c (revision ca5f011da245c42ea0548b9616858e9c74e6bdc9)
163dd3a1aSKris Buschelman 
2af0996ceSBarry Smith #include <petsc/private/tsimpl.h>        /*I "petscts.h"  I*/
3496e6a7aSJed Brown #include <petscdmshell.h>
41e25c274SJed Brown #include <petscdmda.h>
52d5ee99bSBarry Smith #include <petscviewer.h>
62d5ee99bSBarry Smith #include <petscdraw.h>
7d763cef2SBarry Smith 
8d5ba7fb7SMatthew Knepley /* Logging support */
9d74926cbSBarry Smith PetscClassId  TS_CLASSID, DMTS_CLASSID;
10166c7f25SBarry Smith PetscLogEvent TS_Step, TS_PseudoComputeTimeStep, TS_FunctionEval, TS_JacobianEval;
11d405a339SMatthew Knepley 
1249354f04SShri Abhyankar const char *const TSExactFinalTimeOptions[] = {"STEPOVER","INTERPOLATE","MATCHSTEP","TSExactFinalTimeOption","TS_EXACTFINALTIME_",0};
1349354f04SShri Abhyankar 
142d5ee99bSBarry Smith struct _n_TSMonitorDrawCtx {
152d5ee99bSBarry Smith   PetscViewer   viewer;
164b363babSBarry Smith   PetscDrawAxis axis;
172d5ee99bSBarry Smith   Vec           initialsolution;
182d5ee99bSBarry Smith   PetscBool     showinitial;
192d5ee99bSBarry Smith   PetscInt      howoften;  /* when > 0 uses step % howoften, when negative only final solution plotted */
202d5ee99bSBarry Smith   PetscBool     showtimestepandtime;
212d5ee99bSBarry Smith   int           color;
222d5ee99bSBarry Smith };
232d5ee99bSBarry Smith 
24bdad233fSMatthew Knepley #undef __FUNCT__
25bdad233fSMatthew Knepley #define __FUNCT__ "TSSetFromOptions"
26bdad233fSMatthew Knepley /*@
27bdad233fSMatthew Knepley    TSSetFromOptions - Sets various TS parameters from user options.
28bdad233fSMatthew Knepley 
29bdad233fSMatthew Knepley    Collective on TS
30bdad233fSMatthew Knepley 
31bdad233fSMatthew Knepley    Input Parameter:
32bdad233fSMatthew Knepley .  ts - the TS context obtained from TSCreate()
33bdad233fSMatthew Knepley 
34bdad233fSMatthew Knepley    Options Database Keys:
354d91e141SJed Brown +  -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSGL, TSSSP
36ef222394SBarry Smith .  -ts_save_trajectory - checkpoint the solution at each time-step
373e4cdcaaSBarry Smith .  -ts_max_steps <maxsteps> - maximum number of time-steps to take
383e4cdcaaSBarry Smith .  -ts_final_time <time> - maximum time to compute to
393e4cdcaaSBarry Smith .  -ts_dt <dt> - initial time step
40a3cdaa26SBarry Smith .  -ts_exact_final_time <stepover,interpolate,matchstep> whether to stop at the exact given final time and how to compute the solution at that ti,e
41a3cdaa26SBarry Smith .  -ts_max_snes_failures <maxfailures> - Maximum number of nonlinear solve failures allowed
42a3cdaa26SBarry Smith .  -ts_max_reject <maxrejects> - Maximum number of step rejections before step fails
43a3cdaa26SBarry Smith .  -ts_error_if_step_fails <true,false> - Error if no step succeeds
44a3cdaa26SBarry Smith .  -ts_rtol <rtol> - relative tolerance for local truncation error
45a3cdaa26SBarry Smith .  -ts_atol <atol> Absolute tolerance for local truncation error
46ef222394SBarry Smith .  -ts_adjoint_solve <yes,no> After solving the ODE/DAE solve the adjoint problem (requires -ts_save_trajectory)
47847ff0e1SMatthew G. Knepley .  -ts_fd_color - Use finite differences with coloring to compute IJacobian
48bdad233fSMatthew Knepley .  -ts_monitor - print information at each timestep
49de06c3feSJed Brown .  -ts_monitor_lg_timestep - Monitor timestep size graphically
50de06c3feSJed Brown .  -ts_monitor_lg_solution - Monitor solution graphically
51de06c3feSJed Brown .  -ts_monitor_lg_error - Monitor error graphically
52de06c3feSJed Brown .  -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically
53de06c3feSJed Brown .  -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically
54de06c3feSJed Brown .  -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically
55de06c3feSJed Brown .  -ts_monitor_draw_solution - Monitor solution graphically
563e4cdcaaSBarry Smith .  -ts_monitor_draw_solution_phase  <xleft,yleft,xright,yright> - Monitor solution graphically with phase diagram, requires problem with exactly 2 degrees of freedom
573e4cdcaaSBarry Smith .  -ts_monitor_draw_error - Monitor error graphically, requires use to have provided TSSetSolutionFunction()
5891b97e58SBarry Smith .  -ts_monitor_solution_binary <filename> - Save each solution to a binary file
59b3d3934dSBarry Smith .  -ts_monitor_solution_vtk <filename.vts> - Save each time step to a binary file, use filename-%%03D.vts
60110eb670SHong Zhang .  -ts_monitor_envelope - determine maximum and minimum value of each component of the solution over the solution time
61110eb670SHong Zhang .  -ts_adjoint_monitor - print information at each adjoint time step
6253ea634cSHong Zhang -  -ts_adjoint_monitor_draw_sensi - monitor the sensitivity of the first cost function wrt initial conditions (lambda[0]) graphically
6353ea634cSHong Zhang 
6491b97e58SBarry Smith    Developer Note: We should unify all the -ts_monitor options in the way that -xxx_view has been unified
65bdad233fSMatthew Knepley 
66bdad233fSMatthew Knepley    Level: beginner
67bdad233fSMatthew Knepley 
68bdad233fSMatthew Knepley .keywords: TS, timestep, set, options, database
69bdad233fSMatthew Knepley 
70a313700dSBarry Smith .seealso: TSGetType()
71bdad233fSMatthew Knepley @*/
727087cfbeSBarry Smith PetscErrorCode  TSSetFromOptions(TS ts)
73bdad233fSMatthew Knepley {
74bc952696SBarry Smith   PetscBool              opt,flg,tflg;
75dfbe8321SBarry Smith   PetscErrorCode         ierr;
76649052a6SBarry Smith   PetscViewer            monviewer;
77eabae89aSBarry Smith   char                   monfilename[PETSC_MAX_PATH_LEN];
78089b2837SJed Brown   SNES                   snes;
791c3436cfSJed Brown   TSAdapt                adapt;
8031748224SBarry Smith   PetscReal              time_step;
8149354f04SShri Abhyankar   TSExactFinalTimeOption eftopt;
82d1212d36SBarry Smith   char                   dir[16];
836991f827SBarry Smith   const char             *defaultType;
846991f827SBarry Smith   char                   typeName[256];
85bdad233fSMatthew Knepley 
86bdad233fSMatthew Knepley   PetscFunctionBegin;
870700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
883194b578SJed Brown   ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr);
896991f827SBarry Smith   if (((PetscObject)ts)->type_name) defaultType = ((PetscObject)ts)->type_name;
906991f827SBarry Smith   else defaultType = TSEULER;
916991f827SBarry Smith 
926991f827SBarry Smith   ierr = TSRegisterAll();CHKERRQ(ierr);
936991f827SBarry Smith   ierr = PetscOptionsFList("-ts_type", "TS method"," TSSetType", TSList, defaultType, typeName, 256, &opt);CHKERRQ(ierr);
946991f827SBarry Smith   if (opt) {
956991f827SBarry Smith     ierr = TSSetType(ts, typeName);CHKERRQ(ierr);
966991f827SBarry Smith   } else {
976991f827SBarry Smith     ierr = TSSetType(ts, defaultType);CHKERRQ(ierr);
986991f827SBarry Smith   }
99bdad233fSMatthew Knepley 
100bdad233fSMatthew Knepley   /* Handle generic TS options */
101844594baSBarry Smith   if (ts->trajectory) tflg = PETSC_TRUE;
102844594baSBarry Smith   else tflg = PETSC_FALSE;
103920aabf2SBarry Smith   ierr = PetscOptionsBool("-ts_save_trajectory","Save the solution at each timestep","TSSetSaveTrajectory",tflg,&tflg,NULL);CHKERRQ(ierr);
104bc952696SBarry Smith   if (tflg) {ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);}
105ef222394SBarry Smith   if (ts->adjoint_solve) tflg = PETSC_TRUE;
106ef222394SBarry Smith   else tflg = PETSC_FALSE;
107ef222394SBarry Smith   ierr = PetscOptionsBool("-ts_adjoint_solve","Solve the adjoint problem immediately after solving the forward problem","",tflg,&tflg,&flg);CHKERRQ(ierr);
108ef222394SBarry Smith   if (flg) {
109ef222394SBarry Smith     ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);
110e87fd094SBarry Smith     ts->adjoint_solve = tflg;
111ef222394SBarry Smith   }
1120298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetDuration",ts->max_steps,&ts->max_steps,NULL);CHKERRQ(ierr);
1130298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_final_time","Time to run to","TSSetDuration",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr);
1140298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);CHKERRQ(ierr);
11531748224SBarry Smith   ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr);
11631748224SBarry Smith   if (flg) {
11731748224SBarry Smith     ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
11831748224SBarry Smith   }
11949354f04SShri Abhyankar   ierr = PetscOptionsEnum("-ts_exact_final_time","Option for handling of final time step","TSSetExactFinalTime",TSExactFinalTimeOptions,(PetscEnum)ts->exact_final_time,(PetscEnum*)&eftopt,&flg);CHKERRQ(ierr);
12049354f04SShri Abhyankar   if (flg) {ierr = TSSetExactFinalTime(ts,eftopt);CHKERRQ(ierr);}
1210298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_snes_failures","Maximum number of nonlinear solve failures","TSSetMaxSNESFailures",ts->max_snes_failures,&ts->max_snes_failures,NULL);CHKERRQ(ierr);
1220298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);CHKERRQ(ierr);
1230298fd71SBarry Smith   ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);CHKERRQ(ierr);
1240298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);CHKERRQ(ierr);
1250298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);CHKERRQ(ierr);
126bdad233fSMatthew Knepley 
12756f85f32SBarry Smith #if defined(PETSC_HAVE_SAWS)
12856f85f32SBarry Smith   {
12956f85f32SBarry Smith   PetscBool set;
13056f85f32SBarry Smith   flg  = PETSC_FALSE;
13156f85f32SBarry Smith   ierr = PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);CHKERRQ(ierr);
13256f85f32SBarry Smith   if (set) {
13356f85f32SBarry Smith     ierr = PetscObjectSAWsSetBlock((PetscObject)ts,flg);CHKERRQ(ierr);
13456f85f32SBarry Smith   }
13556f85f32SBarry Smith   }
13656f85f32SBarry Smith #endif
13756f85f32SBarry Smith 
138bdad233fSMatthew Knepley   /* Monitor options */
139a6570f20SBarry Smith   ierr = PetscOptionsString("-ts_monitor","Monitor timestep size","TSMonitorDefault","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
140eabae89aSBarry Smith   if (flg) {
141ce94432eSBarry Smith     ierr = PetscViewerASCIIOpen(PetscObjectComm((PetscObject)ts),monfilename,&monviewer);CHKERRQ(ierr);
142649052a6SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
143bdad233fSMatthew Knepley   }
1445180491cSLisandro Dalcin   ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
1455180491cSLisandro Dalcin   if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);}
1465180491cSLisandro Dalcin 
1474f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr);
148a7cc72afSBarry Smith   if (opt) {
1490b039ecaSBarry Smith     TSMonitorLGCtx ctx;
1503923b477SBarry Smith     PetscInt       howoften = 1;
151a80ad3e0SBarry Smith 
1520298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr);
1537f52daa2SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
1544f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
155b3603a34SBarry Smith   }
1564f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr);
157b3603a34SBarry Smith   if (opt) {
1580b039ecaSBarry Smith     TSMonitorLGCtx ctx;
1593923b477SBarry Smith     PetscInt       howoften = 1;
160b3603a34SBarry Smith 
1610298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
16222d28d08SBarry Smith     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
1634f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
164bdad233fSMatthew Knepley   }
1654f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr);
166ef20d060SBarry Smith   if (opt) {
1670b039ecaSBarry Smith     TSMonitorLGCtx ctx;
1683923b477SBarry Smith     PetscInt       howoften = 1;
169ef20d060SBarry Smith 
1700298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);CHKERRQ(ierr);
17122d28d08SBarry Smith     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
1724f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
173ef20d060SBarry Smith   }
174201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr);
175201da799SBarry Smith   if (opt) {
176201da799SBarry Smith     TSMonitorLGCtx ctx;
177201da799SBarry Smith     PetscInt       howoften = 1;
178201da799SBarry Smith 
1790298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
1807f52daa2SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
181201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
182201da799SBarry Smith   }
183201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr);
184201da799SBarry Smith   if (opt) {
185201da799SBarry Smith     TSMonitorLGCtx ctx;
186201da799SBarry Smith     PetscInt       howoften = 1;
187201da799SBarry Smith 
1880298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
1897f52daa2SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
190201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
191201da799SBarry Smith   }
1928189c53fSBarry Smith   ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr);
1938189c53fSBarry Smith   if (opt) {
1948189c53fSBarry Smith     TSMonitorSPEigCtx ctx;
1958189c53fSBarry Smith     PetscInt          howoften = 1;
1968189c53fSBarry Smith 
1970298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr);
19822d28d08SBarry Smith     ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
1998189c53fSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr);
2008189c53fSBarry Smith   }
201ef20d060SBarry Smith   opt  = PETSC_FALSE;
2020dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr);
203a7cc72afSBarry Smith   if (opt) {
20483a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
20583a4ac43SBarry Smith     PetscInt         howoften = 1;
206a80ad3e0SBarry Smith 
2070298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
208ce94432eSBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
20983a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
210bdad233fSMatthew Knepley   }
211fb1732b5SBarry Smith   opt  = PETSC_FALSE;
2129110b2e7SHong Zhang   ierr = PetscOptionsName("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",&opt);CHKERRQ(ierr);
2139110b2e7SHong Zhang   if (opt) {
2149110b2e7SHong Zhang     TSMonitorDrawCtx ctx;
2159110b2e7SHong Zhang     PetscInt         howoften = 1;
2169110b2e7SHong Zhang 
2179110b2e7SHong Zhang     ierr = PetscOptionsInt("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",howoften,&howoften,NULL);CHKERRQ(ierr);
2189110b2e7SHong Zhang     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
2199110b2e7SHong Zhang     ierr = TSAdjointMonitorSet(ts,TSAdjointMonitorDrawSensi,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
2209110b2e7SHong Zhang   }
2219110b2e7SHong Zhang   opt  = PETSC_FALSE;
2222d5ee99bSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr);
2232d5ee99bSBarry Smith   if (opt) {
2242d5ee99bSBarry Smith     TSMonitorDrawCtx ctx;
2252d5ee99bSBarry Smith     PetscReal        bounds[4];
2262d5ee99bSBarry Smith     PetscInt         n = 4;
2272d5ee99bSBarry Smith     PetscDraw        draw;
2282d5ee99bSBarry Smith 
2292d5ee99bSBarry Smith     ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr);
2302d5ee99bSBarry Smith     if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field");
2312d5ee99bSBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,1,&ctx);CHKERRQ(ierr);
2322d5ee99bSBarry Smith     ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr);
2332d5ee99bSBarry Smith     ierr = PetscDrawClear(draw);CHKERRQ(ierr);
2344b363babSBarry Smith     ierr = PetscDrawAxisCreate(draw,&ctx->axis);CHKERRQ(ierr);
2354b363babSBarry Smith     ierr = PetscDrawAxisSetLimits(ctx->axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr);
236f54adfc0SBarry Smith     ierr = PetscDrawAxisSetLabels(ctx->axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr);
2374b363babSBarry Smith     ierr = PetscDrawAxisDraw(ctx->axis);CHKERRQ(ierr);
23807995780SPeter Brune     /* ierr = PetscDrawSetCoordinates(draw,bounds[0],bounds[1],bounds[2],bounds[3]);CHKERRQ(ierr); */
2392d5ee99bSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
2402d5ee99bSBarry Smith   }
2412d5ee99bSBarry Smith   opt  = PETSC_FALSE;
2420dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr);
2433a471f94SBarry Smith   if (opt) {
24483a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
24583a4ac43SBarry Smith     PetscInt         howoften = 1;
2463a471f94SBarry Smith 
2470298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr);
248ce94432eSBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
24983a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
2503a471f94SBarry Smith   }
2513a471f94SBarry Smith   opt  = PETSC_FALSE;
25291b97e58SBarry Smith   ierr = PetscOptionsString("-ts_monitor_solution_binary","Save each solution to a binary file","TSMonitorSolutionBinary",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
253fb1732b5SBarry Smith   if (flg) {
254fb1732b5SBarry Smith     PetscViewer ctx;
255fb1732b5SBarry Smith     if (monfilename[0]) {
256ce94432eSBarry Smith       ierr = PetscViewerBinaryOpen(PetscObjectComm((PetscObject)ts),monfilename,FILE_MODE_WRITE,&ctx);CHKERRQ(ierr);
257c2fbc07fSBarry Smith       ierr = TSMonitorSet(ts,TSMonitorSolutionBinary,ctx,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
258fb1732b5SBarry Smith     } else {
259ce94432eSBarry Smith       ctx = PETSC_VIEWER_BINARY_(PetscObjectComm((PetscObject)ts));
2600298fd71SBarry Smith       ierr = TSMonitorSet(ts,TSMonitorSolutionBinary,ctx,(PetscErrorCode (*)(void**))NULL);CHKERRQ(ierr);
261fb1732b5SBarry Smith     }
262fb1732b5SBarry Smith   }
263ed81e22dSJed Brown   opt  = PETSC_FALSE;
26491b97e58SBarry Smith   ierr = PetscOptionsString("-ts_monitor_solution_vtk","Save each time step to a binary file, use filename-%%03D.vts","TSMonitorSolutionVTK",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
265ed81e22dSJed Brown   if (flg) {
266ed81e22dSJed Brown     const char *ptr,*ptr2;
267ed81e22dSJed Brown     char       *filetemplate;
268ce94432eSBarry Smith     if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
269ed81e22dSJed Brown     /* Do some cursory validation of the input. */
270ed81e22dSJed Brown     ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr);
271ce94432eSBarry Smith     if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
272ed81e22dSJed Brown     for (ptr++; ptr && *ptr; ptr++) {
273ed81e22dSJed Brown       ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr);
274ce94432eSBarry Smith       if (!ptr2 && (*ptr < '0' || '9' < *ptr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Invalid file template argument to -ts_monitor_solution_vtk, should look like filename-%%03D.vts");
275ed81e22dSJed Brown       if (ptr2) break;
276ed81e22dSJed Brown     }
277ed81e22dSJed Brown     ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr);
278ed81e22dSJed Brown     ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr);
279ed81e22dSJed Brown   }
280bdad233fSMatthew Knepley 
281d1212d36SBarry Smith   ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,16,&flg);CHKERRQ(ierr);
282d1212d36SBarry Smith   if (flg) {
283d1212d36SBarry Smith     TSMonitorDMDARayCtx *rayctx;
284d1212d36SBarry Smith     int                  ray = 0;
285d1212d36SBarry Smith     DMDADirection        ddir;
286d1212d36SBarry Smith     DM                   da;
287d1212d36SBarry Smith     PetscMPIInt          rank;
288d1212d36SBarry Smith 
289ce94432eSBarry Smith     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
290d1212d36SBarry Smith     if (dir[0] == 'x') ddir = DMDA_X;
291d1212d36SBarry Smith     else if (dir[0] == 'y') ddir = DMDA_Y;
292ce94432eSBarry Smith     else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
293d1212d36SBarry Smith     sscanf(dir+2,"%d",&ray);
294d1212d36SBarry Smith 
295d1212d36SBarry Smith     ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %D\n",dir[0],ray);CHKERRQ(ierr);
296b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
297d1212d36SBarry Smith     ierr = TSGetDM(ts,&da);CHKERRQ(ierr);
298d1212d36SBarry Smith     ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr);
299ce94432eSBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr);
300d1212d36SBarry Smith     if (!rank) {
301d1212d36SBarry Smith       ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,0,0,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr);
302d1212d36SBarry Smith     }
30351b4a12fSMatthew G. Knepley     rayctx->lgctx = NULL;
304d1212d36SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr);
305d1212d36SBarry Smith   }
30651b4a12fSMatthew G. Knepley   ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,16,&flg);CHKERRQ(ierr);
30751b4a12fSMatthew G. Knepley   if (flg) {
30851b4a12fSMatthew G. Knepley     TSMonitorDMDARayCtx *rayctx;
30951b4a12fSMatthew G. Knepley     int                 ray = 0;
31051b4a12fSMatthew G. Knepley     DMDADirection       ddir;
31151b4a12fSMatthew G. Knepley     DM                  da;
31251b4a12fSMatthew G. Knepley     PetscInt            howoften = 1;
313d1212d36SBarry Smith 
31451b4a12fSMatthew G. Knepley     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir);
31551b4a12fSMatthew G. Knepley     if      (dir[0] == 'x') ddir = DMDA_X;
31651b4a12fSMatthew G. Knepley     else if (dir[0] == 'y') ddir = DMDA_Y;
31751b4a12fSMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir);
31851b4a12fSMatthew G. Knepley     sscanf(dir+2, "%d", &ray);
3191c3436cfSJed Brown 
32051b4a12fSMatthew G. Knepley     ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %D\n", dir[0], ray);CHKERRQ(ierr);
321b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
32251b4a12fSMatthew G. Knepley     ierr = TSGetDM(ts, &da);CHKERRQ(ierr);
32351b4a12fSMatthew G. Knepley     ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr);
32451b4a12fSMatthew G. Knepley     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr);
32551b4a12fSMatthew G. Knepley     ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr);
32651b4a12fSMatthew G. Knepley   }
327a7a1495cSBarry Smith 
328b3d3934dSBarry Smith   ierr = PetscOptionsName("-ts_monitor_envelope","Monitor maximum and minimum value of each component of the solution","TSMonitorEnvelope",&opt);CHKERRQ(ierr);
329b3d3934dSBarry Smith   if (opt) {
330b3d3934dSBarry Smith     TSMonitorEnvelopeCtx ctx;
331b3d3934dSBarry Smith 
332b3d3934dSBarry Smith     ierr = TSMonitorEnvelopeCtxCreate(ts,&ctx);CHKERRQ(ierr);
333b3d3934dSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorEnvelope,ctx,(PetscErrorCode (*)(void**))TSMonitorEnvelopeCtxDestroy);CHKERRQ(ierr);
334b3d3934dSBarry Smith   }
335b3d3934dSBarry Smith 
336847ff0e1SMatthew G. Knepley   flg  = PETSC_FALSE;
337847ff0e1SMatthew G. Knepley   ierr = PetscOptionsBool("-ts_fd_color", "Use finite differences with coloring to compute IJacobian", "TSComputeJacobianDefaultColor", flg, &flg, NULL);CHKERRQ(ierr);
338847ff0e1SMatthew G. Knepley   if (flg) {
339847ff0e1SMatthew G. Knepley     DM   dm;
340847ff0e1SMatthew G. Knepley     DMTS tdm;
341847ff0e1SMatthew G. Knepley 
342847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
343847ff0e1SMatthew G. Knepley     ierr = DMGetDMTS(dm, &tdm);CHKERRQ(ierr);
344847ff0e1SMatthew G. Knepley     tdm->ijacobianctx = NULL;
345847ff0e1SMatthew G. Knepley     ierr = TSSetIJacobian(ts, NULL, NULL, TSComputeIJacobianDefaultColor, 0);CHKERRQ(ierr);
346847ff0e1SMatthew G. Knepley     ierr = PetscInfo(ts, "Setting default finite difference coloring Jacobian matrix\n");CHKERRQ(ierr);
347847ff0e1SMatthew G. Knepley   }
348847ff0e1SMatthew G. Knepley 
349110eb670SHong Zhang   ierr = PetscOptionsString("-ts_adjoint_monitor","Monitor adjoint timestep size","TSAdjointMonitorDefault","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
350110eb670SHong Zhang   if (flg) {
351110eb670SHong Zhang     ierr = PetscViewerASCIIOpen(PetscObjectComm((PetscObject)ts),monfilename,&monviewer);CHKERRQ(ierr);
352110eb670SHong Zhang     ierr = TSAdjointMonitorSet(ts,TSAdjointMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
353110eb670SHong Zhang   }
354110eb670SHong Zhang 
3557781c08eSBarry Smith   /*
3567781c08eSBarry Smith      This code is all wrong. One is creating objects inside the TSSetFromOptions() so if run with the options gui
3577781c08eSBarry Smith      will bleed memory. Also one is using a PetscOptionsBegin() inside a PetscOptionsBegin()
3587781c08eSBarry Smith   */
359552698daSJed Brown   ierr = TSGetAdapt(ts,&adapt);CHKERRQ(ierr);
360e55864a3SBarry Smith   ierr = TSAdaptSetFromOptions(PetscOptionsObject,adapt);CHKERRQ(ierr);
361d763cef2SBarry Smith 
362d763cef2SBarry Smith     /* Handle specific TS options */
363d763cef2SBarry Smith   if (ts->ops->setfromoptions) {
3646991f827SBarry Smith     ierr = (*ts->ops->setfromoptions)(PetscOptionsObject,ts);CHKERRQ(ierr);
365d763cef2SBarry Smith   }
3666991f827SBarry Smith   ierr = PetscOptionsEnd();CHKERRQ(ierr);
367d763cef2SBarry Smith 
368d763cef2SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
369d763cef2SBarry Smith   ierr = PetscObjectProcessOptionsHandlers((PetscObject)ts);CHKERRQ(ierr);
370d763cef2SBarry Smith 
371bc952696SBarry Smith   if (ts->trajectory) {
372bc952696SBarry Smith     ierr = TSTrajectorySetFromOptions(ts->trajectory);CHKERRQ(ierr);
373bc952696SBarry Smith   }
374bc952696SBarry Smith 
3756991f827SBarry Smith   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3766991f827SBarry Smith   if (snes) {
3776991f827SBarry Smith     if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);}
37849c41c37SLisandro Dalcin     ierr = SNESSetFromOptions(snes);CHKERRQ(ierr);
379d763cef2SBarry Smith   }
380d763cef2SBarry Smith   PetscFunctionReturn(0);
381d763cef2SBarry Smith }
382d763cef2SBarry Smith 
383d763cef2SBarry Smith #undef __FUNCT__
384bc952696SBarry Smith #define __FUNCT__ "TSSetSaveTrajectory"
385d2daff3dSHong Zhang /*@
386bc952696SBarry Smith    TSSetSaveTrajectory - Causes the TS to save its solutions as it iterates forward in time in a TSTrajectory object
387d2daff3dSHong Zhang 
388d2daff3dSHong Zhang    Collective on TS
389d2daff3dSHong Zhang 
390d2daff3dSHong Zhang    Input Parameters:
391bc952696SBarry Smith .  ts - the TS context obtained from TSCreate()
392bc952696SBarry Smith 
393d2daff3dSHong Zhang 
394d2daff3dSHong Zhang    Level: intermediate
395d2daff3dSHong Zhang 
396bc952696SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve()
397d2daff3dSHong Zhang 
398bc952696SBarry Smith .keywords: TS, set, checkpoint,
399d2daff3dSHong Zhang @*/
400bc952696SBarry Smith PetscErrorCode  TSSetSaveTrajectory(TS ts)
401d2daff3dSHong Zhang {
402bc952696SBarry Smith   PetscErrorCode ierr;
403bc952696SBarry Smith 
404d2daff3dSHong Zhang   PetscFunctionBegin;
405d2daff3dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
406bc952696SBarry Smith   if (!ts->trajectory) {
407bc952696SBarry Smith     ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr);
408920aabf2SBarry Smith     ierr = TSTrajectorySetType(ts->trajectory,TSTRAJECTORYBASIC);CHKERRQ(ierr);
409648b50deSBarry Smith     ierr = TSTrajectorySetFromOptions(ts->trajectory);CHKERRQ(ierr);
410bc952696SBarry Smith   }
411d2daff3dSHong Zhang   PetscFunctionReturn(0);
412d2daff3dSHong Zhang }
413d2daff3dSHong Zhang 
414a7a1495cSBarry Smith #undef __FUNCT__
415a7a1495cSBarry Smith #define __FUNCT__ "TSComputeRHSJacobian"
416a7a1495cSBarry Smith /*@
417a7a1495cSBarry Smith    TSComputeRHSJacobian - Computes the Jacobian matrix that has been
418a7a1495cSBarry Smith       set with TSSetRHSJacobian().
419a7a1495cSBarry Smith 
420a7a1495cSBarry Smith    Collective on TS and Vec
421a7a1495cSBarry Smith 
422a7a1495cSBarry Smith    Input Parameters:
423316643e7SJed Brown +  ts - the TS context
424a7a1495cSBarry Smith .  t - current timestep
4250910c330SBarry Smith -  U - input vector
426a7a1495cSBarry Smith 
427a7a1495cSBarry Smith    Output Parameters:
428a7a1495cSBarry Smith +  A - Jacobian matrix
429a7a1495cSBarry Smith .  B - optional preconditioning matrix
430a7a1495cSBarry Smith -  flag - flag indicating matrix structure
431a7a1495cSBarry Smith 
432a7a1495cSBarry Smith    Notes:
433a7a1495cSBarry Smith    Most users should not need to explicitly call this routine, as it
434a7a1495cSBarry Smith    is used internally within the nonlinear solvers.
435a7a1495cSBarry Smith 
43694b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the
437a7a1495cSBarry Smith    flag parameter.
438a7a1495cSBarry Smith 
439a7a1495cSBarry Smith    Level: developer
440a7a1495cSBarry Smith 
441a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix
442a7a1495cSBarry Smith 
44394b7f48cSBarry Smith .seealso:  TSSetRHSJacobian(), KSPSetOperators()
444a7a1495cSBarry Smith @*/
445d1e9a80fSBarry Smith PetscErrorCode  TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B)
446a7a1495cSBarry Smith {
447dfbe8321SBarry Smith   PetscErrorCode ierr;
448270bf2e7SJed Brown   PetscObjectState Ustate;
44924989b8cSPeter Brune   DM             dm;
450942e3340SBarry Smith   DMTS           tsdm;
45124989b8cSPeter Brune   TSRHSJacobian  rhsjacobianfunc;
45224989b8cSPeter Brune   void           *ctx;
45324989b8cSPeter Brune   TSIJacobian    ijacobianfunc;
454b2df71adSDebojyoti Ghosh   TSRHSFunction  rhsfunction;
455a7a1495cSBarry Smith 
456a7a1495cSBarry Smith   PetscFunctionBegin;
4570700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4580910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
4590910c330SBarry Smith   PetscCheckSameComm(ts,1,U,3);
46024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
461942e3340SBarry Smith   ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr);
46224989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr);
4630298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr);
464b2df71adSDebojyoti Ghosh   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
46559e4f3c8SBarry Smith   ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr);
466b2df71adSDebojyoti Ghosh   if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.X == U && ts->rhsjacobian.Xstate == Ustate)) && (rhsfunction != TSComputeRHSFunctionLinear)) {
4670e4ef248SJed Brown     PetscFunctionReturn(0);
468f8ede8e7SJed Brown   }
469d90be118SSean Farley 
470ce94432eSBarry Smith   if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
471d90be118SSean Farley 
472e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
47394ab13aaSBarry Smith     ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr);
47494ab13aaSBarry Smith     ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
47594ab13aaSBarry Smith     if (A != B) {
47694ab13aaSBarry Smith       ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr);
47794ab13aaSBarry Smith       ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
478e1244c69SJed Brown     }
479e1244c69SJed Brown     ts->rhsjacobian.shift = 0;
480e1244c69SJed Brown     ts->rhsjacobian.scale = 1.;
481e1244c69SJed Brown   }
482e1244c69SJed Brown 
48324989b8cSPeter Brune   if (rhsjacobianfunc) {
48494ab13aaSBarry Smith     ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
485a7a1495cSBarry Smith     PetscStackPush("TS user Jacobian function");
486d1e9a80fSBarry Smith     ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr);
487a7a1495cSBarry Smith     PetscStackPop;
48894ab13aaSBarry Smith     ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
489a7a1495cSBarry Smith     /* make sure user returned a correct Jacobian and preconditioner */
49094ab13aaSBarry Smith     PetscValidHeaderSpecific(A,MAT_CLASSID,4);
49194ab13aaSBarry Smith     PetscValidHeaderSpecific(B,MAT_CLASSID,5);
492ef66eb69SBarry Smith   } else {
49394ab13aaSBarry Smith     ierr = MatZeroEntries(A);CHKERRQ(ierr);
49494ab13aaSBarry Smith     if (A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);}
495ef66eb69SBarry Smith   }
4960e4ef248SJed Brown   ts->rhsjacobian.time       = t;
4970910c330SBarry Smith   ts->rhsjacobian.X          = U;
49859e4f3c8SBarry Smith   ierr                       = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr);
499a7a1495cSBarry Smith   PetscFunctionReturn(0);
500a7a1495cSBarry Smith }
501a7a1495cSBarry Smith 
5024a2ae208SSatish Balay #undef __FUNCT__
5034a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSFunction"
504316643e7SJed Brown /*@
505d763cef2SBarry Smith    TSComputeRHSFunction - Evaluates the right-hand-side function.
506d763cef2SBarry Smith 
507316643e7SJed Brown    Collective on TS and Vec
508316643e7SJed Brown 
509316643e7SJed Brown    Input Parameters:
510316643e7SJed Brown +  ts - the TS context
511316643e7SJed Brown .  t - current time
5120910c330SBarry Smith -  U - state vector
513316643e7SJed Brown 
514316643e7SJed Brown    Output Parameter:
515316643e7SJed Brown .  y - right hand side
516316643e7SJed Brown 
517316643e7SJed Brown    Note:
518316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
519316643e7SJed Brown    is used internally within the nonlinear solvers.
520316643e7SJed Brown 
521316643e7SJed Brown    Level: developer
522316643e7SJed Brown 
523316643e7SJed Brown .keywords: TS, compute
524316643e7SJed Brown 
525316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction()
526316643e7SJed Brown @*/
5270910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y)
528d763cef2SBarry Smith {
529dfbe8321SBarry Smith   PetscErrorCode ierr;
53024989b8cSPeter Brune   TSRHSFunction  rhsfunction;
53124989b8cSPeter Brune   TSIFunction    ifunction;
53224989b8cSPeter Brune   void           *ctx;
53324989b8cSPeter Brune   DM             dm;
53424989b8cSPeter Brune 
535d763cef2SBarry Smith   PetscFunctionBegin;
5360700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5370910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
5380700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,4);
53924989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
54024989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
5410298fd71SBarry Smith   ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr);
542d763cef2SBarry Smith 
543ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
544d763cef2SBarry Smith 
5450910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
54624989b8cSPeter Brune   if (rhsfunction) {
547d763cef2SBarry Smith     PetscStackPush("TS user right-hand-side function");
5480910c330SBarry Smith     ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr);
549d763cef2SBarry Smith     PetscStackPop;
550214bc6a2SJed Brown   } else {
551214bc6a2SJed Brown     ierr = VecZeroEntries(y);CHKERRQ(ierr);
552b2cd27e8SJed Brown   }
55344a41b28SSean Farley 
5540910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
555d763cef2SBarry Smith   PetscFunctionReturn(0);
556d763cef2SBarry Smith }
557d763cef2SBarry Smith 
5584a2ae208SSatish Balay #undef __FUNCT__
559ef20d060SBarry Smith #define __FUNCT__ "TSComputeSolutionFunction"
560ef20d060SBarry Smith /*@
561ef20d060SBarry Smith    TSComputeSolutionFunction - Evaluates the solution function.
562ef20d060SBarry Smith 
563ef20d060SBarry Smith    Collective on TS and Vec
564ef20d060SBarry Smith 
565ef20d060SBarry Smith    Input Parameters:
566ef20d060SBarry Smith +  ts - the TS context
567ef20d060SBarry Smith -  t - current time
568ef20d060SBarry Smith 
569ef20d060SBarry Smith    Output Parameter:
5700910c330SBarry Smith .  U - the solution
571ef20d060SBarry Smith 
572ef20d060SBarry Smith    Note:
573ef20d060SBarry Smith    Most users should not need to explicitly call this routine, as it
574ef20d060SBarry Smith    is used internally within the nonlinear solvers.
575ef20d060SBarry Smith 
576ef20d060SBarry Smith    Level: developer
577ef20d060SBarry Smith 
578ef20d060SBarry Smith .keywords: TS, compute
579ef20d060SBarry Smith 
580abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
581ef20d060SBarry Smith @*/
5820910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U)
583ef20d060SBarry Smith {
584ef20d060SBarry Smith   PetscErrorCode     ierr;
585ef20d060SBarry Smith   TSSolutionFunction solutionfunction;
586ef20d060SBarry Smith   void               *ctx;
587ef20d060SBarry Smith   DM                 dm;
588ef20d060SBarry Smith 
589ef20d060SBarry Smith   PetscFunctionBegin;
590ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5910910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
592ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
593ef20d060SBarry Smith   ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr);
594ef20d060SBarry Smith 
595ef20d060SBarry Smith   if (solutionfunction) {
5969b7cd975SBarry Smith     PetscStackPush("TS user solution function");
5970910c330SBarry Smith     ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr);
598ef20d060SBarry Smith     PetscStackPop;
599ef20d060SBarry Smith   }
600ef20d060SBarry Smith   PetscFunctionReturn(0);
601ef20d060SBarry Smith }
6029b7cd975SBarry Smith #undef __FUNCT__
6039b7cd975SBarry Smith #define __FUNCT__ "TSComputeForcingFunction"
6049b7cd975SBarry Smith /*@
6059b7cd975SBarry Smith    TSComputeForcingFunction - Evaluates the forcing function.
6069b7cd975SBarry Smith 
6079b7cd975SBarry Smith    Collective on TS and Vec
6089b7cd975SBarry Smith 
6099b7cd975SBarry Smith    Input Parameters:
6109b7cd975SBarry Smith +  ts - the TS context
6119b7cd975SBarry Smith -  t - current time
6129b7cd975SBarry Smith 
6139b7cd975SBarry Smith    Output Parameter:
6149b7cd975SBarry Smith .  U - the function value
6159b7cd975SBarry Smith 
6169b7cd975SBarry Smith    Note:
6179b7cd975SBarry Smith    Most users should not need to explicitly call this routine, as it
6189b7cd975SBarry Smith    is used internally within the nonlinear solvers.
6199b7cd975SBarry Smith 
6209b7cd975SBarry Smith    Level: developer
6219b7cd975SBarry Smith 
6229b7cd975SBarry Smith .keywords: TS, compute
6239b7cd975SBarry Smith 
6249b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
6259b7cd975SBarry Smith @*/
6269b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U)
6279b7cd975SBarry Smith {
6289b7cd975SBarry Smith   PetscErrorCode     ierr, (*forcing)(TS,PetscReal,Vec,void*);
6299b7cd975SBarry Smith   void               *ctx;
6309b7cd975SBarry Smith   DM                 dm;
6319b7cd975SBarry Smith 
6329b7cd975SBarry Smith   PetscFunctionBegin;
6339b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6349b7cd975SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
6359b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
6369b7cd975SBarry Smith   ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr);
6379b7cd975SBarry Smith 
6389b7cd975SBarry Smith   if (forcing) {
6399b7cd975SBarry Smith     PetscStackPush("TS user forcing function");
6409b7cd975SBarry Smith     ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr);
6419b7cd975SBarry Smith     PetscStackPop;
6429b7cd975SBarry Smith   }
6439b7cd975SBarry Smith   PetscFunctionReturn(0);
6449b7cd975SBarry Smith }
645ef20d060SBarry Smith 
646ef20d060SBarry Smith #undef __FUNCT__
647214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSVec_Private"
648214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs)
649214bc6a2SJed Brown {
6502dd45cf8SJed Brown   Vec            F;
651214bc6a2SJed Brown   PetscErrorCode ierr;
652214bc6a2SJed Brown 
653214bc6a2SJed Brown   PetscFunctionBegin;
6540298fd71SBarry Smith   *Frhs = NULL;
6550298fd71SBarry Smith   ierr  = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr);
656214bc6a2SJed Brown   if (!ts->Frhs) {
6572dd45cf8SJed Brown     ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr);
658214bc6a2SJed Brown   }
659214bc6a2SJed Brown   *Frhs = ts->Frhs;
660214bc6a2SJed Brown   PetscFunctionReturn(0);
661214bc6a2SJed Brown }
662214bc6a2SJed Brown 
663214bc6a2SJed Brown #undef __FUNCT__
664214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSMats_Private"
665214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs)
666214bc6a2SJed Brown {
667214bc6a2SJed Brown   Mat            A,B;
6682dd45cf8SJed Brown   PetscErrorCode ierr;
669214bc6a2SJed Brown 
670214bc6a2SJed Brown   PetscFunctionBegin;
671c0cd0301SJed Brown   if (Arhs) *Arhs = NULL;
672c0cd0301SJed Brown   if (Brhs) *Brhs = NULL;
6730298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
674214bc6a2SJed Brown   if (Arhs) {
675214bc6a2SJed Brown     if (!ts->Arhs) {
676214bc6a2SJed Brown       ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr);
677214bc6a2SJed Brown     }
678214bc6a2SJed Brown     *Arhs = ts->Arhs;
679214bc6a2SJed Brown   }
680214bc6a2SJed Brown   if (Brhs) {
681214bc6a2SJed Brown     if (!ts->Brhs) {
682bdb70873SJed Brown       if (A != B) {
683214bc6a2SJed Brown         ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr);
684bdb70873SJed Brown       } else {
685bdb70873SJed Brown         ts->Brhs = ts->Arhs;
686bdb70873SJed Brown         ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr);
687bdb70873SJed Brown       }
688214bc6a2SJed Brown     }
689214bc6a2SJed Brown     *Brhs = ts->Brhs;
690214bc6a2SJed Brown   }
691214bc6a2SJed Brown   PetscFunctionReturn(0);
692214bc6a2SJed Brown }
693214bc6a2SJed Brown 
694214bc6a2SJed Brown #undef __FUNCT__
695316643e7SJed Brown #define __FUNCT__ "TSComputeIFunction"
696316643e7SJed Brown /*@
6970910c330SBarry Smith    TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0
698316643e7SJed Brown 
699316643e7SJed Brown    Collective on TS and Vec
700316643e7SJed Brown 
701316643e7SJed Brown    Input Parameters:
702316643e7SJed Brown +  ts - the TS context
703316643e7SJed Brown .  t - current time
7040910c330SBarry Smith .  U - state vector
7050910c330SBarry Smith .  Udot - time derivative of state vector
706214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate
707316643e7SJed Brown 
708316643e7SJed Brown    Output Parameter:
709316643e7SJed Brown .  Y - right hand side
710316643e7SJed Brown 
711316643e7SJed Brown    Note:
712316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
713316643e7SJed Brown    is used internally within the nonlinear solvers.
714316643e7SJed Brown 
715316643e7SJed Brown    If the user did did not write their equations in implicit form, this
716316643e7SJed Brown    function recasts them in implicit form.
717316643e7SJed Brown 
718316643e7SJed Brown    Level: developer
719316643e7SJed Brown 
720316643e7SJed Brown .keywords: TS, compute
721316643e7SJed Brown 
722316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction()
723316643e7SJed Brown @*/
7240910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex)
725316643e7SJed Brown {
726316643e7SJed Brown   PetscErrorCode ierr;
72724989b8cSPeter Brune   TSIFunction    ifunction;
72824989b8cSPeter Brune   TSRHSFunction  rhsfunction;
72924989b8cSPeter Brune   void           *ctx;
73024989b8cSPeter Brune   DM             dm;
731316643e7SJed Brown 
732316643e7SJed Brown   PetscFunctionBegin;
7330700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7340910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
7350910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
7360700a824SBarry Smith   PetscValidHeaderSpecific(Y,VEC_CLASSID,5);
737316643e7SJed Brown 
73824989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
73924989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr);
7400298fd71SBarry Smith   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
74124989b8cSPeter Brune 
742ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
743d90be118SSean Farley 
7440910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
74524989b8cSPeter Brune   if (ifunction) {
746316643e7SJed Brown     PetscStackPush("TS user implicit function");
7470910c330SBarry Smith     ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr);
748316643e7SJed Brown     PetscStackPop;
749214bc6a2SJed Brown   }
750214bc6a2SJed Brown   if (imex) {
75124989b8cSPeter Brune     if (!ifunction) {
7520910c330SBarry Smith       ierr = VecCopy(Udot,Y);CHKERRQ(ierr);
7532dd45cf8SJed Brown     }
75424989b8cSPeter Brune   } else if (rhsfunction) {
75524989b8cSPeter Brune     if (ifunction) {
756214bc6a2SJed Brown       Vec Frhs;
757214bc6a2SJed Brown       ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
7580910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
759214bc6a2SJed Brown       ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr);
7602dd45cf8SJed Brown     } else {
7610910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr);
7620910c330SBarry Smith       ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr);
763316643e7SJed Brown     }
7644a6899ffSJed Brown   }
7650910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
766316643e7SJed Brown   PetscFunctionReturn(0);
767316643e7SJed Brown }
768316643e7SJed Brown 
769316643e7SJed Brown #undef __FUNCT__
770316643e7SJed Brown #define __FUNCT__ "TSComputeIJacobian"
771316643e7SJed Brown /*@
772316643e7SJed Brown    TSComputeIJacobian - Evaluates the Jacobian of the DAE
773316643e7SJed Brown 
774316643e7SJed Brown    Collective on TS and Vec
775316643e7SJed Brown 
776316643e7SJed Brown    Input
777316643e7SJed Brown       Input Parameters:
778316643e7SJed Brown +  ts - the TS context
779316643e7SJed Brown .  t - current timestep
7800910c330SBarry Smith .  U - state vector
7810910c330SBarry Smith .  Udot - time derivative of state vector
782214bc6a2SJed Brown .  shift - shift to apply, see note below
783214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate
784316643e7SJed Brown 
785316643e7SJed Brown    Output Parameters:
786316643e7SJed Brown +  A - Jacobian matrix
787316643e7SJed Brown .  B - optional preconditioning matrix
788316643e7SJed Brown -  flag - flag indicating matrix structure
789316643e7SJed Brown 
790316643e7SJed Brown    Notes:
7910910c330SBarry Smith    If F(t,U,Udot)=0 is the DAE, the required Jacobian is
792316643e7SJed Brown 
7930910c330SBarry Smith    dF/dU + shift*dF/dUdot
794316643e7SJed Brown 
795316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
796316643e7SJed Brown    is used internally within the nonlinear solvers.
797316643e7SJed Brown 
798316643e7SJed Brown    Level: developer
799316643e7SJed Brown 
800316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix
801316643e7SJed Brown 
802316643e7SJed Brown .seealso:  TSSetIJacobian()
80363495f91SJed Brown @*/
804d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex)
805316643e7SJed Brown {
806316643e7SJed Brown   PetscErrorCode ierr;
80724989b8cSPeter Brune   TSIJacobian    ijacobian;
80824989b8cSPeter Brune   TSRHSJacobian  rhsjacobian;
80924989b8cSPeter Brune   DM             dm;
81024989b8cSPeter Brune   void           *ctx;
811316643e7SJed Brown 
812316643e7SJed Brown   PetscFunctionBegin;
8130700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
8140910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
8150910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
816316643e7SJed Brown   PetscValidPointer(A,6);
81794ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,6);
818316643e7SJed Brown   PetscValidPointer(B,7);
81994ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,7);
82024989b8cSPeter Brune 
82124989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
82224989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr);
8230298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
82424989b8cSPeter Brune 
825ce94432eSBarry Smith   if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
826316643e7SJed Brown 
82794ab13aaSBarry Smith   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
82824989b8cSPeter Brune   if (ijacobian) {
829316643e7SJed Brown     PetscStackPush("TS user implicit Jacobian");
830d1e9a80fSBarry Smith     ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr);
831316643e7SJed Brown     PetscStackPop;
832214bc6a2SJed Brown     /* make sure user returned a correct Jacobian and preconditioner */
83394ab13aaSBarry Smith     PetscValidHeaderSpecific(A,MAT_CLASSID,4);
83494ab13aaSBarry Smith     PetscValidHeaderSpecific(B,MAT_CLASSID,5);
8354a6899ffSJed Brown   }
836214bc6a2SJed Brown   if (imex) {
837b5abc632SBarry Smith     if (!ijacobian) {  /* system was written as Udot = G(t,U) */
83894ab13aaSBarry Smith       ierr = MatZeroEntries(A);CHKERRQ(ierr);
83994ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
84094ab13aaSBarry Smith       if (A != B) {
84194ab13aaSBarry Smith         ierr = MatZeroEntries(B);CHKERRQ(ierr);
84294ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
843214bc6a2SJed Brown       }
844214bc6a2SJed Brown     }
845214bc6a2SJed Brown   } else {
846e1244c69SJed Brown     Mat Arhs = NULL,Brhs = NULL;
847e1244c69SJed Brown     if (rhsjacobian) {
848bd373395SBarry Smith       if (ijacobian) {
849214bc6a2SJed Brown         ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
850bd373395SBarry Smith       } else {
851bd373395SBarry Smith         ierr = TSGetIJacobian(ts,&Arhs,&Brhs,NULL,NULL);CHKERRQ(ierr);
852214bc6a2SJed Brown       }
853d1e9a80fSBarry Smith       ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
854e1244c69SJed Brown     }
85594ab13aaSBarry Smith     if (Arhs == A) {           /* No IJacobian, so we only have the RHS matrix */
856e1244c69SJed Brown       ts->rhsjacobian.scale = -1;
857e1244c69SJed Brown       ts->rhsjacobian.shift = shift;
85894ab13aaSBarry Smith       ierr = MatScale(A,-1);CHKERRQ(ierr);
85994ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
86094ab13aaSBarry Smith       if (A != B) {
86194ab13aaSBarry Smith         ierr = MatScale(B,-1);CHKERRQ(ierr);
86294ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
863316643e7SJed Brown       }
864e1244c69SJed Brown     } else if (Arhs) {          /* Both IJacobian and RHSJacobian */
865e1244c69SJed Brown       MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
866e1244c69SJed Brown       if (!ijacobian) {         /* No IJacobian provided, but we have a separate RHS matrix */
86794ab13aaSBarry Smith         ierr = MatZeroEntries(A);CHKERRQ(ierr);
86894ab13aaSBarry Smith         ierr = MatShift(A,shift);CHKERRQ(ierr);
86994ab13aaSBarry Smith         if (A != B) {
87094ab13aaSBarry Smith           ierr = MatZeroEntries(B);CHKERRQ(ierr);
87194ab13aaSBarry Smith           ierr = MatShift(B,shift);CHKERRQ(ierr);
872214bc6a2SJed Brown         }
873316643e7SJed Brown       }
87494ab13aaSBarry Smith       ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr);
87594ab13aaSBarry Smith       if (A != B) {
87694ab13aaSBarry Smith         ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr);
877316643e7SJed Brown       }
878316643e7SJed Brown     }
879316643e7SJed Brown   }
88094ab13aaSBarry Smith   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
881316643e7SJed Brown   PetscFunctionReturn(0);
882316643e7SJed Brown }
883316643e7SJed Brown 
884316643e7SJed Brown #undef __FUNCT__
8854a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSFunction"
886d763cef2SBarry Smith /*@C
887d763cef2SBarry Smith     TSSetRHSFunction - Sets the routine for evaluating the function,
888b5abc632SBarry Smith     where U_t = G(t,u).
889d763cef2SBarry Smith 
8903f9fe445SBarry Smith     Logically Collective on TS
891d763cef2SBarry Smith 
892d763cef2SBarry Smith     Input Parameters:
893d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
8940298fd71SBarry Smith .   r - vector to put the computed right hand side (or NULL to have it created)
895d763cef2SBarry Smith .   f - routine for evaluating the right-hand-side function
896d763cef2SBarry Smith -   ctx - [optional] user-defined context for private data for the
8970298fd71SBarry Smith           function evaluation routine (may be NULL)
898d763cef2SBarry Smith 
899d763cef2SBarry Smith     Calling sequence of func:
90087828ca2SBarry Smith $     func (TS ts,PetscReal t,Vec u,Vec F,void *ctx);
901d763cef2SBarry Smith 
902d763cef2SBarry Smith +   t - current timestep
903d763cef2SBarry Smith .   u - input vector
904d763cef2SBarry Smith .   F - function vector
905d763cef2SBarry Smith -   ctx - [optional] user-defined function context
906d763cef2SBarry Smith 
907d763cef2SBarry Smith     Level: beginner
908d763cef2SBarry Smith 
9092bbac0d3SBarry Smith     Notes: You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE.
9102bbac0d3SBarry Smith 
911d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
912d763cef2SBarry Smith 
913ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction()
914d763cef2SBarry Smith @*/
915089b2837SJed Brown PetscErrorCode  TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx)
916d763cef2SBarry Smith {
917089b2837SJed Brown   PetscErrorCode ierr;
918089b2837SJed Brown   SNES           snes;
9190298fd71SBarry Smith   Vec            ralloc = NULL;
92024989b8cSPeter Brune   DM             dm;
921d763cef2SBarry Smith 
922089b2837SJed Brown   PetscFunctionBegin;
9230700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
924ca94891dSJed Brown   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
92524989b8cSPeter Brune 
92624989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
92724989b8cSPeter Brune   ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr);
928089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
929e856ceecSJed Brown   if (!r && !ts->dm && ts->vec_sol) {
930e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
931e856ceecSJed Brown     r    = ralloc;
932e856ceecSJed Brown   }
933089b2837SJed Brown   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
934e856ceecSJed Brown   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
935d763cef2SBarry Smith   PetscFunctionReturn(0);
936d763cef2SBarry Smith }
937d763cef2SBarry Smith 
9384a2ae208SSatish Balay #undef __FUNCT__
939ef20d060SBarry Smith #define __FUNCT__ "TSSetSolutionFunction"
940ef20d060SBarry Smith /*@C
941abd5a294SJed Brown     TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE
942ef20d060SBarry Smith 
943ef20d060SBarry Smith     Logically Collective on TS
944ef20d060SBarry Smith 
945ef20d060SBarry Smith     Input Parameters:
946ef20d060SBarry Smith +   ts - the TS context obtained from TSCreate()
947ef20d060SBarry Smith .   f - routine for evaluating the solution
948ef20d060SBarry Smith -   ctx - [optional] user-defined context for private data for the
9490298fd71SBarry Smith           function evaluation routine (may be NULL)
950ef20d060SBarry Smith 
951ef20d060SBarry Smith     Calling sequence of func:
952ef20d060SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
953ef20d060SBarry Smith 
954ef20d060SBarry Smith +   t - current timestep
955ef20d060SBarry Smith .   u - output vector
956ef20d060SBarry Smith -   ctx - [optional] user-defined function context
957ef20d060SBarry Smith 
958abd5a294SJed Brown     Notes:
959abd5a294SJed Brown     This routine is used for testing accuracy of time integration schemes when you already know the solution.
960abd5a294SJed Brown     If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to
961abd5a294SJed Brown     create closed-form solutions with non-physical forcing terms.
962abd5a294SJed Brown 
9634f09c107SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
964abd5a294SJed Brown 
965ef20d060SBarry Smith     Level: beginner
966ef20d060SBarry Smith 
967ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
968ef20d060SBarry Smith 
9699b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction()
970ef20d060SBarry Smith @*/
971ef20d060SBarry Smith PetscErrorCode  TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
972ef20d060SBarry Smith {
973ef20d060SBarry Smith   PetscErrorCode ierr;
974ef20d060SBarry Smith   DM             dm;
975ef20d060SBarry Smith 
976ef20d060SBarry Smith   PetscFunctionBegin;
977ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
978ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
979ef20d060SBarry Smith   ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr);
980ef20d060SBarry Smith   PetscFunctionReturn(0);
981ef20d060SBarry Smith }
982ef20d060SBarry Smith 
983ef20d060SBarry Smith #undef __FUNCT__
9849b7cd975SBarry Smith #define __FUNCT__ "TSSetForcingFunction"
9859b7cd975SBarry Smith /*@C
9869b7cd975SBarry Smith     TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE
9879b7cd975SBarry Smith 
9889b7cd975SBarry Smith     Logically Collective on TS
9899b7cd975SBarry Smith 
9909b7cd975SBarry Smith     Input Parameters:
9919b7cd975SBarry Smith +   ts - the TS context obtained from TSCreate()
9929b7cd975SBarry Smith .   f - routine for evaluating the forcing function
9939b7cd975SBarry Smith -   ctx - [optional] user-defined context for private data for the
9940298fd71SBarry Smith           function evaluation routine (may be NULL)
9959b7cd975SBarry Smith 
9969b7cd975SBarry Smith     Calling sequence of func:
9979b7cd975SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
9989b7cd975SBarry Smith 
9999b7cd975SBarry Smith +   t - current timestep
10009b7cd975SBarry Smith .   u - output vector
10019b7cd975SBarry Smith -   ctx - [optional] user-defined function context
10029b7cd975SBarry Smith 
10039b7cd975SBarry Smith     Notes:
10049b7cd975SBarry Smith     This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to
10059b7cd975SBarry Smith     create closed-form solutions with a non-physical forcing term.
10069b7cd975SBarry Smith 
10079b7cd975SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
10089b7cd975SBarry Smith 
10099b7cd975SBarry Smith     Level: beginner
10109b7cd975SBarry Smith 
10119b7cd975SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
10129b7cd975SBarry Smith 
10139b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction()
10149b7cd975SBarry Smith @*/
10159b7cd975SBarry Smith PetscErrorCode  TSSetForcingFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
10169b7cd975SBarry Smith {
10179b7cd975SBarry Smith   PetscErrorCode ierr;
10189b7cd975SBarry Smith   DM             dm;
10199b7cd975SBarry Smith 
10209b7cd975SBarry Smith   PetscFunctionBegin;
10219b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
10229b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
10239b7cd975SBarry Smith   ierr = DMTSSetForcingFunction(dm,f,ctx);CHKERRQ(ierr);
10249b7cd975SBarry Smith   PetscFunctionReturn(0);
10259b7cd975SBarry Smith }
10269b7cd975SBarry Smith 
10279b7cd975SBarry Smith #undef __FUNCT__
10284a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSJacobian"
1029d763cef2SBarry Smith /*@C
1030f7ab8db6SBarry Smith    TSSetRHSJacobian - Sets the function to compute the Jacobian of G,
1031b5abc632SBarry Smith    where U_t = G(U,t), as well as the location to store the matrix.
1032d763cef2SBarry Smith 
10333f9fe445SBarry Smith    Logically Collective on TS
1034d763cef2SBarry Smith 
1035d763cef2SBarry Smith    Input Parameters:
1036d763cef2SBarry Smith +  ts  - the TS context obtained from TSCreate()
1037e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1038e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1039d763cef2SBarry Smith .  f   - the Jacobian evaluation routine
1040d763cef2SBarry Smith -  ctx - [optional] user-defined context for private data for the
10410298fd71SBarry Smith          Jacobian evaluation routine (may be NULL)
1042d763cef2SBarry Smith 
1043f7ab8db6SBarry Smith    Calling sequence of f:
1044ae8867d6SBarry Smith $     func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx);
1045d763cef2SBarry Smith 
1046d763cef2SBarry Smith +  t - current timestep
1047d763cef2SBarry Smith .  u - input vector
1048e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1049e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1050d763cef2SBarry Smith -  ctx - [optional] user-defined context for matrix evaluation routine
1051d763cef2SBarry Smith 
1052*ca5f011dSBarry Smith    Notes: The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1053*ca5f011dSBarry Smith           You should not assume the values are the same in the next call to f() as you set them in the previous call.
1054d763cef2SBarry Smith 
1055d763cef2SBarry Smith    Level: beginner
1056d763cef2SBarry Smith 
1057d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian
1058d763cef2SBarry Smith 
1059ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian()
1060d763cef2SBarry Smith 
1061d763cef2SBarry Smith @*/
1062e5d3d808SBarry Smith PetscErrorCode  TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx)
1063d763cef2SBarry Smith {
1064277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1065089b2837SJed Brown   SNES           snes;
106624989b8cSPeter Brune   DM             dm;
106724989b8cSPeter Brune   TSIJacobian    ijacobian;
1068277b19d0SLisandro Dalcin 
1069d763cef2SBarry Smith   PetscFunctionBegin;
10700700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1071e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1072e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1073e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1074e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
1075d763cef2SBarry Smith 
107624989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
107724989b8cSPeter Brune   ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr);
1078e1244c69SJed Brown   if (f == TSComputeRHSJacobianConstant) {
1079e1244c69SJed Brown     /* Handle this case automatically for the user; otherwise user should call themselves. */
1080e1244c69SJed Brown     ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr);
1081e1244c69SJed Brown   }
10820298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr);
1083089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
10845f659677SPeter Brune   if (!ijacobian) {
1085e5d3d808SBarry Smith     ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
10860e4ef248SJed Brown   }
1087e5d3d808SBarry Smith   if (Amat) {
1088e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
10890e4ef248SJed Brown     ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
1090bbd56ea5SKarl Rupp 
1091e5d3d808SBarry Smith     ts->Arhs = Amat;
10920e4ef248SJed Brown   }
1093e5d3d808SBarry Smith   if (Pmat) {
1094e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr);
10950e4ef248SJed Brown     ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1096bbd56ea5SKarl Rupp 
1097e5d3d808SBarry Smith     ts->Brhs = Pmat;
10980e4ef248SJed Brown   }
1099d763cef2SBarry Smith   PetscFunctionReturn(0);
1100d763cef2SBarry Smith }
1101d763cef2SBarry Smith 
1102316643e7SJed Brown 
1103316643e7SJed Brown #undef __FUNCT__
1104316643e7SJed Brown #define __FUNCT__ "TSSetIFunction"
1105316643e7SJed Brown /*@C
1106b5abc632SBarry Smith    TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved.
1107316643e7SJed Brown 
11083f9fe445SBarry Smith    Logically Collective on TS
1109316643e7SJed Brown 
1110316643e7SJed Brown    Input Parameters:
1111316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
11120298fd71SBarry Smith .  r   - vector to hold the residual (or NULL to have it created internally)
1113316643e7SJed Brown .  f   - the function evaluation routine
11140298fd71SBarry Smith -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1115316643e7SJed Brown 
1116316643e7SJed Brown    Calling sequence of f:
1117316643e7SJed Brown $  f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx);
1118316643e7SJed Brown 
1119316643e7SJed Brown +  t   - time at step/stage being solved
1120316643e7SJed Brown .  u   - state vector
1121316643e7SJed Brown .  u_t - time derivative of state vector
1122316643e7SJed Brown .  F   - function vector
1123316643e7SJed Brown -  ctx - [optional] user-defined context for matrix evaluation routine
1124316643e7SJed Brown 
1125316643e7SJed Brown    Important:
11262bbac0d3SBarry Smith    The user MUST call either this routine or TSSetRHSFunction() to define the ODE.  When solving DAEs you must use this function.
1127316643e7SJed Brown 
1128316643e7SJed Brown    Level: beginner
1129316643e7SJed Brown 
1130316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian
1131316643e7SJed Brown 
1132d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian()
1133316643e7SJed Brown @*/
1134089b2837SJed Brown PetscErrorCode  TSSetIFunction(TS ts,Vec res,TSIFunction f,void *ctx)
1135316643e7SJed Brown {
1136089b2837SJed Brown   PetscErrorCode ierr;
1137089b2837SJed Brown   SNES           snes;
11380298fd71SBarry Smith   Vec            resalloc = NULL;
113924989b8cSPeter Brune   DM             dm;
1140316643e7SJed Brown 
1141316643e7SJed Brown   PetscFunctionBegin;
11420700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1143ca94891dSJed Brown   if (res) PetscValidHeaderSpecific(res,VEC_CLASSID,2);
114424989b8cSPeter Brune 
114524989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
114624989b8cSPeter Brune   ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr);
114724989b8cSPeter Brune 
1148089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1149e856ceecSJed Brown   if (!res && !ts->dm && ts->vec_sol) {
1150e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&resalloc);CHKERRQ(ierr);
1151e856ceecSJed Brown     res  = resalloc;
1152e856ceecSJed Brown   }
1153089b2837SJed Brown   ierr = SNESSetFunction(snes,res,SNESTSFormFunction,ts);CHKERRQ(ierr);
1154e856ceecSJed Brown   ierr = VecDestroy(&resalloc);CHKERRQ(ierr);
1155089b2837SJed Brown   PetscFunctionReturn(0);
1156089b2837SJed Brown }
1157089b2837SJed Brown 
1158089b2837SJed Brown #undef __FUNCT__
1159089b2837SJed Brown #define __FUNCT__ "TSGetIFunction"
1160089b2837SJed Brown /*@C
1161089b2837SJed Brown    TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1162089b2837SJed Brown 
1163089b2837SJed Brown    Not Collective
1164089b2837SJed Brown 
1165089b2837SJed Brown    Input Parameter:
1166089b2837SJed Brown .  ts - the TS context
1167089b2837SJed Brown 
1168089b2837SJed Brown    Output Parameter:
11690298fd71SBarry Smith +  r - vector to hold residual (or NULL)
11700298fd71SBarry Smith .  func - the function to compute residual (or NULL)
11710298fd71SBarry Smith -  ctx - the function context (or NULL)
1172089b2837SJed Brown 
1173089b2837SJed Brown    Level: advanced
1174089b2837SJed Brown 
1175089b2837SJed Brown .keywords: TS, nonlinear, get, function
1176089b2837SJed Brown 
1177089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction()
1178089b2837SJed Brown @*/
1179089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx)
1180089b2837SJed Brown {
1181089b2837SJed Brown   PetscErrorCode ierr;
1182089b2837SJed Brown   SNES           snes;
118324989b8cSPeter Brune   DM             dm;
1184089b2837SJed Brown 
1185089b2837SJed Brown   PetscFunctionBegin;
1186089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1187089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
11880298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
118924989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
119024989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr);
1191089b2837SJed Brown   PetscFunctionReturn(0);
1192089b2837SJed Brown }
1193089b2837SJed Brown 
1194089b2837SJed Brown #undef __FUNCT__
1195089b2837SJed Brown #define __FUNCT__ "TSGetRHSFunction"
1196089b2837SJed Brown /*@C
1197089b2837SJed Brown    TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it.
1198089b2837SJed Brown 
1199089b2837SJed Brown    Not Collective
1200089b2837SJed Brown 
1201089b2837SJed Brown    Input Parameter:
1202089b2837SJed Brown .  ts - the TS context
1203089b2837SJed Brown 
1204089b2837SJed Brown    Output Parameter:
12050298fd71SBarry Smith +  r - vector to hold computed right hand side (or NULL)
12060298fd71SBarry Smith .  func - the function to compute right hand side (or NULL)
12070298fd71SBarry Smith -  ctx - the function context (or NULL)
1208089b2837SJed Brown 
1209089b2837SJed Brown    Level: advanced
1210089b2837SJed Brown 
1211089b2837SJed Brown .keywords: TS, nonlinear, get, function
1212089b2837SJed Brown 
12132bbac0d3SBarry Smith .seealso: TSSetRHSFunction(), SNESGetFunction()
1214089b2837SJed Brown @*/
1215089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx)
1216089b2837SJed Brown {
1217089b2837SJed Brown   PetscErrorCode ierr;
1218089b2837SJed Brown   SNES           snes;
121924989b8cSPeter Brune   DM             dm;
1220089b2837SJed Brown 
1221089b2837SJed Brown   PetscFunctionBegin;
1222089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1223089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
12240298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
122524989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
122624989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr);
1227316643e7SJed Brown   PetscFunctionReturn(0);
1228316643e7SJed Brown }
1229316643e7SJed Brown 
1230316643e7SJed Brown #undef __FUNCT__
1231316643e7SJed Brown #define __FUNCT__ "TSSetIJacobian"
1232316643e7SJed Brown /*@C
1233a4f0a591SBarry Smith    TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function
1234ae8867d6SBarry Smith         provided with TSSetIFunction().
1235316643e7SJed Brown 
12363f9fe445SBarry Smith    Logically Collective on TS
1237316643e7SJed Brown 
1238316643e7SJed Brown    Input Parameters:
1239316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
1240e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1241e5d3d808SBarry Smith .  Pmat - matrix used to compute preconditioner (usually the same as Amat)
1242316643e7SJed Brown .  f   - the Jacobian evaluation routine
12430298fd71SBarry Smith -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1244316643e7SJed Brown 
1245316643e7SJed Brown    Calling sequence of f:
1246ae8867d6SBarry Smith $  f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx);
1247316643e7SJed Brown 
1248316643e7SJed Brown +  t    - time at step/stage being solved
12491b4a444bSJed Brown .  U    - state vector
12501b4a444bSJed Brown .  U_t  - time derivative of state vector
1251316643e7SJed Brown .  a    - shift
1252e5d3d808SBarry Smith .  Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t
1253e5d3d808SBarry Smith .  Pmat - matrix used for constructing preconditioner, usually the same as Amat
1254316643e7SJed Brown -  ctx  - [optional] user-defined context for matrix evaluation routine
1255316643e7SJed Brown 
1256316643e7SJed Brown    Notes:
1257e5d3d808SBarry Smith    The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve.
1258316643e7SJed Brown 
1259895c21f2SBarry Smith    If you know the operator Amat has a null space you can use MatSetNullSpace() and MatSetTransposeNullSpace() to supply the null
1260895c21f2SBarry Smith    space to Amat and the KSP solvers will automatically use that null space as needed during the solution process.
1261895c21f2SBarry Smith 
1262a4f0a591SBarry Smith    The matrix dF/dU + a*dF/dU_t you provide turns out to be
1263b5abc632SBarry Smith    the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved.
1264a4f0a591SBarry Smith    The time integrator internally approximates U_t by W+a*U where the positive "shift"
1265a4f0a591SBarry Smith    a and vector W depend on the integration method, step size, and past states. For example with
1266a4f0a591SBarry Smith    the backward Euler method a = 1/dt and W = -a*U(previous timestep) so
1267a4f0a591SBarry Smith    W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt
1268a4f0a591SBarry Smith 
1269*ca5f011dSBarry Smith    Notes: The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1270*ca5f011dSBarry Smith           You should not assume the values are the same in the next call to f() as you set them in the previous call.
1271*ca5f011dSBarry Smith 
1272316643e7SJed Brown    Level: beginner
1273316643e7SJed Brown 
1274316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian
1275316643e7SJed Brown 
1276ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction()
1277316643e7SJed Brown 
1278316643e7SJed Brown @*/
1279e5d3d808SBarry Smith PetscErrorCode  TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx)
1280316643e7SJed Brown {
1281316643e7SJed Brown   PetscErrorCode ierr;
1282089b2837SJed Brown   SNES           snes;
128324989b8cSPeter Brune   DM             dm;
1284316643e7SJed Brown 
1285316643e7SJed Brown   PetscFunctionBegin;
12860700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1287e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1288e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1289e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1290e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
129124989b8cSPeter Brune 
129224989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
129324989b8cSPeter Brune   ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr);
129424989b8cSPeter Brune 
1295089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1296e5d3d808SBarry Smith   ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
1297316643e7SJed Brown   PetscFunctionReturn(0);
1298316643e7SJed Brown }
1299316643e7SJed Brown 
13004a2ae208SSatish Balay #undef __FUNCT__
1301e1244c69SJed Brown #define __FUNCT__ "TSRHSJacobianSetReuse"
1302e1244c69SJed Brown /*@
1303e1244c69SJed Brown    TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating.  Without this flag, TS will change the sign and
1304e1244c69SJed Brown    shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute
1305e1244c69SJed Brown    the entire Jacobian.  The reuse flag must be set if the evaluation function will assume that the matrix entries have
1306e1244c69SJed Brown    not been changed by the TS.
1307e1244c69SJed Brown 
1308e1244c69SJed Brown    Logically Collective
1309e1244c69SJed Brown 
1310e1244c69SJed Brown    Input Arguments:
1311e1244c69SJed Brown +  ts - TS context obtained from TSCreate()
1312e1244c69SJed Brown -  reuse - PETSC_TRUE if the RHS Jacobian
1313e1244c69SJed Brown 
1314e1244c69SJed Brown    Level: intermediate
1315e1244c69SJed Brown 
1316e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
1317e1244c69SJed Brown @*/
1318e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse)
1319e1244c69SJed Brown {
1320e1244c69SJed Brown   PetscFunctionBegin;
1321e1244c69SJed Brown   ts->rhsjacobian.reuse = reuse;
1322e1244c69SJed Brown   PetscFunctionReturn(0);
1323e1244c69SJed Brown }
1324e1244c69SJed Brown 
1325e1244c69SJed Brown #undef __FUNCT__
132655849f57SBarry Smith #define __FUNCT__ "TSLoad"
132755849f57SBarry Smith /*@C
132855849f57SBarry Smith   TSLoad - Loads a KSP that has been stored in binary  with KSPView().
132955849f57SBarry Smith 
133055849f57SBarry Smith   Collective on PetscViewer
133155849f57SBarry Smith 
133255849f57SBarry Smith   Input Parameters:
133355849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or
133455849f57SBarry Smith            some related function before a call to TSLoad().
133555849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen()
133655849f57SBarry Smith 
133755849f57SBarry Smith    Level: intermediate
133855849f57SBarry Smith 
133955849f57SBarry Smith   Notes:
134055849f57SBarry Smith    The type is determined by the data in the file, any type set into the TS before this call is ignored.
134155849f57SBarry Smith 
134255849f57SBarry Smith   Notes for advanced users:
134355849f57SBarry Smith   Most users should not need to know the details of the binary storage
134455849f57SBarry Smith   format, since TSLoad() and TSView() completely hide these details.
134555849f57SBarry Smith   But for anyone who's interested, the standard binary matrix storage
134655849f57SBarry Smith   format is
134755849f57SBarry Smith .vb
134855849f57SBarry Smith      has not yet been determined
134955849f57SBarry Smith .ve
135055849f57SBarry Smith 
135155849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad()
135255849f57SBarry Smith @*/
1353f2c2a1b9SBarry Smith PetscErrorCode  TSLoad(TS ts, PetscViewer viewer)
135455849f57SBarry Smith {
135555849f57SBarry Smith   PetscErrorCode ierr;
135655849f57SBarry Smith   PetscBool      isbinary;
135755849f57SBarry Smith   PetscInt       classid;
135855849f57SBarry Smith   char           type[256];
13592d53ad75SBarry Smith   DMTS           sdm;
1360ad6bc421SBarry Smith   DM             dm;
136155849f57SBarry Smith 
136255849f57SBarry Smith   PetscFunctionBegin;
1363f2c2a1b9SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
136455849f57SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
136555849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
136655849f57SBarry Smith   if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
136755849f57SBarry Smith 
1368060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr);
1369ce94432eSBarry Smith   if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file");
1370060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr);
1371f2c2a1b9SBarry Smith   ierr = TSSetType(ts, type);CHKERRQ(ierr);
1372f2c2a1b9SBarry Smith   if (ts->ops->load) {
1373f2c2a1b9SBarry Smith     ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr);
1374f2c2a1b9SBarry Smith   }
1375ce94432eSBarry Smith   ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr);
1376ad6bc421SBarry Smith   ierr = DMLoad(dm,viewer);CHKERRQ(ierr);
1377ad6bc421SBarry Smith   ierr = TSSetDM(ts,dm);CHKERRQ(ierr);
1378f2c2a1b9SBarry Smith   ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr);
1379f2c2a1b9SBarry Smith   ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr);
13802d53ad75SBarry Smith   ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
13812d53ad75SBarry Smith   ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr);
138255849f57SBarry Smith   PetscFunctionReturn(0);
138355849f57SBarry Smith }
138455849f57SBarry Smith 
13859804daf3SBarry Smith #include <petscdraw.h>
1386e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1387e04113cfSBarry Smith #include <petscviewersaws.h>
1388f05ece33SBarry Smith #endif
138955849f57SBarry Smith #undef __FUNCT__
13904a2ae208SSatish Balay #define __FUNCT__ "TSView"
13917e2c5f70SBarry Smith /*@C
1392d763cef2SBarry Smith     TSView - Prints the TS data structure.
1393d763cef2SBarry Smith 
13944c49b128SBarry Smith     Collective on TS
1395d763cef2SBarry Smith 
1396d763cef2SBarry Smith     Input Parameters:
1397d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
1398d763cef2SBarry Smith -   viewer - visualization context
1399d763cef2SBarry Smith 
1400d763cef2SBarry Smith     Options Database Key:
1401d763cef2SBarry Smith .   -ts_view - calls TSView() at end of TSStep()
1402d763cef2SBarry Smith 
1403d763cef2SBarry Smith     Notes:
1404d763cef2SBarry Smith     The available visualization contexts include
1405b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
1406b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
1407d763cef2SBarry Smith          output where only the first processor opens
1408d763cef2SBarry Smith          the file.  All other processors send their
1409d763cef2SBarry Smith          data to the first processor to print.
1410d763cef2SBarry Smith 
1411d763cef2SBarry Smith     The user can open an alternative visualization context with
1412b0a32e0cSBarry Smith     PetscViewerASCIIOpen() - output to a specified file.
1413d763cef2SBarry Smith 
1414d763cef2SBarry Smith     Level: beginner
1415d763cef2SBarry Smith 
1416d763cef2SBarry Smith .keywords: TS, timestep, view
1417d763cef2SBarry Smith 
1418b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
1419d763cef2SBarry Smith @*/
14207087cfbeSBarry Smith PetscErrorCode  TSView(TS ts,PetscViewer viewer)
1421d763cef2SBarry Smith {
1422dfbe8321SBarry Smith   PetscErrorCode ierr;
142319fd82e9SBarry Smith   TSType         type;
14242b0a91c0SBarry Smith   PetscBool      iascii,isstring,isundials,isbinary,isdraw;
14252d53ad75SBarry Smith   DMTS           sdm;
1426e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1427536b137fSBarry Smith   PetscBool      issaws;
1428f05ece33SBarry Smith #endif
1429d763cef2SBarry Smith 
1430d763cef2SBarry Smith   PetscFunctionBegin;
14310700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
14323050cee2SBarry Smith   if (!viewer) {
1433ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr);
14343050cee2SBarry Smith   }
14350700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1436c9780b6fSBarry Smith   PetscCheckSameComm(ts,1,viewer,2);
1437fd16b177SBarry Smith 
1438251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1439251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
144055849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
14412b0a91c0SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1442e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1443536b137fSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr);
1444f05ece33SBarry Smith #endif
144532077d6dSBarry Smith   if (iascii) {
1446dae58748SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr);
144777431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr);
14487c8652ddSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr);
1449d763cef2SBarry Smith     if (ts->problem_type == TS_NONLINEAR) {
14505ef26d82SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr);
1451c610991cSLisandro Dalcin       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solve failures=%D\n",ts->num_snes_failures);CHKERRQ(ierr);
1452d763cef2SBarry Smith     }
14535ef26d82SJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr);
1454193ac0bcSJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr);
14552d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
14562d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
1457d52bd9f3SBarry Smith     if (ts->ops->view) {
1458d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1459d52bd9f3SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
1460d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1461d52bd9f3SBarry Smith     }
14620f5bd95cSBarry Smith   } else if (isstring) {
1463a313700dSBarry Smith     ierr = TSGetType(ts,&type);CHKERRQ(ierr);
1464b0a32e0cSBarry Smith     ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr);
146555849f57SBarry Smith   } else if (isbinary) {
146655849f57SBarry Smith     PetscInt    classid = TS_FILE_CLASSID;
146755849f57SBarry Smith     MPI_Comm    comm;
146855849f57SBarry Smith     PetscMPIInt rank;
146955849f57SBarry Smith     char        type[256];
147055849f57SBarry Smith 
147155849f57SBarry Smith     ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
147255849f57SBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
147355849f57SBarry Smith     if (!rank) {
147455849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
147555849f57SBarry Smith       ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr);
147655849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr);
147755849f57SBarry Smith     }
147855849f57SBarry Smith     if (ts->ops->view) {
147955849f57SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
148055849f57SBarry Smith     }
1481f2c2a1b9SBarry Smith     ierr = DMView(ts->dm,viewer);CHKERRQ(ierr);
1482f2c2a1b9SBarry Smith     ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr);
14832d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
14842d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
14852b0a91c0SBarry Smith   } else if (isdraw) {
14862b0a91c0SBarry Smith     PetscDraw draw;
14872b0a91c0SBarry Smith     char      str[36];
148889fd9fafSBarry Smith     PetscReal x,y,bottom,h;
14892b0a91c0SBarry Smith 
14902b0a91c0SBarry Smith     ierr   = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
14912b0a91c0SBarry Smith     ierr   = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
14922b0a91c0SBarry Smith     ierr   = PetscStrcpy(str,"TS: ");CHKERRQ(ierr);
14932b0a91c0SBarry Smith     ierr   = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr);
149451fa3d41SBarry Smith     ierr   = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
149589fd9fafSBarry Smith     bottom = y - h;
14962b0a91c0SBarry Smith     ierr   = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr);
14972b0a91c0SBarry Smith     if (ts->ops->view) {
14982b0a91c0SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
14992b0a91c0SBarry Smith     }
15002b0a91c0SBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
1501e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1502536b137fSBarry Smith   } else if (issaws) {
1503d45a07a7SBarry Smith     PetscMPIInt rank;
15042657e9d9SBarry Smith     const char  *name;
15052657e9d9SBarry Smith 
15062657e9d9SBarry Smith     ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr);
1507d45a07a7SBarry Smith     ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
1508d45a07a7SBarry Smith     if (!((PetscObject)ts)->amsmem && !rank) {
1509d45a07a7SBarry Smith       char       dir[1024];
1510d45a07a7SBarry Smith 
1511e04113cfSBarry Smith       ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr);
1512a0931e03SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr);
15132657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT));
15142657e9d9SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr);
15152657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE));
1516d763cef2SBarry Smith     }
15170acecf5bSBarry Smith     if (ts->ops->view) {
15180acecf5bSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
15190acecf5bSBarry Smith     }
1520f05ece33SBarry Smith #endif
1521f05ece33SBarry Smith   }
1522f05ece33SBarry Smith 
1523b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1524251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr);
1525b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1526d763cef2SBarry Smith   PetscFunctionReturn(0);
1527d763cef2SBarry Smith }
1528d763cef2SBarry Smith 
1529d763cef2SBarry Smith 
15304a2ae208SSatish Balay #undef __FUNCT__
15314a2ae208SSatish Balay #define __FUNCT__ "TSSetApplicationContext"
1532b07ff414SBarry Smith /*@
1533d763cef2SBarry Smith    TSSetApplicationContext - Sets an optional user-defined context for
1534d763cef2SBarry Smith    the timesteppers.
1535d763cef2SBarry Smith 
15363f9fe445SBarry Smith    Logically Collective on TS
1537d763cef2SBarry Smith 
1538d763cef2SBarry Smith    Input Parameters:
1539d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1540d763cef2SBarry Smith -  usrP - optional user context
1541d763cef2SBarry Smith 
1542daf670e6SBarry Smith    Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this
1543daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
1544daf670e6SBarry Smith 
1545d763cef2SBarry Smith    Level: intermediate
1546d763cef2SBarry Smith 
1547d763cef2SBarry Smith .keywords: TS, timestep, set, application, context
1548d763cef2SBarry Smith 
1549d763cef2SBarry Smith .seealso: TSGetApplicationContext()
1550d763cef2SBarry Smith @*/
15517087cfbeSBarry Smith PetscErrorCode  TSSetApplicationContext(TS ts,void *usrP)
1552d763cef2SBarry Smith {
1553d763cef2SBarry Smith   PetscFunctionBegin;
15540700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1555d763cef2SBarry Smith   ts->user = usrP;
1556d763cef2SBarry Smith   PetscFunctionReturn(0);
1557d763cef2SBarry Smith }
1558d763cef2SBarry Smith 
15594a2ae208SSatish Balay #undef __FUNCT__
15604a2ae208SSatish Balay #define __FUNCT__ "TSGetApplicationContext"
1561b07ff414SBarry Smith /*@
1562d763cef2SBarry Smith     TSGetApplicationContext - Gets the user-defined context for the
1563d763cef2SBarry Smith     timestepper.
1564d763cef2SBarry Smith 
1565d763cef2SBarry Smith     Not Collective
1566d763cef2SBarry Smith 
1567d763cef2SBarry Smith     Input Parameter:
1568d763cef2SBarry Smith .   ts - the TS context obtained from TSCreate()
1569d763cef2SBarry Smith 
1570d763cef2SBarry Smith     Output Parameter:
1571d763cef2SBarry Smith .   usrP - user context
1572d763cef2SBarry Smith 
1573daf670e6SBarry Smith    Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this
1574daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
1575daf670e6SBarry Smith 
1576d763cef2SBarry Smith     Level: intermediate
1577d763cef2SBarry Smith 
1578d763cef2SBarry Smith .keywords: TS, timestep, get, application, context
1579d763cef2SBarry Smith 
1580d763cef2SBarry Smith .seealso: TSSetApplicationContext()
1581d763cef2SBarry Smith @*/
1582e71120c6SJed Brown PetscErrorCode  TSGetApplicationContext(TS ts,void *usrP)
1583d763cef2SBarry Smith {
1584d763cef2SBarry Smith   PetscFunctionBegin;
15850700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1586e71120c6SJed Brown   *(void**)usrP = ts->user;
1587d763cef2SBarry Smith   PetscFunctionReturn(0);
1588d763cef2SBarry Smith }
1589d763cef2SBarry Smith 
15904a2ae208SSatish Balay #undef __FUNCT__
15914a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStepNumber"
1592d763cef2SBarry Smith /*@
1593b8123daeSJed Brown    TSGetTimeStepNumber - Gets the number of time steps completed.
1594d763cef2SBarry Smith 
1595d763cef2SBarry Smith    Not Collective
1596d763cef2SBarry Smith 
1597d763cef2SBarry Smith    Input Parameter:
1598d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1599d763cef2SBarry Smith 
1600d763cef2SBarry Smith    Output Parameter:
1601b8123daeSJed Brown .  iter - number of steps completed so far
1602d763cef2SBarry Smith 
1603d763cef2SBarry Smith    Level: intermediate
1604d763cef2SBarry Smith 
1605d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number
16069be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep()
1607d763cef2SBarry Smith @*/
16087087cfbeSBarry Smith PetscErrorCode  TSGetTimeStepNumber(TS ts,PetscInt *iter)
1609d763cef2SBarry Smith {
1610d763cef2SBarry Smith   PetscFunctionBegin;
16110700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
16124482741eSBarry Smith   PetscValidIntPointer(iter,2);
1613d763cef2SBarry Smith   *iter = ts->steps;
1614d763cef2SBarry Smith   PetscFunctionReturn(0);
1615d763cef2SBarry Smith }
1616d763cef2SBarry Smith 
16174a2ae208SSatish Balay #undef __FUNCT__
16184a2ae208SSatish Balay #define __FUNCT__ "TSSetInitialTimeStep"
1619d763cef2SBarry Smith /*@
1620d763cef2SBarry Smith    TSSetInitialTimeStep - Sets the initial timestep to be used,
1621d763cef2SBarry Smith    as well as the initial time.
1622d763cef2SBarry Smith 
16233f9fe445SBarry Smith    Logically Collective on TS
1624d763cef2SBarry Smith 
1625d763cef2SBarry Smith    Input Parameters:
1626d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1627d763cef2SBarry Smith .  initial_time - the initial time
1628d763cef2SBarry Smith -  time_step - the size of the timestep
1629d763cef2SBarry Smith 
1630d763cef2SBarry Smith    Level: intermediate
1631d763cef2SBarry Smith 
1632d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep()
1633d763cef2SBarry Smith 
1634d763cef2SBarry Smith .keywords: TS, set, initial, timestep
1635d763cef2SBarry Smith @*/
16367087cfbeSBarry Smith PetscErrorCode  TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step)
1637d763cef2SBarry Smith {
1638e144a568SJed Brown   PetscErrorCode ierr;
1639e144a568SJed Brown 
1640d763cef2SBarry Smith   PetscFunctionBegin;
16410700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1642e144a568SJed Brown   ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
1643d8cd7023SBarry Smith   ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr);
1644d763cef2SBarry Smith   PetscFunctionReturn(0);
1645d763cef2SBarry Smith }
1646d763cef2SBarry Smith 
16474a2ae208SSatish Balay #undef __FUNCT__
16484a2ae208SSatish Balay #define __FUNCT__ "TSSetTimeStep"
1649d763cef2SBarry Smith /*@
1650d763cef2SBarry Smith    TSSetTimeStep - Allows one to reset the timestep at any time,
1651d763cef2SBarry Smith    useful for simple pseudo-timestepping codes.
1652d763cef2SBarry Smith 
16533f9fe445SBarry Smith    Logically Collective on TS
1654d763cef2SBarry Smith 
1655d763cef2SBarry Smith    Input Parameters:
1656d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1657d763cef2SBarry Smith -  time_step - the size of the timestep
1658d763cef2SBarry Smith 
1659d763cef2SBarry Smith    Level: intermediate
1660d763cef2SBarry Smith 
1661d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
1662d763cef2SBarry Smith 
1663d763cef2SBarry Smith .keywords: TS, set, timestep
1664d763cef2SBarry Smith @*/
16657087cfbeSBarry Smith PetscErrorCode  TSSetTimeStep(TS ts,PetscReal time_step)
1666d763cef2SBarry Smith {
1667d763cef2SBarry Smith   PetscFunctionBegin;
16680700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1669c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,time_step,2);
1670d763cef2SBarry Smith   ts->time_step      = time_step;
167131748224SBarry Smith   ts->time_step_orig = time_step;
1672d763cef2SBarry Smith   PetscFunctionReturn(0);
1673d763cef2SBarry Smith }
1674d763cef2SBarry Smith 
16754a2ae208SSatish Balay #undef __FUNCT__
1676a43b19c4SJed Brown #define __FUNCT__ "TSSetExactFinalTime"
1677a43b19c4SJed Brown /*@
167849354f04SShri Abhyankar    TSSetExactFinalTime - Determines whether to adapt the final time step to
167949354f04SShri Abhyankar      match the exact final time, interpolate solution to the exact final time,
168049354f04SShri Abhyankar      or just return at the final time TS computed.
1681a43b19c4SJed Brown 
1682a43b19c4SJed Brown   Logically Collective on TS
1683a43b19c4SJed Brown 
1684a43b19c4SJed Brown    Input Parameter:
1685a43b19c4SJed Brown +   ts - the time-step context
168649354f04SShri Abhyankar -   eftopt - exact final time option
1687a43b19c4SJed Brown 
1688a43b19c4SJed Brown    Level: beginner
1689a43b19c4SJed Brown 
1690a2ea699eSBarry Smith .seealso: TSExactFinalTimeOption
1691a43b19c4SJed Brown @*/
169249354f04SShri Abhyankar PetscErrorCode  TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt)
1693a43b19c4SJed Brown {
1694a43b19c4SJed Brown   PetscFunctionBegin;
1695a43b19c4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
169649354f04SShri Abhyankar   PetscValidLogicalCollectiveEnum(ts,eftopt,2);
169749354f04SShri Abhyankar   ts->exact_final_time = eftopt;
1698a43b19c4SJed Brown   PetscFunctionReturn(0);
1699a43b19c4SJed Brown }
1700a43b19c4SJed Brown 
1701a43b19c4SJed Brown #undef __FUNCT__
17024a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStep"
1703d763cef2SBarry Smith /*@
1704d763cef2SBarry Smith    TSGetTimeStep - Gets the current timestep size.
1705d763cef2SBarry Smith 
1706d763cef2SBarry Smith    Not Collective
1707d763cef2SBarry Smith 
1708d763cef2SBarry Smith    Input Parameter:
1709d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1710d763cef2SBarry Smith 
1711d763cef2SBarry Smith    Output Parameter:
1712d763cef2SBarry Smith .  dt - the current timestep size
1713d763cef2SBarry Smith 
1714d763cef2SBarry Smith    Level: intermediate
1715d763cef2SBarry Smith 
1716d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
1717d763cef2SBarry Smith 
1718d763cef2SBarry Smith .keywords: TS, get, timestep
1719d763cef2SBarry Smith @*/
17207087cfbeSBarry Smith PetscErrorCode  TSGetTimeStep(TS ts,PetscReal *dt)
1721d763cef2SBarry Smith {
1722d763cef2SBarry Smith   PetscFunctionBegin;
17230700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1724f7cf8827SBarry Smith   PetscValidRealPointer(dt,2);
1725d763cef2SBarry Smith   *dt = ts->time_step;
1726d763cef2SBarry Smith   PetscFunctionReturn(0);
1727d763cef2SBarry Smith }
1728d763cef2SBarry Smith 
17294a2ae208SSatish Balay #undef __FUNCT__
17304a2ae208SSatish Balay #define __FUNCT__ "TSGetSolution"
1731d8e5e3e6SSatish Balay /*@
1732d763cef2SBarry Smith    TSGetSolution - Returns the solution at the present timestep. It
1733d763cef2SBarry Smith    is valid to call this routine inside the function that you are evaluating
1734d763cef2SBarry Smith    in order to move to the new timestep. This vector not changed until
1735d763cef2SBarry Smith    the solution at the next timestep has been calculated.
1736d763cef2SBarry Smith 
1737d763cef2SBarry Smith    Not Collective, but Vec returned is parallel if TS is parallel
1738d763cef2SBarry Smith 
1739d763cef2SBarry Smith    Input Parameter:
1740d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1741d763cef2SBarry Smith 
1742d763cef2SBarry Smith    Output Parameter:
1743d763cef2SBarry Smith .  v - the vector containing the solution
1744d763cef2SBarry Smith 
1745d763cef2SBarry Smith    Level: intermediate
1746d763cef2SBarry Smith 
1747d763cef2SBarry Smith .seealso: TSGetTimeStep()
1748d763cef2SBarry Smith 
1749d763cef2SBarry Smith .keywords: TS, timestep, get, solution
1750d763cef2SBarry Smith @*/
17517087cfbeSBarry Smith PetscErrorCode  TSGetSolution(TS ts,Vec *v)
1752d763cef2SBarry Smith {
1753d763cef2SBarry Smith   PetscFunctionBegin;
17540700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
17554482741eSBarry Smith   PetscValidPointer(v,2);
17568737fe31SLisandro Dalcin   *v = ts->vec_sol;
1757d763cef2SBarry Smith   PetscFunctionReturn(0);
1758d763cef2SBarry Smith }
1759d763cef2SBarry Smith 
1760c235aa8dSHong Zhang #undef __FUNCT__
1761dfb21088SHong Zhang #define __FUNCT__ "TSGetCostGradients"
1762c235aa8dSHong Zhang /*@
1763dfb21088SHong Zhang    TSGetCostGradients - Returns the gradients from the TSAdjointSolve()
1764c235aa8dSHong Zhang 
1765c235aa8dSHong Zhang    Not Collective, but Vec returned is parallel if TS is parallel
1766c235aa8dSHong Zhang 
1767c235aa8dSHong Zhang    Input Parameter:
1768c235aa8dSHong Zhang .  ts - the TS context obtained from TSCreate()
1769c235aa8dSHong Zhang 
1770c235aa8dSHong Zhang    Output Parameter:
1771abc2977eSBarry Smith +  lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables
1772abc2977eSBarry Smith -  mu - vectors containing the gradients of the cost functions with respect to the problem parameters
1773c235aa8dSHong Zhang 
1774c235aa8dSHong Zhang    Level: intermediate
1775c235aa8dSHong Zhang 
1776c235aa8dSHong Zhang .seealso: TSGetTimeStep()
1777c235aa8dSHong Zhang 
1778c235aa8dSHong Zhang .keywords: TS, timestep, get, sensitivity
1779c235aa8dSHong Zhang @*/
1780dfb21088SHong Zhang PetscErrorCode  TSGetCostGradients(TS ts,PetscInt *numcost,Vec **lambda,Vec **mu)
1781c235aa8dSHong Zhang {
1782c235aa8dSHong Zhang   PetscFunctionBegin;
1783c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1784abc2977eSBarry Smith   if (numcost) *numcost = ts->numcost;
1785abc2977eSBarry Smith   if (lambda)  *lambda  = ts->vecs_sensi;
1786abc2977eSBarry Smith   if (mu)      *mu      = ts->vecs_sensip;
1787c235aa8dSHong Zhang   PetscFunctionReturn(0);
1788c235aa8dSHong Zhang }
1789c235aa8dSHong Zhang 
1790bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */
17914a2ae208SSatish Balay #undef __FUNCT__
1792bdad233fSMatthew Knepley #define __FUNCT__ "TSSetProblemType"
1793d8e5e3e6SSatish Balay /*@
1794bdad233fSMatthew Knepley   TSSetProblemType - Sets the type of problem to be solved.
1795d763cef2SBarry Smith 
1796bdad233fSMatthew Knepley   Not collective
1797d763cef2SBarry Smith 
1798bdad233fSMatthew Knepley   Input Parameters:
1799bdad233fSMatthew Knepley + ts   - The TS
1800bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1801d763cef2SBarry Smith .vb
18020910c330SBarry Smith          U_t - A U = 0      (linear)
18030910c330SBarry Smith          U_t - A(t) U = 0   (linear)
18040910c330SBarry Smith          F(t,U,U_t) = 0     (nonlinear)
1805d763cef2SBarry Smith .ve
1806d763cef2SBarry Smith 
1807d763cef2SBarry Smith    Level: beginner
1808d763cef2SBarry Smith 
1809bdad233fSMatthew Knepley .keywords: TS, problem type
1810bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
1811d763cef2SBarry Smith @*/
18127087cfbeSBarry Smith PetscErrorCode  TSSetProblemType(TS ts, TSProblemType type)
1813a7cc72afSBarry Smith {
18149e2a6581SJed Brown   PetscErrorCode ierr;
18159e2a6581SJed Brown 
1816d763cef2SBarry Smith   PetscFunctionBegin;
18170700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1818bdad233fSMatthew Knepley   ts->problem_type = type;
18199e2a6581SJed Brown   if (type == TS_LINEAR) {
18209e2a6581SJed Brown     SNES snes;
18219e2a6581SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
18229e2a6581SJed Brown     ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);
18239e2a6581SJed Brown   }
1824d763cef2SBarry Smith   PetscFunctionReturn(0);
1825d763cef2SBarry Smith }
1826d763cef2SBarry Smith 
1827bdad233fSMatthew Knepley #undef __FUNCT__
1828bdad233fSMatthew Knepley #define __FUNCT__ "TSGetProblemType"
1829bdad233fSMatthew Knepley /*@C
1830bdad233fSMatthew Knepley   TSGetProblemType - Gets the type of problem to be solved.
1831bdad233fSMatthew Knepley 
1832bdad233fSMatthew Knepley   Not collective
1833bdad233fSMatthew Knepley 
1834bdad233fSMatthew Knepley   Input Parameter:
1835bdad233fSMatthew Knepley . ts   - The TS
1836bdad233fSMatthew Knepley 
1837bdad233fSMatthew Knepley   Output Parameter:
1838bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1839bdad233fSMatthew Knepley .vb
1840089b2837SJed Brown          M U_t = A U
1841089b2837SJed Brown          M(t) U_t = A(t) U
1842b5abc632SBarry Smith          F(t,U,U_t)
1843bdad233fSMatthew Knepley .ve
1844bdad233fSMatthew Knepley 
1845bdad233fSMatthew Knepley    Level: beginner
1846bdad233fSMatthew Knepley 
1847bdad233fSMatthew Knepley .keywords: TS, problem type
1848bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
1849bdad233fSMatthew Knepley @*/
18507087cfbeSBarry Smith PetscErrorCode  TSGetProblemType(TS ts, TSProblemType *type)
1851a7cc72afSBarry Smith {
1852bdad233fSMatthew Knepley   PetscFunctionBegin;
18530700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
18544482741eSBarry Smith   PetscValidIntPointer(type,2);
1855bdad233fSMatthew Knepley   *type = ts->problem_type;
1856bdad233fSMatthew Knepley   PetscFunctionReturn(0);
1857bdad233fSMatthew Knepley }
1858d763cef2SBarry Smith 
18594a2ae208SSatish Balay #undef __FUNCT__
18604a2ae208SSatish Balay #define __FUNCT__ "TSSetUp"
1861d763cef2SBarry Smith /*@
1862d763cef2SBarry Smith    TSSetUp - Sets up the internal data structures for the later use
1863d763cef2SBarry Smith    of a timestepper.
1864d763cef2SBarry Smith 
1865d763cef2SBarry Smith    Collective on TS
1866d763cef2SBarry Smith 
1867d763cef2SBarry Smith    Input Parameter:
1868d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1869d763cef2SBarry Smith 
1870d763cef2SBarry Smith    Notes:
1871d763cef2SBarry Smith    For basic use of the TS solvers the user need not explicitly call
1872d763cef2SBarry Smith    TSSetUp(), since these actions will automatically occur during
1873d763cef2SBarry Smith    the call to TSStep().  However, if one wishes to control this
1874d763cef2SBarry Smith    phase separately, TSSetUp() should be called after TSCreate()
1875d763cef2SBarry Smith    and optional routines of the form TSSetXXX(), but before TSStep().
1876d763cef2SBarry Smith 
1877d763cef2SBarry Smith    Level: advanced
1878d763cef2SBarry Smith 
1879d763cef2SBarry Smith .keywords: TS, timestep, setup
1880d763cef2SBarry Smith 
1881d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy()
1882d763cef2SBarry Smith @*/
18837087cfbeSBarry Smith PetscErrorCode  TSSetUp(TS ts)
1884d763cef2SBarry Smith {
1885dfbe8321SBarry Smith   PetscErrorCode ierr;
18866c6b9e74SPeter Brune   DM             dm;
18876c6b9e74SPeter Brune   PetscErrorCode (*func)(SNES,Vec,Vec,void*);
1888d1e9a80fSBarry Smith   PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*);
18896c6b9e74SPeter Brune   TSIJacobian    ijac;
18906c6b9e74SPeter Brune   TSRHSJacobian  rhsjac;
1891d763cef2SBarry Smith 
1892d763cef2SBarry Smith   PetscFunctionBegin;
18930700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1894277b19d0SLisandro Dalcin   if (ts->setupcalled) PetscFunctionReturn(0);
1895277b19d0SLisandro Dalcin 
18962c18e0fdSBarry Smith   ts->total_steps = 0;
18977adad957SLisandro Dalcin   if (!((PetscObject)ts)->type_name) {
18989596e0b4SJed Brown     ierr = TSSetType(ts,TSEULER);CHKERRQ(ierr);
1899d763cef2SBarry Smith   }
1900277b19d0SLisandro Dalcin 
1901277b19d0SLisandro Dalcin   if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first");
1902277b19d0SLisandro Dalcin 
19031c3436cfSJed Brown 
1904552698daSJed Brown   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
1905277b19d0SLisandro Dalcin 
1906e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
1907e1244c69SJed Brown     Mat Amat,Pmat;
1908e1244c69SJed Brown     SNES snes;
1909e1244c69SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1910e1244c69SJed Brown     ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr);
1911e1244c69SJed Brown     /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would
1912e1244c69SJed Brown      * have displaced the RHS matrix */
1913e1244c69SJed Brown     if (Amat == ts->Arhs) {
1914e1244c69SJed Brown       ierr = MatDuplicate(ts->Arhs,MAT_DO_NOT_COPY_VALUES,&Amat);CHKERRQ(ierr);
1915e1244c69SJed Brown       ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr);
1916e1244c69SJed Brown       ierr = MatDestroy(&Amat);CHKERRQ(ierr);
1917e1244c69SJed Brown     }
1918e1244c69SJed Brown     if (Pmat == ts->Brhs) {
1919e1244c69SJed Brown       ierr = MatDuplicate(ts->Brhs,MAT_DO_NOT_COPY_VALUES,&Pmat);CHKERRQ(ierr);
1920e1244c69SJed Brown       ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr);
1921e1244c69SJed Brown       ierr = MatDestroy(&Pmat);CHKERRQ(ierr);
1922e1244c69SJed Brown     }
1923e1244c69SJed Brown   }
1924277b19d0SLisandro Dalcin   if (ts->ops->setup) {
1925000e7ae3SMatthew Knepley     ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr);
1926277b19d0SLisandro Dalcin   }
1927277b19d0SLisandro Dalcin 
19286c6b9e74SPeter Brune   /* in the case where we've set a DMTSFunction or what have you, we need the default SNESFunction
19296c6b9e74SPeter Brune    to be set right but can't do it elsewhere due to the overreliance on ctx=ts.
19306c6b9e74SPeter Brune    */
19316c6b9e74SPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
19320298fd71SBarry Smith   ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr);
19336c6b9e74SPeter Brune   if (!func) {
19346c6b9e74SPeter Brune     ierr =DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr);
19356c6b9e74SPeter Brune   }
19366c6b9e74SPeter 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.
19376c6b9e74SPeter Brune      Otherwise, the SNES will use coloring internally to form the Jacobian.
19386c6b9e74SPeter Brune    */
19390298fd71SBarry Smith   ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr);
19400298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr);
19410298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr);
19426c6b9e74SPeter Brune   if (!jac && (ijac || rhsjac)) {
19436c6b9e74SPeter Brune     ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr);
19446c6b9e74SPeter Brune   }
1945277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_TRUE;
1946277b19d0SLisandro Dalcin   PetscFunctionReturn(0);
1947277b19d0SLisandro Dalcin }
1948277b19d0SLisandro Dalcin 
1949277b19d0SLisandro Dalcin #undef __FUNCT__
1950f6a906c0SBarry Smith #define __FUNCT__ "TSAdjointSetUp"
1951f6a906c0SBarry Smith /*@
1952f6a906c0SBarry Smith    TSAdjointSetUp - Sets up the internal data structures for the later use
1953f6a906c0SBarry Smith    of an adjoint solver
1954f6a906c0SBarry Smith 
1955f6a906c0SBarry Smith    Collective on TS
1956f6a906c0SBarry Smith 
1957f6a906c0SBarry Smith    Input Parameter:
1958f6a906c0SBarry Smith .  ts - the TS context obtained from TSCreate()
1959f6a906c0SBarry Smith 
1960f6a906c0SBarry Smith    Level: advanced
1961f6a906c0SBarry Smith 
1962f6a906c0SBarry Smith .keywords: TS, timestep, setup
1963f6a906c0SBarry Smith 
1964947abb85SHong Zhang .seealso: TSCreate(), TSAdjointStep(), TSSetCostGradients()
1965f6a906c0SBarry Smith @*/
1966f6a906c0SBarry Smith PetscErrorCode  TSAdjointSetUp(TS ts)
1967f6a906c0SBarry Smith {
1968f6a906c0SBarry Smith   PetscErrorCode ierr;
1969f6a906c0SBarry Smith 
1970f6a906c0SBarry Smith   PetscFunctionBegin;
1971f6a906c0SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1972f6a906c0SBarry Smith   if (ts->adjointsetupcalled) PetscFunctionReturn(0);
1973dfb21088SHong Zhang   if (!ts->vecs_sensi) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetCostGradients() first");
1974d8151eeaSBarry Smith 
1975947abb85SHong Zhang   if (ts->vec_costintegral) { /* if there is integral in the cost function*/
1976d8151eeaSBarry Smith     ierr = VecDuplicateVecs(ts->vecs_sensi[0],ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr);
1977d8151eeaSBarry Smith     if (ts->vecs_sensip){
1978d8151eeaSBarry Smith       ierr = VecDuplicateVecs(ts->vecs_sensip[0],ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr);
1979d8151eeaSBarry Smith     }
1980947abb85SHong Zhang   }
1981d8151eeaSBarry Smith 
198242f2b339SBarry Smith   if (ts->ops->adjointsetup) {
198342f2b339SBarry Smith     ierr = (*ts->ops->adjointsetup)(ts);CHKERRQ(ierr);
1984f6a906c0SBarry Smith   }
1985f6a906c0SBarry Smith   ts->adjointsetupcalled = PETSC_TRUE;
1986f6a906c0SBarry Smith   PetscFunctionReturn(0);
1987f6a906c0SBarry Smith }
1988f6a906c0SBarry Smith 
1989f6a906c0SBarry Smith #undef __FUNCT__
1990277b19d0SLisandro Dalcin #define __FUNCT__ "TSReset"
1991277b19d0SLisandro Dalcin /*@
1992277b19d0SLisandro Dalcin    TSReset - Resets a TS context and removes any allocated Vecs and Mats.
1993277b19d0SLisandro Dalcin 
1994277b19d0SLisandro Dalcin    Collective on TS
1995277b19d0SLisandro Dalcin 
1996277b19d0SLisandro Dalcin    Input Parameter:
1997277b19d0SLisandro Dalcin .  ts - the TS context obtained from TSCreate()
1998277b19d0SLisandro Dalcin 
1999277b19d0SLisandro Dalcin    Level: beginner
2000277b19d0SLisandro Dalcin 
2001277b19d0SLisandro Dalcin .keywords: TS, timestep, reset
2002277b19d0SLisandro Dalcin 
2003277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy()
2004277b19d0SLisandro Dalcin @*/
2005277b19d0SLisandro Dalcin PetscErrorCode  TSReset(TS ts)
2006277b19d0SLisandro Dalcin {
2007277b19d0SLisandro Dalcin   PetscErrorCode ierr;
2008277b19d0SLisandro Dalcin 
2009277b19d0SLisandro Dalcin   PetscFunctionBegin;
2010277b19d0SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2011b18ea86cSHong Zhang 
2012277b19d0SLisandro Dalcin   if (ts->ops->reset) {
2013277b19d0SLisandro Dalcin     ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr);
2014277b19d0SLisandro Dalcin   }
2015277b19d0SLisandro Dalcin   if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);}
2016e27a82bcSLisandro Dalcin   if (ts->adapt) {ierr = TSAdaptReset(ts->adapt);CHKERRQ(ierr);}
2017bbd56ea5SKarl Rupp 
20184e684422SJed Brown   ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
20194e684422SJed Brown   ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
2020214bc6a2SJed Brown   ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr);
20216bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
2022e3d84a46SJed Brown   ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
2023e3d84a46SJed Brown   ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
202438637c2eSJed Brown   ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr);
2025bbd56ea5SKarl Rupp 
2026947abb85SHong Zhang  if (ts->vec_costintegral) {
2027d8151eeaSBarry Smith     ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr);
2028d8151eeaSBarry Smith     if (ts->vecs_drdp){
2029d8151eeaSBarry Smith       ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr);
2030d8151eeaSBarry Smith     }
2031947abb85SHong Zhang   }
2032d8151eeaSBarry Smith   ts->vecs_sensi  = NULL;
2033d8151eeaSBarry Smith   ts->vecs_sensip = NULL;
2034ad8e2604SHong Zhang   ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
20352c39e106SBarry Smith   ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr);
203636eaed60SHong Zhang   ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr);
2037277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_FALSE;
2038d763cef2SBarry Smith   PetscFunctionReturn(0);
2039d763cef2SBarry Smith }
2040d763cef2SBarry Smith 
20414a2ae208SSatish Balay #undef __FUNCT__
20424a2ae208SSatish Balay #define __FUNCT__ "TSDestroy"
2043d8e5e3e6SSatish Balay /*@
2044d763cef2SBarry Smith    TSDestroy - Destroys the timestepper context that was created
2045d763cef2SBarry Smith    with TSCreate().
2046d763cef2SBarry Smith 
2047d763cef2SBarry Smith    Collective on TS
2048d763cef2SBarry Smith 
2049d763cef2SBarry Smith    Input Parameter:
2050d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2051d763cef2SBarry Smith 
2052d763cef2SBarry Smith    Level: beginner
2053d763cef2SBarry Smith 
2054d763cef2SBarry Smith .keywords: TS, timestepper, destroy
2055d763cef2SBarry Smith 
2056d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve()
2057d763cef2SBarry Smith @*/
20586bf464f9SBarry Smith PetscErrorCode  TSDestroy(TS *ts)
2059d763cef2SBarry Smith {
20606849ba73SBarry Smith   PetscErrorCode ierr;
2061d763cef2SBarry Smith 
2062d763cef2SBarry Smith   PetscFunctionBegin;
20636bf464f9SBarry Smith   if (!*ts) PetscFunctionReturn(0);
20646bf464f9SBarry Smith   PetscValidHeaderSpecific((*ts),TS_CLASSID,1);
20656bf464f9SBarry Smith   if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);}
2066d763cef2SBarry Smith 
20676bf464f9SBarry Smith   ierr = TSReset((*ts));CHKERRQ(ierr);
2068277b19d0SLisandro Dalcin 
2069e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
2070e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr);
20716bf464f9SBarry Smith   if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);}
20726d4c513bSLisandro Dalcin 
2073bc952696SBarry Smith   ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr);
2074bc952696SBarry Smith 
207584df9cb4SJed Brown   ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr);
2076aeb4809dSShri Abhyankar   if ((*ts)->event) {
2077aeb4809dSShri Abhyankar     ierr = TSEventMonitorDestroy(&(*ts)->event);CHKERRQ(ierr);
2078aeb4809dSShri Abhyankar   }
20796bf464f9SBarry Smith   ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr);
20806bf464f9SBarry Smith   ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr);
20816bf464f9SBarry Smith   ierr = TSMonitorCancel((*ts));CHKERRQ(ierr);
20820dd9f2efSHong Zhang   ierr = TSAdjointMonitorCancel((*ts));CHKERRQ(ierr);
20836d4c513bSLisandro Dalcin 
2084a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr);
2085d763cef2SBarry Smith   PetscFunctionReturn(0);
2086d763cef2SBarry Smith }
2087d763cef2SBarry Smith 
20884a2ae208SSatish Balay #undef __FUNCT__
20894a2ae208SSatish Balay #define __FUNCT__ "TSGetSNES"
2090d8e5e3e6SSatish Balay /*@
2091d763cef2SBarry Smith    TSGetSNES - Returns the SNES (nonlinear solver) associated with
2092d763cef2SBarry Smith    a TS (timestepper) context. Valid only for nonlinear problems.
2093d763cef2SBarry Smith 
2094d763cef2SBarry Smith    Not Collective, but SNES is parallel if TS is parallel
2095d763cef2SBarry Smith 
2096d763cef2SBarry Smith    Input Parameter:
2097d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2098d763cef2SBarry Smith 
2099d763cef2SBarry Smith    Output Parameter:
2100d763cef2SBarry Smith .  snes - the nonlinear solver context
2101d763cef2SBarry Smith 
2102d763cef2SBarry Smith    Notes:
2103d763cef2SBarry Smith    The user can then directly manipulate the SNES context to set various
2104d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
210594b7f48cSBarry Smith    KSP, KSP, and PC contexts as well.
2106d763cef2SBarry Smith 
2107d763cef2SBarry Smith    TSGetSNES() does not work for integrators that do not use SNES; in
21080298fd71SBarry Smith    this case TSGetSNES() returns NULL in snes.
2109d763cef2SBarry Smith 
2110d763cef2SBarry Smith    Level: beginner
2111d763cef2SBarry Smith 
2112d763cef2SBarry Smith .keywords: timestep, get, SNES
2113d763cef2SBarry Smith @*/
21147087cfbeSBarry Smith PetscErrorCode  TSGetSNES(TS ts,SNES *snes)
2115d763cef2SBarry Smith {
2116d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2117d372ba47SLisandro Dalcin 
2118d763cef2SBarry Smith   PetscFunctionBegin;
21190700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
21204482741eSBarry Smith   PetscValidPointer(snes,2);
2121d372ba47SLisandro Dalcin   if (!ts->snes) {
2122ce94432eSBarry Smith     ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr);
21230298fd71SBarry Smith     ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
21243bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr);
2125d372ba47SLisandro Dalcin     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr);
2126496e6a7aSJed Brown     if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
21279e2a6581SJed Brown     if (ts->problem_type == TS_LINEAR) {
21289e2a6581SJed Brown       ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);
21299e2a6581SJed Brown     }
2130d372ba47SLisandro Dalcin   }
2131d763cef2SBarry Smith   *snes = ts->snes;
2132d763cef2SBarry Smith   PetscFunctionReturn(0);
2133d763cef2SBarry Smith }
2134d763cef2SBarry Smith 
21354a2ae208SSatish Balay #undef __FUNCT__
2136deb2cd25SJed Brown #define __FUNCT__ "TSSetSNES"
2137deb2cd25SJed Brown /*@
2138deb2cd25SJed Brown    TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context
2139deb2cd25SJed Brown 
2140deb2cd25SJed Brown    Collective
2141deb2cd25SJed Brown 
2142deb2cd25SJed Brown    Input Parameter:
2143deb2cd25SJed Brown +  ts - the TS context obtained from TSCreate()
2144deb2cd25SJed Brown -  snes - the nonlinear solver context
2145deb2cd25SJed Brown 
2146deb2cd25SJed Brown    Notes:
2147deb2cd25SJed Brown    Most users should have the TS created by calling TSGetSNES()
2148deb2cd25SJed Brown 
2149deb2cd25SJed Brown    Level: developer
2150deb2cd25SJed Brown 
2151deb2cd25SJed Brown .keywords: timestep, set, SNES
2152deb2cd25SJed Brown @*/
2153deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes)
2154deb2cd25SJed Brown {
2155deb2cd25SJed Brown   PetscErrorCode ierr;
2156d1e9a80fSBarry Smith   PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*);
2157deb2cd25SJed Brown 
2158deb2cd25SJed Brown   PetscFunctionBegin;
2159deb2cd25SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2160deb2cd25SJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,2);
2161deb2cd25SJed Brown   ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr);
2162deb2cd25SJed Brown   ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr);
2163bbd56ea5SKarl Rupp 
2164deb2cd25SJed Brown   ts->snes = snes;
2165bbd56ea5SKarl Rupp 
21660298fd71SBarry Smith   ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
21670298fd71SBarry Smith   ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr);
2168740132f1SEmil Constantinescu   if (func == SNESTSFormJacobian) {
21690298fd71SBarry Smith     ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr);
2170740132f1SEmil Constantinescu   }
2171deb2cd25SJed Brown   PetscFunctionReturn(0);
2172deb2cd25SJed Brown }
2173deb2cd25SJed Brown 
2174deb2cd25SJed Brown #undef __FUNCT__
217594b7f48cSBarry Smith #define __FUNCT__ "TSGetKSP"
2176d8e5e3e6SSatish Balay /*@
217794b7f48cSBarry Smith    TSGetKSP - Returns the KSP (linear solver) associated with
2178d763cef2SBarry Smith    a TS (timestepper) context.
2179d763cef2SBarry Smith 
218094b7f48cSBarry Smith    Not Collective, but KSP is parallel if TS is parallel
2181d763cef2SBarry Smith 
2182d763cef2SBarry Smith    Input Parameter:
2183d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2184d763cef2SBarry Smith 
2185d763cef2SBarry Smith    Output Parameter:
218694b7f48cSBarry Smith .  ksp - the nonlinear solver context
2187d763cef2SBarry Smith 
2188d763cef2SBarry Smith    Notes:
218994b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
2190d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
2191d763cef2SBarry Smith    KSP and PC contexts as well.
2192d763cef2SBarry Smith 
219394b7f48cSBarry Smith    TSGetKSP() does not work for integrators that do not use KSP;
21940298fd71SBarry Smith    in this case TSGetKSP() returns NULL in ksp.
2195d763cef2SBarry Smith 
2196d763cef2SBarry Smith    Level: beginner
2197d763cef2SBarry Smith 
219894b7f48cSBarry Smith .keywords: timestep, get, KSP
2199d763cef2SBarry Smith @*/
22007087cfbeSBarry Smith PetscErrorCode  TSGetKSP(TS ts,KSP *ksp)
2201d763cef2SBarry Smith {
2202d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2203089b2837SJed Brown   SNES           snes;
2204d372ba47SLisandro Dalcin 
2205d763cef2SBarry Smith   PetscFunctionBegin;
22060700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
22074482741eSBarry Smith   PetscValidPointer(ksp,2);
220817186662SBarry Smith   if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first");
2209e32f2f54SBarry Smith   if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()");
2210089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2211089b2837SJed Brown   ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr);
2212d763cef2SBarry Smith   PetscFunctionReturn(0);
2213d763cef2SBarry Smith }
2214d763cef2SBarry Smith 
2215d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */
2216d763cef2SBarry Smith 
22174a2ae208SSatish Balay #undef __FUNCT__
2218adb62b0dSMatthew Knepley #define __FUNCT__ "TSGetDuration"
2219adb62b0dSMatthew Knepley /*@
2220adb62b0dSMatthew Knepley    TSGetDuration - Gets the maximum number of timesteps to use and
2221adb62b0dSMatthew Knepley    maximum time for iteration.
2222adb62b0dSMatthew Knepley 
22233f9fe445SBarry Smith    Not Collective
2224adb62b0dSMatthew Knepley 
2225adb62b0dSMatthew Knepley    Input Parameters:
2226adb62b0dSMatthew Knepley +  ts       - the TS context obtained from TSCreate()
22270298fd71SBarry Smith .  maxsteps - maximum number of iterations to use, or NULL
22280298fd71SBarry Smith -  maxtime  - final time to iterate to, or NULL
2229adb62b0dSMatthew Knepley 
2230adb62b0dSMatthew Knepley    Level: intermediate
2231adb62b0dSMatthew Knepley 
2232adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time
2233adb62b0dSMatthew Knepley @*/
22347087cfbeSBarry Smith PetscErrorCode  TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
2235adb62b0dSMatthew Knepley {
2236adb62b0dSMatthew Knepley   PetscFunctionBegin;
22370700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2238abc0a331SBarry Smith   if (maxsteps) {
22394482741eSBarry Smith     PetscValidIntPointer(maxsteps,2);
2240adb62b0dSMatthew Knepley     *maxsteps = ts->max_steps;
2241adb62b0dSMatthew Knepley   }
2242abc0a331SBarry Smith   if (maxtime) {
22434482741eSBarry Smith     PetscValidScalarPointer(maxtime,3);
2244adb62b0dSMatthew Knepley     *maxtime = ts->max_time;
2245adb62b0dSMatthew Knepley   }
2246adb62b0dSMatthew Knepley   PetscFunctionReturn(0);
2247adb62b0dSMatthew Knepley }
2248adb62b0dSMatthew Knepley 
2249adb62b0dSMatthew Knepley #undef __FUNCT__
22504a2ae208SSatish Balay #define __FUNCT__ "TSSetDuration"
2251d763cef2SBarry Smith /*@
2252d763cef2SBarry Smith    TSSetDuration - Sets the maximum number of timesteps to use and
2253d763cef2SBarry Smith    maximum time for iteration.
2254d763cef2SBarry Smith 
22553f9fe445SBarry Smith    Logically Collective on TS
2256d763cef2SBarry Smith 
2257d763cef2SBarry Smith    Input Parameters:
2258d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2259d763cef2SBarry Smith .  maxsteps - maximum number of iterations to use
2260d763cef2SBarry Smith -  maxtime - final time to iterate to
2261d763cef2SBarry Smith 
2262d763cef2SBarry Smith    Options Database Keys:
2263d763cef2SBarry Smith .  -ts_max_steps <maxsteps> - Sets maxsteps
22643bca7d26SBarry Smith .  -ts_final_time <maxtime> - Sets maxtime
2265d763cef2SBarry Smith 
2266d763cef2SBarry Smith    Notes:
2267d763cef2SBarry Smith    The default maximum number of iterations is 5000. Default time is 5.0
2268d763cef2SBarry Smith 
2269d763cef2SBarry Smith    Level: intermediate
2270d763cef2SBarry Smith 
2271d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations
2272a43b19c4SJed Brown 
2273a43b19c4SJed Brown .seealso: TSSetExactFinalTime()
2274d763cef2SBarry Smith @*/
22757087cfbeSBarry Smith PetscErrorCode  TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
2276d763cef2SBarry Smith {
2277d763cef2SBarry Smith   PetscFunctionBegin;
22780700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2279c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
2280c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,maxtime,2);
228139b7ec4bSSean Farley   if (maxsteps >= 0) ts->max_steps = maxsteps;
228239b7ec4bSSean Farley   if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime;
2283d763cef2SBarry Smith   PetscFunctionReturn(0);
2284d763cef2SBarry Smith }
2285d763cef2SBarry Smith 
22864a2ae208SSatish Balay #undef __FUNCT__
22874a2ae208SSatish Balay #define __FUNCT__ "TSSetSolution"
2288d763cef2SBarry Smith /*@
2289d763cef2SBarry Smith    TSSetSolution - Sets the initial solution vector
2290d763cef2SBarry Smith    for use by the TS routines.
2291d763cef2SBarry Smith 
22923f9fe445SBarry Smith    Logically Collective on TS and Vec
2293d763cef2SBarry Smith 
2294d763cef2SBarry Smith    Input Parameters:
2295d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
22960910c330SBarry Smith -  u - the solution vector
2297d763cef2SBarry Smith 
2298d763cef2SBarry Smith    Level: beginner
2299d763cef2SBarry Smith 
2300d763cef2SBarry Smith .keywords: TS, timestep, set, solution, initial conditions
2301d763cef2SBarry Smith @*/
23020910c330SBarry Smith PetscErrorCode  TSSetSolution(TS ts,Vec u)
2303d763cef2SBarry Smith {
23048737fe31SLisandro Dalcin   PetscErrorCode ierr;
2305496e6a7aSJed Brown   DM             dm;
23068737fe31SLisandro Dalcin 
2307d763cef2SBarry Smith   PetscFunctionBegin;
23080700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
23090910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
23100910c330SBarry Smith   ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr);
23116bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
2312bbd56ea5SKarl Rupp 
23130910c330SBarry Smith   ts->vec_sol = u;
2314bbd56ea5SKarl Rupp 
2315496e6a7aSJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
23160910c330SBarry Smith   ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr);
2317d763cef2SBarry Smith   PetscFunctionReturn(0);
2318d763cef2SBarry Smith }
2319d763cef2SBarry Smith 
2320e74ef692SMatthew Knepley #undef __FUNCT__
232173b18844SBarry Smith #define __FUNCT__ "TSAdjointSetSteps"
232273b18844SBarry Smith /*@
232373b18844SBarry Smith    TSAdjointSetSteps - Sets the number of steps the adjoint solver should take backward in time
232473b18844SBarry Smith 
232573b18844SBarry Smith    Logically Collective on TS
232673b18844SBarry Smith 
232773b18844SBarry Smith    Input Parameters:
232873b18844SBarry Smith +  ts - the TS context obtained from TSCreate()
232973b18844SBarry Smith .  steps - number of steps to use
233073b18844SBarry Smith 
233173b18844SBarry Smith    Level: intermediate
233273b18844SBarry Smith 
233373b18844SBarry Smith    Notes: Normally one does not call this and TSAdjointSolve() integrates back to the original timestep. One can call this
233473b18844SBarry Smith           so as to integrate back to less than the original timestep
233573b18844SBarry Smith 
233673b18844SBarry Smith .keywords: TS, timestep, set, maximum, iterations
233773b18844SBarry Smith 
233873b18844SBarry Smith .seealso: TSSetExactFinalTime()
233973b18844SBarry Smith @*/
234073b18844SBarry Smith PetscErrorCode  TSAdjointSetSteps(TS ts,PetscInt steps)
234173b18844SBarry Smith {
234273b18844SBarry Smith   PetscFunctionBegin;
234373b18844SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
234473b18844SBarry Smith   PetscValidLogicalCollectiveInt(ts,steps,2);
234573b18844SBarry Smith   if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back a negative number of steps");
234673b18844SBarry Smith   if (steps > ts->total_steps) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back more than the total number of forward steps");
234773b18844SBarry Smith   ts->adjoint_max_steps = steps;
234873b18844SBarry Smith   PetscFunctionReturn(0);
234973b18844SBarry Smith }
235073b18844SBarry Smith 
235173b18844SBarry Smith #undef __FUNCT__
2352dfb21088SHong Zhang #define __FUNCT__ "TSSetCostGradients"
2353c235aa8dSHong Zhang /*@
2354dfb21088SHong Zhang    TSSetCostGradients - Sets the initial value of the gradients of the cost function w.r.t. initial conditions and w.r.t. the problem parameters
23550cf82b59SBarry Smith       for use by the TSAdjoint routines.
2356c235aa8dSHong Zhang 
2357c235aa8dSHong Zhang    Logically Collective on TS and Vec
2358c235aa8dSHong Zhang 
2359c235aa8dSHong Zhang    Input Parameters:
2360c235aa8dSHong Zhang +  ts - the TS context obtained from TSCreate()
2361abc2977eSBarry Smith .  lambda - gradients with respect to the initial condition variables, the dimension and parallel layout of these vectors is the same as the ODE solution vector
2362abc2977eSBarry Smith -  mu - gradients with respect to the parameters, the number of entries in these vectors is the same as the number of parameters
2363c235aa8dSHong Zhang 
2364c235aa8dSHong Zhang    Level: beginner
2365c235aa8dSHong Zhang 
2366abc2977eSBarry Smith    Notes: the entries in these vectors must be correctly initialized with the values lamda_i = df/dy|finaltime  mu_i = df/dp|finaltime
23670cf82b59SBarry Smith 
2368c235aa8dSHong Zhang .keywords: TS, timestep, set, sensitivity, initial conditions
2369c235aa8dSHong Zhang @*/
2370dfb21088SHong Zhang PetscErrorCode  TSSetCostGradients(TS ts,PetscInt numcost,Vec *lambda,Vec *mu)
2371c235aa8dSHong Zhang {
2372c235aa8dSHong Zhang   PetscFunctionBegin;
2373c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2374abc2977eSBarry Smith   PetscValidPointer(lambda,2);
2375abc2977eSBarry Smith   ts->vecs_sensi  = lambda;
2376abc2977eSBarry Smith   ts->vecs_sensip = mu;
2377dfb21088SHong Zhang   if (ts->numcost && ts->numcost!=numcost) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"The number of cost functions (2rd parameter of TSSetCostIntegrand()) is inconsistent with the one set by TSSetCostIntegrand");
2378abc2977eSBarry Smith   ts->numcost  = numcost;
2379ad8e2604SHong Zhang   PetscFunctionReturn(0);
2380ad8e2604SHong Zhang }
2381ad8e2604SHong Zhang 
2382ad8e2604SHong Zhang #undef __FUNCT__
23835bf8c567SBarry Smith #define __FUNCT__ "TSAdjointSetRHSJacobian"
2384ad8e2604SHong Zhang /*@C
23850cf82b59SBarry Smith   TSAdjointSetRHSJacobian - Sets the function that computes the Jacobian of G w.r.t. the parameters p where y_t = G(y,p,t), as well as the location to store the matrix.
2386ad8e2604SHong Zhang 
2387ad8e2604SHong Zhang   Logically Collective on TS
2388ad8e2604SHong Zhang 
2389ad8e2604SHong Zhang   Input Parameters:
2390ad8e2604SHong Zhang + ts   - The TS context obtained from TSCreate()
2391ad8e2604SHong Zhang - func - The function
2392ad8e2604SHong Zhang 
2393ad8e2604SHong Zhang   Calling sequence of func:
23940cf82b59SBarry Smith $ func (TS ts,PetscReal t,Vec y,Mat A,void *ctx);
239505755b9cSHong Zhang +   t - current timestep
23960cf82b59SBarry Smith .   y - input vector (current ODE solution)
239705755b9cSHong Zhang .   A - output matrix
239805755b9cSHong Zhang -   ctx - [optional] user-defined function context
2399ad8e2604SHong Zhang 
2400ad8e2604SHong Zhang   Level: intermediate
2401ad8e2604SHong Zhang 
24020cf82b59SBarry Smith   Notes: Amat has the same number of rows and the same row parallel layout as u, Amat has the same number of columns and parallel layout as p
24030cf82b59SBarry Smith 
2404ad8e2604SHong Zhang .keywords: TS, sensitivity
2405ad8e2604SHong Zhang .seealso:
2406ad8e2604SHong Zhang @*/
24075bf8c567SBarry Smith PetscErrorCode  TSAdjointSetRHSJacobian(TS ts,Mat Amat,PetscErrorCode (*func)(TS,PetscReal,Vec,Mat,void*),void *ctx)
2408ad8e2604SHong Zhang {
2409ad8e2604SHong Zhang   PetscErrorCode ierr;
2410ad8e2604SHong Zhang 
2411ad8e2604SHong Zhang   PetscFunctionBegin;
2412ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2413ad8e2604SHong Zhang   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
2414ad8e2604SHong Zhang 
2415ad8e2604SHong Zhang   ts->rhsjacobianp    = func;
2416ad8e2604SHong Zhang   ts->rhsjacobianpctx = ctx;
2417ad8e2604SHong Zhang   if(Amat) {
2418ad8e2604SHong Zhang     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
2419ad8e2604SHong Zhang     ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
2420ad8e2604SHong Zhang     ts->Jacp = Amat;
2421ad8e2604SHong Zhang   }
2422ad8e2604SHong Zhang   PetscFunctionReturn(0);
2423ad8e2604SHong Zhang }
2424ad8e2604SHong Zhang 
2425ad8e2604SHong Zhang #undef __FUNCT__
24265bf8c567SBarry Smith #define __FUNCT__ "TSAdjointComputeRHSJacobian"
24270cf82b59SBarry Smith /*@C
24285bf8c567SBarry Smith   TSAdjointComputeRHSJacobian - Runs the user-defined Jacobian function.
2429ad8e2604SHong Zhang 
2430ad8e2604SHong Zhang   Collective on TS
2431ad8e2604SHong Zhang 
2432ad8e2604SHong Zhang   Input Parameters:
2433ad8e2604SHong Zhang . ts   - The TS context obtained from TSCreate()
2434ad8e2604SHong Zhang 
2435ad8e2604SHong Zhang   Level: developer
2436ad8e2604SHong Zhang 
2437ad8e2604SHong Zhang .keywords: TS, sensitivity
24385bf8c567SBarry Smith .seealso: TSAdjointSetRHSJacobian()
2439ad8e2604SHong Zhang @*/
24405bf8c567SBarry Smith PetscErrorCode  TSAdjointComputeRHSJacobian(TS ts,PetscReal t,Vec X,Mat Amat)
2441ad8e2604SHong Zhang {
2442ad8e2604SHong Zhang   PetscErrorCode ierr;
2443ad8e2604SHong Zhang 
2444ad8e2604SHong Zhang   PetscFunctionBegin;
2445ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2446ad8e2604SHong Zhang   PetscValidHeaderSpecific(X,VEC_CLASSID,3);
2447ad8e2604SHong Zhang   PetscValidPointer(Amat,4);
2448ad8e2604SHong Zhang 
2449ad8e2604SHong Zhang   PetscStackPush("TS user JacobianP function for sensitivity analysis");
2450ad8e2604SHong Zhang   ierr = (*ts->rhsjacobianp)(ts,t,X,Amat,ts->rhsjacobianpctx); CHKERRQ(ierr);
2451ad8e2604SHong Zhang   PetscStackPop;
2452c235aa8dSHong Zhang   PetscFunctionReturn(0);
2453c235aa8dSHong Zhang }
2454c235aa8dSHong Zhang 
2455c235aa8dSHong Zhang #undef __FUNCT__
2456dfb21088SHong Zhang #define __FUNCT__ "TSSetCostIntegrand"
24576fd0887fSHong Zhang /*@C
2458dfb21088SHong Zhang     TSSetCostIntegrand - Sets the routine for evaluating the integral term in one or more cost functions
24596fd0887fSHong Zhang 
24606fd0887fSHong Zhang     Logically Collective on TS
24616fd0887fSHong Zhang 
24626fd0887fSHong Zhang     Input Parameters:
24636fd0887fSHong Zhang +   ts - the TS context obtained from TSCreate()
2464abc2977eSBarry Smith .   numcost - number of gradients to be computed, this is the number of cost functions
24650cf82b59SBarry Smith .   rf - routine for evaluating the integrand function
2466b612ec54SBarry Smith .   drdyf - function that computes the gradients of the r's with respect to y,NULL if not a function y
2467b612ec54SBarry Smith .   drdpf - function that computes the gradients of the r's with respect to p, NULL if not a function of p
2468b612ec54SBarry Smith -   ctx - [optional] user-defined context for private data for the function evaluation routine (may be NULL)
24696fd0887fSHong Zhang 
24700cf82b59SBarry Smith     Calling sequence of rf:
24710cf82b59SBarry Smith $     rf(TS ts,PetscReal t,Vec y,Vec f[],void *ctx);
24726fd0887fSHong Zhang 
24736fd0887fSHong Zhang +   t - current timestep
24740cf82b59SBarry Smith .   y - input vector
24750cf82b59SBarry Smith .   f - function result; one vector entry for each cost function
24766fd0887fSHong Zhang -   ctx - [optional] user-defined function context
24776fd0887fSHong Zhang 
2478b612ec54SBarry Smith    Calling sequence of drdyf:
24790cf82b59SBarry Smith $    PetscErroCode drdyf(TS ts,PetscReal t,Vec y,Vec *drdy,void *ctx);
2480b612ec54SBarry Smith 
2481b612ec54SBarry Smith    Calling sequence of drdpf:
24820cf82b59SBarry Smith $    PetscErroCode drdpf(TS ts,PetscReal t,Vec y,Vec *drdp,void *ctx);
2483b612ec54SBarry Smith 
2484b612ec54SBarry Smith     Level: intermediate
24856fd0887fSHong Zhang 
2486abc2977eSBarry Smith     Notes: For optimization there is generally a single cost function, numcost = 1. For sensitivities there may be multiple cost functions
24870cf82b59SBarry Smith 
24886fd0887fSHong Zhang .keywords: TS, sensitivity analysis, timestep, set, quadrature, function
24896fd0887fSHong Zhang 
2490dfb21088SHong Zhang .seealso: TSAdjointSetRHSJacobian(),TSGetCostGradients(), TSSetCostGradients()
24916fd0887fSHong Zhang @*/
2492dfb21088SHong Zhang PetscErrorCode  TSSetCostIntegrand(TS ts,PetscInt numcost, PetscErrorCode (*rf)(TS,PetscReal,Vec,Vec,void*),
2493d8151eeaSBarry Smith                                                                   PetscErrorCode (*drdyf)(TS,PetscReal,Vec,Vec*,void*),
2494d8151eeaSBarry Smith                                                                   PetscErrorCode (*drdpf)(TS,PetscReal,Vec,Vec*,void*),void *ctx)
24956fd0887fSHong Zhang {
24966fd0887fSHong Zhang   PetscErrorCode ierr;
24976fd0887fSHong Zhang 
24986fd0887fSHong Zhang   PetscFunctionBegin;
24996fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2500dfb21088SHong Zhang   if (ts->numcost && ts->numcost!=numcost) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"The number of cost functions (2rd parameter of TSSetCostIntegrand()) is inconsistent with the one set by TSSetCostGradients()");
2501c72ed514SHong Zhang   if (!ts->numcost) ts->numcost=numcost;
25026fd0887fSHong Zhang 
2503abc2977eSBarry Smith   ierr                 = VecCreateSeq(PETSC_COMM_SELF,numcost,&ts->vec_costintegral);CHKERRQ(ierr);
25042c39e106SBarry Smith   ierr                 = VecDuplicate(ts->vec_costintegral,&ts->vec_costintegrand);CHKERRQ(ierr);
25050cf82b59SBarry Smith   ts->costintegrand    = rf;
250605755b9cSHong Zhang   ts->costintegrandctx = ctx;
2507b612ec54SBarry Smith   ts->drdyfunction     = drdyf;
2508b612ec54SBarry Smith   ts->drdpfunction     = drdpf;
25096fd0887fSHong Zhang   PetscFunctionReturn(0);
25106fd0887fSHong Zhang }
25116fd0887fSHong Zhang 
25126fd0887fSHong Zhang #undef __FUNCT__
2513dfb21088SHong Zhang #define __FUNCT__ "TSGetCostIntegral"
251436eaed60SHong Zhang /*@
2515dfb21088SHong Zhang    TSGetCostIntegral - Returns the values of the integral term in the cost functions.
251636eaed60SHong Zhang    It is valid to call the routine after a backward run.
251736eaed60SHong Zhang 
251836eaed60SHong Zhang    Not Collective
251936eaed60SHong Zhang 
252036eaed60SHong Zhang    Input Parameter:
252136eaed60SHong Zhang .  ts - the TS context obtained from TSCreate()
252236eaed60SHong Zhang 
252336eaed60SHong Zhang    Output Parameter:
25242c39e106SBarry Smith .  v - the vector containing the integrals for each cost function
252536eaed60SHong Zhang 
252636eaed60SHong Zhang    Level: intermediate
252736eaed60SHong Zhang 
2528dfb21088SHong Zhang .seealso: TSSetCostIntegrand()
252936eaed60SHong Zhang 
253036eaed60SHong Zhang .keywords: TS, sensitivity analysis
253136eaed60SHong Zhang @*/
2532dfb21088SHong Zhang PetscErrorCode  TSGetCostIntegral(TS ts,Vec *v)
253336eaed60SHong Zhang {
253436eaed60SHong Zhang   PetscFunctionBegin;
253536eaed60SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
253636eaed60SHong Zhang   PetscValidPointer(v,2);
25372c39e106SBarry Smith   *v = ts->vec_costintegral;
253836eaed60SHong Zhang   PetscFunctionReturn(0);
253936eaed60SHong Zhang }
254036eaed60SHong Zhang 
254136eaed60SHong Zhang #undef __FUNCT__
2542d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeCostIntegrand"
25436fd0887fSHong Zhang /*@
25442c39e106SBarry Smith    TSAdjointComputeCostIntegrand - Evaluates the integral function in the cost functions.
25456fd0887fSHong Zhang 
25466fd0887fSHong Zhang    Input Parameters:
25476fd0887fSHong Zhang +  ts - the TS context
25486fd0887fSHong Zhang .  t - current time
25490cf82b59SBarry Smith -  y - state vector, i.e. current solution
25506fd0887fSHong Zhang 
25516fd0887fSHong Zhang    Output Parameter:
2552abc2977eSBarry Smith .  q - vector of size numcost to hold the outputs
25536fd0887fSHong Zhang 
25546fd0887fSHong Zhang    Note:
25556fd0887fSHong Zhang    Most users should not need to explicitly call this routine, as it
25566fd0887fSHong Zhang    is used internally within the sensitivity analysis context.
25576fd0887fSHong Zhang 
25586fd0887fSHong Zhang    Level: developer
25596fd0887fSHong Zhang 
25606fd0887fSHong Zhang .keywords: TS, compute
25616fd0887fSHong Zhang 
2562dfb21088SHong Zhang .seealso: TSSetCostIntegrand()
25636fd0887fSHong Zhang @*/
25640cf82b59SBarry Smith PetscErrorCode TSAdjointComputeCostIntegrand(TS ts,PetscReal t,Vec y,Vec q)
25656fd0887fSHong Zhang {
25666fd0887fSHong Zhang   PetscErrorCode ierr;
25676fd0887fSHong Zhang 
25686fd0887fSHong Zhang   PetscFunctionBegin;
25696fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
25700cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
25716fd0887fSHong Zhang   PetscValidHeaderSpecific(q,VEC_CLASSID,4);
25726fd0887fSHong Zhang 
25730cf82b59SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
2574e4680132SHong Zhang   if (ts->costintegrand) {
2575e4680132SHong Zhang     PetscStackPush("TS user integrand in the cost function");
25760cf82b59SBarry Smith     ierr = (*ts->costintegrand)(ts,t,y,q,ts->costintegrandctx);CHKERRQ(ierr);
25776fd0887fSHong Zhang     PetscStackPop;
25786fd0887fSHong Zhang   } else {
25796fd0887fSHong Zhang     ierr = VecZeroEntries(q);CHKERRQ(ierr);
25806fd0887fSHong Zhang   }
25816fd0887fSHong Zhang 
25820cf82b59SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
25836fd0887fSHong Zhang   PetscFunctionReturn(0);
25846fd0887fSHong Zhang }
25856fd0887fSHong Zhang 
25866fd0887fSHong Zhang #undef __FUNCT__
2587d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeDRDYFunction"
258805755b9cSHong Zhang /*@
2589d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction - Runs the user-defined DRDY function.
259005755b9cSHong Zhang 
259105755b9cSHong Zhang   Collective on TS
259205755b9cSHong Zhang 
259305755b9cSHong Zhang   Input Parameters:
259405755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
259505755b9cSHong Zhang 
259605755b9cSHong Zhang   Notes:
2597d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction() is typically used for sensitivity implementation,
259805755b9cSHong Zhang   so most users would not generally call this routine themselves.
259905755b9cSHong Zhang 
260005755b9cSHong Zhang   Level: developer
260105755b9cSHong Zhang 
260205755b9cSHong Zhang .keywords: TS, sensitivity
2603d4aa0a58SBarry Smith .seealso: TSAdjointComputeDRDYFunction()
260405755b9cSHong Zhang @*/
26050cf82b59SBarry Smith PetscErrorCode  TSAdjointComputeDRDYFunction(TS ts,PetscReal t,Vec y,Vec *drdy)
260605755b9cSHong Zhang {
260705755b9cSHong Zhang   PetscErrorCode ierr;
260805755b9cSHong Zhang 
260905755b9cSHong Zhang   PetscFunctionBegin;
261005755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
26110cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
261205755b9cSHong Zhang 
261305755b9cSHong Zhang   PetscStackPush("TS user DRDY function for sensitivity analysis");
26140cf82b59SBarry Smith   ierr = (*ts->drdyfunction)(ts,t,y,drdy,ts->costintegrandctx); CHKERRQ(ierr);
261505755b9cSHong Zhang   PetscStackPop;
261605755b9cSHong Zhang   PetscFunctionReturn(0);
261705755b9cSHong Zhang }
261805755b9cSHong Zhang 
261905755b9cSHong Zhang #undef __FUNCT__
2620d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeDRDPFunction"
262105755b9cSHong Zhang /*@
2622d4aa0a58SBarry Smith   TSAdjointComputeDRDPFunction - Runs the user-defined DRDP function.
262305755b9cSHong Zhang 
262405755b9cSHong Zhang   Collective on TS
262505755b9cSHong Zhang 
262605755b9cSHong Zhang   Input Parameters:
262705755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
262805755b9cSHong Zhang 
262905755b9cSHong Zhang   Notes:
263005755b9cSHong Zhang   TSDRDPFunction() is typically used for sensitivity implementation,
263105755b9cSHong Zhang   so most users would not generally call this routine themselves.
263205755b9cSHong Zhang 
263305755b9cSHong Zhang   Level: developer
263405755b9cSHong Zhang 
263505755b9cSHong Zhang .keywords: TS, sensitivity
2636d4aa0a58SBarry Smith .seealso: TSAdjointSetDRDPFunction()
263705755b9cSHong Zhang @*/
26380cf82b59SBarry Smith PetscErrorCode  TSAdjointComputeDRDPFunction(TS ts,PetscReal t,Vec y,Vec *drdp)
263905755b9cSHong Zhang {
264005755b9cSHong Zhang   PetscErrorCode ierr;
264105755b9cSHong Zhang 
264205755b9cSHong Zhang   PetscFunctionBegin;
264305755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
26440cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
264505755b9cSHong Zhang 
264605755b9cSHong Zhang   PetscStackPush("TS user DRDP function for sensitivity analysis");
26470cf82b59SBarry Smith   ierr = (*ts->drdpfunction)(ts,t,y,drdp,ts->costintegrandctx); CHKERRQ(ierr);
264805755b9cSHong Zhang   PetscStackPop;
264905755b9cSHong Zhang   PetscFunctionReturn(0);
265005755b9cSHong Zhang }
265105755b9cSHong Zhang 
265205755b9cSHong Zhang #undef __FUNCT__
2653e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPreStep"
2654ac226902SBarry Smith /*@C
2655000e7ae3SMatthew Knepley   TSSetPreStep - Sets the general-purpose function
26563f2090d5SJed Brown   called once at the beginning of each time step.
2657000e7ae3SMatthew Knepley 
26583f9fe445SBarry Smith   Logically Collective on TS
2659000e7ae3SMatthew Knepley 
2660000e7ae3SMatthew Knepley   Input Parameters:
2661000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
2662000e7ae3SMatthew Knepley - func - The function
2663000e7ae3SMatthew Knepley 
2664000e7ae3SMatthew Knepley   Calling sequence of func:
2665000e7ae3SMatthew Knepley . func (TS ts);
2666000e7ae3SMatthew Knepley 
2667000e7ae3SMatthew Knepley   Level: intermediate
2668000e7ae3SMatthew Knepley 
2669b8123daeSJed Brown   Note:
2670b8123daeSJed Brown   If a step is rejected, TSStep() will call this routine again before each attempt.
2671b8123daeSJed Brown   The last completed time step number can be queried using TSGetTimeStepNumber(), the
2672b8123daeSJed Brown   size of the step being attempted can be obtained using TSGetTimeStep().
2673b8123daeSJed Brown 
2674000e7ae3SMatthew Knepley .keywords: TS, timestep
26759be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep()
2676000e7ae3SMatthew Knepley @*/
26777087cfbeSBarry Smith PetscErrorCode  TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
2678000e7ae3SMatthew Knepley {
2679000e7ae3SMatthew Knepley   PetscFunctionBegin;
26800700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2681ae60f76fSBarry Smith   ts->prestep = func;
2682000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
2683000e7ae3SMatthew Knepley }
2684000e7ae3SMatthew Knepley 
2685e74ef692SMatthew Knepley #undef __FUNCT__
26863f2090d5SJed Brown #define __FUNCT__ "TSPreStep"
268709ee8438SJed Brown /*@
26883f2090d5SJed Brown   TSPreStep - Runs the user-defined pre-step function.
26893f2090d5SJed Brown 
26903f2090d5SJed Brown   Collective on TS
26913f2090d5SJed Brown 
26923f2090d5SJed Brown   Input Parameters:
26933f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
26943f2090d5SJed Brown 
26953f2090d5SJed Brown   Notes:
26963f2090d5SJed Brown   TSPreStep() is typically used within time stepping implementations,
26973f2090d5SJed Brown   so most users would not generally call this routine themselves.
26983f2090d5SJed Brown 
26993f2090d5SJed Brown   Level: developer
27003f2090d5SJed Brown 
27013f2090d5SJed Brown .keywords: TS, timestep
27029be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep()
27033f2090d5SJed Brown @*/
27047087cfbeSBarry Smith PetscErrorCode  TSPreStep(TS ts)
27053f2090d5SJed Brown {
27063f2090d5SJed Brown   PetscErrorCode ierr;
27073f2090d5SJed Brown 
27083f2090d5SJed Brown   PetscFunctionBegin;
27090700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2710ae60f76fSBarry Smith   if (ts->prestep) {
2711ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestep),(ts));
2712312ce896SJed Brown   }
27133f2090d5SJed Brown   PetscFunctionReturn(0);
27143f2090d5SJed Brown }
27153f2090d5SJed Brown 
27163f2090d5SJed Brown #undef __FUNCT__
2717b8123daeSJed Brown #define __FUNCT__ "TSSetPreStage"
2718b8123daeSJed Brown /*@C
2719b8123daeSJed Brown   TSSetPreStage - Sets the general-purpose function
2720b8123daeSJed Brown   called once at the beginning of each stage.
2721b8123daeSJed Brown 
2722b8123daeSJed Brown   Logically Collective on TS
2723b8123daeSJed Brown 
2724b8123daeSJed Brown   Input Parameters:
2725b8123daeSJed Brown + ts   - The TS context obtained from TSCreate()
2726b8123daeSJed Brown - func - The function
2727b8123daeSJed Brown 
2728b8123daeSJed Brown   Calling sequence of func:
2729b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime);
2730b8123daeSJed Brown 
2731b8123daeSJed Brown   Level: intermediate
2732b8123daeSJed Brown 
2733b8123daeSJed Brown   Note:
2734b8123daeSJed Brown   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
2735b8123daeSJed Brown   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
2736b8123daeSJed Brown   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
2737b8123daeSJed Brown 
2738b8123daeSJed Brown .keywords: TS, timestep
27399be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
2740b8123daeSJed Brown @*/
2741b8123daeSJed Brown PetscErrorCode  TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal))
2742b8123daeSJed Brown {
2743b8123daeSJed Brown   PetscFunctionBegin;
2744b8123daeSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2745ae60f76fSBarry Smith   ts->prestage = func;
2746b8123daeSJed Brown   PetscFunctionReturn(0);
2747b8123daeSJed Brown }
2748b8123daeSJed Brown 
2749b8123daeSJed Brown #undef __FUNCT__
27509be3e283SDebojyoti Ghosh #define __FUNCT__ "TSSetPostStage"
27519be3e283SDebojyoti Ghosh /*@C
27529be3e283SDebojyoti Ghosh   TSSetPostStage - Sets the general-purpose function
27539be3e283SDebojyoti Ghosh   called once at the end of each stage.
27549be3e283SDebojyoti Ghosh 
27559be3e283SDebojyoti Ghosh   Logically Collective on TS
27569be3e283SDebojyoti Ghosh 
27579be3e283SDebojyoti Ghosh   Input Parameters:
27589be3e283SDebojyoti Ghosh + ts   - The TS context obtained from TSCreate()
27599be3e283SDebojyoti Ghosh - func - The function
27609be3e283SDebojyoti Ghosh 
27619be3e283SDebojyoti Ghosh   Calling sequence of func:
27629be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y);
27639be3e283SDebojyoti Ghosh 
27649be3e283SDebojyoti Ghosh   Level: intermediate
27659be3e283SDebojyoti Ghosh 
27669be3e283SDebojyoti Ghosh   Note:
27679be3e283SDebojyoti Ghosh   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
27689be3e283SDebojyoti Ghosh   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
27699be3e283SDebojyoti Ghosh   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
27709be3e283SDebojyoti Ghosh 
27719be3e283SDebojyoti Ghosh .keywords: TS, timestep
27729be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
27739be3e283SDebojyoti Ghosh @*/
27749be3e283SDebojyoti Ghosh PetscErrorCode  TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*))
27759be3e283SDebojyoti Ghosh {
27769be3e283SDebojyoti Ghosh   PetscFunctionBegin;
27779be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
27789be3e283SDebojyoti Ghosh   ts->poststage = func;
27799be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
27809be3e283SDebojyoti Ghosh }
27819be3e283SDebojyoti Ghosh 
27829be3e283SDebojyoti Ghosh #undef __FUNCT__
2783b8123daeSJed Brown #define __FUNCT__ "TSPreStage"
2784b8123daeSJed Brown /*@
2785b8123daeSJed Brown   TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage()
2786b8123daeSJed Brown 
2787b8123daeSJed Brown   Collective on TS
2788b8123daeSJed Brown 
2789b8123daeSJed Brown   Input Parameters:
2790b8123daeSJed Brown . ts          - The TS context obtained from TSCreate()
27919be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
2792b8123daeSJed Brown 
2793b8123daeSJed Brown   Notes:
2794b8123daeSJed Brown   TSPreStage() is typically used within time stepping implementations,
2795b8123daeSJed Brown   most users would not generally call this routine themselves.
2796b8123daeSJed Brown 
2797b8123daeSJed Brown   Level: developer
2798b8123daeSJed Brown 
2799b8123daeSJed Brown .keywords: TS, timestep
28009be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
2801b8123daeSJed Brown @*/
2802b8123daeSJed Brown PetscErrorCode  TSPreStage(TS ts, PetscReal stagetime)
2803b8123daeSJed Brown {
2804b8123daeSJed Brown   PetscErrorCode ierr;
2805b8123daeSJed Brown 
2806b8123daeSJed Brown   PetscFunctionBegin;
2807b8123daeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2808ae60f76fSBarry Smith   if (ts->prestage) {
2809ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestage),(ts,stagetime));
2810b8123daeSJed Brown   }
2811b8123daeSJed Brown   PetscFunctionReturn(0);
2812b8123daeSJed Brown }
2813b8123daeSJed Brown 
2814b8123daeSJed Brown #undef __FUNCT__
28159be3e283SDebojyoti Ghosh #define __FUNCT__ "TSPostStage"
28169be3e283SDebojyoti Ghosh /*@
28179be3e283SDebojyoti Ghosh   TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage()
28189be3e283SDebojyoti Ghosh 
28199be3e283SDebojyoti Ghosh   Collective on TS
28209be3e283SDebojyoti Ghosh 
28219be3e283SDebojyoti Ghosh   Input Parameters:
28229be3e283SDebojyoti Ghosh . ts          - The TS context obtained from TSCreate()
28239be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
28249be3e283SDebojyoti Ghosh   stageindex  - Stage number
28259be3e283SDebojyoti Ghosh   Y           - Array of vectors (of size = total number
28269be3e283SDebojyoti Ghosh                 of stages) with the stage solutions
28279be3e283SDebojyoti Ghosh 
28289be3e283SDebojyoti Ghosh   Notes:
28299be3e283SDebojyoti Ghosh   TSPostStage() is typically used within time stepping implementations,
28309be3e283SDebojyoti Ghosh   most users would not generally call this routine themselves.
28319be3e283SDebojyoti Ghosh 
28329be3e283SDebojyoti Ghosh   Level: developer
28339be3e283SDebojyoti Ghosh 
28349be3e283SDebojyoti Ghosh .keywords: TS, timestep
28359be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
28369be3e283SDebojyoti Ghosh @*/
28379be3e283SDebojyoti Ghosh PetscErrorCode  TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y)
28389be3e283SDebojyoti Ghosh {
28399be3e283SDebojyoti Ghosh   PetscErrorCode ierr;
28409be3e283SDebojyoti Ghosh 
28419be3e283SDebojyoti Ghosh   PetscFunctionBegin;
28429be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
28434beae5d8SLisandro Dalcin   if (ts->poststage) {
28449be3e283SDebojyoti Ghosh     PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y));
28459be3e283SDebojyoti Ghosh   }
28469be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
28479be3e283SDebojyoti Ghosh }
28489be3e283SDebojyoti Ghosh 
28499be3e283SDebojyoti Ghosh #undef __FUNCT__
2850e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPostStep"
2851ac226902SBarry Smith /*@C
2852000e7ae3SMatthew Knepley   TSSetPostStep - Sets the general-purpose function
28533f2090d5SJed Brown   called once at the end of each time step.
2854000e7ae3SMatthew Knepley 
28553f9fe445SBarry Smith   Logically Collective on TS
2856000e7ae3SMatthew Knepley 
2857000e7ae3SMatthew Knepley   Input Parameters:
2858000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
2859000e7ae3SMatthew Knepley - func - The function
2860000e7ae3SMatthew Knepley 
2861000e7ae3SMatthew Knepley   Calling sequence of func:
2862b8123daeSJed Brown $ func (TS ts);
2863000e7ae3SMatthew Knepley 
2864000e7ae3SMatthew Knepley   Level: intermediate
2865000e7ae3SMatthew Knepley 
2866000e7ae3SMatthew Knepley .keywords: TS, timestep
2867b8123daeSJed Brown .seealso: TSSetPreStep(), TSSetPreStage(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime()
2868000e7ae3SMatthew Knepley @*/
28697087cfbeSBarry Smith PetscErrorCode  TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
2870000e7ae3SMatthew Knepley {
2871000e7ae3SMatthew Knepley   PetscFunctionBegin;
28720700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2873ae60f76fSBarry Smith   ts->poststep = func;
2874000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
2875000e7ae3SMatthew Knepley }
2876000e7ae3SMatthew Knepley 
2877e74ef692SMatthew Knepley #undef __FUNCT__
28783f2090d5SJed Brown #define __FUNCT__ "TSPostStep"
287909ee8438SJed Brown /*@
28803f2090d5SJed Brown   TSPostStep - Runs the user-defined post-step function.
28813f2090d5SJed Brown 
28823f2090d5SJed Brown   Collective on TS
28833f2090d5SJed Brown 
28843f2090d5SJed Brown   Input Parameters:
28853f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
28863f2090d5SJed Brown 
28873f2090d5SJed Brown   Notes:
28883f2090d5SJed Brown   TSPostStep() is typically used within time stepping implementations,
28893f2090d5SJed Brown   so most users would not generally call this routine themselves.
28903f2090d5SJed Brown 
28913f2090d5SJed Brown   Level: developer
28923f2090d5SJed Brown 
28933f2090d5SJed Brown .keywords: TS, timestep
28943f2090d5SJed Brown @*/
28957087cfbeSBarry Smith PetscErrorCode  TSPostStep(TS ts)
28963f2090d5SJed Brown {
28973f2090d5SJed Brown   PetscErrorCode ierr;
28983f2090d5SJed Brown 
28993f2090d5SJed Brown   PetscFunctionBegin;
29000700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2901ae60f76fSBarry Smith   if (ts->poststep) {
2902ae60f76fSBarry Smith     PetscStackCallStandard((*ts->poststep),(ts));
290372ac3e02SJed Brown   }
29043f2090d5SJed Brown   PetscFunctionReturn(0);
29053f2090d5SJed Brown }
29063f2090d5SJed Brown 
2907d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
2908d763cef2SBarry Smith 
29094a2ae208SSatish Balay #undef __FUNCT__
2910a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSet"
2911d763cef2SBarry Smith /*@C
2912a6570f20SBarry Smith    TSMonitorSet - Sets an ADDITIONAL function that is to be used at every
2913d763cef2SBarry Smith    timestep to display the iteration's  progress.
2914d763cef2SBarry Smith 
29153f9fe445SBarry Smith    Logically Collective on TS
2916d763cef2SBarry Smith 
2917d763cef2SBarry Smith    Input Parameters:
2918d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2919e213d8f1SJed Brown .  monitor - monitoring routine
2920329f5518SBarry Smith .  mctx - [optional] user-defined context for private data for the
29210298fd71SBarry Smith              monitor routine (use NULL if no context is desired)
2922b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
29230298fd71SBarry Smith           (may be NULL)
2924d763cef2SBarry Smith 
2925e213d8f1SJed Brown    Calling sequence of monitor:
29260910c330SBarry Smith $    int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx)
2927d763cef2SBarry Smith 
2928d763cef2SBarry Smith +    ts - the TS context
292988c05cc5SBarry 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
293088c05cc5SBarry Smith                                been interpolated to)
29311f06c33eSBarry Smith .    time - current time
29320910c330SBarry Smith .    u - current iterate
2933d763cef2SBarry Smith -    mctx - [optional] monitoring context
2934d763cef2SBarry Smith 
2935d763cef2SBarry Smith    Notes:
2936d763cef2SBarry Smith    This routine adds an additional monitor to the list of monitors that
2937d763cef2SBarry Smith    already has been loaded.
2938d763cef2SBarry Smith 
2939025f1a04SBarry Smith    Fortran notes: Only a single monitor function can be set for each TS object
2940025f1a04SBarry Smith 
2941d763cef2SBarry Smith    Level: intermediate
2942d763cef2SBarry Smith 
2943d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
2944d763cef2SBarry Smith 
2945a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel()
2946d763cef2SBarry Smith @*/
2947c2efdce3SBarry Smith PetscErrorCode  TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**))
2948d763cef2SBarry Smith {
2949d763cef2SBarry Smith   PetscFunctionBegin;
29500700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
295117186662SBarry Smith   if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
2952d763cef2SBarry Smith   ts->monitor[ts->numbermonitors]          = monitor;
29538704b422SBarry Smith   ts->monitordestroy[ts->numbermonitors]   = mdestroy;
2954d763cef2SBarry Smith   ts->monitorcontext[ts->numbermonitors++] = (void*)mctx;
2955d763cef2SBarry Smith   PetscFunctionReturn(0);
2956d763cef2SBarry Smith }
2957d763cef2SBarry Smith 
29584a2ae208SSatish Balay #undef __FUNCT__
2959a6570f20SBarry Smith #define __FUNCT__ "TSMonitorCancel"
2960d763cef2SBarry Smith /*@C
2961a6570f20SBarry Smith    TSMonitorCancel - Clears all the monitors that have been set on a time-step object.
2962d763cef2SBarry Smith 
29633f9fe445SBarry Smith    Logically Collective on TS
2964d763cef2SBarry Smith 
2965d763cef2SBarry Smith    Input Parameters:
2966d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2967d763cef2SBarry Smith 
2968d763cef2SBarry Smith    Notes:
2969d763cef2SBarry Smith    There is no way to remove a single, specific monitor.
2970d763cef2SBarry Smith 
2971d763cef2SBarry Smith    Level: intermediate
2972d763cef2SBarry Smith 
2973d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
2974d763cef2SBarry Smith 
2975a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet()
2976d763cef2SBarry Smith @*/
29777087cfbeSBarry Smith PetscErrorCode  TSMonitorCancel(TS ts)
2978d763cef2SBarry Smith {
2979d952e501SBarry Smith   PetscErrorCode ierr;
2980d952e501SBarry Smith   PetscInt       i;
2981d952e501SBarry Smith 
2982d763cef2SBarry Smith   PetscFunctionBegin;
29830700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2984d952e501SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
29858704b422SBarry Smith     if (ts->monitordestroy[i]) {
29868704b422SBarry Smith       ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr);
2987d952e501SBarry Smith     }
2988d952e501SBarry Smith   }
2989d763cef2SBarry Smith   ts->numbermonitors = 0;
2990d763cef2SBarry Smith   PetscFunctionReturn(0);
2991d763cef2SBarry Smith }
2992d763cef2SBarry Smith 
29934a2ae208SSatish Balay #undef __FUNCT__
2994a6570f20SBarry Smith #define __FUNCT__ "TSMonitorDefault"
2995d8e5e3e6SSatish Balay /*@
2996a6570f20SBarry Smith    TSMonitorDefault - Sets the Default monitor
29975516499fSSatish Balay 
29985516499fSSatish Balay    Level: intermediate
299941251cbbSSatish Balay 
30005516499fSSatish Balay .keywords: TS, set, monitor
30015516499fSSatish Balay 
300241251cbbSSatish Balay .seealso: TSMonitorDefault(), TSMonitorSet()
300341251cbbSSatish Balay @*/
3004649052a6SBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,void *dummy)
3005d763cef2SBarry Smith {
3006dfbe8321SBarry Smith   PetscErrorCode ierr;
30074d4332d5SBarry Smith   PetscViewer    viewer =  (PetscViewer) dummy;
3008d132466eSBarry Smith 
3009d763cef2SBarry Smith   PetscFunctionBegin;
30104d4332d5SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
3011649052a6SBarry Smith   ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
30128392e04aSShri Abhyankar   ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g%s",step,(double)ts->time_step,(double)ptime,ts->steprollback ? " (r)\n" : "\n");CHKERRQ(ierr);
3013649052a6SBarry Smith   ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
3014d763cef2SBarry Smith   PetscFunctionReturn(0);
3015d763cef2SBarry Smith }
3016d763cef2SBarry Smith 
30174a2ae208SSatish Balay #undef __FUNCT__
30189110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitorSet"
30199110b2e7SHong Zhang /*@C
30209110b2e7SHong Zhang    TSAdjointMonitorSet - Sets an ADDITIONAL function that is to be used at every
30219110b2e7SHong Zhang    timestep to display the iteration's  progress.
30229110b2e7SHong Zhang 
30239110b2e7SHong Zhang    Logically Collective on TS
30249110b2e7SHong Zhang 
30259110b2e7SHong Zhang    Input Parameters:
30269110b2e7SHong Zhang +  ts - the TS context obtained from TSCreate()
30279110b2e7SHong Zhang .  adjointmonitor - monitoring routine
30289110b2e7SHong Zhang .  adjointmctx - [optional] user-defined context for private data for the
30299110b2e7SHong Zhang              monitor routine (use NULL if no context is desired)
30309110b2e7SHong Zhang -  adjointmonitordestroy - [optional] routine that frees monitor context
30319110b2e7SHong Zhang           (may be NULL)
30329110b2e7SHong Zhang 
30339110b2e7SHong Zhang    Calling sequence of monitor:
30349110b2e7SHong Zhang $    int adjointmonitor(TS ts,PetscInt steps,PetscReal time,Vec u,PetscInt numcost,Vec *lambda, Vec *mu,void *adjointmctx)
30359110b2e7SHong Zhang 
30369110b2e7SHong Zhang +    ts - the TS context
30379110b2e7SHong Zhang .    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
30389110b2e7SHong Zhang                                been interpolated to)
30399110b2e7SHong Zhang .    time - current time
30409110b2e7SHong Zhang .    u - current iterate
30419110b2e7SHong Zhang .    numcost - number of cost functionos
30429110b2e7SHong Zhang .    lambda - sensitivities to initial conditions
30439110b2e7SHong Zhang .    mu - sensitivities to parameters
30449110b2e7SHong Zhang -    adjointmctx - [optional] adjoint monitoring context
30459110b2e7SHong Zhang 
30469110b2e7SHong Zhang    Notes:
30479110b2e7SHong Zhang    This routine adds an additional monitor to the list of monitors that
30489110b2e7SHong Zhang    already has been loaded.
30499110b2e7SHong Zhang 
30509110b2e7SHong Zhang    Fortran notes: Only a single monitor function can be set for each TS object
30519110b2e7SHong Zhang 
30529110b2e7SHong Zhang    Level: intermediate
30539110b2e7SHong Zhang 
30549110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor
30559110b2e7SHong Zhang 
30569110b2e7SHong Zhang .seealso: TSAdjointMonitorCancel()
30579110b2e7SHong Zhang @*/
30589110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorSet(TS ts,PetscErrorCode (*adjointmonitor)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *adjointmctx,PetscErrorCode (*adjointmdestroy)(void**))
30599110b2e7SHong Zhang {
30609110b2e7SHong Zhang   PetscFunctionBegin;
30619110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
30629110b2e7SHong Zhang   if (ts->numberadjointmonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many adjoint monitors set");
30639110b2e7SHong Zhang   ts->adjointmonitor[ts->numberadjointmonitors]          = adjointmonitor;
30649110b2e7SHong Zhang   ts->adjointmonitordestroy[ts->numberadjointmonitors]   = adjointmdestroy;
30659110b2e7SHong Zhang   ts->adjointmonitorcontext[ts->numberadjointmonitors++] = (void*)adjointmctx;
30669110b2e7SHong Zhang   PetscFunctionReturn(0);
30679110b2e7SHong Zhang }
30689110b2e7SHong Zhang 
30699110b2e7SHong Zhang #undef __FUNCT__
30709110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitorCancel"
30719110b2e7SHong Zhang /*@C
30729110b2e7SHong Zhang    TSAdjointMonitorCancel - Clears all the adjoint monitors that have been set on a time-step object.
30739110b2e7SHong Zhang 
30749110b2e7SHong Zhang    Logically Collective on TS
30759110b2e7SHong Zhang 
30769110b2e7SHong Zhang    Input Parameters:
30779110b2e7SHong Zhang .  ts - the TS context obtained from TSCreate()
30789110b2e7SHong Zhang 
30799110b2e7SHong Zhang    Notes:
30809110b2e7SHong Zhang    There is no way to remove a single, specific monitor.
30819110b2e7SHong Zhang 
30829110b2e7SHong Zhang    Level: intermediate
30839110b2e7SHong Zhang 
30849110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor
30859110b2e7SHong Zhang 
30869110b2e7SHong Zhang .seealso: TSAdjointMonitorSet()
30879110b2e7SHong Zhang @*/
30889110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorCancel(TS ts)
30899110b2e7SHong Zhang {
30909110b2e7SHong Zhang   PetscErrorCode ierr;
30919110b2e7SHong Zhang   PetscInt       i;
30929110b2e7SHong Zhang 
30939110b2e7SHong Zhang   PetscFunctionBegin;
30949110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
30959110b2e7SHong Zhang   for (i=0; i<ts->numberadjointmonitors; i++) {
30969110b2e7SHong Zhang     if (ts->adjointmonitordestroy[i]) {
30979110b2e7SHong Zhang       ierr = (*ts->adjointmonitordestroy[i])(&ts->adjointmonitorcontext[i]);CHKERRQ(ierr);
30989110b2e7SHong Zhang     }
30999110b2e7SHong Zhang   }
31009110b2e7SHong Zhang   ts->numberadjointmonitors = 0;
31019110b2e7SHong Zhang   PetscFunctionReturn(0);
31029110b2e7SHong Zhang }
31039110b2e7SHong Zhang 
31049110b2e7SHong Zhang #undef __FUNCT__
3105110eb670SHong Zhang #define __FUNCT__ "TSAdjointMonitorDefault"
3106110eb670SHong Zhang /*@
3107110eb670SHong Zhang    TSAdjointMonitorDefault - Sets the Default monitor
3108110eb670SHong Zhang 
3109110eb670SHong Zhang    Level: intermediate
3110110eb670SHong Zhang 
3111110eb670SHong Zhang .keywords: TS, set, monitor
3112110eb670SHong Zhang 
3113110eb670SHong Zhang .seealso: TSAdjointMonitorSet()
3114110eb670SHong Zhang @*/
3115110eb670SHong Zhang PetscErrorCode TSAdjointMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscInt numcost,Vec *lambda,Vec *mu,void *dummy)
3116110eb670SHong Zhang {
3117110eb670SHong Zhang   PetscErrorCode ierr;
3118110eb670SHong Zhang   PetscViewer    viewer =  (PetscViewer) dummy;
3119110eb670SHong Zhang 
3120110eb670SHong Zhang   PetscFunctionBegin;
3121110eb670SHong Zhang   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
3122110eb670SHong Zhang   ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
3123110eb670SHong Zhang   ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g%s",step,(double)ts->time_step,(double)ptime,ts->steprollback ? " (r)\n" : "\n");CHKERRQ(ierr);
3124110eb670SHong Zhang   ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
3125110eb670SHong Zhang   PetscFunctionReturn(0);
3126110eb670SHong Zhang }
3127110eb670SHong Zhang 
3128110eb670SHong Zhang #undef __FUNCT__
3129cd652676SJed Brown #define __FUNCT__ "TSSetRetainStages"
3130cd652676SJed Brown /*@
3131cd652676SJed Brown    TSSetRetainStages - Request that all stages in the upcoming step be stored so that interpolation will be available.
3132cd652676SJed Brown 
3133cd652676SJed Brown    Logically Collective on TS
3134cd652676SJed Brown 
3135cd652676SJed Brown    Input Argument:
3136cd652676SJed Brown .  ts - time stepping context
3137cd652676SJed Brown 
3138cd652676SJed Brown    Output Argument:
3139cd652676SJed Brown .  flg - PETSC_TRUE or PETSC_FALSE
3140cd652676SJed Brown 
3141cd652676SJed Brown    Level: intermediate
3142cd652676SJed Brown 
3143cd652676SJed Brown .keywords: TS, set
3144cd652676SJed Brown 
3145cd652676SJed Brown .seealso: TSInterpolate(), TSSetPostStep()
3146cd652676SJed Brown @*/
3147cd652676SJed Brown PetscErrorCode TSSetRetainStages(TS ts,PetscBool flg)
3148cd652676SJed Brown {
3149cd652676SJed Brown   PetscFunctionBegin;
3150cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3151cd652676SJed Brown   ts->retain_stages = flg;
3152cd652676SJed Brown   PetscFunctionReturn(0);
3153cd652676SJed Brown }
3154cd652676SJed Brown 
3155cd652676SJed Brown #undef __FUNCT__
3156cd652676SJed Brown #define __FUNCT__ "TSInterpolate"
3157cd652676SJed Brown /*@
3158cd652676SJed Brown    TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
3159cd652676SJed Brown 
3160cd652676SJed Brown    Collective on TS
3161cd652676SJed Brown 
3162cd652676SJed Brown    Input Argument:
3163cd652676SJed Brown +  ts - time stepping context
3164cd652676SJed Brown -  t - time to interpolate to
3165cd652676SJed Brown 
3166cd652676SJed Brown    Output Argument:
31670910c330SBarry Smith .  U - state at given time
3168cd652676SJed Brown 
3169cd652676SJed Brown    Notes:
3170cd652676SJed Brown    The user should call TSSetRetainStages() before taking a step in which interpolation will be requested.
3171cd652676SJed Brown 
3172cd652676SJed Brown    Level: intermediate
3173cd652676SJed Brown 
3174cd652676SJed Brown    Developer Notes:
3175cd652676SJed Brown    TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
3176cd652676SJed Brown 
3177cd652676SJed Brown .keywords: TS, set
3178cd652676SJed Brown 
3179cd652676SJed Brown .seealso: TSSetRetainStages(), TSSetPostStep()
3180cd652676SJed Brown @*/
31810910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U)
3182cd652676SJed Brown {
3183cd652676SJed Brown   PetscErrorCode ierr;
3184cd652676SJed Brown 
3185cd652676SJed Brown   PetscFunctionBegin;
3186cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3187b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
31886712e2f1SBarry Smith   if (t < ts->ptime - ts->time_step_prev || t > ts->ptime) SETERRQ3(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Requested time %g not in last time steps [%g,%g]",t,(double)(ts->ptime-ts->time_step_prev),(double)ts->ptime);
3189ce94432eSBarry Smith   if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
31900910c330SBarry Smith   ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr);
3191cd652676SJed Brown   PetscFunctionReturn(0);
3192cd652676SJed Brown }
3193cd652676SJed Brown 
3194cd652676SJed Brown #undef __FUNCT__
31954a2ae208SSatish Balay #define __FUNCT__ "TSStep"
3196d763cef2SBarry Smith /*@
31976d9e5789SSean Farley    TSStep - Steps one time step
3198d763cef2SBarry Smith 
3199d763cef2SBarry Smith    Collective on TS
3200d763cef2SBarry Smith 
3201d763cef2SBarry Smith    Input Parameter:
3202d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3203d763cef2SBarry Smith 
320427829d71SBarry Smith    Level: developer
3205d763cef2SBarry Smith 
3206b8123daeSJed Brown    Notes:
320727829d71SBarry Smith    The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine.
320827829d71SBarry Smith 
3209b8123daeSJed Brown    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
3210b8123daeSJed Brown    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
3211b8123daeSJed Brown 
321225cb2221SBarry Smith    This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the
321325cb2221SBarry Smith    time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
321425cb2221SBarry Smith 
3215d763cef2SBarry Smith .keywords: TS, timestep, solve
3216d763cef2SBarry Smith 
32179be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
3218d763cef2SBarry Smith @*/
3219193ac0bcSJed Brown PetscErrorCode  TSStep(TS ts)
3220d763cef2SBarry Smith {
32212fb8446cSMatthew G. Knepley   DM               dm;
3222dfbe8321SBarry Smith   PetscErrorCode   ierr;
3223fffbeea8SBarry Smith   static PetscBool cite = PETSC_FALSE;
3224d763cef2SBarry Smith 
3225d763cef2SBarry Smith   PetscFunctionBegin;
32260700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3227fffbeea8SBarry Smith   ierr = PetscCitationsRegister("@techreport{tspaper,\n"
3228fffbeea8SBarry Smith                                 "  title       = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n"
3229fffbeea8SBarry Smith                                 "  author      = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n"
3230fffbeea8SBarry Smith                                 "  type        = {Preprint},\n"
3231fffbeea8SBarry Smith                                 "  number      = {ANL/MCS-P5061-0114},\n"
3232fffbeea8SBarry Smith                                 "  institution = {Argonne National Laboratory},\n"
3233302440fdSBarry Smith                                 "  year        = {2014}\n}\n",&cite);CHKERRQ(ierr);
3234fffbeea8SBarry Smith 
32352fb8446cSMatthew G. Knepley   ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
3236d405a339SMatthew Knepley   ierr = TSSetUp(ts);CHKERRQ(ierr);
3237d405a339SMatthew Knepley 
3238362cd11cSLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
323924655328SShri   ts->ptime_prev = ts->ptime;
3240cdb7a50dSMatthew G. Knepley   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3241bbd56ea5SKarl Rupp 
3242e04979a6SLisandro Dalcin   if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name);
3243d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3244193ac0bcSJed Brown   ierr = (*ts->ops->step)(ts);CHKERRQ(ierr);
3245d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3246bbd56ea5SKarl Rupp 
324724655328SShri   ts->time_step_prev = ts->ptime - ts->ptime_prev;
3248cdb7a50dSMatthew G. Knepley   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3249362cd11cSLisandro Dalcin 
3250362cd11cSLisandro Dalcin   if (ts->reason < 0) {
3251cef5090cSJed Brown     if (ts->errorifstepfailed) {
325208c7845fSBarry Smith       if (ts->reason == TS_DIVERGED_NONLINEAR_SOLVE) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s, increase -ts_max_snes_failures or make negative to attempt recovery",TSConvergedReasons[ts->reason]);
325308c7845fSBarry Smith       else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
3254d2daff3dSHong Zhang     }
325508c7845fSBarry Smith   } else if (!ts->reason) {
325608c7845fSBarry Smith     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
325708c7845fSBarry Smith     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
325808c7845fSBarry Smith   }
32592c18e0fdSBarry Smith   ts->total_steps++;
32608392e04aSShri Abhyankar   ts->steprollback = PETSC_FALSE;
326108c7845fSBarry Smith   PetscFunctionReturn(0);
326208c7845fSBarry Smith }
326308c7845fSBarry Smith 
326408c7845fSBarry Smith #undef __FUNCT__
326508c7845fSBarry Smith #define __FUNCT__ "TSAdjointStep"
326608c7845fSBarry Smith /*@
3267b957a604SHong Zhang    TSAdjointStep - Steps one time step backward in the adjoint run
326808c7845fSBarry Smith 
326908c7845fSBarry Smith    Collective on TS
327008c7845fSBarry Smith 
327108c7845fSBarry Smith    Input Parameter:
327208c7845fSBarry Smith .  ts - the TS context obtained from TSCreate()
327308c7845fSBarry Smith 
32746a4d4014SLisandro Dalcin    Level: intermediate
32756a4d4014SLisandro Dalcin 
3276b957a604SHong Zhang .keywords: TS, adjoint, step
32776a4d4014SLisandro Dalcin 
3278b957a604SHong Zhang .seealso: TSAdjointSetUp(), TSAdjointSolve()
32796a4d4014SLisandro Dalcin @*/
328008c7845fSBarry Smith PetscErrorCode  TSAdjointStep(TS ts)
32816a4d4014SLisandro Dalcin {
328208c7845fSBarry Smith   DM               dm;
32836a4d4014SLisandro Dalcin   PetscErrorCode   ierr;
32846a4d4014SLisandro Dalcin 
32856a4d4014SLisandro Dalcin   PetscFunctionBegin;
32864a2ae208SSatish Balay   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
328708c7845fSBarry Smith   ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
328808c7845fSBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
3289d763cef2SBarry Smith 
3290d763cef2SBarry Smith   ts->reason = TS_CONVERGED_ITERATING;
329108c7845fSBarry Smith   ts->ptime_prev = ts->ptime;
329208c7845fSBarry Smith   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3293685405a1SBarry Smith   ierr = VecViewFromOptions(ts->vec_sol,(PetscObject)ts, "-ts_view_solution");CHKERRQ(ierr);
3294d763cef2SBarry Smith 
32956849ba73SBarry Smith   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
329642f2b339SBarry Smith   if (!ts->ops->adjointstep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed because the adjoint of  %s has not been implemented, try other time stepping methods for adjoint sensitivity analysis",((PetscObject)ts)->type_name);
329742f2b339SBarry Smith   ierr = (*ts->ops->adjointstep)(ts);CHKERRQ(ierr);
3298a6570f20SBarry Smith   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3299d763cef2SBarry Smith 
3300cef5090cSJed Brown   ts->time_step_prev = ts->ptime - ts->ptime_prev;
3301cef5090cSJed Brown   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3302362cd11cSLisandro Dalcin 
3303362cd11cSLisandro Dalcin   if (ts->reason < 0) {
3304cef5090cSJed Brown     if (ts->errorifstepfailed) {
3305cef5090cSJed Brown       if (ts->reason == TS_DIVERGED_NONLINEAR_SOLVE) {
3306ce94432eSBarry Smith         SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s, increase -ts_max_snes_failures or make negative to attempt recovery",TSConvergedReasons[ts->reason]);
33072a3a10ceSLisandro Dalcin       } else if (ts->reason == TS_DIVERGED_STEP_REJECTED) {
33082a3a10ceSLisandro Dalcin         SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s, increase -ts_max_reject or make negative to attempt recovery",TSConvergedReasons[ts->reason]);
3309ce94432eSBarry Smith       } else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
3310cef5090cSJed Brown     }
3311362cd11cSLisandro Dalcin   } else if (!ts->reason) {
331273b18844SBarry Smith     if (ts->steps >= ts->adjoint_max_steps)     ts->reason = TS_CONVERGED_ITS;
3313db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time)         ts->reason = TS_CONVERGED_TIME;
3314362cd11cSLisandro Dalcin   }
33152c18e0fdSBarry Smith   ts->total_steps--;
3316d763cef2SBarry Smith   PetscFunctionReturn(0);
3317d763cef2SBarry Smith }
3318d763cef2SBarry Smith 
3319d763cef2SBarry Smith #undef __FUNCT__
332005175c85SJed Brown #define __FUNCT__ "TSEvaluateStep"
332105175c85SJed Brown /*@
332205175c85SJed Brown    TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy.
332305175c85SJed Brown 
33241c3436cfSJed Brown    Collective on TS
332505175c85SJed Brown 
332605175c85SJed Brown    Input Arguments:
33271c3436cfSJed Brown +  ts - time stepping context
33281c3436cfSJed Brown .  order - desired order of accuracy
33290298fd71SBarry Smith -  done - whether the step was evaluated at this order (pass NULL to generate an error if not available)
333005175c85SJed Brown 
333105175c85SJed Brown    Output Arguments:
33320910c330SBarry Smith .  U - state at the end of the current step
333305175c85SJed Brown 
333405175c85SJed Brown    Level: advanced
333505175c85SJed Brown 
3336108c343cSJed Brown    Notes:
3337108c343cSJed Brown    This function cannot be called until all stages have been evaluated.
3338108c343cSJed 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.
3339108c343cSJed Brown 
33401c3436cfSJed Brown .seealso: TSStep(), TSAdapt
334105175c85SJed Brown @*/
33420910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done)
334305175c85SJed Brown {
334405175c85SJed Brown   PetscErrorCode ierr;
334505175c85SJed Brown 
334605175c85SJed Brown   PetscFunctionBegin;
334705175c85SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
334805175c85SJed Brown   PetscValidType(ts,1);
33490910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
3350ce94432eSBarry Smith   if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name);
33510910c330SBarry Smith   ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr);
335205175c85SJed Brown   PetscFunctionReturn(0);
335305175c85SJed Brown }
335405175c85SJed Brown 
3355d67e68b7SBarry Smith 
335605175c85SJed Brown #undef __FUNCT__
3357d763cef2SBarry Smith #define __FUNCT__ "TSSolve"
3358d763cef2SBarry Smith /*@
3359d763cef2SBarry Smith    TSSolve - Steps the requested number of timesteps.
3360d763cef2SBarry Smith 
3361d763cef2SBarry Smith    Collective on TS
3362d763cef2SBarry Smith 
3363d763cef2SBarry Smith    Input Parameter:
3364d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
3365cc708dedSBarry Smith -  u - the solution vector  (can be null if TSSetSolution() was used, otherwise must contain the initial conditions)
33665a3a76d0SJed Brown 
3367d763cef2SBarry Smith    Level: beginner
3368d763cef2SBarry Smith 
33695a3a76d0SJed Brown    Notes:
33705a3a76d0SJed Brown    The final time returned by this function may be different from the time of the internally
33715a3a76d0SJed Brown    held state accessible by TSGetSolution() and TSGetTime() because the method may have
33725a3a76d0SJed Brown    stepped over the final time.
33735a3a76d0SJed Brown 
3374d763cef2SBarry Smith .keywords: TS, timestep, solve
3375d763cef2SBarry Smith 
3376d763cef2SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep()
3377d763cef2SBarry Smith @*/
3378cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u)
3379d763cef2SBarry Smith {
3380b06615a5SLisandro Dalcin   Vec               solution;
3381d763cef2SBarry Smith   PetscErrorCode    ierr;
3382d763cef2SBarry Smith 
3383d763cef2SBarry Smith   PetscFunctionBegin;
3384d763cef2SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3385f2c2a1b9SBarry Smith   if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2);
338649354f04SShri Abhyankar   if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE) {   /* Need ts->vec_sol to be distinct so it is not overwritten when we interpolate at the end */
3387b06615a5SLisandro Dalcin     PetscValidHeaderSpecific(u,VEC_CLASSID,2);
33880910c330SBarry Smith     if (!ts->vec_sol || u == ts->vec_sol) {
3389b06615a5SLisandro Dalcin       ierr = VecDuplicate(u,&solution);CHKERRQ(ierr);
3390b06615a5SLisandro Dalcin       ierr = TSSetSolution(ts,solution);CHKERRQ(ierr);
3391b06615a5SLisandro Dalcin       ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */
33925a3a76d0SJed Brown     }
33930910c330SBarry Smith     ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr);
3394bbd56ea5SKarl Rupp   } else if (u) {
33950910c330SBarry Smith     ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
33965a3a76d0SJed Brown   }
3397b5d403baSSean Farley   ierr = TSSetUp(ts);CHKERRQ(ierr);
3398d763cef2SBarry Smith   /* reset time step and iteration counters */
3399193ac0bcSJed Brown   ts->steps             = 0;
34005ef26d82SJed Brown   ts->ksp_its           = 0;
34015ef26d82SJed Brown   ts->snes_its          = 0;
3402c610991cSLisandro Dalcin   ts->num_snes_failures = 0;
3403c610991cSLisandro Dalcin   ts->reject            = 0;
3404193ac0bcSJed Brown   ts->reason            = TS_CONVERGED_ITERATING;
3405193ac0bcSJed Brown 
3406ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr);
3407ec8db0baSMatthew G. Knepley   {
3408ec8db0baSMatthew G. Knepley     DM dm;
3409ec8db0baSMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
3410ec8db0baSMatthew G. Knepley     ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3411ec8db0baSMatthew G. Knepley   }
3412f05ece33SBarry Smith 
3413193ac0bcSJed Brown   if (ts->ops->solve) {         /* This private interface is transitional and should be removed when all implementations are updated. */
3414193ac0bcSJed Brown     ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr);
34150910c330SBarry Smith     ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);
3416cc708dedSBarry Smith     ts->solvetime = ts->ptime;
3417193ac0bcSJed Brown   } else {
3418d763cef2SBarry Smith     /* steps the requested number of timesteps. */
3419db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
3420db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
3421cdf0de3dSShri Abhyankar     ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
342211b05f00SHong Zhang     if (ts->vec_costintegral) ts->costintegralfwd=PETSC_TRUE;
34236fea3669SShri Abhyankar     if(ts->event) {
34246fea3669SShri Abhyankar       ierr = TSEventMonitorInitialize(ts);CHKERRQ(ierr);
34256fea3669SShri Abhyankar     }
3426e1a7a14fSJed Brown     while (!ts->reason) {
3427193ac0bcSJed Brown       ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
3428193ac0bcSJed Brown       ierr = TSStep(ts);CHKERRQ(ierr);
3429aeb4809dSShri Abhyankar       if (ts->event) {
3430aeb4809dSShri Abhyankar 	ierr = TSEventMonitor(ts);CHKERRQ(ierr);
34311eda64f1SShri Abhyankar       }
34328392e04aSShri Abhyankar       if(!ts->steprollback) {
3433cdf0de3dSShri Abhyankar 	ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
34341eda64f1SShri Abhyankar 	ierr = TSPostStep(ts);CHKERRQ(ierr);
3435aeb4809dSShri Abhyankar       }
3436193ac0bcSJed Brown     }
343749354f04SShri Abhyankar     if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) {
34380910c330SBarry Smith       ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr);
3439cc708dedSBarry Smith       ts->solvetime = ts->max_time;
3440b06615a5SLisandro Dalcin       solution = u;
34410574a7fbSJed Brown     } else {
3442ad6bc421SBarry Smith       if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
3443cc708dedSBarry Smith       ts->solvetime = ts->ptime;
3444b06615a5SLisandro Dalcin       solution = ts->vec_sol;
34450574a7fbSJed Brown     }
3446b06615a5SLisandro Dalcin     ierr = TSMonitor(ts,ts->steps,ts->solvetime,solution);CHKERRQ(ierr);
3447685405a1SBarry Smith     ierr = VecViewFromOptions(solution,(PetscObject) ts,"-ts_view_solution");CHKERRQ(ierr);
3448193ac0bcSJed Brown   }
3449d2daff3dSHong Zhang 
3450ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr);
3451dc1cb503SEmil Constantinescu   ierr = VecViewFromOptions(ts->vec_sol,NULL,"-ts_view_solution");CHKERRQ(ierr);
345256f85f32SBarry Smith   ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr);
3453ef222394SBarry Smith   if (ts->adjoint_solve) {
3454ef222394SBarry Smith     ierr = TSAdjointSolve(ts);CHKERRQ(ierr);
34552b0a91c0SBarry Smith   }
3456d763cef2SBarry Smith   PetscFunctionReturn(0);
3457d763cef2SBarry Smith }
3458d763cef2SBarry Smith 
3459d763cef2SBarry Smith #undef __FUNCT__
3460c88f2d44SBarry Smith #define __FUNCT__ "TSAdjointSolve"
3461c88f2d44SBarry Smith /*@
3462c88f2d44SBarry Smith    TSAdjointSolve - Solves the discrete ajoint problem for an ODE/DAE
3463c88f2d44SBarry Smith 
3464c88f2d44SBarry Smith    Collective on TS
3465c88f2d44SBarry Smith 
3466c88f2d44SBarry Smith    Input Parameter:
34672c39e106SBarry Smith .  ts - the TS context obtained from TSCreate()
3468c88f2d44SBarry Smith 
3469e87fd094SBarry Smith    Options Database:
3470e87fd094SBarry Smith . -ts_adjoint_view_solution <viewerinfo> - views the first gradient with respect to the initial conditions
3471e87fd094SBarry Smith 
3472c88f2d44SBarry Smith    Level: intermediate
3473c88f2d44SBarry Smith 
3474c88f2d44SBarry Smith    Notes:
3475c88f2d44SBarry Smith    This must be called after a call to TSSolve() that solves the forward problem
3476c88f2d44SBarry Smith 
347773b18844SBarry Smith    By default this will integrate back to the initial time, one can use TSAdjointSetSteps() to step back to a later time
347873b18844SBarry Smith 
3479c88f2d44SBarry Smith .keywords: TS, timestep, solve
3480c88f2d44SBarry Smith 
3481b957a604SHong Zhang .seealso: TSCreate(), TSSetCostGradients(), TSSetSolution(), TSAdjointStep()
3482c88f2d44SBarry Smith @*/
34832c39e106SBarry Smith PetscErrorCode TSAdjointSolve(TS ts)
3484c88f2d44SBarry Smith {
3485c88f2d44SBarry Smith   PetscErrorCode    ierr;
3486c88f2d44SBarry Smith 
3487c88f2d44SBarry Smith   PetscFunctionBegin;
3488c88f2d44SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3489c88f2d44SBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
3490c88f2d44SBarry Smith   /* reset time step and iteration counters */
3491c88f2d44SBarry Smith   ts->steps             = 0;
3492c88f2d44SBarry Smith   ts->ksp_its           = 0;
3493c88f2d44SBarry Smith   ts->snes_its          = 0;
3494c88f2d44SBarry Smith   ts->num_snes_failures = 0;
3495c88f2d44SBarry Smith   ts->reject            = 0;
3496c88f2d44SBarry Smith   ts->reason            = TS_CONVERGED_ITERATING;
3497c88f2d44SBarry Smith 
349873b18844SBarry Smith   if (!ts->adjoint_max_steps) ts->adjoint_max_steps = ts->total_steps;
3499c88f2d44SBarry Smith 
350073b18844SBarry Smith   if (ts->steps >= ts->adjoint_max_steps)     ts->reason = TS_CONVERGED_ITS;
3501c88f2d44SBarry Smith   while (!ts->reason) {
350255c52731SHong Zhang     ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr);
35039110b2e7SHong Zhang     ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr);
3504c88f2d44SBarry Smith     if (ts->event) {
3505d0578d90SShri Abhyankar       ierr = TSAdjointEventMonitor(ts);CHKERRQ(ierr);
3506d0578d90SShri Abhyankar     }
3507616946c1SHong Zhang     ierr = TSAdjointStep(ts);CHKERRQ(ierr);
3508c88f2d44SBarry Smith   }
350926656371SHong Zhang   ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr);
351026656371SHong Zhang   ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr);
3511c88f2d44SBarry Smith   ts->solvetime = ts->ptime;
3512685405a1SBarry Smith   ierr = VecViewFromOptions(ts->vecs_sensi[0],(PetscObject) ts, "-ts_adjoint_view_solution");CHKERRQ(ierr);
3513c88f2d44SBarry Smith   PetscFunctionReturn(0);
3514c88f2d44SBarry Smith }
3515c88f2d44SBarry Smith 
3516c88f2d44SBarry Smith #undef __FUNCT__
3517d763cef2SBarry Smith #define __FUNCT__ "TSMonitor"
35187db568b7SBarry Smith /*@C
3519228d79bcSJed Brown    TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet()
3520228d79bcSJed Brown 
3521228d79bcSJed Brown    Collective on TS
3522228d79bcSJed Brown 
3523228d79bcSJed Brown    Input Parameters:
3524228d79bcSJed Brown +  ts - time stepping context obtained from TSCreate()
3525228d79bcSJed Brown .  step - step number that has just completed
3526228d79bcSJed Brown .  ptime - model time of the state
35270910c330SBarry Smith -  u - state at the current model time
3528228d79bcSJed Brown 
3529228d79bcSJed Brown    Notes:
35307db568b7SBarry Smith    TSMonitor() is typically used automatically within the time stepping implementations.
35317db568b7SBarry Smith    Users would almost never call this routine directly.
3532228d79bcSJed Brown 
35337db568b7SBarry Smith    Level: developer
3534228d79bcSJed Brown 
3535228d79bcSJed Brown .keywords: TS, timestep
3536228d79bcSJed Brown @*/
35370910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u)
3538d763cef2SBarry Smith {
3539d763cef2SBarry Smith   PetscErrorCode ierr;
3540d763cef2SBarry Smith   PetscInt       i,n = ts->numbermonitors;
3541d763cef2SBarry Smith 
3542d763cef2SBarry Smith   PetscFunctionBegin;
3543b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3544b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
35455edff71fSBarry Smith   ierr = VecLockPush(u);CHKERRQ(ierr);
3546d763cef2SBarry Smith   for (i=0; i<n; i++) {
35470910c330SBarry Smith     ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr);
3548d763cef2SBarry Smith   }
35495edff71fSBarry Smith   ierr = VecLockPop(u);CHKERRQ(ierr);
3550d763cef2SBarry Smith   PetscFunctionReturn(0);
3551d763cef2SBarry Smith }
3552d763cef2SBarry Smith 
35539110b2e7SHong Zhang #undef __FUNCT__
35549110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitor"
35557db568b7SBarry Smith /*@C
35569110b2e7SHong Zhang    TSAdjointMonitor - Runs all user-provided adjoint monitor routines set using TSAdjointMonitorSet()
35579110b2e7SHong Zhang 
35589110b2e7SHong Zhang    Collective on TS
35599110b2e7SHong Zhang 
35609110b2e7SHong Zhang    Input Parameters:
35619110b2e7SHong Zhang +  ts - time stepping context obtained from TSCreate()
35629110b2e7SHong Zhang .  step - step number that has just completed
35639110b2e7SHong Zhang .  ptime - model time of the state
35649110b2e7SHong Zhang .  u - state at the current model time
35659110b2e7SHong Zhang .  numcost - number of cost functions (dimension of lambda  or mu)
35669110b2e7SHong Zhang .  lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables
35679110b2e7SHong Zhang -  mu - vectors containing the gradients of the cost functions with respect to the problem parameters
35689110b2e7SHong Zhang 
35699110b2e7SHong Zhang    Notes:
35707db568b7SBarry Smith    TSAdjointMonitor() is typically used automatically within the time stepping implementations.
35717db568b7SBarry Smith    Users would almost never call this routine directly.
35729110b2e7SHong Zhang 
35737db568b7SBarry Smith    Level: developer
35749110b2e7SHong Zhang 
35759110b2e7SHong Zhang .keywords: TS, timestep
35769110b2e7SHong Zhang @*/
35779110b2e7SHong Zhang PetscErrorCode TSAdjointMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda, Vec *mu)
35789110b2e7SHong Zhang {
35799110b2e7SHong Zhang   PetscErrorCode ierr;
35809110b2e7SHong Zhang   PetscInt       i,n = ts->numberadjointmonitors;
35819110b2e7SHong Zhang 
35829110b2e7SHong Zhang   PetscFunctionBegin;
35839110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
35849110b2e7SHong Zhang   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
35859110b2e7SHong Zhang   ierr = VecLockPush(u);CHKERRQ(ierr);
35869110b2e7SHong Zhang   for (i=0; i<n; i++) {
35879110b2e7SHong Zhang     ierr = (*ts->adjointmonitor[i])(ts,step,ptime,u,numcost,lambda,mu,ts->adjointmonitorcontext[i]);CHKERRQ(ierr);
35889110b2e7SHong Zhang   }
35899110b2e7SHong Zhang   ierr = VecLockPop(u);CHKERRQ(ierr);
35909110b2e7SHong Zhang   PetscFunctionReturn(0);
35919110b2e7SHong Zhang }
35929110b2e7SHong Zhang 
3593d763cef2SBarry Smith /* ------------------------------------------------------------------------*/
3594d763cef2SBarry Smith #undef __FUNCT__
3595a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxCreate"
3596d763cef2SBarry Smith /*@C
35977db568b7SBarry Smith    TSMonitorLGCtxCreate - Creates a TSMonitorLGCtx context for use with
3598a9f9c1f6SBarry Smith    TS to monitor the solution process graphically in various ways
3599d763cef2SBarry Smith 
3600d763cef2SBarry Smith    Collective on TS
3601d763cef2SBarry Smith 
3602d763cef2SBarry Smith    Input Parameters:
3603d763cef2SBarry Smith +  host - the X display to open, or null for the local machine
3604d763cef2SBarry Smith .  label - the title to put in the title bar
36057c922b88SBarry Smith .  x, y - the screen coordinates of the upper left coordinate of the window
3606a9f9c1f6SBarry Smith .  m, n - the screen width and height in pixels
3607a9f9c1f6SBarry Smith -  howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time
3608d763cef2SBarry Smith 
3609d763cef2SBarry Smith    Output Parameter:
36100b039ecaSBarry Smith .  ctx - the context
3611d763cef2SBarry Smith 
3612d763cef2SBarry Smith    Options Database Key:
36134f09c107SBarry Smith +  -ts_monitor_lg_timestep - automatically sets line graph monitor
36147db568b7SBarry Smith .  -ts_monitor_lg_solution - monitor the solution (or certain values of the solution by calling TSMonitorLGSetDisplayVariables() or TSMonitorLGCtxSetDisplayVariables())
36157db568b7SBarry Smith .  -ts_monitor_lg_error -  monitor the error
36167db568b7SBarry Smith .  -ts_monitor_lg_ksp_iterations - monitor the number of KSP iterations needed for each timestep
36177db568b7SBarry Smith .  -ts_monitor_lg_snes_iterations - monitor the number of SNES iterations needed for each timestep
3618b6fe0379SLisandro Dalcin -  -lg_use_markers <true,false> - mark the data points (at each time step) on the plot; default is true
3619d763cef2SBarry Smith 
3620d763cef2SBarry Smith    Notes:
3621a9f9c1f6SBarry Smith    Use TSMonitorLGCtxDestroy() to destroy.
3622d763cef2SBarry Smith 
36237db568b7SBarry Smith    One can provide a function that transforms the solution before plotting it with TSMonitorLGCtxSetTransform() or TSMonitorLGSetTransform()
36247db568b7SBarry Smith 
36257db568b7SBarry Smith    Many of the functions that control the monitoring have two forms: TSMonitorLGSet/GetXXXX() and TSMonitorLGCtxSet/GetXXXX() the first take a TS object as the
36267db568b7SBarry Smith    first argument (if that TS object does not have a TSMonitorLGCtx associated with it the function call is ignored) and the second takes a TSMonitorLGCtx object
36277db568b7SBarry Smith    as the first argument.
36287db568b7SBarry Smith 
36297db568b7SBarry Smith    One can control the names displayed for each solution or error variable with TSMonitorLGCtxSetVariableNames() or TSMonitorLGSetVariableNames()
36307db568b7SBarry Smith 
36317db568b7SBarry Smith 
3632d763cef2SBarry Smith    Level: intermediate
3633d763cef2SBarry Smith 
36347db568b7SBarry Smith .keywords: TS, monitor, line graph, residual
3635d763cef2SBarry Smith 
36367db568b7SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError(), TSMonitorDefault(), VecView(),
36377db568b7SBarry Smith            TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
36387db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
36397db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
36407db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
36417c922b88SBarry Smith 
3642d763cef2SBarry Smith @*/
3643a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx)
3644d763cef2SBarry Smith {
36457f52daa2SLisandro Dalcin   PetscDraw      draw;
3646dfbe8321SBarry Smith   PetscErrorCode ierr;
3647d763cef2SBarry Smith 
3648d763cef2SBarry Smith   PetscFunctionBegin;
3649b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
36507f52daa2SLisandro Dalcin   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr);
36517f52daa2SLisandro Dalcin   ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr);
36527f52daa2SLisandro Dalcin   ierr = PetscDrawLGCreate(draw,1,&(*ctx)->lg);CHKERRQ(ierr);
3653b6fe0379SLisandro Dalcin   ierr = PetscDrawLGSetUseMarkers((*ctx)->lg,PETSC_TRUE);CHKERRQ(ierr);
3654287de1a7SBarry Smith   ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr);
36557f52daa2SLisandro Dalcin   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
3656a9f9c1f6SBarry Smith   (*ctx)->howoften = howoften;
3657d763cef2SBarry Smith   PetscFunctionReturn(0);
3658d763cef2SBarry Smith }
3659d763cef2SBarry Smith 
36604a2ae208SSatish Balay #undef __FUNCT__
36614f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGTimeStep"
3662b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx)
3663d763cef2SBarry Smith {
36640b039ecaSBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
3665c32365f1SBarry Smith   PetscReal      x   = ptime,y;
3666dfbe8321SBarry Smith   PetscErrorCode ierr;
3667d763cef2SBarry Smith 
3668d763cef2SBarry Smith   PetscFunctionBegin;
3669b06615a5SLisandro Dalcin   if (!step) {
3670a9f9c1f6SBarry Smith     PetscDrawAxis axis;
3671a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
3672a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time step");CHKERRQ(ierr);
3673a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
3674a9f9c1f6SBarry Smith   }
3675c32365f1SBarry Smith   ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr);
36760b039ecaSBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
3677b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
36780b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
36793923b477SBarry Smith   }
3680d763cef2SBarry Smith   PetscFunctionReturn(0);
3681d763cef2SBarry Smith }
3682d763cef2SBarry Smith 
36834a2ae208SSatish Balay #undef __FUNCT__
3684a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxDestroy"
3685d763cef2SBarry Smith /*@C
3686a9f9c1f6SBarry Smith    TSMonitorLGCtxDestroy - Destroys a line graph context that was created
3687a9f9c1f6SBarry Smith    with TSMonitorLGCtxCreate().
3688d763cef2SBarry Smith 
36890b039ecaSBarry Smith    Collective on TSMonitorLGCtx
3690d763cef2SBarry Smith 
3691d763cef2SBarry Smith    Input Parameter:
36920b039ecaSBarry Smith .  ctx - the monitor context
3693d763cef2SBarry Smith 
3694d763cef2SBarry Smith    Level: intermediate
3695d763cef2SBarry Smith 
3696d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy
3697d763cef2SBarry Smith 
36984f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep();
3699d763cef2SBarry Smith @*/
3700a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx)
3701d763cef2SBarry Smith {
3702dfbe8321SBarry Smith   PetscErrorCode ierr;
3703d763cef2SBarry Smith 
3704d763cef2SBarry Smith   PetscFunctionBegin;
37057684fa3eSBarry Smith   if ((*ctx)->transformdestroy) {
37067684fa3eSBarry Smith     ierr = ((*ctx)->transformdestroy)((*ctx)->transformctx);CHKERRQ(ierr);
37077684fa3eSBarry Smith   }
37080b039ecaSBarry Smith   ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr);
370931152f8aSBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->names);CHKERRQ(ierr);
3710387f4636SBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->displaynames);CHKERRQ(ierr);
3711387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvariables);CHKERRQ(ierr);
3712387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvalues);CHKERRQ(ierr);
37130b039ecaSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
3714d763cef2SBarry Smith   PetscFunctionReturn(0);
3715d763cef2SBarry Smith }
3716d763cef2SBarry Smith 
37174a2ae208SSatish Balay #undef __FUNCT__
37184a2ae208SSatish Balay #define __FUNCT__ "TSGetTime"
3719d763cef2SBarry Smith /*@
3720b8123daeSJed Brown    TSGetTime - Gets the time of the most recently completed step.
3721d763cef2SBarry Smith 
3722d763cef2SBarry Smith    Not Collective
3723d763cef2SBarry Smith 
3724d763cef2SBarry Smith    Input Parameter:
3725d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3726d763cef2SBarry Smith 
3727d763cef2SBarry Smith    Output Parameter:
3728d763cef2SBarry Smith .  t  - the current time
3729d763cef2SBarry Smith 
3730d763cef2SBarry Smith    Level: beginner
3731d763cef2SBarry Smith 
3732b8123daeSJed Brown    Note:
3733b8123daeSJed Brown    When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(),
37349be3e283SDebojyoti Ghosh    TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated.
3735b8123daeSJed Brown 
3736d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
3737d763cef2SBarry Smith 
3738d763cef2SBarry Smith .keywords: TS, get, time
3739d763cef2SBarry Smith @*/
37407087cfbeSBarry Smith PetscErrorCode  TSGetTime(TS ts,PetscReal *t)
3741d763cef2SBarry Smith {
3742d763cef2SBarry Smith   PetscFunctionBegin;
37430700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3744f7cf8827SBarry Smith   PetscValidRealPointer(t,2);
3745d763cef2SBarry Smith   *t = ts->ptime;
3746d763cef2SBarry Smith   PetscFunctionReturn(0);
3747d763cef2SBarry Smith }
3748d763cef2SBarry Smith 
37494a2ae208SSatish Balay #undef __FUNCT__
3750e5e524a1SHong Zhang #define __FUNCT__ "TSGetPrevTime"
3751e5e524a1SHong Zhang /*@
3752e5e524a1SHong Zhang    TSGetPrevTime - Gets the starting time of the previously completed step.
3753e5e524a1SHong Zhang 
3754e5e524a1SHong Zhang    Not Collective
3755e5e524a1SHong Zhang 
3756e5e524a1SHong Zhang    Input Parameter:
3757e5e524a1SHong Zhang .  ts - the TS context obtained from TSCreate()
3758e5e524a1SHong Zhang 
3759e5e524a1SHong Zhang    Output Parameter:
3760e5e524a1SHong Zhang .  t  - the previous time
3761e5e524a1SHong Zhang 
3762e5e524a1SHong Zhang    Level: beginner
3763e5e524a1SHong Zhang 
3764e5e524a1SHong Zhang .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
3765e5e524a1SHong Zhang 
3766e5e524a1SHong Zhang .keywords: TS, get, time
3767e5e524a1SHong Zhang @*/
3768e5e524a1SHong Zhang PetscErrorCode  TSGetPrevTime(TS ts,PetscReal *t)
3769e5e524a1SHong Zhang {
3770e5e524a1SHong Zhang   PetscFunctionBegin;
3771e5e524a1SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3772e5e524a1SHong Zhang   PetscValidRealPointer(t,2);
3773e5e524a1SHong Zhang   *t = ts->ptime_prev;
3774e5e524a1SHong Zhang   PetscFunctionReturn(0);
3775e5e524a1SHong Zhang }
3776e5e524a1SHong Zhang 
3777e5e524a1SHong Zhang #undef __FUNCT__
37786a4d4014SLisandro Dalcin #define __FUNCT__ "TSSetTime"
37796a4d4014SLisandro Dalcin /*@
37806a4d4014SLisandro Dalcin    TSSetTime - Allows one to reset the time.
37816a4d4014SLisandro Dalcin 
37823f9fe445SBarry Smith    Logically Collective on TS
37836a4d4014SLisandro Dalcin 
37846a4d4014SLisandro Dalcin    Input Parameters:
37856a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
37866a4d4014SLisandro Dalcin -  time - the time
37876a4d4014SLisandro Dalcin 
37886a4d4014SLisandro Dalcin    Level: intermediate
37896a4d4014SLisandro Dalcin 
37906a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration()
37916a4d4014SLisandro Dalcin 
37926a4d4014SLisandro Dalcin .keywords: TS, set, time
37936a4d4014SLisandro Dalcin @*/
37947087cfbeSBarry Smith PetscErrorCode  TSSetTime(TS ts, PetscReal t)
37956a4d4014SLisandro Dalcin {
37966a4d4014SLisandro Dalcin   PetscFunctionBegin;
37970700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3798c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,t,2);
37996a4d4014SLisandro Dalcin   ts->ptime = t;
38006a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
38016a4d4014SLisandro Dalcin }
38026a4d4014SLisandro Dalcin 
38036a4d4014SLisandro Dalcin #undef __FUNCT__
38044a2ae208SSatish Balay #define __FUNCT__ "TSSetOptionsPrefix"
3805d763cef2SBarry Smith /*@C
3806d763cef2SBarry Smith    TSSetOptionsPrefix - Sets the prefix used for searching for all
3807d763cef2SBarry Smith    TS options in the database.
3808d763cef2SBarry Smith 
38093f9fe445SBarry Smith    Logically Collective on TS
3810d763cef2SBarry Smith 
3811d763cef2SBarry Smith    Input Parameter:
3812d763cef2SBarry Smith +  ts     - The TS context
3813d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
3814d763cef2SBarry Smith 
3815d763cef2SBarry Smith    Notes:
3816d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
3817d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
3818d763cef2SBarry Smith    hyphen.
3819d763cef2SBarry Smith 
3820d763cef2SBarry Smith    Level: advanced
3821d763cef2SBarry Smith 
3822d763cef2SBarry Smith .keywords: TS, set, options, prefix, database
3823d763cef2SBarry Smith 
3824d763cef2SBarry Smith .seealso: TSSetFromOptions()
3825d763cef2SBarry Smith 
3826d763cef2SBarry Smith @*/
38277087cfbeSBarry Smith PetscErrorCode  TSSetOptionsPrefix(TS ts,const char prefix[])
3828d763cef2SBarry Smith {
3829dfbe8321SBarry Smith   PetscErrorCode ierr;
3830089b2837SJed Brown   SNES           snes;
3831d763cef2SBarry Smith 
3832d763cef2SBarry Smith   PetscFunctionBegin;
38330700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3834d763cef2SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3835089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3836089b2837SJed Brown   ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr);
3837d763cef2SBarry Smith   PetscFunctionReturn(0);
3838d763cef2SBarry Smith }
3839d763cef2SBarry Smith 
3840d763cef2SBarry Smith 
38414a2ae208SSatish Balay #undef __FUNCT__
38424a2ae208SSatish Balay #define __FUNCT__ "TSAppendOptionsPrefix"
3843d763cef2SBarry Smith /*@C
3844d763cef2SBarry Smith    TSAppendOptionsPrefix - Appends to the prefix used for searching for all
3845d763cef2SBarry Smith    TS options in the database.
3846d763cef2SBarry Smith 
38473f9fe445SBarry Smith    Logically Collective on TS
3848d763cef2SBarry Smith 
3849d763cef2SBarry Smith    Input Parameter:
3850d763cef2SBarry Smith +  ts     - The TS context
3851d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
3852d763cef2SBarry Smith 
3853d763cef2SBarry Smith    Notes:
3854d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
3855d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
3856d763cef2SBarry Smith    hyphen.
3857d763cef2SBarry Smith 
3858d763cef2SBarry Smith    Level: advanced
3859d763cef2SBarry Smith 
3860d763cef2SBarry Smith .keywords: TS, append, options, prefix, database
3861d763cef2SBarry Smith 
3862d763cef2SBarry Smith .seealso: TSGetOptionsPrefix()
3863d763cef2SBarry Smith 
3864d763cef2SBarry Smith @*/
38657087cfbeSBarry Smith PetscErrorCode  TSAppendOptionsPrefix(TS ts,const char prefix[])
3866d763cef2SBarry Smith {
3867dfbe8321SBarry Smith   PetscErrorCode ierr;
3868089b2837SJed Brown   SNES           snes;
3869d763cef2SBarry Smith 
3870d763cef2SBarry Smith   PetscFunctionBegin;
38710700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3872d763cef2SBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3873089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3874089b2837SJed Brown   ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr);
3875d763cef2SBarry Smith   PetscFunctionReturn(0);
3876d763cef2SBarry Smith }
3877d763cef2SBarry Smith 
38784a2ae208SSatish Balay #undef __FUNCT__
38794a2ae208SSatish Balay #define __FUNCT__ "TSGetOptionsPrefix"
3880d763cef2SBarry Smith /*@C
3881d763cef2SBarry Smith    TSGetOptionsPrefix - Sets the prefix used for searching for all
3882d763cef2SBarry Smith    TS options in the database.
3883d763cef2SBarry Smith 
3884d763cef2SBarry Smith    Not Collective
3885d763cef2SBarry Smith 
3886d763cef2SBarry Smith    Input Parameter:
3887d763cef2SBarry Smith .  ts - The TS context
3888d763cef2SBarry Smith 
3889d763cef2SBarry Smith    Output Parameter:
3890d763cef2SBarry Smith .  prefix - A pointer to the prefix string used
3891d763cef2SBarry Smith 
3892d763cef2SBarry Smith    Notes: On the fortran side, the user should pass in a string 'prifix' of
3893d763cef2SBarry Smith    sufficient length to hold the prefix.
3894d763cef2SBarry Smith 
3895d763cef2SBarry Smith    Level: intermediate
3896d763cef2SBarry Smith 
3897d763cef2SBarry Smith .keywords: TS, get, options, prefix, database
3898d763cef2SBarry Smith 
3899d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix()
3900d763cef2SBarry Smith @*/
39017087cfbeSBarry Smith PetscErrorCode  TSGetOptionsPrefix(TS ts,const char *prefix[])
3902d763cef2SBarry Smith {
3903dfbe8321SBarry Smith   PetscErrorCode ierr;
3904d763cef2SBarry Smith 
3905d763cef2SBarry Smith   PetscFunctionBegin;
39060700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
39074482741eSBarry Smith   PetscValidPointer(prefix,2);
3908d763cef2SBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3909d763cef2SBarry Smith   PetscFunctionReturn(0);
3910d763cef2SBarry Smith }
3911d763cef2SBarry Smith 
39124a2ae208SSatish Balay #undef __FUNCT__
39134a2ae208SSatish Balay #define __FUNCT__ "TSGetRHSJacobian"
3914d763cef2SBarry Smith /*@C
3915d763cef2SBarry Smith    TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
3916d763cef2SBarry Smith 
3917d763cef2SBarry Smith    Not Collective, but parallel objects are returned if TS is parallel
3918d763cef2SBarry Smith 
3919d763cef2SBarry Smith    Input Parameter:
3920d763cef2SBarry Smith .  ts  - The TS context obtained from TSCreate()
3921d763cef2SBarry Smith 
3922d763cef2SBarry Smith    Output Parameters:
3923e4357dc4SBarry Smith +  Amat - The (approximate) Jacobian J of G, where U_t = G(U,t)  (or NULL)
3924e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat  (or NULL)
3925e4357dc4SBarry Smith .  func - Function to compute the Jacobian of the RHS  (or NULL)
3926e4357dc4SBarry Smith -  ctx - User-defined context for Jacobian evaluation routine  (or NULL)
3927d763cef2SBarry Smith 
39280298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
3929d763cef2SBarry Smith 
3930d763cef2SBarry Smith    Level: intermediate
3931d763cef2SBarry Smith 
393226d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
3933d763cef2SBarry Smith 
3934d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian
3935d763cef2SBarry Smith @*/
3936e4357dc4SBarry Smith PetscErrorCode  TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx)
3937d763cef2SBarry Smith {
3938089b2837SJed Brown   PetscErrorCode ierr;
3939089b2837SJed Brown   SNES           snes;
394024989b8cSPeter Brune   DM             dm;
3941089b2837SJed Brown 
3942d763cef2SBarry Smith   PetscFunctionBegin;
3943089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3944e4357dc4SBarry Smith   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
394524989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
394624989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr);
3947d763cef2SBarry Smith   PetscFunctionReturn(0);
3948d763cef2SBarry Smith }
3949d763cef2SBarry Smith 
39501713a123SBarry Smith #undef __FUNCT__
39512eca1d9cSJed Brown #define __FUNCT__ "TSGetIJacobian"
39522eca1d9cSJed Brown /*@C
39532eca1d9cSJed Brown    TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
39542eca1d9cSJed Brown 
39552eca1d9cSJed Brown    Not Collective, but parallel objects are returned if TS is parallel
39562eca1d9cSJed Brown 
39572eca1d9cSJed Brown    Input Parameter:
39582eca1d9cSJed Brown .  ts  - The TS context obtained from TSCreate()
39592eca1d9cSJed Brown 
39602eca1d9cSJed Brown    Output Parameters:
3961e4357dc4SBarry Smith +  Amat  - The (approximate) Jacobian of F(t,U,U_t)
3962e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, often the same as Amat
39632eca1d9cSJed Brown .  f   - The function to compute the matrices
39642eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine
39652eca1d9cSJed Brown 
39660298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
39672eca1d9cSJed Brown 
39682eca1d9cSJed Brown    Level: advanced
39692eca1d9cSJed Brown 
39702eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
39712eca1d9cSJed Brown 
39722eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian
39732eca1d9cSJed Brown @*/
3974e4357dc4SBarry Smith PetscErrorCode  TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx)
39752eca1d9cSJed Brown {
3976089b2837SJed Brown   PetscErrorCode ierr;
3977089b2837SJed Brown   SNES           snes;
397824989b8cSPeter Brune   DM             dm;
39790910c330SBarry Smith 
39802eca1d9cSJed Brown   PetscFunctionBegin;
3981089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3982f7d39f7aSBarry Smith   ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
3983e4357dc4SBarry Smith   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
398424989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
398524989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr);
39862eca1d9cSJed Brown   PetscFunctionReturn(0);
39872eca1d9cSJed Brown }
39882eca1d9cSJed Brown 
39896083293cSBarry Smith 
39902eca1d9cSJed Brown #undef __FUNCT__
399183a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawSolution"
39921713a123SBarry Smith /*@C
399383a4ac43SBarry Smith    TSMonitorDrawSolution - Monitors progress of the TS solvers by calling
39941713a123SBarry Smith    VecView() for the solution at each timestep
39951713a123SBarry Smith 
39961713a123SBarry Smith    Collective on TS
39971713a123SBarry Smith 
39981713a123SBarry Smith    Input Parameters:
39991713a123SBarry Smith +  ts - the TS context
40001713a123SBarry Smith .  step - current time-step
4001142b95e3SSatish Balay .  ptime - current time
40020298fd71SBarry Smith -  dummy - either a viewer or NULL
40031713a123SBarry Smith 
400499fdda47SBarry Smith    Options Database:
400599fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
400699fdda47SBarry Smith 
4007387f4636SBarry Smith    Notes: the initial solution and current solution are not display with a common axis scaling so generally the option -ts_monitor_draw_solution_initial
400899fdda47SBarry Smith        will look bad
400999fdda47SBarry Smith 
40101713a123SBarry Smith    Level: intermediate
40111713a123SBarry Smith 
40121713a123SBarry Smith .keywords: TS,  vector, monitor, view
40131713a123SBarry Smith 
4014a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
40151713a123SBarry Smith @*/
40160910c330SBarry Smith PetscErrorCode  TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
40171713a123SBarry Smith {
4018dfbe8321SBarry Smith   PetscErrorCode   ierr;
401983a4ac43SBarry Smith   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
4020473a3ab2SBarry Smith   PetscDraw        draw;
40211713a123SBarry Smith 
40221713a123SBarry Smith   PetscFunctionBegin;
40236083293cSBarry Smith   if (!step && ictx->showinitial) {
40246083293cSBarry Smith     if (!ictx->initialsolution) {
40250910c330SBarry Smith       ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr);
40261713a123SBarry Smith     }
40270910c330SBarry Smith     ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr);
40286083293cSBarry Smith   }
4029b06615a5SLisandro Dalcin   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
40300dcf80beSBarry Smith 
40316083293cSBarry Smith   if (ictx->showinitial) {
40326083293cSBarry Smith     PetscReal pause;
40336083293cSBarry Smith     ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr);
40346083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr);
40356083293cSBarry Smith     ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr);
40366083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr);
40376083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr);
40386083293cSBarry Smith   }
40390910c330SBarry Smith   ierr = VecView(u,ictx->viewer);CHKERRQ(ierr);
4040473a3ab2SBarry Smith   if (ictx->showtimestepandtime) {
404151fa3d41SBarry Smith     PetscReal xl,yl,xr,yr,h;
4042473a3ab2SBarry Smith     char      time[32];
4043473a3ab2SBarry Smith 
4044473a3ab2SBarry Smith     ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
404585b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
4046473a3ab2SBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
4047473a3ab2SBarry Smith     h    = yl + .95*(yr - yl);
404851fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
4049473a3ab2SBarry Smith     ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
4050473a3ab2SBarry Smith   }
4051473a3ab2SBarry Smith 
40526083293cSBarry Smith   if (ictx->showinitial) {
40536083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr);
40546083293cSBarry Smith   }
40551713a123SBarry Smith   PetscFunctionReturn(0);
40561713a123SBarry Smith }
40571713a123SBarry Smith 
40582d5ee99bSBarry Smith #undef __FUNCT__
40599110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitorDrawSensi"
40609110b2e7SHong Zhang /*@C
40619110b2e7SHong Zhang    TSAdjointMonitorDrawSensi - Monitors progress of the adjoint TS solvers by calling
40629110b2e7SHong Zhang    VecView() for the sensitivities to initial states at each timestep
40639110b2e7SHong Zhang 
40649110b2e7SHong Zhang    Collective on TS
40659110b2e7SHong Zhang 
40669110b2e7SHong Zhang    Input Parameters:
40679110b2e7SHong Zhang +  ts - the TS context
40689110b2e7SHong Zhang .  step - current time-step
40699110b2e7SHong Zhang .  ptime - current time
40709110b2e7SHong Zhang .  u - current state
40719110b2e7SHong Zhang .  numcost - number of cost functions
40729110b2e7SHong Zhang .  lambda - sensitivities to initial conditions
40739110b2e7SHong Zhang .  mu - sensitivities to parameters
40749110b2e7SHong Zhang -  dummy - either a viewer or NULL
40759110b2e7SHong Zhang 
40769110b2e7SHong Zhang    Level: intermediate
40779110b2e7SHong Zhang 
40789110b2e7SHong Zhang .keywords: TS,  vector, adjoint, monitor, view
40799110b2e7SHong Zhang 
40809110b2e7SHong Zhang .seealso: TSAdjointMonitorSet(), TSAdjointMonitorDefault(), VecView()
40819110b2e7SHong Zhang @*/
40829110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorDrawSensi(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda,Vec *mu,void *dummy)
40839110b2e7SHong Zhang {
40849110b2e7SHong Zhang   PetscErrorCode   ierr;
40859110b2e7SHong Zhang   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
40869110b2e7SHong Zhang   PetscDraw        draw;
4087a0046e2cSSatish Balay   PetscReal        xl,yl,xr,yr,h;
4088a0046e2cSSatish Balay   char             time[32];
40899110b2e7SHong Zhang 
40909110b2e7SHong Zhang   PetscFunctionBegin;
40919110b2e7SHong Zhang   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
40929110b2e7SHong Zhang 
40939110b2e7SHong Zhang   ierr = VecView(lambda[0],ictx->viewer);CHKERRQ(ierr);
40949110b2e7SHong Zhang   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
40959110b2e7SHong Zhang   ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
40969110b2e7SHong Zhang   ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
40979110b2e7SHong Zhang   h    = yl + .95*(yr - yl);
40989110b2e7SHong Zhang   ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
40999110b2e7SHong Zhang   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
41009110b2e7SHong Zhang 
41019110b2e7SHong Zhang   PetscFunctionReturn(0);
41029110b2e7SHong Zhang }
41039110b2e7SHong Zhang 
41049110b2e7SHong Zhang #undef __FUNCT__
41052d5ee99bSBarry Smith #define __FUNCT__ "TSMonitorDrawSolutionPhase"
41062d5ee99bSBarry Smith /*@C
41072d5ee99bSBarry Smith    TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram
41082d5ee99bSBarry Smith 
41092d5ee99bSBarry Smith    Collective on TS
41102d5ee99bSBarry Smith 
41112d5ee99bSBarry Smith    Input Parameters:
41122d5ee99bSBarry Smith +  ts - the TS context
41132d5ee99bSBarry Smith .  step - current time-step
41142d5ee99bSBarry Smith .  ptime - current time
41152d5ee99bSBarry Smith -  dummy - either a viewer or NULL
41162d5ee99bSBarry Smith 
41172d5ee99bSBarry Smith    Level: intermediate
41182d5ee99bSBarry Smith 
41192d5ee99bSBarry Smith .keywords: TS,  vector, monitor, view
41202d5ee99bSBarry Smith 
41212d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
41222d5ee99bSBarry Smith @*/
41232d5ee99bSBarry Smith PetscErrorCode  TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
41242d5ee99bSBarry Smith {
41252d5ee99bSBarry Smith   PetscErrorCode    ierr;
41262d5ee99bSBarry Smith   TSMonitorDrawCtx  ictx = (TSMonitorDrawCtx)dummy;
41272d5ee99bSBarry Smith   PetscDraw         draw;
41282d5ee99bSBarry Smith   MPI_Comm          comm;
41292d5ee99bSBarry Smith   PetscInt          n;
41302d5ee99bSBarry Smith   PetscMPIInt       size;
413151fa3d41SBarry Smith   PetscReal         xl,yl,xr,yr,h;
41322d5ee99bSBarry Smith   char              time[32];
41332d5ee99bSBarry Smith   const PetscScalar *U;
41342d5ee99bSBarry Smith 
41352d5ee99bSBarry Smith   PetscFunctionBegin;
41362d5ee99bSBarry Smith   ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
41372d5ee99bSBarry Smith   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
41382d5ee99bSBarry Smith   if (size != 1) SETERRQ(comm,PETSC_ERR_SUP,"Only allowed for sequential runs");
41392d5ee99bSBarry Smith   ierr = VecGetSize(u,&n);CHKERRQ(ierr);
41402d5ee99bSBarry Smith   if (n != 2) SETERRQ(comm,PETSC_ERR_SUP,"Only for ODEs with two unknowns");
41412d5ee99bSBarry Smith 
41422d5ee99bSBarry Smith   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
41432d5ee99bSBarry Smith 
41442d5ee99bSBarry Smith   ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr);
41454b363babSBarry Smith   ierr = PetscDrawAxisGetLimits(ictx->axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr);
4146ba5783adSMatthew G Knepley   if ((PetscRealPart(U[0]) < xl) || (PetscRealPart(U[1]) < yl) || (PetscRealPart(U[0]) > xr) || (PetscRealPart(U[1]) > yr)) {
4147a4494fc1SBarry Smith       ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
4148a4494fc1SBarry Smith       PetscFunctionReturn(0);
4149a4494fc1SBarry Smith   }
41502d5ee99bSBarry Smith   if (!step) ictx->color++;
41512d5ee99bSBarry Smith   ierr = PetscDrawPoint(draw,PetscRealPart(U[0]),PetscRealPart(U[1]),ictx->color);CHKERRQ(ierr);
41522d5ee99bSBarry Smith   ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
41532d5ee99bSBarry Smith 
41542d5ee99bSBarry Smith   if (ictx->showtimestepandtime) {
41554b363babSBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
415685b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
41572d5ee99bSBarry Smith     h    = yl + .95*(yr - yl);
415851fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
41592d5ee99bSBarry Smith   }
41602d5ee99bSBarry Smith   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
41612d5ee99bSBarry Smith   PetscFunctionReturn(0);
41622d5ee99bSBarry Smith }
41632d5ee99bSBarry Smith 
41641713a123SBarry Smith 
41656c699258SBarry Smith #undef __FUNCT__
416683a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxDestroy"
41676083293cSBarry Smith /*@C
416883a4ac43SBarry Smith    TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution()
41696083293cSBarry Smith 
41706083293cSBarry Smith    Collective on TS
41716083293cSBarry Smith 
41726083293cSBarry Smith    Input Parameters:
41736083293cSBarry Smith .    ctx - the monitor context
41746083293cSBarry Smith 
41756083293cSBarry Smith    Level: intermediate
41766083293cSBarry Smith 
41776083293cSBarry Smith .keywords: TS,  vector, monitor, view
41786083293cSBarry Smith 
417983a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError()
41806083293cSBarry Smith @*/
418183a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx)
41826083293cSBarry Smith {
41836083293cSBarry Smith   PetscErrorCode ierr;
41846083293cSBarry Smith 
41856083293cSBarry Smith   PetscFunctionBegin;
41864b363babSBarry Smith   ierr = PetscDrawAxisDestroy(&(*ictx)->axis);CHKERRQ(ierr);
418783a4ac43SBarry Smith   ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr);
418883a4ac43SBarry Smith   ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr);
418983a4ac43SBarry Smith   ierr = PetscFree(*ictx);CHKERRQ(ierr);
41906083293cSBarry Smith   PetscFunctionReturn(0);
41916083293cSBarry Smith }
41926083293cSBarry Smith 
41936083293cSBarry Smith #undef __FUNCT__
419483a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxCreate"
41956083293cSBarry Smith /*@C
419683a4ac43SBarry Smith    TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx
41976083293cSBarry Smith 
41986083293cSBarry Smith    Collective on TS
41996083293cSBarry Smith 
42006083293cSBarry Smith    Input Parameter:
42016083293cSBarry Smith .    ts - time-step context
42026083293cSBarry Smith 
42036083293cSBarry Smith    Output Patameter:
42046083293cSBarry Smith .    ctx - the monitor context
42056083293cSBarry Smith 
420699fdda47SBarry Smith    Options Database:
420799fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
420899fdda47SBarry Smith 
42096083293cSBarry Smith    Level: intermediate
42106083293cSBarry Smith 
42116083293cSBarry Smith .keywords: TS,  vector, monitor, view
42126083293cSBarry Smith 
421383a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx()
42146083293cSBarry Smith @*/
421583a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx)
42166083293cSBarry Smith {
42176083293cSBarry Smith   PetscErrorCode   ierr;
42186083293cSBarry Smith 
42196083293cSBarry Smith   PetscFunctionBegin;
4220b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
422183a4ac43SBarry Smith   ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr);
4222e9457bf7SBarry Smith   ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr);
4223bbd56ea5SKarl Rupp 
422483a4ac43SBarry Smith   (*ctx)->howoften    = howoften;
4225473a3ab2SBarry Smith   (*ctx)->showinitial = PETSC_FALSE;
42260298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr);
4227473a3ab2SBarry Smith 
4228473a3ab2SBarry Smith   (*ctx)->showtimestepandtime = PETSC_FALSE;
42290298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr);
42302d5ee99bSBarry Smith   (*ctx)->color = PETSC_DRAW_WHITE;
42316083293cSBarry Smith   PetscFunctionReturn(0);
42326083293cSBarry Smith }
42336083293cSBarry Smith 
42346083293cSBarry Smith #undef __FUNCT__
423583a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawError"
42363a471f94SBarry Smith /*@C
423783a4ac43SBarry Smith    TSMonitorDrawError - Monitors progress of the TS solvers by calling
42383a471f94SBarry Smith    VecView() for the error at each timestep
42393a471f94SBarry Smith 
42403a471f94SBarry Smith    Collective on TS
42413a471f94SBarry Smith 
42423a471f94SBarry Smith    Input Parameters:
42433a471f94SBarry Smith +  ts - the TS context
42443a471f94SBarry Smith .  step - current time-step
42453a471f94SBarry Smith .  ptime - current time
42460298fd71SBarry Smith -  dummy - either a viewer or NULL
42473a471f94SBarry Smith 
42483a471f94SBarry Smith    Level: intermediate
42493a471f94SBarry Smith 
42503a471f94SBarry Smith .keywords: TS,  vector, monitor, view
42513a471f94SBarry Smith 
42523a471f94SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
42533a471f94SBarry Smith @*/
42540910c330SBarry Smith PetscErrorCode  TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
42553a471f94SBarry Smith {
42563a471f94SBarry Smith   PetscErrorCode   ierr;
425783a4ac43SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
425883a4ac43SBarry Smith   PetscViewer      viewer = ctx->viewer;
42593a471f94SBarry Smith   Vec              work;
42603a471f94SBarry Smith 
42613a471f94SBarry Smith   PetscFunctionBegin;
4262b06615a5SLisandro Dalcin   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
42630910c330SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
42643a471f94SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
42650910c330SBarry Smith   ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr);
42663a471f94SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
42673a471f94SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
42683a471f94SBarry Smith   PetscFunctionReturn(0);
42693a471f94SBarry Smith }
42703a471f94SBarry Smith 
4271af0996ceSBarry Smith #include <petsc/private/dmimpl.h>
42723a471f94SBarry Smith #undef __FUNCT__
42736c699258SBarry Smith #define __FUNCT__ "TSSetDM"
42746c699258SBarry Smith /*@
42756c699258SBarry Smith    TSSetDM - Sets the DM that may be used by some preconditioners
42766c699258SBarry Smith 
42773f9fe445SBarry Smith    Logically Collective on TS and DM
42786c699258SBarry Smith 
42796c699258SBarry Smith    Input Parameters:
42806c699258SBarry Smith +  ts - the preconditioner context
42816c699258SBarry Smith -  dm - the dm
42826c699258SBarry Smith 
42836c699258SBarry Smith    Level: intermediate
42846c699258SBarry Smith 
42856c699258SBarry Smith 
42866c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
42876c699258SBarry Smith @*/
42887087cfbeSBarry Smith PetscErrorCode  TSSetDM(TS ts,DM dm)
42896c699258SBarry Smith {
42906c699258SBarry Smith   PetscErrorCode ierr;
4291089b2837SJed Brown   SNES           snes;
4292942e3340SBarry Smith   DMTS           tsdm;
42936c699258SBarry Smith 
42946c699258SBarry Smith   PetscFunctionBegin;
42950700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
429670663e4aSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);
4297942e3340SBarry Smith   if (ts->dm) {               /* Move the DMTS context over to the new DM unless the new DM already has one */
42982a34c10cSBarry Smith     if (ts->dm->dmts && !dm->dmts) {
4299942e3340SBarry Smith       ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr);
4300942e3340SBarry Smith       ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr);
430124989b8cSPeter Brune       if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */
430224989b8cSPeter Brune         tsdm->originaldm = dm;
430324989b8cSPeter Brune       }
430424989b8cSPeter Brune     }
43056bf464f9SBarry Smith     ierr = DMDestroy(&ts->dm);CHKERRQ(ierr);
430624989b8cSPeter Brune   }
43076c699258SBarry Smith   ts->dm = dm;
4308bbd56ea5SKarl Rupp 
4309089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4310089b2837SJed Brown   ierr = SNESSetDM(snes,dm);CHKERRQ(ierr);
43116c699258SBarry Smith   PetscFunctionReturn(0);
43126c699258SBarry Smith }
43136c699258SBarry Smith 
43146c699258SBarry Smith #undef __FUNCT__
43156c699258SBarry Smith #define __FUNCT__ "TSGetDM"
43166c699258SBarry Smith /*@
43176c699258SBarry Smith    TSGetDM - Gets the DM that may be used by some preconditioners
43186c699258SBarry Smith 
43193f9fe445SBarry Smith    Not Collective
43206c699258SBarry Smith 
43216c699258SBarry Smith    Input Parameter:
43226c699258SBarry Smith . ts - the preconditioner context
43236c699258SBarry Smith 
43246c699258SBarry Smith    Output Parameter:
43256c699258SBarry Smith .  dm - the dm
43266c699258SBarry Smith 
43276c699258SBarry Smith    Level: intermediate
43286c699258SBarry Smith 
43296c699258SBarry Smith 
43306c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
43316c699258SBarry Smith @*/
43327087cfbeSBarry Smith PetscErrorCode  TSGetDM(TS ts,DM *dm)
43336c699258SBarry Smith {
4334496e6a7aSJed Brown   PetscErrorCode ierr;
4335496e6a7aSJed Brown 
43366c699258SBarry Smith   PetscFunctionBegin;
43370700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4338496e6a7aSJed Brown   if (!ts->dm) {
4339ce94432eSBarry Smith     ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr);
4340496e6a7aSJed Brown     if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
4341496e6a7aSJed Brown   }
43426c699258SBarry Smith   *dm = ts->dm;
43436c699258SBarry Smith   PetscFunctionReturn(0);
43446c699258SBarry Smith }
43451713a123SBarry Smith 
43460f5c6efeSJed Brown #undef __FUNCT__
43470f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormFunction"
43480f5c6efeSJed Brown /*@
43490f5c6efeSJed Brown    SNESTSFormFunction - Function to evaluate nonlinear residual
43500f5c6efeSJed Brown 
43513f9fe445SBarry Smith    Logically Collective on SNES
43520f5c6efeSJed Brown 
43530f5c6efeSJed Brown    Input Parameter:
4354d42a1c89SJed Brown + snes - nonlinear solver
43550910c330SBarry Smith . U - the current state at which to evaluate the residual
4356d42a1c89SJed Brown - ctx - user context, must be a TS
43570f5c6efeSJed Brown 
43580f5c6efeSJed Brown    Output Parameter:
43590f5c6efeSJed Brown . F - the nonlinear residual
43600f5c6efeSJed Brown 
43610f5c6efeSJed Brown    Notes:
43620f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
43630f5c6efeSJed Brown    It is most frequently passed to MatFDColoringSetFunction().
43640f5c6efeSJed Brown 
43650f5c6efeSJed Brown    Level: advanced
43660f5c6efeSJed Brown 
43670f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction()
43680f5c6efeSJed Brown @*/
43690910c330SBarry Smith PetscErrorCode  SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx)
43700f5c6efeSJed Brown {
43710f5c6efeSJed Brown   TS             ts = (TS)ctx;
43720f5c6efeSJed Brown   PetscErrorCode ierr;
43730f5c6efeSJed Brown 
43740f5c6efeSJed Brown   PetscFunctionBegin;
43750f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
43760910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
43770f5c6efeSJed Brown   PetscValidHeaderSpecific(F,VEC_CLASSID,3);
43780f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,4);
43790910c330SBarry Smith   ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr);
43800f5c6efeSJed Brown   PetscFunctionReturn(0);
43810f5c6efeSJed Brown }
43820f5c6efeSJed Brown 
43830f5c6efeSJed Brown #undef __FUNCT__
43840f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormJacobian"
43850f5c6efeSJed Brown /*@
43860f5c6efeSJed Brown    SNESTSFormJacobian - Function to evaluate the Jacobian
43870f5c6efeSJed Brown 
43880f5c6efeSJed Brown    Collective on SNES
43890f5c6efeSJed Brown 
43900f5c6efeSJed Brown    Input Parameter:
43910f5c6efeSJed Brown + snes - nonlinear solver
43920910c330SBarry Smith . U - the current state at which to evaluate the residual
43930f5c6efeSJed Brown - ctx - user context, must be a TS
43940f5c6efeSJed Brown 
43950f5c6efeSJed Brown    Output Parameter:
43960f5c6efeSJed Brown + A - the Jacobian
43970f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A)
43980f5c6efeSJed Brown - flag - indicates any structure change in the matrix
43990f5c6efeSJed Brown 
44000f5c6efeSJed Brown    Notes:
44010f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
44020f5c6efeSJed Brown 
44030f5c6efeSJed Brown    Level: developer
44040f5c6efeSJed Brown 
44050f5c6efeSJed Brown .seealso: SNESSetJacobian()
44060f5c6efeSJed Brown @*/
4407d1e9a80fSBarry Smith PetscErrorCode  SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx)
44080f5c6efeSJed Brown {
44090f5c6efeSJed Brown   TS             ts = (TS)ctx;
44100f5c6efeSJed Brown   PetscErrorCode ierr;
44110f5c6efeSJed Brown 
44120f5c6efeSJed Brown   PetscFunctionBegin;
44130f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
44140910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
44150f5c6efeSJed Brown   PetscValidPointer(A,3);
441694ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,3);
44170f5c6efeSJed Brown   PetscValidPointer(B,4);
441894ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,4);
44190f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,6);
4420d1e9a80fSBarry Smith   ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr);
44210f5c6efeSJed Brown   PetscFunctionReturn(0);
44220f5c6efeSJed Brown }
4423325fc9f4SBarry Smith 
44240e4ef248SJed Brown #undef __FUNCT__
44250e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSFunctionLinear"
44260e4ef248SJed Brown /*@C
44270e4ef248SJed Brown    TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems only
44280e4ef248SJed Brown 
44290e4ef248SJed Brown    Collective on TS
44300e4ef248SJed Brown 
44310e4ef248SJed Brown    Input Arguments:
44320e4ef248SJed Brown +  ts - time stepping context
44330e4ef248SJed Brown .  t - time at which to evaluate
44340910c330SBarry Smith .  U - state at which to evaluate
44350e4ef248SJed Brown -  ctx - context
44360e4ef248SJed Brown 
44370e4ef248SJed Brown    Output Arguments:
44380e4ef248SJed Brown .  F - right hand side
44390e4ef248SJed Brown 
44400e4ef248SJed Brown    Level: intermediate
44410e4ef248SJed Brown 
44420e4ef248SJed Brown    Notes:
44430e4ef248SJed Brown    This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
44440e4ef248SJed Brown    The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
44450e4ef248SJed Brown 
44460e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
44470e4ef248SJed Brown @*/
44480910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx)
44490e4ef248SJed Brown {
44500e4ef248SJed Brown   PetscErrorCode ierr;
44510e4ef248SJed Brown   Mat            Arhs,Brhs;
44520e4ef248SJed Brown 
44530e4ef248SJed Brown   PetscFunctionBegin;
44540e4ef248SJed Brown   ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
4455d1e9a80fSBarry Smith   ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
44560910c330SBarry Smith   ierr = MatMult(Arhs,U,F);CHKERRQ(ierr);
44570e4ef248SJed Brown   PetscFunctionReturn(0);
44580e4ef248SJed Brown }
44590e4ef248SJed Brown 
44600e4ef248SJed Brown #undef __FUNCT__
44610e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSJacobianConstant"
44620e4ef248SJed Brown /*@C
44630e4ef248SJed Brown    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
44640e4ef248SJed Brown 
44650e4ef248SJed Brown    Collective on TS
44660e4ef248SJed Brown 
44670e4ef248SJed Brown    Input Arguments:
44680e4ef248SJed Brown +  ts - time stepping context
44690e4ef248SJed Brown .  t - time at which to evaluate
44700910c330SBarry Smith .  U - state at which to evaluate
44710e4ef248SJed Brown -  ctx - context
44720e4ef248SJed Brown 
44730e4ef248SJed Brown    Output Arguments:
44740e4ef248SJed Brown +  A - pointer to operator
44750e4ef248SJed Brown .  B - pointer to preconditioning matrix
44760e4ef248SJed Brown -  flg - matrix structure flag
44770e4ef248SJed Brown 
44780e4ef248SJed Brown    Level: intermediate
44790e4ef248SJed Brown 
44800e4ef248SJed Brown    Notes:
44810e4ef248SJed Brown    This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
44820e4ef248SJed Brown 
44830e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
44840e4ef248SJed Brown @*/
4485d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx)
44860e4ef248SJed Brown {
44870e4ef248SJed Brown   PetscFunctionBegin;
44880e4ef248SJed Brown   PetscFunctionReturn(0);
44890e4ef248SJed Brown }
44900e4ef248SJed Brown 
44910026cea9SSean Farley #undef __FUNCT__
44920026cea9SSean Farley #define __FUNCT__ "TSComputeIFunctionLinear"
44930026cea9SSean Farley /*@C
44940026cea9SSean Farley    TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
44950026cea9SSean Farley 
44960026cea9SSean Farley    Collective on TS
44970026cea9SSean Farley 
44980026cea9SSean Farley    Input Arguments:
44990026cea9SSean Farley +  ts - time stepping context
45000026cea9SSean Farley .  t - time at which to evaluate
45010910c330SBarry Smith .  U - state at which to evaluate
45020910c330SBarry Smith .  Udot - time derivative of state vector
45030026cea9SSean Farley -  ctx - context
45040026cea9SSean Farley 
45050026cea9SSean Farley    Output Arguments:
45060026cea9SSean Farley .  F - left hand side
45070026cea9SSean Farley 
45080026cea9SSean Farley    Level: intermediate
45090026cea9SSean Farley 
45100026cea9SSean Farley    Notes:
45110910c330SBarry 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
45120026cea9SSean Farley    user is required to write their own TSComputeIFunction.
45130026cea9SSean Farley    This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
45140026cea9SSean Farley    The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
45150026cea9SSean Farley 
45160026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant()
45170026cea9SSean Farley @*/
45180910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx)
45190026cea9SSean Farley {
45200026cea9SSean Farley   PetscErrorCode ierr;
45210026cea9SSean Farley   Mat            A,B;
45220026cea9SSean Farley 
45230026cea9SSean Farley   PetscFunctionBegin;
45240298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
4525d1e9a80fSBarry Smith   ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr);
45260910c330SBarry Smith   ierr = MatMult(A,Udot,F);CHKERRQ(ierr);
45270026cea9SSean Farley   PetscFunctionReturn(0);
45280026cea9SSean Farley }
45290026cea9SSean Farley 
45300026cea9SSean Farley #undef __FUNCT__
45310026cea9SSean Farley #define __FUNCT__ "TSComputeIJacobianConstant"
45320026cea9SSean Farley /*@C
4533b41af12eSJed Brown    TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE
45340026cea9SSean Farley 
45350026cea9SSean Farley    Collective on TS
45360026cea9SSean Farley 
45370026cea9SSean Farley    Input Arguments:
45380026cea9SSean Farley +  ts - time stepping context
45390026cea9SSean Farley .  t - time at which to evaluate
45400910c330SBarry Smith .  U - state at which to evaluate
45410910c330SBarry Smith .  Udot - time derivative of state vector
45420026cea9SSean Farley .  shift - shift to apply
45430026cea9SSean Farley -  ctx - context
45440026cea9SSean Farley 
45450026cea9SSean Farley    Output Arguments:
45460026cea9SSean Farley +  A - pointer to operator
45470026cea9SSean Farley .  B - pointer to preconditioning matrix
45480026cea9SSean Farley -  flg - matrix structure flag
45490026cea9SSean Farley 
4550b41af12eSJed Brown    Level: advanced
45510026cea9SSean Farley 
45520026cea9SSean Farley    Notes:
45530026cea9SSean Farley    This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
45540026cea9SSean Farley 
4555b41af12eSJed Brown    It is only appropriate for problems of the form
4556b41af12eSJed Brown 
4557b41af12eSJed Brown $     M Udot = F(U,t)
4558b41af12eSJed Brown 
4559b41af12eSJed Brown   where M is constant and F is non-stiff.  The user must pass M to TSSetIJacobian().  The current implementation only
4560b41af12eSJed Brown   works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing
4561b41af12eSJed Brown   an implicit operator of the form
4562b41af12eSJed Brown 
4563b41af12eSJed Brown $    shift*M + J
4564b41af12eSJed Brown 
4565b41af12eSJed Brown   where J is the Jacobian of -F(U).  Support may be added in a future version of PETSc, but for now, the user must store
4566b41af12eSJed Brown   a copy of M or reassemble it when requested.
4567b41af12eSJed Brown 
45680026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
45690026cea9SSean Farley @*/
4570d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx)
45710026cea9SSean Farley {
4572b41af12eSJed Brown   PetscErrorCode ierr;
4573b41af12eSJed Brown 
45740026cea9SSean Farley   PetscFunctionBegin;
457594ab13aaSBarry Smith   ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr);
4576b41af12eSJed Brown   ts->ijacobian.shift = shift;
45770026cea9SSean Farley   PetscFunctionReturn(0);
45780026cea9SSean Farley }
4579b41af12eSJed Brown 
4580e817cc15SEmil Constantinescu #undef __FUNCT__
4581e817cc15SEmil Constantinescu #define __FUNCT__ "TSGetEquationType"
4582e817cc15SEmil Constantinescu /*@
4583e817cc15SEmil Constantinescu    TSGetEquationType - Gets the type of the equation that TS is solving.
4584e817cc15SEmil Constantinescu 
4585e817cc15SEmil Constantinescu    Not Collective
4586e817cc15SEmil Constantinescu 
4587e817cc15SEmil Constantinescu    Input Parameter:
4588e817cc15SEmil Constantinescu .  ts - the TS context
4589e817cc15SEmil Constantinescu 
4590e817cc15SEmil Constantinescu    Output Parameter:
45914e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
4592e817cc15SEmil Constantinescu 
4593e817cc15SEmil Constantinescu    Level: beginner
4594e817cc15SEmil Constantinescu 
4595e817cc15SEmil Constantinescu .keywords: TS, equation type
4596e817cc15SEmil Constantinescu 
4597e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType
4598e817cc15SEmil Constantinescu @*/
4599e817cc15SEmil Constantinescu PetscErrorCode  TSGetEquationType(TS ts,TSEquationType *equation_type)
4600e817cc15SEmil Constantinescu {
4601e817cc15SEmil Constantinescu   PetscFunctionBegin;
4602e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4603e817cc15SEmil Constantinescu   PetscValidPointer(equation_type,2);
4604e817cc15SEmil Constantinescu   *equation_type = ts->equation_type;
4605e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
4606e817cc15SEmil Constantinescu }
4607e817cc15SEmil Constantinescu 
4608e817cc15SEmil Constantinescu #undef __FUNCT__
4609e817cc15SEmil Constantinescu #define __FUNCT__ "TSSetEquationType"
4610e817cc15SEmil Constantinescu /*@
4611e817cc15SEmil Constantinescu    TSSetEquationType - Sets the type of the equation that TS is solving.
4612e817cc15SEmil Constantinescu 
4613e817cc15SEmil Constantinescu    Not Collective
4614e817cc15SEmil Constantinescu 
4615e817cc15SEmil Constantinescu    Input Parameter:
4616e817cc15SEmil Constantinescu +  ts - the TS context
46171297b224SEmil Constantinescu -  equation_type - see TSEquationType
4618e817cc15SEmil Constantinescu 
4619e817cc15SEmil Constantinescu    Level: advanced
4620e817cc15SEmil Constantinescu 
4621e817cc15SEmil Constantinescu .keywords: TS, equation type
4622e817cc15SEmil Constantinescu 
4623e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType
4624e817cc15SEmil Constantinescu @*/
4625e817cc15SEmil Constantinescu PetscErrorCode  TSSetEquationType(TS ts,TSEquationType equation_type)
4626e817cc15SEmil Constantinescu {
4627e817cc15SEmil Constantinescu   PetscFunctionBegin;
4628e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4629e817cc15SEmil Constantinescu   ts->equation_type = equation_type;
4630e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
4631e817cc15SEmil Constantinescu }
46320026cea9SSean Farley 
46334af1b03aSJed Brown #undef __FUNCT__
46344af1b03aSJed Brown #define __FUNCT__ "TSGetConvergedReason"
46354af1b03aSJed Brown /*@
46364af1b03aSJed Brown    TSGetConvergedReason - Gets the reason the TS iteration was stopped.
46374af1b03aSJed Brown 
46384af1b03aSJed Brown    Not Collective
46394af1b03aSJed Brown 
46404af1b03aSJed Brown    Input Parameter:
46414af1b03aSJed Brown .  ts - the TS context
46424af1b03aSJed Brown 
46434af1b03aSJed Brown    Output Parameter:
46444af1b03aSJed Brown .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
46454af1b03aSJed Brown             manual pages for the individual convergence tests for complete lists
46464af1b03aSJed Brown 
4647487e0bb9SJed Brown    Level: beginner
46484af1b03aSJed Brown 
4649cd652676SJed Brown    Notes:
4650cd652676SJed Brown    Can only be called after the call to TSSolve() is complete.
46514af1b03aSJed Brown 
46524af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test
46534af1b03aSJed Brown 
46544af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason
46554af1b03aSJed Brown @*/
46564af1b03aSJed Brown PetscErrorCode  TSGetConvergedReason(TS ts,TSConvergedReason *reason)
46574af1b03aSJed Brown {
46584af1b03aSJed Brown   PetscFunctionBegin;
46594af1b03aSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
46604af1b03aSJed Brown   PetscValidPointer(reason,2);
46614af1b03aSJed Brown   *reason = ts->reason;
46624af1b03aSJed Brown   PetscFunctionReturn(0);
46634af1b03aSJed Brown }
46644af1b03aSJed Brown 
4665fb1732b5SBarry Smith #undef __FUNCT__
4666d6ad946cSShri Abhyankar #define __FUNCT__ "TSSetConvergedReason"
4667d6ad946cSShri Abhyankar /*@
4668d6ad946cSShri Abhyankar    TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve.
4669d6ad946cSShri Abhyankar 
4670d6ad946cSShri Abhyankar    Not Collective
4671d6ad946cSShri Abhyankar 
4672d6ad946cSShri Abhyankar    Input Parameter:
4673d6ad946cSShri Abhyankar +  ts - the TS context
4674d6ad946cSShri Abhyankar .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
4675d6ad946cSShri Abhyankar             manual pages for the individual convergence tests for complete lists
4676d6ad946cSShri Abhyankar 
4677f5abba47SShri Abhyankar    Level: advanced
4678d6ad946cSShri Abhyankar 
4679d6ad946cSShri Abhyankar    Notes:
4680d6ad946cSShri Abhyankar    Can only be called during TSSolve() is active.
4681d6ad946cSShri Abhyankar 
4682d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test
4683d6ad946cSShri Abhyankar 
4684d6ad946cSShri Abhyankar .seealso: TSConvergedReason
4685d6ad946cSShri Abhyankar @*/
4686d6ad946cSShri Abhyankar PetscErrorCode  TSSetConvergedReason(TS ts,TSConvergedReason reason)
4687d6ad946cSShri Abhyankar {
4688d6ad946cSShri Abhyankar   PetscFunctionBegin;
4689d6ad946cSShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4690d6ad946cSShri Abhyankar   ts->reason = reason;
4691d6ad946cSShri Abhyankar   PetscFunctionReturn(0);
4692d6ad946cSShri Abhyankar }
4693d6ad946cSShri Abhyankar 
4694d6ad946cSShri Abhyankar #undef __FUNCT__
4695cc708dedSBarry Smith #define __FUNCT__ "TSGetSolveTime"
4696cc708dedSBarry Smith /*@
4697cc708dedSBarry Smith    TSGetSolveTime - Gets the time after a call to TSSolve()
4698cc708dedSBarry Smith 
4699cc708dedSBarry Smith    Not Collective
4700cc708dedSBarry Smith 
4701cc708dedSBarry Smith    Input Parameter:
4702cc708dedSBarry Smith .  ts - the TS context
4703cc708dedSBarry Smith 
4704cc708dedSBarry Smith    Output Parameter:
4705cc708dedSBarry Smith .  ftime - the final time. This time should correspond to the final time set with TSSetDuration()
4706cc708dedSBarry Smith 
4707487e0bb9SJed Brown    Level: beginner
4708cc708dedSBarry Smith 
4709cc708dedSBarry Smith    Notes:
4710cc708dedSBarry Smith    Can only be called after the call to TSSolve() is complete.
4711cc708dedSBarry Smith 
4712cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test
4713cc708dedSBarry Smith 
4714cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
4715cc708dedSBarry Smith @*/
4716cc708dedSBarry Smith PetscErrorCode  TSGetSolveTime(TS ts,PetscReal *ftime)
4717cc708dedSBarry Smith {
4718cc708dedSBarry Smith   PetscFunctionBegin;
4719cc708dedSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4720cc708dedSBarry Smith   PetscValidPointer(ftime,2);
4721cc708dedSBarry Smith   *ftime = ts->solvetime;
4722cc708dedSBarry Smith   PetscFunctionReturn(0);
4723cc708dedSBarry Smith }
4724cc708dedSBarry Smith 
4725cc708dedSBarry Smith #undef __FUNCT__
47262c18e0fdSBarry Smith #define __FUNCT__ "TSGetTotalSteps"
47272c18e0fdSBarry Smith /*@
47282c18e0fdSBarry Smith    TSGetTotalSteps - Gets the total number of steps done since the last call to TSSetUp() or TSCreate()
47292c18e0fdSBarry Smith 
47302c18e0fdSBarry Smith    Not Collective
47312c18e0fdSBarry Smith 
47322c18e0fdSBarry Smith    Input Parameter:
47332c18e0fdSBarry Smith .  ts - the TS context
47342c18e0fdSBarry Smith 
47352c18e0fdSBarry Smith    Output Parameter:
47362c18e0fdSBarry Smith .  steps - the number of steps
47372c18e0fdSBarry Smith 
47382c18e0fdSBarry Smith    Level: beginner
47392c18e0fdSBarry Smith 
47402c18e0fdSBarry Smith    Notes:
47412c18e0fdSBarry Smith    Includes the number of steps for all calls to TSSolve() since TSSetUp() was called
47422c18e0fdSBarry Smith 
47432c18e0fdSBarry Smith .keywords: TS, nonlinear, set, convergence, test
47442c18e0fdSBarry Smith 
47452c18e0fdSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
47462c18e0fdSBarry Smith @*/
47472c18e0fdSBarry Smith PetscErrorCode  TSGetTotalSteps(TS ts,PetscInt *steps)
47482c18e0fdSBarry Smith {
47492c18e0fdSBarry Smith   PetscFunctionBegin;
47502c18e0fdSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
47512c18e0fdSBarry Smith   PetscValidPointer(steps,2);
47522c18e0fdSBarry Smith   *steps = ts->total_steps;
47532c18e0fdSBarry Smith   PetscFunctionReturn(0);
47542c18e0fdSBarry Smith }
47552c18e0fdSBarry Smith 
47562c18e0fdSBarry Smith #undef __FUNCT__
47575ef26d82SJed Brown #define __FUNCT__ "TSGetSNESIterations"
47589f67acb7SJed Brown /*@
47595ef26d82SJed Brown    TSGetSNESIterations - Gets the total number of nonlinear iterations
47609f67acb7SJed Brown    used by the time integrator.
47619f67acb7SJed Brown 
47629f67acb7SJed Brown    Not Collective
47639f67acb7SJed Brown 
47649f67acb7SJed Brown    Input Parameter:
47659f67acb7SJed Brown .  ts - TS context
47669f67acb7SJed Brown 
47679f67acb7SJed Brown    Output Parameter:
47689f67acb7SJed Brown .  nits - number of nonlinear iterations
47699f67acb7SJed Brown 
47709f67acb7SJed Brown    Notes:
47719f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
47729f67acb7SJed Brown 
47739f67acb7SJed Brown    Level: intermediate
47749f67acb7SJed Brown 
47759f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations
47769f67acb7SJed Brown 
47775ef26d82SJed Brown .seealso:  TSGetKSPIterations()
47789f67acb7SJed Brown @*/
47795ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits)
47809f67acb7SJed Brown {
47819f67acb7SJed Brown   PetscFunctionBegin;
47829f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
47839f67acb7SJed Brown   PetscValidIntPointer(nits,2);
47845ef26d82SJed Brown   *nits = ts->snes_its;
47859f67acb7SJed Brown   PetscFunctionReturn(0);
47869f67acb7SJed Brown }
47879f67acb7SJed Brown 
47889f67acb7SJed Brown #undef __FUNCT__
47895ef26d82SJed Brown #define __FUNCT__ "TSGetKSPIterations"
47909f67acb7SJed Brown /*@
47915ef26d82SJed Brown    TSGetKSPIterations - Gets the total number of linear iterations
47929f67acb7SJed Brown    used by the time integrator.
47939f67acb7SJed Brown 
47949f67acb7SJed Brown    Not Collective
47959f67acb7SJed Brown 
47969f67acb7SJed Brown    Input Parameter:
47979f67acb7SJed Brown .  ts - TS context
47989f67acb7SJed Brown 
47999f67acb7SJed Brown    Output Parameter:
48009f67acb7SJed Brown .  lits - number of linear iterations
48019f67acb7SJed Brown 
48029f67acb7SJed Brown    Notes:
48039f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
48049f67acb7SJed Brown 
48059f67acb7SJed Brown    Level: intermediate
48069f67acb7SJed Brown 
48079f67acb7SJed Brown .keywords: TS, get, number, linear, iterations
48089f67acb7SJed Brown 
48095ef26d82SJed Brown .seealso:  TSGetSNESIterations(), SNESGetKSPIterations()
48109f67acb7SJed Brown @*/
48115ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits)
48129f67acb7SJed Brown {
48139f67acb7SJed Brown   PetscFunctionBegin;
48149f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
48159f67acb7SJed Brown   PetscValidIntPointer(lits,2);
48165ef26d82SJed Brown   *lits = ts->ksp_its;
48179f67acb7SJed Brown   PetscFunctionReturn(0);
48189f67acb7SJed Brown }
48199f67acb7SJed Brown 
48209f67acb7SJed Brown #undef __FUNCT__
4821cef5090cSJed Brown #define __FUNCT__ "TSGetStepRejections"
4822cef5090cSJed Brown /*@
4823cef5090cSJed Brown    TSGetStepRejections - Gets the total number of rejected steps.
4824cef5090cSJed Brown 
4825cef5090cSJed Brown    Not Collective
4826cef5090cSJed Brown 
4827cef5090cSJed Brown    Input Parameter:
4828cef5090cSJed Brown .  ts - TS context
4829cef5090cSJed Brown 
4830cef5090cSJed Brown    Output Parameter:
4831cef5090cSJed Brown .  rejects - number of steps rejected
4832cef5090cSJed Brown 
4833cef5090cSJed Brown    Notes:
4834cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
4835cef5090cSJed Brown 
4836cef5090cSJed Brown    Level: intermediate
4837cef5090cSJed Brown 
4838cef5090cSJed Brown .keywords: TS, get, number
4839cef5090cSJed Brown 
48405ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails()
4841cef5090cSJed Brown @*/
4842cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects)
4843cef5090cSJed Brown {
4844cef5090cSJed Brown   PetscFunctionBegin;
4845cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4846cef5090cSJed Brown   PetscValidIntPointer(rejects,2);
4847cef5090cSJed Brown   *rejects = ts->reject;
4848cef5090cSJed Brown   PetscFunctionReturn(0);
4849cef5090cSJed Brown }
4850cef5090cSJed Brown 
4851cef5090cSJed Brown #undef __FUNCT__
4852cef5090cSJed Brown #define __FUNCT__ "TSGetSNESFailures"
4853cef5090cSJed Brown /*@
4854cef5090cSJed Brown    TSGetSNESFailures - Gets the total number of failed SNES solves
4855cef5090cSJed Brown 
4856cef5090cSJed Brown    Not Collective
4857cef5090cSJed Brown 
4858cef5090cSJed Brown    Input Parameter:
4859cef5090cSJed Brown .  ts - TS context
4860cef5090cSJed Brown 
4861cef5090cSJed Brown    Output Parameter:
4862cef5090cSJed Brown .  fails - number of failed nonlinear solves
4863cef5090cSJed Brown 
4864cef5090cSJed Brown    Notes:
4865cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
4866cef5090cSJed Brown 
4867cef5090cSJed Brown    Level: intermediate
4868cef5090cSJed Brown 
4869cef5090cSJed Brown .keywords: TS, get, number
4870cef5090cSJed Brown 
48715ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures()
4872cef5090cSJed Brown @*/
4873cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails)
4874cef5090cSJed Brown {
4875cef5090cSJed Brown   PetscFunctionBegin;
4876cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4877cef5090cSJed Brown   PetscValidIntPointer(fails,2);
4878cef5090cSJed Brown   *fails = ts->num_snes_failures;
4879cef5090cSJed Brown   PetscFunctionReturn(0);
4880cef5090cSJed Brown }
4881cef5090cSJed Brown 
4882cef5090cSJed Brown #undef __FUNCT__
4883cef5090cSJed Brown #define __FUNCT__ "TSSetMaxStepRejections"
4884cef5090cSJed Brown /*@
4885cef5090cSJed Brown    TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails
4886cef5090cSJed Brown 
4887cef5090cSJed Brown    Not Collective
4888cef5090cSJed Brown 
4889cef5090cSJed Brown    Input Parameter:
4890cef5090cSJed Brown +  ts - TS context
4891cef5090cSJed Brown -  rejects - maximum number of rejected steps, pass -1 for unlimited
4892cef5090cSJed Brown 
4893cef5090cSJed Brown    Notes:
4894cef5090cSJed Brown    The counter is reset to zero for each step
4895cef5090cSJed Brown 
4896cef5090cSJed Brown    Options Database Key:
4897cef5090cSJed Brown  .  -ts_max_reject - Maximum number of step rejections before a step fails
4898cef5090cSJed Brown 
4899cef5090cSJed Brown    Level: intermediate
4900cef5090cSJed Brown 
4901cef5090cSJed Brown .keywords: TS, set, maximum, number
4902cef5090cSJed Brown 
49035ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
4904cef5090cSJed Brown @*/
4905cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects)
4906cef5090cSJed Brown {
4907cef5090cSJed Brown   PetscFunctionBegin;
4908cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4909cef5090cSJed Brown   ts->max_reject = rejects;
4910cef5090cSJed Brown   PetscFunctionReturn(0);
4911cef5090cSJed Brown }
4912cef5090cSJed Brown 
4913cef5090cSJed Brown #undef __FUNCT__
4914cef5090cSJed Brown #define __FUNCT__ "TSSetMaxSNESFailures"
4915cef5090cSJed Brown /*@
4916cef5090cSJed Brown    TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves
4917cef5090cSJed Brown 
4918cef5090cSJed Brown    Not Collective
4919cef5090cSJed Brown 
4920cef5090cSJed Brown    Input Parameter:
4921cef5090cSJed Brown +  ts - TS context
4922cef5090cSJed Brown -  fails - maximum number of failed nonlinear solves, pass -1 for unlimited
4923cef5090cSJed Brown 
4924cef5090cSJed Brown    Notes:
4925cef5090cSJed Brown    The counter is reset to zero for each successive call to TSSolve().
4926cef5090cSJed Brown 
4927cef5090cSJed Brown    Options Database Key:
4928cef5090cSJed Brown  .  -ts_max_snes_failures - Maximum number of nonlinear solve failures
4929cef5090cSJed Brown 
4930cef5090cSJed Brown    Level: intermediate
4931cef5090cSJed Brown 
4932cef5090cSJed Brown .keywords: TS, set, maximum, number
4933cef5090cSJed Brown 
49345ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason()
4935cef5090cSJed Brown @*/
4936cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails)
4937cef5090cSJed Brown {
4938cef5090cSJed Brown   PetscFunctionBegin;
4939cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4940cef5090cSJed Brown   ts->max_snes_failures = fails;
4941cef5090cSJed Brown   PetscFunctionReturn(0);
4942cef5090cSJed Brown }
4943cef5090cSJed Brown 
4944cef5090cSJed Brown #undef __FUNCT__
49454e8de811SJed Brown #define __FUNCT__ "TSSetErrorIfStepFails"
4946cef5090cSJed Brown /*@
4947cef5090cSJed Brown    TSSetErrorIfStepFails - Error if no step succeeds
4948cef5090cSJed Brown 
4949cef5090cSJed Brown    Not Collective
4950cef5090cSJed Brown 
4951cef5090cSJed Brown    Input Parameter:
4952cef5090cSJed Brown +  ts - TS context
4953cef5090cSJed Brown -  err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure
4954cef5090cSJed Brown 
4955cef5090cSJed Brown    Options Database Key:
4956cef5090cSJed Brown  .  -ts_error_if_step_fails - Error if no step succeeds
4957cef5090cSJed Brown 
4958cef5090cSJed Brown    Level: intermediate
4959cef5090cSJed Brown 
4960cef5090cSJed Brown .keywords: TS, set, error
4961cef5090cSJed Brown 
49625ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
4963cef5090cSJed Brown @*/
4964cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err)
4965cef5090cSJed Brown {
4966cef5090cSJed Brown   PetscFunctionBegin;
4967cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4968cef5090cSJed Brown   ts->errorifstepfailed = err;
4969cef5090cSJed Brown   PetscFunctionReturn(0);
4970cef5090cSJed Brown }
4971cef5090cSJed Brown 
4972cef5090cSJed Brown #undef __FUNCT__
4973fb1732b5SBarry Smith #define __FUNCT__ "TSMonitorSolutionBinary"
4974fb1732b5SBarry Smith /*@C
4975fb1732b5SBarry Smith    TSMonitorSolutionBinary - Monitors progress of the TS solvers by VecView() for the solution at each timestep. Normally the viewer is a binary file
4976fb1732b5SBarry Smith 
4977fb1732b5SBarry Smith    Collective on TS
4978fb1732b5SBarry Smith 
4979fb1732b5SBarry Smith    Input Parameters:
4980fb1732b5SBarry Smith +  ts - the TS context
4981fb1732b5SBarry Smith .  step - current time-step
4982fb1732b5SBarry Smith .  ptime - current time
49830910c330SBarry Smith .  u - current state
4984fb1732b5SBarry Smith -  viewer - binary viewer
4985fb1732b5SBarry Smith 
4986fb1732b5SBarry Smith    Level: intermediate
4987fb1732b5SBarry Smith 
4988fb1732b5SBarry Smith .keywords: TS,  vector, monitor, view
4989fb1732b5SBarry Smith 
4990fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
4991fb1732b5SBarry Smith @*/
49920910c330SBarry Smith PetscErrorCode  TSMonitorSolutionBinary(TS ts,PetscInt step,PetscReal ptime,Vec u,void *viewer)
4993fb1732b5SBarry Smith {
4994fb1732b5SBarry Smith   PetscErrorCode ierr;
4995ed81e22dSJed Brown   PetscViewer    v = (PetscViewer)viewer;
4996fb1732b5SBarry Smith 
4997fb1732b5SBarry Smith   PetscFunctionBegin;
49980910c330SBarry Smith   ierr = VecView(u,v);CHKERRQ(ierr);
4999ed81e22dSJed Brown   PetscFunctionReturn(0);
5000ed81e22dSJed Brown }
5001ed81e22dSJed Brown 
5002ed81e22dSJed Brown #undef __FUNCT__
5003ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTK"
5004ed81e22dSJed Brown /*@C
5005ed81e22dSJed Brown    TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep.
5006ed81e22dSJed Brown 
5007ed81e22dSJed Brown    Collective on TS
5008ed81e22dSJed Brown 
5009ed81e22dSJed Brown    Input Parameters:
5010ed81e22dSJed Brown +  ts - the TS context
5011ed81e22dSJed Brown .  step - current time-step
5012ed81e22dSJed Brown .  ptime - current time
50130910c330SBarry Smith .  u - current state
5014ed81e22dSJed Brown -  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5015ed81e22dSJed Brown 
5016ed81e22dSJed Brown    Level: intermediate
5017ed81e22dSJed Brown 
5018ed81e22dSJed Brown    Notes:
5019ed81e22dSJed 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.
5020ed81e22dSJed Brown    These are named according to the file name template.
5021ed81e22dSJed Brown 
5022ed81e22dSJed Brown    This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy().
5023ed81e22dSJed Brown 
5024ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
5025ed81e22dSJed Brown 
5026ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5027ed81e22dSJed Brown @*/
50280910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate)
5029ed81e22dSJed Brown {
5030ed81e22dSJed Brown   PetscErrorCode ierr;
5031ed81e22dSJed Brown   char           filename[PETSC_MAX_PATH_LEN];
5032ed81e22dSJed Brown   PetscViewer    viewer;
5033ed81e22dSJed Brown 
5034ed81e22dSJed Brown   PetscFunctionBegin;
50358caf3d72SBarry Smith   ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr);
5036ce94432eSBarry Smith   ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr);
50370910c330SBarry Smith   ierr = VecView(u,viewer);CHKERRQ(ierr);
5038ed81e22dSJed Brown   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
5039ed81e22dSJed Brown   PetscFunctionReturn(0);
5040ed81e22dSJed Brown }
5041ed81e22dSJed Brown 
5042ed81e22dSJed Brown #undef __FUNCT__
5043ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTKDestroy"
5044ed81e22dSJed Brown /*@C
5045ed81e22dSJed Brown    TSMonitorSolutionVTKDestroy - Destroy context for monitoring
5046ed81e22dSJed Brown 
5047ed81e22dSJed Brown    Collective on TS
5048ed81e22dSJed Brown 
5049ed81e22dSJed Brown    Input Parameters:
5050ed81e22dSJed Brown .  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5051ed81e22dSJed Brown 
5052ed81e22dSJed Brown    Level: intermediate
5053ed81e22dSJed Brown 
5054ed81e22dSJed Brown    Note:
5055ed81e22dSJed Brown    This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK().
5056ed81e22dSJed Brown 
5057ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
5058ed81e22dSJed Brown 
5059ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK()
5060ed81e22dSJed Brown @*/
5061ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate)
5062ed81e22dSJed Brown {
5063ed81e22dSJed Brown   PetscErrorCode ierr;
5064ed81e22dSJed Brown 
5065ed81e22dSJed Brown   PetscFunctionBegin;
5066ed81e22dSJed Brown   ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr);
5067fb1732b5SBarry Smith   PetscFunctionReturn(0);
5068fb1732b5SBarry Smith }
5069fb1732b5SBarry Smith 
507084df9cb4SJed Brown #undef __FUNCT__
5071552698daSJed Brown #define __FUNCT__ "TSGetAdapt"
507284df9cb4SJed Brown /*@
5073552698daSJed Brown    TSGetAdapt - Get the adaptive controller context for the current method
507484df9cb4SJed Brown 
5075ed81e22dSJed Brown    Collective on TS if controller has not been created yet
507684df9cb4SJed Brown 
507784df9cb4SJed Brown    Input Arguments:
5078ed81e22dSJed Brown .  ts - time stepping context
507984df9cb4SJed Brown 
508084df9cb4SJed Brown    Output Arguments:
5081ed81e22dSJed Brown .  adapt - adaptive controller
508284df9cb4SJed Brown 
508384df9cb4SJed Brown    Level: intermediate
508484df9cb4SJed Brown 
5085ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose()
508684df9cb4SJed Brown @*/
5087552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt)
508884df9cb4SJed Brown {
508984df9cb4SJed Brown   PetscErrorCode ierr;
509084df9cb4SJed Brown 
509184df9cb4SJed Brown   PetscFunctionBegin;
509284df9cb4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
509384df9cb4SJed Brown   PetscValidPointer(adapt,2);
509484df9cb4SJed Brown   if (!ts->adapt) {
5095ce94432eSBarry Smith     ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr);
50963bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr);
50971c3436cfSJed Brown     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr);
509884df9cb4SJed Brown   }
509984df9cb4SJed Brown   *adapt = ts->adapt;
510084df9cb4SJed Brown   PetscFunctionReturn(0);
510184df9cb4SJed Brown }
5102d6ebe24aSShri Abhyankar 
5103d6ebe24aSShri Abhyankar #undef __FUNCT__
51041c3436cfSJed Brown #define __FUNCT__ "TSSetTolerances"
51051c3436cfSJed Brown /*@
51061c3436cfSJed Brown    TSSetTolerances - Set tolerances for local truncation error when using adaptive controller
51071c3436cfSJed Brown 
51081c3436cfSJed Brown    Logically Collective
51091c3436cfSJed Brown 
51101c3436cfSJed Brown    Input Arguments:
51111c3436cfSJed Brown +  ts - time integration context
51121c3436cfSJed Brown .  atol - scalar absolute tolerances, PETSC_DECIDE to leave current value
51130298fd71SBarry Smith .  vatol - vector of absolute tolerances or NULL, used in preference to atol if present
51141c3436cfSJed Brown .  rtol - scalar relative tolerances, PETSC_DECIDE to leave current value
51150298fd71SBarry Smith -  vrtol - vector of relative tolerances or NULL, used in preference to atol if present
51161c3436cfSJed Brown 
5117a3cdaa26SBarry Smith    Options Database keys:
5118a3cdaa26SBarry Smith +  -ts_rtol <rtol> - relative tolerance for local truncation error
5119a3cdaa26SBarry Smith -  -ts_atol <atol> Absolute tolerance for local truncation error
5120a3cdaa26SBarry Smith 
51213ff766beSShri Abhyankar    Notes:
51223ff766beSShri Abhyankar    With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error
51233ff766beSShri Abhyankar    (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be
51243ff766beSShri Abhyankar    computed only for the differential or the algebraic part then this can be done using the vector of
51253ff766beSShri Abhyankar    tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the
51263ff766beSShri Abhyankar    differential part and infinity for the algebraic part, the LTE calculation will include only the
51273ff766beSShri Abhyankar    differential variables.
51283ff766beSShri Abhyankar 
51291c3436cfSJed Brown    Level: beginner
51301c3436cfSJed Brown 
5131c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances()
51321c3436cfSJed Brown @*/
51331c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol)
51341c3436cfSJed Brown {
51351c3436cfSJed Brown   PetscErrorCode ierr;
51361c3436cfSJed Brown 
51371c3436cfSJed Brown   PetscFunctionBegin;
5138c5033834SJed Brown   if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol;
51391c3436cfSJed Brown   if (vatol) {
51401c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr);
51411c3436cfSJed Brown     ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
5142bbd56ea5SKarl Rupp 
51431c3436cfSJed Brown     ts->vatol = vatol;
51441c3436cfSJed Brown   }
5145c5033834SJed Brown   if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol;
51461c3436cfSJed Brown   if (vrtol) {
51471c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr);
51481c3436cfSJed Brown     ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
5149bbd56ea5SKarl Rupp 
51501c3436cfSJed Brown     ts->vrtol = vrtol;
51511c3436cfSJed Brown   }
51521c3436cfSJed Brown   PetscFunctionReturn(0);
51531c3436cfSJed Brown }
51541c3436cfSJed Brown 
51551c3436cfSJed Brown #undef __FUNCT__
5156c5033834SJed Brown #define __FUNCT__ "TSGetTolerances"
5157c5033834SJed Brown /*@
5158c5033834SJed Brown    TSGetTolerances - Get tolerances for local truncation error when using adaptive controller
5159c5033834SJed Brown 
5160c5033834SJed Brown    Logically Collective
5161c5033834SJed Brown 
5162c5033834SJed Brown    Input Arguments:
5163c5033834SJed Brown .  ts - time integration context
5164c5033834SJed Brown 
5165c5033834SJed Brown    Output Arguments:
51660298fd71SBarry Smith +  atol - scalar absolute tolerances, NULL to ignore
51670298fd71SBarry Smith .  vatol - vector of absolute tolerances, NULL to ignore
51680298fd71SBarry Smith .  rtol - scalar relative tolerances, NULL to ignore
51690298fd71SBarry Smith -  vrtol - vector of relative tolerances, NULL to ignore
5170c5033834SJed Brown 
5171c5033834SJed Brown    Level: beginner
5172c5033834SJed Brown 
5173c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances()
5174c5033834SJed Brown @*/
5175c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol)
5176c5033834SJed Brown {
5177c5033834SJed Brown   PetscFunctionBegin;
5178c5033834SJed Brown   if (atol)  *atol  = ts->atol;
5179c5033834SJed Brown   if (vatol) *vatol = ts->vatol;
5180c5033834SJed Brown   if (rtol)  *rtol  = ts->rtol;
5181c5033834SJed Brown   if (vrtol) *vrtol = ts->vrtol;
5182c5033834SJed Brown   PetscFunctionReturn(0);
5183c5033834SJed Brown }
5184c5033834SJed Brown 
5185c5033834SJed Brown #undef __FUNCT__
51869c6b16b5SShri Abhyankar #define __FUNCT__ "TSErrorWeightedNorm2"
51879c6b16b5SShri Abhyankar /*@
5188a4868fbcSLisandro Dalcin    TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors
51899c6b16b5SShri Abhyankar 
51909c6b16b5SShri Abhyankar    Collective on TS
51919c6b16b5SShri Abhyankar 
51929c6b16b5SShri Abhyankar    Input Arguments:
51939c6b16b5SShri Abhyankar +  ts - time stepping context
5194a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5195a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
51969c6b16b5SShri Abhyankar 
51979c6b16b5SShri Abhyankar    Output Arguments:
51989c6b16b5SShri Abhyankar .  norm - weighted norm, a value of 1.0 is considered small
51999c6b16b5SShri Abhyankar 
52009c6b16b5SShri Abhyankar    Level: developer
52019c6b16b5SShri Abhyankar 
5202deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity()
52039c6b16b5SShri Abhyankar @*/
5204a4868fbcSLisandro Dalcin PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm)
52059c6b16b5SShri Abhyankar {
52069c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
52079c6b16b5SShri Abhyankar   PetscInt          i,n,N,rstart;
52089c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
52099c6b16b5SShri Abhyankar   PetscReal         sum,gsum;
52109c6b16b5SShri Abhyankar   PetscReal         tol;
52119c6b16b5SShri Abhyankar 
52129c6b16b5SShri Abhyankar   PetscFunctionBegin;
52139c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5214a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
5215a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
5216a4868fbcSLisandro Dalcin   PetscValidType(U,2);
5217a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
5218a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
5219a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
5220a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
52219c6b16b5SShri Abhyankar 
52229c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
52239c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
52249c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
52259c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
52269c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
52279c6b16b5SShri Abhyankar   sum  = 0.;
52289c6b16b5SShri Abhyankar   if (ts->vatol && ts->vrtol) {
52299c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
52309c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
52319c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
52329c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
52339c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
52349c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
52359c6b16b5SShri Abhyankar     }
52369c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
52379c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
52389c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
52399c6b16b5SShri Abhyankar     const PetscScalar *atol;
52409c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
52419c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
52429c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
52439c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
52449c6b16b5SShri Abhyankar     }
52459c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
52469c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
52479c6b16b5SShri Abhyankar     const PetscScalar *rtol;
52489c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
52499c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
52509c6b16b5SShri Abhyankar       tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
52519c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
52529c6b16b5SShri Abhyankar     }
52539c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
52549c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
52559c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
52569c6b16b5SShri Abhyankar       tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
52579c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
52589c6b16b5SShri Abhyankar     }
52599c6b16b5SShri Abhyankar   }
52609c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
52619c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
52629c6b16b5SShri Abhyankar 
52639c6b16b5SShri Abhyankar   ierr  = MPI_Allreduce(&sum,&gsum,1,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
52649c6b16b5SShri Abhyankar   *norm = PetscSqrtReal(gsum / N);
52659c6b16b5SShri Abhyankar 
52669c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
52679c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
52689c6b16b5SShri Abhyankar }
52699c6b16b5SShri Abhyankar 
52709c6b16b5SShri Abhyankar #undef __FUNCT__
52719c6b16b5SShri Abhyankar #define __FUNCT__ "TSErrorWeightedNormInfinity"
52729c6b16b5SShri Abhyankar /*@
5273a4868fbcSLisandro Dalcin    TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors
52749c6b16b5SShri Abhyankar 
52759c6b16b5SShri Abhyankar    Collective on TS
52769c6b16b5SShri Abhyankar 
52779c6b16b5SShri Abhyankar    Input Arguments:
52789c6b16b5SShri Abhyankar +  ts - time stepping context
5279a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5280a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
52819c6b16b5SShri Abhyankar 
52829c6b16b5SShri Abhyankar    Output Arguments:
52839c6b16b5SShri Abhyankar .  norm - weighted norm, a value of 1.0 is considered small
52849c6b16b5SShri Abhyankar 
52859c6b16b5SShri Abhyankar    Level: developer
52869c6b16b5SShri Abhyankar 
5287deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2()
52889c6b16b5SShri Abhyankar @*/
5289a4868fbcSLisandro Dalcin PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm)
52909c6b16b5SShri Abhyankar {
52919c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
52929c6b16b5SShri Abhyankar   PetscInt          i,n,N,rstart,k;
52939c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
52949c6b16b5SShri Abhyankar   PetscReal         max,gmax;
52959c6b16b5SShri Abhyankar   PetscReal         tol;
52969c6b16b5SShri Abhyankar 
52979c6b16b5SShri Abhyankar   PetscFunctionBegin;
52989c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5299a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
5300a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
5301a4868fbcSLisandro Dalcin   PetscValidType(U,2);
5302a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
5303a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
5304a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
5305a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
53069c6b16b5SShri Abhyankar 
53079c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
53089c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
53099c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
53109c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
53119c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
53129c6b16b5SShri Abhyankar   if (ts->vatol && ts->vrtol) {
53139c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
53149c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
53159c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
53169c6b16b5SShri Abhyankar     k = 0;
53179c6b16b5SShri Abhyankar     tol = PetscRealPart(atol[k]) + PetscRealPart(rtol[k]) * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
53189c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
53199c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
53209c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
53219c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
53229c6b16b5SShri Abhyankar     }
53239c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
53249c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
53259c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
53269c6b16b5SShri Abhyankar     const PetscScalar *atol;
53279c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
53289c6b16b5SShri Abhyankar     k = 0;
53299c6b16b5SShri Abhyankar     tol = PetscRealPart(atol[k]) + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
53309c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
53319c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
53329c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
53339c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
53349c6b16b5SShri Abhyankar     }
53359c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
53369c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
53379c6b16b5SShri Abhyankar     const PetscScalar *rtol;
53389c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
53399c6b16b5SShri Abhyankar     k = 0;
53409c6b16b5SShri Abhyankar     tol = ts->atol + PetscRealPart(rtol[k]) * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
53419c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
53429c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
53439c6b16b5SShri Abhyankar       tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
53449c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
53459c6b16b5SShri Abhyankar     }
53469c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
53479c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
53489c6b16b5SShri Abhyankar     k = 0;
53499c6b16b5SShri Abhyankar     tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
53509c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
53519c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
53529c6b16b5SShri Abhyankar       tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
53539c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
53549c6b16b5SShri Abhyankar     }
53559c6b16b5SShri Abhyankar   }
53569c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
53579c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
53589c6b16b5SShri Abhyankar 
53599c6b16b5SShri Abhyankar   ierr  = MPI_Allreduce(&max,&gmax,1,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
53609c6b16b5SShri Abhyankar   *norm = gmax;
53619c6b16b5SShri Abhyankar 
53629c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
53639c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
53649c6b16b5SShri Abhyankar }
53659c6b16b5SShri Abhyankar 
53669c6b16b5SShri Abhyankar #undef __FUNCT__
53677619abb3SShri #define __FUNCT__ "TSErrorWeightedNorm"
53681c3436cfSJed Brown /*@
5369a4868fbcSLisandro Dalcin    TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors
53701c3436cfSJed Brown 
53711c3436cfSJed Brown    Collective on TS
53721c3436cfSJed Brown 
53731c3436cfSJed Brown    Input Arguments:
53741c3436cfSJed Brown +  ts - time stepping context
5375a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5376a4868fbcSLisandro Dalcin .  Y - state vector to be compared to U
5377a4868fbcSLisandro Dalcin -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
53787619abb3SShri 
53791c3436cfSJed Brown    Output Arguments:
53801c3436cfSJed Brown .  norm - weighted norm, a value of 1.0 is considered small
53811c3436cfSJed Brown 
5382a4868fbcSLisandro Dalcin 
5383a4868fbcSLisandro Dalcin    Options Database Keys:
5384a4868fbcSLisandro Dalcin .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
5385a4868fbcSLisandro Dalcin 
53861c3436cfSJed Brown    Level: developer
53871c3436cfSJed Brown 
5388deea92deSShri .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2()
53891c3436cfSJed Brown @*/
5390a4868fbcSLisandro Dalcin PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm)
53911c3436cfSJed Brown {
53928beabaa1SBarry Smith   PetscErrorCode ierr;
53931c3436cfSJed Brown 
53941c3436cfSJed Brown   PetscFunctionBegin;
5395a4868fbcSLisandro Dalcin   if (wnormtype == NORM_2) {
5396a4868fbcSLisandro Dalcin     ierr = TSErrorWeightedNorm2(ts,U,Y,norm);CHKERRQ(ierr);
5397a4868fbcSLisandro Dalcin   } else if(wnormtype == NORM_INFINITY) {
5398a4868fbcSLisandro Dalcin     ierr = TSErrorWeightedNormInfinity(ts,U,Y,norm);CHKERRQ(ierr);
5399a4868fbcSLisandro Dalcin   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
54001c3436cfSJed Brown   PetscFunctionReturn(0);
54011c3436cfSJed Brown }
54021c3436cfSJed Brown 
54031c3436cfSJed Brown #undef __FUNCT__
54048d59e960SJed Brown #define __FUNCT__ "TSSetCFLTimeLocal"
54058d59e960SJed Brown /*@
54068d59e960SJed Brown    TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler
54078d59e960SJed Brown 
54088d59e960SJed Brown    Logically Collective on TS
54098d59e960SJed Brown 
54108d59e960SJed Brown    Input Arguments:
54118d59e960SJed Brown +  ts - time stepping context
54128d59e960SJed Brown -  cfltime - maximum stable time step if using forward Euler (value can be different on each process)
54138d59e960SJed Brown 
54148d59e960SJed Brown    Note:
54158d59e960SJed Brown    After calling this function, the global CFL time can be obtained by calling TSGetCFLTime()
54168d59e960SJed Brown 
54178d59e960SJed Brown    Level: intermediate
54188d59e960SJed Brown 
54198d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL
54208d59e960SJed Brown @*/
54218d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime)
54228d59e960SJed Brown {
54238d59e960SJed Brown   PetscFunctionBegin;
54248d59e960SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
54258d59e960SJed Brown   ts->cfltime_local = cfltime;
54268d59e960SJed Brown   ts->cfltime       = -1.;
54278d59e960SJed Brown   PetscFunctionReturn(0);
54288d59e960SJed Brown }
54298d59e960SJed Brown 
54308d59e960SJed Brown #undef __FUNCT__
54318d59e960SJed Brown #define __FUNCT__ "TSGetCFLTime"
54328d59e960SJed Brown /*@
54338d59e960SJed Brown    TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler
54348d59e960SJed Brown 
54358d59e960SJed Brown    Collective on TS
54368d59e960SJed Brown 
54378d59e960SJed Brown    Input Arguments:
54388d59e960SJed Brown .  ts - time stepping context
54398d59e960SJed Brown 
54408d59e960SJed Brown    Output Arguments:
54418d59e960SJed Brown .  cfltime - maximum stable time step for forward Euler
54428d59e960SJed Brown 
54438d59e960SJed Brown    Level: advanced
54448d59e960SJed Brown 
54458d59e960SJed Brown .seealso: TSSetCFLTimeLocal()
54468d59e960SJed Brown @*/
54478d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime)
54488d59e960SJed Brown {
54498d59e960SJed Brown   PetscErrorCode ierr;
54508d59e960SJed Brown 
54518d59e960SJed Brown   PetscFunctionBegin;
54528d59e960SJed Brown   if (ts->cfltime < 0) {
5453ce94432eSBarry Smith     ierr = MPI_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
54548d59e960SJed Brown   }
54558d59e960SJed Brown   *cfltime = ts->cfltime;
54568d59e960SJed Brown   PetscFunctionReturn(0);
54578d59e960SJed Brown }
54588d59e960SJed Brown 
54598d59e960SJed Brown #undef __FUNCT__
5460d6ebe24aSShri Abhyankar #define __FUNCT__ "TSVISetVariableBounds"
5461d6ebe24aSShri Abhyankar /*@
5462d6ebe24aSShri Abhyankar    TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
5463d6ebe24aSShri Abhyankar 
5464d6ebe24aSShri Abhyankar    Input Parameters:
5465d6ebe24aSShri Abhyankar .  ts   - the TS context.
5466d6ebe24aSShri Abhyankar .  xl   - lower bound.
5467d6ebe24aSShri Abhyankar .  xu   - upper bound.
5468d6ebe24aSShri Abhyankar 
5469d6ebe24aSShri Abhyankar    Notes:
5470d6ebe24aSShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
5471e270355aSBarry Smith    PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp().
5472d6ebe24aSShri Abhyankar 
54732bd2b0e6SSatish Balay    Level: advanced
54742bd2b0e6SSatish Balay 
5475d6ebe24aSShri Abhyankar @*/
5476d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
5477d6ebe24aSShri Abhyankar {
5478d6ebe24aSShri Abhyankar   PetscErrorCode ierr;
5479d6ebe24aSShri Abhyankar   SNES           snes;
5480d6ebe24aSShri Abhyankar 
5481d6ebe24aSShri Abhyankar   PetscFunctionBegin;
5482d6ebe24aSShri Abhyankar   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
5483d6ebe24aSShri Abhyankar   ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr);
5484d6ebe24aSShri Abhyankar   PetscFunctionReturn(0);
5485d6ebe24aSShri Abhyankar }
5486d6ebe24aSShri Abhyankar 
5487325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
5488c6db04a5SJed Brown #include <mex.h>
5489325fc9f4SBarry Smith 
5490325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext;
5491325fc9f4SBarry Smith 
5492325fc9f4SBarry Smith #undef __FUNCT__
5493325fc9f4SBarry Smith #define __FUNCT__ "TSComputeFunction_Matlab"
5494325fc9f4SBarry Smith /*
5495325fc9f4SBarry Smith    TSComputeFunction_Matlab - Calls the function that has been set with
5496325fc9f4SBarry Smith                          TSSetFunctionMatlab().
5497325fc9f4SBarry Smith 
5498325fc9f4SBarry Smith    Collective on TS
5499325fc9f4SBarry Smith 
5500325fc9f4SBarry Smith    Input Parameters:
5501325fc9f4SBarry Smith +  snes - the TS context
55020910c330SBarry Smith -  u - input vector
5503325fc9f4SBarry Smith 
5504325fc9f4SBarry Smith    Output Parameter:
5505325fc9f4SBarry Smith .  y - function vector, as set by TSSetFunction()
5506325fc9f4SBarry Smith 
5507325fc9f4SBarry Smith    Notes:
5508325fc9f4SBarry Smith    TSComputeFunction() is typically used within nonlinear solvers
5509325fc9f4SBarry Smith    implementations, so most users would not generally call this routine
5510325fc9f4SBarry Smith    themselves.
5511325fc9f4SBarry Smith 
5512325fc9f4SBarry Smith    Level: developer
5513325fc9f4SBarry Smith 
5514325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
5515325fc9f4SBarry Smith 
5516325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
5517325fc9f4SBarry Smith */
55180910c330SBarry Smith PetscErrorCode  TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx)
5519325fc9f4SBarry Smith {
5520325fc9f4SBarry Smith   PetscErrorCode  ierr;
5521325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5522325fc9f4SBarry Smith   int             nlhs  = 1,nrhs = 7;
5523325fc9f4SBarry Smith   mxArray         *plhs[1],*prhs[7];
5524325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,ly = 0,ls = 0;
5525325fc9f4SBarry Smith 
5526325fc9f4SBarry Smith   PetscFunctionBegin;
5527325fc9f4SBarry Smith   PetscValidHeaderSpecific(snes,TS_CLASSID,1);
55280910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
55290910c330SBarry Smith   PetscValidHeaderSpecific(udot,VEC_CLASSID,4);
5530325fc9f4SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,5);
55310910c330SBarry Smith   PetscCheckSameComm(snes,1,u,3);
5532325fc9f4SBarry Smith   PetscCheckSameComm(snes,1,y,5);
5533325fc9f4SBarry Smith 
5534325fc9f4SBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
55350910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
55360910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr);
55370910c330SBarry Smith   ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr);
5538bbd56ea5SKarl Rupp 
5539325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
5540325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar(time);
5541325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
5542325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
5543325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)ly);
5544325fc9f4SBarry Smith   prhs[5] =  mxCreateString(sctx->funcname);
5545325fc9f4SBarry Smith   prhs[6] =  sctx->ctx;
5546325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr);
5547325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5548325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
5549325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
5550325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
5551325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
5552325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
5553325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
5554325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
5555325fc9f4SBarry Smith   PetscFunctionReturn(0);
5556325fc9f4SBarry Smith }
5557325fc9f4SBarry Smith 
5558325fc9f4SBarry Smith 
5559325fc9f4SBarry Smith #undef __FUNCT__
5560325fc9f4SBarry Smith #define __FUNCT__ "TSSetFunctionMatlab"
5561325fc9f4SBarry Smith /*
5562325fc9f4SBarry Smith    TSSetFunctionMatlab - Sets the function evaluation routine and function
5563325fc9f4SBarry Smith    vector for use by the TS routines in solving ODEs
5564e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
5565325fc9f4SBarry Smith 
5566325fc9f4SBarry Smith    Logically Collective on TS
5567325fc9f4SBarry Smith 
5568325fc9f4SBarry Smith    Input Parameters:
5569325fc9f4SBarry Smith +  ts - the TS context
5570325fc9f4SBarry Smith -  func - function evaluation routine
5571325fc9f4SBarry Smith 
5572325fc9f4SBarry Smith    Calling sequence of func:
55730910c330SBarry Smith $    func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx);
5574325fc9f4SBarry Smith 
5575325fc9f4SBarry Smith    Level: beginner
5576325fc9f4SBarry Smith 
5577325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
5578325fc9f4SBarry Smith 
5579325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5580325fc9f4SBarry Smith */
5581cdcf91faSSean Farley PetscErrorCode  TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx)
5582325fc9f4SBarry Smith {
5583325fc9f4SBarry Smith   PetscErrorCode  ierr;
5584325fc9f4SBarry Smith   TSMatlabContext *sctx;
5585325fc9f4SBarry Smith 
5586325fc9f4SBarry Smith   PetscFunctionBegin;
5587325fc9f4SBarry Smith   /* currently sctx is memory bleed */
5588325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5589325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5590325fc9f4SBarry Smith   /*
5591325fc9f4SBarry Smith      This should work, but it doesn't
5592325fc9f4SBarry Smith   sctx->ctx = ctx;
5593325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5594325fc9f4SBarry Smith   */
5595325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5596bbd56ea5SKarl Rupp 
55970298fd71SBarry Smith   ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr);
5598325fc9f4SBarry Smith   PetscFunctionReturn(0);
5599325fc9f4SBarry Smith }
5600325fc9f4SBarry Smith 
5601325fc9f4SBarry Smith #undef __FUNCT__
5602325fc9f4SBarry Smith #define __FUNCT__ "TSComputeJacobian_Matlab"
5603325fc9f4SBarry Smith /*
5604325fc9f4SBarry Smith    TSComputeJacobian_Matlab - Calls the function that has been set with
5605325fc9f4SBarry Smith                          TSSetJacobianMatlab().
5606325fc9f4SBarry Smith 
5607325fc9f4SBarry Smith    Collective on TS
5608325fc9f4SBarry Smith 
5609325fc9f4SBarry Smith    Input Parameters:
5610cdcf91faSSean Farley +  ts - the TS context
56110910c330SBarry Smith .  u - input vector
5612325fc9f4SBarry Smith .  A, B - the matrices
5613325fc9f4SBarry Smith -  ctx - user context
5614325fc9f4SBarry Smith 
5615325fc9f4SBarry Smith    Level: developer
5616325fc9f4SBarry Smith 
5617325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
5618325fc9f4SBarry Smith 
5619325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
5620325fc9f4SBarry Smith @*/
5621f3229a78SSatish Balay PetscErrorCode  TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx)
5622325fc9f4SBarry Smith {
5623325fc9f4SBarry Smith   PetscErrorCode  ierr;
5624325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5625325fc9f4SBarry Smith   int             nlhs  = 2,nrhs = 9;
5626325fc9f4SBarry Smith   mxArray         *plhs[2],*prhs[9];
5627325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0;
5628325fc9f4SBarry Smith 
5629325fc9f4SBarry Smith   PetscFunctionBegin;
5630cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
56310910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
5632325fc9f4SBarry Smith 
56330910c330SBarry Smith   /* call Matlab function in ctx with arguments u and y */
5634325fc9f4SBarry Smith 
5635cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
56360910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
56370910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr);
56380910c330SBarry Smith   ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr);
56390910c330SBarry Smith   ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr);
5640bbd56ea5SKarl Rupp 
5641325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
5642325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)time);
5643325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
5644325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
5645325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)shift);
5646325fc9f4SBarry Smith   prhs[5] =  mxCreateDoubleScalar((double)lA);
5647325fc9f4SBarry Smith   prhs[6] =  mxCreateDoubleScalar((double)lB);
5648325fc9f4SBarry Smith   prhs[7] =  mxCreateString(sctx->funcname);
5649325fc9f4SBarry Smith   prhs[8] =  sctx->ctx;
5650325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr);
5651325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5652325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
5653325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
5654325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
5655325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
5656325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
5657325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
5658325fc9f4SBarry Smith   mxDestroyArray(prhs[6]);
5659325fc9f4SBarry Smith   mxDestroyArray(prhs[7]);
5660325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
5661325fc9f4SBarry Smith   mxDestroyArray(plhs[1]);
5662325fc9f4SBarry Smith   PetscFunctionReturn(0);
5663325fc9f4SBarry Smith }
5664325fc9f4SBarry Smith 
5665325fc9f4SBarry Smith 
5666325fc9f4SBarry Smith #undef __FUNCT__
5667325fc9f4SBarry Smith #define __FUNCT__ "TSSetJacobianMatlab"
5668325fc9f4SBarry Smith /*
5669325fc9f4SBarry Smith    TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
5670e3c5b3baSBarry 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
5671325fc9f4SBarry Smith 
5672325fc9f4SBarry Smith    Logically Collective on TS
5673325fc9f4SBarry Smith 
5674325fc9f4SBarry Smith    Input Parameters:
5675cdcf91faSSean Farley +  ts - the TS context
5676325fc9f4SBarry Smith .  A,B - Jacobian matrices
5677325fc9f4SBarry Smith .  func - function evaluation routine
5678325fc9f4SBarry Smith -  ctx - user context
5679325fc9f4SBarry Smith 
5680325fc9f4SBarry Smith    Calling sequence of func:
56810910c330SBarry Smith $    flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx);
5682325fc9f4SBarry Smith 
5683325fc9f4SBarry Smith 
5684325fc9f4SBarry Smith    Level: developer
5685325fc9f4SBarry Smith 
5686325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
5687325fc9f4SBarry Smith 
5688325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5689325fc9f4SBarry Smith */
5690cdcf91faSSean Farley PetscErrorCode  TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx)
5691325fc9f4SBarry Smith {
5692325fc9f4SBarry Smith   PetscErrorCode  ierr;
5693325fc9f4SBarry Smith   TSMatlabContext *sctx;
5694325fc9f4SBarry Smith 
5695325fc9f4SBarry Smith   PetscFunctionBegin;
5696325fc9f4SBarry Smith   /* currently sctx is memory bleed */
5697325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5698325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5699325fc9f4SBarry Smith   /*
5700325fc9f4SBarry Smith      This should work, but it doesn't
5701325fc9f4SBarry Smith   sctx->ctx = ctx;
5702325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5703325fc9f4SBarry Smith   */
5704325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5705bbd56ea5SKarl Rupp 
5706cdcf91faSSean Farley   ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
5707325fc9f4SBarry Smith   PetscFunctionReturn(0);
5708325fc9f4SBarry Smith }
5709325fc9f4SBarry Smith 
5710b5b1a830SBarry Smith #undef __FUNCT__
5711b5b1a830SBarry Smith #define __FUNCT__ "TSMonitor_Matlab"
5712b5b1a830SBarry Smith /*
5713b5b1a830SBarry Smith    TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab().
5714b5b1a830SBarry Smith 
5715b5b1a830SBarry Smith    Collective on TS
5716b5b1a830SBarry Smith 
5717b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
5718b5b1a830SBarry Smith @*/
57190910c330SBarry Smith PetscErrorCode  TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx)
5720b5b1a830SBarry Smith {
5721b5b1a830SBarry Smith   PetscErrorCode  ierr;
5722b5b1a830SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5723a530c242SBarry Smith   int             nlhs  = 1,nrhs = 6;
5724b5b1a830SBarry Smith   mxArray         *plhs[1],*prhs[6];
5725b5b1a830SBarry Smith   long long int   lx = 0,ls = 0;
5726b5b1a830SBarry Smith 
5727b5b1a830SBarry Smith   PetscFunctionBegin;
5728cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
57290910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
5730b5b1a830SBarry Smith 
5731cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
57320910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
5733bbd56ea5SKarl Rupp 
5734b5b1a830SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
5735b5b1a830SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)it);
5736b5b1a830SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)time);
5737b5b1a830SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lx);
5738b5b1a830SBarry Smith   prhs[4] =  mxCreateString(sctx->funcname);
5739b5b1a830SBarry Smith   prhs[5] =  sctx->ctx;
5740b5b1a830SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr);
5741b5b1a830SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5742b5b1a830SBarry Smith   mxDestroyArray(prhs[0]);
5743b5b1a830SBarry Smith   mxDestroyArray(prhs[1]);
5744b5b1a830SBarry Smith   mxDestroyArray(prhs[2]);
5745b5b1a830SBarry Smith   mxDestroyArray(prhs[3]);
5746b5b1a830SBarry Smith   mxDestroyArray(prhs[4]);
5747b5b1a830SBarry Smith   mxDestroyArray(plhs[0]);
5748b5b1a830SBarry Smith   PetscFunctionReturn(0);
5749b5b1a830SBarry Smith }
5750b5b1a830SBarry Smith 
5751b5b1a830SBarry Smith 
5752b5b1a830SBarry Smith #undef __FUNCT__
5753b5b1a830SBarry Smith #define __FUNCT__ "TSMonitorSetMatlab"
5754b5b1a830SBarry Smith /*
5755b5b1a830SBarry Smith    TSMonitorSetMatlab - Sets the monitor function from Matlab
5756b5b1a830SBarry Smith 
5757b5b1a830SBarry Smith    Level: developer
5758b5b1a830SBarry Smith 
5759b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function
5760b5b1a830SBarry Smith 
5761b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5762b5b1a830SBarry Smith */
5763cdcf91faSSean Farley PetscErrorCode  TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx)
5764b5b1a830SBarry Smith {
5765b5b1a830SBarry Smith   PetscErrorCode  ierr;
5766b5b1a830SBarry Smith   TSMatlabContext *sctx;
5767b5b1a830SBarry Smith 
5768b5b1a830SBarry Smith   PetscFunctionBegin;
5769b5b1a830SBarry Smith   /* currently sctx is memory bleed */
5770b5b1a830SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5771b5b1a830SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5772b5b1a830SBarry Smith   /*
5773b5b1a830SBarry Smith      This should work, but it doesn't
5774b5b1a830SBarry Smith   sctx->ctx = ctx;
5775b5b1a830SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5776b5b1a830SBarry Smith   */
5777b5b1a830SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5778bbd56ea5SKarl Rupp 
57790298fd71SBarry Smith   ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr);
5780b5b1a830SBarry Smith   PetscFunctionReturn(0);
5781b5b1a830SBarry Smith }
5782325fc9f4SBarry Smith #endif
5783b3603a34SBarry Smith 
5784b3603a34SBarry Smith #undef __FUNCT__
57854f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGSolution"
5786b3603a34SBarry Smith /*@C
57874f09c107SBarry Smith    TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector
5788b3603a34SBarry Smith        in a time based line graph
5789b3603a34SBarry Smith 
5790b3603a34SBarry Smith    Collective on TS
5791b3603a34SBarry Smith 
5792b3603a34SBarry Smith    Input Parameters:
5793b3603a34SBarry Smith +  ts - the TS context
5794b3603a34SBarry Smith .  step - current time-step
5795b3603a34SBarry Smith .  ptime - current time
57967db568b7SBarry Smith .  u - current solution
57977db568b7SBarry Smith -  dctx - the TSMonitorLGCtx object that contains all the options for the monitoring, this is created with TSMonitorLGCtxCreate()
5798b3603a34SBarry Smith 
5799b3d3934dSBarry Smith    Options Database:
58009ae14b6eSBarry Smith .   -ts_monitor_lg_solution_variables
5801b3d3934dSBarry Smith 
5802b3603a34SBarry Smith    Level: intermediate
5803b3603a34SBarry Smith 
58040b039ecaSBarry Smith     Notes: each process in a parallel run displays its component solutions in a separate window
5805b3603a34SBarry Smith 
5806b3603a34SBarry Smith .keywords: TS,  vector, monitor, view
5807b3603a34SBarry Smith 
58087db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
58097db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
58107db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
58117db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
5812b3603a34SBarry Smith @*/
58137db568b7SBarry Smith PetscErrorCode  TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
5814b3603a34SBarry Smith {
5815b3603a34SBarry Smith   PetscErrorCode    ierr;
58167db568b7SBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dctx;
5817b3603a34SBarry Smith   const PetscScalar *yy;
581858ff32f7SBarry Smith   PetscInt          dim;
581980666b62SBarry Smith   Vec               v;
5820b3603a34SBarry Smith 
5821b3603a34SBarry Smith   PetscFunctionBegin;
582258ff32f7SBarry Smith   if (!step) {
5823a9f9c1f6SBarry Smith     PetscDrawAxis axis;
5824a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
5825a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr);
5826387f4636SBarry Smith     if (ctx->names && !ctx->displaynames) {
5827387f4636SBarry Smith       char      **displaynames;
5828387f4636SBarry Smith       PetscBool flg;
5829387f4636SBarry Smith 
5830387f4636SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
5831387f4636SBarry Smith       ierr = PetscMalloc((dim+1)*sizeof(char*),&displaynames);CHKERRQ(ierr);
5832387f4636SBarry Smith       ierr = PetscMemzero(displaynames,(dim+1)*sizeof(char*));CHKERRQ(ierr);
58339ae14b6eSBarry Smith       ierr = PetscOptionsGetStringArray(((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);CHKERRQ(ierr);
5834387f4636SBarry Smith       if (flg) {
5835a66092f1SBarry Smith         ierr = TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);CHKERRQ(ierr);
5836387f4636SBarry Smith       }
5837387f4636SBarry Smith       ierr = PetscStrArrayDestroy(&displaynames);CHKERRQ(ierr);
5838387f4636SBarry Smith     }
5839387f4636SBarry Smith     if (ctx->displaynames) {
5840387f4636SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);CHKERRQ(ierr);
5841387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);CHKERRQ(ierr);
5842387f4636SBarry Smith     } else if (ctx->names) {
58430910c330SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
58440b039ecaSBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
5845387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);CHKERRQ(ierr);
5846387f4636SBarry Smith     }
58470b039ecaSBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
584858ff32f7SBarry Smith   }
584980666b62SBarry Smith   if (ctx->transform) {
5850e673d494SBarry Smith     ierr = (*ctx->transform)(ctx->transformctx,u,&v);CHKERRQ(ierr);
585180666b62SBarry Smith   } else {
585280666b62SBarry Smith     v = u;
585380666b62SBarry Smith   }
585480666b62SBarry Smith   ierr = VecGetArrayRead(v,&yy);CHKERRQ(ierr);
5855e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
5856e3efe391SJed Brown   {
5857e3efe391SJed Brown     PetscReal *yreal;
5858e3efe391SJed Brown     PetscInt  i,n;
585980666b62SBarry Smith     ierr = VecGetLocalSize(v,&n);CHKERRQ(ierr);
5860785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
5861e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
58620b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
5863e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
5864e3efe391SJed Brown   }
5865e3efe391SJed Brown #else
5866387f4636SBarry Smith   if (ctx->displaynames) {
5867387f4636SBarry Smith     PetscInt i;
5868387f4636SBarry Smith     for (i=0; i<ctx->ndisplayvariables; i++) {
5869387f4636SBarry Smith       ctx->displayvalues[i] = yy[ctx->displayvariables[i]];
5870387f4636SBarry Smith     }
5871387f4636SBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);CHKERRQ(ierr);
5872387f4636SBarry Smith   } else {
58730b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
5874387f4636SBarry Smith   }
5875e3efe391SJed Brown #endif
587680666b62SBarry Smith   ierr = VecRestoreArrayRead(v,&yy);CHKERRQ(ierr);
587780666b62SBarry Smith   if (ctx->transform) {
587880666b62SBarry Smith     ierr = VecDestroy(&v);CHKERRQ(ierr);
587980666b62SBarry Smith   }
5880b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
58810b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
58823923b477SBarry Smith   }
5883b3603a34SBarry Smith   PetscFunctionReturn(0);
5884b3603a34SBarry Smith }
5885b3603a34SBarry Smith 
5886387f4636SBarry Smith 
5887b3603a34SBarry Smith #undef __FUNCT__
588831152f8aSBarry Smith #define __FUNCT__ "TSMonitorLGSetVariableNames"
5889b037adc7SBarry Smith /*@C
589031152f8aSBarry Smith    TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
5891b037adc7SBarry Smith 
5892b037adc7SBarry Smith    Collective on TS
5893b037adc7SBarry Smith 
5894b037adc7SBarry Smith    Input Parameters:
5895b037adc7SBarry Smith +  ts - the TS context
5896b3d3934dSBarry Smith -  names - the names of the components, final string must be NULL
5897b037adc7SBarry Smith 
5898b037adc7SBarry Smith    Level: intermediate
5899b037adc7SBarry Smith 
59007db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
59017db568b7SBarry Smith 
5902b037adc7SBarry Smith .keywords: TS,  vector, monitor, view
5903b037adc7SBarry Smith 
5904a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames()
5905b037adc7SBarry Smith @*/
590631152f8aSBarry Smith PetscErrorCode  TSMonitorLGSetVariableNames(TS ts,const char * const *names)
5907b037adc7SBarry Smith {
5908b037adc7SBarry Smith   PetscErrorCode    ierr;
5909b037adc7SBarry Smith   PetscInt          i;
5910b037adc7SBarry Smith 
5911b037adc7SBarry Smith   PetscFunctionBegin;
5912b037adc7SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
5913b037adc7SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
59145537e223SBarry Smith       ierr = TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);CHKERRQ(ierr);
5915b3d3934dSBarry Smith       break;
5916b3d3934dSBarry Smith     }
5917b3d3934dSBarry Smith   }
5918b3d3934dSBarry Smith   PetscFunctionReturn(0);
5919b3d3934dSBarry Smith }
5920b3d3934dSBarry Smith 
5921b3d3934dSBarry Smith #undef __FUNCT__
5922e673d494SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetVariableNames"
5923e673d494SBarry Smith /*@C
5924e673d494SBarry Smith    TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
5925e673d494SBarry Smith 
5926e673d494SBarry Smith    Collective on TS
5927e673d494SBarry Smith 
5928e673d494SBarry Smith    Input Parameters:
5929e673d494SBarry Smith +  ts - the TS context
5930e673d494SBarry Smith -  names - the names of the components, final string must be NULL
5931e673d494SBarry Smith 
5932e673d494SBarry Smith    Level: intermediate
5933e673d494SBarry Smith 
5934e673d494SBarry Smith .keywords: TS,  vector, monitor, view
5935e673d494SBarry Smith 
5936a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames()
5937e673d494SBarry Smith @*/
5938e673d494SBarry Smith PetscErrorCode  TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names)
5939e673d494SBarry Smith {
5940e673d494SBarry Smith   PetscErrorCode    ierr;
5941e673d494SBarry Smith 
5942e673d494SBarry Smith   PetscFunctionBegin;
5943e673d494SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr);
5944e673d494SBarry Smith   ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr);
5945e673d494SBarry Smith   PetscFunctionReturn(0);
5946e673d494SBarry Smith }
5947e673d494SBarry Smith 
5948e673d494SBarry Smith #undef __FUNCT__
5949b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorLGGetVariableNames"
5950b3d3934dSBarry Smith /*@C
5951b3d3934dSBarry Smith    TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot
5952b3d3934dSBarry Smith 
5953b3d3934dSBarry Smith    Collective on TS
5954b3d3934dSBarry Smith 
5955b3d3934dSBarry Smith    Input Parameter:
5956b3d3934dSBarry Smith .  ts - the TS context
5957b3d3934dSBarry Smith 
5958b3d3934dSBarry Smith    Output Parameter:
5959b3d3934dSBarry Smith .  names - the names of the components, final string must be NULL
5960b3d3934dSBarry Smith 
5961b3d3934dSBarry Smith    Level: intermediate
5962b3d3934dSBarry Smith 
59637db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
59647db568b7SBarry Smith 
5965b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
5966b3d3934dSBarry Smith 
5967b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
5968b3d3934dSBarry Smith @*/
5969b3d3934dSBarry Smith PetscErrorCode  TSMonitorLGGetVariableNames(TS ts,const char *const **names)
5970b3d3934dSBarry Smith {
5971b3d3934dSBarry Smith   PetscInt       i;
5972b3d3934dSBarry Smith 
5973b3d3934dSBarry Smith   PetscFunctionBegin;
5974b3d3934dSBarry Smith   *names = NULL;
5975b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
5976b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
59775537e223SBarry Smith       TSMonitorLGCtx  ctx = (TSMonitorLGCtx) ts->monitorcontext[i];
5978b3d3934dSBarry Smith       *names = (const char *const *)ctx->names;
5979b3d3934dSBarry Smith       break;
5980387f4636SBarry Smith     }
5981387f4636SBarry Smith   }
5982387f4636SBarry Smith   PetscFunctionReturn(0);
5983387f4636SBarry Smith }
5984387f4636SBarry Smith 
5985387f4636SBarry Smith #undef __FUNCT__
5986a66092f1SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetDisplayVariables"
5987a66092f1SBarry Smith /*@C
5988a66092f1SBarry Smith    TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor
5989a66092f1SBarry Smith 
5990a66092f1SBarry Smith    Collective on TS
5991a66092f1SBarry Smith 
5992a66092f1SBarry Smith    Input Parameters:
5993a66092f1SBarry Smith +  ctx - the TSMonitorLG context
5994a66092f1SBarry Smith .  displaynames - the names of the components, final string must be NULL
5995a66092f1SBarry Smith 
5996a66092f1SBarry Smith    Level: intermediate
5997a66092f1SBarry Smith 
5998a66092f1SBarry Smith .keywords: TS,  vector, monitor, view
5999a66092f1SBarry Smith 
6000a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
6001a66092f1SBarry Smith @*/
6002a66092f1SBarry Smith PetscErrorCode  TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames)
6003a66092f1SBarry Smith {
6004a66092f1SBarry Smith   PetscInt          j = 0,k;
6005a66092f1SBarry Smith   PetscErrorCode    ierr;
6006a66092f1SBarry Smith 
6007a66092f1SBarry Smith   PetscFunctionBegin;
6008a66092f1SBarry Smith   if (!ctx->names) PetscFunctionReturn(0);
6009a66092f1SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->displaynames);CHKERRQ(ierr);
6010a66092f1SBarry Smith   ierr = PetscStrArrayallocpy(displaynames,&ctx->displaynames);CHKERRQ(ierr);
6011a66092f1SBarry Smith   while (displaynames[j]) j++;
6012a66092f1SBarry Smith   ctx->ndisplayvariables = j;
6013a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);CHKERRQ(ierr);
6014a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);CHKERRQ(ierr);
6015a66092f1SBarry Smith   j = 0;
6016a66092f1SBarry Smith   while (displaynames[j]) {
6017a66092f1SBarry Smith     k = 0;
6018a66092f1SBarry Smith     while (ctx->names[k]) {
6019a66092f1SBarry Smith       PetscBool flg;
6020a66092f1SBarry Smith       ierr = PetscStrcmp(displaynames[j],ctx->names[k],&flg);CHKERRQ(ierr);
6021a66092f1SBarry Smith       if (flg) {
6022a66092f1SBarry Smith         ctx->displayvariables[j] = k;
6023a66092f1SBarry Smith         break;
6024a66092f1SBarry Smith       }
6025a66092f1SBarry Smith       k++;
6026a66092f1SBarry Smith     }
6027a66092f1SBarry Smith     j++;
6028a66092f1SBarry Smith   }
6029a66092f1SBarry Smith   PetscFunctionReturn(0);
6030a66092f1SBarry Smith }
6031a66092f1SBarry Smith 
6032a66092f1SBarry Smith 
6033a66092f1SBarry Smith #undef __FUNCT__
6034387f4636SBarry Smith #define __FUNCT__ "TSMonitorLGSetDisplayVariables"
6035387f4636SBarry Smith /*@C
6036387f4636SBarry Smith    TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor
6037387f4636SBarry Smith 
6038387f4636SBarry Smith    Collective on TS
6039387f4636SBarry Smith 
6040387f4636SBarry Smith    Input Parameters:
6041387f4636SBarry Smith +  ts - the TS context
6042387f4636SBarry Smith .  displaynames - the names of the components, final string must be NULL
6043387f4636SBarry Smith 
60447db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
60457db568b7SBarry Smith 
6046387f4636SBarry Smith    Level: intermediate
6047387f4636SBarry Smith 
6048387f4636SBarry Smith .keywords: TS,  vector, monitor, view
6049387f4636SBarry Smith 
6050387f4636SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
6051387f4636SBarry Smith @*/
6052387f4636SBarry Smith PetscErrorCode  TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames)
6053387f4636SBarry Smith {
6054a66092f1SBarry Smith   PetscInt          i;
6055387f4636SBarry Smith   PetscErrorCode    ierr;
6056387f4636SBarry Smith 
6057387f4636SBarry Smith   PetscFunctionBegin;
6058387f4636SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6059387f4636SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
60605537e223SBarry Smith       ierr = TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);CHKERRQ(ierr);
6061b3d3934dSBarry Smith       break;
6062b037adc7SBarry Smith     }
6063b037adc7SBarry Smith   }
6064b037adc7SBarry Smith   PetscFunctionReturn(0);
6065b037adc7SBarry Smith }
6066b037adc7SBarry Smith 
6067b037adc7SBarry Smith #undef __FUNCT__
606880666b62SBarry Smith #define __FUNCT__ "TSMonitorLGSetTransform"
606980666b62SBarry Smith /*@C
607080666b62SBarry Smith    TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed
607180666b62SBarry Smith 
607280666b62SBarry Smith    Collective on TS
607380666b62SBarry Smith 
607480666b62SBarry Smith    Input Parameters:
607580666b62SBarry Smith +  ts - the TS context
607680666b62SBarry Smith .  transform - the transform function
60777684fa3eSBarry Smith .  destroy - function to destroy the optional context
607880666b62SBarry Smith -  ctx - optional context used by transform function
607980666b62SBarry Smith 
60807db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
60817db568b7SBarry Smith 
608280666b62SBarry Smith    Level: intermediate
608380666b62SBarry Smith 
608480666b62SBarry Smith .keywords: TS,  vector, monitor, view
608580666b62SBarry Smith 
6086a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform()
608780666b62SBarry Smith @*/
60887684fa3eSBarry Smith PetscErrorCode  TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
608980666b62SBarry Smith {
609080666b62SBarry Smith   PetscInt          i;
6091a66092f1SBarry Smith   PetscErrorCode    ierr;
609280666b62SBarry Smith 
609380666b62SBarry Smith   PetscFunctionBegin;
609480666b62SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
609580666b62SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
60965537e223SBarry Smith       ierr = TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);CHKERRQ(ierr);
609780666b62SBarry Smith     }
609880666b62SBarry Smith   }
609980666b62SBarry Smith   PetscFunctionReturn(0);
610080666b62SBarry Smith }
610180666b62SBarry Smith 
610280666b62SBarry Smith #undef __FUNCT__
6103e673d494SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetTransform"
6104e673d494SBarry Smith /*@C
6105e673d494SBarry Smith    TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed
6106e673d494SBarry Smith 
6107e673d494SBarry Smith    Collective on TSLGCtx
6108e673d494SBarry Smith 
6109e673d494SBarry Smith    Input Parameters:
6110e673d494SBarry Smith +  ts - the TS context
6111e673d494SBarry Smith .  transform - the transform function
61127684fa3eSBarry Smith .  destroy - function to destroy the optional context
6113e673d494SBarry Smith -  ctx - optional context used by transform function
6114e673d494SBarry Smith 
6115e673d494SBarry Smith    Level: intermediate
6116e673d494SBarry Smith 
6117e673d494SBarry Smith .keywords: TS,  vector, monitor, view
6118e673d494SBarry Smith 
6119a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform()
6120e673d494SBarry Smith @*/
61217684fa3eSBarry Smith PetscErrorCode  TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
6122e673d494SBarry Smith {
6123e673d494SBarry Smith   PetscFunctionBegin;
6124e673d494SBarry Smith   ctx->transform    = transform;
61257684fa3eSBarry Smith   ctx->transformdestroy = destroy;
6126e673d494SBarry Smith   ctx->transformctx = tctx;
6127e673d494SBarry Smith   PetscFunctionReturn(0);
6128e673d494SBarry Smith }
6129e673d494SBarry Smith 
6130b3603a34SBarry Smith #undef __FUNCT__
61314f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGError"
6132ef20d060SBarry Smith /*@C
61334f09c107SBarry Smith    TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector
6134ef20d060SBarry Smith        in a time based line graph
6135ef20d060SBarry Smith 
6136ef20d060SBarry Smith    Collective on TS
6137ef20d060SBarry Smith 
6138ef20d060SBarry Smith    Input Parameters:
6139ef20d060SBarry Smith +  ts - the TS context
6140ef20d060SBarry Smith .  step - current time-step
6141ef20d060SBarry Smith .  ptime - current time
61427db568b7SBarry Smith .  u - current solution
61437db568b7SBarry Smith -  dctx - TSMonitorLGCtx object created with TSMonitorLGCtxCreate()
6144ef20d060SBarry Smith 
6145ef20d060SBarry Smith    Level: intermediate
6146ef20d060SBarry Smith 
6147abd5a294SJed Brown    Notes:
6148abd5a294SJed Brown    Only for sequential solves.
6149abd5a294SJed Brown 
6150abd5a294SJed Brown    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
6151abd5a294SJed Brown 
6152abd5a294SJed Brown    Options Database Keys:
61534f09c107SBarry Smith .  -ts_monitor_lg_error - create a graphical monitor of error history
6154ef20d060SBarry Smith 
6155ef20d060SBarry Smith .keywords: TS,  vector, monitor, view
6156ef20d060SBarry Smith 
6157abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
6158ef20d060SBarry Smith @*/
61590910c330SBarry Smith PetscErrorCode  TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
6160ef20d060SBarry Smith {
6161ef20d060SBarry Smith   PetscErrorCode    ierr;
61620b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
6163ef20d060SBarry Smith   const PetscScalar *yy;
6164ef20d060SBarry Smith   Vec               y;
6165a9f9c1f6SBarry Smith   PetscInt          dim;
6166ef20d060SBarry Smith 
6167ef20d060SBarry Smith   PetscFunctionBegin;
6168a9f9c1f6SBarry Smith   if (!step) {
6169a9f9c1f6SBarry Smith     PetscDrawAxis axis;
6170a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
61711ae185eaSBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr);
61720910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
6173a9f9c1f6SBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6174a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6175a9f9c1f6SBarry Smith   }
61760910c330SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
6177ef20d060SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
61780910c330SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
6179ef20d060SBarry Smith   ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr);
6180e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
6181e3efe391SJed Brown   {
6182e3efe391SJed Brown     PetscReal *yreal;
6183e3efe391SJed Brown     PetscInt  i,n;
6184e3efe391SJed Brown     ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr);
6185785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
6186e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
61870b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
6188e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
6189e3efe391SJed Brown   }
6190e3efe391SJed Brown #else
61910b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
6192e3efe391SJed Brown #endif
6193ef20d060SBarry Smith   ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr);
6194ef20d060SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
6195b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
61960b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
61973923b477SBarry Smith   }
6198ef20d060SBarry Smith   PetscFunctionReturn(0);
6199ef20d060SBarry Smith }
6200ef20d060SBarry Smith 
6201201da799SBarry Smith #undef __FUNCT__
6202201da799SBarry Smith #define __FUNCT__ "TSMonitorLGSNESIterations"
6203201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
6204201da799SBarry Smith {
6205201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
6206201da799SBarry Smith   PetscReal      x   = ptime,y;
6207201da799SBarry Smith   PetscErrorCode ierr;
6208201da799SBarry Smith   PetscInt       its;
6209201da799SBarry Smith 
6210201da799SBarry Smith   PetscFunctionBegin;
6211201da799SBarry Smith   if (!n) {
6212201da799SBarry Smith     PetscDrawAxis axis;
6213bbd56ea5SKarl Rupp 
6214201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
6215201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr);
6216201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6217bbd56ea5SKarl Rupp 
6218201da799SBarry Smith     ctx->snes_its = 0;
6219201da799SBarry Smith   }
6220201da799SBarry Smith   ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr);
6221201da799SBarry Smith   y    = its - ctx->snes_its;
6222201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
62233fbbecb0SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
6224201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
6225201da799SBarry Smith   }
6226201da799SBarry Smith   ctx->snes_its = its;
6227201da799SBarry Smith   PetscFunctionReturn(0);
6228201da799SBarry Smith }
6229201da799SBarry Smith 
6230201da799SBarry Smith #undef __FUNCT__
6231201da799SBarry Smith #define __FUNCT__ "TSMonitorLGKSPIterations"
6232201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
6233201da799SBarry Smith {
6234201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
6235201da799SBarry Smith   PetscReal      x   = ptime,y;
6236201da799SBarry Smith   PetscErrorCode ierr;
6237201da799SBarry Smith   PetscInt       its;
6238201da799SBarry Smith 
6239201da799SBarry Smith   PetscFunctionBegin;
6240201da799SBarry Smith   if (!n) {
6241201da799SBarry Smith     PetscDrawAxis axis;
6242bbd56ea5SKarl Rupp 
6243201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
6244201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr);
6245201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6246bbd56ea5SKarl Rupp 
6247201da799SBarry Smith     ctx->ksp_its = 0;
6248201da799SBarry Smith   }
6249201da799SBarry Smith   ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr);
6250201da799SBarry Smith   y    = its - ctx->ksp_its;
6251201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
625299fdda47SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
6253201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
6254201da799SBarry Smith   }
6255201da799SBarry Smith   ctx->ksp_its = its;
6256201da799SBarry Smith   PetscFunctionReturn(0);
6257201da799SBarry Smith }
6258f9c1d6abSBarry Smith 
6259f9c1d6abSBarry Smith #undef __FUNCT__
6260f9c1d6abSBarry Smith #define __FUNCT__ "TSComputeLinearStability"
6261f9c1d6abSBarry Smith /*@
6262f9c1d6abSBarry Smith    TSComputeLinearStability - computes the linear stability function at a point
6263f9c1d6abSBarry Smith 
6264f9c1d6abSBarry Smith    Collective on TS and Vec
6265f9c1d6abSBarry Smith 
6266f9c1d6abSBarry Smith    Input Parameters:
6267f9c1d6abSBarry Smith +  ts - the TS context
6268f9c1d6abSBarry Smith -  xr,xi - real and imaginary part of input arguments
6269f9c1d6abSBarry Smith 
6270f9c1d6abSBarry Smith    Output Parameters:
6271f9c1d6abSBarry Smith .  yr,yi - real and imaginary part of function value
6272f9c1d6abSBarry Smith 
6273f9c1d6abSBarry Smith    Level: developer
6274f9c1d6abSBarry Smith 
6275f9c1d6abSBarry Smith .keywords: TS, compute
6276f9c1d6abSBarry Smith 
6277f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction()
6278f9c1d6abSBarry Smith @*/
6279f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi)
6280f9c1d6abSBarry Smith {
6281f9c1d6abSBarry Smith   PetscErrorCode ierr;
6282f9c1d6abSBarry Smith 
6283f9c1d6abSBarry Smith   PetscFunctionBegin;
6284f9c1d6abSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6285ce94432eSBarry Smith   if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method");
6286f9c1d6abSBarry Smith   ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr);
6287f9c1d6abSBarry Smith   PetscFunctionReturn(0);
6288f9c1d6abSBarry Smith }
628924655328SShri 
6290b3d3934dSBarry Smith /* ------------------------------------------------------------------------*/
6291b3d3934dSBarry Smith #undef __FUNCT__
6292b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeCtxCreate"
6293b3d3934dSBarry Smith /*@C
6294b3d3934dSBarry Smith    TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope()
6295b3d3934dSBarry Smith 
6296b3d3934dSBarry Smith    Collective on TS
6297b3d3934dSBarry Smith 
6298b3d3934dSBarry Smith    Input Parameters:
6299b3d3934dSBarry Smith .  ts  - the ODE solver object
6300b3d3934dSBarry Smith 
6301b3d3934dSBarry Smith    Output Parameter:
6302b3d3934dSBarry Smith .  ctx - the context
6303b3d3934dSBarry Smith 
6304b3d3934dSBarry Smith    Level: intermediate
6305b3d3934dSBarry Smith 
6306b3d3934dSBarry Smith .keywords: TS, monitor, line graph, residual, seealso
6307b3d3934dSBarry Smith 
6308b3d3934dSBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
6309b3d3934dSBarry Smith 
6310b3d3934dSBarry Smith @*/
6311b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx)
6312b3d3934dSBarry Smith {
6313b3d3934dSBarry Smith   PetscErrorCode ierr;
6314b3d3934dSBarry Smith 
6315b3d3934dSBarry Smith   PetscFunctionBegin;
6316a74656a8SBarry Smith   ierr = PetscNew(ctx);CHKERRQ(ierr);
6317b3d3934dSBarry Smith   PetscFunctionReturn(0);
6318b3d3934dSBarry Smith }
6319b3d3934dSBarry Smith 
6320b3d3934dSBarry Smith #undef __FUNCT__
6321b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelope"
6322b3d3934dSBarry Smith /*@C
6323b3d3934dSBarry Smith    TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution
6324b3d3934dSBarry Smith 
6325b3d3934dSBarry Smith    Collective on TS
6326b3d3934dSBarry Smith 
6327b3d3934dSBarry Smith    Input Parameters:
6328b3d3934dSBarry Smith +  ts - the TS context
6329b3d3934dSBarry Smith .  step - current time-step
6330b3d3934dSBarry Smith .  ptime - current time
63317db568b7SBarry Smith .  u  - current solution
63327db568b7SBarry Smith -  dctx - the envelope context
6333b3d3934dSBarry Smith 
6334b3d3934dSBarry Smith    Options Database:
6335b3d3934dSBarry Smith .  -ts_monitor_envelope
6336b3d3934dSBarry Smith 
6337b3d3934dSBarry Smith    Level: intermediate
6338b3d3934dSBarry Smith 
6339b3d3934dSBarry Smith    Notes: after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope
6340b3d3934dSBarry Smith 
6341b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
6342b3d3934dSBarry Smith 
63437db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxCreate()
6344b3d3934dSBarry Smith @*/
63457db568b7SBarry Smith PetscErrorCode  TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
6346b3d3934dSBarry Smith {
6347b3d3934dSBarry Smith   PetscErrorCode       ierr;
63487db568b7SBarry Smith   TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dctx;
6349b3d3934dSBarry Smith 
6350b3d3934dSBarry Smith   PetscFunctionBegin;
6351b3d3934dSBarry Smith   if (!ctx->max) {
6352b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->max);CHKERRQ(ierr);
6353b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->min);CHKERRQ(ierr);
6354b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->max);CHKERRQ(ierr);
6355b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->min);CHKERRQ(ierr);
6356b3d3934dSBarry Smith   } else {
6357b3d3934dSBarry Smith     ierr = VecPointwiseMax(ctx->max,u,ctx->max);CHKERRQ(ierr);
6358b3d3934dSBarry Smith     ierr = VecPointwiseMin(ctx->min,u,ctx->min);CHKERRQ(ierr);
6359b3d3934dSBarry Smith   }
6360b3d3934dSBarry Smith   PetscFunctionReturn(0);
6361b3d3934dSBarry Smith }
6362b3d3934dSBarry Smith 
6363b3d3934dSBarry Smith 
6364b3d3934dSBarry Smith #undef __FUNCT__
6365b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeGetBounds"
6366b3d3934dSBarry Smith /*@C
6367b3d3934dSBarry Smith    TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution
6368b3d3934dSBarry Smith 
6369b3d3934dSBarry Smith    Collective on TS
6370b3d3934dSBarry Smith 
6371b3d3934dSBarry Smith    Input Parameter:
6372b3d3934dSBarry Smith .  ts - the TS context
6373b3d3934dSBarry Smith 
6374b3d3934dSBarry Smith    Output Parameter:
6375b3d3934dSBarry Smith +  max - the maximum values
6376b3d3934dSBarry Smith -  min - the minimum values
6377b3d3934dSBarry Smith 
63787db568b7SBarry Smith    Notes: If the TS does not have a TSMonitorEnvelopeCtx associated with it then this function is ignored
63797db568b7SBarry Smith 
6380b3d3934dSBarry Smith    Level: intermediate
6381b3d3934dSBarry Smith 
6382b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
6383b3d3934dSBarry Smith 
6384b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
6385b3d3934dSBarry Smith @*/
6386b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min)
6387b3d3934dSBarry Smith {
6388b3d3934dSBarry Smith   PetscInt i;
6389b3d3934dSBarry Smith 
6390b3d3934dSBarry Smith   PetscFunctionBegin;
6391b3d3934dSBarry Smith   if (max) *max = NULL;
6392b3d3934dSBarry Smith   if (min) *min = NULL;
6393b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6394b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorEnvelope) {
63955537e223SBarry Smith       TSMonitorEnvelopeCtx  ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i];
6396b3d3934dSBarry Smith       if (max) *max = ctx->max;
6397b3d3934dSBarry Smith       if (min) *min = ctx->min;
6398b3d3934dSBarry Smith       break;
6399b3d3934dSBarry Smith     }
6400b3d3934dSBarry Smith   }
6401b3d3934dSBarry Smith   PetscFunctionReturn(0);
6402b3d3934dSBarry Smith }
6403b3d3934dSBarry Smith 
6404b3d3934dSBarry Smith #undef __FUNCT__
6405b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeCtxDestroy"
6406b3d3934dSBarry Smith /*@C
6407b3d3934dSBarry Smith    TSMonitorEnvelopeCtxDestroy - Destroys a context that was created  with TSMonitorEnvelopeCtxCreate().
6408b3d3934dSBarry Smith 
6409b3d3934dSBarry Smith    Collective on TSMonitorEnvelopeCtx
6410b3d3934dSBarry Smith 
6411b3d3934dSBarry Smith    Input Parameter:
6412b3d3934dSBarry Smith .  ctx - the monitor context
6413b3d3934dSBarry Smith 
6414b3d3934dSBarry Smith    Level: intermediate
6415b3d3934dSBarry Smith 
6416b3d3934dSBarry Smith .keywords: TS, monitor, line graph, destroy
6417b3d3934dSBarry Smith 
64187db568b7SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep()
6419b3d3934dSBarry Smith @*/
6420b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx)
6421b3d3934dSBarry Smith {
6422b3d3934dSBarry Smith   PetscErrorCode ierr;
6423b3d3934dSBarry Smith 
6424b3d3934dSBarry Smith   PetscFunctionBegin;
6425b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->min);CHKERRQ(ierr);
6426b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->max);CHKERRQ(ierr);
6427b3d3934dSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
6428b3d3934dSBarry Smith   PetscFunctionReturn(0);
6429b3d3934dSBarry Smith }
6430f2dee214SBarry Smith 
643124655328SShri #undef __FUNCT__
643224655328SShri #define __FUNCT__ "TSRollBack"
643324655328SShri /*@
643424655328SShri    TSRollBack - Rolls back one time step
643524655328SShri 
643624655328SShri    Collective on TS
643724655328SShri 
643824655328SShri    Input Parameter:
643924655328SShri .  ts - the TS context obtained from TSCreate()
644024655328SShri 
644124655328SShri    Level: advanced
644224655328SShri 
644324655328SShri .keywords: TS, timestep, rollback
644424655328SShri 
644524655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate()
644624655328SShri @*/
644724655328SShri PetscErrorCode  TSRollBack(TS ts)
644824655328SShri {
644924655328SShri   PetscErrorCode ierr;
645024655328SShri 
645124655328SShri   PetscFunctionBegin;
645224655328SShri   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
645324655328SShri 
645424655328SShri   if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name);
645524655328SShri   ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr);
645624655328SShri   ts->time_step = ts->ptime - ts->ptime_prev;
645724655328SShri   ts->ptime = ts->ptime_prev;
64588392e04aSShri Abhyankar   ts->steprollback = PETSC_TRUE; /* Flag to indicate that the step is rollbacked */
645924655328SShri   PetscFunctionReturn(0);
646024655328SShri }
6461aeb4809dSShri Abhyankar 
6462ff22ae23SHong Zhang #undef __FUNCT__
6463ff22ae23SHong Zhang #define __FUNCT__ "TSGetStages"
6464ff22ae23SHong Zhang /*@
6465ff22ae23SHong Zhang    TSGetStages - Get the number of stages and stage values
6466ff22ae23SHong Zhang 
6467ff22ae23SHong Zhang    Input Parameter:
6468ff22ae23SHong Zhang .  ts - the TS context obtained from TSCreate()
6469ff22ae23SHong Zhang 
6470ff22ae23SHong Zhang    Level: advanced
6471ff22ae23SHong Zhang 
6472ff22ae23SHong Zhang .keywords: TS, getstages
6473ff22ae23SHong Zhang 
6474ff22ae23SHong Zhang .seealso: TSCreate()
6475ff22ae23SHong Zhang @*/
6476ff22ae23SHong Zhang PetscErrorCode  TSGetStages(TS ts,PetscInt *ns, Vec **Y)
6477ff22ae23SHong Zhang {
6478ff22ae23SHong Zhang   PetscErrorCode ierr;
6479ff22ae23SHong Zhang 
6480ff22ae23SHong Zhang   PetscFunctionBegin;
6481ff22ae23SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
6482ff22ae23SHong Zhang   PetscValidPointer(ns,2);
6483ff22ae23SHong Zhang 
6484ff22ae23SHong Zhang   if (!ts->ops->getstages) *ns=0;
6485ff22ae23SHong Zhang   else {
6486ff22ae23SHong Zhang     ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr);
6487ff22ae23SHong Zhang   }
6488ff22ae23SHong Zhang   PetscFunctionReturn(0);
6489ff22ae23SHong Zhang }
6490ff22ae23SHong Zhang 
6491847ff0e1SMatthew G. Knepley #undef __FUNCT__
6492847ff0e1SMatthew G. Knepley #define __FUNCT__ "TSComputeIJacobianDefaultColor"
6493847ff0e1SMatthew G. Knepley /*@C
6494847ff0e1SMatthew G. Knepley   TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity.
6495847ff0e1SMatthew G. Knepley 
6496847ff0e1SMatthew G. Knepley   Collective on SNES
6497847ff0e1SMatthew G. Knepley 
6498847ff0e1SMatthew G. Knepley   Input Parameters:
6499847ff0e1SMatthew G. Knepley + ts - the TS context
6500847ff0e1SMatthew G. Knepley . t - current timestep
6501847ff0e1SMatthew G. Knepley . U - state vector
6502847ff0e1SMatthew G. Knepley . Udot - time derivative of state vector
6503847ff0e1SMatthew G. Knepley . shift - shift to apply, see note below
6504847ff0e1SMatthew G. Knepley - ctx - an optional user context
6505847ff0e1SMatthew G. Knepley 
6506847ff0e1SMatthew G. Knepley   Output Parameters:
6507847ff0e1SMatthew G. Knepley + J - Jacobian matrix (not altered in this routine)
6508847ff0e1SMatthew G. Knepley - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J)
6509847ff0e1SMatthew G. Knepley 
6510847ff0e1SMatthew G. Knepley   Level: intermediate
6511847ff0e1SMatthew G. Knepley 
6512847ff0e1SMatthew G. Knepley   Notes:
6513847ff0e1SMatthew G. Knepley   If F(t,U,Udot)=0 is the DAE, the required Jacobian is
6514847ff0e1SMatthew G. Knepley 
6515847ff0e1SMatthew G. Knepley   dF/dU + shift*dF/dUdot
6516847ff0e1SMatthew G. Knepley 
6517847ff0e1SMatthew G. Knepley   Most users should not need to explicitly call this routine, as it
6518847ff0e1SMatthew G. Knepley   is used internally within the nonlinear solvers.
6519847ff0e1SMatthew G. Knepley 
6520847ff0e1SMatthew G. Knepley   This will first try to get the coloring from the DM.  If the DM type has no coloring
6521847ff0e1SMatthew G. Knepley   routine, then it will try to get the coloring from the matrix.  This requires that the
6522847ff0e1SMatthew G. Knepley   matrix have nonzero entries precomputed.
6523847ff0e1SMatthew G. Knepley 
6524847ff0e1SMatthew G. Knepley .keywords: TS, finite differences, Jacobian, coloring, sparse
6525847ff0e1SMatthew G. Knepley .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction()
6526847ff0e1SMatthew G. Knepley @*/
6527847ff0e1SMatthew G. Knepley PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx)
6528847ff0e1SMatthew G. Knepley {
6529847ff0e1SMatthew G. Knepley   SNES           snes;
6530847ff0e1SMatthew G. Knepley   MatFDColoring  color;
6531847ff0e1SMatthew G. Knepley   PetscBool      hascolor, matcolor = PETSC_FALSE;
6532847ff0e1SMatthew G. Knepley   PetscErrorCode ierr;
6533847ff0e1SMatthew G. Knepley 
6534847ff0e1SMatthew G. Knepley   PetscFunctionBegin;
6535847ff0e1SMatthew G. Knepley   ierr = PetscOptionsGetBool(((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL);CHKERRQ(ierr);
6536847ff0e1SMatthew G. Knepley   ierr = PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color);CHKERRQ(ierr);
6537847ff0e1SMatthew G. Knepley   if (!color) {
6538847ff0e1SMatthew G. Knepley     DM         dm;
6539847ff0e1SMatthew G. Knepley     ISColoring iscoloring;
6540847ff0e1SMatthew G. Knepley 
6541847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
6542847ff0e1SMatthew G. Knepley     ierr = DMHasColoring(dm, &hascolor);CHKERRQ(ierr);
6543847ff0e1SMatthew G. Knepley     if (hascolor && !matcolor) {
6544847ff0e1SMatthew G. Knepley       ierr = DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring);CHKERRQ(ierr);
6545847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
6546847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
6547847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
6548847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
6549847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
6550847ff0e1SMatthew G. Knepley     } else {
6551847ff0e1SMatthew G. Knepley       MatColoring mc;
6552847ff0e1SMatthew G. Knepley 
6553847ff0e1SMatthew G. Knepley       ierr = MatColoringCreate(B, &mc);CHKERRQ(ierr);
6554847ff0e1SMatthew G. Knepley       ierr = MatColoringSetDistance(mc, 2);CHKERRQ(ierr);
6555847ff0e1SMatthew G. Knepley       ierr = MatColoringSetType(mc, MATCOLORINGSL);CHKERRQ(ierr);
6556847ff0e1SMatthew G. Knepley       ierr = MatColoringSetFromOptions(mc);CHKERRQ(ierr);
6557847ff0e1SMatthew G. Knepley       ierr = MatColoringApply(mc, &iscoloring);CHKERRQ(ierr);
6558847ff0e1SMatthew G. Knepley       ierr = MatColoringDestroy(&mc);CHKERRQ(ierr);
6559847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
6560847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
6561847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
6562847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
6563847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
6564847ff0e1SMatthew G. Knepley     }
6565847ff0e1SMatthew G. Knepley     ierr = PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color);CHKERRQ(ierr);
6566847ff0e1SMatthew G. Knepley     ierr = PetscObjectDereference((PetscObject) color);CHKERRQ(ierr);
6567847ff0e1SMatthew G. Knepley   }
6568847ff0e1SMatthew G. Knepley   ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr);
6569847ff0e1SMatthew G. Knepley   ierr = MatFDColoringApply(B, color, U, snes);CHKERRQ(ierr);
6570847ff0e1SMatthew G. Knepley   if (J != B) {
6571847ff0e1SMatthew G. Knepley     ierr = MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
6572847ff0e1SMatthew G. Knepley     ierr = MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
6573847ff0e1SMatthew G. Knepley   }
6574847ff0e1SMatthew G. Knepley   PetscFunctionReturn(0);
6575847ff0e1SMatthew G. Knepley }
657693b34091SDebojyoti Ghosh 
657793b34091SDebojyoti Ghosh #undef  __FUNCT__
6578e5168f73SEmil Constantinescu #define __FUNCT__ "TSClone"
657993b34091SDebojyoti Ghosh /*@C
6580e5168f73SEmil Constantinescu   TSClone - This function clones a time step object.
658193b34091SDebojyoti Ghosh 
658293b34091SDebojyoti Ghosh   Collective on MPI_Comm
658393b34091SDebojyoti Ghosh 
658493b34091SDebojyoti Ghosh   Input Parameter:
658593b34091SDebojyoti Ghosh . tsin    - The input TS
658693b34091SDebojyoti Ghosh 
658793b34091SDebojyoti Ghosh   Output Parameter:
6588e5168f73SEmil Constantinescu . tsout   - The output TS (cloned)
658993b34091SDebojyoti Ghosh 
65905eca1a21SEmil Constantinescu   Notes:
65915eca1a21SEmil Constantinescu   This function is used to create a clone of a TS object. It is used in ARKIMEX for initializing the slope for first stage explicit methods. It will likely be replaced in the future with a mechanism of switching methods on the fly.
65925eca1a21SEmil Constantinescu 
6593baa10174SEmil Constantinescu   When using TSDestroy() on a clone the user has to first reset the correct TS reference in the embedded SNES object: e.g.: by running SNES snes_dup=NULL; TSGetSNES(ts,&snes_dup); ierr = TSSetSNES(ts,snes_dup);
65945eca1a21SEmil Constantinescu 
65955eca1a21SEmil Constantinescu   Level: developer
659693b34091SDebojyoti Ghosh 
6597e5168f73SEmil Constantinescu .keywords: TS, clone
6598e5168f73SEmil Constantinescu .seealso: TSCreate(), TSSetType(), TSSetUp(), TSDestroy(), TSSetProblemType()
659993b34091SDebojyoti Ghosh @*/
6600baa10174SEmil Constantinescu PetscErrorCode  TSClone(TS tsin, TS *tsout)
660193b34091SDebojyoti Ghosh {
660293b34091SDebojyoti Ghosh   TS             t;
660393b34091SDebojyoti Ghosh   PetscErrorCode ierr;
6604dc846ba4SSatish Balay   SNES           snes_start;
6605dc846ba4SSatish Balay   DM             dm;
6606dc846ba4SSatish Balay   TSType         type;
660793b34091SDebojyoti Ghosh 
660893b34091SDebojyoti Ghosh   PetscFunctionBegin;
660993b34091SDebojyoti Ghosh   PetscValidPointer(tsin,1);
661093b34091SDebojyoti Ghosh   *tsout = NULL;
661193b34091SDebojyoti Ghosh 
66127a37829fSSatish Balay   ierr = PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView);CHKERRQ(ierr);
661393b34091SDebojyoti Ghosh 
661493b34091SDebojyoti Ghosh   /* General TS description */
661593b34091SDebojyoti Ghosh   t->numbermonitors    = 0;
661693b34091SDebojyoti Ghosh   t->setupcalled       = 0;
661793b34091SDebojyoti Ghosh   t->ksp_its           = 0;
661893b34091SDebojyoti Ghosh   t->snes_its          = 0;
661993b34091SDebojyoti Ghosh   t->nwork             = 0;
662093b34091SDebojyoti Ghosh   t->rhsjacobian.time  = -1e20;
662193b34091SDebojyoti Ghosh   t->rhsjacobian.scale = 1.;
662293b34091SDebojyoti Ghosh   t->ijacobian.shift   = 1.;
662393b34091SDebojyoti Ghosh 
662434561852SEmil Constantinescu   ierr = TSGetSNES(tsin,&snes_start);                   CHKERRQ(ierr);
662534561852SEmil Constantinescu   ierr = TSSetSNES(t,snes_start);                       CHKERRQ(ierr);
6626d15a3a53SEmil Constantinescu 
662793b34091SDebojyoti Ghosh   ierr = TSGetDM(tsin,&dm);                             CHKERRQ(ierr);
662893b34091SDebojyoti Ghosh   ierr = TSSetDM(t,dm);                                 CHKERRQ(ierr);
662993b34091SDebojyoti Ghosh 
663093b34091SDebojyoti Ghosh   t->adapt=tsin->adapt;
663193b34091SDebojyoti Ghosh   PetscObjectReference((PetscObject)t->adapt);
663293b34091SDebojyoti Ghosh 
663393b34091SDebojyoti Ghosh   t->problem_type      = tsin->problem_type;
663493b34091SDebojyoti Ghosh   t->ptime             = tsin->ptime;
663593b34091SDebojyoti Ghosh   t->time_step         = tsin->time_step;
663693b34091SDebojyoti Ghosh   t->time_step_orig    = tsin->time_step_orig;
663793b34091SDebojyoti Ghosh   t->max_time          = tsin->max_time;
663893b34091SDebojyoti Ghosh   t->steps             = tsin->steps;
663993b34091SDebojyoti Ghosh   t->max_steps         = tsin->max_steps;
664093b34091SDebojyoti Ghosh   t->equation_type     = tsin->equation_type;
664193b34091SDebojyoti Ghosh   t->atol              = tsin->atol;
664293b34091SDebojyoti Ghosh   t->rtol              = tsin->rtol;
664393b34091SDebojyoti Ghosh   t->max_snes_failures = tsin->max_snes_failures;
664493b34091SDebojyoti Ghosh   t->max_reject        = tsin->max_reject;
664593b34091SDebojyoti Ghosh   t->errorifstepfailed = tsin->errorifstepfailed;
664693b34091SDebojyoti Ghosh 
664793b34091SDebojyoti Ghosh   ierr = TSGetType(tsin,&type); CHKERRQ(ierr);
664893b34091SDebojyoti Ghosh   ierr = TSSetType(t,type);     CHKERRQ(ierr);
664993b34091SDebojyoti Ghosh 
665093b34091SDebojyoti Ghosh   t->vec_sol           = NULL;
665193b34091SDebojyoti Ghosh 
665293b34091SDebojyoti Ghosh   t->cfltime          = tsin->cfltime;
665393b34091SDebojyoti Ghosh   t->cfltime_local    = tsin->cfltime_local;
665493b34091SDebojyoti Ghosh   t->exact_final_time = tsin->exact_final_time;
665593b34091SDebojyoti Ghosh 
665693b34091SDebojyoti Ghosh   ierr = PetscMemcpy(t->ops,tsin->ops,sizeof(struct _TSOps));CHKERRQ(ierr);
665793b34091SDebojyoti Ghosh 
665893b34091SDebojyoti Ghosh   *tsout = t;
665993b34091SDebojyoti Ghosh   PetscFunctionReturn(0);
666093b34091SDebojyoti Ghosh }
6661