mirror of
https://github.com/OPM/opm-simulators.git
synced 2026-10-26 15:40:09 -05:00
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
14 lines
564 B
Python
14 lines
564 B
Python
# Instead of having the pybind11 extension module, e.g.
|
|
# simulators.cpython-310-x86_64-linux-gnu.so located
|
|
# directly in the opm directory, we create a package (sub
|
|
# directory) with the same name and place it there.
|
|
# In this way we can do (if needed in the future)
|
|
#
|
|
# from opm.simulators import BlackOilSimulator, FoamSimulator, PurePythonUtils, ...
|
|
#
|
|
# where FoamSimulator and PurePythonUtils does not currently exists,
|
|
# but could be possible future extensions..
|
|
#
|
|
from .BlackOil import BlackOilSimulator
|
|
from .GasWater import GasWaterSimulator
|