Implements the Python step_init() function.

A resubmission of commit 11eaa3d7 in PR #2403 and PR #2443 and continues
the work in #2555 implementing Python bindings to the flow simulator.

The step_init() method initializes the simulation. It is required for the
Python script to run step_init() before calling the step() method (which
will be implemented in a later commit).

opm/simulators/flow/FlowMainEbos.hpp

@@ -303,6 +303,11 @@ namespace Opm
             return execute_(&FlowMainEbos::runSimulator, /*cleanup=*/true);
         }
 
+        int executeInitStep()
+        {
+            return execute_(&FlowMainEbos::runSimulatorInit, /*cleanup=*/false);
+        }
+
         // Print an ASCII-art header to the PRT and DEBUG files.
         // \return Whether unkown keywords were seen during parsing.
         static void printPRTHeader(bool output_cout)
@@ -533,6 +538,11 @@ namespace Opm
             return runSimulatorInitOrRun_(&FlowMainEbos::runSimulatorRunCallback_);
         }
 
+        int runSimulatorInit()
+        {
+            return runSimulatorInitOrRun_(&FlowMainEbos::runSimulatorInitCallback_);
+        }
+
     private:
         // Callback that will be called from runSimulatorInitOrRun_().
         int runSimulatorRunCallback_()
@@ -542,6 +552,13 @@ namespace Opm
             return report.success.exit_status;
         }
 
+        // Callback that will be called from runSimulatorInitOrRun_().
+        int runSimulatorInitCallback_()
+        {
+            simulator_->init(*simtimer_);
+            return EXIT_SUCCESS;
+        }
+
         // Output summary after simulation has completed
         void runSimulatorAfterSim_(SimulatorReport &report)
         {

opm/simulators/flow/Main.hpp

@@ -119,6 +119,7 @@ namespace Opm
     {
     private:
         using FlowMainEbosType = Opm::FlowMainEbos<TTAG(EclFlowProblem)>;
+
         enum class FileOutputMode {
             //! \brief No output to files.
             OUTPUT_NONE = 0,

opm/simulators/flow/python/simulators.hpp

@@ -0,0 +1,47 @@
+/*
+  Copyright 2013, 2014, 2015 SINTEF ICT, Applied Mathematics.
+  Copyright 2014 Dr. Blatt - HPC-Simulation-Software & Services
+  Copyright 2015 IRIS AS
+  Copyright 2014 STATOIL ASA.
+
+  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/>.
+*/
+#ifndef OPM_SIMULATORS_HEADER_INCLUDED
+#define OPM_SIMULATORS_HEADER_INCLUDED
+
+#include <opm/simulators/flow/Main.hpp>
+#include <opm/simulators/flow/FlowMainEbos.hpp>
+
+namespace Opm::Pybind {
+class BlackOilSimulator
+{
+private:
+    using FlowMainEbosType = Opm::FlowMainEbos<TTAG(EclFlowProblem)>;
+
+public:
+    BlackOilSimulator( const std::string &deckFilename);
+    int run();
+    int step_init();
+
+private:
+    const std::string deckFilename_;
+    std::unique_ptr<FlowMainEbosType> mainEbos_;
+    std::unique_ptr<Opm::Main> main_;
+    bool hasRunInit_;
+};
+
+} // namespace Opm::Python
+#endif // OPM_SIMULATORS_HEADER_INCLUDED

python/simulators/CMakeLists.txt

@@ -4,6 +4,7 @@ set_target_properties( simulators PROPERTIES LIBRARY_OUTPUT_DIRECTORY ${PROJECT_
 
 target_sources(simulators
   PRIVATE
+    ../../opm/simulators/utils/moduleVersion.cpp
     ../../flow/flow_ebos_blackoil.cpp)
 
 target_link_libraries( simulators PRIVATE opmsimulators )

python/simulators/simulators.cpp

@@ -5,34 +5,56 @@
 #include <opm/parser/eclipse/EclipseState/SummaryConfig/SummaryConfig.hpp>
 #define FLOW_BLACKOIL_ONLY
 #include <opm/simulators/flow/Main.hpp>
+#include <opm/simulators/flow/FlowMainEbos.hpp>
 #include <pybind11/pybind11.h>
 #include <pybind11/embed.h>
+// NOTE: EXIT_SUCCESS, EXIT_FAILURE is defined in cstdlib
+#include <cstdlib>
 #include <iostream>
 #include <string>
+#include <opm/simulators/flow/python/simulators.hpp>
 
 namespace py = pybind11;
 
-class BlackOilSimulator
+namespace Opm::Pybind {
+BlackOilSimulator::BlackOilSimulator( const std::string &deckFilename)
+    : deckFilename_(deckFilename), hasRunInit_(false)
 {
-public:
+}
 
-    BlackOilSimulator( const std::string &deckFilename) : deckFilename_(deckFilename)
+int BlackOilSimulator::run()
-    {
+{
-    }
+    auto mainObject = Opm::Main( deckFilename_ );
+    return mainObject.runDynamic();
+}
 
-    int run()
+int BlackOilSimulator::step_init()
-    {
+{
-        auto mainObject = Opm::Main( deckFilename_ );
+
-        return mainObject.runDynamic();
+    if (hasRunInit_) {
+        // Running step_init() multiple times is not implemented yet,
+        // currently we just do nothing and return
+        return EXIT_SUCCESS;
     }
-    
+    main_ = std::make_unique<Opm::Main>( deckFilename_ );
-private:
+    int exitCode = EXIT_SUCCESS;
-    const std::string deckFilename_;
+    mainEbos_ = main_->initFlowEbosBlackoil(exitCode);
-};
+    if (mainEbos_) {
+        int result = mainEbos_->executeInitStep();
+        hasRunInit_ = true;
+        return result;
+    }
+    else {
+        return exitCode;
+    }
+}
+
+} // namespace Opm::Python
 
 PYBIND11_MODULE(simulators, m)
 {
-    py::class_<BlackOilSimulator>(m, "BlackOilSimulator")
+    py::class_<Opm::Pybind::BlackOilSimulator>(m, "BlackOilSimulator")
         .def(py::init< const std::string& >())
-        .def("run", &BlackOilSimulator::run);
+        .def("run", &Opm::Pybind::BlackOilSimulator::run)
+        .def("step_init", &Opm::Pybind::BlackOilSimulator::step_init);
 }