Initialize blackoil simulator from schedule shared with Python.

Adds a new constructor to Main.hpp that takes shared pointers to Deck,
EclipseState, Schedule, and SummaryConfig. This makes it possible to
share these variables with Python without worrying about lifetime issues
of the underlying C++ objects. For example, a Python script can first
create an opm.io.schedule.Schedule object which is modified from Python.
Then, assume the same Python script creates an
opm.simulators.BlackOilSimulator which is initialized with the same
schedule object. Since the underlying C++ object is a shared pointer,
the Schedule object in Python may go out of scope (get deleted by Python)
without having the C++ schedule object being deleted. And the Python
BlackOilSimulator may continue to be used after the Python Schedule object
has been deleted since it still has a valid C++ schedule object.

python/simulators/PyBlackOilSimulator.cpp

@@ -0,0 +1,162 @@
+/*
+  Copyright 2020 Equinor 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/>.
+*/
+
+#include "config.h"
+#include <opm/parser/eclipse/Deck/Deck.hpp>
+#include <opm/parser/eclipse/EclipseState/EclipseState.hpp>
+#include <opm/parser/eclipse/EclipseState/Schedule/Schedule.hpp>
+#include <opm/parser/eclipse/EclipseState/SummaryConfig/SummaryConfig.hpp>
+#define FLOW_BLACKOIL_ONLY
+#include <opm/simulators/flow/Main.hpp>
+#include <opm/simulators/flow/FlowMainEbos.hpp>
+// NOTE: EXIT_SUCCESS, EXIT_FAILURE is defined in cstdlib
+#include <cstdlib>
+#include <iostream>
+#include <string>
+#include <opm/simulators/flow/python/PyBlackOilSimulator.hpp>
+
+namespace py = pybind11;
+
+namespace Opm::Pybind {
+PyBlackOilSimulator::PyBlackOilSimulator( const std::string &deckFilename)
+    : deckFilename_{deckFilename}
+{
+}
+
+PyBlackOilSimulator::PyBlackOilSimulator(
+    std::shared_ptr<Opm::Deck>& deck,
+    std::shared_ptr<Opm::EclipseState>& state,
+    std::shared_ptr<Opm::Schedule>& schedule,
+    std::shared_ptr<Opm::SummaryConfig>& summary_config
+)
+    : deck_{deck}
+    , eclipse_state_{state}
+    , schedule_{schedule}
+    , summary_config_{summary_config}
+{
+}
+
+const Opm::FlowMainEbos<typename Opm::Pybind::PyBlackOilSimulator::TypeTag>&
+         PyBlackOilSimulator::getFlowMainEbos() const
+{
+    if (this->mainEbos_) {
+        return *(this->mainEbos_.get());
+    }
+    else {
+        throw std::runtime_error("BlackOilSimulator not initialized: "
+            "Cannot get reference to FlowMainEbos object" );
+    }
+}
+
+py::array_t<double> PyBlackOilSimulator::getPorosity()
+{
+    std::size_t len;
+    auto array = materialState_->getPorosity(&len);
+    return py::array(len, array.get());
+}
+
+int PyBlackOilSimulator::run()
+{
+    auto mainObject = Opm::Main( deckFilename_ );
+    return mainObject.runDynamic();
+}
+
+void PyBlackOilSimulator::setPorosity( py::array_t<double,
+    py::array::c_style | py::array::forcecast> array)
+{
+    std::size_t size_ = array.size();
+    const double *poro = array.data();
+    materialState_->setPorosity(poro, size_);
+}
+
+int PyBlackOilSimulator::step()
+{
+    if (!hasRunInit_) {
+        throw std::logic_error("step() called before step_init()");
+    }
+    if (hasRunCleanup_) {
+        throw std::logic_error("step() called after step_cleanup()");
+    }
+    return mainEbos_->executeStep();
+}
+
+int PyBlackOilSimulator::stepCleanup()
+{
+    hasRunCleanup_ = true;
+    return mainEbos_->executeStepsCleanup();
+}
+
+int PyBlackOilSimulator::stepInit()
+{
+
+    if (hasRunInit_) {
+        // Running step_init() multiple times is not implemented yet,
+        if (hasRunCleanup_) {
+            throw std::logic_error("step_init() called again");
+        }
+        else {
+            return EXIT_SUCCESS;
+        }
+    }
+    if (this->deck_) {
+        main_ = std::make_unique<Opm::Main>(
+            this->deck_,
+            this->eclipse_state_,
+            this->schedule_,
+            this->summary_config_
+        );
+    }
+    else {
+        main_ = std::make_unique<Opm::Main>( deckFilename_ );
+    }
+    int exitCode = EXIT_SUCCESS;
+    mainEbos_ = main_->initFlowEbosBlackoil(exitCode);
+    if (mainEbos_) {
+        int result = mainEbos_->executeInitStep();
+        hasRunInit_ = true;
+        ebosSimulator_ = mainEbos_->getSimulatorPtr();
+        materialState_ = std::make_unique<PyMaterialState<TypeTag>>(
+            ebosSimulator_);
+        return result;
+    }
+    else {
+        return exitCode;
+    }
+}
+
+void export_PyBlackOilSimulator(py::module& m)
+{
+    py::class_<PyBlackOilSimulator>(m, "BlackOilSimulator")
+        .def(py::init< const std::string& >())
+        .def(py::init<
+            std::shared_ptr<Opm::Deck>&,
+            std::shared_ptr<Opm::EclipseState>&,
+            std::shared_ptr<Opm::Schedule>&,
+            std::shared_ptr<Opm::SummaryConfig>& >())
+        .def("get_porosity", &PyBlackOilSimulator::getPorosity,
+            py::return_value_policy::copy)
+        .def("run", &PyBlackOilSimulator::run)
+        .def("set_porosity", &PyBlackOilSimulator::setPorosity)
+        .def("step", &PyBlackOilSimulator::step)
+        .def("step_init", &PyBlackOilSimulator::stepInit)
+        .def("step_cleanup", &PyBlackOilSimulator::stepCleanup);
+}
+
+} // namespace Opm::Pybind
+