xref: /petsc/src/ts/trajectory/impls/memory/trajmemory.c (revision 143a061064cf446043e8f39a9aa639b3a0c7d7d8)
1 #define TJ_VERBOSE
2 #include <petsc/private/tsimpl.h>        /*I "petscts.h"  I*/
3 #include <petscsys.h>
4 
5 extern int wrap_revolve(int* check,int* capo,int* fine,int *snaps_in,int* info,int* rank);
6 extern int wrap_revolve_reset();
7 
8 typedef struct _StackElement {
9   PetscInt  stepnum;
10   Vec       X;
11   Vec       *Y;
12   PetscReal time;
13   PetscReal timeprev;
14 } *StackElement;
15 
16 typedef struct _RevolveCTX {
17   PetscBool    reverseonestep;
18   PetscInt     snaps_in;
19   PetscInt     stepsleft;
20   PetscInt     check;
21   PetscInt     oldcapo;
22   PetscInt     capo;
23   PetscInt     fine;
24   PetscInt     info;
25 } RevolveCTX;
26 
27 typedef struct _Stack {
28   PetscBool    userevolve;
29   PetscBool    recompute;
30   MPI_Comm     comm;
31   RevolveCTX   *rctx;
32   PetscInt     max_cps;     /* maximum stack size */
33   PetscInt     stride;
34   PetscInt     total_steps; /* total number of steps */
35   PetscInt     numY;
36   PetscInt     stacksize;
37   PetscInt     top;         /* top of the stack */
38   StackElement *stack;      /* container */
39 } Stack;
40 
41 static PetscErrorCode StackCreate(MPI_Comm,Stack *,PetscInt,PetscInt);
42 static PetscErrorCode StackDestroy(Stack*);
43 static PetscErrorCode StackPush(Stack*,StackElement);
44 static PetscErrorCode StackPop(Stack*,StackElement*);
45 static PetscErrorCode StackTop(Stack*,StackElement*);
46 static PetscErrorCode StackDumpAll(TS,Stack*,PetscInt);
47 static PetscErrorCode StackLoadAll(TS,Stack*,PetscInt);
48 
49 #ifdef TJ_VERBOSE
50 static void printwhattodo(PetscInt whattodo,RevolveCTX *rctx,PetscInt shift)
51 {
52   switch(whattodo) {
53     case 1:
54       PetscPrintf(PETSC_COMM_WORLD,"\x1B[35mAdvance from %D to %D\033[0m\n",rctx->oldcapo+shift,rctx->capo+shift);
55       break;
56     case 2:
57       PetscPrintf(PETSC_COMM_WORLD,"\x1B[35mStore in checkpoint number %D\n\033[0m",rctx->check);
58       break;
59     case 3:
60       PetscPrintf(PETSC_COMM_WORLD,"\x1B[35mFirst turn: Initialize adjoints and reverse first step\033[0m\n");
61       break;
62     case 4:
63       PetscPrintf(PETSC_COMM_WORLD,"\x1B[35mForward and reverse one step\033[0m\n");
64       break;
65     case 5:
66       PetscPrintf(PETSC_COMM_WORLD,"\x1B[35mRestore in checkpoint number %D\033[0m\n",rctx->check);
67       break;
68     case -1:
69       PetscPrintf(PETSC_COMM_WORLD,"\x1B[35mError!");
70       break;
71   }
72 }
73 #endif
74 
75 #undef __FUNCT__
76 #define __FUNCT__ "StackCreate"
77 static PetscErrorCode StackCreate(MPI_Comm comm,Stack *s,PetscInt size,PetscInt ny)
78 {
79   PetscErrorCode ierr;
80 
81   PetscFunctionBegin;
82   s->top  = -1;
83   s->comm = comm;
84   s->numY = ny;
85 
86   ierr = PetscMalloc1(size*sizeof(StackElement),&s->stack);CHKERRQ(ierr);
87   PetscFunctionReturn(0);
88 }
89 
90 #undef __FUNCT__
91 #define __FUNCT__ "StackDestroy"
92 static PetscErrorCode StackDestroy(Stack *s)
93 {
94   PetscInt       i;
95   PetscErrorCode ierr;
96 
97   PetscFunctionBegin;
98   if (s->top>-1) {
99     for (i=0;i<=s->top;i++) {
100       ierr = VecDestroy(&s->stack[i]->X);CHKERRQ(ierr);
101       ierr = VecDestroyVecs(s->numY,&s->stack[i]->Y);CHKERRQ(ierr);
102       ierr = PetscFree(s->stack[i]);CHKERRQ(ierr);
103     }
104   }
105   ierr = PetscFree(s->stack);CHKERRQ(ierr);
106   if (s->userevolve) {
107     ierr = PetscFree(s->rctx);CHKERRQ(ierr);
108   }
109   ierr = PetscFree(s);CHKERRQ(ierr);
110   PetscFunctionReturn(0);
111 }
112 
113 #undef __FUNCT__
114 #define __FUNCT__ "StackPush"
115 static PetscErrorCode StackPush(Stack *s,StackElement e)
116 {
117   PetscFunctionBegin;
118   if (s->top+1 >= s->stacksize) SETERRQ1(s->comm,PETSC_ERR_MEMC,"Maximum stack size (%D) exceeded",s->stacksize);
119   s->stack[++s->top] = e;
120   PetscFunctionReturn(0);
121 }
122 
123 #undef __FUNCT__
124 #define __FUNCT__ "StackPop"
125 static PetscErrorCode StackPop(Stack *s,StackElement *e)
126 {
127   PetscFunctionBegin;
128   if (s->top == -1) SETERRQ(s->comm,PETSC_ERR_MEMC,"Emptry stack");
129   *e = s->stack[s->top--];
130   PetscFunctionReturn(0);
131 }
132 
133 #undef __FUNCT__
134 #define __FUNCT__ "StackTop"
135 static PetscErrorCode StackTop(Stack *s,StackElement *e)
136 {
137   PetscFunctionBegin;
138   *e = s->stack[s->top];
139   PetscFunctionReturn(0);
140 }
141 
142 #undef __FUNCT__
143 #define __FUNCT__ "OutputBIN"
144 static PetscErrorCode OutputBIN(const char *filename,PetscViewer *viewer)
145 {
146   PetscErrorCode ierr;
147 
148   PetscFunctionBegin;
149   ierr = PetscViewerCreate(PETSC_COMM_WORLD,viewer);CHKERRQ(ierr);
150   ierr = PetscViewerSetType(*viewer,PETSCVIEWERBINARY);CHKERRQ(ierr);
151   ierr = PetscViewerFileSetMode(*viewer,FILE_MODE_WRITE);CHKERRQ(ierr);
152   ierr = PetscViewerFileSetName(*viewer,filename);CHKERRQ(ierr);
153   PetscFunctionReturn(0);
154 }
155 
156 #undef __FUNCT__
157 #define __FUNCT__ "StackDumpAll"
158 static PetscErrorCode StackDumpAll(TS ts,Stack *s,PetscInt id)
159 {
160   PetscInt       i,j;
161   StackElement   e;
162   PetscViewer    viewer;
163   char           filename[PETSC_MAX_PATH_LEN];
164   Vec            *Y;
165   PetscErrorCode ierr;
166 
167   PetscFunctionBegin;
168   if (id == 1) {
169 #if defined(PETSC_HAVE_POPEN)
170     PetscMPIInt rank;
171     ierr = MPI_Comm_rank(s->comm,&rank);CHKERRQ(ierr);
172     if (!rank) {
173       char command[PETSC_MAX_PATH_LEN];
174       FILE *fd;
175       int  err;
176 
177       ierr = PetscMemzero(command,sizeof(command));CHKERRQ(ierr);
178       ierr = PetscSNPrintf(command,PETSC_MAX_PATH_LEN,"rm -fr %s","SA-data");CHKERRQ(ierr);
179       ierr = PetscPOpen(PETSC_COMM_SELF,NULL,command,"r",&fd);CHKERRQ(ierr);
180       ierr = PetscPClose(PETSC_COMM_SELF,fd,&err);CHKERRQ(ierr);
181       ierr = PetscSNPrintf(command,PETSC_MAX_PATH_LEN,"mkdir %s","SA-data");CHKERRQ(ierr);
182       ierr = PetscPOpen(PETSC_COMM_SELF,NULL,command,"r",&fd);CHKERRQ(ierr);
183       ierr = PetscPClose(PETSC_COMM_SELF,fd,&err);CHKERRQ(ierr);
184     }
185 #endif
186   }
187   ierr = PetscSNPrintf(filename,sizeof(filename),"SA-data/SA-STACK%06d.bin",id);CHKERRQ(ierr);
188   ierr = OutputBIN(filename,&viewer);CHKERRQ(ierr);
189   for (i=0;i<s->stacksize;i++) {
190     e = s->stack[i];
191     ierr = PetscViewerBinaryWrite(viewer,&e->stepnum,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
192     ierr = VecView(e->X,viewer);CHKERRQ(ierr);
193     for (j=0;j<s->numY;j++) {
194       ierr = VecView(e->Y[j],viewer);CHKERRQ(ierr);
195     }
196     ierr = PetscViewerBinaryWrite(viewer,&e->time,1,PETSC_REAL,PETSC_FALSE);CHKERRQ(ierr);
197     ierr = PetscViewerBinaryWrite(viewer,&e->timeprev,1,PETSC_REAL,PETSC_FALSE);CHKERRQ(ierr);
198   }
199   /* dump the state inside TS from the current step */
200   ierr = PetscViewerBinaryWrite(viewer,&ts->total_steps,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
201   ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr);
202   ierr = TSGetStages(ts,&s->numY,&Y);CHKERRQ(ierr);
203   for (j=0;j<s->numY;j++) {
204     ierr = VecView(Y[j],viewer);CHKERRQ(ierr);
205   }
206   ierr = PetscViewerBinaryWrite(viewer,&ts->ptime,1,PETSC_REAL,PETSC_FALSE);CHKERRQ(ierr);
207   ierr = PetscViewerBinaryWrite(viewer,&ts->ptime_prev,1,PETSC_REAL,PETSC_FALSE);CHKERRQ(ierr);
208   for (i=0;i<s->stacksize;i++) {
209     ierr = StackPop(s,&e);CHKERRQ(ierr);
210     ierr = VecDestroy(&e->X);CHKERRQ(ierr);
211     ierr = VecDestroyVecs(s->numY,&e->Y);CHKERRQ(ierr);
212     ierr = PetscFree(e);CHKERRQ(ierr);
213   }
214   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
215   PetscFunctionReturn(0);
216 }
217 
218 #undef __FUNCT__
219 #define __FUNCT__ "StackLoadAll"
220 static PetscErrorCode StackLoadAll(TS ts,Stack *s,PetscInt id)
221 {
222   Vec            *Y;
223   PetscInt       i,j;
224   StackElement   e;
225   PetscViewer    viewer;
226   char           filename[PETSC_MAX_PATH_LEN];
227   PetscErrorCode ierr;
228 
229   PetscFunctionBegin;
230   ierr = PetscSNPrintf(filename,sizeof filename,"SA-data/SA-STACK%06d.bin",id);CHKERRQ(ierr);
231   ierr = PetscViewerBinaryOpen(PETSC_COMM_WORLD,filename,FILE_MODE_READ,&viewer);CHKERRQ(ierr);
232   for (i=0;i<s->stacksize;i++) {
233     ierr = PetscCalloc1(1,&e);
234     ierr = TSGetStages(ts,&s->numY,&Y);CHKERRQ(ierr);
235     ierr = VecDuplicate(Y[0],&e->X);CHKERRQ(ierr);
236     ierr = VecDuplicateVecs(Y[0],s->numY,&e->Y);CHKERRQ(ierr);
237     ierr = StackPush(s,e);CHKERRQ(ierr);
238   }
239   for (i=0;i<s->stacksize;i++) {
240     e = s->stack[i];
241     ierr = PetscViewerBinaryRead(viewer,&e->stepnum,1,NULL,PETSC_INT);CHKERRQ(ierr);
242     ierr = VecLoad(e->X,viewer);CHKERRQ(ierr);
243     for (j=0;j<s->numY;j++) {
244       ierr = VecLoad(e->Y[j],viewer);CHKERRQ(ierr);
245     }
246     ierr = PetscViewerBinaryRead(viewer,&e->time,1,NULL,PETSC_REAL);CHKERRQ(ierr);
247     ierr = PetscViewerBinaryRead(viewer,&e->timeprev,1,NULL,PETSC_REAL);CHKERRQ(ierr);
248   }
249   /* load the additioinal state into TS */
250   ierr = PetscViewerBinaryRead(viewer,&ts->total_steps,1,NULL,PETSC_INT);CHKERRQ(ierr);
251   ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr);
252   ierr = TSGetStages(ts,&s->numY,&Y);CHKERRQ(ierr);
253   for (j=0;j<s->numY;j++) {
254     ierr = VecLoad(Y[j],viewer);CHKERRQ(ierr);
255   }
256   ierr = PetscViewerBinaryRead(viewer,&ts->ptime,1,NULL,PETSC_REAL);CHKERRQ(ierr);
257   ierr = PetscViewerBinaryRead(viewer,&ts->ptime_prev,1,NULL,PETSC_REAL);CHKERRQ(ierr);
258   ierr = TSSetTimeStep(ts,ts->ptime-ts->ptime_prev);CHKERRQ(ierr);
259   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
260   PetscFunctionReturn(0);
261 }
262 
263 #undef __FUNCT__
264 #define __FUNCT__ "TSTrajectorySetStride_Memory"
265 PetscErrorCode TSTrajectorySetStride_Memory(TSTrajectory tj,TS ts,PetscInt stride)
266 {
267   Stack    *s = (Stack*)tj->data;
268 
269   PetscFunctionBegin;
270   s->stride = stride;
271   PetscFunctionReturn(0);
272 }
273 
274 #undef __FUNCT__
275 #define __FUNCT__ "TSTrajectorySetMaxCheckpoints_Memory"
276 PetscErrorCode TSTrajectorySetMaxCheckpoints_Memory(TSTrajectory tj,TS ts,PetscInt max_cps)
277 {
278   Stack    *s = (Stack*)tj->data;
279 
280   PetscFunctionBegin;
281   s->max_cps = max_cps;
282   PetscFunctionReturn(0);
283 }
284 
285 #undef __FUNCT__
286 #define __FUNCT__ "TSTrajectorySetFromOptions_Memory"
287 PetscErrorCode TSTrajectorySetFromOptions_Memory(PetscOptions *PetscOptionsObject,TSTrajectory tj)
288 {
289   Stack     *s = (Stack*)tj->data;
290   PetscErrorCode ierr;
291 
292   PetscFunctionBegin;
293   ierr = PetscOptionsHead(PetscOptionsObject,"Memory based TS trajectory options");CHKERRQ(ierr);
294   {
295     ierr = PetscOptionsInt("-tstrajectory_max_cps","Maximum number of checkpoints","TSTrajectorySetMaxCheckpoints_Memory",s->max_cps,&s->max_cps,NULL);CHKERRQ(ierr);
296     ierr = PetscOptionsInt("-tstrajectory_stride","Stride to save checkpoints to file","TSTrajectorySetStride_Memory",s->stride,&s->stride,NULL);CHKERRQ(ierr);
297   }
298   ierr = PetscOptionsTail();CHKERRQ(ierr);
299   PetscFunctionReturn(0);
300 }
301 
302 #undef __FUNCT__
303 #define __FUNCT__ "TSTrajectorySetUp_Memory"
304 PetscErrorCode TSTrajectorySetUp_Memory(TSTrajectory tj,TS ts)
305 {
306   Stack          *s = (Stack*)tj->data;
307   RevolveCTX     *rctx;
308   PetscInt       numY;
309   PetscErrorCode ierr;
310 
311   PetscFunctionBegin;
312   ierr = TSGetStages(ts,&numY,NULL);CHKERRQ(ierr);
313   s->total_steps = PetscMin(ts->max_steps,(PetscInt)(ceil(ts->max_time/ts->time_step)));
314 
315   if ((s->stride>1 && s->max_cps>1 && s->max_cps<s->stride-1)||(s->stride<=1 && s->max_cps>1 && s->max_cps<s->total_steps-1)) {
316     s->userevolve = PETSC_TRUE;
317     s->recompute  = PETSC_FALSE;
318     ierr = PetscCalloc1(1,&rctx);CHKERRQ(ierr);
319     rctx->snaps_in       = s->max_cps; /* for theta methods snaps_in=2*max_cps */
320     rctx->reverseonestep = PETSC_FALSE;
321     rctx->check          = -1;
322     rctx->oldcapo        = 0;
323     rctx->capo           = 0;
324     rctx->info           = 2;
325     s->rctx = rctx;
326     if (s->stride>1) rctx->fine = s->stride;
327     else rctx->fine = s->total_steps;
328     s->stacksize = s->max_cps;
329   } else {
330     s->userevolve = PETSC_FALSE;
331     if (s->stride>1) s->stacksize = s->stride-1;
332     else s->stacksize = s->total_steps-1;
333   }
334   ierr = StackCreate(PetscObjectComm((PetscObject)ts),s,s->stacksize,numY);CHKERRQ(ierr);
335   PetscFunctionReturn(0);
336 }
337 
338 #undef __FUNCT__
339 #define __FUNCT__ "TSTrajectorySet_Memory"
340 PetscErrorCode TSTrajectorySet_Memory(TSTrajectory tj,TS ts,PetscInt stepnum,PetscReal time,Vec X)
341 {
342   PetscInt       i;
343   Vec            *Y;
344   PetscReal      timeprev;
345   StackElement   e;
346   Stack          *s = (Stack*)tj->data;
347   RevolveCTX     *rctx;
348   PetscInt       whattodo,rank,localstepnum,id,shift;
349   PetscErrorCode ierr;
350 
351   PetscFunctionBegin;
352   if (!s->recompute) { /* use global stepnum in the forward sweep */
353     ierr = TSGetTotalSteps(ts,&stepnum);CHKERRQ(ierr);
354   }
355   if (s->stride>1) { /* multilevel mode */
356     localstepnum = stepnum%s->stride;
357     if (stepnum!=0 && stepnum!=s->total_steps && localstepnum==0 && !s->recompute) { /* never need to recompute localstepnum=0 */
358 #ifdef TJ_VERBOSE
359       PetscPrintf(PETSC_COMM_WORLD,"\x1B[33mDump stack to file\033[0m\n");
360 #endif
361       id = stepnum/s->stride;
362       ierr = StackDumpAll(ts,s,id);CHKERRQ(ierr);
363       s->top = -1; /* reset top */
364       if (s->userevolve) {
365         rctx = s->rctx;
366         rctx->check = -1;
367         rctx->capo  = 0;
368         rctx->fine  = s->stride;
369       }
370       wrap_revolve_reset();
371     }
372   } else { /* in-memory mode */
373     localstepnum = stepnum;
374   }
375 
376   if (s->userevolve) {
377     rctx = s->rctx;
378     if (rctx->reverseonestep && stepnum==s->total_steps) { /* intermediate information is ready inside TS, this happens at last time step */
379       rctx->reverseonestep = PETSC_FALSE;
380       PetscFunctionReturn(0);
381     }
382     if (rctx->stepsleft!=0) { /* advance the solution without checkpointing anything as Revolve requires */
383       rctx->stepsleft--;
384       PetscFunctionReturn(0);
385     }
386 
387     /* let Revolve determine what to do next */
388     shift         = stepnum-localstepnum;
389     rctx->capo    = localstepnum;
390     rctx->oldcapo = rctx->capo;
391     whattodo = wrap_revolve(&rctx->check,&rctx->capo,&rctx->fine,&rctx->snaps_in,&rctx->info,&rank);
392 #ifdef TJ_VERBOSE
393     printwhattodo(whattodo,rctx,shift);
394 #endif
395     if (whattodo==-1) SETERRQ(s->comm,PETSC_ERR_LIB,"Error in the Revolve library");
396     if (whattodo==1) { /* advance some time steps */
397       rctx->stepsleft = rctx->capo-rctx->oldcapo-1;
398       PetscFunctionReturn(0);
399     }
400     if (whattodo==3 || whattodo==4) { /* ready for a reverse step */
401       rctx->reverseonestep = PETSC_TRUE;
402       PetscFunctionReturn(0);
403     }
404     if (whattodo==5) { /* restore a checkpoint and ask Revolve what to do next */
405       rctx->oldcapo = rctx->capo;
406       whattodo = wrap_revolve(&rctx->check,&rctx->capo,&rctx->fine,&rctx->snaps_in,&rctx->info,&rank); /* must return 1*/
407 #ifdef TJ_VERBOSE
408       printwhattodo(whattodo,rctx,shift);
409 #endif
410       rctx->stepsleft = rctx->capo-rctx->oldcapo;
411       PetscFunctionReturn(0);
412     }
413     if (whattodo==2) { /* store a checkpoint and ask Revolve how many time steps to advance next */
414       rctx->oldcapo = rctx->capo;
415       whattodo = wrap_revolve(&rctx->check,&rctx->capo,&rctx->fine,&rctx->snaps_in,&rctx->info,&rank); /* must return 1*/
416 #ifdef TJ_VERBOSE
417       printwhattodo(whattodo,rctx,shift);
418 #endif
419       rctx->stepsleft = rctx->capo-rctx->oldcapo-1;
420     }
421   } else { /* Revolve is not used */
422     /* skip the first and the last steps of each stride or the whole interval */
423     if (localstepnum==0 || stepnum==s->total_steps) PetscFunctionReturn(0);
424   }
425 
426   /* checkpoint to memmory */
427   if (localstepnum==s->top) { /* overwrite the top checkpoint, this might happen when the time interval is split into several smaller ones, each corresponding to a call of TSSolve() */
428     ierr = StackTop(s,&e);CHKERRQ(ierr);
429     ierr = VecCopy(X,e->X);CHKERRQ(ierr);
430     ierr = TSGetStages(ts,&s->numY,&Y);CHKERRQ(ierr);
431     for (i=0;i<s->numY;i++) {
432       ierr = VecCopy(Y[i],e->Y[i]);CHKERRQ(ierr);
433     }
434     e->stepnum  = stepnum;
435     e->time     = time;
436     ierr        = TSGetPrevTime(ts,&timeprev);CHKERRQ(ierr);
437     e->timeprev = timeprev;
438   } else {
439     if (localstepnum<s->top) SETERRQ(s->comm,PETSC_ERR_MEMC,"Illegal modification of a non-top stack element");
440     ierr = PetscCalloc1(1,&e);CHKERRQ(ierr);
441     ierr = VecDuplicate(X,&e->X);CHKERRQ(ierr);
442     ierr = VecCopy(X,e->X);CHKERRQ(ierr);
443     ierr = TSGetStages(ts,&s->numY,&Y);CHKERRQ(ierr);
444     ierr = VecDuplicateVecs(Y[0],s->numY,&e->Y);CHKERRQ(ierr);
445     for (i=0;i<s->numY;i++) {
446       ierr = VecCopy(Y[i],e->Y[i]);CHKERRQ(ierr);
447     }
448     e->stepnum  = stepnum;
449     e->time     = time;
450     /* for consistency */
451     if (stepnum == 0) {
452       e->timeprev = e->time - ts->time_step;
453     } else {
454       ierr = TSGetPrevTime(ts,&timeprev);CHKERRQ(ierr);
455       e->timeprev = timeprev;
456     }
457     ierr = StackPush(s,e);CHKERRQ(ierr);
458   }
459   PetscFunctionReturn(0);
460 }
461 
462 #undef __FUNCT__
463 #define __FUNCT__ "TSTrajectoryGet_Memory"
464 PetscErrorCode TSTrajectoryGet_Memory(TSTrajectory tj,TS ts,PetscInt stepnum,PetscReal *t)
465 {
466   Vec            *Y;
467   PetscInt       i;
468   StackElement   e;
469   Stack          *s = (Stack*)tj->data;
470   PetscReal      stepsize;
471   PetscInt       whattodo,rank,localstepnum,id,shift;
472   PetscErrorCode ierr;
473 
474   PetscFunctionBegin;
475   ierr = TSGetTotalSteps(ts,&stepnum);CHKERRQ(ierr);
476   if (s->stride>1) { /* multilevel mode */
477     localstepnum = stepnum%s->stride;
478     if (localstepnum==0 && stepnum!=0 && stepnum!=s->total_steps) {
479 #ifdef TJ_VERBOSE
480       PetscPrintf(PETSC_COMM_WORLD,"\x1B[33mLoad stack from file\033[0m\n");
481 #endif
482       id = stepnum/s->stride;
483       ierr = StackLoadAll(ts,s,id);CHKERRQ(ierr);
484       s->top = s->stacksize-1;
485       if (s->userevolve) {
486         wrap_revolve_reset();
487         s->rctx->check = -1;
488         s->rctx->capo  = 0;
489         s->rctx->fine  = s->stride;
490         whattodo = 0;
491         while(whattodo!=3) { /* stupid revolve */
492           whattodo = wrap_revolve(&s->rctx->check,&s->rctx->capo,&s->rctx->fine,&s->rctx->snaps_in,&s->rctx->info,&rank);
493         }
494       }
495     }
496   } else {
497     localstepnum = stepnum;
498   }
499   if (s->userevolve && s->rctx->reverseonestep) { /* ready for the reverse step */
500     ierr = TSGetTimeStep(ts,&stepsize);CHKERRQ(ierr);
501     ierr = TSSetTimeStep(ts,-stepsize);CHKERRQ(ierr);
502     s->rctx->reverseonestep = PETSC_FALSE;
503     PetscFunctionReturn(0);
504   }
505   if (stepnum==s->total_steps || localstepnum==0) {
506     ierr = TSGetTimeStep(ts,&stepsize);CHKERRQ(ierr);
507     ierr = TSSetTimeStep(ts,-stepsize);CHKERRQ(ierr);
508     PetscFunctionReturn(0);
509   }
510   /* restore a checkpoint */
511   ierr = StackTop(s,&e);CHKERRQ(ierr);
512   ierr = VecCopy(e->X,ts->vec_sol);CHKERRQ(ierr);
513   ierr = TSGetStages(ts,&s->numY,&Y);CHKERRQ(ierr);
514   for (i=0;i<s->numY;i++) {
515     ierr = VecCopy(e->Y[i],Y[i]);CHKERRQ(ierr);
516   }
517   *t = e->time;
518 
519   if (e->stepnum < stepnum) { /* need recomputation */
520     s->recompute = PETSC_TRUE;
521     shift = stepnum-localstepnum;
522     s->rctx->capo = localstepnum;
523     whattodo = wrap_revolve(&s->rctx->check,&s->rctx->capo,&s->rctx->fine,&s->rctx->snaps_in,&s->rctx->info,&rank);
524 #ifdef TJ_VERBOSE
525     printwhattodo(whattodo,s->rctx,shift);
526 #endif
527     ierr = TSSetTimeStep(ts,(*t)-e->timeprev);CHKERRQ(ierr);
528     /* reset ts context */
529     PetscInt steps = ts->steps;
530     ts->steps      = e->stepnum;
531     ts->ptime      = e->time;
532     ts->ptime_prev = e->timeprev;
533     for (i=e->stepnum;i<stepnum;i++) { /* assume fixed step size */
534       ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
535       ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
536       ierr = TSStep(ts);CHKERRQ(ierr);
537       if (ts->event) {
538         ierr = TSEventMonitor(ts);CHKERRQ(ierr);
539       }
540       if (!ts->steprollback) {
541         ierr = TSPostStep(ts);CHKERRQ(ierr);
542       }
543     }
544     /* reverseonestep must be true after the for loop */
545     ts->steps = steps;
546     ts->total_steps = stepnum;
547     ierr = TSGetTimeStep(ts,&stepsize);CHKERRQ(ierr);
548     ierr = TSSetTimeStep(ts,-stepsize);CHKERRQ(ierr);
549     if (stepnum-e->stepnum==1) { /* the restored checkpoint can be deleted now */
550       ierr = StackPop(s,&e);CHKERRQ(ierr);
551       ierr = VecDestroy(&e->X);CHKERRQ(ierr);
552       ierr = VecDestroyVecs(s->numY,&e->Y);CHKERRQ(ierr);
553       ierr = PetscFree(e);CHKERRQ(ierr);
554     }
555     s->rctx->reverseonestep = PETSC_FALSE;
556   } else if (e->stepnum == stepnum) { /* restore the data directly from checkpoints */
557     ierr = TSSetTimeStep(ts,-(*t)+e->timeprev);CHKERRQ(ierr);
558     ierr = StackPop(s,&e);CHKERRQ(ierr);
559     ierr = VecDestroy(&e->X);CHKERRQ(ierr);
560     ierr = VecDestroyVecs(s->numY,&e->Y);CHKERRQ(ierr);
561     ierr = PetscFree(e);CHKERRQ(ierr);
562   } else {
563     SETERRQ2(s->comm,PETSC_ERR_ARG_OUTOFRANGE,"The current step no. is %D, but the step number at top of the stack is %D",stepnum,e->stepnum);
564   }
565 
566   PetscFunctionReturn(0);
567 }
568 
569 #undef __FUNCT__
570 #define __FUNCT__ "TSTrajectoryDestroy_Memory"
571 PETSC_EXTERN PetscErrorCode TSTrajectoryDestroy_Memory(TSTrajectory tj)
572 {
573   Stack          *s = (Stack*)tj->data;
574   PetscErrorCode ierr;
575 
576   PetscFunctionBegin;
577   ierr = StackDestroy(s);CHKERRQ(ierr);
578   PetscFunctionReturn(0);
579 }
580 
581 /*MC
582       TSTRAJECTORYMEMORY - Stores each solution of the ODE/ADE in memory
583 
584   Level: intermediate
585 
586 .seealso:  TSTrajectoryCreate(), TS, TSTrajectorySetType()
587 
588 M*/
589 #undef __FUNCT__
590 #define __FUNCT__ "TSTrajectoryCreate_Memory"
591 PETSC_EXTERN PetscErrorCode TSTrajectoryCreate_Memory(TSTrajectory tj,TS ts)
592 {
593   Stack          *s;
594   PetscErrorCode ierr;
595 
596   PetscFunctionBegin;
597   tj->ops->set            = TSTrajectorySet_Memory;
598   tj->ops->get            = TSTrajectoryGet_Memory;
599   tj->ops->setup          = TSTrajectorySetUp_Memory;
600   tj->ops->destroy        = TSTrajectoryDestroy_Memory;
601   tj->ops->setfromoptions = TSTrajectorySetFromOptions_Memory;
602 
603   ierr = PetscCalloc1(1,&s);CHKERRQ(ierr);
604   s->max_cps = -1; /* -1 indicates that it is not set */
605   s->stride  = 0; /* if not zero, two-level checkpointing will be used */
606   tj->data   = s;
607   PetscFunctionReturn(0);
608 }
609