Resolve "tweak frequency of print outs in StackInspector"

Closes #622

The code approval procedure is described in the wiki: Code approval procedure wiki

• The MR is without WIP/Draft status
• Make sure the most recent CI jobs (config, quality, build_test_example) all run fine with no failures
  • if "check clang-format" failed: the code contributor has to run ./do-clang-format.py --apply eventually with the --all option
  • if "check copyright" failed the code contributor has to run./do-copyright.py --add=20xy
• Make sure also the jobs with MR-label ready for code review succeed. This includes the optional jobs, in particular 'coverage', 'release-clang-14", "release-u-22.04" and make sure no problems occur. You may have to trigger a pipeline manually to check this.
• Check in the "coverage" job output that the coverage did not decrease. It should always stay, or increase. If it decreased --> ask contributor to add further needed unit tests, and check coverage report.
• On the MR page, open the "Open in Web IDE" tool
  • Check if the provided solution solves the Issue, discuss on gitlab
  • Check that all changes are actually related to the issue
  • There are no debug statements left, not even commented out
  • Check all changes for coding rules and guidelines
• When all above is done:
  • Add MR label "Code Review Finished"
  • Approve (click button)
  • Rebase, if needed. If unclear: discuss!
    • git rebase master (rebase on top of master)
    • git merge master (merge back changes from master)

corsika/detail/modules/StackInspector.inl

@@ -58,51 +58,60 @@ namespace corsika {
 
     if ((E0_ - Etot) < dE_threshold_) return;
 
-    std::chrono::system_clock::time_point const now = std::chrono::system_clock::now();
-    std::chrono::duration<double> const elapsed_seconds = now - StartTime_; // seconds
-
-    // Select reference times and energies using either the true start
-    // or the delayed start to avoid counting overhead in ETA
-    bool const usePostVals = (energyPostInit_ != HEPEnergyType::zero());
-    auto const dE = (usePostVals ? energyPostInit_ : E0_) - Etot;
-    std::chrono::duration<double> const usedSeconds = now - timePostInit_;
-    double const dT = usedSeconds.count();
-
-    double const progress = (E0_ - Etot) / E0_;
-    // for printout
-    std::time_t const now_time = std::chrono::system_clock::to_time_t(now);
-
-    double const ETA_seconds = (1.0 - progress) * dT * (E0_ / dE);
-    std::chrono::system_clock::time_point const ETA =
-        now + std::chrono::seconds((int)ETA_seconds);
-
-    // for printout
-    std::time_t const ETA_time = std::chrono::system_clock::to_time_t(ETA);
-
-    int const yday0 = std::localtime(&now_time)->tm_yday;
-    int const yday1 = std::localtime(&ETA_time)->tm_yday;
-    int const dyday = yday1 - yday0;
-
-    std::stringstream ETA_string;
-    ETA_string << std::put_time(std::localtime(&ETA_time), "%T %Z");
-
-    CORSIKA_LOG_INFO(
-        "StackInspector: "
-        " time={}"
-        ", running={:.1f} seconds"
-        " ( {:.1f}%)"
-        ", nStep={}"
-        ", stackSize={}"
-        ", Estack={:.1f} GeV"
-        ", ETA={}{}",
-        std::put_time(std::localtime(&now_time), "%T %Z"), elapsed_seconds.count(),
-        (progress * 100), getStep(), vS.getSize(), Etot / 1_GeV,
-        (dyday == 0 ? "" : fmt::format("+{}d ", dyday)), ETA_string.str());
-
-    // Change reference time once the shower has begin (avoid counting overhead time)
-    if (progress > 0.02 && energyPostInit_ == HEPEnergyType::zero()) {
-      energyPostInit_ = Etot;
-      timePostInit_ = std::chrono::system_clock::now();
+    // limit number of printouts
+    if (PrintoutCounter_ < MaxNumberOfPrintouts_) {
+      std::chrono::system_clock::time_point const now = std::chrono::system_clock::now();
+      std::chrono::duration<double> const elapsed_seconds = now - StartTime_; // seconds
+
+      // Select reference times and energies using either the true start
+      // or the delayed start to avoid counting overhead in ETA
+      bool const usePostVals = (energyPostInit_ != HEPEnergyType::zero());
+      auto const dE = (usePostVals ? energyPostInit_ : E0_) - Etot;
+      std::chrono::duration<double> const usedSeconds = now - timePostInit_;
+      double const dT = usedSeconds.count();
+
+      double const progress = (E0_ - Etot) / E0_;
+      // for printout
+      std::time_t const now_time = std::chrono::system_clock::to_time_t(now);
+
+      double const ETA_seconds = (1.0 - progress) * dT * (E0_ / dE);
+      std::chrono::system_clock::time_point const ETA =
+          now + std::chrono::seconds((int)ETA_seconds);
+
+      std::time_t const ETA_time = std::chrono::system_clock::to_time_t(ETA);
+
+      int const yday0 = std::localtime(&now_time)->tm_yday;
+      int const yday1 = std::localtime(&ETA_time)->tm_yday;
+      int const dyday = yday1 - yday0;
+
+      std::stringstream ETA_string;
+      ETA_string << std::put_time(std::localtime(&ETA_time), "%T %Z");
+
+      CORSIKA_LOG_DEBUG(
+          "StackInspector: "
+          " time={}"
+          ", running={:.1f} seconds"
+          " ( {:.1f}%)"
+          ", nStep={}"
+          ", stackSize={}"
+          ", Estack={:.1f} GeV"
+          ", ETA={}{}",
+          std::put_time(std::localtime(&now_time), "%T %Z"), elapsed_seconds.count(),
+          (progress * 100), getStep(), vS.getSize(), Etot / 1_GeV,
+          (dyday == 0 ? "" : fmt::format("+{}d ", dyday)), ETA_string.str());
+
+      PrintoutCounter_++;
+
+      if (PrintoutCounter_ == MaxNumberOfPrintouts_) {
+        CORSIKA_LOG_DEBUG("StackInspector reached allowed maximum of {} lines printout",
+                          MaxNumberOfPrintouts_);
+      }
+
+      // Change reference time once the shower has begin (avoid counting overhead time)
+      if (progress > 0.02 && energyPostInit_ == HEPEnergyType::zero()) {
+        energyPostInit_ = Etot;
+        timePostInit_ = std::chrono::system_clock::now();
+      }
     }
   }