Merge pull request #5073 from atgeirr/fix-output-dir

Avoid modifying outputDir, leave empty if defaulted.

CMakeLists.txt

@@ -349,6 +349,8 @@ if (HAVE_OPM_TESTS)
     include (${CMAKE_CURRENT_SOURCE_DIR}/compareECLFiles.cmake)
 endif()
 
+target_sources(test_outputdir PRIVATE $<TARGET_OBJECTS:moduleVersion>)
+
 opm_set_test_driver(${CMAKE_CURRENT_SOURCE_DIR}/tests/run-parallel-unitTest.sh "")
 
 opm_add_test(test_gatherconvergencereport

CMakeLists_files.cmake

@@ -268,6 +268,7 @@ list (APPEND TEST_SOURCE_FILES
   tests/test_milu.cpp
   tests/test_multmatrixtransposed.cpp
   tests/test_norne_pvt.cpp
+  tests/test_outputdir.cpp
   tests/test_parallel_wbp_sourcevalues.cpp
   tests/test_parallelwellinfo.cpp
   tests/test_partitionCells.cpp

opm/simulators/flow/Main.cpp

@@ -40,10 +40,12 @@
 
 namespace Opm {
 
-Main::Main(int argc, char** argv)
-    : argc_(argc), argv_(argv)
+Main::Main(int argc, char** argv, bool ownMPI)
+    : argc_(argc), argv_(argv), ownMPI_(ownMPI)
 {
-    initMPI();
+    if (ownMPI_) {
+        initMPI();
+    }
 }
 
 Main::Main(const std::string& filename)
@@ -83,7 +85,9 @@ Main::~Main()
     }
 #endif // HAVE_MPI
 
-    EclGenericVanguard::setCommunication(nullptr);
+    if (ownMPI_) {
+        EclGenericVanguard::setCommunication(nullptr);
+    }
 
 #if HAVE_DAMARIS
     if (enableDamarisOutput_) {
@@ -102,7 +106,9 @@ Main::~Main()
 #endif // HAVE_DAMARIS
 
 #if HAVE_MPI && !HAVE_DUNE_FEM
-    MPI_Finalize();
+    if (ownMPI_) {
+        MPI_Finalize();
+    }
 #endif
 }
 

opm/simulators/flow/Main.hpp

@@ -78,6 +78,7 @@
 
 #include <cassert>
 #include <cstdlib>
+#include <filesystem>
 #include <iostream>
 #include <memory>
 #include <stdexcept>
@@ -126,7 +127,7 @@ int flowEbosMain(int argc, char** argv, bool outputCout, bool outputFiles)
 class Main
 {
 public:
-    Main(int argc, char** argv);
+    Main(int argc, char** argv, bool ownMPI = true);
 
     // This constructor can be called from Python
     Main(const std::string& filename);
@@ -189,6 +190,14 @@ public:
         }
     }
 
+    //! \brief Used for test_outputdir.
+    int justInitialize()
+    {
+        int exitCode = EXIT_SUCCESS;
+        initialize_<Properties::TTag::FlowEarlyBird>(exitCode);
+        return exitCode;
+    }
+
 private:
     int dispatchDynamic_()
     {
@@ -328,10 +337,6 @@ private:
             outputDir = EWOMS_GET_PARAM(PreTypeTag, std::string, OutputDir);
         }
 
-        if (outputDir.empty()) {
-            outputDir = ".";
-        }
-
 #if HAVE_DAMARIS
         enableDamarisOutput_ = EWOMS_GET_PARAM(PreTypeTag, bool, EnableDamarisOutput);
         
@@ -344,7 +349,18 @@ private:
         }
 
         if (enableDamarisOutput_) {
-            this->setupDamaris(outputDir); // Damaris server ranks will block here until damaris_stop() is called by client ranks
+            // Deal with empty (defaulted) output dir, should be deck dir
+            auto damarisOutputDir = outputDir;
+            if (outputDir.empty()) {
+                auto odir = std::filesystem::path{deckFilename}.parent_path();
+                if (odir.empty()) {
+                    damarisOutputDir = ".";
+                } else {
+                    damarisOutputDir = odir.generic_string();
+                }
+            }
+            // Damaris server ranks will block here until damaris_stop() is called by client ranks
+            this->setupDamaris(damarisOutputDir);
         }
 #endif // HAVE_DAMARIS
 
@@ -719,6 +735,7 @@ private:
 
     int argc_{0};
     char** argv_{nullptr};
+    bool ownMPI_{true}; //!< True if we "own" MPI and should init / finalize
     bool outputCout_{false};
     bool outputFiles_{false};
     double setupTime_{0.0};

tests/test_outputdir.cpp

@@ -0,0 +1,165 @@
+/*
+  Copyright 2023 SINTEF Digital, Mathematics and Cybernetics.
+
+  This file is part of the Open Porous Media project (OPM).
+
+  OPM is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  OPM is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with OPM.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#include <config.h>
+
+#define BOOST_TEST_MODULE TestOutputDir
+#define BOOST_TEST_NO_MAIN
+#include <boost/test/unit_test.hpp>
+
+#include <opm/simulators/flow/Main.hpp>
+
+#include <filesystem>
+#include <fstream>
+#include <string>
+
+namespace {
+
+struct Fixture {
+    Fixture()
+    {
+        const std::string deck = R"(RUNSPEC
+DIMENS
+  10 10 3 /
+START
+ 8 OCT 2020 /
+GRID
+DXV
+  10*100.0 /
+DYV
+  10*100.0 /
+DZV
+  3*10.0 /
+DEPTHZ
+  121*2000.0 /
+PERMX
+  300*100.0 /
+PERMY
+  300*100.0 /
+PERMZ
+  300*10.0 /
+PORO
+  300*0.3 /
+PROPS
+SOLUTION
+SCHEDULE
+
+TSTEP
+  10
+/
+END
+)";
+
+        input_path = std::filesystem::temp_directory_path() / "outputdir_test/";
+
+        std::filesystem::remove_all(input_path);
+        std::filesystem::create_directories(input_path / "subdir" / "subdir");
+
+        for (const auto& file_path : {input_path / "INPUT.DATA",
+                                      input_path / "subdir" / "INPUT.DATA",
+                                      input_path / "subdir" / "subdir" / "INPUT.DATA"}) {
+            std::ofstream of(file_path);
+            of << deck;
+        }
+    }
+
+    ~Fixture()
+    {
+        std::filesystem::remove_all(input_path);
+    }
+
+    std::filesystem::path input_path;
+};
+
+}
+
+BOOST_FIXTURE_TEST_CASE(WithOutputDir, Fixture)
+{
+    std::filesystem::current_path(input_path);
+
+    using PathPair = std::pair<std::filesystem::path, std::filesystem::path>;
+
+    for (const auto& Case : {PathPair{input_path, input_path / "output1"},
+                             PathPair{input_path / "subdir", input_path / "output2"},
+                             PathPair{input_path / "subdir" / "subdir", input_path / "output3"}}) {
+        const std::string output_path = "--output-dir=" + Case.second.string();
+        const std::string input_file_path = (Case.first / "INPUT.DATA");
+        const char* no_param[] = {"test_outputdir", input_file_path.c_str(),
+                                  output_path.c_str(), nullptr};
+
+        using ParamsMeta = Opm::GetProp<Opm::Properties::TTag::FlowEarlyBird,
+                                        Opm::Properties::ParameterMetaData>;
+        ParamsMeta::clear();
+
+        Opm::Main main(3, const_cast<char**>(no_param), false);
+
+        BOOST_CHECK_EQUAL(main.justInitialize(), EXIT_SUCCESS);
+        BOOST_CHECK(!std::filesystem::exists(input_path / "INPUT.PRT"));
+        BOOST_CHECK(!std::filesystem::exists(input_path / "INPUT.DBG"));
+        BOOST_CHECK(!std::filesystem::exists(Case.first / "INPUT.PRT"));
+        BOOST_CHECK(!std::filesystem::exists(Case.first / "INPUT.DBG"));
+        BOOST_CHECK(std::filesystem::exists(Case.second / "INPUT.PRT"));
+        BOOST_CHECK(std::filesystem::exists(Case.second / "INPUT.DBG"));
+    }
+}
+
+BOOST_FIXTURE_TEST_CASE(NoOutputDir, Fixture)
+{
+    std::filesystem::current_path(input_path);
+
+    for (const auto& Case : {input_path / "subdir" / "subdir",
+                             input_path / "subdir"}) {
+        const std::string input_file_path = (Case / "INPUT.DATA");
+        const char* no_param[] = {"test_outputdir", input_file_path.c_str(), nullptr};
+
+        using ParamsMeta = Opm::GetProp<Opm::Properties::TTag::FlowEarlyBird,
+                                        Opm::Properties::ParameterMetaData>;
+        ParamsMeta::clear();
+
+        Opm::Main main(2, const_cast<char**>(no_param), false);
+
+        BOOST_CHECK_EQUAL(main.justInitialize(), EXIT_SUCCESS);
+        BOOST_CHECK(!std::filesystem::exists(input_path / "INPUT.PRT"));
+        BOOST_CHECK(!std::filesystem::exists(input_path / "INPUT.DBG"));
+        BOOST_CHECK(std::filesystem::exists(Case/ "INPUT.PRT"));
+        BOOST_CHECK(std::filesystem::exists(Case/ "INPUT.DBG"));
+    }
+}
+
+bool init_unit_test_func()
+{
+    return true;
+}
+
+int main(int argc, char** argv)
+{
+    // MPI setup.
+    int argcDummy = 1;
+    const char *tmp[] = {"test_outputdir"};
+    char **argvDummy = const_cast<char**>(tmp);
+#if HAVE_DUNE_FEM
+    Dune::Fem::MPIManager::initialize(argcDummy, argvDummy);
+#else
+    Dune::MPIHelper::instance(argcDummy, argvDummy);
+#endif
+
+    Opm::EclGenericVanguard::setCommunication(std::make_unique<Opm::Parallel::Communication>());
+
+    return boost::unit_test::unit_test_main(&init_unit_test_func, argc, argv);
+}