diff options
Diffstat (limited to 'doc/UsersGuide/Appendices.tex')
| -rw-r--r-- | doc/UsersGuide/Appendices.tex | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/doc/UsersGuide/Appendices.tex b/doc/UsersGuide/Appendices.tex index 6c12931d..3ef375ac 100644 --- a/doc/UsersGuide/Appendices.tex +++ b/doc/UsersGuide/Appendices.tex @@ -1199,10 +1199,15 @@ end The return value in {\tt CCTK\_STARTUP} and {\tt CCTK\_SHUTDOWN} is unused, and might in the future be used to indicate whether an error -occurred. You should return 0. The return value in {\tt - CCTK\_RECOVER\_PARAMETERS} should be zero, positive, or negative, -indicating that no parameters were recovered, that parameters were -recovered successfully, or that an error occurred, respectively. +occurred. You should return 0. + +The return value in {\tt CCTK\_RECOVER\_PARAMETERS} should be zero, +positive, or negative, indicating that no parameters were recovered, +that parameters were recovered successfully, or that an error +occurred, respectively. Only the first routine that returns a +positive value in the {\tt CCTK\_RECOVER\_PARAMETERS} bin will be +executed; all later routines will be ignored. The execution order in +this bin is unspecified. @@ -1211,7 +1216,9 @@ recovered successfully, or that an error occurred, respectively. \item[{\tt CCTK\_RECOVER\_PARAMETERS}] Used by thorns with relevant IO methods as the point to read parameters when recovering from checkpoint files. - Grid variables are not available in this timebin. + Grid variables are not available in this timebin. This bin is + special (see above); do not schedule any routines here except + if they recover parameters. \item[{\tt CCTK\_STARTUP}] Run before any grids are constructed, this is |