ENH: Add upscaler.py, analysis.py, many smaller features, maintenance…

… & bug fixes

.github/workflows/CI.yml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['3.8']
+        python-version: ['3.10']
         os: [ubuntu-latest]
 
     runs-on: ${{ matrix.os }}

examples/cemracs2023/ml/recovery.py

@@ -6,10 +6,11 @@
 """
 
 import os
+
+import matplotlib.pyplot as plt
 import numpy as np
 from ecl.summary import EclSum
 from mako.template import Template
-import matplotlib.pyplot as plt
 
 npoints, npruns = 20, 5
 tmin, tmax = 0, 30
@@ -18,7 +19,7 @@
 FLOW = "/Users/dmar/Github/opm/build/opm-simulators/bin/flow"
 FLAGS = (
     " --linear-solver-reduction=1e-5 --relaxed-max-pv-fraction=0"
-    + " --ecl-enable-drift-compensation=0 --newton-max-iterations=50"
+    + " --enable-drift-compensation=0 --newton-max-iterations=50"
     + " --newton-min-iterations=5 --tolerance-mb=1e-7 --tolerance-wells=1e-5"
     + " --relaxed-well-flow-tol=1e-5 --use-multisegment-well=false --enable-tuning=true"
     + " --enable-opm-rst-file=true --linear-solver=cprw --enable-well-operability-check=false"

examples/cemracs2023/ml_cyclic_h2/h2.mako

@@ -1,5 +1,5 @@
 """Set the full path to the flow executable and flags"""
-${flow} --linear-solver-reduction=1e-5 --relaxed-max-pv-fraction=0 --ecl-enable-drift-compensation=0 --newton-max-iterations=50 --newton-min-iterations=5 --tolerance-mb=1e-7 --tolerance-wells=1e-5 --relaxed-well-flow-tol=1e-5 --use-multisegment-well=false --enable-tuning=true --enable-opm-rst-file=true --linear-solver=cprw --enable-well-operability-check=false --min-time-step-before-shutting-problematic-wells-in-days=1e-99
+${flow} --linear-solver-reduction=1e-5 --relaxed-max-pv-fraction=0 --enable-drift-compensation=0 --newton-max-iterations=50 --newton-min-iterations=5 --tolerance-mb=1e-7 --tolerance-wells=1e-5 --relaxed-well-flow-tol=1e-5 --use-multisegment-well=false --enable-tuning=true --enable-opm-rst-file=true --linear-solver=cprw --enable-well-operability-check=false --min-time-step-before-shutting-problematic-wells-in-days=1e-99
 
 """Set the model parameters"""
 h2store okoroafor2023      #Model (co2store/h2store)

examples/cemracs2023/ml_example_co2/co2.mako

@@ -1,5 +1,5 @@
 """Set the full path to the flow executable and flags"""
-${flow} --linear-solver-reduction=1e-5 --relaxed-max-pv-fraction=0 --ecl-enable-drift-compensation=0 --newton-max-iterations=50 --newton-min-iterations=5 --tolerance-mb=1e-7 --tolerance-wells=1e-5 --relaxed-well-flow-tol=1e-5 --use-multisegment-well=false --enable-tuning=true --enable-opm-rst-file=true --linear-solver=cprw --enable-well-operability-check=false --min-time-step-before-shutting-problematic-wells-in-days=1e-99
+${flow} --linear-solver-reduction=1e-5 --relaxed-max-pv-fraction=0 --enable-drift-compensation=0 --newton-max-iterations=50 --newton-min-iterations=5 --tolerance-mb=1e-7 --tolerance-wells=1e-5 --relaxed-well-flow-tol=1e-5 --use-multisegment-well=false --enable-tuning=true --enable-opm-rst-file=true --linear-solver=cprw --enable-well-operability-check=false --min-time-step-before-shutting-problematic-wells-in-days=1e-99
 
 """Set the model parameters"""
 co2store base #Model (co2store/h2store)

examples/cemracs2023/ml_example_h2/h2.mako

@@ -1,5 +1,5 @@
 """Set the full path to the flow executable and flags"""
-${flow} --linear-solver-reduction=1e-5 --relaxed-max-pv-fraction=0 --ecl-enable-drift-compensation=0 --newton-max-iterations=50 --newton-min-iterations=5 --tolerance-mb=1e-7 --tolerance-wells=1e-5 --relaxed-well-flow-tol=1e-5 --use-multisegment-well=false --enable-tuning=true --enable-opm-rst-file=true --linear-solver=cprw --enable-well-operability-check=false --min-time-step-before-shutting-problematic-wells-in-days=1e-99
+${flow} --linear-solver-reduction=1e-5 --relaxed-max-pv-fraction=0 --enable-drift-compensation=0 --newton-max-iterations=50 --newton-min-iterations=5 --tolerance-mb=1e-7 --tolerance-wells=1e-5 --relaxed-well-flow-tol=1e-5 --use-multisegment-well=false --enable-tuning=true --enable-opm-rst-file=true --linear-solver=cprw --enable-well-operability-check=false --min-time-step-before-shutting-problematic-wells-in-days=1e-99
 
 """Set the model parameters"""
 h2store okoroafor2023 #Model (co2store/h2store)

examples/cemracs2023/peaceman_well-model_nn/2023-08-10_ml_well_model_CO2_realistic_critical_point/co2_3d_finescale_wellmodel.mako

@@ -1,5 +1,5 @@
 """Set the full path to the flow executable and flags"""
-${flow} --ml-wi-filename="" --linear-solver-reduction=1e-5 --relaxed-max-pv-fraction=0 --ecl-enable-drift-compensation=0 --newton-max-iterations=50 --newton-min-iterations=5 --tolerance-mb=1e-7 --tolerance-wells=1e-5 --relaxed-well-flow-tol=1e-5 --use-multisegment-well=false --enable-tuning=true --enable-opm-rst-file=true --linear-solver=cprw --enable-well-operability-check=false --min-time-step-before-shutting-problematic-wells-in-days=1e-99
+${flow} --ml-wi-filename="" --linear-solver-reduction=1e-5 --relaxed-max-pv-fraction=0 --enable-drift-compensation=0 --newton-max-iterations=50 --newton-min-iterations=5 --tolerance-mb=1e-7 --tolerance-wells=1e-5 --relaxed-well-flow-tol=1e-5 --use-multisegment-well=false --enable-tuning=true --enable-opm-rst-file=true --linear-solver=cprw --enable-well-operability-check=false --min-time-step-before-shutting-problematic-wells-in-days=1e-99
 
 """Set the model parameters"""
 co2store base     #Model (co2store/h2store)

examples/cemracs2023/peaceman_well-model_nn/2023-08-10_ml_well_model_CO2_realistic_critical_point/co2_3d_finescale_wellmodel_large_reservoir.mako

@@ -1,5 +1,5 @@
 """Set the full path to the flow executable and flags"""
-${flow} --ml-wi-filename="" --linear-solver-reduction=1e-5 --relaxed-max-pv-fraction=0 --ecl-enable-drift-compensation=0 --newton-max-iterations=50 --newton-min-iterations=5 --tolerance-mb=1e-7 --tolerance-wells=1e-5 --relaxed-well-flow-tol=1e-5 --use-multisegment-well=false --enable-tuning=true --enable-opm-rst-file=true --linear-solver=cprw --enable-well-operability-check=false --min-time-step-before-shutting-problematic-wells-in-days=1e-99
+${flow} --ml-wi-filename="" --linear-solver-reduction=1e-5 --relaxed-max-pv-fraction=0 --enable-drift-compensation=0 --newton-max-iterations=50 --newton-min-iterations=5 --tolerance-mb=1e-7 --tolerance-wells=1e-5 --relaxed-well-flow-tol=1e-5 --use-multisegment-well=false --enable-tuning=true --enable-opm-rst-file=true --linear-solver=cprw --enable-well-operability-check=false --min-time-step-before-shutting-problematic-wells-in-days=1e-99
 
 """Set the model parameters"""
 co2store base     #Model (co2store/h2store)

examples/cemracs2023/peaceman_well-model_nn/2023-08-10_ml_well_model_CO2_realistic_critical_point/co2_3d_flow_wellmodel.mako

@@ -1,5 +1,5 @@
 """Set the full path to the flow executable and flags"""
-${flow} --ml-wi-filename="" --linear-solver-reduction=1e-5 --relaxed-max-pv-fraction=0 --ecl-enable-drift-compensation=0 --newton-max-iterations=50 --newton-min-iterations=5 --tolerance-mb=1e-7 --tolerance-wells=1e-5 --relaxed-well-flow-tol=1e-5 --use-multisegment-well=false --enable-tuning=true --enable-opm-rst-file=true --linear-solver=cprw --enable-well-operability-check=false --min-time-step-before-shutting-problematic-wells-in-days=1e-99
+${flow} --ml-wi-filename="" --linear-solver-reduction=1e-5 --relaxed-max-pv-fraction=0 --enable-drift-compensation=0 --newton-max-iterations=50 --newton-min-iterations=5 --tolerance-mb=1e-7 --tolerance-wells=1e-5 --relaxed-well-flow-tol=1e-5 --use-multisegment-well=false --enable-tuning=true --enable-opm-rst-file=true --linear-solver=cprw --enable-well-operability-check=false --min-time-step-before-shutting-problematic-wells-in-days=1e-99
 
 """Set the model parameters"""
 co2store base #Model (co2store/h2store)

examples/cemracs2023/peaceman_well-model_nn/2023-08-10_ml_well_model_CO2_realistic_critical_point/co2_3d_flow_wellmodel_large_reservoir.mako

@@ -1,5 +1,5 @@
 """Set the full path to the flow executable and flags"""
-${flow} --ml-wi-filename="" --linear-solver-reduction=1e-5 --relaxed-max-pv-fraction=0 --ecl-enable-drift-compensation=0 --newton-max-iterations=50 --newton-min-iterations=5 --tolerance-mb=1e-7 --tolerance-wells=1e-5 --relaxed-well-flow-tol=1e-5 --use-multisegment-well=false --enable-tuning=true --enable-opm-rst-file=true --linear-solver=cprw --enable-well-operability-check=false --min-time-step-before-shutting-problematic-wells-in-days=1e-99
+${flow} --ml-wi-filename="" --linear-solver-reduction=1e-5 --relaxed-max-pv-fraction=0 --enable-drift-compensation=0 --newton-max-iterations=50 --newton-min-iterations=5 --tolerance-mb=1e-7 --tolerance-wells=1e-5 --relaxed-well-flow-tol=1e-5 --use-multisegment-well=false --enable-tuning=true --enable-opm-rst-file=true --linear-solver=cprw --enable-well-operability-check=false --min-time-step-before-shutting-problematic-wells-in-days=1e-99
 
 """Set the model parameters"""
 co2store base     #Model (co2store/h2store)

examples/cemracs2023/peaceman_well-model_nn/2023-08-10_ml_well_model_CO2_realistic_critical_point/co2_3d_ml_wellmodel.mako

@@ -1,5 +1,5 @@
 """Set the full path to the flow executable and flags"""
-${flow} --ml-wi-filename="${pwd}/model_pressure_radius_WI/WI.model" --linear-solver-reduction=1e-5 --relaxed-max-pv-fraction=0 --ecl-enable-drift-compensation=0 --newton-max-iterations=50 --newton-min-iterations=5 --tolerance-mb=1e-7 --tolerance-wells=1e-5 --relaxed-well-flow-tol=1e-5 --use-multisegment-well=false --enable-tuning=true --enable-opm-rst-file=true --linear-solver=cprw --enable-well-operability-check=false --min-time-step-before-shutting-problematic-wells-in-days=1e-99
+${flow} --ml-wi-filename="${pwd}/model_pressure_radius_WI/WI.model" --linear-solver-reduction=1e-5 --relaxed-max-pv-fraction=0 --enable-drift-compensation=0 --newton-max-iterations=50 --newton-min-iterations=5 --tolerance-mb=1e-7 --tolerance-wells=1e-5 --relaxed-well-flow-tol=1e-5 --use-multisegment-well=false --enable-tuning=true --enable-opm-rst-file=true --linear-solver=cprw --enable-well-operability-check=false --min-time-step-before-shutting-problematic-wells-in-days=1e-99
 
 """Set the model parameters"""
 co2store base     #Model (co2store/h2store)

examples/cemracs2023/peaceman_well-model_nn/2023-08-10_ml_well_model_CO2_realistic_critical_point/co2_3d_ml_wellmodel_large_reservoir.mako

@@ -1,5 +1,5 @@
 """Set the full path to the flow executable and flags"""
-${flow} --ml-wi-filename="${pwd}/model_pressure_radius_WI/WI.model" --linear-solver-reduction=1e-5 --relaxed-max-pv-fraction=0 --ecl-enable-drift-compensation=0 --newton-max-iterations=50 --newton-min-iterations=5 --tolerance-mb=1e-7 --tolerance-wells=1e-5 --relaxed-well-flow-tol=1e-5 --use-multisegment-well=false --enable-tuning=true --enable-opm-rst-file=true --linear-solver=cprw --enable-well-operability-check=false --min-time-step-before-shutting-problematic-wells-in-days=1e-99
+${flow} --ml-wi-filename="${pwd}/model_pressure_radius_WI/WI.model" --linear-solver-reduction=1e-5 --relaxed-max-pv-fraction=0 --enable-drift-compensation=0 --newton-max-iterations=50 --newton-min-iterations=5 --tolerance-mb=1e-7 --tolerance-wells=1e-5 --relaxed-well-flow-tol=1e-5 --use-multisegment-well=false --enable-tuning=true --enable-opm-rst-file=true --linear-solver=cprw --enable-well-operability-check=false --min-time-step-before-shutting-problematic-wells-in-days=1e-99
 
 """Set the model parameters"""
 co2store base     #Model (co2store/h2store)

examples/cemracs2023/peaceman_well-model_nn/2023-08-10_ml_well_model_CO2_realistic_critical_point/run_ensemble.py

@@ -10,6 +10,7 @@
     1. WI [m*s]
 
 """
+
 from __future__ import annotations
 
 import logging
@@ -54,13 +55,15 @@
 X: float = 2.500000e-01  # Outer coordinates of first cell.
 Y: float = -1.443376e-01
 WELL_RADIUS: float = math.sqrt(X**2 + Y**2)  # unit: [m]; Fixed during training.
-DENSITY: float = 12.9788  # unit: kg/m^3; for 72 bar, 30.9780 °C. Is this at surface conditions or not?
+DENSITY: float = (
+    12.9788  # unit: kg/m^3; for 72 bar, 30.9780 °C. Is this at surface conditions or not?
+)
 VISCOSITY: float = 1.52786e-05  # unit: Pa*s; for 72 bar, 30.9780 °C
 
 FLOW = "flow"
 FLAGS = (
     " --linear-solver-reduction=1e-5 --relaxed-max-pv-fraction=0"
-    + " --ecl-enable-drift-compensation=0 --newton-max-iterations=50"
+    + " --enable-drift-compensation=0 --newton-max-iterations=50"
     + " --newton-min-iterations=5 --tolerance-mb=1e-7 --tolerance-wells=1e-5"
     + " --relaxed-well-flow-tol=1e-5 --use-multisegment-well=false --enable-tuning=true"
     + " --enable-opm-rst-file=true --linear-solver=cprw"

examples/cemracs2023/peaceman_well-model_nn/example_framework_peaceman_co2/co2_3d_flow_wellmodel.mako

@@ -1,5 +1,5 @@
 """Set the full path to the flow executable and flags"""
-${flow} --ml-wi-filename="" --linear-solver-reduction=1e-5 --relaxed-max-pv-fraction=0 --ecl-enable-drift-compensation=0 --newton-max-iterations=50 --newton-min-iterations=5 --tolerance-mb=1e-7 --tolerance-wells=1e-5 --relaxed-well-flow-tol=1e-5 --use-multisegment-well=false --enable-tuning=true --enable-opm-rst-file=true --linear-solver=cprw --enable-well-operability-check=false --min-time-step-before-shutting-problematic-wells-in-days=1e-99
+${flow} --ml-wi-filename="" --linear-solver-reduction=1e-5 --relaxed-max-pv-fraction=0 --enable-drift-compensation=0 --newton-max-iterations=50 --newton-min-iterations=5 --tolerance-mb=1e-7 --tolerance-wells=1e-5 --relaxed-well-flow-tol=1e-5 --use-multisegment-well=false --enable-tuning=true --enable-opm-rst-file=true --linear-solver=cprw --enable-well-operability-check=false --min-time-step-before-shutting-problematic-wells-in-days=1e-99
 
 """Set the model parameters"""
 co2store base    #Model (co2store/h2store)

examples/cemracs2023/peaceman_well-model_nn/example_framework_peaceman_co2/co2_3d_ml_wellmodel.mako

@@ -1,5 +1,5 @@
 """Set the full path to the flow executable and flags"""
-${flow} --ml-wi-filename="${pwd}/water_re.modelPeaceman" --linear-solver-reduction=1e-5 --relaxed-max-pv-fraction=0 --ecl-enable-drift-compensation=0 --newton-max-iterations=50 --newton-min-iterations=5 --tolerance-mb=1e-7 --tolerance-wells=1e-5 --relaxed-well-flow-tol=1e-5 --use-multisegment-well=false --enable-tuning=true --enable-opm-rst-file=true --linear-solver=cprw --enable-well-operability-check=false --min-time-step-before-shutting-problematic-wells-in-days=1e-99
+${flow} --ml-wi-filename="${pwd}/water_re.modelPeaceman" --linear-solver-reduction=1e-5 --relaxed-max-pv-fraction=0 --enable-drift-compensation=0 --newton-max-iterations=50 --newton-min-iterations=5 --tolerance-mb=1e-7 --tolerance-wells=1e-5 --relaxed-well-flow-tol=1e-5 --use-multisegment-well=false --enable-tuning=true --enable-opm-rst-file=true --linear-solver=cprw --enable-well-operability-check=false --min-time-step-before-shutting-problematic-wells-in-days=1e-99
 
 """Set the model parameters"""
 co2store base    #Model (co2store/h2store)

examples/cemracs2023/peaceman_well-model_nn/example_framework_peaceman_co2/co2_nearwell.mako

@@ -1,5 +1,5 @@
 """Set the full path to the flow executable and flags"""
-${flow} --linear-solver-reduction=1e-5 --relaxed-max-pv-fraction=0 --ecl-enable-drift-compensation=0 --newton-max-iterations=50 --newton-min-iterations=5 --use-multisegment-well=false --enable-tuning=true --enable-opm-rst-file=true --linear-solver=cprw --enable-well-operability-check=false --min-time-step-before-shutting-problematic-wells-in-days=1e-99
+${flow} --linear-solver-reduction=1e-5 --relaxed-max-pv-fraction=0 --enable-drift-compensation=0 --newton-max-iterations=50 --newton-min-iterations=5 --use-multisegment-well=false --enable-tuning=true --enable-opm-rst-file=true --linear-solver=cprw --enable-well-operability-check=false --min-time-step-before-shutting-problematic-wells-in-days=1e-99
 
 """Set the model parameters"""
 co2store base    #Model (co2store/h2store)

examples/cemracs2023/peaceman_well-model_nn/example_framework_peaceman_co2/example.py

@@ -24,12 +24,15 @@ def compute_peaceman(k_h: float, r_e: float, r_w: float) -> float:
     from the Peaceman well model.
     .. math::
         WI\cdot\frac{\mu}{\rho} = \frac{2\pi hk}{\ln (r_e/r_w)}
-    Parameters:
-        k_h: Permeability times the cell thickness (thickness fix to 1 m).
-        r_e: Equivalent well-block radius.
-        r_w: Wellbore radius.
+
+    Args:
+        k_h (float): Permeability times the cell thickness (thickness fix to 1 m).
+        r_e (float): Equivalent well-block radius.
+        r_w (float): Wellbore radius.
+
     Returns:
-        :math:`WI\cdot\frac{\mu}{\rho}`
+        float: :math:`WI\cdot\frac{\mu}{\rho}`
+
     """
     w_i = (2 * math.pi * k_h) / (math.log(r_e / r_w))
     return w_i