mirror of
https://github.com/OPM/opm-simulators.git
synced 2026-11-04 21:27:12 -06:00
Svenn Tveit
32dd09c78f
Extend the Python blackoil simulator to support two-phase gas-water simulations by extracting common functionality into a template base class and implementing proper module separation. - Extract PyBaseSimulator<TypeTag> template base class containing all common simulator functionality (20+ methods including advance, run, step, property access, and MPI handling) - Add PyGasWaterSimulator for two-phase gas-water simulations using FlowGasWaterProblem TypeTag with oil phase disabled - Split Python modules to avoid ODR violations: - BlackOil.so for PyBlackOilSimulator (FlowProblemTPFA) - GasWater.so for PyGasWaterSimulator (FlowGasWaterProblem) - Implement proper template instantiation control with explicit instantiations per module - Eliminate ~400 lines of code duplication between simulators - Clean inheritance hierarchy: derived classes contain only constructors - Type-safe specialization through OPM's TypeTag property system - Separate docstring generation for each simulator type - Independent build targets with shared infrastructure - Update CMakeLists.txt to support multiple pybind11 modules - Add docstrings_gw_simulators.json for gas-water simulator documentation - Remove centralized Pybind11Exporter.cpp in favor of distributed exports - Implement proper build dependencies and custom targets This establishes a scalable foundation for extending OPM's Python bindings to support additional simulator types (thermal, polymer, solvent) while maintaining type safety and avoiding symbol conflicts. Files changed: 21 files, 915 insertions, 428 deletions
116 lines
4.1 KiB
C++
116 lines
4.1 KiB
C++
/*
|
|
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/>.
|
|
*/
|
|
#ifndef OPM_PY_BASE_SIMULATOR_HEADER_INCLUDED
|
|
#define OPM_PY_BASE_SIMULATOR_HEADER_INCLUDED
|
|
|
|
#include <opm/models/utils/parametersystem.hpp>
|
|
#include <opm/models/utils/propertysystem.hh>
|
|
|
|
#include <opm/simulators/flow/FlowMain.hpp>
|
|
#include <opm/simulators/flow/python/PyMain.hpp>
|
|
#include <opm/simulators/flow/python/PyFluidState.hpp>
|
|
#include <opm/simulators/flow/python/PyMaterialState.hpp>
|
|
#include <opm/simulators/flow/python/Pybind11Exporter.hpp>
|
|
|
|
#include <opm/input/eclipse/EclipseState/EclipseState.hpp>
|
|
#include <opm/input/eclipse/EclipseState/SummaryConfig/SummaryConfig.hpp>
|
|
#include <opm/input/eclipse/Schedule/Schedule.hpp>
|
|
#include <opm/input/eclipse/Deck/Deck.hpp>
|
|
|
|
#include <map>
|
|
#include <memory>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
namespace Opm::Pybind {
|
|
|
|
template<class TypeTag>
|
|
class PyBaseSimulator
|
|
{
|
|
private:
|
|
using Simulator = Opm::GetPropType<TypeTag, Opm::Properties::Simulator>;
|
|
|
|
public:
|
|
PyBaseSimulator(const std::string& deckFilename,
|
|
const std::vector<std::string>& args);
|
|
PyBaseSimulator(
|
|
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,
|
|
const std::vector<std::string>& args);
|
|
|
|
void advance(int report_step);
|
|
bool checkSimulationFinished();
|
|
int currentStep();
|
|
py::array_t<double> getFluidStateVariable(const std::string &name) const;
|
|
py::array_t<double> getCellVolumes();
|
|
double getDT();
|
|
py::array_t<double> getPorosity();
|
|
py::array_t<double> getPrimaryVariable(const std::string &variable) const;
|
|
py::array_t<int> getPrimaryVarMeaning(const std::string &variable) const;
|
|
std::map<std::string, int> getPrimaryVarMeaningMap(const std::string &variable) const;
|
|
int run();
|
|
void setPorosity(
|
|
py::array_t<double, py::array::c_style | py::array::forcecast> array);
|
|
void setPrimaryVariable(
|
|
const std::string &idx_name,
|
|
py::array_t<double,
|
|
py::array::c_style | py::array::forcecast> array);
|
|
void setupMpi(bool init_mpi, bool finalize_mpi);
|
|
int step();
|
|
int stepCleanup();
|
|
int stepInit();
|
|
|
|
// void initMain();
|
|
|
|
protected:
|
|
Opm::FlowMain<TypeTag>& getFlowMain() const;
|
|
PyFluidState<TypeTag>& getFluidState() const;
|
|
PyMaterialState<TypeTag>& getMaterialState() const;
|
|
|
|
const std::string deck_filename_;
|
|
bool has_run_init_ = false;
|
|
bool has_run_cleanup_ = false;
|
|
bool mpi_init_ = true;
|
|
bool mpi_finalize_ = true;
|
|
//bool debug_ = false;
|
|
|
|
// NOTE: the main_ pointer *must* be declared before the flow_main_ pointer
|
|
// to ensure that it is destroyed before the main object since the main object
|
|
// destructor will call MPI_Finalize() and flow_main_ object destructor will call
|
|
// MPI_Comm_free().
|
|
std::unique_ptr<Opm::PyMain<TypeTag>> main_;
|
|
std::unique_ptr<Opm::FlowMain<TypeTag>> flow_main_;
|
|
Simulator* simulator_;
|
|
std::unique_ptr<PyFluidState<TypeTag>> fluid_state_;
|
|
std::unique_ptr<PyMaterialState<TypeTag>> material_state_;
|
|
std::shared_ptr<Opm::Deck> deck_;
|
|
std::shared_ptr<Opm::EclipseState> eclipse_state_;
|
|
std::shared_ptr<Opm::Schedule> schedule_;
|
|
std::shared_ptr<Opm::SummaryConfig> summary_config_;
|
|
std::vector<std::string> args_;
|
|
}; // class PyBaseSimulator
|
|
|
|
} // namespace Opm::Pybind
|
|
|
|
#include <opm/simulators/flow/python/PyBaseSimulator_impl.hpp>
|
|
|
|
#endif // OPM_PY_BASE_SIMULATOR_HEADER_INCLUDED
|