Setting ehystr from the tomls

docs/_sources/configuration_file.rst.txt

@@ -40,7 +40,7 @@ The following input lines are:
     initialphase = 0 #Initial phase in the reservoir (0 wetting, 1 non-wetting) 
     pvmult = 1e10 #Pore volume multiplier on the boundary [-] (-1 to ignore; 0 to use well producers instead)
     perforations = [1,5,6] #Activate perforations [-], number of well perforations [-], and length [m]
-    hysteresis = "Killough" #Add hysteresis (Killough or Carlson, 0 by default, i.e., no hysteresis)
+    ehystr = "1* 2 2* KR" #Define Hysteresis model and parameters (see EHYSTR in the OPM Flow manual)
     zxy = "2-2*np.cos((2*np.pi*x/50)) + 10*(x/100)**2" #The function for the reservoir surface
 
 Here we first select the physical model and the corresponding template. To add additional models (e.g., blackoil), one could look at the 

docs/configuration_file.html

@@ -114,7 +114,7 @@ <h2>Reservoir-related parameters<a class="headerlink" href="#reservoir-related-p
 <span class="linenos">15</span><span class="n">initialphase</span> <span class="o">=</span> <span class="mi">0</span> <span class="c1">#Initial phase in the reservoir (0 wetting, 1 non-wetting)</span>
 <span class="linenos">16</span><span class="n">pvmult</span> <span class="o">=</span> <span class="mf">1e10</span> <span class="c1">#Pore volume multiplier on the boundary [-] (-1 to ignore; 0 to use well producers instead)</span>
 <span class="linenos">17</span><span class="n">perforations</span> <span class="o">=</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span><span class="mi">5</span><span class="p">,</span><span class="mi">6</span><span class="p">]</span> <span class="c1">#Activate perforations [-], number of well perforations [-], and length [m]</span>
-<span class="linenos">18</span><span class="n">hysteresis</span> <span class="o">=</span> <span class="s2">&quot;Killough&quot;</span> <span class="c1">#Add hysteresis (Killough or Carlson, 0 by default, i.e., no hysteresis)</span>
+<span class="linenos">18</span><span class="n">ehystr</span> <span class="o">=</span> <span class="s2">&quot;1* 2 2* KR&quot;</span> <span class="c1">#Define Hysteresis model and parameters (see EHYSTR in the OPM Flow manual)</span>
 <span class="linenos">19</span><span class="n">zxy</span> <span class="o">=</span> <span class="s2">&quot;2-2*np.cos((2*np.pi*x/50)) + 10*(x/100)**2&quot;</span> <span class="c1">#The function for the reservoir surface</span>
 </pre></div>
 </div>

docs/genindex.html

@@ -90,6 +90,7 @@ <h1 id="index">Index</h1>
  | <a href="#G"><strong>G</strong></a>
  | <a href="#H"><strong>H</strong></a>
  | <a href="#I"><strong>I</strong></a>
+ | <a href="#L"><strong>L</strong></a>
  | <a href="#M"><strong>M</strong></a>
  | <a href="#N"><strong>N</strong></a>
  | <a href="#O"><strong>O</strong></a>
@@ -166,10 +167,12 @@ <h2 id="C">C</h2>
       </ul></li>
       <li><a href="pyopmnearwell.utils.formulas.html#pyopmnearwell.utils.formulas.cell_size">cell_size() (in module pyopmnearwell.utils.formulas)</a>
 </li>
-      <li><a href="pyopmnearwell.utils.formulas.html#pyopmnearwell.utils.formulas.co2brinepvt">co2brinepvt() (in module pyopmnearwell.utils.formulas)</a>
+      <li><a href="pyopmnearwell.core.pyopmnearwell.html#pyopmnearwell.core.pyopmnearwell.check_cmdargs">check_cmdargs() (in module pyopmnearwell.core.pyopmnearwell)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="pyopmnearwell.utils.formulas.html#pyopmnearwell.utils.formulas.co2brinepvt">co2brinepvt() (in module pyopmnearwell.utils.formulas)</a>
+</li>
       <li><a href="pyopmnearwell.utils.writefile.html#pyopmnearwell.utils.writefile.compact_format">compact_format() (in module pyopmnearwell.utils.writefile)</a>
 </li>
       <li><a href="pyopmnearwell.ml.scaler_layers.html#pyopmnearwell.ml.scaler_layers.MinMaxScalerLayer.compute_output_shape">compute_output_shape() (pyopmnearwell.ml.scaler_layers.MinMaxScalerLayer method)</a>
@@ -333,6 +336,14 @@ <h2 id="I">I</h2>
   </ul></td>
 </tr></table>
 
+<h2 id="L">L</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="pyopmnearwell.core.pyopmnearwell.html#pyopmnearwell.core.pyopmnearwell.load_parser">load_parser() (in module pyopmnearwell.core.pyopmnearwell)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="M">M</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>

docs/pyopmnearwell.core.html

@@ -89,6 +89,8 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 <div class="toctree-wrapper compound">
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="pyopmnearwell.core.pyopmnearwell.html">pyopmnearwell.core.pyopmnearwell module</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="pyopmnearwell.core.pyopmnearwell.html#pyopmnearwell.core.pyopmnearwell.check_cmdargs"><code class="docutils literal notranslate"><span class="pre">check_cmdargs()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyopmnearwell.core.pyopmnearwell.html#pyopmnearwell.core.pyopmnearwell.load_parser"><code class="docutils literal notranslate"><span class="pre">load_parser()</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="pyopmnearwell.core.pyopmnearwell.html#pyopmnearwell.core.pyopmnearwell.main"><code class="docutils literal notranslate"><span class="pre">main()</span></code></a></li>
 </ul>
 </li>

docs/pyopmnearwell.core.pyopmnearwell.html

@@ -86,9 +86,30 @@
   <section id="module-pyopmnearwell.core.pyopmnearwell">
 <span id="pyopmnearwell-core-pyopmnearwell-module"></span><h1>pyopmnearwell.core.pyopmnearwell module<a class="headerlink" href="#module-pyopmnearwell.core.pyopmnearwell" title="Link to this heading"></a></h1>
 <p>Main script for pyopmnearwell</p>
+<dl class="py function">
+<dt class="sig sig-object py" id="pyopmnearwell.core.pyopmnearwell.check_cmdargs">
+<span class="sig-prename descclassname"><span class="pre">pyopmnearwell.core.pyopmnearwell.</span></span><span class="sig-name descname"><span class="pre">check_cmdargs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmdargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Namespace</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pyopmnearwell.core.pyopmnearwell.check_cmdargs" title="Link to this definition"></a></dt>
+<dd><p>Validate command-line arguments.</p>
+<p>The checks cover the input configuration file and output folder.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>cmdargs</strong> – Parsed arguments returned by <code class="xref py py-mod docutils literal notranslate"><span class="pre">argparse</span></code>.</p>
+</dd>
+<dt class="field-even">Raises<span class="colon">:</span></dt>
+<dd class="field-even"><p><strong>SystemExit</strong> – If an argument is invalid.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="pyopmnearwell.core.pyopmnearwell.load_parser">
+<span class="sig-prename descclassname"><span class="pre">pyopmnearwell.core.pyopmnearwell.</span></span><span class="sig-name descname"><span class="pre">load_parser</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">argv</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Namespace</span></span></span><a class="headerlink" href="#pyopmnearwell.core.pyopmnearwell.load_parser" title="Link to this definition"></a></dt>
+<dd><p>CLI arguments</p>
+</dd></dl>
+
 <dl class="py function">
 <dt class="sig sig-object py" id="pyopmnearwell.core.pyopmnearwell.main">
-<span class="sig-prename descclassname"><span class="pre">pyopmnearwell.core.pyopmnearwell.</span></span><span class="sig-name descname"><span class="pre">main</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">argv</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pyopmnearwell.core.pyopmnearwell.main" title="Link to this definition"></a></dt>
+<span class="sig-prename descclassname"><span class="pre">pyopmnearwell.core.pyopmnearwell.</span></span><span class="sig-name descname"><span class="pre">main</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">argv</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pyopmnearwell.core.pyopmnearwell.main" title="Link to this definition"></a></dt>
 <dd><p>Main function for the pyopmnearwell executable</p>
 </dd></dl>
 

docs/pyopmnearwell.html

@@ -90,6 +90,8 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
 <li class="toctree-l1"><a class="reference internal" href="pyopmnearwell.core.html">pyopmnearwell.core package</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="pyopmnearwell.core.html#submodules">Submodules</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="pyopmnearwell.core.pyopmnearwell.html">pyopmnearwell.core.pyopmnearwell module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="pyopmnearwell.core.pyopmnearwell.html#pyopmnearwell.core.pyopmnearwell.check_cmdargs"><code class="docutils literal notranslate"><span class="pre">check_cmdargs()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="pyopmnearwell.core.pyopmnearwell.html#pyopmnearwell.core.pyopmnearwell.load_parser"><code class="docutils literal notranslate"><span class="pre">load_parser()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="pyopmnearwell.core.pyopmnearwell.html#pyopmnearwell.core.pyopmnearwell.main"><code class="docutils literal notranslate"><span class="pre">main()</span></code></a></li>
 </ul>
 </li>

docs/text/configuration_file.rst

@@ -40,7 +40,7 @@ The following input lines are:
     initialphase = 0 #Initial phase in the reservoir (0 wetting, 1 non-wetting) 
     pvmult = 1e10 #Pore volume multiplier on the boundary [-] (-1 to ignore; 0 to use well producers instead)
     perforations = [1,5,6] #Activate perforations [-], number of well perforations [-], and length [m]
-    hysteresis = "Killough" #Add hysteresis (Killough or Carlson, 0 by default, i.e., no hysteresis)
+    ehystr = "1* 2 2* KR" #Define Hysteresis model and parameters (see EHYSTR in the OPM Flow manual)
     zxy = "2-2*np.cos((2*np.pi*x/50)) + 10*(x/100)**2" #The function for the reservoir surface
 
 Here we first select the physical model and the corresponding template. To add additional models (e.g., blackoil), one could look at the 

examples/cemracs2023/ccs_control/q_1440000_t_30/co2.mako

@@ -14,7 +14,7 @@ pressure = 10 #Pressure [Bar] on the top
 temperature = [40,40] #Top and bottom temperatures [C]
 initialphase = 0 #Initial phase in the reservoir (0 wetting, 1 non-wetting) 
 pvmult = 1e5 #Pore volume multiplier on the boundary [-] (-1 to ignore; 0 to use well producers instead)
-hysteresis = "Killough" #Add hysteresis (Killough or Carlson, 0 by default, i.e., no hysteresis)
+ehystr = "1* 2 2* KR" #Define Hysteresis model and parameters (see EHYSTR in the OPM Flow manual)
 zxy = "20-20*np.cos((2*np.pi*x/250)) + 200*(x/1000)**2" #The function for the reservoir surface
 
 #Set the saturation functions

examples/cemracs2023/ccs_control/q_360000_t_120/co2.mako

@@ -14,7 +14,7 @@ pressure = 10 #Pressure [Bar] on the top
 temperature = [40,40] #Top and bottom temperatures [C]
 initialphase = 0 #Initial phase in the reservoir (0 wetting, 1 non-wetting) 
 pvmult = 1e5 #Pore volume multiplier on the boundary [-] (-1 to ignore; 0 to use well producers instead)
-hysteresis = "Killough" #Add hysteresis (Killough or Carlson, 0 by default, i.e., no hysteresis)
+ehystr = "1* 2 2* KR" #Define Hysteresis model and parameters (see EHYSTR in the OPM Flow manual)
 zxy = "20-20*np.cos((2*np.pi*x/250)) + 200*(x/1000)**2" #The function for the reservoir surface
 
 #Set the saturation functions

examples/cemracs2023/ccs_control/q_720000_t_60/co2.mako

@@ -14,7 +14,7 @@ pressure = 10 #Pressure [Bar] on the top
 temperature = [40,40] #Top and bottom temperatures [C]
 initialphase = 0 #Initial phase in the reservoir (0 wetting, 1 non-wetting) 
 pvmult = 1e5 #Pore volume multiplier on the boundary [-] (-1 to ignore; 0 to use well producers instead)
-hysteresis = "Killough" #Add hysteresis (Killough or Carlson, 0 by default, i.e., no hysteresis)
+ehystr = "1* 2 2* KR" #Define Hysteresis model and parameters (see EHYSTR in the OPM Flow manual)
 zxy = "20-20*np.cos((2*np.pi*x/250)) + 200*(x/1000)**2" #The function for the reservoir surface
 
 #Set the saturation functions

examples/cemracs2023/h2_3controls/hyst/h2.mako

@@ -13,7 +13,7 @@ pressure = 40 #Pressure [Bar] on the top
 temperature = [50,50] #Top and bottom temperatures [C]
 initialphase = 0 #Initial phase in the reservoir (0 wetting, 1 non-wetting)
 pvmult = 1e4 #Pore volume multiplier on the boundary [-] (-1 to ignore; 0 to use well producers instead)
-hysteresis = "Killough" #Add hysteresis (Killough or Carlson, 0 by default, i.e., no hysteresis)
+ehystr = "1* 2 2* KR" #Define Hysteresis model and parameters (see EHYSTR in the OPM Flow manual)
 
 #Set the saturation functions
 krw = "krw * ((sw - swi) / (1.0 - sni -swi)) ** nkrw"        #Wetting rel perm saturation function [-]

examples/cemracs2023/h2_3controls/hyst_wecon/h2.mako

@@ -13,7 +13,7 @@ pressure = 40 #Pressure [Bar] on the top
 temperature = [50,50] #Top and bottom temperatures [C]
 initialphase = 0 #Initial phase in the reservoir (0 wetting, 1 non-wetting)
 pvmult = 1e4 #Pore volume multiplier on the boundary [-] (-1 to ignore; 0 to use well producers instead)
-hysteresis = "Killough" #Add hysteresis (Killough or Carlson, 0 by default, i.e., no hysteresis)
+ehystr = "1* 2 2* KR" #Define Hysteresis model and parameters (see EHYSTR in the OPM Flow manual)
 econ = 0.95 #For h2 models, econ for the producer
 
 #Set the saturation functions

examples/cemracs2023/h2_combinations_in_schedule/dissolution_wecon_hyst/h2.mako

@@ -13,7 +13,7 @@ pressure = 40 #Pressure [Bar] on the top
 temperature = [50,50] #Top and bottom temperatures [C]
 initialphase = 0 #Initial phase in the reservoir (0 wetting, 1 non-wetting)
 pvmult = 1e4 #Pore volume multiplier on the boundary [-] (-1 to ignore; 0 to use well producers instead)
-hysteresis = "Killough" #Add hysteresis (Killough or Carlson, 0 by default, i.e., no hysteresis)
+ehystr = "1* 2 2* KR" #Define Hysteresis model and parameters (see EHYSTR in the OPM Flow manual)
 econ = ${econ} #For h2 models, econ for the producer
 zxy = "300-300*mt.exp(-(x**2)/(2*500**2)) - 0*100*mt.exp(-((x-500)**2)/(2*100**2))" #The function for the reservoir surface
 

examples/cemracs2023/h2_forecast/dissolution_wecon_hyst/h2.mako

@@ -16,7 +16,7 @@ temperature = [50,50] #Top and bottom temperatures [C]
 initialphase = 0 #Initial phase in the reservoir (0 wetting, 1 non-wetting)
 pvmult = 1e4 #Pore volume multiplier on the boundary [-] (-1 to ignore; 0 to use well producers instead)
 
-hysteresis = "Killough" #Add hysteresis (Killough or Carlson, 0 by default, i.e., no hysteresis)
+ehystr = "1* 2 2* KR" #Define Hysteresis model and parameters (see EHYSTR in the OPM Flow manual)
 econ = ${econ} #For h2 models, econ for the producer
 
 zxy = "300-300*mt.exp(-(x**2)/(2*500**2)) - 0*100*mt.exp(-((x-500)**2)/(2*100**2))" #The function for the reservoir surface

examples/cemracs2023/h2_lab/diss_satfunc_hyst/h2.mako

@@ -13,7 +13,7 @@ pressure = 40 #Pressure [Bar] on the top
 temperature = [50,50] #Top and bottom temperatures [C]
 initialphase = 0 #Initial phase in the reservoir (0 wetting, 1 non-wetting)
 pvmult = 1e4 #Pore volume multiplier on the boundary [-] (-1 to ignore; 0 to use well producers instead)
-hysteresis = "Killough" #Add hysteresis (Killough or Carlson, 0 by default, i.e., no hysteresis)
+ehystr = "1* 2 2* KR" #Define Hysteresis model and parameters (see EHYSTR in the OPM Flow manual)
 
 #Set the saturation functions
 krw = "krw * ((sw - swi) / (1.0 - sni -swi)) ** nkrw"        #Wetting rel perm saturation function [-]

examples/cemracs2023/h2_lab/diss_satfunc_hyst_wecon/h2.mako

@@ -13,7 +13,7 @@ pressure = 40 #Pressure [Bar] on the top
 temperature = [50,50] #Top and bottom temperatures [C]
 initialphase = 0 #Initial phase in the reservoir (0 wetting, 1 non-wetting)
 pvmult = 1e4 #Pore volume multiplier on the boundary [-] (-1 to ignore; 0 to use well producers instead)
-hysteresis = "Killough" #Add hysteresis (Killough or Carlson, 0 by default, i.e., no hysteresis)
+ehystr = "1* 2 2* KR" #Define Hysteresis model and parameters (see EHYSTR in the OPM Flow manual)
 econ = 0.95 #For h2 models, econ for the producer
 
 #Set the saturation functions

examples/cemracs2023/h2_lab/satfunc_hyst/h2.mako

@@ -14,7 +14,7 @@ temperature = [50,50] #Top and bottom temperatures [C]
 initialphase = 0 #Initial phase in the reservoir (0 wetting, 1 non-wetting)
 pvmult = 1e4 #Pore volume multiplier on the boundary [-] (-1 to ignore; 0 to use well producers instead)
 
-hysteresis = "Killough" #Add hysteresis (Killough or Carlson, 0 by default, i.e., no hysteresis)
+ehystr = "1* 2 2* KR" #Define Hysteresis model and parameters (see EHYSTR in the OPM Flow manual)
 
 #Set the saturation functions
 krw = "krw * ((sw - swi) / (1.0 - sni -swi)) ** nkrw"        #Wetting rel perm saturation function [-]

examples/cemracs2023/proceedings/hwell_hyst/h2.mako

@@ -15,7 +15,7 @@ pressure = 40 #Pressure [Bar] on the top
 temperature = [50,50] #Top and bottom temperatures [C]
 initialphase = 0 #Initial phase in the reservoir (0 wetting, 1 non-wetting)
 pvmult = 1e8 #Pore volume multiplier on the boundary [-] (-1 to ignore; 0 to use well producers instead)
-hysteresis = "Killough" #Add hysteresis (Killough or Carlson, 0 by default, i.e., no hysteresis)
+ehystr = "1* 2 2* KR" #Define Hysteresis model and parameters (see EHYSTR in the OPM Flow manual)
 
 #Set the saturation functions
 krw = "krw * ((sw - swi) / (1.0 - sni -swi)) ** nkrw"        #Wetting rel perm saturation function [-]

examples/cemracs2023/proceedings/ml_hwell/h2.mako

@@ -15,7 +15,7 @@ pressure = 40 #Pressure [Bar] on the top
 temperature = [50,50] #Top and bottom temperatures [C]
 initialphase = 0 #Initial phase in the reservoir (0 wetting, 1 non-wetting)
 pvmult = 1e7 #Pore volume multiplier on the boundary [-] (-1 to ignore; 0 to use well producers instead)
-hysteresis = "Killough" #Add hysteresis (Killough or Carlson, 0 by default, i.e., no hysteresis)
+ehystr = "1* 2 2* KR" #Define Hysteresis model and parameters (see EHYSTR in the OPM Flow manual)
 
 #Set the saturation functions
 krw = "krw * ((sw - swi) / (1.0 - sni -swi)) ** nkrw"        #Wetting rel perm saturation function [-]

examples/co2.toml

@@ -15,7 +15,7 @@ temperature = [40,40] #Top and bottom temperatures [C]
 initialphase = 0 #Initial phase in the reservoir (0 wetting, 1 non-wetting) 
 pvmult = 1e10 #Pore volume multiplier on the boundary [-] (-1 to ignore; 0 to use well producers instead)
 perforations = [1,5,6] #Activate perforations [-], number of well perforations [-], and length [m]
-hysteresis = "Killough" #Add hysteresis (Killough or Carlson, 0 by default, i.e., no hysteresis)
+ehystr = "1* 2 2* KR" #Define Hysteresis model and parameters (see EHYSTR in the OPM Flow manual)
 zxy = "2-2*np.cos((2*np.pi*x/50)) + 10*(x/100)**2" #The function for the reservoir surface
 
 #Set the saturation functions