Actual source code: traj.c
1: #include <petsc/private/tsimpl.h>
2: #include <petsc/private/tshistoryimpl.h>
3: #include <petscdm.h>
5: PetscFunctionList TSTrajectoryList = NULL;
6: PetscBool TSTrajectoryRegisterAllCalled = PETSC_FALSE;
7: PetscClassId TSTRAJECTORY_CLASSID;
8: PetscLogEvent TSTrajectory_Set, TSTrajectory_Get, TSTrajectory_GetVecs, TSTrajectory_SetUp;
10: /*@
11: TSTrajectoryRegister - Adds a way of storing trajectories to the `TS` package
13: Not Collective, No Fortran Support
15: Input Parameters:
16: + sname - the name of a new user-defined creation routine
17: - function - the creation routine itself
19: Level: developer
21: Note:
22: `TSTrajectoryRegister()` may be called multiple times to add several user-defined tses.
24: .seealso: [](ch_ts), `TSTrajectoryRegisterAll()`
25: @*/
26: PetscErrorCode TSTrajectoryRegister(const char sname[], PetscErrorCode (*function)(TSTrajectory, TS))
27: {
28: PetscFunctionBegin;
29: PetscCall(PetscFunctionListAdd(&TSTrajectoryList, sname, function));
30: PetscFunctionReturn(PETSC_SUCCESS);
31: }
33: /*@
34: TSTrajectorySet - Sets a vector of state in the trajectory object
36: Collective
38: Input Parameters:
39: + tj - the trajectory object
40: . ts - the time stepper object (optional)
41: . stepnum - the step number
42: . time - the current time
43: - X - the current solution
45: Level: developer
47: Note:
48: Usually one does not call this routine, it is called automatically during `TSSolve()`
50: .seealso: [](ch_ts), `TSTrajectorySetUp()`, `TSTrajectoryDestroy()`, `TSTrajectorySetType()`, `TSTrajectorySetVariableNames()`, `TSGetTrajectory()`, `TSTrajectoryGet()`, `TSTrajectoryGetVecs()`
51: @*/
52: PetscErrorCode TSTrajectorySet(TSTrajectory tj, TS ts, PetscInt stepnum, PetscReal time, Vec X)
53: {
54: PetscFunctionBegin;
55: if (!tj) PetscFunctionReturn(PETSC_SUCCESS);
61: PetscCheck(tj->setupcalled, PetscObjectComm((PetscObject)tj), PETSC_ERR_ORDER, "TSTrajectorySetUp should be called first");
62: if (tj->monitor) PetscCall(PetscViewerASCIIPrintf(tj->monitor, "TSTrajectorySet: stepnum %" PetscInt_FMT ", time %g (stages %" PetscInt_FMT ")\n", stepnum, (double)time, (PetscInt)!tj->solution_only));
63: PetscCall(PetscLogEventBegin(TSTrajectory_Set, tj, ts, 0, 0));
64: PetscUseTypeMethod(tj, set, ts, stepnum, time, X);
65: PetscCall(PetscLogEventEnd(TSTrajectory_Set, tj, ts, 0, 0));
66: if (tj->usehistory) PetscCall(TSHistoryUpdate(tj->tsh, stepnum, time));
67: if (tj->lag.caching) tj->lag.Udotcached.time = PETSC_MIN_REAL;
68: PetscFunctionReturn(PETSC_SUCCESS);
69: }
71: /*@
72: TSTrajectoryGetNumSteps - Return the number of steps registered in the `TSTrajectory` via `TSTrajectorySet()`.
74: Not Collective.
76: Input Parameter:
77: . tj - the trajectory object
79: Output Parameter:
80: . steps - the number of steps
82: Level: developer
84: .seealso: [](ch_ts), `TS`, `TSTrajectorySet()`
85: @*/
86: PetscErrorCode TSTrajectoryGetNumSteps(TSTrajectory tj, PetscInt *steps)
87: {
88: PetscFunctionBegin;
90: PetscAssertPointer(steps, 2);
91: PetscCall(TSHistoryGetNumSteps(tj->tsh, steps));
92: PetscFunctionReturn(PETSC_SUCCESS);
93: }
95: /*@
96: TSTrajectoryGet - Updates the solution vector of a time stepper object by querying the `TSTrajectory`
98: Collective
100: Input Parameters:
101: + tj - the trajectory object
102: . ts - the time stepper object
103: - stepnum - the step number
105: Output Parameter:
106: . time - the time associated with the step number
108: Level: developer
110: Note:
111: Usually one does not call this routine, it is called automatically during `TSSolve()`
113: .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSTrajectorySetUp()`, `TSTrajectoryDestroy()`, `TSTrajectorySetType()`, `TSTrajectorySetVariableNames()`, `TSGetTrajectory()`, `TSTrajectorySet()`, `TSTrajectoryGetVecs()`, `TSGetSolution()`
114: @*/
115: PetscErrorCode TSTrajectoryGet(TSTrajectory tj, TS ts, PetscInt stepnum, PetscReal *time)
116: {
117: PetscFunctionBegin;
118: PetscCheck(tj, PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_WRONGSTATE, "TS solver did not save trajectory");
122: PetscAssertPointer(time, 4);
123: PetscCheck(tj->setupcalled, PetscObjectComm((PetscObject)tj), PETSC_ERR_ORDER, "TSTrajectorySetUp should be called first");
124: PetscCheck(stepnum >= 0, PetscObjectComm((PetscObject)tj), PETSC_ERR_PLIB, "Requesting negative step number");
125: if (tj->monitor) {
126: PetscCall(PetscViewerASCIIPrintf(tj->monitor, "TSTrajectoryGet: stepnum %" PetscInt_FMT ", stages %" PetscInt_FMT "\n", stepnum, (PetscInt)!tj->solution_only));
127: PetscCall(PetscViewerFlush(tj->monitor));
128: }
129: PetscCall(PetscLogEventBegin(TSTrajectory_Get, tj, ts, 0, 0));
130: PetscUseTypeMethod(tj, get, ts, stepnum, time);
131: PetscCall(PetscLogEventEnd(TSTrajectory_Get, tj, ts, 0, 0));
132: PetscFunctionReturn(PETSC_SUCCESS);
133: }
135: /*@
136: TSTrajectoryGetVecs - Reconstructs the vector of state and its time derivative using information from the `TSTrajectory` and, possibly, from the `TS`
138: Collective
140: Input Parameters:
141: + tj - the trajectory object
142: . ts - the time stepper object (optional)
143: - stepnum - the requested step number
145: Output Parameters:
146: + time - On input time for the step if step number is `PETSC_DECIDE`, on output the time associated with the step number
147: . U - state vector (can be `NULL`)
148: - Udot - time derivative of state vector (can be `NULL`)
150: Level: developer
152: Notes:
153: If the step number is `PETSC_DECIDE`, the time argument is used to inquire the trajectory.
154: If the requested time does not match any in the trajectory, Lagrangian interpolations are returned.
156: .seealso: [](ch_ts), `TS`, `TSTrajectory`, `TSTrajectorySetUp()`, `TSTrajectoryDestroy()`, `TSTrajectorySetType()`, `TSTrajectorySetVariableNames()`, `TSGetTrajectory()`, `TSTrajectorySet()`, `TSTrajectoryGet()`
157: @*/
158: PetscErrorCode TSTrajectoryGetVecs(TSTrajectory tj, TS ts, PetscInt stepnum, PetscReal *time, Vec U, Vec Udot)
159: {
160: PetscFunctionBegin;
161: PetscCheck(tj, PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_WRONGSTATE, "TS solver did not save trajectory");
165: PetscAssertPointer(time, 4);
168: if (!U && !Udot) PetscFunctionReturn(PETSC_SUCCESS);
169: PetscCheck(tj->setupcalled, PetscObjectComm((PetscObject)tj), PETSC_ERR_ORDER, "TSTrajectorySetUp should be called first");
170: PetscCall(PetscLogEventBegin(TSTrajectory_GetVecs, tj, ts, 0, 0));
171: if (tj->monitor) {
172: PetscInt pU, pUdot;
173: pU = U ? 1 : 0;
174: pUdot = Udot ? 1 : 0;
175: PetscCall(PetscViewerASCIIPrintf(tj->monitor, "Requested by GetVecs %" PetscInt_FMT " %" PetscInt_FMT ": stepnum %" PetscInt_FMT ", time %g\n", pU, pUdot, stepnum, (double)*time));
176: PetscCall(PetscViewerFlush(tj->monitor));
177: }
178: if (U && tj->lag.caching) {
179: PetscObjectId id;
180: PetscObjectState state;
182: PetscCall(PetscObjectStateGet((PetscObject)U, &state));
183: PetscCall(PetscObjectGetId((PetscObject)U, &id));
184: if (stepnum == PETSC_DECIDE) {
185: if (id == tj->lag.Ucached.id && *time == tj->lag.Ucached.time && state == tj->lag.Ucached.state) U = NULL;
186: } else {
187: if (id == tj->lag.Ucached.id && stepnum == tj->lag.Ucached.step && state == tj->lag.Ucached.state) U = NULL;
188: }
189: if (tj->monitor && !U) {
190: PetscCall(PetscViewerASCIIPushTab(tj->monitor));
191: PetscCall(PetscViewerASCIIPrintf(tj->monitor, "State vector cached\n"));
192: PetscCall(PetscViewerASCIIPopTab(tj->monitor));
193: PetscCall(PetscViewerFlush(tj->monitor));
194: }
195: }
196: if (Udot && tj->lag.caching) {
197: PetscObjectId id;
198: PetscObjectState state;
200: PetscCall(PetscObjectStateGet((PetscObject)Udot, &state));
201: PetscCall(PetscObjectGetId((PetscObject)Udot, &id));
202: if (stepnum == PETSC_DECIDE) {
203: if (id == tj->lag.Udotcached.id && *time == tj->lag.Udotcached.time && state == tj->lag.Udotcached.state) Udot = NULL;
204: } else {
205: if (id == tj->lag.Udotcached.id && stepnum == tj->lag.Udotcached.step && state == tj->lag.Udotcached.state) Udot = NULL;
206: }
207: if (tj->monitor && !Udot) {
208: PetscCall(PetscViewerASCIIPushTab(tj->monitor));
209: PetscCall(PetscViewerASCIIPrintf(tj->monitor, "Derivative vector cached\n"));
210: PetscCall(PetscViewerASCIIPopTab(tj->monitor));
211: PetscCall(PetscViewerFlush(tj->monitor));
212: }
213: }
214: if (!U && !Udot) {
215: PetscCall(PetscLogEventEnd(TSTrajectory_GetVecs, tj, ts, 0, 0));
216: PetscFunctionReturn(PETSC_SUCCESS);
217: }
219: if (stepnum == PETSC_DECIDE || Udot) { /* reverse search for requested time in TSHistory */
220: if (tj->monitor) PetscCall(PetscViewerASCIIPushTab(tj->monitor));
221: /* cached states will be updated in the function */
222: PetscCall(TSTrajectoryReconstruct_Private(tj, ts, *time, U, Udot));
223: if (tj->monitor) {
224: PetscCall(PetscViewerASCIIPopTab(tj->monitor));
225: PetscCall(PetscViewerFlush(tj->monitor));
226: }
227: } else if (U) { /* we were asked to load from stepnum, use TSTrajectoryGet */
228: TS fakets = ts;
229: Vec U2;
231: /* use a fake TS if ts is missing */
232: if (!ts) {
233: PetscCall(PetscObjectQuery((PetscObject)tj, "__fake_ts", (PetscObject *)&fakets));
234: if (!fakets) {
235: PetscCall(TSCreate(PetscObjectComm((PetscObject)tj), &fakets));
236: PetscCall(PetscObjectCompose((PetscObject)tj, "__fake_ts", (PetscObject)fakets));
237: PetscCall(PetscObjectDereference((PetscObject)fakets));
238: PetscCall(VecDuplicate(U, &U2));
239: PetscCall(TSSetSolution(fakets, U2));
240: PetscCall(PetscObjectDereference((PetscObject)U2));
241: }
242: }
243: PetscCall(TSTrajectoryGet(tj, fakets, stepnum, time));
244: PetscCall(TSGetSolution(fakets, &U2));
245: PetscCall(VecCopy(U2, U));
246: PetscCall(PetscObjectStateGet((PetscObject)U, &tj->lag.Ucached.state));
247: PetscCall(PetscObjectGetId((PetscObject)U, &tj->lag.Ucached.id));
248: tj->lag.Ucached.time = *time;
249: tj->lag.Ucached.step = stepnum;
250: }
251: PetscCall(PetscLogEventEnd(TSTrajectory_GetVecs, tj, ts, 0, 0));
252: PetscFunctionReturn(PETSC_SUCCESS);
253: }
255: /*@
256: TSTrajectoryViewFromOptions - View a `TSTrajectory` based on values in the options database
258: Collective
260: Input Parameters:
261: + A - the `TSTrajectory` context
262: . obj - optional object that provides prefix used for option name, pass `NULL` to use the options prefix of `A`
263: - name - command line option
265: Options Database Key:
266: . -name viewer_specification - See `PetscOptionsCreateViewer()` for the values of `viewer_specification`
268: Level: intermediate
270: Note:
271: This checks the options database, creates the viewer on-the-fly, uses it and then destroys it. Hence it should not be called in heavily used routines,
272: rather `PetscOptionsCreateViewer()` should be used to construct the viewer once which can then be utilized in the heavily used routine.
274: .seealso: [](ch_ts), `TSTrajectory`, `TSTrajectoryView()`, `PetscObjectViewFromOptions()`, `TSTrajectoryCreate()`, `PetscOptionsCreateViewer()`
275: @*/
276: PetscErrorCode TSTrajectoryViewFromOptions(TSTrajectory A, PetscObject obj, const char name[])
277: {
278: PetscFunctionBegin;
280: PetscCall(PetscObjectViewFromOptions((PetscObject)A, obj, name));
281: PetscFunctionReturn(PETSC_SUCCESS);
282: }
284: /*@
285: TSTrajectoryView - Prints information about the trajectory object
287: Collective
289: Input Parameters:
290: + tj - the `TSTrajectory` context obtained from `TSTrajectoryCreate()`
291: - viewer - visualization context
293: Options Database Key:
294: . -ts_trajectory_view - calls `TSTrajectoryView()` at end of `TSAdjointStep()`
296: Level: developer
298: Notes:
299: The available visualization contexts include
300: + `PETSC_VIEWER_STDOUT_SELF` - standard output (default)
301: - `PETSC_VIEWER_STDOUT_WORLD` - synchronized standard
302: output where only the first processor opens
303: the file. All other processors send their
304: data to the first processor to print.
306: The user can open an alternative visualization context with
307: `PetscViewerASCIIOpen()` - output to a specified file.
309: .seealso: [](ch_ts), `TS`, `TSTrajectory`, `PetscViewer`, `PetscViewerASCIIOpen()`
310: @*/
311: PetscErrorCode TSTrajectoryView(TSTrajectory tj, PetscViewer viewer)
312: {
313: PetscBool isascii;
315: PetscFunctionBegin;
317: if (!viewer) PetscCall(PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)tj), &viewer));
319: PetscCheckSameComm(tj, 1, viewer, 2);
321: PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &isascii));
322: if (isascii) {
323: PetscCall(PetscObjectPrintClassNamePrefixType((PetscObject)tj, viewer));
324: PetscCall(PetscViewerASCIIPrintf(viewer, " total number of recomputations for adjoint calculation = %" PetscInt_FMT "\n", tj->recomps));
325: PetscCall(PetscViewerASCIIPrintf(viewer, " disk checkpoint reads = %" PetscInt_FMT "\n", tj->diskreads));
326: PetscCall(PetscViewerASCIIPrintf(viewer, " disk checkpoint writes = %" PetscInt_FMT "\n", tj->diskwrites));
327: PetscCall(PetscViewerASCIIPushTab(viewer));
328: PetscTryTypeMethod(tj, view, viewer);
329: PetscCall(PetscViewerASCIIPopTab(viewer));
330: }
331: PetscFunctionReturn(PETSC_SUCCESS);
332: }
334: /*@
335: TSTrajectorySetVariableNames - Sets the name of each component in the solution vector so that it may be saved with the trajectory
337: Collective
339: Input Parameters:
340: + ctx - the trajectory context
341: - names - the names of the components, final string must be `NULL`
343: Level: intermediate
345: Fortran Notes:
346: Fortran interface is not possible because of the string array argument
348: .seealso: [](ch_ts), `TSTrajectory`, `TSGetTrajectory()`
349: @*/
350: PetscErrorCode TSTrajectorySetVariableNames(TSTrajectory ctx, const char *const *names)
351: {
352: PetscFunctionBegin;
354: PetscAssertPointer(names, 2);
355: PetscCall(PetscStrArrayDestroy(&ctx->names));
356: PetscCall(PetscStrArrayallocpy(names, &ctx->names));
357: PetscFunctionReturn(PETSC_SUCCESS);
358: }
360: /*@
361: TSTrajectorySetTransform - Solution vector will be transformed by provided function before being saved to disk
363: Collective
365: Input Parameters:
366: + tj - the `TSTrajectory` context
367: . transform - the transform function
368: . destroy - function to destroy the optional context
369: - tctx - optional context used by transform function
371: Level: intermediate
373: .seealso: [](ch_ts), `TSTrajectorySetVariableNames()`, `TSTrajectory`, `TSMonitorLGSetTransform()`
374: @*/
375: PetscErrorCode TSTrajectorySetTransform(TSTrajectory tj, PetscErrorCode (*transform)(void *, Vec, Vec *), PetscCtxDestroyFn *destroy, void *tctx)
376: {
377: PetscFunctionBegin;
379: tj->transform = transform;
380: tj->transformdestroy = destroy;
381: tj->transformctx = tctx;
382: PetscFunctionReturn(PETSC_SUCCESS);
383: }
385: /*@
386: TSTrajectoryCreate - This function creates an empty trajectory object used to store the time dependent solution of an ODE/DAE
388: Collective
390: Input Parameter:
391: . comm - the communicator
393: Output Parameter:
394: . tj - the trajectory object
396: Level: developer
398: Notes:
399: Usually one does not call this routine, it is called automatically when one calls `TSSetSaveTrajectory()`.
401: .seealso: [](ch_ts), `TS`, `TSTrajectory`, `TSTrajectorySetUp()`, `TSTrajectoryDestroy()`, `TSTrajectorySetType()`, `TSTrajectorySetVariableNames()`, `TSGetTrajectory()`, `TSTrajectorySetKeepFiles()`
402: @*/
403: PetscErrorCode TSTrajectoryCreate(MPI_Comm comm, TSTrajectory *tj)
404: {
405: TSTrajectory t;
407: PetscFunctionBegin;
408: PetscAssertPointer(tj, 2);
409: PetscCall(TSInitializePackage());
411: PetscCall(PetscHeaderCreate(t, TSTRAJECTORY_CLASSID, "TSTrajectory", "Time stepping", "TS", comm, TSTrajectoryDestroy, TSTrajectoryView));
412: t->setupcalled = PETSC_FALSE;
413: PetscCall(TSHistoryCreate(comm, &t->tsh));
414: t->lag.order = 1;
415: t->lag.L = NULL;
416: t->lag.T = NULL;
417: t->lag.W = NULL;
418: t->lag.WW = NULL;
419: t->lag.TW = NULL;
420: t->lag.TT = NULL;
421: t->lag.caching = PETSC_TRUE;
422: t->lag.Ucached.id = 0;
423: t->lag.Ucached.state = -1;
424: t->lag.Ucached.time = PETSC_MIN_REAL;
425: t->lag.Ucached.step = PETSC_INT_MAX;
426: t->lag.Udotcached.id = 0;
427: t->lag.Udotcached.state = -1;
428: t->lag.Udotcached.time = PETSC_MIN_REAL;
429: t->lag.Udotcached.step = PETSC_INT_MAX;
430: t->adjoint_solve_mode = PETSC_TRUE;
431: t->solution_only = PETSC_FALSE;
432: t->keepfiles = PETSC_FALSE;
433: t->usehistory = PETSC_TRUE;
434: *tj = t;
435: PetscCall(TSTrajectorySetFiletemplate(t, "TS-%06" PetscInt_FMT ".bin"));
436: PetscFunctionReturn(PETSC_SUCCESS);
437: }
439: /*@
440: TSTrajectorySetType - Sets the storage method to be used as in a trajectory
442: Collective
444: Input Parameters:
445: + tj - the `TSTrajectory` context
446: . ts - the `TS` context
447: - type - a known method
449: Options Database Key:
450: . -ts_trajectory_type (basic|singlefile|memory|visualization) - Sets the trajectory type
452: Level: developer
454: Developer Notes:
455: Why does this option require access to the `TS`
457: .seealso: [](ch_ts), `TSTrajectory`, `TSTrajectoryType`, `TS`, `TSTrajectoryCreate()`, `TSTrajectorySetFromOptions()`, `TSTrajectoryDestroy()`, `TSTrajectoryGetType()`
458: @*/
459: PetscErrorCode TSTrajectorySetType(TSTrajectory tj, TS ts, TSTrajectoryType type)
460: {
461: PetscErrorCode (*r)(TSTrajectory, TS);
462: PetscBool match;
464: PetscFunctionBegin;
466: PetscCall(PetscObjectTypeCompare((PetscObject)tj, type, &match));
467: if (match) PetscFunctionReturn(PETSC_SUCCESS);
469: PetscCall(PetscFunctionListFind(TSTrajectoryList, type, &r));
470: PetscCheck(r, PetscObjectComm((PetscObject)tj), PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown TSTrajectory type: %s", type);
471: PetscTryTypeMethod(tj, destroy);
472: tj->ops->destroy = NULL;
473: PetscCall(PetscMemzero(tj->ops, sizeof(*tj->ops)));
475: PetscCall(PetscObjectChangeTypeName((PetscObject)tj, type));
476: PetscCall((*r)(tj, ts));
477: PetscFunctionReturn(PETSC_SUCCESS);
478: }
480: /*@
481: TSTrajectoryGetType - Gets the trajectory type
483: Collective
485: Input Parameters:
486: + tj - the `TSTrajectory` context
487: - ts - the `TS` context
489: Output Parameter:
490: . type - a known method
492: Level: developer
494: .seealso: [](ch_ts), `TS`, `TSTrajectory`, `TSTrajectoryCreate()`, `TSTrajectorySetFromOptions()`, `TSTrajectoryDestroy()`, `TSTrajectorySetType()`
495: @*/
496: PetscErrorCode TSTrajectoryGetType(TSTrajectory tj, TS ts, TSTrajectoryType *type)
497: {
498: PetscFunctionBegin;
500: if (type) *type = ((PetscObject)tj)->type_name;
501: PetscFunctionReturn(PETSC_SUCCESS);
502: }
504: PETSC_EXTERN PetscErrorCode TSTrajectoryCreate_Basic(TSTrajectory, TS);
505: PETSC_EXTERN PetscErrorCode TSTrajectoryCreate_Singlefile(TSTrajectory, TS);
506: PETSC_EXTERN PetscErrorCode TSTrajectoryCreate_Memory(TSTrajectory, TS);
507: PETSC_EXTERN PetscErrorCode TSTrajectoryCreate_Visualization(TSTrajectory, TS);
509: /*@
510: TSTrajectoryRegisterAll - Registers all of the `TSTrajectory` storage schecmes in the `TS` package.
512: Not Collective
514: Level: developer
516: .seealso: [](ch_ts), `TSTrajectory`, `TSTrajectoryRegister()`
517: @*/
518: PetscErrorCode TSTrajectoryRegisterAll(void)
519: {
520: PetscFunctionBegin;
521: if (TSTrajectoryRegisterAllCalled) PetscFunctionReturn(PETSC_SUCCESS);
522: TSTrajectoryRegisterAllCalled = PETSC_TRUE;
524: PetscCall(TSTrajectoryRegister(TSTRAJECTORYBASIC, TSTrajectoryCreate_Basic));
525: PetscCall(TSTrajectoryRegister(TSTRAJECTORYSINGLEFILE, TSTrajectoryCreate_Singlefile));
526: PetscCall(TSTrajectoryRegister(TSTRAJECTORYMEMORY, TSTrajectoryCreate_Memory));
527: PetscCall(TSTrajectoryRegister(TSTRAJECTORYVISUALIZATION, TSTrajectoryCreate_Visualization));
528: PetscFunctionReturn(PETSC_SUCCESS);
529: }
531: /*@
532: TSTrajectoryReset - Resets a trajectory context
534: Collective
536: Input Parameter:
537: . tj - the `TSTrajectory` context obtained from `TSGetTrajectory()`
539: Level: developer
541: .seealso: [](ch_ts), `TS`, `TSTrajectory`, `TSTrajectoryCreate()`, `TSTrajectorySetUp()`
542: @*/
543: PetscErrorCode TSTrajectoryReset(TSTrajectory tj)
544: {
545: PetscFunctionBegin;
546: if (!tj) PetscFunctionReturn(PETSC_SUCCESS);
548: PetscTryTypeMethod(tj, reset);
549: PetscCall(PetscFree(tj->dirfiletemplate));
550: PetscCall(TSHistoryDestroy(&tj->tsh));
551: PetscCall(TSHistoryCreate(PetscObjectComm((PetscObject)tj), &tj->tsh));
552: tj->setupcalled = PETSC_FALSE;
553: PetscFunctionReturn(PETSC_SUCCESS);
554: }
556: /*@
557: TSTrajectoryDestroy - Destroys a trajectory context
559: Collective
561: Input Parameter:
562: . tj - the `TSTrajectory` context obtained from `TSTrajectoryCreate()`
564: Level: developer
566: .seealso: [](ch_ts), `TSTrajectory`, `TSTrajectoryCreate()`, `TSTrajectorySetUp()`
567: @*/
568: PetscErrorCode TSTrajectoryDestroy(TSTrajectory *tj)
569: {
570: PetscFunctionBegin;
571: if (!*tj) PetscFunctionReturn(PETSC_SUCCESS);
573: if (--((PetscObject)*tj)->refct > 0) {
574: *tj = NULL;
575: PetscFunctionReturn(PETSC_SUCCESS);
576: }
578: PetscCall(TSTrajectoryReset(*tj));
579: PetscCall(TSHistoryDestroy(&(*tj)->tsh));
580: PetscCall(VecDestroyVecs((*tj)->lag.order + 1, &(*tj)->lag.W));
581: PetscCall(PetscFree5((*tj)->lag.L, (*tj)->lag.T, (*tj)->lag.WW, (*tj)->lag.TT, (*tj)->lag.TW));
582: PetscCall(VecDestroy(&(*tj)->U));
583: PetscCall(VecDestroy(&(*tj)->Udot));
585: if ((*tj)->transformdestroy) PetscCall((*(*tj)->transformdestroy)(&(*tj)->transformctx));
586: PetscTryTypeMethod(*tj, destroy);
587: if (!((*tj)->keepfiles)) {
588: PetscMPIInt rank;
589: MPI_Comm comm;
591: PetscCall(PetscObjectGetComm((PetscObject)*tj, &comm));
592: PetscCallMPI(MPI_Comm_rank(comm, &rank));
593: if (rank == 0 && (*tj)->dirname) { /* we own the directory, so we run PetscRMTree on it */
594: PetscCall(PetscRMTree((*tj)->dirname));
595: }
596: }
597: PetscCall(PetscStrArrayDestroy(&(*tj)->names));
598: PetscCall(PetscFree((*tj)->dirname));
599: PetscCall(PetscFree((*tj)->filetemplate));
600: PetscCall(PetscHeaderDestroy(tj));
601: PetscFunctionReturn(PETSC_SUCCESS);
602: }
604: /*
605: TSTrajectorySetTypeFromOptions_Private - Sets the type of `TSTrajectory` from user options.
607: Collective
609: Input Parameter:
610: + tj - the `TSTrajectory` context
611: - ts - the TS context
613: Options Database Key:
614: . -ts_trajectory_type (basic|memory|singlefile|visualization) - the method of storing the trajectory
616: Level: developer
618: .seealso: [](ch_ts), `TSTrajectory`, `TSTrajectoryType`, `TSTrajectorySetFromOptions()`, `TSTrajectorySetType()`
619: */
620: static PetscErrorCode TSTrajectorySetTypeFromOptions_Private(PetscOptionItems PetscOptionsObject, TSTrajectory tj, TS ts)
621: {
622: PetscBool opt;
623: const char *defaultType;
624: char typeName[256];
626: PetscFunctionBegin;
627: if (((PetscObject)tj)->type_name) defaultType = ((PetscObject)tj)->type_name;
628: else defaultType = TSTRAJECTORYBASIC;
630: PetscCall(TSTrajectoryRegisterAll());
631: PetscCall(PetscOptionsFList("-ts_trajectory_type", "TSTrajectory method", "TSTrajectorySetType", TSTrajectoryList, defaultType, typeName, sizeof(typeName), &opt));
632: if (opt) {
633: PetscCall(TSTrajectorySetType(tj, ts, typeName));
634: } else {
635: PetscCall(TSTrajectorySetType(tj, ts, defaultType));
636: }
637: PetscFunctionReturn(PETSC_SUCCESS);
638: }
640: /*@
641: TSTrajectorySetUseHistory - Use `TSHistory` in `TSTrajectory`
643: Collective
645: Input Parameters:
646: + tj - the `TSTrajectory` context
647: - flg - `PETSC_TRUE` to save, `PETSC_FALSE` to disable
649: Options Database Key:
650: . -ts_trajectory_use_history - have it use `TSHistory`
652: Level: advanced
654: .seealso: [](ch_ts), `TSTrajectory`, `TSTrajectoryCreate()`, `TSTrajectoryDestroy()`, `TSTrajectorySetUp()`
655: @*/
656: PetscErrorCode TSTrajectorySetUseHistory(TSTrajectory tj, PetscBool flg)
657: {
658: PetscFunctionBegin;
661: tj->usehistory = flg;
662: PetscFunctionReturn(PETSC_SUCCESS);
663: }
665: /*@
666: TSTrajectorySetMonitor - Monitor the schedules generated by the `TSTrajectory` checkpointing controller
668: Collective
670: Input Parameters:
671: + tj - the `TSTrajectory` context
672: - flg - `PETSC_TRUE` to active a monitor, `PETSC_FALSE` to disable
674: Options Database Key:
675: . -ts_trajectory_monitor - print `TSTrajectory` information
677: Level: developer
679: .seealso: [](ch_ts), `TSTrajectory`, `TSTrajectoryCreate()`, `TSTrajectoryDestroy()`, `TSTrajectorySetUp()`
680: @*/
681: PetscErrorCode TSTrajectorySetMonitor(TSTrajectory tj, PetscBool flg)
682: {
683: PetscFunctionBegin;
686: if (flg) tj->monitor = PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject)tj));
687: else tj->monitor = NULL;
688: PetscFunctionReturn(PETSC_SUCCESS);
689: }
691: /*@
692: TSTrajectorySetKeepFiles - Keep the files generated by the `TSTrajectory` once the program is done
694: Collective
696: Input Parameters:
697: + tj - the `TSTrajectory` context
698: - flg - `PETSC_TRUE` to save, `PETSC_FALSE` to disable
700: Options Database Key:
701: . -ts_trajectory_keep_files - have it keep the files
703: Level: advanced
705: Note:
706: By default the `TSTrajectory` used for adjoint computations, `TSTRAJECTORYBASIC`, removes the files it generates at the end of the run. This causes the files to be kept.
708: .seealso: [](ch_ts), `TSTrajectoryCreate()`, `TSTrajectoryDestroy()`, `TSTrajectorySetUp()`, `TSTrajectorySetMonitor()`
709: @*/
710: PetscErrorCode TSTrajectorySetKeepFiles(TSTrajectory tj, PetscBool flg)
711: {
712: PetscFunctionBegin;
715: tj->keepfiles = flg;
716: PetscFunctionReturn(PETSC_SUCCESS);
717: }
719: /*@
720: TSTrajectorySetDirname - Specify the name of the directory where `TSTrajectory` disk checkpoints are stored.
722: Collective
724: Input Parameters:
725: + tj - the `TSTrajectory` context
726: - dirname - the directory name
728: Options Database Key:
729: . -ts_trajectory_dirname - set the directory name
731: Level: developer
733: Notes:
734: The final location of the files is determined by dirname/filetemplate where filetemplate was provided by `TSTrajectorySetFiletemplate()`
736: If this is not called `TSTrajectory` selects a unique new name for the directory
738: .seealso: [](ch_ts), `TSTrajectory`, `TSTrajectorySetFiletemplate()`, `TSTrajectorySetUp()`
739: @*/
740: PetscErrorCode TSTrajectorySetDirname(TSTrajectory tj, const char dirname[])
741: {
742: PetscBool flg;
744: PetscFunctionBegin;
746: PetscCall(PetscStrcmp(tj->dirname, dirname, &flg));
747: PetscCheck(flg || !tj->dirfiletemplate, PetscObjectComm((PetscObject)tj), PETSC_ERR_ARG_WRONGSTATE, "Cannot set directoryname after TSTrajectory has been setup");
748: PetscCall(PetscFree(tj->dirname));
749: PetscCall(PetscStrallocpy(dirname, &tj->dirname));
750: PetscFunctionReturn(PETSC_SUCCESS);
751: }
753: /*@
754: TSTrajectorySetFiletemplate - Specify the name template for the files storing `TSTrajectory` checkpoints.
756: Collective
758: Input Parameters:
759: + tj - the `TSTrajectory` context
760: - filetemplate - the template
762: Options Database Key:
763: . -ts_trajectory_file_template - set the file name template
765: Level: developer
767: Notes:
768: The name template should be of the form, for example filename-%06" PetscInt_FMT ".bin It should not begin with a leading /
770: The final location of the files is determined by dirname/filetemplate where dirname was provided by `TSTrajectorySetDirname()`. The %06" PetscInt_FMT " is replaced by the
771: timestep counter
773: .seealso: [](ch_ts), `TSTrajectory`, `TSTrajectorySetDirname()`, `TSTrajectorySetUp()`
774: @*/
775: PetscErrorCode TSTrajectorySetFiletemplate(TSTrajectory tj, const char filetemplate[])
776: {
777: const char *ptr = NULL, *ptr2 = NULL;
779: PetscFunctionBegin;
781: PetscAssertPointer(filetemplate, 2);
782: PetscCheck(!tj->dirfiletemplate, PetscObjectComm((PetscObject)tj), PETSC_ERR_ARG_WRONGSTATE, "Cannot set filetemplate after TSTrajectory has been setup");
784: PetscCheck(filetemplate[0], PetscObjectComm((PetscObject)tj), PETSC_ERR_USER, "-ts_trajectory_file_template requires a file name template, e.g. filename-%%06" PetscInt_FMT ".bin");
785: /* Do some cursory validation of the input. */
786: PetscCall(PetscStrstr(filetemplate, "%", (char **)&ptr));
787: PetscCheck(ptr, PetscObjectComm((PetscObject)tj), PETSC_ERR_USER, "-ts_trajectory_file_template requires a file name template, e.g. filename-%%06" PetscInt_FMT ".bin");
788: for (ptr++; ptr && *ptr; ptr++) {
789: PetscCall(PetscStrchr(PetscInt_FMT "DiouxX", *ptr, (char **)&ptr2));
790: PetscCheck(ptr2 || (*ptr >= '0' && *ptr <= '9'), PetscObjectComm((PetscObject)tj), PETSC_ERR_USER, "Invalid file template argument to -ts_trajectory_file_template, should look like filename-%%06" PetscInt_FMT ".bin");
791: if (ptr2) break;
792: }
793: PetscCall(PetscFree(tj->filetemplate));
794: PetscCall(PetscStrallocpy(filetemplate, &tj->filetemplate));
795: PetscFunctionReturn(PETSC_SUCCESS);
796: }
798: /*@
799: TSTrajectorySetFromOptions - Sets various `TSTrajectory` parameters from user options.
801: Collective
803: Input Parameters:
804: + tj - the `TSTrajectory` context obtained from `TSGetTrajectory()`
805: - ts - the `TS` context
807: Options Database Keys:
808: + -ts_trajectory_type (basic|singlefile|memory|visualization) - how to manage the trajectory
809: . -ts_trajectory_keep_files (true|false) - keep the files generated by the code after the program ends. This is true by default for singlefile and visualization
810: - -ts_trajectory_monitor - print `TSTrajectory` information
812: Level: developer
814: Note:
815: This is not normally called directly by users
817: .seealso: [](ch_ts), `TSTrajectory`, `TSSetSaveTrajectory()`, `TSTrajectorySetUp()`
818: @*/
819: PetscErrorCode TSTrajectorySetFromOptions(TSTrajectory tj, TS ts)
820: {
821: PetscBool set, flg;
822: char dirname[PETSC_MAX_PATH_LEN], filetemplate[PETSC_MAX_PATH_LEN];
824: PetscFunctionBegin;
827: PetscObjectOptionsBegin((PetscObject)tj);
828: PetscCall(TSTrajectorySetTypeFromOptions_Private(PetscOptionsObject, tj, ts));
829: PetscCall(PetscOptionsBool("-ts_trajectory_use_history", "Turn on/off usage of TSHistory", NULL, tj->usehistory, &tj->usehistory, NULL));
830: PetscCall(PetscOptionsBool("-ts_trajectory_monitor", "Print checkpointing schedules", "TSTrajectorySetMonitor", tj->monitor ? PETSC_TRUE : PETSC_FALSE, &flg, &set));
831: if (set) PetscCall(TSTrajectorySetMonitor(tj, flg));
832: PetscCall(PetscOptionsInt("-ts_trajectory_reconstruction_order", "Interpolation order for reconstruction", NULL, tj->lag.order, &tj->lag.order, NULL));
833: PetscCall(PetscOptionsBool("-ts_trajectory_reconstruction_caching", "Turn on/off caching of TSTrajectoryGetVecs input", NULL, tj->lag.caching, &tj->lag.caching, NULL));
834: PetscCall(PetscOptionsBool("-ts_trajectory_adjointmode", "Instruct the trajectory that will be used in a TSAdjointSolve()", NULL, tj->adjoint_solve_mode, &tj->adjoint_solve_mode, NULL));
835: PetscCall(PetscOptionsBool("-ts_trajectory_solution_only", "Checkpoint solution only", "TSTrajectorySetSolutionOnly", tj->solution_only, &tj->solution_only, NULL));
836: PetscCall(PetscOptionsBool("-ts_trajectory_keep_files", "Keep any trajectory files generated during the run", "TSTrajectorySetKeepFiles", tj->keepfiles, &flg, &set));
837: if (set) PetscCall(TSTrajectorySetKeepFiles(tj, flg));
839: PetscCall(PetscOptionsString("-ts_trajectory_dirname", "Directory name for TSTrajectory file", "TSTrajectorySetDirname", NULL, dirname, sizeof(dirname) - 14, &set));
840: if (set) PetscCall(TSTrajectorySetDirname(tj, dirname));
842: PetscCall(PetscOptionsString("-ts_trajectory_file_template", "Template for TSTrajectory file name, use filename-%06" PetscInt_FMT ".bin", "TSTrajectorySetFiletemplate", NULL, filetemplate, sizeof(filetemplate), &set));
843: if (set) PetscCall(TSTrajectorySetFiletemplate(tj, filetemplate));
845: /* Handle specific TSTrajectory options */
846: PetscTryTypeMethod(tj, setfromoptions, PetscOptionsObject);
847: PetscOptionsEnd();
848: PetscFunctionReturn(PETSC_SUCCESS);
849: }
851: /*@
852: TSTrajectorySetUp - Sets up the internal data structures, e.g. stacks, for the later use
853: of a `TS` `TSTrajectory`.
855: Collective
857: Input Parameters:
858: + tj - the `TSTrajectory` context
859: - ts - the TS context obtained from `TSCreate()`
861: Level: developer
863: .seealso: [](ch_ts), `TSTrajectory`, `TSSetSaveTrajectory()`, `TSTrajectoryCreate()`, `TSTrajectoryDestroy()`
864: @*/
865: PetscErrorCode TSTrajectorySetUp(TSTrajectory tj, TS ts)
866: {
867: size_t s1, s2;
869: PetscFunctionBegin;
870: if (!tj) PetscFunctionReturn(PETSC_SUCCESS);
873: if (tj->setupcalled) PetscFunctionReturn(PETSC_SUCCESS);
875: PetscCall(PetscLogEventBegin(TSTrajectory_SetUp, tj, ts, 0, 0));
876: if (!((PetscObject)tj)->type_name) PetscCall(TSTrajectorySetType(tj, ts, TSTRAJECTORYBASIC));
877: PetscTryTypeMethod(tj, setup, ts);
879: tj->setupcalled = PETSC_TRUE;
881: /* Set the counters to zero */
882: tj->recomps = 0;
883: tj->diskreads = 0;
884: tj->diskwrites = 0;
885: PetscCall(PetscStrlen(tj->dirname, &s1));
886: PetscCall(PetscStrlen(tj->filetemplate, &s2));
887: PetscCall(PetscFree(tj->dirfiletemplate));
888: PetscCall(PetscMalloc((s1 + s2 + 10) * sizeof(char), &tj->dirfiletemplate));
889: PetscCall(PetscSNPrintf(tj->dirfiletemplate, s1 + s2 + 10, "%s/%s", tj->dirname, tj->filetemplate));
890: PetscCall(PetscLogEventEnd(TSTrajectory_SetUp, tj, ts, 0, 0));
891: PetscFunctionReturn(PETSC_SUCCESS);
892: }
894: /*@
895: TSTrajectorySetSolutionOnly - Tells the trajectory to store just the solution, and not any intermediate stage information
897: Collective
899: Input Parameters:
900: + tj - the `TSTrajectory` context obtained with `TSGetTrajectory()`
901: - solution_only - the boolean flag
903: Level: developer
905: .seealso: [](ch_ts), `TSTrajectory`, `TSSetSaveTrajectory()`, `TSTrajectoryCreate()`, `TSTrajectoryDestroy()`, `TSTrajectoryGetSolutionOnly()`
906: @*/
907: PetscErrorCode TSTrajectorySetSolutionOnly(TSTrajectory tj, PetscBool solution_only)
908: {
909: PetscFunctionBegin;
912: tj->solution_only = solution_only;
913: PetscFunctionReturn(PETSC_SUCCESS);
914: }
916: /*@
917: TSTrajectoryGetSolutionOnly - Gets the value set with `TSTrajectorySetSolutionOnly()`.
919: Logically Collective
921: Input Parameter:
922: . tj - the `TSTrajectory` context
924: Output Parameter:
925: . solution_only - the boolean flag
927: Level: developer
929: .seealso: [](ch_ts), `TSTrajectory`, `TSSetSaveTrajectory()`, `TSTrajectoryCreate()`, `TSTrajectoryDestroy()`, `TSTrajectorySetSolutionOnly()`
930: @*/
931: PetscErrorCode TSTrajectoryGetSolutionOnly(TSTrajectory tj, PetscBool *solution_only)
932: {
933: PetscFunctionBegin;
935: PetscAssertPointer(solution_only, 2);
936: *solution_only = tj->solution_only;
937: PetscFunctionReturn(PETSC_SUCCESS);
938: }
940: /*@
941: TSTrajectoryGetUpdatedHistoryVecs - Get updated state and time-derivative history vectors.
943: Collective
945: Input Parameters:
946: + tj - the `TSTrajectory` context
947: . ts - the `TS` solver context
948: - time - the requested time
950: Output Parameters:
951: + U - state vector at given time (can be interpolated)
952: - Udot - time-derivative vector at given time (can be interpolated)
954: Level: developer
956: Notes:
957: The vectors are interpolated if time does not match any time step stored in the `TSTrajectory()`. Pass NULL to not request a vector.
959: This function differs from `TSTrajectoryGetVecs()` since the vectors obtained cannot be modified, and they need to be returned by
960: calling `TSTrajectoryRestoreUpdatedHistoryVecs()`.
962: .seealso: [](ch_ts), `TSTrajectory`, `TSSetSaveTrajectory()`, `TSTrajectoryCreate()`, `TSTrajectoryDestroy()`, `TSTrajectoryRestoreUpdatedHistoryVecs()`, `TSTrajectoryGetVecs()`
963: @*/
964: PetscErrorCode TSTrajectoryGetUpdatedHistoryVecs(TSTrajectory tj, TS ts, PetscReal time, Vec *U, Vec *Udot)
965: {
966: PetscFunctionBegin;
970: if (U) PetscAssertPointer(U, 4);
971: if (Udot) PetscAssertPointer(Udot, 5);
972: if (U && !tj->U) {
973: DM dm;
975: PetscCall(TSGetDM(ts, &dm));
976: PetscCall(DMCreateGlobalVector(dm, &tj->U));
977: }
978: if (Udot && !tj->Udot) {
979: DM dm;
981: PetscCall(TSGetDM(ts, &dm));
982: PetscCall(DMCreateGlobalVector(dm, &tj->Udot));
983: }
984: PetscCall(TSTrajectoryGetVecs(tj, ts, PETSC_DECIDE, &time, U ? tj->U : NULL, Udot ? tj->Udot : NULL));
985: if (U) {
986: PetscCall(VecLockReadPush(tj->U));
987: *U = tj->U;
988: }
989: if (Udot) {
990: PetscCall(VecLockReadPush(tj->Udot));
991: *Udot = tj->Udot;
992: }
993: PetscFunctionReturn(PETSC_SUCCESS);
994: }
996: /*@
997: TSTrajectoryRestoreUpdatedHistoryVecs - Restores updated state and time-derivative history vectors obtained with `TSTrajectoryGetUpdatedHistoryVecs()`.
999: Collective
1001: Input Parameters:
1002: + tj - the `TSTrajectory` context
1003: . U - state vector at given time (can be interpolated)
1004: - Udot - time-derivative vector at given time (can be interpolated)
1006: Level: developer
1008: .seealso: [](ch_ts), `TSTrajectory`, `TSTrajectoryGetUpdatedHistoryVecs()`
1009: @*/
1010: PetscErrorCode TSTrajectoryRestoreUpdatedHistoryVecs(TSTrajectory tj, Vec *U, Vec *Udot)
1011: {
1012: PetscFunctionBegin;
1016: PetscCheck(!U || *U == tj->U, PetscObjectComm((PetscObject)*U), PETSC_ERR_USER, "U was not obtained from TSTrajectoryGetUpdatedHistoryVecs()");
1017: PetscCheck(!Udot || *Udot == tj->Udot, PetscObjectComm((PetscObject)*Udot), PETSC_ERR_USER, "Udot was not obtained from TSTrajectoryGetUpdatedHistoryVecs()");
1018: if (U) {
1019: PetscCall(VecLockReadPop(tj->U));
1020: *U = NULL;
1021: }
1022: if (Udot) {
1023: PetscCall(VecLockReadPop(tj->Udot));
1024: *Udot = NULL;
1025: }
1026: PetscFunctionReturn(PETSC_SUCCESS);
1027: }