Actual source code: ts.c
petsc-3.7.5 2017-01-01
2: #include <petsc/private/tsimpl.h> /*I "petscts.h" I*/
3: #include <petscdmshell.h>
4: #include <petscdmda.h>
5: #include <petscviewer.h>
6: #include <petscdraw.h>
8: /* Logging support */
9: PetscClassId TS_CLASSID, DMTS_CLASSID;
10: PetscLogEvent TS_AdjointStep, TS_Step, TS_PseudoComputeTimeStep, TS_FunctionEval, TS_JacobianEval;
12: const char *const TSExactFinalTimeOptions[] = {"UNSPECIFIED","STEPOVER","INTERPOLATE","MATCHSTEP","TSExactFinalTimeOption","TS_EXACTFINALTIME_",0};
14: struct _n_TSMonitorDrawCtx {
15: PetscViewer viewer;
16: Vec initialsolution;
17: PetscBool showinitial;
18: PetscInt howoften; /* when > 0 uses step % howoften, when negative only final solution plotted */
19: PetscBool showtimestepandtime;
20: };
24: /*@C
25: TSMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user
27: Collective on TS
29: Input Parameters:
30: + ts - TS object you wish to monitor
31: . name - the monitor type one is seeking
32: . help - message indicating what monitoring is done
33: . manual - manual page for the monitor
34: . monitor - the monitor function
35: - monitorsetup - a function that is called once ONLY if the user selected this monitor that may set additional features of the TS or PetscViewer objects
37: Level: developer
39: .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(),
40: PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
41: PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
42: PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
43: PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
44: PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
45: PetscOptionsFList(), PetscOptionsEList()
46: @*/
47: PetscErrorCode TSMonitorSetFromOptions(TS ts,const char name[],const char help[], const char manual[],PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*),PetscErrorCode (*monitorsetup)(TS,PetscViewerAndFormat*))
48: {
49: PetscErrorCode ierr;
50: PetscViewer viewer;
51: PetscViewerFormat format;
52: PetscBool flg;
55: PetscOptionsGetViewer(PetscObjectComm((PetscObject)ts),((PetscObject)ts)->prefix,name,&viewer,&format,&flg);
56: if (flg) {
57: PetscViewerAndFormat *vf;
58: PetscViewerAndFormatCreate(viewer,format,&vf);
59: PetscObjectDereference((PetscObject)viewer);
60: if (monitorsetup) {
61: (*monitorsetup)(ts,vf);
62: }
63: TSMonitorSet(ts,(PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,void*))monitor,vf,(PetscErrorCode (*)(void**))PetscViewerAndFormatDestroy);
64: }
65: return(0);
66: }
70: /*@C
71: TSAdjointMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user
73: Collective on TS
75: Input Parameters:
76: + ts - TS object you wish to monitor
77: . name - the monitor type one is seeking
78: . help - message indicating what monitoring is done
79: . manual - manual page for the monitor
80: . monitor - the monitor function
81: - monitorsetup - a function that is called once ONLY if the user selected this monitor that may set additional features of the TS or PetscViewer objects
83: Level: developer
85: .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(),
86: PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
87: PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
88: PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
89: PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
90: PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
91: PetscOptionsFList(), PetscOptionsEList()
92: @*/
93: PetscErrorCode TSAdjointMonitorSetFromOptions(TS ts,const char name[],const char help[], const char manual[],PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat*),PetscErrorCode (*monitorsetup)(TS,PetscViewerAndFormat*))
94: {
95: PetscErrorCode ierr;
96: PetscViewer viewer;
97: PetscViewerFormat format;
98: PetscBool flg;
101: PetscOptionsGetViewer(PetscObjectComm((PetscObject)ts),((PetscObject)ts)->prefix,name,&viewer,&format,&flg);
102: if (flg) {
103: PetscViewerAndFormat *vf;
104: PetscViewerAndFormatCreate(viewer,format,&vf);
105: PetscObjectDereference((PetscObject)viewer);
106: if (monitorsetup) {
107: (*monitorsetup)(ts,vf);
108: }
109: TSAdjointMonitorSet(ts,(PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*))monitor,vf,(PetscErrorCode (*)(void**))PetscViewerAndFormatDestroy);
110: }
111: return(0);
112: }
116: /*@
117: TSSetFromOptions - Sets various TS parameters from user options.
119: Collective on TS
121: Input Parameter:
122: . ts - the TS context obtained from TSCreate()
124: Options Database Keys:
125: + -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSALPHA, TSGL, TSSSP
126: . -ts_save_trajectory - checkpoint the solution at each time-step
127: . -ts_max_steps <maxsteps> - maximum number of time-steps to take
128: . -ts_final_time <time> - maximum time to compute to
129: . -ts_dt <dt> - initial time step
130: . -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
131: . -ts_max_snes_failures <maxfailures> - Maximum number of nonlinear solve failures allowed
132: . -ts_max_reject <maxrejects> - Maximum number of step rejections before step fails
133: . -ts_error_if_step_fails <true,false> - Error if no step succeeds
134: . -ts_rtol <rtol> - relative tolerance for local truncation error
135: . -ts_atol <atol> Absolute tolerance for local truncation error
136: . -ts_adjoint_solve <yes,no> After solving the ODE/DAE solve the adjoint problem (requires -ts_save_trajectory)
137: . -ts_fd_color - Use finite differences with coloring to compute IJacobian
138: . -ts_monitor - print information at each timestep
139: . -ts_monitor_lg_solution - Monitor solution graphically
140: . -ts_monitor_lg_error - Monitor error graphically
141: . -ts_monitor_lg_timestep - Monitor timestep size graphically
142: . -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically
143: . -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically
144: . -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically
145: . -ts_monitor_draw_solution - Monitor solution graphically
146: . -ts_monitor_draw_solution_phase <xleft,yleft,xright,yright> - Monitor solution graphically with phase diagram, requires problem with exactly 2 degrees of freedom
147: . -ts_monitor_draw_error - Monitor error graphically, requires use to have provided TSSetSolutionFunction()
148: . -ts_monitor_solution [ascii binary draw][:filename][:viewerformat] - monitors the solution at each timestep
149: . -ts_monitor_solution_vtk <filename.vts> - Save each time step to a binary file, use filename-%%03D.vts
150: . -ts_monitor_envelope - determine maximum and minimum value of each component of the solution over the solution time
151: . -ts_adjoint_monitor - print information at each adjoint time step
152: - -ts_adjoint_monitor_draw_sensi - monitor the sensitivity of the first cost function wrt initial conditions (lambda[0]) graphically
154: Developer Note: We should unify all the -ts_monitor options in the way that -xxx_view has been unified
156: Level: beginner
158: .keywords: TS, timestep, set, options, database
160: .seealso: TSGetType()
161: @*/
162: PetscErrorCode TSSetFromOptions(TS ts)
163: {
164: PetscBool opt,flg,tflg;
165: PetscErrorCode ierr;
166: char monfilename[PETSC_MAX_PATH_LEN];
167: PetscReal time_step;
168: TSExactFinalTimeOption eftopt;
169: char dir[16];
170: TSIFunction ifun;
171: const char *defaultType;
172: char typeName[256];
177: TSRegisterAll();
178: TSGetIFunction(ts,NULL,&ifun,NULL);
180: PetscObjectOptionsBegin((PetscObject)ts);
181: if (((PetscObject)ts)->type_name)
182: defaultType = ((PetscObject)ts)->type_name;
183: else
184: defaultType = ifun ? TSBEULER : TSEULER;
185: PetscOptionsFList("-ts_type","TS method","TSSetType",TSList,defaultType,typeName,256,&opt);
186: if (opt) {
187: TSSetType(ts,typeName);
188: } else {
189: TSSetType(ts,defaultType);
190: }
192: /* Handle generic TS options */
193: PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetDuration",ts->max_steps,&ts->max_steps,NULL);
194: PetscOptionsReal("-ts_final_time","Time to run to","TSSetDuration",ts->max_time,&ts->max_time,NULL);
195: PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);
196: PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);
197: if (flg) {TSSetTimeStep(ts,time_step);}
198: PetscOptionsEnum("-ts_exact_final_time","Option for handling of final time step","TSSetExactFinalTime",TSExactFinalTimeOptions,(PetscEnum)ts->exact_final_time,(PetscEnum*)&eftopt,&flg);
199: if (flg) {TSSetExactFinalTime(ts,eftopt);}
200: PetscOptionsInt("-ts_max_snes_failures","Maximum number of nonlinear solve failures","TSSetMaxSNESFailures",ts->max_snes_failures,&ts->max_snes_failures,NULL);
201: PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);
202: PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);
203: PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);
204: PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);
206: #if defined(PETSC_HAVE_SAWS)
207: {
208: PetscBool set;
209: flg = PETSC_FALSE;
210: PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);
211: if (set) {
212: PetscObjectSAWsSetBlock((PetscObject)ts,flg);
213: }
214: }
215: #endif
217: /* Monitor options */
218: TSMonitorSetFromOptions(ts,"-ts_monitor","Monitor time and timestep size","TSMonitorDefault",TSMonitorDefault,NULL);
219: TSMonitorSetFromOptions(ts,"-ts_monitor_solution","View the solution at each timestep","TSMonitorSolution",TSMonitorSolution,NULL);
220: TSAdjointMonitorSetFromOptions(ts,"-ts_adjoint_monitor","Monitor adjoint timestep size","TSAdjointMonitorDefault",TSAdjointMonitorDefault,NULL);
222: PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);
223: if (flg) {PetscPythonMonitorSet((PetscObject)ts,monfilename);}
225: PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);
226: if (opt) {
227: TSMonitorLGCtx ctx;
228: PetscInt howoften = 1;
230: PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);
231: TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);
232: TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);
233: }
235: PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);
236: if (opt) {
237: TSMonitorLGCtx ctx;
238: PetscInt howoften = 1;
240: PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);
241: TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);
242: TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);
243: }
245: PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);
246: if (opt) {
247: TSMonitorLGCtx ctx;
248: PetscInt howoften = 1;
250: PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);
251: TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);
252: TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);
253: }
254: PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);
255: if (opt) {
256: TSMonitorLGCtx ctx;
257: PetscInt howoften = 1;
259: PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);
260: TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);
261: TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);
262: }
263: PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);
264: if (opt) {
265: TSMonitorLGCtx ctx;
266: PetscInt howoften = 1;
268: PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);
269: TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);
270: TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);
271: }
272: PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);
273: if (opt) {
274: TSMonitorSPEigCtx ctx;
275: PetscInt howoften = 1;
277: PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);
278: TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);
279: TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);
280: }
281: opt = PETSC_FALSE;
282: PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);
283: if (opt) {
284: TSMonitorDrawCtx ctx;
285: PetscInt howoften = 1;
287: PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);
288: TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);
289: TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);
290: }
291: opt = PETSC_FALSE;
292: PetscOptionsName("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",&opt);
293: if (opt) {
294: TSMonitorDrawCtx ctx;
295: PetscInt howoften = 1;
297: PetscOptionsInt("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",howoften,&howoften,NULL);
298: TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);
299: TSAdjointMonitorSet(ts,TSAdjointMonitorDrawSensi,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);
300: }
301: opt = PETSC_FALSE;
302: PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);
303: if (opt) {
304: TSMonitorDrawCtx ctx;
305: PetscReal bounds[4];
306: PetscInt n = 4;
307: PetscDraw draw;
308: PetscDrawAxis axis;
310: PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);
311: if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field");
312: TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,1,&ctx);
313: PetscViewerDrawGetDraw(ctx->viewer,0,&draw);
314: PetscViewerDrawGetDrawAxis(ctx->viewer,0,&axis);
315: PetscDrawAxisSetLimits(axis,bounds[0],bounds[2],bounds[1],bounds[3]);
316: PetscDrawAxisSetLabels(axis,"Phase Diagram","Variable 1","Variable 2");
317: TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);
318: }
319: opt = PETSC_FALSE;
320: PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);
321: if (opt) {
322: TSMonitorDrawCtx ctx;
323: PetscInt howoften = 1;
325: PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);
326: TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);
327: TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);
328: }
330: opt = PETSC_FALSE;
331: 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);
332: if (flg) {
333: const char *ptr,*ptr2;
334: char *filetemplate;
335: if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
336: /* Do some cursory validation of the input. */
337: PetscStrstr(monfilename,"%",(char**)&ptr);
338: if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
339: for (ptr++; ptr && *ptr; ptr++) {
340: PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);
341: 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");
342: if (ptr2) break;
343: }
344: PetscStrallocpy(monfilename,&filetemplate);
345: TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);
346: }
348: PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,16,&flg);
349: if (flg) {
350: TSMonitorDMDARayCtx *rayctx;
351: int ray = 0;
352: DMDADirection ddir;
353: DM da;
354: PetscMPIInt rank;
356: if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
357: if (dir[0] == 'x') ddir = DMDA_X;
358: else if (dir[0] == 'y') ddir = DMDA_Y;
359: else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
360: sscanf(dir+2,"%d",&ray);
362: PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %D\n",dir[0],ray);
363: PetscNew(&rayctx);
364: TSGetDM(ts,&da);
365: DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);
366: MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);
367: if (!rank) {
368: PetscViewerDrawOpen(PETSC_COMM_SELF,0,0,0,0,600,300,&rayctx->viewer);
369: }
370: rayctx->lgctx = NULL;
371: TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);
372: }
373: PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,16,&flg);
374: if (flg) {
375: TSMonitorDMDARayCtx *rayctx;
376: int ray = 0;
377: DMDADirection ddir;
378: DM da;
379: PetscInt howoften = 1;
381: if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir);
382: if (dir[0] == 'x') ddir = DMDA_X;
383: else if (dir[0] == 'y') ddir = DMDA_Y;
384: else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir);
385: sscanf(dir+2, "%d", &ray);
387: PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %D\n", dir[0], ray);
388: PetscNew(&rayctx);
389: TSGetDM(ts, &da);
390: DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);
391: TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);
392: TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);
393: }
395: PetscOptionsName("-ts_monitor_envelope","Monitor maximum and minimum value of each component of the solution","TSMonitorEnvelope",&opt);
396: if (opt) {
397: TSMonitorEnvelopeCtx ctx;
399: TSMonitorEnvelopeCtxCreate(ts,&ctx);
400: TSMonitorSet(ts,TSMonitorEnvelope,ctx,(PetscErrorCode (*)(void**))TSMonitorEnvelopeCtxDestroy);
401: }
403: flg = PETSC_FALSE;
404: PetscOptionsBool("-ts_fd_color", "Use finite differences with coloring to compute IJacobian", "TSComputeJacobianDefaultColor", flg, &flg, NULL);
405: if (flg) {
406: DM dm;
407: DMTS tdm;
409: TSGetDM(ts, &dm);
410: DMGetDMTS(dm, &tdm);
411: tdm->ijacobianctx = NULL;
412: TSSetIJacobian(ts, NULL, NULL, TSComputeIJacobianDefaultColor, 0);
413: PetscInfo(ts, "Setting default finite difference coloring Jacobian matrix\n");
414: }
416: if (ts->adapt) {
417: TSAdaptSetFromOptions(PetscOptionsObject,ts->adapt);
418: }
420: /* Handle specific TS options */
421: if (ts->ops->setfromoptions) {
422: (*ts->ops->setfromoptions)(PetscOptionsObject,ts);
423: }
425: /* TS trajectory must be set after TS, since it may use some TS options above */
426: tflg = ts->trajectory ? PETSC_TRUE : PETSC_FALSE;
427: PetscOptionsBool("-ts_save_trajectory","Save the solution at each timestep","TSSetSaveTrajectory",tflg,&tflg,NULL);
428: if (tflg) {
429: TSSetSaveTrajectory(ts);
430: }
431: tflg = ts->adjoint_solve ? PETSC_TRUE : PETSC_FALSE;
432: PetscOptionsBool("-ts_adjoint_solve","Solve the adjoint problem immediately after solving the forward problem","",tflg,&tflg,&flg);
433: if (flg) {
434: TSSetSaveTrajectory(ts);
435: ts->adjoint_solve = tflg;
436: }
438: /* process any options handlers added with PetscObjectAddOptionsHandler() */
439: PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject)ts);
440: PetscOptionsEnd();
442: if (ts->trajectory) {
443: TSTrajectorySetFromOptions(ts->trajectory,ts);
444: }
446: TSGetSNES(ts,&ts->snes);
447: if (ts->problem_type == TS_LINEAR) {SNESSetType(ts->snes,SNESKSPONLY);}
448: SNESSetFromOptions(ts->snes);
449: return(0);
450: }
454: /*@
455: TSSetSaveTrajectory - Causes the TS to save its solutions as it iterates forward in time in a TSTrajectory object
457: Collective on TS
459: Input Parameters:
460: . ts - the TS context obtained from TSCreate()
462: Note: This routine should be called after all TS options have been set
464: Level: intermediate
466: .seealso: TSGetTrajectory(), TSAdjointSolve()
468: .keywords: TS, set, checkpoint,
469: @*/
470: PetscErrorCode TSSetSaveTrajectory(TS ts)
471: {
476: if (!ts->trajectory) {
477: TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);
478: TSTrajectorySetFromOptions(ts->trajectory,ts);
479: }
480: return(0);
481: }
485: /*@
486: TSComputeRHSJacobian - Computes the Jacobian matrix that has been
487: set with TSSetRHSJacobian().
489: Collective on TS and Vec
491: Input Parameters:
492: + ts - the TS context
493: . t - current timestep
494: - U - input vector
496: Output Parameters:
497: + A - Jacobian matrix
498: . B - optional preconditioning matrix
499: - flag - flag indicating matrix structure
501: Notes:
502: Most users should not need to explicitly call this routine, as it
503: is used internally within the nonlinear solvers.
505: See KSPSetOperators() for important information about setting the
506: flag parameter.
508: Level: developer
510: .keywords: SNES, compute, Jacobian, matrix
512: .seealso: TSSetRHSJacobian(), KSPSetOperators()
513: @*/
514: PetscErrorCode TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B)
515: {
517: PetscObjectState Ustate;
518: DM dm;
519: DMTS tsdm;
520: TSRHSJacobian rhsjacobianfunc;
521: void *ctx;
522: TSIJacobian ijacobianfunc;
523: TSRHSFunction rhsfunction;
529: TSGetDM(ts,&dm);
530: DMGetDMTS(dm,&tsdm);
531: DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);
532: DMTSGetIJacobian(dm,&ijacobianfunc,NULL);
533: DMTSGetRHSFunction(dm,&rhsfunction,&ctx);
534: PetscObjectStateGet((PetscObject)U,&Ustate);
535: if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.X == U && ts->rhsjacobian.Xstate == Ustate)) && (rhsfunction != TSComputeRHSFunctionLinear)) {
536: return(0);
537: }
539: if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
541: if (ts->rhsjacobian.reuse) {
542: MatShift(A,-ts->rhsjacobian.shift);
543: MatScale(A,1./ts->rhsjacobian.scale);
544: if (A != B) {
545: MatShift(B,-ts->rhsjacobian.shift);
546: MatScale(B,1./ts->rhsjacobian.scale);
547: }
548: ts->rhsjacobian.shift = 0;
549: ts->rhsjacobian.scale = 1.;
550: }
552: if (rhsjacobianfunc) {
553: PetscBool missing;
554: PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);
555: PetscStackPush("TS user Jacobian function");
556: (*rhsjacobianfunc)(ts,t,U,A,B,ctx);
557: PetscStackPop;
558: PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);
559: if (A) {
560: MatMissingDiagonal(A,&missing,NULL);
561: if (missing) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Amat passed to TSSetRHSJacobian() must have all diagonal entries set, if they are zero you must still set them with a zero value");
562: }
563: if (B && B != A) {
564: MatMissingDiagonal(B,&missing,NULL);
565: if (missing) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Bmat passed to TSSetRHSJacobian() must have all diagonal entries set, if they are zero you must still set them with a zero value");
566: }
567: } else {
568: MatZeroEntries(A);
569: if (A != B) {MatZeroEntries(B);}
570: }
571: ts->rhsjacobian.time = t;
572: ts->rhsjacobian.X = U;
573: PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);
574: return(0);
575: }
579: /*@
580: TSComputeRHSFunction - Evaluates the right-hand-side function.
582: Collective on TS and Vec
584: Input Parameters:
585: + ts - the TS context
586: . t - current time
587: - U - state vector
589: Output Parameter:
590: . y - right hand side
592: Note:
593: Most users should not need to explicitly call this routine, as it
594: is used internally within the nonlinear solvers.
596: Level: developer
598: .keywords: TS, compute
600: .seealso: TSSetRHSFunction(), TSComputeIFunction()
601: @*/
602: PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y)
603: {
605: TSRHSFunction rhsfunction;
606: TSIFunction ifunction;
607: void *ctx;
608: DM dm;
614: TSGetDM(ts,&dm);
615: DMTSGetRHSFunction(dm,&rhsfunction,&ctx);
616: DMTSGetIFunction(dm,&ifunction,NULL);
618: if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
620: PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);
621: if (rhsfunction) {
622: PetscStackPush("TS user right-hand-side function");
623: (*rhsfunction)(ts,t,U,y,ctx);
624: PetscStackPop;
625: } else {
626: VecZeroEntries(y);
627: }
629: PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);
630: return(0);
631: }
635: /*@
636: TSComputeSolutionFunction - Evaluates the solution function.
638: Collective on TS and Vec
640: Input Parameters:
641: + ts - the TS context
642: - t - current time
644: Output Parameter:
645: . U - the solution
647: Note:
648: Most users should not need to explicitly call this routine, as it
649: is used internally within the nonlinear solvers.
651: Level: developer
653: .keywords: TS, compute
655: .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
656: @*/
657: PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U)
658: {
659: PetscErrorCode ierr;
660: TSSolutionFunction solutionfunction;
661: void *ctx;
662: DM dm;
667: TSGetDM(ts,&dm);
668: DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);
670: if (solutionfunction) {
671: PetscStackPush("TS user solution function");
672: (*solutionfunction)(ts,t,U,ctx);
673: PetscStackPop;
674: }
675: return(0);
676: }
679: /*@
680: TSComputeForcingFunction - Evaluates the forcing function.
682: Collective on TS and Vec
684: Input Parameters:
685: + ts - the TS context
686: - t - current time
688: Output Parameter:
689: . U - the function value
691: Note:
692: Most users should not need to explicitly call this routine, as it
693: is used internally within the nonlinear solvers.
695: Level: developer
697: .keywords: TS, compute
699: .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
700: @*/
701: PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U)
702: {
703: PetscErrorCode ierr, (*forcing)(TS,PetscReal,Vec,void*);
704: void *ctx;
705: DM dm;
710: TSGetDM(ts,&dm);
711: DMTSGetForcingFunction(dm,&forcing,&ctx);
713: if (forcing) {
714: PetscStackPush("TS user forcing function");
715: (*forcing)(ts,t,U,ctx);
716: PetscStackPop;
717: }
718: return(0);
719: }
723: static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs)
724: {
725: Vec F;
729: *Frhs = NULL;
730: TSGetIFunction(ts,&F,NULL,NULL);
731: if (!ts->Frhs) {
732: VecDuplicate(F,&ts->Frhs);
733: }
734: *Frhs = ts->Frhs;
735: return(0);
736: }
740: static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs)
741: {
742: Mat A,B;
746: if (Arhs) *Arhs = NULL;
747: if (Brhs) *Brhs = NULL;
748: TSGetIJacobian(ts,&A,&B,NULL,NULL);
749: if (Arhs) {
750: if (!ts->Arhs) {
751: MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);
752: }
753: *Arhs = ts->Arhs;
754: }
755: if (Brhs) {
756: if (!ts->Brhs) {
757: if (A != B) {
758: MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);
759: } else {
760: PetscObjectReference((PetscObject)ts->Arhs);
761: ts->Brhs = ts->Arhs;
762: }
763: }
764: *Brhs = ts->Brhs;
765: }
766: return(0);
767: }
771: /*@
772: TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0
774: Collective on TS and Vec
776: Input Parameters:
777: + ts - the TS context
778: . t - current time
779: . U - state vector
780: . Udot - time derivative of state vector
781: - imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate
783: Output Parameter:
784: . Y - right hand side
786: Note:
787: Most users should not need to explicitly call this routine, as it
788: is used internally within the nonlinear solvers.
790: If the user did did not write their equations in implicit form, this
791: function recasts them in implicit form.
793: Level: developer
795: .keywords: TS, compute
797: .seealso: TSSetIFunction(), TSComputeRHSFunction()
798: @*/
799: PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex)
800: {
802: TSIFunction ifunction;
803: TSRHSFunction rhsfunction;
804: void *ctx;
805: DM dm;
813: TSGetDM(ts,&dm);
814: DMTSGetIFunction(dm,&ifunction,&ctx);
815: DMTSGetRHSFunction(dm,&rhsfunction,NULL);
817: if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
819: PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);
820: if (ifunction) {
821: PetscStackPush("TS user implicit function");
822: (*ifunction)(ts,t,U,Udot,Y,ctx);
823: PetscStackPop;
824: }
825: if (imex) {
826: if (!ifunction) {
827: VecCopy(Udot,Y);
828: }
829: } else if (rhsfunction) {
830: if (ifunction) {
831: Vec Frhs;
832: TSGetRHSVec_Private(ts,&Frhs);
833: TSComputeRHSFunction(ts,t,U,Frhs);
834: VecAXPY(Y,-1,Frhs);
835: } else {
836: TSComputeRHSFunction(ts,t,U,Y);
837: VecAYPX(Y,-1,Udot);
838: }
839: }
840: PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);
841: return(0);
842: }
846: /*@
847: TSComputeIJacobian - Evaluates the Jacobian of the DAE
849: Collective on TS and Vec
851: Input
852: Input Parameters:
853: + ts - the TS context
854: . t - current timestep
855: . U - state vector
856: . Udot - time derivative of state vector
857: . shift - shift to apply, see note below
858: - imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate
860: Output Parameters:
861: + A - Jacobian matrix
862: . B - optional preconditioning matrix
863: - flag - flag indicating matrix structure
865: Notes:
866: If F(t,U,Udot)=0 is the DAE, the required Jacobian is
868: dF/dU + shift*dF/dUdot
870: Most users should not need to explicitly call this routine, as it
871: is used internally within the nonlinear solvers.
873: Level: developer
875: .keywords: TS, compute, Jacobian, matrix
877: .seealso: TSSetIJacobian()
878: @*/
879: PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex)
880: {
882: TSIJacobian ijacobian;
883: TSRHSJacobian rhsjacobian;
884: DM dm;
885: void *ctx;
896: TSGetDM(ts,&dm);
897: DMTSGetIJacobian(dm,&ijacobian,&ctx);
898: DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);
900: if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
902: PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);
903: if (ijacobian) {
904: PetscBool missing;
905: PetscStackPush("TS user implicit Jacobian");
906: (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);
907: PetscStackPop;
908: if (A) {
909: MatMissingDiagonal(A,&missing,NULL);
910: if (missing) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Amat passed to TSSetIJacobian() must have all diagonal entries set, if they are zero you must still set them with a zero value");
911: }
912: if (B && B != A) {
913: MatMissingDiagonal(B,&missing,NULL);
914: if (missing) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Bmat passed to TSSetIJacobian() must have all diagonal entries set, if they are zero you must still set them with a zero value");
915: }
916: }
917: if (imex) {
918: if (!ijacobian) { /* system was written as Udot = G(t,U) */
919: PetscBool assembled;
920: MatZeroEntries(A);
921: MatAssembled(A,&assembled);
922: if (!assembled) {
923: MatAssemblyBegin(A,MAT_FINAL_ASSEMBLY);
924: MatAssemblyEnd(A,MAT_FINAL_ASSEMBLY);
925: }
926: MatShift(A,shift);
927: if (A != B) {
928: MatZeroEntries(B);
929: MatAssembled(B,&assembled);
930: if (!assembled) {
931: MatAssemblyBegin(B,MAT_FINAL_ASSEMBLY);
932: MatAssemblyEnd(B,MAT_FINAL_ASSEMBLY);
933: }
934: MatShift(B,shift);
935: }
936: }
937: } else {
938: Mat Arhs = NULL,Brhs = NULL;
939: if (rhsjacobian) {
940: TSGetRHSMats_Private(ts,&Arhs,&Brhs);
941: TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);
942: }
943: if (Arhs == A) { /* No IJacobian, so we only have the RHS matrix */
944: ts->rhsjacobian.scale = -1;
945: ts->rhsjacobian.shift = shift;
946: MatScale(A,-1);
947: MatShift(A,shift);
948: if (A != B) {
949: MatScale(B,-1);
950: MatShift(B,shift);
951: }
952: } else if (Arhs) { /* Both IJacobian and RHSJacobian */
953: MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
954: if (!ijacobian) { /* No IJacobian provided, but we have a separate RHS matrix */
955: MatZeroEntries(A);
956: MatShift(A,shift);
957: if (A != B) {
958: MatZeroEntries(B);
959: MatShift(B,shift);
960: }
961: }
962: MatAXPY(A,-1,Arhs,axpy);
963: if (A != B) {
964: MatAXPY(B,-1,Brhs,axpy);
965: }
966: }
967: }
968: PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);
969: return(0);
970: }
974: /*@C
975: TSSetRHSFunction - Sets the routine for evaluating the function,
976: where U_t = G(t,u).
978: Logically Collective on TS
980: Input Parameters:
981: + ts - the TS context obtained from TSCreate()
982: . r - vector to put the computed right hand side (or NULL to have it created)
983: . f - routine for evaluating the right-hand-side function
984: - ctx - [optional] user-defined context for private data for the
985: function evaluation routine (may be NULL)
987: Calling sequence of func:
988: $ func (TS ts,PetscReal t,Vec u,Vec F,void *ctx);
990: + t - current timestep
991: . u - input vector
992: . F - function vector
993: - ctx - [optional] user-defined function context
995: Level: beginner
997: Notes: You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE.
999: .keywords: TS, timestep, set, right-hand-side, function
1001: .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction()
1002: @*/
1003: PetscErrorCode TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx)
1004: {
1006: SNES snes;
1007: Vec ralloc = NULL;
1008: DM dm;
1014: TSGetDM(ts,&dm);
1015: DMTSSetRHSFunction(dm,f,ctx);
1016: TSGetSNES(ts,&snes);
1017: if (!r && !ts->dm && ts->vec_sol) {
1018: VecDuplicate(ts->vec_sol,&ralloc);
1019: r = ralloc;
1020: }
1021: SNESSetFunction(snes,r,SNESTSFormFunction,ts);
1022: VecDestroy(&ralloc);
1023: return(0);
1024: }
1028: /*@C
1029: TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE
1031: Logically Collective on TS
1033: Input Parameters:
1034: + ts - the TS context obtained from TSCreate()
1035: . f - routine for evaluating the solution
1036: - ctx - [optional] user-defined context for private data for the
1037: function evaluation routine (may be NULL)
1039: Calling sequence of func:
1040: $ func (TS ts,PetscReal t,Vec u,void *ctx);
1042: + t - current timestep
1043: . u - output vector
1044: - ctx - [optional] user-defined function context
1046: Notes:
1047: This routine is used for testing accuracy of time integration schemes when you already know the solution.
1048: If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to
1049: create closed-form solutions with non-physical forcing terms.
1051: For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
1053: Level: beginner
1055: .keywords: TS, timestep, set, right-hand-side, function
1057: .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction()
1058: @*/
1059: PetscErrorCode TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
1060: {
1062: DM dm;
1066: TSGetDM(ts,&dm);
1067: DMTSSetSolutionFunction(dm,f,ctx);
1068: return(0);
1069: }
1073: /*@C
1074: TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE
1076: Logically Collective on TS
1078: Input Parameters:
1079: + ts - the TS context obtained from TSCreate()
1080: . f - routine for evaluating the forcing function
1081: - ctx - [optional] user-defined context for private data for the
1082: function evaluation routine (may be NULL)
1084: Calling sequence of func:
1085: $ func (TS ts,PetscReal t,Vec u,void *ctx);
1087: + t - current timestep
1088: . u - output vector
1089: - ctx - [optional] user-defined function context
1091: Notes:
1092: This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to
1093: create closed-form solutions with a non-physical forcing term.
1095: For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
1097: Level: beginner
1099: .keywords: TS, timestep, set, right-hand-side, function
1101: .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction()
1102: @*/
1103: PetscErrorCode TSSetForcingFunction(TS ts,TSForcingFunction f,void *ctx)
1104: {
1106: DM dm;
1110: TSGetDM(ts,&dm);
1111: DMTSSetForcingFunction(dm,f,ctx);
1112: return(0);
1113: }
1117: /*@C
1118: TSSetRHSJacobian - Sets the function to compute the Jacobian of G,
1119: where U_t = G(U,t), as well as the location to store the matrix.
1121: Logically Collective on TS
1123: Input Parameters:
1124: + ts - the TS context obtained from TSCreate()
1125: . Amat - (approximate) Jacobian matrix
1126: . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1127: . f - the Jacobian evaluation routine
1128: - ctx - [optional] user-defined context for private data for the
1129: Jacobian evaluation routine (may be NULL)
1131: Calling sequence of f:
1132: $ func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx);
1134: + t - current timestep
1135: . u - input vector
1136: . Amat - (approximate) Jacobian matrix
1137: . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1138: - ctx - [optional] user-defined context for matrix evaluation routine
1140: Notes:
1141: You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
1143: The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1144: You should not assume the values are the same in the next call to f() as you set them in the previous call.
1146: Level: beginner
1148: .keywords: TS, timestep, set, right-hand-side, Jacobian
1150: .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian()
1152: @*/
1153: PetscErrorCode TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx)
1154: {
1156: SNES snes;
1157: DM dm;
1158: TSIJacobian ijacobian;
1167: TSGetDM(ts,&dm);
1168: DMTSSetRHSJacobian(dm,f,ctx);
1169: if (f == TSComputeRHSJacobianConstant) {
1170: /* Handle this case automatically for the user; otherwise user should call themselves. */
1171: TSRHSJacobianSetReuse(ts,PETSC_TRUE);
1172: }
1173: DMTSGetIJacobian(dm,&ijacobian,NULL);
1174: TSGetSNES(ts,&snes);
1175: if (!ijacobian) {
1176: SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);
1177: }
1178: if (Amat) {
1179: PetscObjectReference((PetscObject)Amat);
1180: MatDestroy(&ts->Arhs);
1181: ts->Arhs = Amat;
1182: }
1183: if (Pmat) {
1184: PetscObjectReference((PetscObject)Pmat);
1185: MatDestroy(&ts->Brhs);
1186: ts->Brhs = Pmat;
1187: }
1188: return(0);
1189: }
1194: /*@C
1195: TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved.
1197: Logically Collective on TS
1199: Input Parameters:
1200: + ts - the TS context obtained from TSCreate()
1201: . r - vector to hold the residual (or NULL to have it created internally)
1202: . f - the function evaluation routine
1203: - ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1205: Calling sequence of f:
1206: $ f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx);
1208: + t - time at step/stage being solved
1209: . u - state vector
1210: . u_t - time derivative of state vector
1211: . F - function vector
1212: - ctx - [optional] user-defined context for matrix evaluation routine
1214: Important:
1215: The user MUST call either this routine or TSSetRHSFunction() to define the ODE. When solving DAEs you must use this function.
1217: Level: beginner
1219: .keywords: TS, timestep, set, DAE, Jacobian
1221: .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian()
1222: @*/
1223: PetscErrorCode TSSetIFunction(TS ts,Vec r,TSIFunction f,void *ctx)
1224: {
1226: SNES snes;
1227: Vec ralloc = NULL;
1228: DM dm;
1234: TSGetDM(ts,&dm);
1235: DMTSSetIFunction(dm,f,ctx);
1237: TSGetSNES(ts,&snes);
1238: if (!r && !ts->dm && ts->vec_sol) {
1239: VecDuplicate(ts->vec_sol,&ralloc);
1240: r = ralloc;
1241: }
1242: SNESSetFunction(snes,r,SNESTSFormFunction,ts);
1243: VecDestroy(&ralloc);
1244: return(0);
1245: }
1249: /*@C
1250: TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1252: Not Collective
1254: Input Parameter:
1255: . ts - the TS context
1257: Output Parameter:
1258: + r - vector to hold residual (or NULL)
1259: . func - the function to compute residual (or NULL)
1260: - ctx - the function context (or NULL)
1262: Level: advanced
1264: .keywords: TS, nonlinear, get, function
1266: .seealso: TSSetIFunction(), SNESGetFunction()
1267: @*/
1268: PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx)
1269: {
1271: SNES snes;
1272: DM dm;
1276: TSGetSNES(ts,&snes);
1277: SNESGetFunction(snes,r,NULL,NULL);
1278: TSGetDM(ts,&dm);
1279: DMTSGetIFunction(dm,func,ctx);
1280: return(0);
1281: }
1285: /*@C
1286: TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it.
1288: Not Collective
1290: Input Parameter:
1291: . ts - the TS context
1293: Output Parameter:
1294: + r - vector to hold computed right hand side (or NULL)
1295: . func - the function to compute right hand side (or NULL)
1296: - ctx - the function context (or NULL)
1298: Level: advanced
1300: .keywords: TS, nonlinear, get, function
1302: .seealso: TSSetRHSFunction(), SNESGetFunction()
1303: @*/
1304: PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx)
1305: {
1307: SNES snes;
1308: DM dm;
1312: TSGetSNES(ts,&snes);
1313: SNESGetFunction(snes,r,NULL,NULL);
1314: TSGetDM(ts,&dm);
1315: DMTSGetRHSFunction(dm,func,ctx);
1316: return(0);
1317: }
1321: /*@C
1322: TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function
1323: provided with TSSetIFunction().
1325: Logically Collective on TS
1327: Input Parameters:
1328: + ts - the TS context obtained from TSCreate()
1329: . Amat - (approximate) Jacobian matrix
1330: . Pmat - matrix used to compute preconditioner (usually the same as Amat)
1331: . f - the Jacobian evaluation routine
1332: - ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1334: Calling sequence of f:
1335: $ f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx);
1337: + t - time at step/stage being solved
1338: . U - state vector
1339: . U_t - time derivative of state vector
1340: . a - shift
1341: . Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t
1342: . Pmat - matrix used for constructing preconditioner, usually the same as Amat
1343: - ctx - [optional] user-defined context for matrix evaluation routine
1345: Notes:
1346: The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve.
1348: If you know the operator Amat has a null space you can use MatSetNullSpace() and MatSetTransposeNullSpace() to supply the null
1349: space to Amat and the KSP solvers will automatically use that null space as needed during the solution process.
1351: The matrix dF/dU + a*dF/dU_t you provide turns out to be
1352: the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved.
1353: The time integrator internally approximates U_t by W+a*U where the positive "shift"
1354: a and vector W depend on the integration method, step size, and past states. For example with
1355: the backward Euler method a = 1/dt and W = -a*U(previous timestep) so
1356: W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt
1358: You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
1360: The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1361: You should not assume the values are the same in the next call to f() as you set them in the previous call.
1363: Level: beginner
1365: .keywords: TS, timestep, DAE, Jacobian
1367: .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction()
1369: @*/
1370: PetscErrorCode TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx)
1371: {
1373: SNES snes;
1374: DM dm;
1383: TSGetDM(ts,&dm);
1384: DMTSSetIJacobian(dm,f,ctx);
1386: TSGetSNES(ts,&snes);
1387: SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);
1388: return(0);
1389: }
1393: /*@
1394: TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating. Without this flag, TS will change the sign and
1395: shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute
1396: the entire Jacobian. The reuse flag must be set if the evaluation function will assume that the matrix entries have
1397: not been changed by the TS.
1399: Logically Collective
1401: Input Arguments:
1402: + ts - TS context obtained from TSCreate()
1403: - reuse - PETSC_TRUE if the RHS Jacobian
1405: Level: intermediate
1407: .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
1408: @*/
1409: PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse)
1410: {
1412: ts->rhsjacobian.reuse = reuse;
1413: return(0);
1414: }
1418: /*@C
1419: TSSetI2Function - Set the function to compute F(t,U,U_t,U_tt) where F = 0 is the DAE to be solved.
1421: Logically Collective on TS
1423: Input Parameters:
1424: + ts - the TS context obtained from TSCreate()
1425: . F - vector to hold the residual (or NULL to have it created internally)
1426: . fun - the function evaluation routine
1427: - ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1429: Calling sequence of fun:
1430: $ fun(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,Vec F,ctx);
1432: + t - time at step/stage being solved
1433: . U - state vector
1434: . U_t - time derivative of state vector
1435: . U_tt - second time derivative of state vector
1436: . F - function vector
1437: - ctx - [optional] user-defined context for matrix evaluation routine (may be NULL)
1439: Level: beginner
1441: .keywords: TS, timestep, set, ODE, DAE, Function
1443: .seealso: TSSetI2Jacobian()
1444: @*/
1445: PetscErrorCode TSSetI2Function(TS ts,Vec F,TSI2Function fun,void *ctx)
1446: {
1447: DM dm;
1453: TSSetIFunction(ts,F,NULL,NULL);
1454: TSGetDM(ts,&dm);
1455: DMTSSetI2Function(dm,fun,ctx);
1456: return(0);
1457: }
1461: /*@C
1462: TSGetI2Function - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1464: Not Collective
1466: Input Parameter:
1467: . ts - the TS context
1469: Output Parameter:
1470: + r - vector to hold residual (or NULL)
1471: . fun - the function to compute residual (or NULL)
1472: - ctx - the function context (or NULL)
1474: Level: advanced
1476: .keywords: TS, nonlinear, get, function
1478: .seealso: TSSetI2Function(), SNESGetFunction()
1479: @*/
1480: PetscErrorCode TSGetI2Function(TS ts,Vec *r,TSI2Function *fun,void **ctx)
1481: {
1483: SNES snes;
1484: DM dm;
1488: TSGetSNES(ts,&snes);
1489: SNESGetFunction(snes,r,NULL,NULL);
1490: TSGetDM(ts,&dm);
1491: DMTSGetI2Function(dm,fun,ctx);
1492: return(0);
1493: }
1497: /*@C
1498: TSSetI2Jacobian - Set the function to compute the matrix dF/dU + v*dF/dU_t + a*dF/dU_tt
1499: where F(t,U,U_t,U_tt) is the function you provided with TSSetI2Function().
1501: Logically Collective on TS
1503: Input Parameters:
1504: + ts - the TS context obtained from TSCreate()
1505: . J - Jacobian matrix
1506: . P - preconditioning matrix for J (may be same as J)
1507: . jac - the Jacobian evaluation routine
1508: - ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1510: Calling sequence of jac:
1511: $ jac(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,PetscReal v,PetscReal a,Mat J,Mat P,void *ctx);
1513: + t - time at step/stage being solved
1514: . U - state vector
1515: . U_t - time derivative of state vector
1516: . U_tt - second time derivative of state vector
1517: . v - shift for U_t
1518: . a - shift for U_tt
1519: . J - Jacobian of G(U) = F(t,U,W+v*U,W'+a*U), equivalent to dF/dU + v*dF/dU_t + a*dF/dU_tt
1520: . P - preconditioning matrix for J, may be same as J
1521: - ctx - [optional] user-defined context for matrix evaluation routine
1523: Notes:
1524: The matrices J and P are exactly the matrices that are used by SNES for the nonlinear solve.
1526: The matrix dF/dU + v*dF/dU_t + a*dF/dU_tt you provide turns out to be
1527: the Jacobian of G(U) = F(t,U,W+v*U,W'+a*U) where F(t,U,U_t,U_tt) = 0 is the DAE to be solved.
1528: The time integrator internally approximates U_t by W+v*U and U_tt by W'+a*U where the positive "shift"
1529: parameters 'v' and 'a' and vectors W, W' depend on the integration method, step size, and past states.
1531: Level: beginner
1533: .keywords: TS, timestep, set, ODE, DAE, Jacobian
1535: .seealso: TSSetI2Function()
1536: @*/
1537: PetscErrorCode TSSetI2Jacobian(TS ts,Mat J,Mat P,TSI2Jacobian jac,void *ctx)
1538: {
1539: DM dm;
1546: TSSetIJacobian(ts,J,P,NULL,NULL);
1547: TSGetDM(ts,&dm);
1548: DMTSSetI2Jacobian(dm,jac,ctx);
1549: return(0);
1550: }
1554: /*@C
1555: TSGetI2Jacobian - Returns the implicit Jacobian at the present timestep.
1557: Not Collective, but parallel objects are returned if TS is parallel
1559: Input Parameter:
1560: . ts - The TS context obtained from TSCreate()
1562: Output Parameters:
1563: + J - The (approximate) Jacobian of F(t,U,U_t,U_tt)
1564: . P - The matrix from which the preconditioner is constructed, often the same as J
1565: . jac - The function to compute the Jacobian matrices
1566: - ctx - User-defined context for Jacobian evaluation routine
1568: Notes: You can pass in NULL for any return argument you do not need.
1570: Level: advanced
1572: .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
1574: .keywords: TS, timestep, get, matrix, Jacobian
1575: @*/
1576: PetscErrorCode TSGetI2Jacobian(TS ts,Mat *J,Mat *P,TSI2Jacobian *jac,void **ctx)
1577: {
1579: SNES snes;
1580: DM dm;
1583: TSGetSNES(ts,&snes);
1584: SNESSetUpMatrices(snes);
1585: SNESGetJacobian(snes,J,P,NULL,NULL);
1586: TSGetDM(ts,&dm);
1587: DMTSGetI2Jacobian(dm,jac,ctx);
1588: return(0);
1589: }
1593: /*@
1594: TSComputeI2Function - Evaluates the DAE residual written in implicit form F(t,U,U_t,U_tt) = 0
1596: Collective on TS and Vec
1598: Input Parameters:
1599: + ts - the TS context
1600: . t - current time
1601: . U - state vector
1602: . V - time derivative of state vector (U_t)
1603: - A - second time derivative of state vector (U_tt)
1605: Output Parameter:
1606: . F - the residual vector
1608: Note:
1609: Most users should not need to explicitly call this routine, as it
1610: is used internally within the nonlinear solvers.
1612: Level: developer
1614: .keywords: TS, compute, function, vector
1616: .seealso: TSSetI2Function()
1617: @*/
1618: PetscErrorCode TSComputeI2Function(TS ts,PetscReal t,Vec U,Vec V,Vec A,Vec F)
1619: {
1620: DM dm;
1621: TSI2Function I2Function;
1622: void *ctx;
1623: TSRHSFunction rhsfunction;
1633: TSGetDM(ts,&dm);
1634: DMTSGetI2Function(dm,&I2Function,&ctx);
1635: DMTSGetRHSFunction(dm,&rhsfunction,NULL);
1637: if (!I2Function) {
1638: TSComputeIFunction(ts,t,U,A,F,PETSC_FALSE);
1639: return(0);
1640: }
1642: PetscLogEventBegin(TS_FunctionEval,ts,U,V,F);
1644: PetscStackPush("TS user implicit function");
1645: I2Function(ts,t,U,V,A,F,ctx);
1646: PetscStackPop;
1648: if (rhsfunction) {
1649: Vec Frhs;
1650: TSGetRHSVec_Private(ts,&Frhs);
1651: TSComputeRHSFunction(ts,t,U,Frhs);
1652: VecAXPY(F,-1,Frhs);
1653: }
1655: PetscLogEventEnd(TS_FunctionEval,ts,U,V,F);
1656: return(0);
1657: }
1661: /*@
1662: TSComputeI2Jacobian - Evaluates the Jacobian of the DAE
1664: Collective on TS and Vec
1666: Input Parameters:
1667: + ts - the TS context
1668: . t - current timestep
1669: . U - state vector
1670: . V - time derivative of state vector
1671: . A - second time derivative of state vector
1672: . shiftV - shift to apply, see note below
1673: - shiftA - shift to apply, see note below
1675: Output Parameters:
1676: + J - Jacobian matrix
1677: - P - optional preconditioning matrix
1679: Notes:
1680: If F(t,U,V,A)=0 is the DAE, the required Jacobian is
1682: dF/dU + shiftV*dF/dV + shiftA*dF/dA
1684: Most users should not need to explicitly call this routine, as it
1685: is used internally within the nonlinear solvers.
1687: Level: developer
1689: .keywords: TS, compute, Jacobian, matrix
1691: .seealso: TSSetI2Jacobian()
1692: @*/
1693: PetscErrorCode TSComputeI2Jacobian(TS ts,PetscReal t,Vec U,Vec V,Vec A,PetscReal shiftV,PetscReal shiftA,Mat J,Mat P)
1694: {
1695: DM dm;
1696: TSI2Jacobian I2Jacobian;
1697: void *ctx;
1698: TSRHSJacobian rhsjacobian;
1709: TSGetDM(ts,&dm);
1710: DMTSGetI2Jacobian(dm,&I2Jacobian,&ctx);
1711: DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);
1713: if (!I2Jacobian) {
1714: TSComputeIJacobian(ts,t,U,A,shiftA,J,P,PETSC_FALSE);
1715: return(0);
1716: }
1718: PetscLogEventBegin(TS_JacobianEval,ts,U,J,P);
1720: PetscStackPush("TS user implicit Jacobian");
1721: I2Jacobian(ts,t,U,V,A,shiftV,shiftA,J,P,ctx);
1722: PetscStackPop;
1724: if (rhsjacobian) {
1725: Mat Jrhs,Prhs; MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
1726: TSGetRHSMats_Private(ts,&Jrhs,&Prhs);
1727: TSComputeRHSJacobian(ts,t,U,Jrhs,Prhs);
1728: MatAXPY(J,-1,Jrhs,axpy);
1729: if (P != J) {MatAXPY(P,-1,Prhs,axpy);}
1730: }
1732: PetscLogEventEnd(TS_JacobianEval,ts,U,J,P);
1733: return(0);
1734: }
1738: /*@
1739: TS2SetSolution - Sets the initial solution and time derivative vectors
1740: for use by the TS routines handling second order equations.
1742: Logically Collective on TS and Vec
1744: Input Parameters:
1745: + ts - the TS context obtained from TSCreate()
1746: . u - the solution vector
1747: - v - the time derivative vector
1749: Level: beginner
1751: .keywords: TS, timestep, set, solution, initial conditions
1752: @*/
1753: PetscErrorCode TS2SetSolution(TS ts,Vec u,Vec v)
1754: {
1761: TSSetSolution(ts,u);
1762: PetscObjectReference((PetscObject)v);
1763: VecDestroy(&ts->vec_dot);
1764: ts->vec_dot = v;
1765: return(0);
1766: }
1770: /*@
1771: TS2GetSolution - Returns the solution and time derivative at the present timestep
1772: for second order equations. It is valid to call this routine inside the function
1773: that you are evaluating in order to move to the new timestep. This vector not
1774: changed until the solution at the next timestep has been calculated.
1776: Not Collective, but Vec returned is parallel if TS is parallel
1778: Input Parameter:
1779: . ts - the TS context obtained from TSCreate()
1781: Output Parameter:
1782: + u - the vector containing the solution
1783: - v - the vector containing the time derivative
1785: Level: intermediate
1787: .seealso: TS2SetSolution(), TSGetTimeStep(), TSGetTime()
1789: .keywords: TS, timestep, get, solution
1790: @*/
1791: PetscErrorCode TS2GetSolution(TS ts,Vec *u,Vec *v)
1792: {
1797: if (u) *u = ts->vec_sol;
1798: if (v) *v = ts->vec_dot;
1799: return(0);
1800: }
1804: /*@C
1805: TSLoad - Loads a KSP that has been stored in binary with KSPView().
1807: Collective on PetscViewer
1809: Input Parameters:
1810: + newdm - the newly loaded TS, this needs to have been created with TSCreate() or
1811: some related function before a call to TSLoad().
1812: - viewer - binary file viewer, obtained from PetscViewerBinaryOpen()
1814: Level: intermediate
1816: Notes:
1817: The type is determined by the data in the file, any type set into the TS before this call is ignored.
1819: Notes for advanced users:
1820: Most users should not need to know the details of the binary storage
1821: format, since TSLoad() and TSView() completely hide these details.
1822: But for anyone who's interested, the standard binary matrix storage
1823: format is
1824: .vb
1825: has not yet been determined
1826: .ve
1828: .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad()
1829: @*/
1830: PetscErrorCode TSLoad(TS ts, PetscViewer viewer)
1831: {
1833: PetscBool isbinary;
1834: PetscInt classid;
1835: char type[256];
1836: DMTS sdm;
1837: DM dm;
1842: PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);
1843: if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
1845: PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);
1846: if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file");
1847: PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);
1848: TSSetType(ts, type);
1849: if (ts->ops->load) {
1850: (*ts->ops->load)(ts,viewer);
1851: }
1852: DMCreate(PetscObjectComm((PetscObject)ts),&dm);
1853: DMLoad(dm,viewer);
1854: TSSetDM(ts,dm);
1855: DMCreateGlobalVector(ts->dm,&ts->vec_sol);
1856: VecLoad(ts->vec_sol,viewer);
1857: DMGetDMTS(ts->dm,&sdm);
1858: DMTSLoad(sdm,viewer);
1859: return(0);
1860: }
1862: #include <petscdraw.h>
1863: #if defined(PETSC_HAVE_SAWS)
1864: #include <petscviewersaws.h>
1865: #endif
1868: /*@C
1869: TSView - Prints the TS data structure.
1871: Collective on TS
1873: Input Parameters:
1874: + ts - the TS context obtained from TSCreate()
1875: - viewer - visualization context
1877: Options Database Key:
1878: . -ts_view - calls TSView() at end of TSStep()
1880: Notes:
1881: The available visualization contexts include
1882: + PETSC_VIEWER_STDOUT_SELF - standard output (default)
1883: - PETSC_VIEWER_STDOUT_WORLD - synchronized standard
1884: output where only the first processor opens
1885: the file. All other processors send their
1886: data to the first processor to print.
1888: The user can open an alternative visualization context with
1889: PetscViewerASCIIOpen() - output to a specified file.
1891: Level: beginner
1893: .keywords: TS, timestep, view
1895: .seealso: PetscViewerASCIIOpen()
1896: @*/
1897: PetscErrorCode TSView(TS ts,PetscViewer viewer)
1898: {
1900: TSType type;
1901: PetscBool iascii,isstring,isundials,isbinary,isdraw;
1902: DMTS sdm;
1903: #if defined(PETSC_HAVE_SAWS)
1904: PetscBool issaws;
1905: #endif
1909: if (!viewer) {
1910: PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);
1911: }
1915: PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);
1916: PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);
1917: PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);
1918: PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);
1919: #if defined(PETSC_HAVE_SAWS)
1920: PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);
1921: #endif
1922: if (iascii) {
1923: PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);
1924: PetscViewerASCIIPrintf(viewer," maximum steps=%D\n",ts->max_steps);
1925: PetscViewerASCIIPrintf(viewer," maximum time=%g\n",(double)ts->max_time);
1926: if (ts->problem_type == TS_NONLINEAR) {
1927: PetscViewerASCIIPrintf(viewer," total number of nonlinear solver iterations=%D\n",ts->snes_its);
1928: PetscViewerASCIIPrintf(viewer," total number of nonlinear solve failures=%D\n",ts->num_snes_failures);
1929: }
1930: PetscViewerASCIIPrintf(viewer," total number of linear solver iterations=%D\n",ts->ksp_its);
1931: PetscViewerASCIIPrintf(viewer," total number of rejected steps=%D\n",ts->reject);
1932: DMGetDMTS(ts->dm,&sdm);
1933: DMTSView(sdm,viewer);
1934: if (ts->ops->view) {
1935: PetscViewerASCIIPushTab(viewer);
1936: (*ts->ops->view)(ts,viewer);
1937: PetscViewerASCIIPopTab(viewer);
1938: }
1939: } else if (isstring) {
1940: TSGetType(ts,&type);
1941: PetscViewerStringSPrintf(viewer," %-7.7s",type);
1942: } else if (isbinary) {
1943: PetscInt classid = TS_FILE_CLASSID;
1944: MPI_Comm comm;
1945: PetscMPIInt rank;
1946: char type[256];
1948: PetscObjectGetComm((PetscObject)ts,&comm);
1949: MPI_Comm_rank(comm,&rank);
1950: if (!rank) {
1951: PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);
1952: PetscStrncpy(type,((PetscObject)ts)->type_name,256);
1953: PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);
1954: }
1955: if (ts->ops->view) {
1956: (*ts->ops->view)(ts,viewer);
1957: }
1958: DMView(ts->dm,viewer);
1959: VecView(ts->vec_sol,viewer);
1960: DMGetDMTS(ts->dm,&sdm);
1961: DMTSView(sdm,viewer);
1962: } else if (isdraw) {
1963: PetscDraw draw;
1964: char str[36];
1965: PetscReal x,y,bottom,h;
1967: PetscViewerDrawGetDraw(viewer,0,&draw);
1968: PetscDrawGetCurrentPoint(draw,&x,&y);
1969: PetscStrcpy(str,"TS: ");
1970: PetscStrcat(str,((PetscObject)ts)->type_name);
1971: PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);
1972: bottom = y - h;
1973: PetscDrawPushCurrentPoint(draw,x,bottom);
1974: if (ts->ops->view) {
1975: (*ts->ops->view)(ts,viewer);
1976: }
1977: PetscDrawPopCurrentPoint(draw);
1978: #if defined(PETSC_HAVE_SAWS)
1979: } else if (issaws) {
1980: PetscMPIInt rank;
1981: const char *name;
1983: PetscObjectGetName((PetscObject)ts,&name);
1984: MPI_Comm_rank(PETSC_COMM_WORLD,&rank);
1985: if (!((PetscObject)ts)->amsmem && !rank) {
1986: char dir[1024];
1988: PetscObjectViewSAWs((PetscObject)ts,viewer);
1989: PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);
1990: PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT));
1991: PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);
1992: PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE));
1993: }
1994: if (ts->ops->view) {
1995: (*ts->ops->view)(ts,viewer);
1996: }
1997: #endif
1998: }
2000: PetscViewerASCIIPushTab(viewer);
2001: PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);
2002: PetscViewerASCIIPopTab(viewer);
2003: return(0);
2004: }
2009: /*@
2010: TSSetApplicationContext - Sets an optional user-defined context for
2011: the timesteppers.
2013: Logically Collective on TS
2015: Input Parameters:
2016: + ts - the TS context obtained from TSCreate()
2017: - usrP - optional user context
2019: Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this
2020: function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
2022: Level: intermediate
2024: .keywords: TS, timestep, set, application, context
2026: .seealso: TSGetApplicationContext()
2027: @*/
2028: PetscErrorCode TSSetApplicationContext(TS ts,void *usrP)
2029: {
2032: ts->user = usrP;
2033: return(0);
2034: }
2038: /*@
2039: TSGetApplicationContext - Gets the user-defined context for the
2040: timestepper.
2042: Not Collective
2044: Input Parameter:
2045: . ts - the TS context obtained from TSCreate()
2047: Output Parameter:
2048: . usrP - user context
2050: Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this
2051: function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
2053: Level: intermediate
2055: .keywords: TS, timestep, get, application, context
2057: .seealso: TSSetApplicationContext()
2058: @*/
2059: PetscErrorCode TSGetApplicationContext(TS ts,void *usrP)
2060: {
2063: *(void**)usrP = ts->user;
2064: return(0);
2065: }
2069: /*@
2070: TSGetTimeStepNumber - Gets the number of time steps completed.
2072: Not Collective
2074: Input Parameter:
2075: . ts - the TS context obtained from TSCreate()
2077: Output Parameter:
2078: . iter - number of steps completed so far
2080: Level: intermediate
2082: .keywords: TS, timestep, get, iteration, number
2083: .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep()
2084: @*/
2085: PetscErrorCode TSGetTimeStepNumber(TS ts,PetscInt *iter)
2086: {
2090: *iter = ts->steps;
2091: return(0);
2092: }
2096: /*@
2097: TSSetInitialTimeStep - Sets the initial timestep to be used,
2098: as well as the initial time.
2100: Logically Collective on TS
2102: Input Parameters:
2103: + ts - the TS context obtained from TSCreate()
2104: . initial_time - the initial time
2105: - time_step - the size of the timestep
2107: Level: intermediate
2109: .seealso: TSSetTimeStep(), TSGetTimeStep()
2111: .keywords: TS, set, initial, timestep
2112: @*/
2113: PetscErrorCode TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step)
2114: {
2119: TSSetTimeStep(ts,time_step);
2120: TSSetTime(ts,initial_time);
2121: return(0);
2122: }
2126: /*@
2127: TSSetTimeStep - Allows one to reset the timestep at any time,
2128: useful for simple pseudo-timestepping codes.
2130: Logically Collective on TS
2132: Input Parameters:
2133: + ts - the TS context obtained from TSCreate()
2134: - time_step - the size of the timestep
2136: Level: intermediate
2138: .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
2140: .keywords: TS, set, timestep
2141: @*/
2142: PetscErrorCode TSSetTimeStep(TS ts,PetscReal time_step)
2143: {
2147: ts->time_step = time_step;
2148: return(0);
2149: }
2153: /*@
2154: TSSetExactFinalTime - Determines whether to adapt the final time step to
2155: match the exact final time, interpolate solution to the exact final time,
2156: or just return at the final time TS computed.
2158: Logically Collective on TS
2160: Input Parameter:
2161: + ts - the time-step context
2162: - eftopt - exact final time option
2164: $ TS_EXACTFINALTIME_STEPOVER - Don't do anything if final time is exceeded
2165: $ TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time
2166: $ TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time
2168: Options Database:
2169: . -ts_exact_final_time <stepover,interpolate,matchstep> - select the final step at runtime
2171: Warning: If you use the option TS_EXACTFINALTIME_STEPOVER the solution may be at a very different time
2172: then the final time you selected.
2174: Level: beginner
2176: .seealso: TSExactFinalTimeOption
2177: @*/
2178: PetscErrorCode TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt)
2179: {
2183: ts->exact_final_time = eftopt;
2184: return(0);
2185: }
2189: /*@
2190: TSGetTimeStep - Gets the current timestep size.
2192: Not Collective
2194: Input Parameter:
2195: . ts - the TS context obtained from TSCreate()
2197: Output Parameter:
2198: . dt - the current timestep size
2200: Level: intermediate
2202: .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
2204: .keywords: TS, get, timestep
2205: @*/
2206: PetscErrorCode TSGetTimeStep(TS ts,PetscReal *dt)
2207: {
2211: *dt = ts->time_step;
2212: return(0);
2213: }
2217: /*@
2218: TSGetSolution - Returns the solution at the present timestep. It
2219: is valid to call this routine inside the function that you are evaluating
2220: in order to move to the new timestep. This vector not changed until
2221: the solution at the next timestep has been calculated.
2223: Not Collective, but Vec returned is parallel if TS is parallel
2225: Input Parameter:
2226: . ts - the TS context obtained from TSCreate()
2228: Output Parameter:
2229: . v - the vector containing the solution
2231: Note: If you used TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP); this does not return the solution at the requested
2232: final time. It returns the solution at the next timestep.
2234: Level: intermediate
2236: .seealso: TSGetTimeStep(), TSGetTime(), TSGetSolveTime()
2238: .keywords: TS, timestep, get, solution
2239: @*/
2240: PetscErrorCode TSGetSolution(TS ts,Vec *v)
2241: {
2245: *v = ts->vec_sol;
2246: return(0);
2247: }
2251: /*@
2252: TSGetCostGradients - Returns the gradients from the TSAdjointSolve()
2254: Not Collective, but Vec returned is parallel if TS is parallel
2256: Input Parameter:
2257: . ts - the TS context obtained from TSCreate()
2259: Output Parameter:
2260: + lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables
2261: - mu - vectors containing the gradients of the cost functions with respect to the problem parameters
2263: Level: intermediate
2265: .seealso: TSGetTimeStep()
2267: .keywords: TS, timestep, get, sensitivity
2268: @*/
2269: PetscErrorCode TSGetCostGradients(TS ts,PetscInt *numcost,Vec **lambda,Vec **mu)
2270: {
2273: if (numcost) *numcost = ts->numcost;
2274: if (lambda) *lambda = ts->vecs_sensi;
2275: if (mu) *mu = ts->vecs_sensip;
2276: return(0);
2277: }
2279: /* ----- Routines to initialize and destroy a timestepper ---- */
2282: /*@
2283: TSSetProblemType - Sets the type of problem to be solved.
2285: Not collective
2287: Input Parameters:
2288: + ts - The TS
2289: - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
2290: .vb
2291: U_t - A U = 0 (linear)
2292: U_t - A(t) U = 0 (linear)
2293: F(t,U,U_t) = 0 (nonlinear)
2294: .ve
2296: Level: beginner
2298: .keywords: TS, problem type
2299: .seealso: TSSetUp(), TSProblemType, TS
2300: @*/
2301: PetscErrorCode TSSetProblemType(TS ts, TSProblemType type)
2302: {
2307: ts->problem_type = type;
2308: if (type == TS_LINEAR) {
2309: SNES snes;
2310: TSGetSNES(ts,&snes);
2311: SNESSetType(snes,SNESKSPONLY);
2312: }
2313: return(0);
2314: }
2318: /*@C
2319: TSGetProblemType - Gets the type of problem to be solved.
2321: Not collective
2323: Input Parameter:
2324: . ts - The TS
2326: Output Parameter:
2327: . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
2328: .vb
2329: M U_t = A U
2330: M(t) U_t = A(t) U
2331: F(t,U,U_t)
2332: .ve
2334: Level: beginner
2336: .keywords: TS, problem type
2337: .seealso: TSSetUp(), TSProblemType, TS
2338: @*/
2339: PetscErrorCode TSGetProblemType(TS ts, TSProblemType *type)
2340: {
2344: *type = ts->problem_type;
2345: return(0);
2346: }
2350: /*@
2351: TSSetUp - Sets up the internal data structures for the later use
2352: of a timestepper.
2354: Collective on TS
2356: Input Parameter:
2357: . ts - the TS context obtained from TSCreate()
2359: Notes:
2360: For basic use of the TS solvers the user need not explicitly call
2361: TSSetUp(), since these actions will automatically occur during
2362: the call to TSStep(). However, if one wishes to control this
2363: phase separately, TSSetUp() should be called after TSCreate()
2364: and optional routines of the form TSSetXXX(), but before TSStep().
2366: Level: advanced
2368: .keywords: TS, timestep, setup
2370: .seealso: TSCreate(), TSStep(), TSDestroy()
2371: @*/
2372: PetscErrorCode TSSetUp(TS ts)
2373: {
2375: DM dm;
2376: PetscErrorCode (*func)(SNES,Vec,Vec,void*);
2377: PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*);
2378: TSIFunction ifun;
2379: TSIJacobian ijac;
2380: TSI2Jacobian i2jac;
2381: TSRHSJacobian rhsjac;
2385: if (ts->setupcalled) return(0);
2387: ts->total_steps = 0;
2388: if (!((PetscObject)ts)->type_name) {
2389: TSGetIFunction(ts,NULL,&ifun,NULL);
2390: TSSetType(ts,ifun ? TSBEULER : TSEULER);
2391: }
2393: if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first");
2395: if (ts->rhsjacobian.reuse) {
2396: Mat Amat,Pmat;
2397: SNES snes;
2398: TSGetSNES(ts,&snes);
2399: SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);
2400: /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would
2401: * have displaced the RHS matrix */
2402: if (Amat == ts->Arhs) {
2403: MatDuplicate(ts->Arhs,MAT_DO_NOT_COPY_VALUES,&Amat);
2404: SNESSetJacobian(snes,Amat,NULL,NULL,NULL);
2405: MatDestroy(&Amat);
2406: }
2407: if (Pmat == ts->Brhs) {
2408: MatDuplicate(ts->Brhs,MAT_DO_NOT_COPY_VALUES,&Pmat);
2409: SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);
2410: MatDestroy(&Pmat);
2411: }
2412: }
2413: if (ts->ops->setup) {
2414: (*ts->ops->setup)(ts);
2415: }
2417: /* In the case where we've set a DMTSFunction or what have you, we need the default SNESFunction
2418: to be set right but can't do it elsewhere due to the overreliance on ctx=ts.
2419: */
2420: TSGetDM(ts,&dm);
2421: DMSNESGetFunction(dm,&func,NULL);
2422: if (!func) {
2423: DMSNESSetFunction(dm,SNESTSFormFunction,ts);
2424: }
2425: /* If the SNES doesn't have a jacobian set and the TS has an ijacobian or rhsjacobian set, set the SNES to use it.
2426: Otherwise, the SNES will use coloring internally to form the Jacobian.
2427: */
2428: DMSNESGetJacobian(dm,&jac,NULL);
2429: DMTSGetIJacobian(dm,&ijac,NULL);
2430: DMTSGetI2Jacobian(dm,&i2jac,NULL);
2431: DMTSGetRHSJacobian(dm,&rhsjac,NULL);
2432: if (!jac && (ijac || i2jac || rhsjac)) {
2433: DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);
2434: }
2435: ts->setupcalled = PETSC_TRUE;
2436: return(0);
2437: }
2441: /*@
2442: TSAdjointSetUp - Sets up the internal data structures for the later use
2443: of an adjoint solver
2445: Collective on TS
2447: Input Parameter:
2448: . ts - the TS context obtained from TSCreate()
2450: Level: advanced
2452: .keywords: TS, timestep, setup
2454: .seealso: TSCreate(), TSAdjointStep(), TSSetCostGradients()
2455: @*/
2456: PetscErrorCode TSAdjointSetUp(TS ts)
2457: {
2462: if (ts->adjointsetupcalled) return(0);
2463: if (!ts->vecs_sensi) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetCostGradients() first");
2465: if (ts->vec_costintegral) { /* if there is integral in the cost function*/
2466: VecDuplicateVecs(ts->vecs_sensi[0],ts->numcost,&ts->vecs_drdy);
2467: if (ts->vecs_sensip){
2468: VecDuplicateVecs(ts->vecs_sensip[0],ts->numcost,&ts->vecs_drdp);
2469: }
2470: }
2472: if (ts->ops->adjointsetup) {
2473: (*ts->ops->adjointsetup)(ts);
2474: }
2475: ts->adjointsetupcalled = PETSC_TRUE;
2476: return(0);
2477: }
2481: /*@
2482: TSReset - Resets a TS context and removes any allocated Vecs and Mats.
2484: Collective on TS
2486: Input Parameter:
2487: . ts - the TS context obtained from TSCreate()
2489: Level: beginner
2491: .keywords: TS, timestep, reset
2493: .seealso: TSCreate(), TSSetup(), TSDestroy()
2494: @*/
2495: PetscErrorCode TSReset(TS ts)
2496: {
2502: if (ts->ops->reset) {
2503: (*ts->ops->reset)(ts);
2504: }
2505: if (ts->snes) {SNESReset(ts->snes);}
2506: if (ts->adapt) {TSAdaptReset(ts->adapt);}
2508: MatDestroy(&ts->Arhs);
2509: MatDestroy(&ts->Brhs);
2510: VecDestroy(&ts->Frhs);
2511: VecDestroy(&ts->vec_sol);
2512: VecDestroy(&ts->vec_dot);
2513: VecDestroy(&ts->vatol);
2514: VecDestroy(&ts->vrtol);
2515: VecDestroyVecs(ts->nwork,&ts->work);
2517: if (ts->vec_costintegral) {
2518: VecDestroyVecs(ts->numcost,&ts->vecs_drdy);
2519: if (ts->vecs_drdp){
2520: VecDestroyVecs(ts->numcost,&ts->vecs_drdp);
2521: }
2522: }
2523: ts->vecs_sensi = NULL;
2524: ts->vecs_sensip = NULL;
2525: MatDestroy(&ts->Jacp);
2526: VecDestroy(&ts->vec_costintegral);
2527: VecDestroy(&ts->vec_costintegrand);
2528: ts->setupcalled = PETSC_FALSE;
2529: return(0);
2530: }
2534: /*@
2535: TSDestroy - Destroys the timestepper context that was created
2536: with TSCreate().
2538: Collective on TS
2540: Input Parameter:
2541: . ts - the TS context obtained from TSCreate()
2543: Level: beginner
2545: .keywords: TS, timestepper, destroy
2547: .seealso: TSCreate(), TSSetUp(), TSSolve()
2548: @*/
2549: PetscErrorCode TSDestroy(TS *ts)
2550: {
2554: if (!*ts) return(0);
2556: if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; return(0);}
2558: TSReset((*ts));
2560: /* if memory was published with SAWs then destroy it */
2561: PetscObjectSAWsViewOff((PetscObject)*ts);
2562: if ((*ts)->ops->destroy) {(*(*ts)->ops->destroy)((*ts));}
2564: TSTrajectoryDestroy(&(*ts)->trajectory);
2566: TSAdaptDestroy(&(*ts)->adapt);
2567: TSEventDestroy(&(*ts)->event);
2569: SNESDestroy(&(*ts)->snes);
2570: DMDestroy(&(*ts)->dm);
2571: TSMonitorCancel((*ts));
2572: TSAdjointMonitorCancel((*ts));
2574: PetscHeaderDestroy(ts);
2575: return(0);
2576: }
2580: /*@
2581: TSGetSNES - Returns the SNES (nonlinear solver) associated with
2582: a TS (timestepper) context. Valid only for nonlinear problems.
2584: Not Collective, but SNES is parallel if TS is parallel
2586: Input Parameter:
2587: . ts - the TS context obtained from TSCreate()
2589: Output Parameter:
2590: . snes - the nonlinear solver context
2592: Notes:
2593: The user can then directly manipulate the SNES context to set various
2594: options, etc. Likewise, the user can then extract and manipulate the
2595: KSP, KSP, and PC contexts as well.
2597: TSGetSNES() does not work for integrators that do not use SNES; in
2598: this case TSGetSNES() returns NULL in snes.
2600: Level: beginner
2602: .keywords: timestep, get, SNES
2603: @*/
2604: PetscErrorCode TSGetSNES(TS ts,SNES *snes)
2605: {
2611: if (!ts->snes) {
2612: SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);
2613: SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);
2614: PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);
2615: PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);
2616: if (ts->dm) {SNESSetDM(ts->snes,ts->dm);}
2617: if (ts->problem_type == TS_LINEAR) {
2618: SNESSetType(ts->snes,SNESKSPONLY);
2619: }
2620: }
2621: *snes = ts->snes;
2622: return(0);
2623: }
2627: /*@
2628: TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context
2630: Collective
2632: Input Parameter:
2633: + ts - the TS context obtained from TSCreate()
2634: - snes - the nonlinear solver context
2636: Notes:
2637: Most users should have the TS created by calling TSGetSNES()
2639: Level: developer
2641: .keywords: timestep, set, SNES
2642: @*/
2643: PetscErrorCode TSSetSNES(TS ts,SNES snes)
2644: {
2646: PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*);
2651: PetscObjectReference((PetscObject)snes);
2652: SNESDestroy(&ts->snes);
2654: ts->snes = snes;
2656: SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);
2657: SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);
2658: if (func == SNESTSFormJacobian) {
2659: SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);
2660: }
2661: return(0);
2662: }
2666: /*@
2667: TSGetKSP - Returns the KSP (linear solver) associated with
2668: a TS (timestepper) context.
2670: Not Collective, but KSP is parallel if TS is parallel
2672: Input Parameter:
2673: . ts - the TS context obtained from TSCreate()
2675: Output Parameter:
2676: . ksp - the nonlinear solver context
2678: Notes:
2679: The user can then directly manipulate the KSP context to set various
2680: options, etc. Likewise, the user can then extract and manipulate the
2681: KSP and PC contexts as well.
2683: TSGetKSP() does not work for integrators that do not use KSP;
2684: in this case TSGetKSP() returns NULL in ksp.
2686: Level: beginner
2688: .keywords: timestep, get, KSP
2689: @*/
2690: PetscErrorCode TSGetKSP(TS ts,KSP *ksp)
2691: {
2693: SNES snes;
2698: if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first");
2699: if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()");
2700: TSGetSNES(ts,&snes);
2701: SNESGetKSP(snes,ksp);
2702: return(0);
2703: }
2705: /* ----------- Routines to set solver parameters ---------- */
2709: /*@
2710: TSGetDuration - Gets the maximum number of timesteps to use and
2711: maximum time for iteration.
2713: Not Collective
2715: Input Parameters:
2716: + ts - the TS context obtained from TSCreate()
2717: . maxsteps - maximum number of iterations to use, or NULL
2718: - maxtime - final time to iterate to, or NULL
2720: Level: intermediate
2722: .keywords: TS, timestep, get, maximum, iterations, time
2723: @*/
2724: PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
2725: {
2728: if (maxsteps) {
2730: *maxsteps = ts->max_steps;
2731: }
2732: if (maxtime) {
2734: *maxtime = ts->max_time;
2735: }
2736: return(0);
2737: }
2741: /*@
2742: TSSetDuration - Sets the maximum number of timesteps to use and
2743: maximum time for iteration.
2745: Logically Collective on TS
2747: Input Parameters:
2748: + ts - the TS context obtained from TSCreate()
2749: . maxsteps - maximum number of iterations to use
2750: - maxtime - final time to iterate to
2752: Options Database Keys:
2753: . -ts_max_steps <maxsteps> - Sets maxsteps
2754: . -ts_final_time <maxtime> - Sets maxtime
2756: Notes:
2757: The default maximum number of iterations is 5000. Default time is 5.0
2759: Level: intermediate
2761: .keywords: TS, timestep, set, maximum, iterations
2763: .seealso: TSSetExactFinalTime()
2764: @*/
2765: PetscErrorCode TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
2766: {
2771: if (maxsteps >= 0) ts->max_steps = maxsteps;
2772: if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime;
2773: return(0);
2774: }
2778: /*@
2779: TSSetSolution - Sets the initial solution vector
2780: for use by the TS routines.
2782: Logically Collective on TS and Vec
2784: Input Parameters:
2785: + ts - the TS context obtained from TSCreate()
2786: - u - the solution vector
2788: Level: beginner
2790: .keywords: TS, timestep, set, solution, initial conditions
2791: @*/
2792: PetscErrorCode TSSetSolution(TS ts,Vec u)
2793: {
2795: DM dm;
2800: PetscObjectReference((PetscObject)u);
2801: VecDestroy(&ts->vec_sol);
2802: ts->vec_sol = u;
2804: TSGetDM(ts,&dm);
2805: DMShellSetGlobalVector(dm,u);
2806: return(0);
2807: }
2811: /*@
2812: TSAdjointSetSteps - Sets the number of steps the adjoint solver should take backward in time
2814: Logically Collective on TS
2816: Input Parameters:
2817: + ts - the TS context obtained from TSCreate()
2818: . steps - number of steps to use
2820: Level: intermediate
2822: Notes: Normally one does not call this and TSAdjointSolve() integrates back to the original timestep. One can call this
2823: so as to integrate back to less than the original timestep
2825: .keywords: TS, timestep, set, maximum, iterations
2827: .seealso: TSSetExactFinalTime()
2828: @*/
2829: PetscErrorCode TSAdjointSetSteps(TS ts,PetscInt steps)
2830: {
2834: if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back a negative number of steps");
2835: if (steps > ts->total_steps) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back more than the total number of forward steps");
2836: ts->adjoint_max_steps = steps;
2837: return(0);
2838: }
2842: /*@
2843: TSSetCostGradients - Sets the initial value of the gradients of the cost function w.r.t. initial conditions and w.r.t. the problem parameters
2844: for use by the TSAdjoint routines.
2846: Logically Collective on TS and Vec
2848: Input Parameters:
2849: + ts - the TS context obtained from TSCreate()
2850: . 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
2851: - mu - gradients with respect to the parameters, the number of entries in these vectors is the same as the number of parameters
2853: Level: beginner
2855: Notes: the entries in these vectors must be correctly initialized with the values lamda_i = df/dy|finaltime mu_i = df/dp|finaltime
2857: .keywords: TS, timestep, set, sensitivity, initial conditions
2858: @*/
2859: PetscErrorCode TSSetCostGradients(TS ts,PetscInt numcost,Vec *lambda,Vec *mu)
2860: {
2864: ts->vecs_sensi = lambda;
2865: ts->vecs_sensip = mu;
2866: 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");
2867: ts->numcost = numcost;
2868: return(0);
2869: }
2873: /*@C
2874: 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.
2876: Logically Collective on TS
2878: Input Parameters:
2879: + ts - The TS context obtained from TSCreate()
2880: - func - The function
2882: Calling sequence of func:
2883: $ func (TS ts,PetscReal t,Vec y,Mat A,void *ctx);
2884: + t - current timestep
2885: . y - input vector (current ODE solution)
2886: . A - output matrix
2887: - ctx - [optional] user-defined function context
2889: Level: intermediate
2891: 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
2893: .keywords: TS, sensitivity
2894: .seealso:
2895: @*/
2896: PetscErrorCode TSAdjointSetRHSJacobian(TS ts,Mat Amat,PetscErrorCode (*func)(TS,PetscReal,Vec,Mat,void*),void *ctx)
2897: {
2904: ts->rhsjacobianp = func;
2905: ts->rhsjacobianpctx = ctx;
2906: if(Amat) {
2907: PetscObjectReference((PetscObject)Amat);
2908: MatDestroy(&ts->Jacp);
2909: ts->Jacp = Amat;
2910: }
2911: return(0);
2912: }
2916: /*@C
2917: TSAdjointComputeRHSJacobian - Runs the user-defined Jacobian function.
2919: Collective on TS
2921: Input Parameters:
2922: . ts - The TS context obtained from TSCreate()
2924: Level: developer
2926: .keywords: TS, sensitivity
2927: .seealso: TSAdjointSetRHSJacobian()
2928: @*/
2929: PetscErrorCode TSAdjointComputeRHSJacobian(TS ts,PetscReal t,Vec X,Mat Amat)
2930: {
2938: PetscStackPush("TS user JacobianP function for sensitivity analysis");
2939: (*ts->rhsjacobianp)(ts,t,X,Amat,ts->rhsjacobianpctx);
2940: PetscStackPop;
2941: return(0);
2942: }
2946: /*@C
2947: TSSetCostIntegrand - Sets the routine for evaluating the integral term in one or more cost functions
2949: Logically Collective on TS
2951: Input Parameters:
2952: + ts - the TS context obtained from TSCreate()
2953: . numcost - number of gradients to be computed, this is the number of cost functions
2954: . rf - routine for evaluating the integrand function
2955: . drdyf - function that computes the gradients of the r's with respect to y,NULL if not a function y
2956: . drdpf - function that computes the gradients of the r's with respect to p, NULL if not a function of p
2957: . fwd ï¼ flag indicating whether to evaluate cost integral in the forward run or the adjoint run
2958: - ctx - [optional] user-defined context for private data for the function evaluation routine (may be NULL)
2960: Calling sequence of rf:
2961: $ rf(TS ts,PetscReal t,Vec y,Vec f[],void *ctx);
2963: + t - current timestep
2964: . y - input vector
2965: . f - function result; one vector entry for each cost function
2966: - ctx - [optional] user-defined function context
2968: Calling sequence of drdyf:
2969: $ PetscErroCode drdyf(TS ts,PetscReal t,Vec y,Vec *drdy,void *ctx);
2971: Calling sequence of drdpf:
2972: $ PetscErroCode drdpf(TS ts,PetscReal t,Vec y,Vec *drdp,void *ctx);
2974: Level: intermediate
2976: Notes: For optimization there is generally a single cost function, numcost = 1. For sensitivities there may be multiple cost functions
2978: .keywords: TS, sensitivity analysis, timestep, set, quadrature, function
2980: .seealso: TSAdjointSetRHSJacobian(),TSGetCostGradients(), TSSetCostGradients()
2981: @*/
2982: PetscErrorCode TSSetCostIntegrand(TS ts,PetscInt numcost,PetscErrorCode (*rf)(TS,PetscReal,Vec,Vec,void*),
2983: PetscErrorCode (*drdyf)(TS,PetscReal,Vec,Vec*,void*),
2984: PetscErrorCode (*drdpf)(TS,PetscReal,Vec,Vec*,void*),
2985: PetscBool fwd,void *ctx)
2986: {
2991: 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()");
2992: if (!ts->numcost) ts->numcost=numcost;
2994: ts->costintegralfwd = fwd; /* Evaluate the cost integral in forward run if fwd is true */
2995: VecCreateSeq(PETSC_COMM_SELF,numcost,&ts->vec_costintegral);
2996: VecDuplicate(ts->vec_costintegral,&ts->vec_costintegrand);
2997: ts->costintegrand = rf;
2998: ts->costintegrandctx = ctx;
2999: ts->drdyfunction = drdyf;
3000: ts->drdpfunction = drdpf;
3001: return(0);
3002: }
3006: /*@
3007: TSGetCostIntegral - Returns the values of the integral term in the cost functions.
3008: It is valid to call the routine after a backward run.
3010: Not Collective
3012: Input Parameter:
3013: . ts - the TS context obtained from TSCreate()
3015: Output Parameter:
3016: . v - the vector containing the integrals for each cost function
3018: Level: intermediate
3020: .seealso: TSSetCostIntegrand()
3022: .keywords: TS, sensitivity analysis
3023: @*/
3024: PetscErrorCode TSGetCostIntegral(TS ts,Vec *v)
3025: {
3029: *v = ts->vec_costintegral;
3030: return(0);
3031: }
3035: /*@
3036: TSAdjointComputeCostIntegrand - Evaluates the integral function in the cost functions.
3038: Input Parameters:
3039: + ts - the TS context
3040: . t - current time
3041: - y - state vector, i.e. current solution
3043: Output Parameter:
3044: . q - vector of size numcost to hold the outputs
3046: Note:
3047: Most users should not need to explicitly call this routine, as it
3048: is used internally within the sensitivity analysis context.
3050: Level: developer
3052: .keywords: TS, compute
3054: .seealso: TSSetCostIntegrand()
3055: @*/
3056: PetscErrorCode TSAdjointComputeCostIntegrand(TS ts,PetscReal t,Vec y,Vec q)
3057: {
3065: PetscLogEventBegin(TS_FunctionEval,ts,y,q,0);
3066: if (ts->costintegrand) {
3067: PetscStackPush("TS user integrand in the cost function");
3068: (*ts->costintegrand)(ts,t,y,q,ts->costintegrandctx);
3069: PetscStackPop;
3070: } else {
3071: VecZeroEntries(q);
3072: }
3074: PetscLogEventEnd(TS_FunctionEval,ts,y,q,0);
3075: return(0);
3076: }
3080: /*@
3081: TSAdjointComputeDRDYFunction - Runs the user-defined DRDY function.
3083: Collective on TS
3085: Input Parameters:
3086: . ts - The TS context obtained from TSCreate()
3088: Notes:
3089: TSAdjointComputeDRDYFunction() is typically used for sensitivity implementation,
3090: so most users would not generally call this routine themselves.
3092: Level: developer
3094: .keywords: TS, sensitivity
3095: .seealso: TSAdjointComputeDRDYFunction()
3096: @*/
3097: PetscErrorCode TSAdjointComputeDRDYFunction(TS ts,PetscReal t,Vec y,Vec *drdy)
3098: {
3105: PetscStackPush("TS user DRDY function for sensitivity analysis");
3106: (*ts->drdyfunction)(ts,t,y,drdy,ts->costintegrandctx);
3107: PetscStackPop;
3108: return(0);
3109: }
3113: /*@
3114: TSAdjointComputeDRDPFunction - Runs the user-defined DRDP function.
3116: Collective on TS
3118: Input Parameters:
3119: . ts - The TS context obtained from TSCreate()
3121: Notes:
3122: TSDRDPFunction() is typically used for sensitivity implementation,
3123: so most users would not generally call this routine themselves.
3125: Level: developer
3127: .keywords: TS, sensitivity
3128: .seealso: TSAdjointSetDRDPFunction()
3129: @*/
3130: PetscErrorCode TSAdjointComputeDRDPFunction(TS ts,PetscReal t,Vec y,Vec *drdp)
3131: {
3138: PetscStackPush("TS user DRDP function for sensitivity analysis");
3139: (*ts->drdpfunction)(ts,t,y,drdp,ts->costintegrandctx);
3140: PetscStackPop;
3141: return(0);
3142: }
3146: /*@C
3147: TSSetPreStep - Sets the general-purpose function
3148: called once at the beginning of each time step.
3150: Logically Collective on TS
3152: Input Parameters:
3153: + ts - The TS context obtained from TSCreate()
3154: - func - The function
3156: Calling sequence of func:
3157: . func (TS ts);
3159: Level: intermediate
3161: Note:
3162: If a step is rejected, TSStep() will call this routine again before each attempt.
3163: The last completed time step number can be queried using TSGetTimeStepNumber(), the
3164: size of the step being attempted can be obtained using TSGetTimeStep().
3166: .keywords: TS, timestep
3167: .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep()
3168: @*/
3169: PetscErrorCode TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
3170: {
3173: ts->prestep = func;
3174: return(0);
3175: }
3179: /*@
3180: TSPreStep - Runs the user-defined pre-step function.
3182: Collective on TS
3184: Input Parameters:
3185: . ts - The TS context obtained from TSCreate()
3187: Notes:
3188: TSPreStep() is typically used within time stepping implementations,
3189: so most users would not generally call this routine themselves.
3191: Level: developer
3193: .keywords: TS, timestep
3194: .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep()
3195: @*/
3196: PetscErrorCode TSPreStep(TS ts)
3197: {
3202: if (ts->prestep) {
3203: PetscStackCallStandard((*ts->prestep),(ts));
3204: }
3205: return(0);
3206: }
3210: /*@C
3211: TSSetPreStage - Sets the general-purpose function
3212: called once at the beginning of each stage.
3214: Logically Collective on TS
3216: Input Parameters:
3217: + ts - The TS context obtained from TSCreate()
3218: - func - The function
3220: Calling sequence of func:
3221: . PetscErrorCode func(TS ts, PetscReal stagetime);
3223: Level: intermediate
3225: Note:
3226: There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
3227: The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
3228: attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
3230: .keywords: TS, timestep
3231: .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
3232: @*/
3233: PetscErrorCode TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal))
3234: {
3237: ts->prestage = func;
3238: return(0);
3239: }
3243: /*@C
3244: TSSetPostStage - Sets the general-purpose function
3245: called once at the end of each stage.
3247: Logically Collective on TS
3249: Input Parameters:
3250: + ts - The TS context obtained from TSCreate()
3251: - func - The function
3253: Calling sequence of func:
3254: . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y);
3256: Level: intermediate
3258: Note:
3259: There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
3260: The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
3261: attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
3263: .keywords: TS, timestep
3264: .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
3265: @*/
3266: PetscErrorCode TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*))
3267: {
3270: ts->poststage = func;
3271: return(0);
3272: }
3276: /*@
3277: TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage()
3279: Collective on TS
3281: Input Parameters:
3282: . ts - The TS context obtained from TSCreate()
3283: stagetime - The absolute time of the current stage
3285: Notes:
3286: TSPreStage() is typically used within time stepping implementations,
3287: most users would not generally call this routine themselves.
3289: Level: developer
3291: .keywords: TS, timestep
3292: .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
3293: @*/
3294: PetscErrorCode TSPreStage(TS ts, PetscReal stagetime)
3295: {
3300: if (ts->prestage) {
3301: PetscStackCallStandard((*ts->prestage),(ts,stagetime));
3302: }
3303: return(0);
3304: }
3308: /*@
3309: TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage()
3311: Collective on TS
3313: Input Parameters:
3314: . ts - The TS context obtained from TSCreate()
3315: stagetime - The absolute time of the current stage
3316: stageindex - Stage number
3317: Y - Array of vectors (of size = total number
3318: of stages) with the stage solutions
3320: Notes:
3321: TSPostStage() is typically used within time stepping implementations,
3322: most users would not generally call this routine themselves.
3324: Level: developer
3326: .keywords: TS, timestep
3327: .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
3328: @*/
3329: PetscErrorCode TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y)
3330: {
3335: if (ts->poststage) {
3336: PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y));
3337: }
3338: return(0);
3339: }
3343: /*@C
3344: TSSetPostStep - Sets the general-purpose function
3345: called once at the end of each time step.
3347: Logically Collective on TS
3349: Input Parameters:
3350: + ts - The TS context obtained from TSCreate()
3351: - func - The function
3353: Calling sequence of func:
3354: $ func (TS ts);
3356: Level: intermediate
3358: .keywords: TS, timestep
3359: .seealso: TSSetPreStep(), TSSetPreStage(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime()
3360: @*/
3361: PetscErrorCode TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
3362: {
3365: ts->poststep = func;
3366: return(0);
3367: }
3371: /*@
3372: TSPostStep - Runs the user-defined post-step function.
3374: Collective on TS
3376: Input Parameters:
3377: . ts - The TS context obtained from TSCreate()
3379: Notes:
3380: TSPostStep() is typically used within time stepping implementations,
3381: so most users would not generally call this routine themselves.
3383: Level: developer
3385: .keywords: TS, timestep
3386: @*/
3387: PetscErrorCode TSPostStep(TS ts)
3388: {
3393: if (ts->poststep) {
3394: PetscStackCallStandard((*ts->poststep),(ts));
3395: }
3396: return(0);
3397: }
3399: /* ------------ Routines to set performance monitoring options ----------- */
3403: /*@C
3404: TSMonitorSet - Sets an ADDITIONAL function that is to be used at every
3405: timestep to display the iteration's progress.
3407: Logically Collective on TS
3409: Input Parameters:
3410: + ts - the TS context obtained from TSCreate()
3411: . monitor - monitoring routine
3412: . mctx - [optional] user-defined context for private data for the
3413: monitor routine (use NULL if no context is desired)
3414: - monitordestroy - [optional] routine that frees monitor context
3415: (may be NULL)
3417: Calling sequence of monitor:
3418: $ int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx)
3420: + ts - the TS context
3421: . steps - iteration number (after the final time step the monitor routine may be called with a step of -1, this indicates the solution has been interpolated to this time)
3422: . time - current time
3423: . u - current iterate
3424: - mctx - [optional] monitoring context
3426: Notes:
3427: This routine adds an additional monitor to the list of monitors that
3428: already has been loaded.
3430: Fortran notes: Only a single monitor function can be set for each TS object
3432: Level: intermediate
3434: .keywords: TS, timestep, set, monitor
3436: .seealso: TSMonitorDefault(), TSMonitorCancel()
3437: @*/
3438: PetscErrorCode TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**))
3439: {
3441: PetscInt i;
3442: PetscBool identical;
3443:
3446: for (i=0; i<ts->numbermonitors;i++) {
3447: PetscMonitorCompare((PetscErrorCode (*)(void))monitor,mctx,mdestroy,(PetscErrorCode (*)(void))ts->monitor[i],ts->monitorcontext[i],ts->monitordestroy[i],&identical);
3448: if (identical) return(0);
3449: }
3450: if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
3451: ts->monitor[ts->numbermonitors] = monitor;
3452: ts->monitordestroy[ts->numbermonitors] = mdestroy;
3453: ts->monitorcontext[ts->numbermonitors++] = (void*)mctx;
3454: return(0);
3455: }
3459: /*@C
3460: TSMonitorCancel - Clears all the monitors that have been set on a time-step object.
3462: Logically Collective on TS
3464: Input Parameters:
3465: . ts - the TS context obtained from TSCreate()
3467: Notes:
3468: There is no way to remove a single, specific monitor.
3470: Level: intermediate
3472: .keywords: TS, timestep, set, monitor
3474: .seealso: TSMonitorDefault(), TSMonitorSet()
3475: @*/
3476: PetscErrorCode TSMonitorCancel(TS ts)
3477: {
3479: PetscInt i;
3483: for (i=0; i<ts->numbermonitors; i++) {
3484: if (ts->monitordestroy[i]) {
3485: (*ts->monitordestroy[i])(&ts->monitorcontext[i]);
3486: }
3487: }
3488: ts->numbermonitors = 0;
3489: return(0);
3490: }
3494: /*@C
3495: TSMonitorDefault - The Default monitor, prints the timestep and time for each step
3497: Level: intermediate
3499: .keywords: TS, set, monitor
3501: .seealso: TSMonitorSet()
3502: @*/
3503: PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf)
3504: {
3506: PetscViewer viewer = vf->viewer;
3507: PetscBool iascii,ibinary;
3511: PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);
3512: PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&ibinary);
3513: PetscViewerPushFormat(viewer,vf->format);
3514: if (iascii) {
3515: PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);
3516: if (step == -1){ /* this indicates it is an interpolated solution */
3517: PetscViewerASCIIPrintf(viewer,"Interpolated solution at time %g between steps %D and %D\n",(double)ptime,ts->steps-1,ts->steps);
3518: } else {
3519: PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g%s",step,(double)ts->time_step,(double)ptime,ts->steprollback ? " (r)\n" : "\n");
3520: }
3521: PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);
3522: } else if (ibinary) {
3523: PetscMPIInt rank;
3524: MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);
3525: if (!rank) {
3526: PetscRealView(1,&ptime,viewer);
3527: } else {
3528: PetscRealView(0,&ptime,viewer);
3529: }
3530: }
3531: PetscViewerPopFormat(viewer);
3532: return(0);
3533: }
3537: /*@C
3538: TSAdjointMonitorSet - Sets an ADDITIONAL function that is to be used at every
3539: timestep to display the iteration's progress.
3541: Logically Collective on TS
3543: Input Parameters:
3544: + ts - the TS context obtained from TSCreate()
3545: . adjointmonitor - monitoring routine
3546: . adjointmctx - [optional] user-defined context for private data for the
3547: monitor routine (use NULL if no context is desired)
3548: - adjointmonitordestroy - [optional] routine that frees monitor context
3549: (may be NULL)
3551: Calling sequence of monitor:
3552: $ int adjointmonitor(TS ts,PetscInt steps,PetscReal time,Vec u,PetscInt numcost,Vec *lambda, Vec *mu,void *adjointmctx)
3554: + ts - the TS context
3555: . 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
3556: been interpolated to)
3557: . time - current time
3558: . u - current iterate
3559: . numcost - number of cost functionos
3560: . lambda - sensitivities to initial conditions
3561: . mu - sensitivities to parameters
3562: - adjointmctx - [optional] adjoint monitoring context
3564: Notes:
3565: This routine adds an additional monitor to the list of monitors that
3566: already has been loaded.
3568: Fortran notes: Only a single monitor function can be set for each TS object
3570: Level: intermediate
3572: .keywords: TS, timestep, set, adjoint, monitor
3574: .seealso: TSAdjointMonitorCancel()
3575: @*/
3576: PetscErrorCode TSAdjointMonitorSet(TS ts,PetscErrorCode (*adjointmonitor)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *adjointmctx,PetscErrorCode (*adjointmdestroy)(void**))
3577: {
3579: PetscInt i;
3580: PetscBool identical;
3584: for (i=0; i<ts->numbermonitors;i++) {
3585: PetscMonitorCompare((PetscErrorCode (*)(void))adjointmonitor,adjointmctx,adjointmdestroy,(PetscErrorCode (*)(void))ts->adjointmonitor[i],ts->adjointmonitorcontext[i],ts->adjointmonitordestroy[i],&identical);
3586: if (identical) return(0);
3587: }
3588: if (ts->numberadjointmonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many adjoint monitors set");
3589: ts->adjointmonitor[ts->numberadjointmonitors] = adjointmonitor;
3590: ts->adjointmonitordestroy[ts->numberadjointmonitors] = adjointmdestroy;
3591: ts->adjointmonitorcontext[ts->numberadjointmonitors++] = (void*)adjointmctx;
3592: return(0);
3593: }
3597: /*@C
3598: TSAdjointMonitorCancel - Clears all the adjoint monitors that have been set on a time-step object.
3600: Logically Collective on TS
3602: Input Parameters:
3603: . ts - the TS context obtained from TSCreate()
3605: Notes:
3606: There is no way to remove a single, specific monitor.
3608: Level: intermediate
3610: .keywords: TS, timestep, set, adjoint, monitor
3612: .seealso: TSAdjointMonitorSet()
3613: @*/
3614: PetscErrorCode TSAdjointMonitorCancel(TS ts)
3615: {
3617: PetscInt i;
3621: for (i=0; i<ts->numberadjointmonitors; i++) {
3622: if (ts->adjointmonitordestroy[i]) {
3623: (*ts->adjointmonitordestroy[i])(&ts->adjointmonitorcontext[i]);
3624: }
3625: }
3626: ts->numberadjointmonitors = 0;
3627: return(0);
3628: }
3632: /*@C
3633: TSAdjointMonitorDefault - the default monitor of adjoint computations
3635: Level: intermediate
3637: .keywords: TS, set, monitor
3639: .seealso: TSAdjointMonitorSet()
3640: @*/
3641: PetscErrorCode TSAdjointMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscInt numcost,Vec *lambda,Vec *mu,PetscViewerAndFormat *vf)
3642: {
3644: PetscViewer viewer = vf->viewer;
3648: PetscViewerPushFormat(viewer,vf->format);
3649: PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);
3650: PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g%s",step,(double)ts->time_step,(double)ptime,ts->steprollback ? " (r)\n" : "\n");
3651: PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);
3652: PetscViewerPopFormat(viewer);
3653: return(0);
3654: }
3658: /*@
3659: TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
3661: Collective on TS
3663: Input Argument:
3664: + ts - time stepping context
3665: - t - time to interpolate to
3667: Output Argument:
3668: . U - state at given time
3670: Level: intermediate
3672: Developer Notes:
3673: TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
3675: .keywords: TS, set
3677: .seealso: TSSetExactFinalTime(), TSSolve()
3678: @*/
3679: PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U)
3680: {
3686: if (t < ts->ptime_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_prev,(double)ts->ptime);
3687: if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
3688: (*ts->ops->interpolate)(ts,t,U);
3689: return(0);
3690: }
3694: /*@
3695: TSStep - Steps one time step
3697: Collective on TS
3699: Input Parameter:
3700: . ts - the TS context obtained from TSCreate()
3702: Level: developer
3704: Notes:
3705: The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine.
3707: The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
3708: be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
3710: This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the
3711: time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
3713: .keywords: TS, timestep, solve
3715: .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
3716: @*/
3717: PetscErrorCode TSStep(TS ts)
3718: {
3719: PetscErrorCode ierr;
3720: static PetscBool cite = PETSC_FALSE;
3721: PetscReal ptime;
3725: PetscCitationsRegister("@techreport{tspaper,\n"
3726: " title = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n"
3727: " author = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n"
3728: " type = {Preprint},\n"
3729: " number = {ANL/MCS-P5061-0114},\n"
3730: " institution = {Argonne National Laboratory},\n"
3731: " year = {2014}\n}\n",&cite);
3733: TSSetUp(ts);
3734: TSTrajectorySetUp(ts->trajectory,ts);
3736: if (ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"You must call TSSetExactFinalTime() or use -ts_exact_final_time <stepover,interpolate,matchstep> before calling TSStep()");
3737: if (ts->exact_final_time == TS_EXACTFINALTIME_MATCHSTEP && !ts->adapt) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Since TS is not adaptive you cannot use TS_EXACTFINALTIME_MATCHSTEP, suggest TS_EXACTFINALTIME_INTERPOLATE");
3739: if (!ts->steps) ts->ptime_prev = ts->ptime;
3740: ts->reason = TS_CONVERGED_ITERATING;
3741: ptime = ts->ptime; ts->ptime_prev_rollback = ts->ptime_prev;
3742: if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name);
3743: PetscLogEventBegin(TS_Step,ts,0,0,0);
3744: (*ts->ops->step)(ts);
3745: PetscLogEventEnd(TS_Step,ts,0,0,0);
3746: ts->ptime_prev = ptime;
3747: ts->steps++; ts->total_steps++;
3748: ts->steprollback = PETSC_FALSE;
3749: ts->steprestart = PETSC_FALSE;
3751: if (ts->reason < 0) {
3752: if (ts->errorifstepfailed) {
3753: 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]);
3754: else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
3755: }
3756: } else if (!ts->reason) {
3757: if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS;
3758: else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
3759: }
3760: return(0);
3761: }
3765: /*@
3766: TSAdjointStep - Steps one time step backward in the adjoint run
3768: Collective on TS
3770: Input Parameter:
3771: . ts - the TS context obtained from TSCreate()
3773: Level: intermediate
3775: .keywords: TS, adjoint, step
3777: .seealso: TSAdjointSetUp(), TSAdjointSolve()
3778: @*/
3779: PetscErrorCode TSAdjointStep(TS ts)
3780: {
3781: DM dm;
3782: PetscErrorCode ierr;
3786: TSGetDM(ts,&dm);
3787: TSAdjointSetUp(ts);
3789: VecViewFromOptions(ts->vec_sol,(PetscObject)ts,"-ts_view_solution");
3791: ts->reason = TS_CONVERGED_ITERATING;
3792: ts->ptime_prev = ts->ptime;
3793: 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);
3794: PetscLogEventBegin(TS_AdjointStep,ts,0,0,0);
3795: (*ts->ops->adjointstep)(ts);
3796: PetscLogEventEnd(TS_AdjointStep,ts,0,0,0);
3797: ts->steps++; ts->total_steps--;
3799: if (ts->reason < 0) {
3800: if (ts->errorifstepfailed) {
3801: 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]);
3802: else if (ts->reason == TS_DIVERGED_STEP_REJECTED) 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]);
3803: else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
3804: }
3805: } else if (!ts->reason) {
3806: if (ts->steps >= ts->adjoint_max_steps) ts->reason = TS_CONVERGED_ITS;
3807: }
3808: return(0);
3809: }
3813: /*@
3814: TSEvaluateWLTE - Evaluate the weighted local truncation error norm
3815: at the end of a time step with a given order of accuracy.
3817: Collective on TS
3819: Input Arguments:
3820: + ts - time stepping context
3821: . wnormtype - norm type, either NORM_2 or NORM_INFINITY
3822: - order - optional, desired order for the error evaluation or PETSC_DECIDE
3824: Output Arguments:
3825: + order - optional, the actual order of the error evaluation
3826: - wlte - the weighted local truncation error norm
3828: Level: advanced
3830: Notes:
3831: If the timestepper cannot evaluate the error in a particular step
3832: (eg. in the first step or restart steps after event handling),
3833: this routine returns wlte=-1.0 .
3835: .seealso: TSStep(), TSAdapt, TSErrorWeightedNorm()
3836: @*/
3837: PetscErrorCode TSEvaluateWLTE(TS ts,NormType wnormtype,PetscInt *order,PetscReal *wlte)
3838: {
3848: if (wnormtype != NORM_2 && wnormtype != NORM_INFINITY) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
3849: if (!ts->ops->evaluatewlte) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateWLTE not implemented for type '%s'",((PetscObject)ts)->type_name);
3850: (*ts->ops->evaluatewlte)(ts,wnormtype,order,wlte);
3851: return(0);
3852: }
3856: /*@
3857: TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy.
3859: Collective on TS
3861: Input Arguments:
3862: + ts - time stepping context
3863: . order - desired order of accuracy
3864: - done - whether the step was evaluated at this order (pass NULL to generate an error if not available)
3866: Output Arguments:
3867: . U - state at the end of the current step
3869: Level: advanced
3871: Notes:
3872: This function cannot be called until all stages have been evaluated.
3873: 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.
3875: .seealso: TSStep(), TSAdapt
3876: @*/
3877: PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done)
3878: {
3885: if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name);
3886: (*ts->ops->evaluatestep)(ts,order,U,done);
3887: return(0);
3888: }
3892: /*@
3893: TSForwardCostIntegral - Evaluate the cost integral in the forward run.
3894:
3895: Collective on TS
3896:
3897: Input Arguments:
3898: . ts - time stepping context
3899:
3900: Level: advanced
3901:
3902: Notes:
3903: This function cannot be called until TSStep() has been completed.
3904:
3905: .seealso: TSSolve(), TSAdjointCostIntegral()
3906: @*/
3907: PetscErrorCode TSForwardCostIntegral(TS ts)
3908: {
3911: if (!ts->ops->forwardintegral) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide integral evaluation in the forward run",((PetscObject)ts)->type_name);
3912: (*ts->ops->forwardintegral)(ts);
3913: return(0);
3914: }
3918: /*@
3919: TSSolve - Steps the requested number of timesteps.
3921: Collective on TS
3923: Input Parameter:
3924: + ts - the TS context obtained from TSCreate()
3925: - u - the solution vector (can be null if TSSetSolution() was used and TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP) was not used,
3926: otherwise must contain the initial conditions and will contain the solution at the final requested time
3928: Level: beginner
3930: Notes:
3931: The final time returned by this function may be different from the time of the internally
3932: held state accessible by TSGetSolution() and TSGetTime() because the method may have
3933: stepped over the final time.
3935: .keywords: TS, timestep, solve
3937: .seealso: TSCreate(), TSSetSolution(), TSStep(), TSGetTime(), TSGetSolveTime()
3938: @*/
3939: PetscErrorCode TSSolve(TS ts,Vec u)
3940: {
3941: Vec solution;
3942: PetscErrorCode ierr;
3948: 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 */
3950: if (!ts->vec_sol || u == ts->vec_sol) {
3951: VecDuplicate(u,&solution);
3952: TSSetSolution(ts,solution);
3953: VecDestroy(&solution); /* grant ownership */
3954: }
3955: VecCopy(u,ts->vec_sol);
3956: } else if (u) {
3957: TSSetSolution(ts,u);
3958: }
3959: TSSetUp(ts);
3960: TSTrajectorySetUp(ts->trajectory,ts);
3962: if (ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"You must call TSSetExactFinalTime() or use -ts_exact_final_time <stepover,interpolate,matchstep> before calling TSSolve()");
3963: if (ts->exact_final_time == TS_EXACTFINALTIME_MATCHSTEP && !ts->adapt) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Since TS is not adaptive you cannot use TS_EXACTFINALTIME_MATCHSTEP, suggest TS_EXACTFINALTIME_INTERPOLATE");
3965: /* reset time step and iteration counters */
3966: ts->steps = 0;
3967: ts->ksp_its = 0;
3968: ts->snes_its = 0;
3969: ts->num_snes_failures = 0;
3970: ts->reject = 0;
3971: ts->reason = TS_CONVERGED_ITERATING;
3973: TSViewFromOptions(ts,NULL,"-ts_view_pre");
3975: if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */
3976: (*ts->ops->solve)(ts);
3977: if (u) {VecCopy(ts->vec_sol,u);}
3978: ts->solvetime = ts->ptime;
3979: solution = ts->vec_sol;
3980: } else { /* Step the requested number of timesteps. */
3981: if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS;
3982: else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
3983: TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);
3984: TSEventInitialize(ts->event,ts,ts->ptime,ts->vec_sol);
3985: ts->steprollback = PETSC_FALSE;
3986: ts->steprestart = PETSC_TRUE;
3988: while (!ts->reason) {
3989: TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);
3990: if (!ts->steprollback) {
3991: TSPreStep(ts);
3992: }
3993: TSStep(ts);
3994: if (ts->vec_costintegral && ts->costintegralfwd) { /* Must evaluate the cost integral before event is handled. The cost integral value can also be rolled back. */
3995: TSForwardCostIntegral(ts);
3996: }
3997: TSEventHandler(ts); /* The right-hand side may be changed due to event. Be careful with Any computation using the RHS information after this point. */
3998: if (!ts->steprollback) {
3999: TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);
4000: TSPostStep(ts);
4001: }
4002: }
4003: TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);
4005: if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) {
4006: TSInterpolate(ts,ts->max_time,u);
4007: ts->solvetime = ts->max_time;
4008: solution = u;
4009: TSMonitor(ts,-1,ts->solvetime,solution);
4010: } else {
4011: if (u) {VecCopy(ts->vec_sol,u);}
4012: ts->solvetime = ts->ptime;
4013: solution = ts->vec_sol;
4014: }
4015: }
4017: TSViewFromOptions(ts,NULL,"-ts_view");
4018: VecViewFromOptions(solution,NULL,"-ts_view_solution");
4019: PetscObjectSAWsBlock((PetscObject)ts);
4020: if (ts->adjoint_solve) {
4021: TSAdjointSolve(ts);
4022: }
4023: return(0);
4024: }
4028: /*@
4029: TSAdjointCostIntegral - Evaluate the cost integral in the adjoint run.
4030:
4031: Collective on TS
4032:
4033: Input Arguments:
4034: . ts - time stepping context
4035:
4036: Level: advanced
4037:
4038: Notes:
4039: This function cannot be called until TSAdjointStep() has been completed.
4040:
4041: .seealso: TSAdjointSolve(), TSAdjointStep
4042: @*/
4043: PetscErrorCode TSAdjointCostIntegral(TS ts)
4044: {
4047: if (!ts->ops->adjointintegral) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide integral evaluation in the adjoint run",((PetscObject)ts)->type_name);
4048: (*ts->ops->adjointintegral)(ts);
4049: return(0);
4050: }
4054: /*@
4055: TSAdjointSolve - Solves the discrete ajoint problem for an ODE/DAE
4057: Collective on TS
4059: Input Parameter:
4060: . ts - the TS context obtained from TSCreate()
4062: Options Database:
4063: . -ts_adjoint_view_solution <viewerinfo> - views the first gradient with respect to the initial conditions
4065: Level: intermediate
4067: Notes:
4068: This must be called after a call to TSSolve() that solves the forward problem
4070: By default this will integrate back to the initial time, one can use TSAdjointSetSteps() to step back to a later time
4072: .keywords: TS, timestep, solve
4074: .seealso: TSCreate(), TSSetCostGradients(), TSSetSolution(), TSAdjointStep()
4075: @*/
4076: PetscErrorCode TSAdjointSolve(TS ts)
4077: {
4078: PetscErrorCode ierr;
4082: TSAdjointSetUp(ts);
4084: /* reset time step and iteration counters */
4085: ts->steps = 0;
4086: ts->ksp_its = 0;
4087: ts->snes_its = 0;
4088: ts->num_snes_failures = 0;
4089: ts->reject = 0;
4090: ts->reason = TS_CONVERGED_ITERATING;
4092: if (!ts->adjoint_max_steps) ts->adjoint_max_steps = ts->total_steps;
4094: if (ts->steps >= ts->adjoint_max_steps) ts->reason = TS_CONVERGED_ITS;
4095: while (!ts->reason) {
4096: TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);
4097: TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);
4098: TSAdjointEventHandler(ts);
4099: TSAdjointStep(ts);
4100: if (ts->vec_costintegral && !ts->costintegralfwd) {
4101: TSAdjointCostIntegral(ts);
4102: }
4103: }
4104: TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);
4105: TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);
4106: ts->solvetime = ts->ptime;
4107: TSTrajectoryViewFromOptions(ts->trajectory,NULL,"-ts_trajectory_view");
4108: VecViewFromOptions(ts->vecs_sensi[0],(PetscObject) ts, "-ts_adjoint_view_solution");
4109: return(0);
4110: }
4114: /*@C
4115: TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet()
4117: Collective on TS
4119: Input Parameters:
4120: + ts - time stepping context obtained from TSCreate()
4121: . step - step number that has just completed
4122: . ptime - model time of the state
4123: - u - state at the current model time
4125: Notes:
4126: TSMonitor() is typically used automatically within the time stepping implementations.
4127: Users would almost never call this routine directly.
4129: A step of -1 indicates that the monitor is being called on a solution obtained by interpolating from computed solutions
4131: Level: developer
4133: .keywords: TS, timestep
4134: @*/
4135: PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u)
4136: {
4137: DM dm;
4138: PetscInt i,n = ts->numbermonitors;
4145: TSGetDM(ts,&dm);
4146: DMSetOutputSequenceNumber(dm,step,ptime);
4148: VecLockPush(u);
4149: for (i=0; i<n; i++) {
4150: (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);
4151: }
4152: VecLockPop(u);
4153: return(0);
4154: }
4158: /*@C
4159: TSAdjointMonitor - Runs all user-provided adjoint monitor routines set using TSAdjointMonitorSet()
4161: Collective on TS
4163: Input Parameters:
4164: + ts - time stepping context obtained from TSCreate()
4165: . step - step number that has just completed
4166: . ptime - model time of the state
4167: . u - state at the current model time
4168: . numcost - number of cost functions (dimension of lambda or mu)
4169: . lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables
4170: - mu - vectors containing the gradients of the cost functions with respect to the problem parameters
4172: Notes:
4173: TSAdjointMonitor() is typically used automatically within the time stepping implementations.
4174: Users would almost never call this routine directly.
4176: Level: developer
4178: .keywords: TS, timestep
4179: @*/
4180: PetscErrorCode TSAdjointMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda, Vec *mu)
4181: {
4183: PetscInt i,n = ts->numberadjointmonitors;
4188: VecLockPush(u);
4189: for (i=0; i<n; i++) {
4190: (*ts->adjointmonitor[i])(ts,step,ptime,u,numcost,lambda,mu,ts->adjointmonitorcontext[i]);
4191: }
4192: VecLockPop(u);
4193: return(0);
4194: }
4196: /* ------------------------------------------------------------------------*/
4199: /*@C
4200: TSMonitorLGCtxCreate - Creates a TSMonitorLGCtx context for use with
4201: TS to monitor the solution process graphically in various ways
4203: Collective on TS
4205: Input Parameters:
4206: + host - the X display to open, or null for the local machine
4207: . label - the title to put in the title bar
4208: . x, y - the screen coordinates of the upper left coordinate of the window
4209: . m, n - the screen width and height in pixels
4210: - howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time
4212: Output Parameter:
4213: . ctx - the context
4215: Options Database Key:
4216: + -ts_monitor_lg_timestep - automatically sets line graph monitor
4217: . -ts_monitor_lg_solution - monitor the solution (or certain values of the solution by calling TSMonitorLGSetDisplayVariables() or TSMonitorLGCtxSetDisplayVariables())
4218: . -ts_monitor_lg_error - monitor the error
4219: . -ts_monitor_lg_ksp_iterations - monitor the number of KSP iterations needed for each timestep
4220: . -ts_monitor_lg_snes_iterations - monitor the number of SNES iterations needed for each timestep
4221: - -lg_use_markers <true,false> - mark the data points (at each time step) on the plot; default is true
4223: Notes:
4224: Use TSMonitorLGCtxDestroy() to destroy.
4226: One can provide a function that transforms the solution before plotting it with TSMonitorLGCtxSetTransform() or TSMonitorLGSetTransform()
4228: Many of the functions that control the monitoring have two forms: TSMonitorLGSet/GetXXXX() and TSMonitorLGCtxSet/GetXXXX() the first take a TS object as the
4229: 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
4230: as the first argument.
4232: One can control the names displayed for each solution or error variable with TSMonitorLGCtxSetVariableNames() or TSMonitorLGSetVariableNames()
4235: Level: intermediate
4237: .keywords: TS, monitor, line graph, residual
4239: .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError(), TSMonitorDefault(), VecView(),
4240: TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
4241: TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
4242: TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
4243: TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
4245: @*/
4246: PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx)
4247: {
4248: PetscDraw draw;
4252: PetscNew(ctx);
4253: PetscDrawCreate(comm,host,label,x,y,m,n,&draw);
4254: PetscDrawSetFromOptions(draw);
4255: PetscDrawLGCreate(draw,1,&(*ctx)->lg);
4256: PetscDrawLGSetFromOptions((*ctx)->lg);
4257: PetscDrawDestroy(&draw);
4258: (*ctx)->howoften = howoften;
4259: return(0);
4260: }
4264: PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx)
4265: {
4266: TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
4267: PetscReal x = ptime,y;
4271: if (step < 0) return(0); /* -1 indicates an interpolated solution */
4272: if (!step) {
4273: PetscDrawAxis axis;
4274: PetscDrawLGGetAxis(ctx->lg,&axis);
4275: PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time Step");
4276: PetscDrawLGReset(ctx->lg);
4277: }
4278: TSGetTimeStep(ts,&y);
4279: PetscDrawLGAddPoint(ctx->lg,&x,&y);
4280: if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
4281: PetscDrawLGDraw(ctx->lg);
4282: PetscDrawLGSave(ctx->lg);
4283: }
4284: return(0);
4285: }
4289: /*@C
4290: TSMonitorLGCtxDestroy - Destroys a line graph context that was created
4291: with TSMonitorLGCtxCreate().
4293: Collective on TSMonitorLGCtx
4295: Input Parameter:
4296: . ctx - the monitor context
4298: Level: intermediate
4300: .keywords: TS, monitor, line graph, destroy
4302: .seealso: TSMonitorLGCtxCreate(), TSMonitorSet(), TSMonitorLGTimeStep();
4303: @*/
4304: PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx)
4305: {
4309: if ((*ctx)->transformdestroy) {
4310: ((*ctx)->transformdestroy)((*ctx)->transformctx);
4311: }
4312: PetscDrawLGDestroy(&(*ctx)->lg);
4313: PetscStrArrayDestroy(&(*ctx)->names);
4314: PetscStrArrayDestroy(&(*ctx)->displaynames);
4315: PetscFree((*ctx)->displayvariables);
4316: PetscFree((*ctx)->displayvalues);
4317: PetscFree(*ctx);
4318: return(0);
4319: }
4323: /*@
4324: TSGetTime - Gets the time of the most recently completed step.
4326: Not Collective
4328: Input Parameter:
4329: . ts - the TS context obtained from TSCreate()
4331: Output Parameter:
4332: . t - the current time. This time may not corresponds to the final time set with TSSetDuration(), use TSGetSolveTime().
4334: Level: beginner
4336: Note:
4337: When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(),
4338: TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated.
4340: .seealso: TSSetInitialTimeStep(), TSGetTimeStep(), TSGetSolveTime()
4342: .keywords: TS, get, time
4343: @*/
4344: PetscErrorCode TSGetTime(TS ts,PetscReal *t)
4345: {
4349: *t = ts->ptime;
4350: return(0);
4351: }
4355: /*@
4356: TSGetPrevTime - Gets the starting time of the previously completed step.
4358: Not Collective
4360: Input Parameter:
4361: . ts - the TS context obtained from TSCreate()
4363: Output Parameter:
4364: . t - the previous time
4366: Level: beginner
4368: .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
4370: .keywords: TS, get, time
4371: @*/
4372: PetscErrorCode TSGetPrevTime(TS ts,PetscReal *t)
4373: {
4377: *t = ts->ptime_prev;
4378: return(0);
4379: }
4383: /*@
4384: TSSetTime - Allows one to reset the time.
4386: Logically Collective on TS
4388: Input Parameters:
4389: + ts - the TS context obtained from TSCreate()
4390: - time - the time
4392: Level: intermediate
4394: .seealso: TSGetTime(), TSSetDuration()
4396: .keywords: TS, set, time
4397: @*/
4398: PetscErrorCode TSSetTime(TS ts, PetscReal t)
4399: {
4403: ts->ptime = t;
4404: return(0);
4405: }
4409: /*@C
4410: TSSetOptionsPrefix - Sets the prefix used for searching for all
4411: TS options in the database.
4413: Logically Collective on TS
4415: Input Parameter:
4416: + ts - The TS context
4417: - prefix - The prefix to prepend to all option names
4419: Notes:
4420: A hyphen (-) must NOT be given at the beginning of the prefix name.
4421: The first character of all runtime options is AUTOMATICALLY the
4422: hyphen.
4424: Level: advanced
4426: .keywords: TS, set, options, prefix, database
4428: .seealso: TSSetFromOptions()
4430: @*/
4431: PetscErrorCode TSSetOptionsPrefix(TS ts,const char prefix[])
4432: {
4434: SNES snes;
4438: PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);
4439: TSGetSNES(ts,&snes);
4440: SNESSetOptionsPrefix(snes,prefix);
4441: return(0);
4442: }
4447: /*@C
4448: TSAppendOptionsPrefix - Appends to the prefix used for searching for all
4449: TS options in the database.
4451: Logically Collective on TS
4453: Input Parameter:
4454: + ts - The TS context
4455: - prefix - The prefix to prepend to all option names
4457: Notes:
4458: A hyphen (-) must NOT be given at the beginning of the prefix name.
4459: The first character of all runtime options is AUTOMATICALLY the
4460: hyphen.
4462: Level: advanced
4464: .keywords: TS, append, options, prefix, database
4466: .seealso: TSGetOptionsPrefix()
4468: @*/
4469: PetscErrorCode TSAppendOptionsPrefix(TS ts,const char prefix[])
4470: {
4472: SNES snes;
4476: PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);
4477: TSGetSNES(ts,&snes);
4478: SNESAppendOptionsPrefix(snes,prefix);
4479: return(0);
4480: }
4484: /*@C
4485: TSGetOptionsPrefix - Sets the prefix used for searching for all
4486: TS options in the database.
4488: Not Collective
4490: Input Parameter:
4491: . ts - The TS context
4493: Output Parameter:
4494: . prefix - A pointer to the prefix string used
4496: Notes: On the fortran side, the user should pass in a string 'prifix' of
4497: sufficient length to hold the prefix.
4499: Level: intermediate
4501: .keywords: TS, get, options, prefix, database
4503: .seealso: TSAppendOptionsPrefix()
4504: @*/
4505: PetscErrorCode TSGetOptionsPrefix(TS ts,const char *prefix[])
4506: {
4512: PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);
4513: return(0);
4514: }
4518: /*@C
4519: TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
4521: Not Collective, but parallel objects are returned if TS is parallel
4523: Input Parameter:
4524: . ts - The TS context obtained from TSCreate()
4526: Output Parameters:
4527: + Amat - The (approximate) Jacobian J of G, where U_t = G(U,t) (or NULL)
4528: . Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat (or NULL)
4529: . func - Function to compute the Jacobian of the RHS (or NULL)
4530: - ctx - User-defined context for Jacobian evaluation routine (or NULL)
4532: Notes: You can pass in NULL for any return argument you do not need.
4534: Level: intermediate
4536: .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
4538: .keywords: TS, timestep, get, matrix, Jacobian
4539: @*/
4540: PetscErrorCode TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx)
4541: {
4543: SNES snes;
4544: DM dm;
4547: TSGetSNES(ts,&snes);
4548: SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);
4549: TSGetDM(ts,&dm);
4550: DMTSGetRHSJacobian(dm,func,ctx);
4551: return(0);
4552: }
4556: /*@C
4557: TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
4559: Not Collective, but parallel objects are returned if TS is parallel
4561: Input Parameter:
4562: . ts - The TS context obtained from TSCreate()
4564: Output Parameters:
4565: + Amat - The (approximate) Jacobian of F(t,U,U_t)
4566: . Pmat - The matrix from which the preconditioner is constructed, often the same as Amat
4567: . f - The function to compute the matrices
4568: - ctx - User-defined context for Jacobian evaluation routine
4570: Notes: You can pass in NULL for any return argument you do not need.
4572: Level: advanced
4574: .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
4576: .keywords: TS, timestep, get, matrix, Jacobian
4577: @*/
4578: PetscErrorCode TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx)
4579: {
4581: SNES snes;
4582: DM dm;
4585: TSGetSNES(ts,&snes);
4586: SNESSetUpMatrices(snes);
4587: SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);
4588: TSGetDM(ts,&dm);
4589: DMTSGetIJacobian(dm,f,ctx);
4590: return(0);
4591: }
4596: /*@C
4597: TSMonitorDrawSolution - Monitors progress of the TS solvers by calling
4598: VecView() for the solution at each timestep
4600: Collective on TS
4602: Input Parameters:
4603: + ts - the TS context
4604: . step - current time-step
4605: . ptime - current time
4606: - dummy - either a viewer or NULL
4608: Options Database:
4609: . -ts_monitor_draw_solution_initial - show initial solution as well as current solution
4611: Notes: the initial solution and current solution are not display with a common axis scaling so generally the option -ts_monitor_draw_solution_initial
4612: will look bad
4614: Level: intermediate
4616: .keywords: TS, vector, monitor, view
4618: .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
4619: @*/
4620: PetscErrorCode TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
4621: {
4622: PetscErrorCode ierr;
4623: TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
4624: PetscDraw draw;
4627: if (!step && ictx->showinitial) {
4628: if (!ictx->initialsolution) {
4629: VecDuplicate(u,&ictx->initialsolution);
4630: }
4631: VecCopy(u,ictx->initialsolution);
4632: }
4633: if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) return(0);
4635: if (ictx->showinitial) {
4636: PetscReal pause;
4637: PetscViewerDrawGetPause(ictx->viewer,&pause);
4638: PetscViewerDrawSetPause(ictx->viewer,0.0);
4639: VecView(ictx->initialsolution,ictx->viewer);
4640: PetscViewerDrawSetPause(ictx->viewer,pause);
4641: PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);
4642: }
4643: VecView(u,ictx->viewer);
4644: if (ictx->showtimestepandtime) {
4645: PetscReal xl,yl,xr,yr,h;
4646: char time[32];
4648: PetscViewerDrawGetDraw(ictx->viewer,0,&draw);
4649: PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);
4650: PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);
4651: h = yl + .95*(yr - yl);
4652: PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);
4653: PetscDrawFlush(draw);
4654: }
4656: if (ictx->showinitial) {
4657: PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);
4658: }
4659: return(0);
4660: }
4664: /*@C
4665: TSAdjointMonitorDrawSensi - Monitors progress of the adjoint TS solvers by calling
4666: VecView() for the sensitivities to initial states at each timestep
4668: Collective on TS
4670: Input Parameters:
4671: + ts - the TS context
4672: . step - current time-step
4673: . ptime - current time
4674: . u - current state
4675: . numcost - number of cost functions
4676: . lambda - sensitivities to initial conditions
4677: . mu - sensitivities to parameters
4678: - dummy - either a viewer or NULL
4680: Level: intermediate
4682: .keywords: TS, vector, adjoint, monitor, view
4684: .seealso: TSAdjointMonitorSet(), TSAdjointMonitorDefault(), VecView()
4685: @*/
4686: PetscErrorCode TSAdjointMonitorDrawSensi(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda,Vec *mu,void *dummy)
4687: {
4688: PetscErrorCode ierr;
4689: TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
4690: PetscDraw draw;
4691: PetscReal xl,yl,xr,yr,h;
4692: char time[32];
4695: if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) return(0);
4697: VecView(lambda[0],ictx->viewer);
4698: PetscViewerDrawGetDraw(ictx->viewer,0,&draw);
4699: PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);
4700: PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);
4701: h = yl + .95*(yr - yl);
4702: PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);
4703: PetscDrawFlush(draw);
4704: return(0);
4705: }
4709: /*@C
4710: TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram
4712: Collective on TS
4714: Input Parameters:
4715: + ts - the TS context
4716: . step - current time-step
4717: . ptime - current time
4718: - dummy - either a viewer or NULL
4720: Level: intermediate
4722: .keywords: TS, vector, monitor, view
4724: .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
4725: @*/
4726: PetscErrorCode TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
4727: {
4728: PetscErrorCode ierr;
4729: TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
4730: PetscDraw draw;
4731: PetscDrawAxis axis;
4732: PetscInt n;
4733: PetscMPIInt size;
4734: PetscReal U0,U1,xl,yl,xr,yr,h;
4735: char time[32];
4736: const PetscScalar *U;
4739: MPI_Comm_size(PetscObjectComm((PetscObject)ts),&size);
4740: if (size != 1) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only allowed for sequential runs");
4741: VecGetSize(u,&n);
4742: if (n != 2) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only for ODEs with two unknowns");
4744: PetscViewerDrawGetDraw(ictx->viewer,0,&draw);
4745: PetscViewerDrawGetDrawAxis(ictx->viewer,0,&axis);
4746: PetscDrawAxisGetLimits(axis,&xl,&xr,&yl,&yr);
4747: if (!step) {
4748: PetscDrawClear(draw);
4749: PetscDrawAxisDraw(axis);
4750: }
4752: VecGetArrayRead(u,&U);
4753: U0 = PetscRealPart(U[0]);
4754: U1 = PetscRealPart(U[1]);
4755: VecRestoreArrayRead(u,&U);
4756: if ((U0 < xl) || (U1 < yl) || (U0 > xr) || (U1 > yr)) return(0);
4758: PetscDrawCollectiveBegin(draw);
4759: PetscDrawPoint(draw,U0,U1,PETSC_DRAW_BLACK);
4760: if (ictx->showtimestepandtime) {
4761: PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);
4762: PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);
4763: h = yl + .95*(yr - yl);
4764: PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);
4765: }
4766: PetscDrawCollectiveEnd(draw);
4767: PetscDrawFlush(draw);
4768: PetscDrawSave(draw);
4769: return(0);
4770: }
4775: /*@C
4776: TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution()
4778: Collective on TS
4780: Input Parameters:
4781: . ctx - the monitor context
4783: Level: intermediate
4785: .keywords: TS, vector, monitor, view
4787: .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError()
4788: @*/
4789: PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx)
4790: {
4794: PetscViewerDestroy(&(*ictx)->viewer);
4795: VecDestroy(&(*ictx)->initialsolution);
4796: PetscFree(*ictx);
4797: return(0);
4798: }
4802: /*@C
4803: TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx
4805: Collective on TS
4807: Input Parameter:
4808: . ts - time-step context
4810: Output Patameter:
4811: . ctx - the monitor context
4813: Options Database:
4814: . -ts_monitor_draw_solution_initial - show initial solution as well as current solution
4816: Level: intermediate
4818: .keywords: TS, vector, monitor, view
4820: .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx()
4821: @*/
4822: PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx)
4823: {
4824: PetscErrorCode ierr;
4827: PetscNew(ctx);
4828: PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);
4829: PetscViewerSetFromOptions((*ctx)->viewer);
4831: (*ctx)->howoften = howoften;
4832: (*ctx)->showinitial = PETSC_FALSE;
4833: PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);
4835: (*ctx)->showtimestepandtime = PETSC_FALSE;
4836: PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);
4837: return(0);
4838: }
4842: /*@C
4843: TSMonitorDrawError - Monitors progress of the TS solvers by calling
4844: VecView() for the error at each timestep
4846: Collective on TS
4848: Input Parameters:
4849: + ts - the TS context
4850: . step - current time-step
4851: . ptime - current time
4852: - dummy - either a viewer or NULL
4854: Level: intermediate
4856: .keywords: TS, vector, monitor, view
4858: .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
4859: @*/
4860: PetscErrorCode TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
4861: {
4862: PetscErrorCode ierr;
4863: TSMonitorDrawCtx ctx = (TSMonitorDrawCtx)dummy;
4864: PetscViewer viewer = ctx->viewer;
4865: Vec work;
4868: if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) return(0);
4869: VecDuplicate(u,&work);
4870: TSComputeSolutionFunction(ts,ptime,work);
4871: VecAXPY(work,-1.0,u);
4872: VecView(work,viewer);
4873: VecDestroy(&work);
4874: return(0);
4875: }
4877: #include <petsc/private/dmimpl.h>
4880: /*@
4881: TSSetDM - Sets the DM that may be used by some preconditioners
4883: Logically Collective on TS and DM
4885: Input Parameters:
4886: + ts - the preconditioner context
4887: - dm - the dm
4889: Level: intermediate
4892: .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
4893: @*/
4894: PetscErrorCode TSSetDM(TS ts,DM dm)
4895: {
4897: SNES snes;
4898: DMTS tsdm;
4902: PetscObjectReference((PetscObject)dm);
4903: if (ts->dm) { /* Move the DMTS context over to the new DM unless the new DM already has one */
4904: if (ts->dm->dmts && !dm->dmts) {
4905: DMCopyDMTS(ts->dm,dm);
4906: DMGetDMTS(ts->dm,&tsdm);
4907: if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */
4908: tsdm->originaldm = dm;
4909: }
4910: }
4911: DMDestroy(&ts->dm);
4912: }
4913: ts->dm = dm;
4915: TSGetSNES(ts,&snes);
4916: SNESSetDM(snes,dm);
4917: return(0);
4918: }
4922: /*@
4923: TSGetDM - Gets the DM that may be used by some preconditioners
4925: Not Collective
4927: Input Parameter:
4928: . ts - the preconditioner context
4930: Output Parameter:
4931: . dm - the dm
4933: Level: intermediate
4936: .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
4937: @*/
4938: PetscErrorCode TSGetDM(TS ts,DM *dm)
4939: {
4944: if (!ts->dm) {
4945: DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);
4946: if (ts->snes) {SNESSetDM(ts->snes,ts->dm);}
4947: }
4948: *dm = ts->dm;
4949: return(0);
4950: }
4954: /*@
4955: SNESTSFormFunction - Function to evaluate nonlinear residual
4957: Logically Collective on SNES
4959: Input Parameter:
4960: + snes - nonlinear solver
4961: . U - the current state at which to evaluate the residual
4962: - ctx - user context, must be a TS
4964: Output Parameter:
4965: . F - the nonlinear residual
4967: Notes:
4968: This function is not normally called by users and is automatically registered with the SNES used by TS.
4969: It is most frequently passed to MatFDColoringSetFunction().
4971: Level: advanced
4973: .seealso: SNESSetFunction(), MatFDColoringSetFunction()
4974: @*/
4975: PetscErrorCode SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx)
4976: {
4977: TS ts = (TS)ctx;
4985: (ts->ops->snesfunction)(snes,U,F,ts);
4986: return(0);
4987: }
4991: /*@
4992: SNESTSFormJacobian - Function to evaluate the Jacobian
4994: Collective on SNES
4996: Input Parameter:
4997: + snes - nonlinear solver
4998: . U - the current state at which to evaluate the residual
4999: - ctx - user context, must be a TS
5001: Output Parameter:
5002: + A - the Jacobian
5003: . B - the preconditioning matrix (may be the same as A)
5004: - flag - indicates any structure change in the matrix
5006: Notes:
5007: This function is not normally called by users and is automatically registered with the SNES used by TS.
5009: Level: developer
5011: .seealso: SNESSetJacobian()
5012: @*/
5013: PetscErrorCode SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx)
5014: {
5015: TS ts = (TS)ctx;
5026: (ts->ops->snesjacobian)(snes,U,A,B,ts);
5027: return(0);
5028: }
5032: /*@C
5033: TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems Udot = A U only
5035: Collective on TS
5037: Input Arguments:
5038: + ts - time stepping context
5039: . t - time at which to evaluate
5040: . U - state at which to evaluate
5041: - ctx - context
5043: Output Arguments:
5044: . F - right hand side
5046: Level: intermediate
5048: Notes:
5049: This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
5050: The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
5052: .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
5053: @*/
5054: PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx)
5055: {
5057: Mat Arhs,Brhs;
5060: TSGetRHSMats_Private(ts,&Arhs,&Brhs);
5061: TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);
5062: MatMult(Arhs,U,F);
5063: return(0);
5064: }
5068: /*@C
5069: TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
5071: Collective on TS
5073: Input Arguments:
5074: + ts - time stepping context
5075: . t - time at which to evaluate
5076: . U - state at which to evaluate
5077: - ctx - context
5079: Output Arguments:
5080: + A - pointer to operator
5081: . B - pointer to preconditioning matrix
5082: - flg - matrix structure flag
5084: Level: intermediate
5086: Notes:
5087: This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
5089: .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
5090: @*/
5091: PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx)
5092: {
5094: return(0);
5095: }
5099: /*@C
5100: TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
5102: Collective on TS
5104: Input Arguments:
5105: + ts - time stepping context
5106: . t - time at which to evaluate
5107: . U - state at which to evaluate
5108: . Udot - time derivative of state vector
5109: - ctx - context
5111: Output Arguments:
5112: . F - left hand side
5114: Level: intermediate
5116: Notes:
5117: 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
5118: user is required to write their own TSComputeIFunction.
5119: This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
5120: The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
5122: Note that using this function is NOT equivalent to using TSComputeRHSFunctionLinear() since that solves Udot = A U
5124: .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant(), TSComputeRHSFunctionLinear()
5125: @*/
5126: PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx)
5127: {
5129: Mat A,B;
5132: TSGetIJacobian(ts,&A,&B,NULL,NULL);
5133: TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);
5134: MatMult(A,Udot,F);
5135: return(0);
5136: }
5140: /*@C
5141: TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE
5143: Collective on TS
5145: Input Arguments:
5146: + ts - time stepping context
5147: . t - time at which to evaluate
5148: . U - state at which to evaluate
5149: . Udot - time derivative of state vector
5150: . shift - shift to apply
5151: - ctx - context
5153: Output Arguments:
5154: + A - pointer to operator
5155: . B - pointer to preconditioning matrix
5156: - flg - matrix structure flag
5158: Level: advanced
5160: Notes:
5161: This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
5163: It is only appropriate for problems of the form
5165: $ M Udot = F(U,t)
5167: where M is constant and F is non-stiff. The user must pass M to TSSetIJacobian(). The current implementation only
5168: works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing
5169: an implicit operator of the form
5171: $ shift*M + J
5173: 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
5174: a copy of M or reassemble it when requested.
5176: .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
5177: @*/
5178: PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx)
5179: {
5183: MatScale(A, shift / ts->ijacobian.shift);
5184: ts->ijacobian.shift = shift;
5185: return(0);
5186: }
5190: /*@
5191: TSGetEquationType - Gets the type of the equation that TS is solving.
5193: Not Collective
5195: Input Parameter:
5196: . ts - the TS context
5198: Output Parameter:
5199: . equation_type - see TSEquationType
5201: Level: beginner
5203: .keywords: TS, equation type
5205: .seealso: TSSetEquationType(), TSEquationType
5206: @*/
5207: PetscErrorCode TSGetEquationType(TS ts,TSEquationType *equation_type)
5208: {
5212: *equation_type = ts->equation_type;
5213: return(0);
5214: }
5218: /*@
5219: TSSetEquationType - Sets the type of the equation that TS is solving.
5221: Not Collective
5223: Input Parameter:
5224: + ts - the TS context
5225: - equation_type - see TSEquationType
5227: Level: advanced
5229: .keywords: TS, equation type
5231: .seealso: TSGetEquationType(), TSEquationType
5232: @*/
5233: PetscErrorCode TSSetEquationType(TS ts,TSEquationType equation_type)
5234: {
5237: ts->equation_type = equation_type;
5238: return(0);
5239: }
5243: /*@
5244: TSGetConvergedReason - Gets the reason the TS iteration was stopped.
5246: Not Collective
5248: Input Parameter:
5249: . ts - the TS context
5251: Output Parameter:
5252: . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
5253: manual pages for the individual convergence tests for complete lists
5255: Level: beginner
5257: Notes:
5258: Can only be called after the call to TSSolve() is complete.
5260: .keywords: TS, nonlinear, set, convergence, test
5262: .seealso: TSSetConvergenceTest(), TSConvergedReason
5263: @*/
5264: PetscErrorCode TSGetConvergedReason(TS ts,TSConvergedReason *reason)
5265: {
5269: *reason = ts->reason;
5270: return(0);
5271: }
5275: /*@
5276: TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve.
5278: Not Collective
5280: Input Parameter:
5281: + ts - the TS context
5282: . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
5283: manual pages for the individual convergence tests for complete lists
5285: Level: advanced
5287: Notes:
5288: Can only be called during TSSolve() is active.
5290: .keywords: TS, nonlinear, set, convergence, test
5292: .seealso: TSConvergedReason
5293: @*/
5294: PetscErrorCode TSSetConvergedReason(TS ts,TSConvergedReason reason)
5295: {
5298: ts->reason = reason;
5299: return(0);
5300: }
5304: /*@
5305: TSGetSolveTime - Gets the time after a call to TSSolve()
5307: Not Collective
5309: Input Parameter:
5310: . ts - the TS context
5312: Output Parameter:
5313: . ftime - the final time. This time corresponds to the final time set with TSSetDuration()
5315: Level: beginner
5317: Notes:
5318: Can only be called after the call to TSSolve() is complete.
5320: .keywords: TS, nonlinear, set, convergence, test
5322: .seealso: TSSetConvergenceTest(), TSConvergedReason
5323: @*/
5324: PetscErrorCode TSGetSolveTime(TS ts,PetscReal *ftime)
5325: {
5329: *ftime = ts->solvetime;
5330: return(0);
5331: }
5335: /*@
5336: TSGetTotalSteps - Gets the total number of steps done since the last call to TSSetUp() or TSCreate()
5338: Not Collective
5340: Input Parameter:
5341: . ts - the TS context
5343: Output Parameter:
5344: . steps - the number of steps
5346: Level: beginner
5348: Notes:
5349: Includes the number of steps for all calls to TSSolve() since TSSetUp() was called
5351: .keywords: TS, nonlinear, set, convergence, test
5353: .seealso: TSSetConvergenceTest(), TSConvergedReason
5354: @*/
5355: PetscErrorCode TSGetTotalSteps(TS ts,PetscInt *steps)
5356: {
5360: *steps = ts->total_steps;
5361: return(0);
5362: }
5366: /*@
5367: TSGetSNESIterations - Gets the total number of nonlinear iterations
5368: used by the time integrator.
5370: Not Collective
5372: Input Parameter:
5373: . ts - TS context
5375: Output Parameter:
5376: . nits - number of nonlinear iterations
5378: Notes:
5379: This counter is reset to zero for each successive call to TSSolve().
5381: Level: intermediate
5383: .keywords: TS, get, number, nonlinear, iterations
5385: .seealso: TSGetKSPIterations()
5386: @*/
5387: PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits)
5388: {
5392: *nits = ts->snes_its;
5393: return(0);
5394: }
5398: /*@
5399: TSGetKSPIterations - Gets the total number of linear iterations
5400: used by the time integrator.
5402: Not Collective
5404: Input Parameter:
5405: . ts - TS context
5407: Output Parameter:
5408: . lits - number of linear iterations
5410: Notes:
5411: This counter is reset to zero for each successive call to TSSolve().
5413: Level: intermediate
5415: .keywords: TS, get, number, linear, iterations
5417: .seealso: TSGetSNESIterations(), SNESGetKSPIterations()
5418: @*/
5419: PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits)
5420: {
5424: *lits = ts->ksp_its;
5425: return(0);
5426: }
5430: /*@
5431: TSGetStepRejections - Gets the total number of rejected steps.
5433: Not Collective
5435: Input Parameter:
5436: . ts - TS context
5438: Output Parameter:
5439: . rejects - number of steps rejected
5441: Notes:
5442: This counter is reset to zero for each successive call to TSSolve().
5444: Level: intermediate
5446: .keywords: TS, get, number
5448: .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails()
5449: @*/
5450: PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects)
5451: {
5455: *rejects = ts->reject;
5456: return(0);
5457: }
5461: /*@
5462: TSGetSNESFailures - Gets the total number of failed SNES solves
5464: Not Collective
5466: Input Parameter:
5467: . ts - TS context
5469: Output Parameter:
5470: . fails - number of failed nonlinear solves
5472: Notes:
5473: This counter is reset to zero for each successive call to TSSolve().
5475: Level: intermediate
5477: .keywords: TS, get, number
5479: .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures()
5480: @*/
5481: PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails)
5482: {
5486: *fails = ts->num_snes_failures;
5487: return(0);
5488: }
5492: /*@
5493: TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails
5495: Not Collective
5497: Input Parameter:
5498: + ts - TS context
5499: - rejects - maximum number of rejected steps, pass -1 for unlimited
5501: Notes:
5502: The counter is reset to zero for each step
5504: Options Database Key:
5505: . -ts_max_reject - Maximum number of step rejections before a step fails
5507: Level: intermediate
5509: .keywords: TS, set, maximum, number
5511: .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5512: @*/
5513: PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects)
5514: {
5517: ts->max_reject = rejects;
5518: return(0);
5519: }
5523: /*@
5524: TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves
5526: Not Collective
5528: Input Parameter:
5529: + ts - TS context
5530: - fails - maximum number of failed nonlinear solves, pass -1 for unlimited
5532: Notes:
5533: The counter is reset to zero for each successive call to TSSolve().
5535: Options Database Key:
5536: . -ts_max_snes_failures - Maximum number of nonlinear solve failures
5538: Level: intermediate
5540: .keywords: TS, set, maximum, number
5542: .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason()
5543: @*/
5544: PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails)
5545: {
5548: ts->max_snes_failures = fails;
5549: return(0);
5550: }
5554: /*@
5555: TSSetErrorIfStepFails - Error if no step succeeds
5557: Not Collective
5559: Input Parameter:
5560: + ts - TS context
5561: - err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure
5563: Options Database Key:
5564: . -ts_error_if_step_fails - Error if no step succeeds
5566: Level: intermediate
5568: .keywords: TS, set, error
5570: .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5571: @*/
5572: PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err)
5573: {
5576: ts->errorifstepfailed = err;
5577: return(0);
5578: }
5582: /*@C
5583: TSMonitorSolution - Monitors progress of the TS solvers by VecView() for the solution at each timestep. Normally the viewer is a binary file or a PetscDraw object
5585: Collective on TS
5587: Input Parameters:
5588: + ts - the TS context
5589: . step - current time-step
5590: . ptime - current time
5591: . u - current state
5592: - vf - viewer and its format
5594: Level: intermediate
5596: .keywords: TS, vector, monitor, view
5598: .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5599: @*/
5600: PetscErrorCode TSMonitorSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf)
5601: {
5605: PetscViewerPushFormat(vf->viewer,vf->format);
5606: VecView(u,vf->viewer);
5607: PetscViewerPopFormat(vf->viewer);
5608: return(0);
5609: }
5613: /*@C
5614: TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep.
5616: Collective on TS
5618: Input Parameters:
5619: + ts - the TS context
5620: . step - current time-step
5621: . ptime - current time
5622: . u - current state
5623: - filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5625: Level: intermediate
5627: Notes:
5628: 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.
5629: These are named according to the file name template.
5631: This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy().
5633: .keywords: TS, vector, monitor, view
5635: .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5636: @*/
5637: PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate)
5638: {
5640: char filename[PETSC_MAX_PATH_LEN];
5641: PetscViewer viewer;
5644: if (step < 0) return(0); /* -1 indicates interpolated solution */
5645: PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);
5646: PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);
5647: VecView(u,viewer);
5648: PetscViewerDestroy(&viewer);
5649: return(0);
5650: }
5654: /*@C
5655: TSMonitorSolutionVTKDestroy - Destroy context for monitoring
5657: Collective on TS
5659: Input Parameters:
5660: . filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5662: Level: intermediate
5664: Note:
5665: This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK().
5667: .keywords: TS, vector, monitor, view
5669: .seealso: TSMonitorSet(), TSMonitorSolutionVTK()
5670: @*/
5671: PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate)
5672: {
5676: PetscFree(*(char**)filenametemplate);
5677: return(0);
5678: }
5682: /*@
5683: TSGetAdapt - Get the adaptive controller context for the current method
5685: Collective on TS if controller has not been created yet
5687: Input Arguments:
5688: . ts - time stepping context
5690: Output Arguments:
5691: . adapt - adaptive controller
5693: Level: intermediate
5695: .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose()
5696: @*/
5697: PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt)
5698: {
5704: if (!ts->adapt) {
5705: TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);
5706: PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);
5707: PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);
5708: }
5709: *adapt = ts->adapt;
5710: return(0);
5711: }
5715: /*@
5716: TSSetTolerances - Set tolerances for local truncation error when using adaptive controller
5718: Logically Collective
5720: Input Arguments:
5721: + ts - time integration context
5722: . atol - scalar absolute tolerances, PETSC_DECIDE to leave current value
5723: . vatol - vector of absolute tolerances or NULL, used in preference to atol if present
5724: . rtol - scalar relative tolerances, PETSC_DECIDE to leave current value
5725: - vrtol - vector of relative tolerances or NULL, used in preference to atol if present
5727: Options Database keys:
5728: + -ts_rtol <rtol> - relative tolerance for local truncation error
5729: - -ts_atol <atol> Absolute tolerance for local truncation error
5731: Notes:
5732: With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error
5733: (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be
5734: computed only for the differential or the algebraic part then this can be done using the vector of
5735: tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the
5736: differential part and infinity for the algebraic part, the LTE calculation will include only the
5737: differential variables.
5739: Level: beginner
5741: .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances()
5742: @*/
5743: PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol)
5744: {
5748: if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol;
5749: if (vatol) {
5750: PetscObjectReference((PetscObject)vatol);
5751: VecDestroy(&ts->vatol);
5752: ts->vatol = vatol;
5753: }
5754: if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol;
5755: if (vrtol) {
5756: PetscObjectReference((PetscObject)vrtol);
5757: VecDestroy(&ts->vrtol);
5758: ts->vrtol = vrtol;
5759: }
5760: return(0);
5761: }
5765: /*@
5766: TSGetTolerances - Get tolerances for local truncation error when using adaptive controller
5768: Logically Collective
5770: Input Arguments:
5771: . ts - time integration context
5773: Output Arguments:
5774: + atol - scalar absolute tolerances, NULL to ignore
5775: . vatol - vector of absolute tolerances, NULL to ignore
5776: . rtol - scalar relative tolerances, NULL to ignore
5777: - vrtol - vector of relative tolerances, NULL to ignore
5779: Level: beginner
5781: .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances()
5782: @*/
5783: PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol)
5784: {
5786: if (atol) *atol = ts->atol;
5787: if (vatol) *vatol = ts->vatol;
5788: if (rtol) *rtol = ts->rtol;
5789: if (vrtol) *vrtol = ts->vrtol;
5790: return(0);
5791: }
5795: /*@
5796: TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors
5798: Collective on TS
5800: Input Arguments:
5801: + ts - time stepping context
5802: . U - state vector, usually ts->vec_sol
5803: - Y - state vector to be compared to U
5805: Output Arguments:
5806: . norm - weighted norm, a value of 1.0 is considered small
5808: Level: developer
5810: .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity()
5811: @*/
5812: PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm)
5813: {
5814: PetscErrorCode ierr;
5815: PetscInt i,n,N,rstart;
5816: const PetscScalar *u,*y;
5817: PetscReal sum,gsum;
5818: PetscReal tol;
5828: if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
5830: VecGetSize(U,&N);
5831: VecGetLocalSize(U,&n);
5832: VecGetOwnershipRange(U,&rstart,NULL);
5833: VecGetArrayRead(U,&u);
5834: VecGetArrayRead(Y,&y);
5835: sum = 0.;
5836: if (ts->vatol && ts->vrtol) {
5837: const PetscScalar *atol,*rtol;
5838: VecGetArrayRead(ts->vatol,&atol);
5839: VecGetArrayRead(ts->vrtol,&rtol);
5840: for (i=0; i<n; i++) {
5841: tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
5842: sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
5843: }
5844: VecRestoreArrayRead(ts->vatol,&atol);
5845: VecRestoreArrayRead(ts->vrtol,&rtol);
5846: } else if (ts->vatol) { /* vector atol, scalar rtol */
5847: const PetscScalar *atol;
5848: VecGetArrayRead(ts->vatol,&atol);
5849: for (i=0; i<n; i++) {
5850: tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
5851: sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
5852: }
5853: VecRestoreArrayRead(ts->vatol,&atol);
5854: } else if (ts->vrtol) { /* scalar atol, vector rtol */
5855: const PetscScalar *rtol;
5856: VecGetArrayRead(ts->vrtol,&rtol);
5857: for (i=0; i<n; i++) {
5858: tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
5859: sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
5860: }
5861: VecRestoreArrayRead(ts->vrtol,&rtol);
5862: } else { /* scalar atol, scalar rtol */
5863: for (i=0; i<n; i++) {
5864: tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
5865: sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
5866: }
5867: }
5868: VecRestoreArrayRead(U,&u);
5869: VecRestoreArrayRead(Y,&y);
5871: MPIU_Allreduce(&sum,&gsum,1,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));
5872: *norm = PetscSqrtReal(gsum / N);
5874: if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
5875: return(0);
5876: }
5880: /*@
5881: TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors
5883: Collective on TS
5885: Input Arguments:
5886: + ts - time stepping context
5887: . U - state vector, usually ts->vec_sol
5888: - Y - state vector to be compared to U
5890: Output Arguments:
5891: . norm - weighted norm, a value of 1.0 is considered small
5893: Level: developer
5895: .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2()
5896: @*/
5897: PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm)
5898: {
5899: PetscErrorCode ierr;
5900: PetscInt i,n,N,rstart,k;
5901: const PetscScalar *u,*y;
5902: PetscReal max,gmax;
5903: PetscReal tol;
5913: if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
5915: VecGetSize(U,&N);
5916: VecGetLocalSize(U,&n);
5917: VecGetOwnershipRange(U,&rstart,NULL);
5918: VecGetArrayRead(U,&u);
5919: VecGetArrayRead(Y,&y);
5920: if (ts->vatol && ts->vrtol) {
5921: const PetscScalar *atol,*rtol;
5922: VecGetArrayRead(ts->vatol,&atol);
5923: VecGetArrayRead(ts->vrtol,&rtol);
5924: k = 0;
5925: tol = PetscRealPart(atol[k]) + PetscRealPart(rtol[k]) * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
5926: max = PetscAbsScalar(y[k] - u[k]) / tol;
5927: for (i=1; i<n; i++) {
5928: tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
5929: max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
5930: }
5931: VecRestoreArrayRead(ts->vatol,&atol);
5932: VecRestoreArrayRead(ts->vrtol,&rtol);
5933: } else if (ts->vatol) { /* vector atol, scalar rtol */
5934: const PetscScalar *atol;
5935: VecGetArrayRead(ts->vatol,&atol);
5936: k = 0;
5937: tol = PetscRealPart(atol[k]) + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
5938: max = PetscAbsScalar(y[k] - u[k]) / tol;
5939: for (i=1; i<n; i++) {
5940: tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
5941: max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
5942: }
5943: VecRestoreArrayRead(ts->vatol,&atol);
5944: } else if (ts->vrtol) { /* scalar atol, vector rtol */
5945: const PetscScalar *rtol;
5946: VecGetArrayRead(ts->vrtol,&rtol);
5947: k = 0;
5948: tol = ts->atol + PetscRealPart(rtol[k]) * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
5949: max = PetscAbsScalar(y[k] - u[k]) / tol;
5950: for (i=1; i<n; i++) {
5951: tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
5952: max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
5953: }
5954: VecRestoreArrayRead(ts->vrtol,&rtol);
5955: } else { /* scalar atol, scalar rtol */
5956: k = 0;
5957: tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
5958: max = PetscAbsScalar(y[k] - u[k]) / tol;
5959: for (i=1; i<n; i++) {
5960: tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
5961: max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
5962: }
5963: }
5964: VecRestoreArrayRead(U,&u);
5965: VecRestoreArrayRead(Y,&y);
5967: MPIU_Allreduce(&max,&gmax,1,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));
5968: *norm = gmax;
5970: if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
5971: return(0);
5972: }
5976: /*@
5977: TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors
5979: Collective on TS
5981: Input Arguments:
5982: + ts - time stepping context
5983: . U - state vector, usually ts->vec_sol
5984: . Y - state vector to be compared to U
5985: - wnormtype - norm type, either NORM_2 or NORM_INFINITY
5987: Output Arguments:
5988: . norm - weighted norm, a value of 1.0 is considered small
5991: Options Database Keys:
5992: . -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
5994: Level: developer
5996: .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2()
5997: @*/
5998: PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm)
5999: {
6003: if (wnormtype == NORM_2) {
6004: TSErrorWeightedNorm2(ts,U,Y,norm);
6005: } else if(wnormtype == NORM_INFINITY) {
6006: TSErrorWeightedNormInfinity(ts,U,Y,norm);
6007: } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
6008: return(0);
6009: }
6013: /*@
6014: TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler
6016: Logically Collective on TS
6018: Input Arguments:
6019: + ts - time stepping context
6020: - cfltime - maximum stable time step if using forward Euler (value can be different on each process)
6022: Note:
6023: After calling this function, the global CFL time can be obtained by calling TSGetCFLTime()
6025: Level: intermediate
6027: .seealso: TSGetCFLTime(), TSADAPTCFL
6028: @*/
6029: PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime)
6030: {
6033: ts->cfltime_local = cfltime;
6034: ts->cfltime = -1.;
6035: return(0);
6036: }
6040: /*@
6041: TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler
6043: Collective on TS
6045: Input Arguments:
6046: . ts - time stepping context
6048: Output Arguments:
6049: . cfltime - maximum stable time step for forward Euler
6051: Level: advanced
6053: .seealso: TSSetCFLTimeLocal()
6054: @*/
6055: PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime)
6056: {
6060: if (ts->cfltime < 0) {
6061: MPIU_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));
6062: }
6063: *cfltime = ts->cfltime;
6064: return(0);
6065: }
6069: /*@
6070: TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
6072: Input Parameters:
6073: . ts - the TS context.
6074: . xl - lower bound.
6075: . xu - upper bound.
6077: Notes:
6078: If this routine is not called then the lower and upper bounds are set to
6079: PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp().
6081: Level: advanced
6083: @*/
6084: PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
6085: {
6087: SNES snes;
6090: TSGetSNES(ts,&snes);
6091: SNESVISetVariableBounds(snes,xl,xu);
6092: return(0);
6093: }
6095: #if defined(PETSC_HAVE_MATLAB_ENGINE)
6096: #include <mex.h>
6098: typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext;
6102: /*
6103: TSComputeFunction_Matlab - Calls the function that has been set with
6104: TSSetFunctionMatlab().
6106: Collective on TS
6108: Input Parameters:
6109: + snes - the TS context
6110: - u - input vector
6112: Output Parameter:
6113: . y - function vector, as set by TSSetFunction()
6115: Notes:
6116: TSComputeFunction() is typically used within nonlinear solvers
6117: implementations, so most users would not generally call this routine
6118: themselves.
6120: Level: developer
6122: .keywords: TS, nonlinear, compute, function
6124: .seealso: TSSetFunction(), TSGetFunction()
6125: */
6126: PetscErrorCode TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx)
6127: {
6128: PetscErrorCode ierr;
6129: TSMatlabContext *sctx = (TSMatlabContext*)ctx;
6130: int nlhs = 1,nrhs = 7;
6131: mxArray *plhs[1],*prhs[7];
6132: long long int lx = 0,lxdot = 0,ly = 0,ls = 0;
6142: PetscMemcpy(&ls,&snes,sizeof(snes));
6143: PetscMemcpy(&lx,&u,sizeof(u));
6144: PetscMemcpy(&lxdot,&udot,sizeof(udot));
6145: PetscMemcpy(&ly,&y,sizeof(u));
6147: prhs[0] = mxCreateDoubleScalar((double)ls);
6148: prhs[1] = mxCreateDoubleScalar(time);
6149: prhs[2] = mxCreateDoubleScalar((double)lx);
6150: prhs[3] = mxCreateDoubleScalar((double)lxdot);
6151: prhs[4] = mxCreateDoubleScalar((double)ly);
6152: prhs[5] = mxCreateString(sctx->funcname);
6153: prhs[6] = sctx->ctx;
6154: mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");
6155: mxGetScalar(plhs[0]);
6156: mxDestroyArray(prhs[0]);
6157: mxDestroyArray(prhs[1]);
6158: mxDestroyArray(prhs[2]);
6159: mxDestroyArray(prhs[3]);
6160: mxDestroyArray(prhs[4]);
6161: mxDestroyArray(prhs[5]);
6162: mxDestroyArray(plhs[0]);
6163: return(0);
6164: }
6169: /*
6170: TSSetFunctionMatlab - Sets the function evaluation routine and function
6171: vector for use by the TS routines in solving ODEs
6172: equations from MATLAB. Here the function is a string containing the name of a MATLAB function
6174: Logically Collective on TS
6176: Input Parameters:
6177: + ts - the TS context
6178: - func - function evaluation routine
6180: Calling sequence of func:
6181: $ func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx);
6183: Level: beginner
6185: .keywords: TS, nonlinear, set, function
6187: .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
6188: */
6189: PetscErrorCode TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx)
6190: {
6191: PetscErrorCode ierr;
6192: TSMatlabContext *sctx;
6195: /* currently sctx is memory bleed */
6196: PetscMalloc(sizeof(TSMatlabContext),&sctx);
6197: PetscStrallocpy(func,&sctx->funcname);
6198: /*
6199: This should work, but it doesn't
6200: sctx->ctx = ctx;
6201: mexMakeArrayPersistent(sctx->ctx);
6202: */
6203: sctx->ctx = mxDuplicateArray(ctx);
6205: TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);
6206: return(0);
6207: }
6211: /*
6212: TSComputeJacobian_Matlab - Calls the function that has been set with
6213: TSSetJacobianMatlab().
6215: Collective on TS
6217: Input Parameters:
6218: + ts - the TS context
6219: . u - input vector
6220: . A, B - the matrices
6221: - ctx - user context
6223: Level: developer
6225: .keywords: TS, nonlinear, compute, function
6227: .seealso: TSSetFunction(), TSGetFunction()
6228: @*/
6229: PetscErrorCode TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx)
6230: {
6231: PetscErrorCode ierr;
6232: TSMatlabContext *sctx = (TSMatlabContext*)ctx;
6233: int nlhs = 2,nrhs = 9;
6234: mxArray *plhs[2],*prhs[9];
6235: long long int lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0;
6241: /* call Matlab function in ctx with arguments u and y */
6243: PetscMemcpy(&ls,&ts,sizeof(ts));
6244: PetscMemcpy(&lx,&u,sizeof(u));
6245: PetscMemcpy(&lxdot,&udot,sizeof(u));
6246: PetscMemcpy(&lA,A,sizeof(u));
6247: PetscMemcpy(&lB,B,sizeof(u));
6249: prhs[0] = mxCreateDoubleScalar((double)ls);
6250: prhs[1] = mxCreateDoubleScalar((double)time);
6251: prhs[2] = mxCreateDoubleScalar((double)lx);
6252: prhs[3] = mxCreateDoubleScalar((double)lxdot);
6253: prhs[4] = mxCreateDoubleScalar((double)shift);
6254: prhs[5] = mxCreateDoubleScalar((double)lA);
6255: prhs[6] = mxCreateDoubleScalar((double)lB);
6256: prhs[7] = mxCreateString(sctx->funcname);
6257: prhs[8] = sctx->ctx;
6258: mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");
6259: mxGetScalar(plhs[0]);
6260: mxDestroyArray(prhs[0]);
6261: mxDestroyArray(prhs[1]);
6262: mxDestroyArray(prhs[2]);
6263: mxDestroyArray(prhs[3]);
6264: mxDestroyArray(prhs[4]);
6265: mxDestroyArray(prhs[5]);
6266: mxDestroyArray(prhs[6]);
6267: mxDestroyArray(prhs[7]);
6268: mxDestroyArray(plhs[0]);
6269: mxDestroyArray(plhs[1]);
6270: return(0);
6271: }
6276: /*
6277: TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
6278: 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
6280: Logically Collective on TS
6282: Input Parameters:
6283: + ts - the TS context
6284: . A,B - Jacobian matrices
6285: . func - function evaluation routine
6286: - ctx - user context
6288: Calling sequence of func:
6289: $ flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx);
6292: Level: developer
6294: .keywords: TS, nonlinear, set, function
6296: .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
6297: */
6298: PetscErrorCode TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx)
6299: {
6300: PetscErrorCode ierr;
6301: TSMatlabContext *sctx;
6304: /* currently sctx is memory bleed */
6305: PetscMalloc(sizeof(TSMatlabContext),&sctx);
6306: PetscStrallocpy(func,&sctx->funcname);
6307: /*
6308: This should work, but it doesn't
6309: sctx->ctx = ctx;
6310: mexMakeArrayPersistent(sctx->ctx);
6311: */
6312: sctx->ctx = mxDuplicateArray(ctx);
6314: TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);
6315: return(0);
6316: }
6320: /*
6321: TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab().
6323: Collective on TS
6325: .seealso: TSSetFunction(), TSGetFunction()
6326: @*/
6327: PetscErrorCode TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx)
6328: {
6329: PetscErrorCode ierr;
6330: TSMatlabContext *sctx = (TSMatlabContext*)ctx;
6331: int nlhs = 1,nrhs = 6;
6332: mxArray *plhs[1],*prhs[6];
6333: long long int lx = 0,ls = 0;
6339: PetscMemcpy(&ls,&ts,sizeof(ts));
6340: PetscMemcpy(&lx,&u,sizeof(u));
6342: prhs[0] = mxCreateDoubleScalar((double)ls);
6343: prhs[1] = mxCreateDoubleScalar((double)it);
6344: prhs[2] = mxCreateDoubleScalar((double)time);
6345: prhs[3] = mxCreateDoubleScalar((double)lx);
6346: prhs[4] = mxCreateString(sctx->funcname);
6347: prhs[5] = sctx->ctx;
6348: mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");
6349: mxGetScalar(plhs[0]);
6350: mxDestroyArray(prhs[0]);
6351: mxDestroyArray(prhs[1]);
6352: mxDestroyArray(prhs[2]);
6353: mxDestroyArray(prhs[3]);
6354: mxDestroyArray(prhs[4]);
6355: mxDestroyArray(plhs[0]);
6356: return(0);
6357: }
6362: /*
6363: TSMonitorSetMatlab - Sets the monitor function from Matlab
6365: Level: developer
6367: .keywords: TS, nonlinear, set, function
6369: .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
6370: */
6371: PetscErrorCode TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx)
6372: {
6373: PetscErrorCode ierr;
6374: TSMatlabContext *sctx;
6377: /* currently sctx is memory bleed */
6378: PetscMalloc(sizeof(TSMatlabContext),&sctx);
6379: PetscStrallocpy(func,&sctx->funcname);
6380: /*
6381: This should work, but it doesn't
6382: sctx->ctx = ctx;
6383: mexMakeArrayPersistent(sctx->ctx);
6384: */
6385: sctx->ctx = mxDuplicateArray(ctx);
6387: TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);
6388: return(0);
6389: }
6390: #endif
6394: /*@C
6395: TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector
6396: in a time based line graph
6398: Collective on TS
6400: Input Parameters:
6401: + ts - the TS context
6402: . step - current time-step
6403: . ptime - current time
6404: . u - current solution
6405: - dctx - the TSMonitorLGCtx object that contains all the options for the monitoring, this is created with TSMonitorLGCtxCreate()
6407: Options Database:
6408: . -ts_monitor_lg_solution_variables
6410: Level: intermediate
6412: Notes: Each process in a parallel run displays its component solutions in a separate window
6414: .keywords: TS, vector, monitor, view
6416: .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
6417: TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
6418: TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
6419: TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
6420: @*/
6421: PetscErrorCode TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
6422: {
6423: PetscErrorCode ierr;
6424: TSMonitorLGCtx ctx = (TSMonitorLGCtx)dctx;
6425: const PetscScalar *yy;
6426: Vec v;
6429: if (step < 0) return(0); /* -1 indicates interpolated solution */
6430: if (!step) {
6431: PetscDrawAxis axis;
6432: PetscInt dim;
6433: PetscDrawLGGetAxis(ctx->lg,&axis);
6434: PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");
6435: if (ctx->names && !ctx->displaynames) {
6436: char **displaynames;
6437: PetscBool flg;
6438: VecGetLocalSize(u,&dim);
6439: PetscMalloc((dim+1)*sizeof(char*),&displaynames);
6440: PetscMemzero(displaynames,(dim+1)*sizeof(char*));
6441: PetscOptionsGetStringArray(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);
6442: if (flg) {
6443: TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);
6444: }
6445: PetscStrArrayDestroy(&displaynames);
6446: }
6447: if (ctx->displaynames) {
6448: PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);
6449: PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);
6450: } else if (ctx->names) {
6451: VecGetLocalSize(u,&dim);
6452: PetscDrawLGSetDimension(ctx->lg,dim);
6453: PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);
6454: } else {
6455: VecGetLocalSize(u,&dim);
6456: PetscDrawLGSetDimension(ctx->lg,dim);
6457: }
6458: PetscDrawLGReset(ctx->lg);
6459: }
6461: if (!ctx->transform) v = u;
6462: else {(*ctx->transform)(ctx->transformctx,u,&v);}
6463: VecGetArrayRead(v,&yy);
6464: if (ctx->displaynames) {
6465: PetscInt i;
6466: for (i=0; i<ctx->ndisplayvariables; i++)
6467: ctx->displayvalues[i] = PetscRealPart(yy[ctx->displayvariables[i]]);
6468: PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);
6469: } else {
6470: #if defined(PETSC_USE_COMPLEX)
6471: PetscInt i,n;
6472: PetscReal *yreal;
6473: VecGetLocalSize(v,&n);
6474: PetscMalloc1(n,&yreal);
6475: for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
6476: PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);
6477: PetscFree(yreal);
6478: #else
6479: PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);
6480: #endif
6481: }
6482: VecRestoreArrayRead(v,&yy);
6483: if (ctx->transform) {VecDestroy(&v);}
6485: if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
6486: PetscDrawLGDraw(ctx->lg);
6487: PetscDrawLGSave(ctx->lg);
6488: }
6489: return(0);
6490: }
6495: /*@C
6496: TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
6498: Collective on TS
6500: Input Parameters:
6501: + ts - the TS context
6502: - names - the names of the components, final string must be NULL
6504: Level: intermediate
6506: Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
6508: .keywords: TS, vector, monitor, view
6510: .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames()
6511: @*/
6512: PetscErrorCode TSMonitorLGSetVariableNames(TS ts,const char * const *names)
6513: {
6514: PetscErrorCode ierr;
6515: PetscInt i;
6518: for (i=0; i<ts->numbermonitors; i++) {
6519: if (ts->monitor[i] == TSMonitorLGSolution) {
6520: TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);
6521: break;
6522: }
6523: }
6524: return(0);
6525: }
6529: /*@C
6530: TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
6532: Collective on TS
6534: Input Parameters:
6535: + ts - the TS context
6536: - names - the names of the components, final string must be NULL
6538: Level: intermediate
6540: .keywords: TS, vector, monitor, view
6542: .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames()
6543: @*/
6544: PetscErrorCode TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names)
6545: {
6546: PetscErrorCode ierr;
6549: PetscStrArrayDestroy(&ctx->names);
6550: PetscStrArrayallocpy(names,&ctx->names);
6551: return(0);
6552: }
6556: /*@C
6557: TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot
6559: Collective on TS
6561: Input Parameter:
6562: . ts - the TS context
6564: Output Parameter:
6565: . names - the names of the components, final string must be NULL
6567: Level: intermediate
6569: Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
6571: .keywords: TS, vector, monitor, view
6573: .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
6574: @*/
6575: PetscErrorCode TSMonitorLGGetVariableNames(TS ts,const char *const **names)
6576: {
6577: PetscInt i;
6580: *names = NULL;
6581: for (i=0; i<ts->numbermonitors; i++) {
6582: if (ts->monitor[i] == TSMonitorLGSolution) {
6583: TSMonitorLGCtx ctx = (TSMonitorLGCtx) ts->monitorcontext[i];
6584: *names = (const char *const *)ctx->names;
6585: break;
6586: }
6587: }
6588: return(0);
6589: }
6593: /*@C
6594: TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor
6596: Collective on TS
6598: Input Parameters:
6599: + ctx - the TSMonitorLG context
6600: . displaynames - the names of the components, final string must be NULL
6602: Level: intermediate
6604: .keywords: TS, vector, monitor, view
6606: .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
6607: @*/
6608: PetscErrorCode TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames)
6609: {
6610: PetscInt j = 0,k;
6611: PetscErrorCode ierr;
6614: if (!ctx->names) return(0);
6615: PetscStrArrayDestroy(&ctx->displaynames);
6616: PetscStrArrayallocpy(displaynames,&ctx->displaynames);
6617: while (displaynames[j]) j++;
6618: ctx->ndisplayvariables = j;
6619: PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);
6620: PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);
6621: j = 0;
6622: while (displaynames[j]) {
6623: k = 0;
6624: while (ctx->names[k]) {
6625: PetscBool flg;
6626: PetscStrcmp(displaynames[j],ctx->names[k],&flg);
6627: if (flg) {
6628: ctx->displayvariables[j] = k;
6629: break;
6630: }
6631: k++;
6632: }
6633: j++;
6634: }
6635: return(0);
6636: }
6641: /*@C
6642: TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor
6644: Collective on TS
6646: Input Parameters:
6647: + ts - the TS context
6648: . displaynames - the names of the components, final string must be NULL
6650: Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
6652: Level: intermediate
6654: .keywords: TS, vector, monitor, view
6656: .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
6657: @*/
6658: PetscErrorCode TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames)
6659: {
6660: PetscInt i;
6661: PetscErrorCode ierr;
6664: for (i=0; i<ts->numbermonitors; i++) {
6665: if (ts->monitor[i] == TSMonitorLGSolution) {
6666: TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);
6667: break;
6668: }
6669: }
6670: return(0);
6671: }
6675: /*@C
6676: TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed
6678: Collective on TS
6680: Input Parameters:
6681: + ts - the TS context
6682: . transform - the transform function
6683: . destroy - function to destroy the optional context
6684: - ctx - optional context used by transform function
6686: Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
6688: Level: intermediate
6690: .keywords: TS, vector, monitor, view
6692: .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform()
6693: @*/
6694: PetscErrorCode TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
6695: {
6696: PetscInt i;
6697: PetscErrorCode ierr;
6700: for (i=0; i<ts->numbermonitors; i++) {
6701: if (ts->monitor[i] == TSMonitorLGSolution) {
6702: TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);
6703: }
6704: }
6705: return(0);
6706: }
6710: /*@C
6711: TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed
6713: Collective on TSLGCtx
6715: Input Parameters:
6716: + ts - the TS context
6717: . transform - the transform function
6718: . destroy - function to destroy the optional context
6719: - ctx - optional context used by transform function
6721: Level: intermediate
6723: .keywords: TS, vector, monitor, view
6725: .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform()
6726: @*/
6727: PetscErrorCode TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
6728: {
6730: ctx->transform = transform;
6731: ctx->transformdestroy = destroy;
6732: ctx->transformctx = tctx;
6733: return(0);
6734: }
6738: /*@C
6739: TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector
6740: in a time based line graph
6742: Collective on TS
6744: Input Parameters:
6745: + ts - the TS context
6746: . step - current time-step
6747: . ptime - current time
6748: . u - current solution
6749: - dctx - TSMonitorLGCtx object created with TSMonitorLGCtxCreate()
6751: Level: intermediate
6753: Notes: Each process in a parallel run displays its component errors in a separate window
6755: The user must provide the solution using TSSetSolutionFunction() to use this monitor.
6757: Options Database Keys:
6758: . -ts_monitor_lg_error - create a graphical monitor of error history
6760: .keywords: TS, vector, monitor, view
6762: .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
6763: @*/
6764: PetscErrorCode TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
6765: {
6766: PetscErrorCode ierr;
6767: TSMonitorLGCtx ctx = (TSMonitorLGCtx)dummy;
6768: const PetscScalar *yy;
6769: Vec y;
6772: if (!step) {
6773: PetscDrawAxis axis;
6774: PetscInt dim;
6775: PetscDrawLGGetAxis(ctx->lg,&axis);
6776: PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");
6777: VecGetLocalSize(u,&dim);
6778: PetscDrawLGSetDimension(ctx->lg,dim);
6779: PetscDrawLGReset(ctx->lg);
6780: }
6781: VecDuplicate(u,&y);
6782: TSComputeSolutionFunction(ts,ptime,y);
6783: VecAXPY(y,-1.0,u);
6784: VecGetArrayRead(y,&yy);
6785: #if defined(PETSC_USE_COMPLEX)
6786: {
6787: PetscReal *yreal;
6788: PetscInt i,n;
6789: VecGetLocalSize(y,&n);
6790: PetscMalloc1(n,&yreal);
6791: for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
6792: PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);
6793: PetscFree(yreal);
6794: }
6795: #else
6796: PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);
6797: #endif
6798: VecRestoreArrayRead(y,&yy);
6799: VecDestroy(&y);
6800: if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
6801: PetscDrawLGDraw(ctx->lg);
6802: PetscDrawLGSave(ctx->lg);
6803: }
6804: return(0);
6805: }
6809: PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
6810: {
6811: TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
6812: PetscReal x = ptime,y;
6814: PetscInt its;
6817: if (n < 0) return(0); /* -1 indicates interpolated solution */
6818: if (!n) {
6819: PetscDrawAxis axis;
6820: PetscDrawLGGetAxis(ctx->lg,&axis);
6821: PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");
6822: PetscDrawLGReset(ctx->lg);
6823: ctx->snes_its = 0;
6824: }
6825: TSGetSNESIterations(ts,&its);
6826: y = its - ctx->snes_its;
6827: PetscDrawLGAddPoint(ctx->lg,&x,&y);
6828: if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
6829: PetscDrawLGDraw(ctx->lg);
6830: PetscDrawLGSave(ctx->lg);
6831: }
6832: ctx->snes_its = its;
6833: return(0);
6834: }
6838: PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
6839: {
6840: TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
6841: PetscReal x = ptime,y;
6843: PetscInt its;
6846: if (n < 0) return(0); /* -1 indicates interpolated solution */
6847: if (!n) {
6848: PetscDrawAxis axis;
6849: PetscDrawLGGetAxis(ctx->lg,&axis);
6850: PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");
6851: PetscDrawLGReset(ctx->lg);
6852: ctx->ksp_its = 0;
6853: }
6854: TSGetKSPIterations(ts,&its);
6855: y = its - ctx->ksp_its;
6856: PetscDrawLGAddPoint(ctx->lg,&x,&y);
6857: if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
6858: PetscDrawLGDraw(ctx->lg);
6859: PetscDrawLGSave(ctx->lg);
6860: }
6861: ctx->ksp_its = its;
6862: return(0);
6863: }
6867: /*@
6868: TSComputeLinearStability - computes the linear stability function at a point
6870: Collective on TS and Vec
6872: Input Parameters:
6873: + ts - the TS context
6874: - xr,xi - real and imaginary part of input arguments
6876: Output Parameters:
6877: . yr,yi - real and imaginary part of function value
6879: Level: developer
6881: .keywords: TS, compute
6883: .seealso: TSSetRHSFunction(), TSComputeIFunction()
6884: @*/
6885: PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi)
6886: {
6891: if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method");
6892: (*ts->ops->linearstability)(ts,xr,xi,yr,yi);
6893: return(0);
6894: }
6896: /* ------------------------------------------------------------------------*/
6899: /*@C
6900: TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope()
6902: Collective on TS
6904: Input Parameters:
6905: . ts - the ODE solver object
6907: Output Parameter:
6908: . ctx - the context
6910: Level: intermediate
6912: .keywords: TS, monitor, line graph, residual, seealso
6914: .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
6916: @*/
6917: PetscErrorCode TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx)
6918: {
6922: PetscNew(ctx);
6923: return(0);
6924: }
6928: /*@C
6929: TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution
6931: Collective on TS
6933: Input Parameters:
6934: + ts - the TS context
6935: . step - current time-step
6936: . ptime - current time
6937: . u - current solution
6938: - dctx - the envelope context
6940: Options Database:
6941: . -ts_monitor_envelope
6943: Level: intermediate
6945: Notes: after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope
6947: .keywords: TS, vector, monitor, view
6949: .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxCreate()
6950: @*/
6951: PetscErrorCode TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
6952: {
6953: PetscErrorCode ierr;
6954: TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dctx;
6957: if (!ctx->max) {
6958: VecDuplicate(u,&ctx->max);
6959: VecDuplicate(u,&ctx->min);
6960: VecCopy(u,ctx->max);
6961: VecCopy(u,ctx->min);
6962: } else {
6963: VecPointwiseMax(ctx->max,u,ctx->max);
6964: VecPointwiseMin(ctx->min,u,ctx->min);
6965: }
6966: return(0);
6967: }
6972: /*@C
6973: TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution
6975: Collective on TS
6977: Input Parameter:
6978: . ts - the TS context
6980: Output Parameter:
6981: + max - the maximum values
6982: - min - the minimum values
6984: Notes: If the TS does not have a TSMonitorEnvelopeCtx associated with it then this function is ignored
6986: Level: intermediate
6988: .keywords: TS, vector, monitor, view
6990: .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
6991: @*/
6992: PetscErrorCode TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min)
6993: {
6994: PetscInt i;
6997: if (max) *max = NULL;
6998: if (min) *min = NULL;
6999: for (i=0; i<ts->numbermonitors; i++) {
7000: if (ts->monitor[i] == TSMonitorEnvelope) {
7001: TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i];
7002: if (max) *max = ctx->max;
7003: if (min) *min = ctx->min;
7004: break;
7005: }
7006: }
7007: return(0);
7008: }
7012: /*@C
7013: TSMonitorEnvelopeCtxDestroy - Destroys a context that was created with TSMonitorEnvelopeCtxCreate().
7015: Collective on TSMonitorEnvelopeCtx
7017: Input Parameter:
7018: . ctx - the monitor context
7020: Level: intermediate
7022: .keywords: TS, monitor, line graph, destroy
7024: .seealso: TSMonitorLGCtxCreate(), TSMonitorSet(), TSMonitorLGTimeStep()
7025: @*/
7026: PetscErrorCode TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx)
7027: {
7031: VecDestroy(&(*ctx)->min);
7032: VecDestroy(&(*ctx)->max);
7033: PetscFree(*ctx);
7034: return(0);
7035: }
7039: /*@
7040: TSRollBack - Rolls back one time step
7042: Collective on TS
7044: Input Parameter:
7045: . ts - the TS context obtained from TSCreate()
7047: Level: advanced
7049: .keywords: TS, timestep, rollback
7051: .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate()
7052: @*/
7053: PetscErrorCode TSRollBack(TS ts)
7054: {
7059: if (ts->steprollback) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"TSRollBack already called");
7060: if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name);
7061: (*ts->ops->rollback)(ts);
7062: ts->time_step = ts->ptime - ts->ptime_prev;
7063: ts->ptime = ts->ptime_prev;
7064: ts->ptime_prev = ts->ptime_prev_rollback;
7065: ts->steps--; ts->total_steps--;
7066: ts->steprollback = PETSC_TRUE;
7067: return(0);
7068: }
7072: /*@
7073: TSGetStages - Get the number of stages and stage values
7075: Input Parameter:
7076: . ts - the TS context obtained from TSCreate()
7078: Level: advanced
7080: .keywords: TS, getstages
7082: .seealso: TSCreate()
7083: @*/
7084: PetscErrorCode TSGetStages(TS ts,PetscInt *ns,Vec **Y)
7085: {
7092: if (!ts->ops->getstages) *ns=0;
7093: else {
7094: (*ts->ops->getstages)(ts,ns,Y);
7095: }
7096: return(0);
7097: }
7101: /*@C
7102: TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity.
7104: Collective on SNES
7106: Input Parameters:
7107: + ts - the TS context
7108: . t - current timestep
7109: . U - state vector
7110: . Udot - time derivative of state vector
7111: . shift - shift to apply, see note below
7112: - ctx - an optional user context
7114: Output Parameters:
7115: + J - Jacobian matrix (not altered in this routine)
7116: - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J)
7118: Level: intermediate
7120: Notes:
7121: If F(t,U,Udot)=0 is the DAE, the required Jacobian is
7123: dF/dU + shift*dF/dUdot
7125: Most users should not need to explicitly call this routine, as it
7126: is used internally within the nonlinear solvers.
7128: This will first try to get the coloring from the DM. If the DM type has no coloring
7129: routine, then it will try to get the coloring from the matrix. This requires that the
7130: matrix have nonzero entries precomputed.
7132: .keywords: TS, finite differences, Jacobian, coloring, sparse
7133: .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction()
7134: @*/
7135: PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx)
7136: {
7137: SNES snes;
7138: MatFDColoring color;
7139: PetscBool hascolor, matcolor = PETSC_FALSE;
7143: PetscOptionsGetBool(((PetscObject)ts)->options,((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL);
7144: PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color);
7145: if (!color) {
7146: DM dm;
7147: ISColoring iscoloring;
7149: TSGetDM(ts, &dm);
7150: DMHasColoring(dm, &hascolor);
7151: if (hascolor && !matcolor) {
7152: DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring);
7153: MatFDColoringCreate(B, iscoloring, &color);
7154: MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);
7155: MatFDColoringSetFromOptions(color);
7156: MatFDColoringSetUp(B, iscoloring, color);
7157: ISColoringDestroy(&iscoloring);
7158: } else {
7159: MatColoring mc;
7161: MatColoringCreate(B, &mc);
7162: MatColoringSetDistance(mc, 2);
7163: MatColoringSetType(mc, MATCOLORINGSL);
7164: MatColoringSetFromOptions(mc);
7165: MatColoringApply(mc, &iscoloring);
7166: MatColoringDestroy(&mc);
7167: MatFDColoringCreate(B, iscoloring, &color);
7168: MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);
7169: MatFDColoringSetFromOptions(color);
7170: MatFDColoringSetUp(B, iscoloring, color);
7171: ISColoringDestroy(&iscoloring);
7172: }
7173: PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color);
7174: PetscObjectDereference((PetscObject) color);
7175: }
7176: TSGetSNES(ts, &snes);
7177: MatFDColoringApply(B, color, U, snes);
7178: if (J != B) {
7179: MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY);
7180: MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY);
7181: }
7182: return(0);
7183: }
7187: /*@
7188: TSSetFunctionDomainError - Set the function testing if the current state vector is valid
7190: Input Parameters:
7191: ts - the TS context
7192: func - function called within TSFunctionDomainError
7194: Level: intermediate
7196: .keywords: TS, state, domain
7197: .seealso: TSAdaptCheckStage(), TSFunctionDomainError()
7198: @*/
7200: PetscErrorCode TSSetFunctionDomainError(TS ts, PetscErrorCode (*func)(TS,PetscReal,Vec,PetscBool*))
7201: {
7204: ts->functiondomainerror = func;
7205: return(0);
7206: }
7210: /*@
7211: TSFunctionDomainError - Check if the current state is valid
7213: Input Parameters:
7214: ts - the TS context
7215: stagetime - time of the simulation
7216: Y - state vector to check.
7218: Output Parameter:
7219: accept - Set to PETSC_FALSE if the current state vector is valid.
7221: Note:
7222: This function should be used to ensure the state is in a valid part of the space.
7223: For example, one can ensure here all values are positive.
7225: Level: advanced
7226: @*/
7227: PetscErrorCode TSFunctionDomainError(TS ts,PetscReal stagetime,Vec Y,PetscBool* accept)
7228: {
7234: *accept = PETSC_TRUE;
7235: if (ts->functiondomainerror) {
7236: PetscStackCallStandard((*ts->functiondomainerror),(ts,stagetime,Y,accept));
7237: }
7238: return(0);
7239: }
7241: #undef __FUNCT__
7243: /*@C
7244: TSClone - This function clones a time step object.
7246: Collective on MPI_Comm
7248: Input Parameter:
7249: . tsin - The input TS
7251: Output Parameter:
7252: . tsout - The output TS (cloned)
7254: Notes:
7255: 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.
7257: 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); TSSetSNES(ts,snes_dup);
7259: Level: developer
7261: .keywords: TS, clone
7262: .seealso: TSCreate(), TSSetType(), TSSetUp(), TSDestroy(), TSSetProblemType()
7263: @*/
7264: PetscErrorCode TSClone(TS tsin, TS *tsout)
7265: {
7266: TS t;
7268: SNES snes_start;
7269: DM dm;
7270: TSType type;
7274: *tsout = NULL;
7276: PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView);
7278: /* General TS description */
7279: t->numbermonitors = 0;
7280: t->setupcalled = 0;
7281: t->ksp_its = 0;
7282: t->snes_its = 0;
7283: t->nwork = 0;
7284: t->rhsjacobian.time = -1e20;
7285: t->rhsjacobian.scale = 1.;
7286: t->ijacobian.shift = 1.;
7288: TSGetSNES(tsin,&snes_start);
7289: TSSetSNES(t,snes_start);
7291: TSGetDM(tsin,&dm);
7292: TSSetDM(t,dm);
7294: t->adapt = tsin->adapt;
7295: PetscObjectReference((PetscObject)t->adapt);
7297: t->problem_type = tsin->problem_type;
7298: t->ptime = tsin->ptime;
7299: t->time_step = tsin->time_step;
7300: t->max_time = tsin->max_time;
7301: t->steps = tsin->steps;
7302: t->max_steps = tsin->max_steps;
7303: t->equation_type = tsin->equation_type;
7304: t->atol = tsin->atol;
7305: t->rtol = tsin->rtol;
7306: t->max_snes_failures = tsin->max_snes_failures;
7307: t->max_reject = tsin->max_reject;
7308: t->errorifstepfailed = tsin->errorifstepfailed;
7310: TSGetType(tsin,&type);
7311: TSSetType(t,type);
7313: t->vec_sol = NULL;
7315: t->cfltime = tsin->cfltime;
7316: t->cfltime_local = tsin->cfltime_local;
7317: t->exact_final_time = tsin->exact_final_time;
7319: PetscMemcpy(t->ops,tsin->ops,sizeof(struct _TSOps));
7321: if (((PetscObject)tsin)->fortran_func_pointers) {
7322: PetscInt i;
7323: PetscMalloc((10)*sizeof(void(*)(void)),&((PetscObject)t)->fortran_func_pointers);
7324: for (i=0; i<10; i++) {
7325: ((PetscObject)t)->fortran_func_pointers[i] = ((PetscObject)tsin)->fortran_func_pointers[i];
7326: }
7327: }
7328: *tsout = t;
7329: return(0);
7330: }