Add saveMacroscopicObservables to RoadDynamics class

Author: Grufoony

examples/slow_charge_rb.cpp

@@ -142,10 +142,6 @@ int main(int argc, char** argv) {
   std::cout << "Done." << std::endl;
   std::cout << "Running simulation...\n";
 
-  std::ofstream out(OUT_FOLDER + "data.csv");
-  out << "time;n_agents;mean_speed;mean_speed_err;mean_density;mean_density_"
-         "err;mean_flow;mean_flow_err;mean_traveltime;mean_traveltime_err;mean_flow_"
-         "spires;mean_flow_spires_err\n";
 #ifdef PRINT_DENSITIES
   std::ofstream streetDensity(OUT_FOLDER + "densities.csv");
   streetDensity << "time";
@@ -232,17 +228,7 @@ int main(int argc, char** argv) {
       inSpires << std::endl;
 #endif
       printLoadingBar(dynamics.time(), MAX_TIME);
-      const auto& meanSpeed{dynamics.streetMeanSpeed()};
-      const auto& meanDensity{dynamics.streetMeanDensity()};
-      const auto& meanFlow{dynamics.streetMeanFlow()};
-      const auto& meanTravelTime{dynamics.meanTravelTime()};
-      const auto& meanSpireFlow{dynamics.meanSpireOutputFlow()};
-
-      out << dynamics.time() << ';' << dynamics.agents().size() << ';' << meanSpeed.mean
-          << ';' << meanSpeed.std << ';' << meanDensity.mean << ';' << meanDensity.std
-          << ';' << meanFlow.mean << ';' << meanFlow.std << ';' << meanTravelTime.mean
-          << ';' << meanTravelTime.std << ';' << meanSpireFlow.mean << ';'
-          << meanSpireFlow.std << std::endl;
+      dynamics.saveMacroscopicObservables(std::format("{}data.csv", OUT_FOLDER));
     }
     if (dynamics.time() % 10 == 0) {
 #ifdef PRINT_DENSITIES
@@ -279,7 +265,6 @@ int main(int argc, char** argv) {
     }
     ++progress;
   }
-  out.close();
 #ifdef PRINT_DENSITIES
   streetDensity.close();
 #endif

examples/slow_charge_tl.cpp

@@ -233,11 +233,6 @@ int main(int argc, char** argv) {
 
   std::cout << "Done." << std::endl;
   std::cout << "Running simulation...\n";
-
-  std::ofstream out(OUT_FOLDER + "data.csv");
-  out << "time;n_agents;mean_speed;mean_speed_err;mean_density;mean_density_"
-         "err;mean_flow;mean_flow_err;mean_traveltime;mean_traveltime_err;mean_flow_"
-         "spires;mean_flow_spires_err\n";
 #ifdef PRINT_DENSITIES
   std::ofstream streetDensity(OUT_FOLDER + "densities.csv");
   streetDensity << "time";
@@ -343,17 +338,7 @@ int main(int argc, char** argv) {
       outSpires << std::endl;
       inSpires << std::endl;
 #endif
-      const auto& meanSpeed{dynamics.streetMeanSpeed()};
-      const auto& meanDensity{dynamics.streetMeanDensity()};
-      const auto& meanFlow{dynamics.streetMeanFlow()};
-      const auto& meanTravelTime{dynamics.meanTravelTime()};
-      const auto& meanSpireFlow{dynamics.meanSpireOutputFlow()};
-
-      out << dynamics.time() << ';' << dynamics.agents().size() << ';' << meanSpeed.mean
-          << ';' << meanSpeed.std << ';' << meanDensity.mean << ';' << meanDensity.std
-          << ';' << meanFlow.mean << ';' << meanFlow.std << ';' << meanTravelTime.mean
-          << ';' << meanTravelTime.std << ';' << meanSpireFlow.mean << ';'
-          << meanSpireFlow.std << std::endl;
+      dynamics.saveMacroscopicObservables(std::format("{}data.csv", OUT_FOLDER));
       // deltas.push_back(deltaAgents);
       // previousAgents = dynamics.agents().size();
 #ifdef PRINT_TP
@@ -423,7 +408,6 @@ int main(int argc, char** argv) {
     }
     ++progress;
   }
-  out.close();
 #ifdef PRINT_DENSITIES
   streetDensity.close();
 #endif

src/dsm/dsm.hpp

@@ -6,7 +6,7 @@
 
 static constexpr uint8_t DSM_VERSION_MAJOR = 2;
 static constexpr uint8_t DSM_VERSION_MINOR = 5;
-static constexpr uint8_t DSM_VERSION_PATCH = 7;
+static constexpr uint8_t DSM_VERSION_PATCH = 8;
 
 static auto const DSM_VERSION =
     std::format("{}.{}.{}", DSM_VERSION_MAJOR, DSM_VERSION_MINOR, DSM_VERSION_PATCH);

src/dsm/headers/RoadDynamics.hpp

@@ -310,6 +310,23 @@ namespace dsm {
     /// @param filename The name of the file
     /// @param reset If true, the travel speeds are cleared after the computation
     void saveTravelSpeeds(const std::string& filename, bool reset = false);
+    /// @brief Save the main macroscopic observables in csv format
+    /// @param filename The name of the file
+    /// @param separator The separator character (default is ';')
+    /// @details The file contains the following columns:
+    /// - time: the time of the simulation
+    /// - n_agents: the number of agents currently in the simulation
+    /// - mean_speed - mean_speed_std: the mean speed of the agents
+    /// - mean_density - mean_density_std: the (normalized) mean density of the streets
+    /// - mean_flow - mean_flow_std: the mean flow of the streets
+    /// - mean_flow_spires - mean_flow_spires_std: the mean flow of the spires
+    /// - mean_traveltime - mean_traveltime_std: the mean travel time of the agents
+    /// - mean_traveldistance - mean_traveldistance_err: the mean travel distance of the agents
+    /// - mean_travelspeed - mean_travelspeed_std: the mean travel speed of the agents
+    ///
+    /// NOTE: the mean density is normalized in [0, 1] and reset is true for all observables which have such parameter
+    void saveMacroscopicObservables(const std::string& filename,
+                                    char const separator = ';');
   };
 
   template <typename delay_t>
@@ -1567,4 +1584,70 @@ namespace dsm {
       m_travelDTs.clear();
     }
   }
+  template <typename delay_t>
+    requires(is_numeric_v<delay_t>)
+  void RoadDynamics<delay_t>::saveMacroscopicObservables(const std::string& filename,
+                                                         char const separator) {
+    bool bEmptyFile{false};
+    {
+      std::ifstream file(filename);
+      bEmptyFile = file.peek() == std::ifstream::traits_type::eof();
+    }
+    std::ofstream file(filename, std::ios::app);
+    if (!file.is_open()) {
+      Logger::error(std::format("Error opening file \"{}\" for writing.", filename));
+    }
+    if (bEmptyFile) {
+      file << "time;n_agents;mean_speed;mean_speed_std;mean_density;mean_density_std;"
+              "mean_flow;mean_flow_std;mean_flow_spires;mean_flow_spires_std;mean_"
+              "traveltime;mean_traveltime_std;mean_traveldistance;mean_traveldistance_"
+              "err;mean_travelspeed;mean_travelspeed_std\n";
+    }
+    file << this->time() << separator;
+    file << m_agents.size() << separator;
+    file << std::scientific << std::setprecision(2);
+    {
+      std::vector<double> speeds, densities, flows, spireFlows;
+      speeds.reserve(this->graph().nEdges());
+      densities.reserve(this->graph().nEdges());
+      flows.reserve(this->graph().nEdges());
+      spireFlows.reserve(this->graph().nEdges());
+      for (auto const& [streetId, street] : this->graph().edges()) {
+        speeds.push_back(this->streetMeanSpeed(streetId));
+        densities.push_back(street->density(true));
+        flows.push_back(street->density(true) * speeds.back());
+        if (street->isSpire()) {
+          auto& spire = dynamic_cast<SpireStreet&>(*street);
+          spireFlows.push_back(static_cast<double>(spire.inputCounts(true)) /
+                               (this->time() - m_previousSpireTime));
+        }
+      }
+      auto speed{Measurement<double>(speeds)};
+      auto density{Measurement<double>(densities)};
+      auto flow{Measurement<double>(flows)};
+      auto spireFlow{Measurement<double>(spireFlows)};
+      file << speed.mean << separator << speed.std << separator;
+      file << density.mean << separator << density.std << separator;
+      file << flow.mean << separator << flow.std << separator;
+      file << spireFlow.mean << separator << spireFlow.std << separator;
+    }
+    {
+      std::vector<double> distances, times, speeds;
+      distances.reserve(m_travelDTs.size());
+      times.reserve(m_travelDTs.size());
+      speeds.reserve(m_travelDTs.size());
+      for (auto const& [distance, time] : m_travelDTs) {
+        distances.push_back(distance);
+        times.push_back(time);
+        speeds.push_back(distance / time);
+      }
+      auto distance{Measurement<double>(distances)};
+      auto time{Measurement<double>(times)};
+      auto speed{Measurement<double>(speeds)};
+      file << distance.mean << separator << distance.std << separator;
+      file << time.mean << separator << time.std << separator;
+      file << speed.mean << separator << speed.std << std::endl;
+    }
+    file.close();
+  }
 };  // namespace dsm