Merge pull request #72 from daavid00/documentation

Documentation for the convective model

benchmark/spe11a/result1.txt

@@ -3,7 +3,7 @@ mpirun -np 32 flow --partition-method=2 --edge-weights-method=2 --imbalance-tol=
 
 """Set the model parameters"""
 spe11a master     #Name of the spe case (spe11a, spe11b, or spe11c) and OPM Flow version (master or release)
-complete gaswater #Name of the co2 model (immiscible or complete) and co2store implementation (gaswater or gasoil [oil properties are set to water internally in OPM flow])
+complete gaswater #Name of the co2 model (immiscible, convective [convective requires a Flow version newer than 22-08-2024], or complete) and co2store implementation (gaswater or gasoil [oil properties are set to water internally in OPM flow])
 cartesian         #Type of grid (cartesian, tensor, or corner-point)
 2.8 0.01 1.2      #Length, width, and depth [m]
 280               #If cartesian, number of x cells [-]; otherwise, variable array of x-refinment

benchmark/spe11a/result2.txt

@@ -3,7 +3,7 @@ mpirun -np 32 flow --partition-method=2 --edge-weights-method=2 --imbalance-tol=
 
 """Set the model parameters"""
 spe11a master     #Name of the spe case (spe11a, spe11b, or spe11c) and OPM Flow version (master or release)
-complete gaswater #Name of the co2 model (immiscible or complete) and co2store implementation (gaswater or gasoil [oil properties are set to water internally in OPM flow])
+complete gaswater #Name of the co2 model (immiscible, convective [convective requires a Flow version newer than 22-08-2024], or complete) and co2store implementation (gaswater or gasoil [oil properties are set to water internally in OPM flow])
 cartesian         #Type of grid (cartesian, tensor, or corner-point)
 2.8 0.01 1.2      #Length, width, and depth [m]
 280               #If cartesian, number of x cells [-]; otherwise, variable array of x-refinment

benchmark/spe11a/result3.txt

@@ -3,7 +3,7 @@ mpirun -np 32 flow --partition-method=2 --edge-weights-method=2 --imbalance-tol=
 
 """Set the model parameters"""
 spe11a master     #Name of the spe case (spe11a, spe11b, or spe11c) and OPM Flow version (master or release)
-complete gaswater #Name of the co2 model (immiscible or complete) and co2store implementation (gaswater or gasoil [oil properties are set to water internally in OPM flow])
+complete gaswater #Name of the co2 model (immiscible, convective [convective requires a Flow version newer than 22-08-2024], or complete) and co2store implementation (gaswater or gasoil [oil properties are set to water internally in OPM flow])
 corner-point      #Type of grid (cartesian, tensor, or corner-point)
 2.8 0.01 1.2      #Length, width, and depth [m]
 280               #If cartesian, number of x cells [-]; otherwise, variable array of x-refinment

benchmark/spe11a/result4.txt

@@ -3,7 +3,7 @@ mpirun -np 70 flow --partition-method=2 --edge-weights-method=2 --imbalance-tol=
 
 """Set the model parameters"""
 spe11a master     #Name of the spe case (spe11a, spe11b, or spe11c) and OPM Flow version (master or release)
-complete gaswater #Name of the co2 model (immiscible or complete) and co2store implementation (gaswater or gasoil [oil properties are set to water internally in OPM flow])
+complete gaswater #Name of the co2 model (immiscible, convective [convective requires a Flow version newer than 22-08-2024], or complete) and co2store implementation (gaswater or gasoil [oil properties are set to water internally in OPM flow])
 cartesian         #Type of grid (cartesian, tensor, or corner-point)
 2.8 0.01 1.2      #Length, width, and depth [m]
 2800              #If cartesian, number of x cells [-]; otherwise, variable array of x-refinment

benchmark/spe11b/result1.txt

@@ -3,7 +3,7 @@ mpirun -np 32 flow --solver-max-time-step-in-days=3650 --relaxed-max-pv-fraction
 
 """Set the model parameters"""
 spe11b master     #Name of the spe case (spe11a, spe11b, or spe11c) and OPM Flow version (master or release)
-complete gaswater #Name of the co2 model (immiscible or complete) and co2store implementation (gaswater or gasoil [oil properties are set to water internally in OPM flow])
+complete gaswater #Name of the co2 model (immiscible, convective [convective requires a Flow version newer than 22-08-2024], or complete) and co2store implementation (gaswater or gasoil [oil properties are set to water internally in OPM flow])
 cartesian         #Type of grid (cartesian, tensor, or corner-point)
 8400 1 1200       #Length, width, and depth [m]
 840              #If cartesian, number of x cells [-]; otherwise, variable array of x-refinment

benchmark/spe11b/result2.txt

@@ -3,7 +3,7 @@ mpirun -np 32 flow --solver-max-time-step-in-days=3650 --relaxed-max-pv-fraction
 
 """Set the model parameters"""
 spe11b master     #Name of the spe case (spe11a, spe11b, or spe11c) and OPM Flow version (master or release)
-complete gaswater #Name of the co2 model (immiscible or complete) and co2store implementation (gaswater or gasoil [oil properties are set to water internally in OPM flow])
+complete gaswater #Name of the co2 model (immiscible, convective [convective requires a Flow version newer than 22-08-2024], or complete) and co2store implementation (gaswater or gasoil [oil properties are set to water internally in OPM flow])
 corner-point      #Type of grid (cartesian, tensor, or corner-point)
 8400 1 1200       #Length, width, and depth [m]
 840               #If cartesian, number of x cells [-]; otherwise, variable array of x-refinment

benchmark/spe11b/result3.txt

@@ -3,7 +3,7 @@ mpirun -np 64 flow --relaxed-max-pv-fraction=0 --partition-method=2 --edge-weigh
 
 """Set the model parameters"""
 spe11b master     #Name of the spe case (spe11a, spe11b, or spe11c) and OPM Flow version (master or release)
-complete gaswater #Name of the co2 model (immiscible or complete) and co2store implementation (gaswater or gasoil [oil properties are set to water internally in OPM flow])
+complete gaswater #Name of the co2 model (immiscible, convective [convective requires a Flow version newer than 22-08-2024], or complete) and co2store implementation (gaswater or gasoil [oil properties are set to water internally in OPM flow])
 cartesian         #Type of grid (cartesian, tensor, or corner-point)
 8400 1 1200       #Length, width, and depth [m]
 8400              #If cartesian, number of x cells [-]; otherwise, variable array of x-refinment

benchmark/spe11c/result1.txt

@@ -1,14 +1,14 @@
 """Set the full path to the flow executable and flags"""
-mpirun -np 64 flow --relaxed-max-pv-fraction=0 --partition-method=2 --edge-weights-method=2 --imbalance-tol=1.1 --tolerance-mb=1e-7 --enable-tuning=true --enable-opm-rst-file=true --output-extra-convergence-info=steps,iterations --newton-min-iterations=1 --linear-solver=cpr_trueimpes --time-step-control=newtoniterationcount --newton-max-iterations=13 --solver-growth-factor=1.9 --time-step-control-growth-rate=1.5 --enable-drift-compensation=0
+mpirun -np 64 flow --solver-max-time-step-in-days=3650 --relaxed-max-pv-fraction=0 --partition-method=2 --edge-weights-method=2 --imbalance-tol=1.1 --tolerance-mb=1e-7 --enable-opm-rst-file=true --output-extra-convergence-info=steps,iterations --newton-min-iterations=1 --linear-solver=cpr_trueimpes --time-step-control=newtoniterationcount --newton-max-iterations=12 --solver-growth-factor=1.6 --time-step-control-growth-rate=1.1 --solver-restart-factor=0.2 --time-step-control-decay-rate=0.65 --enable-drift-compensation=0
 
 """Set the model parameters"""
 spe11c master     #Name of the spe case (spe11a, spe11b, or spe11c) and OPM Flow version (master or release)
-complete gaswater #Name of the co2 model (immiscible or complete) and co2store implementation (gaswater or gasoil [oil properties are set to water internally in OPM flow])
-corner-point      #Type of grid (cartesian, tensor, or corner-point)
+complete gaswater #Name of the co2 model (immiscible, convective [convective requires a Flow version newer than 22-08-2024], or complete) and co2store implementation (gaswater or gasoil [oil properties are set to water internally in OPM flow])
+cartesian         #Type of grid (cartesian, tensor, or corner-point)
 8400 5000 1200    #Length, width, and depth [m]
 168               #If cartesian, number of x cells [-]; otherwise, variable array of x-refinment
 100               #If cartesian, number of y cells [-]; otherwise, variable array of y-refinment [-] (for spe11c)
-9,7,1,5,5,3,7,7,10,7,7,8,6,15,5,24,24,7  #If cartesian, number of z cells [-]; if tensor, variable array of z-refinment; if corner-point, fix array of z-refinment (18 entries)
+120               #If cartesian, number of z cells [-]; if tensor, variable array of z-refinment; if corner-point, fix array of z-refinment (18 entries)
 70 36.12          #Temperature bottom and top rig [C]            
 300 3e7 0.1       #Datum [m], pressure at the datum [Pa], and multiplier for the permeability in the z direction [-] 
 1e-9 2e-8         #Diffusion (in liquid and gas) [m^2/s]
@@ -51,8 +51,8 @@ PERM7    1e-5 PORO7 1e-6 DISP7  0 THCONR7 2.00
 """injection time, time step size to write results, maximum solver time step, injected fluid (0 water, 1 co2) (well1), injection rate [kg/s] (well1), temperature [C] (well1), injected fluid (0 water, 1 co2) (well2), ..."""
 999.9 999.9    10 1  0 10 1  0 10
   0.1   0.1   0.1 1  0 10 1  0 10
-   25     5     1 1 50 10 1  0 10
-   25     5   0.3 1 50 10 1 50 10
-   50    25   0.5 1  0 10 1  0 10
-  400    50   0.5 1  0 10 1  0 10
-  500   100     1 1  0 10 1  0 10
+   25     5     5 1 50 10 1  0 10
+   25     5     5 1 50 10 1 50 10
+   50    25    25 1  0 10 1  0 10
+  400    50    50 1  0 10 1  0 10
+  500   100   100 1  0 10 1  0 10

benchmark/spe11c/result2.txt

@@ -1,14 +1,14 @@
 """Set the full path to the flow executable and flags"""
-mpirun -np 64 flow --solver-max-time-step-in-days=3650 --relaxed-max-pv-fraction=0 --partition-method=2 --edge-weights-method=2 --imbalance-tol=1.1 --tolerance-mb=1e-7 --enable-opm-rst-file=true --output-extra-convergence-info=steps,iterations --newton-min-iterations=1 --linear-solver=cpr_trueimpes --time-step-control=newtoniterationcount --newton-max-iterations=12 --solver-growth-factor=1.6 --time-step-control-growth-rate=1.1 --solver-restart-factor=0.2 --time-step-control-decay-rate=0.65 --enable-drift-compensation=0
+mpirun -np 64 flow --relaxed-max-pv-fraction=0 --partition-method=2 --edge-weights-method=2 --imbalance-tol=1.1 --tolerance-mb=1e-7 --enable-tuning=true --enable-opm-rst-file=true --output-extra-convergence-info=steps,iterations --newton-min-iterations=1 --linear-solver=cpr_trueimpes --time-step-control=newtoniterationcount --newton-max-iterations=13 --solver-growth-factor=1.9 --time-step-control-growth-rate=1.5 --enable-drift-compensation=0
 
 """Set the model parameters"""
 spe11c master     #Name of the spe case (spe11a, spe11b, or spe11c) and OPM Flow version (master or release)
-complete gaswater #Name of the co2 model (immiscible or complete) and co2store implementation (gaswater or gasoil [oil properties are set to water internally in OPM flow])
-cartesian         #Type of grid (cartesian, tensor, or corner-point)
+complete gaswater #Name of the co2 model (immiscible, convective [convective requires a Flow version newer than 22-08-2024], or complete) and co2store implementation (gaswater or gasoil [oil properties are set to water internally in OPM flow])
+corner-point      #Type of grid (cartesian, tensor, or corner-point)
 8400 5000 1200    #Length, width, and depth [m]
 168               #If cartesian, number of x cells [-]; otherwise, variable array of x-refinment
 100               #If cartesian, number of y cells [-]; otherwise, variable array of y-refinment [-] (for spe11c)
-120               #If cartesian, number of z cells [-]; if tensor, variable array of z-refinment; if corner-point, fix array of z-refinment (18 entries)
+9,7,1,5,5,3,7,7,10,7,7,8,6,15,5,24,24,7  #If cartesian, number of z cells [-]; if tensor, variable array of z-refinment; if corner-point, fix array of z-refinment (18 entries)
 70 36.12          #Temperature bottom and top rig [C]            
 300 3e7 0.1       #Datum [m], pressure at the datum [Pa], and multiplier for the permeability in the z direction [-] 
 1e-9 2e-8         #Diffusion (in liquid and gas) [m^2/s]
@@ -51,8 +51,8 @@ PERM7    1e-5 PORO7 1e-6 DISP7  0 THCONR7 2.00
 """injection time, time step size to write results, maximum solver time step, injected fluid (0 water, 1 co2) (well1), injection rate [kg/s] (well1), temperature [C] (well1), injected fluid (0 water, 1 co2) (well2), ..."""
 999.9 999.9    10 1  0 10 1  0 10
   0.1   0.1   0.1 1  0 10 1  0 10
-   25     5     5 1 50 10 1  0 10
-   25     5     5 1 50 10 1 50 10
-   50    25    25 1  0 10 1  0 10
-  400    50    50 1  0 10 1  0 10
-  500   100   100 1  0 10 1  0 10
+   25     5     1 1 50 10 1  0 10
+   25     5   0.3 1 50 10 1 50 10
+   50    25   0.5 1  0 10 1  0 10
+  400    50   0.5 1  0 10 1  0 10
+  500   100     1 1  0 10 1  0 10

benchmark/spe11c/result3.txt

@@ -3,7 +3,7 @@ mpirun -np 1024 flow --partition-method=2 --edge-weights-method=2 --imbalance-to
 
 """Set the model parameters"""
 spe11c master     #Name of the spe case (spe11a, spe11b, or spe11c) and OPM Flow version (master or release)
-complete gaswater #Name of the co2 model (immiscible or complete) and co2store implementation (gaswater or gasoil [oil properties are set to water internally in OPM flow])
+complete gaswater #Name of the co2 model (immiscible, convective [convective requires a Flow version newer than 22-08-2024], or complete) and co2store implementation (gaswater or gasoil [oil properties are set to water internally in OPM flow])
 corner-point      #Type of grid (cartesian, tensor, or corner-point)
 8400 5000 1200    #Length, width, and depth [m]
 1050              #If cartesian, number of x cells [-]; otherwise, variable array of x-refinment

docs/_sources/configuration_file.rst.txt

@@ -35,7 +35,7 @@ The following input lines in the configuration file are:
 
     """Set the model parameters"""
     spe11c master     #Name of the spe case (spe11a, spe11b, or spe11c) and OPM Flow version (master or release)
-    complete gaswater #Name of the co2 model (immiscible or complete) and co2store implementation (gaswater or gasoil [oil properties are set to water internally in OPM flow])
+    complete gaswater #Name of the co2 model (immiscible, convective [convective requires a Flow version newer than 22-08-2024], or complete) and co2store implementation (gaswater or gasoil [oil properties are set to water internally in OPM flow])
     corner-point      #Type of grid (cartesian, tensor, or corner-point)
     8400 5000 1200    #Length, width, and depth [m]
     420               #If cartesian, number of x cells [-]; otherwise, variable array of x-refinment
@@ -52,7 +52,8 @@ In line 5 you specify if you are using OPM Flow from the master branch or from t
 This since there are continuous changues in the OPM master branch. Then we 
 will keep updating the decks for using Flow from master and also we will keep the framework to produce decks compatible for the latest OPM stable release.
 The immiscible model allows for faster prototyping while the complete model includes dissolution of the components in the
-gas and liquid phases, in addition to thermal effects. Regarding the grid type, the cartesian mode generates an uniform grid
+gas and liquid phases, in addition to thermal effects. The convective model requires a Flow version newer than 22-08-2024; details on the model and keyword can be found in this `link <https://github.com/OPM/opm-simulators/pull/3076>`_. 
+Regarding the grid type, the cartesian mode generates an uniform grid
 with the defined number of elements in lines 9 to 11. The tensor grid allows to define arrays in each direction where the grid
 is first divided with the number of entries in the array, and after it divides each of these elements by the assigned number in 
 the array entry. The corner-point mode generates a grid where the x and y direction are defined as in the array mode, but the 

docs/configuration_file.html

@@ -113,7 +113,7 @@ <h2>Reservoir-related parameters<a class="headerlink" href="#reservoir-related-p
 <p>The following input lines in the configuration file are:</p>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 4</span><span class="sd">&quot;&quot;&quot;Set the model parameters&quot;&quot;&quot;</span>
 <span class="linenos"> 5</span><span class="n">spe11c</span> <span class="n">master</span>     <span class="c1">#Name of the spe case (spe11a, spe11b, or spe11c) and OPM Flow version (master or release)</span>
-<span class="linenos"> 6</span><span class="n">complete</span> <span class="n">gaswater</span> <span class="c1">#Name of the co2 model (immiscible or complete) and co2store implementation (gaswater or gasoil [oil properties are set to water internally in OPM flow])</span>
+<span class="linenos"> 6</span><span class="n">complete</span> <span class="n">gaswater</span> <span class="c1">#Name of the co2 model (immiscible, convective [convective requires a Flow version newer than 22-08-2024], or complete) and co2store implementation (gaswater or gasoil [oil properties are set to water internally in OPM flow])</span>
 <span class="linenos"> 7</span><span class="n">corner</span><span class="o">-</span><span class="n">point</span>      <span class="c1">#Type of grid (cartesian, tensor, or corner-point)</span>
 <span class="linenos"> 8</span><span class="mi">8400</span> <span class="mi">5000</span> <span class="mi">1200</span>    <span class="c1">#Length, width, and depth [m]</span>
 <span class="linenos"> 9</span><span class="mi">420</span>               <span class="c1">#If cartesian, number of x cells [-]; otherwise, variable array of x-refinment</span>
@@ -131,7 +131,8 @@ <h2>Reservoir-related parameters<a class="headerlink" href="#reservoir-related-p
 This since there are continuous changues in the OPM master branch. Then we
 will keep updating the decks for using Flow from master and also we will keep the framework to produce decks compatible for the latest OPM stable release.
 The immiscible model allows for faster prototyping while the complete model includes dissolution of the components in the
-gas and liquid phases, in addition to thermal effects. Regarding the grid type, the cartesian mode generates an uniform grid
+gas and liquid phases, in addition to thermal effects. The convective model requires a Flow version newer than 22-08-2024; details on the model and keyword can be found in this <a class="reference external" href="https://github.com/OPM/opm-simulators/pull/3076">link</a>.
+Regarding the grid type, the cartesian mode generates an uniform grid
 with the defined number of elements in lines 9 to 11. The tensor grid allows to define arrays in each direction where the grid
 is first divided with the number of entries in the array, and after it divides each of these elements by the assigned number in
 the array entry. The corner-point mode generates a grid where the x and y direction are defined as in the array mode, but the

docs/genindex.html

@@ -87,6 +87,7 @@ <h1 id="index">Index</h1>
  | <a href="#C"><strong>C</strong></a>
  | <a href="#D"><strong>D</strong></a>
  | <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>
@@ -159,6 +160,14 @@ <h2 id="G">G</h2>
   </ul></td>
 </tr></table>
 
+<h2 id="H">H</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="pyopmspe11.utils.inputvalues.html#pyopmspe11.utils.inputvalues.handle_tuning">handle_tuning() (in module pyopmspe11.utils.inputvalues)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="I">I</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>