Option for aditional tuning parameters in the deck

Author: daavid00

README.md

@@ -5,7 +5,7 @@
 
 # pyopmspe11: A Python framework using OPM Flow for the SPE11 benchmark project
 
-<img src="docs/text/figs/animationspe11a.gif" width="830" height="360">
+<img src="docs/text/figs/pyopmspe11c100Mcells.gif" width="830" height="462">
 
 This repository contains scripts to set up a workflow using Python for the three cases in the [_SPE11 project_](https://www.spe.org/en/csp/).
 Here we use the [_OPM-Flow_](https://opm-project.org/?page_id=19) simulator.
@@ -39,7 +39,7 @@ pip install -e .
 pip install -r dev-requirements.txt
 ``` 
 
-See the [_installation_](https://OPM.github.io/pyopmsep11/installation.html) for further details on building OPM Flow from the master branches in Linux, Windows, and macOS, as well as the OPM Python package.
+See the [_installation_](https://OPM.github.io/pyopmspe11/installation.html) for further details on building OPM Flow from the master branches in Linux, Windows, and macOS, as well as the OPM Python package.
 
 ## Running pyopmspe11
 You can run _pyopmspe11_ as a single command line:

docs/text/figs/pyopmspe11c100Mcells.gif

@@ -4,7 +4,7 @@
 """Main script for pyopmspe11"""
 import os
 import argparse
-from pyopmspe11.utils.inputvalues import process_input, check_deck
+from pyopmspe11.utils.inputvalues import process_input, check_deck, handle_tuning
 from pyopmspe11.utils.runs import simulations, plotting, data
 from pyopmspe11.visualization.plotting import plot_results
 from pyopmspe11.utils.writefile import opm_files, initial
@@ -56,6 +56,8 @@ def pyopmspe11():
             print("Files used to generate the corner-point grid (INITIAL.* files)")
         # Check the generated deck, flow version, and chosen co2store implementation
         check_deck(dic)
+        # Handle tuning
+        handle_tuning(dic)
         # Get the sand and well/sources positions
         positions(dic)
         # Write used opm related files

requirements.txt

@@ -222,7 +222,7 @@ BCPROP
 
 % for j in range(len(dic['inj'])):
 TUNING
-1e-2 ${dic['inj'][j][2] / 86400.} 1e-10 2* 1e-12/
+${dic["tim_aft_eve"] if dic["tim_aft_eve"] else 1e-2} ${dic['inj'][j][2] / 86400.} 1e-10 2* 1e-12 ${dic["sol_res_fac"]}/
 /
 /
 % if max(dic['radius']) > 0:

src/pyopmspe11/core/pyopmspe11.py

@@ -240,7 +240,7 @@ COMPDAT
 
 % for j in range(len(dic['inj'])):
 TUNING
-1e-2 ${dic['inj'][j][2] / 86400.} 1e-10 2* 1e-12/
+${dic["tim_aft_eve"] if dic["tim_aft_eve"] else 1e-2} ${dic['inj'][j][2] / 86400.} 1e-10 2* 1e-12 ${dic["sol_res_fac"]}/
 /
 /
 % if max(dic['radius']) > 0:

src/pyopmspe11/templates/co2/spe11a.mako

@@ -227,7 +227,7 @@ COMPDAT
 
 % for j in range(len(dic['inj'])):
 TUNING
-1e-2 ${dic['inj'][j][2] / 86400.} 1e-10 2* 1e-12/
+${dic["tim_aft_eve"] if dic["tim_aft_eve"] else 1e-2} ${dic['inj'][j][2] / 86400.} 1e-10 2* 1e-12 ${dic["sol_res_fac"]}/
 /
 /
 % if max(dic['radius']) > 0:

src/pyopmspe11/templates/co2/spe11b.mako

@@ -243,3 +243,24 @@ def check_deck(dic):
             + "build flow from the master GitHub branches.\n"
         )
         sys.exit()
+
+
+def handle_tuning(dic):
+    """
+    If tuning is enable, then we write the entries corresponding to the maximum
+    length of the next time step after event and the solver restart factor.
+
+    Args:
+        dic (dict): Global dictionary
+
+    Returns:
+        dic (dict): Modified global dictionary
+
+    """
+    dic["tim_aft_eve"], dic["sol_res_fac"] = "", ""
+    for value in dic["flow"].split():
+        if "solver-restart-factor" in value:
+            dic["sol_res_fac"] = float(value.split("=")[1])
+            continue
+        if "time-step-after-event-in-days" in value:
+            dic["tim_aft_eve"] = float(value.split("=")[1])