Checkpoint in freeze only

docs/documentation/building_a_simulation/Simulation-Definition-File.md

@@ -254,7 +254,7 @@ requires a job class.
 <tr><td bgcolor="#ffff99">SELF-SCHEDULING</td><td>jobs in the scheduled job loop that must schedule themselves when to run</td></tr>
 <tr><td bgcolor="#ccffcc">CYCLIC</td><td>jobs in the scheduled job loop that run cyclically according to their specified cycle time</td></tr>
 <tr><td bgcolor="#e6ceff">FREEZE</td><td>jobs that are run during the freeze execution mode</td></tr>
-<tr><td bgcolor="#ffc285">CHECKPOINT</td><td>jobs that are run when a checkpoint is dumpded or loaded</td></tr>
+<tr><td bgcolor="#ffc285">CHECKPOINT</td><td>jobs that are run when a checkpoint is dumped or loaded</td></tr>
 </table>
 
 <b>Table SD_1 Trick-Provided Job Classes</b>

docs/documentation/running_a_simulation/Input-File.md

@@ -450,19 +450,31 @@ trick.freeze(trick.exec_get_sim_time() + 5.0)
 
 ## Checkpoint the Simulation
 
-To checkpoint a simulation call `trick.checkpoint([<checkpoint_time>])`.  `trick.checkpoint()` called with no
-arguments will checkpoint immediately.  An optional checkpoint time may be provided to checkpoint some time
-in the future.
+`trick.checkpoint()` called with no arguments will checkpoint immediately. To checkpoint a simulation call `trick.checkpoint(<checkpoint_time>)`.
+An optional checkpoint time may be provided to checkpoint some time in the future. When you supply a name, you can save the checkpoint to a specific file. For example, `trick.checkpoint(<file_name>)` creates a checkpoint in a file with the given name immediately. `trick.checkpoint(<checkpoint_time>, <file_name>)` saves a checkpoint in
+the described file at the given time. 
 
 ```python
 # Checkpoints immediately
 trick.checkpoint()
 
+# Checkpoints immediately, saving to 'checkpoint_save'
+trick.checkpoint("checkpoint_save")
+
 # Checkpoints at an absolute time
 trick.checkpoint(100.0)
 
+# Checkpoints at an absolute time, saving to 'late_checkpoint'
+trick.checkpoint(100.0, "late_checkpoint")
+
 # Checkpoints 5 seconds relative from the current sim_time
 trick.checkpoint(trick.exec_get_sim_time() + 5.0)
+
+# Checkpoints to 'checkpoint.txt' immediately 
+trick.checkpoint("checkpoint.txt")
+
+# Checkpoints to 'checkpoint2.txt' at an absolute time
+trick.checkpoint(50.0, "checkpoint.txt")
 ```
 
 ## Stopping the Simulation

docs/documentation/simulation_capabilities/Checkpoints.md

@@ -13,8 +13,12 @@ trick.checkpoint_post_init(True|False)
 trick.checkpoint_end(True|False)
 # Save a checkpoint at a time in the future
 trick.checkpoint(<time>)
+# Save a checkpoint at a time in the future to a specified file
+trick.checkpoint(<time>, <file_name>)
 # Save a checkpoint now
 trick.checkpoint()
+# Save a checkpoint now to a specified file
+trick.checkpoint(<file_name>)
 
 # Set the CPU to use for checkpoints
 trick.checkpoint_cpu(<cpu_num>)

docs/howto_guides/Checkpointing-Best-Practices.md

@@ -98,7 +98,7 @@ A checkpoint of a simulation is usually initiated from the Input Processor. That
 1. The input file, or
 2. The variable server.
 
-```trick.checkpoint( <time> )``` is called from Python. This Python function is bound to the corresponding C++ function. At a simulation frame boundary (so that data is time-homogeneous), three things happen:
+```trick.checkpoint( <time> )``` is called from Python. This Python function is bound to the corresponding C++ function. At a simulation frame boundary (so that data is time-homogeneous), the simulation freezes and then three things happen:
 
 1. The ```"checkpoint"``` jobs in the S_define file are executed. These job-classes allow you to prepare your sim to be checkpointed. Perhaps you want to transform simulation state data into a different form for checkpointing. This is up to you.
 
@@ -109,7 +109,7 @@ A checkpoint of a simulation is usually initiated from the Input Processor. That
 <a id=loading-a-checkpoint></a>
 ### What Happens When You Load a Checkpoint.
 Trick.load_checkpoint() is called from Python.
-At a simulation frame boundary, three things happen:
+At a simulation frame boundary, the simulation freezes and then three things happen:
 
 1. The ```“preload_checkpoint”``` jobs are called. These job-classes allow you to prepare your sim for a checkpoint-restore, in whatever way you see fit.
 

docs/not_referenced/Input-File-Quick-Reference.md

@@ -84,8 +84,12 @@ trick.checkpoint_post_init(True|False)
 trick.checkpoint_end(True|False)
 # Save a checkpoint at a time in the future
 trick.checkpoint(<time>)
+# Save a checkpoint at a time in the future to a specified file
+trick.checkpoint(<time>, <file_name>)
 # Save a checkpoint now
 trick.checkpoint()
+# Save a checkpoint now to a specified file
+trick.checkpoint(<file_name>)
 
 # Set the CPU to use for checkpoints
 trick.checkpoint_cpu(<cpu_num>)

include/trick/CheckPointRestart.hh

@@ -6,11 +6,12 @@
 #ifndef MMWRAPPER_HH
 #define MMWRAPPER_HH
 
+#include "trick/Scheduler.hh"
+
+#include <map>
+#include <queue>
 #include <string>
 #include <vector>
-#include <queue>
-
-#include "trick/Scheduler.hh"
 
 namespace Trick {
 
@@ -21,6 +22,15 @@ namespace Trick {
      *
      */
     class CheckPointRestart : public Trick::Scheduler {
+        private:
+            /** Flag to track if an automatic freeze has been triggered for loading checkpoint */
+            bool chkpnt_load_auto_freeze = false; /* ** */
+
+            /** Map to track custom named checkpoints based on the scheduled times */
+            std::map<long long, std::string> chkpnt_names; /* ** */
+
+            /** Map to track whether a scheduled checkpoint should resume sim. */
+            std::map<long long, bool> chkpnt_write_auto_resume_by_time; /* ** */
 
         protected:
             /** queue to hold jobs to be called before a checkpoint is dumped. */
@@ -198,15 +208,23 @@ namespace Trick {
             virtual int checkpoint(std::string file_name = "", bool print_status = true , std::string obj_list_str = "") ;
 
             /**
-             @brief @userdesc Command to dump a checkpoint at in_time. (Sets checkpoint_time to the integral time tic value corresponding
-             to the incoming in_time so that checkpoint occurs once at that time at the end of the execution frame.)
-             The checkpointed file name is @e chkpnt_<in_time>.
+             @brief @userdesc Command to dump a checkpoint at in_time. (Sets checkpoint_time to the integral time tic
+             value corresponding to the incoming in_time so that checkpoint occurs once at that time at the end of the
+             execution frame.) The checkpointed file name is @e chkpnt_<in_time> or @e <file_name>.
              @par Python Usage:
              @code trick.checkpoint(<in_time>) @endcode
              @param in_time - desired checkpoint time in seconds.
+             @param file_name - checkpoint file name. Defaults to blank in which case the checkpoint follows the
+             expecteed convention.
              @return always 0
              */
-            virtual int checkpoint(double in_time) ;
+            virtual int checkpoint(double in_time, std::string file_name = "");
+
+            /**
+             * Record that a non-checkpoint freeze was scheduled at a given time.
+             * @param in_time_tics - simulation time in tics
+             */
+            void note_scheduled_freeze(long long in_time_tics);
 
             /**
              * Executes the pre_init_checkpoint

include/trick/Executive.hh

@@ -1238,6 +1238,14 @@ namespace Trick {
             */
             virtual int freeze(double in_time) ;
 
+            /**
+             @brief Internal command to freeze the simulation at a future time.
+             @param in_time - time in simulation seconds to freeze
+             @param user_requested - whether the freeze was requested outside checkpoint scheduling
+             @return always 0
+            */
+            virtual int freeze(double in_time, bool user_requested);
+
             /**
              @userdesc Command to terminate the simulation now. Set exec_command to ExitCmd.
              @par Python Usage:

include/trick/sim_mode.h

@@ -14,28 +14,41 @@
 #ifndef SIMMODE_HH
 #define SIMMODE_HH
 
-typedef enum {
+#ifdef __cplusplus
+extern "C"
+{
+#endif
 
-    NoCmd = 0 ,         /* NoCmd */
-    FreezeCmd = 2 ,     /* freeze */
-    RunCmd = 3 ,        /* run */
-    ExitCmd = 10 ,      /* exit */
+    typedef enum
+    {
 
-} SIM_COMMAND;
+        NoCmd     = 0,  /* NoCmd */
+        FreezeCmd = 2,  /* freeze */
+        RunCmd    = 3,  /* run */
+        ExitCmd   = 10, /* exit */
 
-/**
- * @enum SIM_MODE
- * The SIM_MODE enumeration represents the TRICK simulation modes.
- */
+    } SIM_COMMAND;
+
+    /**
+     * @enum SIM_MODE
+     * The SIM_MODE enumeration represents the TRICK simulation modes.
+     */
 
-typedef enum {
+    typedef enum
+    {
 
-    Initialization = 0 ,  /* Initialization */
-    Freeze = 1 ,          /* freeze */
-    Step = 4 ,            /* Debug Stepping */
-    Run = 5 ,             /* run */
-    ExitMode = 6          /* exit */
+        Initialization = 0, /* Initialization */
+        Freeze         = 1, /* freeze */
+        Step           = 4, /* Debug Stepping */
+        Run            = 5, /* run */
+        ExitMode       = 6  /* exit */
 
-} SIM_MODE ;
+    } SIM_MODE;
+
+    const char* simModeCharString(SIM_MODE mode);
+
+#ifdef __cplusplus
+}
+#endif
 
 #endif

test/SIM_checkpoint_data_recording/RUN_test1/ref_log_foo.csv

@@ -1,4 +1,5 @@
 sys.exec.out.time {s},testSimObject.my_foo.a {1},testSimObject.my_foo.b {1}
+                   5,6,12
                  5.1,6,12
                  5.2,6,12
                  5.3,6,12

test/SIM_checkpoint_data_recording/RUN_test11_redirect/ref_log_foo.csv

@@ -1,4 +1,5 @@
 sys.exec.out.time {s},testSimObject.my_foo.a {1},testSimObject.my_foo.b {1}
+                 5.5,6,12
                  5.6,6,12
                  5.7,6,12
                  5.8,6,12

test/SIM_checkpoint_data_recording/RUN_test3/ref_log_foo.csv

@@ -1,4 +1,5 @@
 sys.exec.out.time {s},testSimObject.my_foo.a {1},testSimObject.my_foo.b {1}
+                   5,6,12
                  5.1,6,12
                  5.2,6,12
                  5.3,6,12

test/SIM_checkpoint_data_recording/RUN_test4/ref_log_foo.csv

@@ -1,4 +1,5 @@
 sys.exec.out.time {s},testSimObject.my_foo.a {1},testSimObject.my_foo.b {1}
+                   2,3,6
                  2.1,3,6
                  2.2,3,6
                  2.3,3,6

test/SIM_checkpoint_data_recording/RUN_test5/ref_log_foo.csv

@@ -1,4 +1,5 @@
 sys.exec.out.time {s},testSimObject.my_foo.a {1},testSimObject.my_foo.b {1}
+                   7,8,16
                  7.1,8,16
                  7.2,8,16
                  7.3,8,16

test/SIM_checkpoint_data_recording/RUN_test6/ref_log_foo2.csv

@@ -1,4 +1,5 @@
 sys.exec.out.time {s},testSimObject.my_foo.b {1}
+                   7,16
                    8,18
                    9,20
                   10,22

test/SIM_checkpoint_data_recording/RUN_test7/ref_log_fooChange.csv

@@ -1,5 +1,5 @@
 sys.exec.out.time {s},testSimObject.my_foo.a {1},testSimObject.my_foo.b {1},testSimObject.my_foo.q {1}
-                 5.1,6,12,2
+                   5,6,12,2
                    8,9,18,3
                   11,12,24,4
                   14,15,30,5

test/SIM_checkpoint_data_recording/RUN_test8/dump.py

@@ -6,6 +6,9 @@
 def main():
     exec(open("Modified_data/fooChange2.dr").read())
 
+    # Testing that separately scheduling a freeze and checkpoint at the same time still results in a checkpoint
+    # Commented freeze out because the test would stop at scheduled freeze time
+    #trick.freeze(5.0) 
     trick.checkpoint(5.0)
 
     trick.stop(20.0)

test/SIM_checkpoint_data_recording/RUN_test8/ref_log_fooChange2.csv

@@ -1,5 +1,5 @@
 sys.exec.out.time {s},testSimObject.my_foo.q {1}
-                 5.1,2
+                   5,2
                    8,3
                   11,4
                   14,5

test/SIM_stls/RUN_test/setup.py

@@ -5,7 +5,7 @@ def main():
     trick.exec_set_job_onoff("the_object.stlc.test", 1, False)
     trick.exec_set_job_onoff("the_object.stlc.print", 1, False)
 
-    trick.add_read( 0.5, 'trick.checkpoint("chkpnt_in")')
+    trick.checkpoint(0.5, "chkpnt_in")
 
     trick.exec_set_freeze_frame(0.10)
     trick.stop(1.0)