Add support for a user-specified root output directory

doc/REALIZATION_CONFIGURATION.md

@@ -15,11 +15,14 @@ The Configuration is a key-value object and must contain these three first level
 * `catchments` 
   *  is a key-value object that must include a list of individual catchments
 
+The configuration may *optionally* contain an `output_root` key with a user-defined root output directory as the key, for nexus and catchment outputs.
+
 ```
 {
    "global": {},
    "time": {},
-   "catchments": {}
+   "catchments": {},
+   "output_root": "/path/to/output/"
 } 
 ```
 

include/realizations/catchment/Formulation_Manager.hpp

@@ -250,6 +250,34 @@ namespace realization {
                     return "";
             }
 
+            /**
+             * @brief Get the formatted output root
+             *
+             * @code{.cpp}
+             * // Example config:
+             * // ...
+             * // "output_root": "/path/to/dir/"
+             * // ...
+             * const auto manager = Formulation_Manger(CONFIG);
+             * manager.get_output_root();
+             * //> "/path/to/dir/"
+             * @endcode
+             * 
+             * @return std::string of the output root directory
+             */
+            std::string get_output_root() const noexcept {
+                const auto output_root = this->tree.get_optional<std::string>("output_root");
+                if (output_root != boost::none && *output_root != "") {
+                    // Check if the path ends with a trailing slash,
+                    // otherwise add it.
+                    return output_root->back() == '/'
+                           ? *output_root
+                           : *output_root + "/";
+                }
+
+                return "./";
+            }
+
 
         protected:
             std::shared_ptr<Catchment_Formulation> construct_formulation_from_tree(

src/NGen.cpp

@@ -316,10 +316,10 @@ int main(int argc, char *argv[]) {
     for(const auto& id : features.nexuses()) {
         #ifdef NGEN_MPI_ACTIVE
         if (!features.is_remote_sender_nexus(id)) {
-          nexus_outfiles[id].open("./"+id+"_output.csv", std::ios::trunc);
+          nexus_outfiles[id].open(manager->get_output_root() + id + "_output.csv", std::ios::trunc);
         }
         #else
-        nexus_outfiles[id].open("./"+id+"_output.csv", std::ios::trunc);
+        nexus_outfiles[id].open(manager->get_output_root() + id + "_output.csv", std::ios::trunc);
         #endif
     }
 
@@ -370,6 +370,7 @@ int main(int argc, char *argv[]) {
   #ifdef NGEN_MPI_ACTIVE
         if (!features.is_remote_sender_nexus(id)) { //Ensures only one side of the dual sided remote nexus actually doing this...
   #endif
+
           //Get the correct "requesting" id for downstream_flow
 	        const auto& nexus = features.nexus_at(id);
           const auto& cat_ids = nexus->get_receiving_catchments();

src/core/HY_Features.cpp

@@ -28,7 +28,7 @@ HY_Features::HY_Features(network::Network network, std::shared_ptr<Formulation_M
         {
           //Find and prepare formulation
           auto formulation = formulations->get_formulation(feat_id);
-          formulation->set_output_stream(feat_id+".csv");
+          formulation->set_output_stream(formulations->get_output_root() + feat_id + ".csv");
           // TODO: add command line or config option to have this be omitted
           //FIXME why isn't default param working here??? get_output_header_line() fails.
           formulation->write_output("Time Step,""Time,"+formulation->get_output_header_line(",")+"\n");

src/core/HY_Features_MPI.cpp

@@ -38,7 +38,7 @@ HY_Features_MPI::HY_Features_MPI( PartitionData partition_data, geojson::GeoJSON
         {
           //Find and prepare formulation
           auto formulation = formulations->get_formulation(feat_id);
-          formulation->set_output_stream(feat_id+".csv");
+          formulation->set_output_stream(formulations->get_output_root() + feat_id + ".csv");
           // TODO: add command line or config option to have this be omitted
           //FIXME why isn't default param working here??? get_output_header_line() fails.
           formulation->write_output("Time Step,""Time,"+formulation->get_output_header_line(",")+"\n");

test/realizations/Formulation_Manager_Test.cpp

@@ -120,6 +120,7 @@ class Formulation_Manager_Test : public ::testing::Test {
 const double EPSILON = 0.0000001;
 
 const std::string EXAMPLE_1 = "{ "
+    "\"output_root\": \"/tmp/output-dir/\","
     "\"global\": { "
       "\"formulations\": [ "
             "{"
@@ -659,6 +660,7 @@ TEST_F(Formulation_Manager_Test, basic_reading_1) {
 
     ASSERT_TRUE(manager.contains("cat-52"));
     ASSERT_TRUE(manager.contains("cat-67"));
+    ASSERT_EQ(manager.get_output_root(), "/tmp/output-dir/");
 }
 
 TEST_F(Formulation_Manager_Test, basic_reading_2) {
@@ -681,6 +683,7 @@ TEST_F(Formulation_Manager_Test, basic_reading_2) {
 
     ASSERT_TRUE(manager.contains("cat-52"));
     ASSERT_TRUE(manager.contains("cat-67"));
+    ASSERT_EQ(manager.get_output_root(), "./");
 }
 
 TEST_F(Formulation_Manager_Test, basic_run_1) {