mirror of
https://github.com/OPM/opm-simulators.git
synced 2026-10-24 22:57:42 -05: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
Python bindings for the OPM-common module of the Open Porous Media project.
To compile with python support:
- Add the cmake flags
-DOPM_ENABLE_PYTHON=ONand-DOPM_INSTALL_PYTHON=ON - Optionally add prefix
-DCMAKE_INSTALL_PREFIX=/opt/opmto install outside the standard distro directories - Optionally specify python binary
-DPython3_EXECUTABLE=/home/user/miniconda3/envs/rkt/bin/python3if you don't want to use the system python, e.g. use a python frompyenvor from acondaenvironment
Sample compilation on linux:
#! /bin/bash
flags="-DPython3_EXECUTABLE=/home/hakon/miniconda3/envs/rkt/bin/python3 -DOPM_ENABLE_PYTHON=ON -DOPM_INSTALL_PYTHON=ON -DCMAKE_INSTALL_PREFIX=/opt/opm"
for repo in opm-common opm-grid opm-models opm-simulators
do
cd "$repo"
mkdir -p build
cd build
cmake $flags ..
make -j8
sudo make install
cd ..
cd ..
done
Then you should be able to use the module from a Python script. If you installed in
a non-standard directory by specifying -DCMAKE_INSTALL_PREFIX you may need to set the
PYTHONPATH environment variable before running your Python script, for example:
$ PYTHONPATH=/opt/opm/lib/python3.11/site-packages python3 spe1case1.py
and spe1case1.py could be:
import os
from opm.simulators import BlackOilSimulator
from opm.io.parser import Parser
from opm.io.ecl_state import EclipseState
from opm.io.schedule import Schedule
from opm.io.summary import SummaryConfig
os.chdir("SPE1CASE1")
deck = Parser().parse('SPE1CASE1.DATA')
state = EclipseState(deck)
schedule = Schedule( deck, state )
summary_config = SummaryConfig(deck, state, schedule)
sim = BlackOilSimulator(deck, state, schedule, summary_config)
sim.step_init()
sim.step()
poro = sim.get_porosity()
poro = poro *.95
sim.set_porosity(poro)
sim.step()
sim.step_cleanup()