Add 15% TI Mycek Data (#38)

This PR adds experimental data for the Mycek experiment at 15% TI. The grid convergence and comparison report scripts now include comparisons to this data and the online documentation has been updated where required. Additionally, a new method `is_equal` was added to the `CaseStudy` class to allow comparisons between `CaseStudy` objects that ignored some fields. This allows reuse of simulations where certain parameters do not affect the results, such as the frequency of generating restart files. Bump to version 0.6.1
Data-Only-Greater · May 12, 2022 · 69c5e8b · 69c5e8b
1 parent 3090c58
commit 69c5e8b
Show file tree

Hide file tree

Showing 45 changed files with 443 additions and 95 deletions.
diff --git a/.conda/recipe/meta.yaml b/.conda/recipe/meta.yaml
@@ -1,4 +1,4 @@
-{% set version = "0.6.0" %}
+{% set version = "0.6.1" %}
 
 package:
   name: snl-delft3d-cec-verify

diff --git a/README.md b/README.md
@@ -32,7 +32,7 @@ From a conda prompt create a named environment in which to install the
 for future updates:
 
 ```
-(base) > conda create -y -n snld3d --override-channels -c conda-forge -c dataonlygreater snl-delft3d-cec-verify=0.6.0
+(base) > conda create -y -n snld3d --override-channels -c conda-forge -c dataonlygreater snl-delft3d-cec-verify=0.6.1
 (base) > conda activate snld3d
 (snld3d) > conda config --env --add channels conda-forge --add channels dataonlygreater
 (snld3d) > conda config --env --set channel_priority strict

diff --git a/docs/_assets/gh-pages-redirect.html b/docs/_assets/gh-pages-redirect.html
@@ -3,7 +3,7 @@
   <head>
     <title>Redirecting to latest version</title>
     <meta charset="utf-8">
-    <meta http-equiv="refresh" content="0; url=./v0.6.0/index.html">
-    <link rel="canonical" href="https://data-only-greater.github.io/SNL-Delft3D-CEC-Verify/v0.6.0/index.html">
+    <meta http-equiv="refresh" content="0; url=./v0.6.1/index.html">
+    <link rel="canonical" href="https://data-only-greater.github.io/SNL-Delft3D-CEC-Verify/v0.6.1/index.html">
   </head>
 </html>
diff --git a/docs/conf.py b/docs/conf.py
@@ -25,7 +25,7 @@
 author = 'Mathew Topper'
 
 # The full version, including alpha/beta/rc tags
-release = '0.6.0'
+release = '0.6.1'
 
 
 # -- General configuration ---------------------------------------------------
@@ -57,7 +57,7 @@
 smv_remote_whitelist = r'^(origin)$'
 smv_tag_whitelist = r'^v(\d+\.\d+\.\d+)$' # r'^v(?!0.4.0|0.4.1|0.4.2)\d+\.\d+\.\d+$'
 smv_released_pattern = r'^refs/tags/.*$'
-smv_latest_version = 'v0.6.0'
+smv_latest_version = 'v0.6.1'
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

diff --git a/docs/validation/comparison/report.rst b/docs/validation/comparison/report.rst
@@ -62,24 +62,26 @@ acceleration around the edges of the turbine of the structured model.
    structured and fm models
 
 Comparing the non-dimensional centerline velocities alongside the
-experimental data (published in (Mycek et al. 2014)) in fig. 4, confirms
-the behavior in the near and far wake shown in fig. 3. Generally, the
-structured model performs better in the near wake compared to the
-experimental data, however the performance in the far wake is better for
-the FM model, where the wake has decayed less. Nonetheless, neither
-model captures the experimental measurements well for the whole
-centerline.
+experimental data (published in (Mycek et al. 2014)) for two turbulence
+intensity (TI) levels, in fig. 4, confirms the behavior in the near and
+far wake shown in fig. 3. Generally, the structured model performs
+better in the near wake compared to the experimental data. In the far
+wake, the FM model better repesents the 3% TI experimental data, and the
+structured model matches better to the 15% TI experimental data.
+Nonetheless, neither model captures the experimental measurements well
+for the whole centerline. Note that the TI within the Delft3D
+simulations is between 5% and 6%.
 
 .. figure:: transect_u.png
    :alt: Figure 4: Comparison of the normalised turbine centerline
          velocity. Experimental data reverse engineered from (Mycek et al.
-         2014, fig. 11a).
+         2014, fig. 11a & 11b).
    :name: fig:transect_u
-   :width: 4in
+   :width: 5.5in
 
    Figure 4: Comparison of the normalised turbine centerline velocity.
    Experimental data reverse engineered from (Mycek et al. 2014, fig.
-   11a).
+   11a & 11b).
 
 .. _sec:radial:
 

diff --git a/docs/validation/comparison/transect_u.png b/docs/validation/comparison/transect_u.png
diff --git a/docs/validation/fm/linux/report.rst b/docs/validation/fm/linux/report.rst
@@ -9,10 +9,14 @@ grid resolution, of 0.0625m, achieved an asymptotic ratio of 1.032
 (asymptotic range is indicated by a value :math:`\approx 1`). At zero
 grid resolution, the normalised velocity deficit measured 1.2 diameters
 downstream from the turbine was 35.85%, a 28.18% error against the
-measured value of 49.92%. For the centreline velocity transect, the root
-mean square error at the lowest grid resolution was 0.1954. For the
-axial velocity at :math:`x^*=5` transect, the root mean square error at
-the lowest grid resolution was 0.1167.
+measured value of 49.92%. For the centreline velocity (3% TI) transect,
+the root mean square error at the lowest grid resolution was 0.1954. For
+the centreline velocity (15% TI) transect, the root mean square error at
+the lowest grid resolution was 0.1172. For the axial velocity at
+:math:`x^*=5` (3% TI) transect, the root mean square error at the lowest
+grid resolution was 0.1167. For the axial velocity at :math:`x^*=5` (15%
+TI) transect, the root mean square error at the lowest grid resolution
+was 0.06263.
 
 Grid Convergence Studies
 ------------------------
@@ -41,7 +45,8 @@ fine-grid GCI of 1.0% is 0.2808m.
    ============== ======= ================ ===========
 
 .. figure:: u_infty_convergence.png
-   :alt: Free stream velocity error against value at zero grid resolution per grid resolution
+   :alt: Free stream velocity error against value at zero grid
+         resolution per grid resolution
    :width: 3.64in
 
    Free stream velocity error against value at zero grid resolution per
@@ -73,7 +78,8 @@ GCI of 1.0% is 0.03873m.
    ============== ======= ================ =========
 
 .. figure:: u_wake_convergence.png
-   :alt: Wake velocity error against value at zero grid resolution per grid resolution
+   :alt: Wake velocity error against value at zero grid resolution per
+         grid resolution
    :width: 3.64in
 
    Wake velocity error against value at zero grid resolution per grid
@@ -93,8 +99,8 @@ This section presents axial velocity transects along the turbine
 centreline and at cross-sections along the :math:`y`-axis. Errors are
 reported relative to the experimental data given in (Mycek et al. 2014).
 
-Centreline velocity
-~~~~~~~~~~~~~~~~~~~
+Centreline velocity (3% TI)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The root mean square error (RMSE) for this transect at the finest grid
 resolution of 0.0625m was 0.1954.
@@ -113,23 +119,66 @@ resolution of 0.0625m was 0.1954.
    ============== ========
 
 .. figure:: transect_u0_0.png
-   :alt: Normalised velocity, :math:`u^*_0`, (m/s) per grid resolution comparison. Experimental data reverse engineered from (Mycek et al. 2014, fig. 11a).
+   :alt: Normalised velocity, :math:`u^*_0`, (m/s) per grid resolution
+         comparison. Experimental data reverse engineered from (Mycek et al.
+         2014, fig. 11a).
    :width: 5.68in
 
    Normalised velocity, :math:`u^*_0`, (m/s) per grid resolution
    comparison. Experimental data reverse engineered from (Mycek et al.
    2014, fig. 11a).
 
 .. figure:: transect_gamma0_0.png
-   :alt: Normalised velocity deficit, :math:`\gamma_0`, (%) per grid resolution comparison. Experimental data reverse engineered from (Mycek et al. 2014, fig. 11a).
+   :alt: Normalised velocity deficit, :math:`\gamma_0`, (%) per grid
+         resolution comparison. Experimental data reverse engineered from
+         (Mycek et al. 2014, fig. 11a).
    :width: 5.68in
 
    Normalised velocity deficit, :math:`\gamma_0`, (%) per grid
    resolution comparison. Experimental data reverse engineered from
    (Mycek et al. 2014, fig. 11a).
 
-Axial velocity at :math:`x^*=5`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Centreline velocity (15% TI)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The root mean square error (RMSE) for this transect at the finest grid
+resolution of 0.0625m was 0.1172.
+
+.. table:: Root mean square error (RMSE) for the normalised velocity,
+           :math:`u^*_0`, per grid resolution.
+
+   ============== ========
+   resolution (m) RMSE
+   ============== ========
+   1              0.212807
+   0.5            0.149742
+   0.25           0.106792
+   0.125          0.10218
+   0.0625         0.117195
+   ============== ========
+
+.. figure:: transect_u0_1.png
+   :alt: Normalised velocity, :math:`u^*_0`, (m/s) per grid resolution
+         comparison. Experimental data reverse engineered from (Mycek et al.
+         2014, fig. 11b).
+   :width: 5.68in
+
+   Normalised velocity, :math:`u^*_0`, (m/s) per grid resolution
+   comparison. Experimental data reverse engineered from (Mycek et al.
+   2014, fig. 11b).
+
+.. figure:: transect_gamma0_1.png
+   :alt: Normalised velocity deficit, :math:`\gamma_0`, (%) per grid
+         resolution comparison. Experimental data reverse engineered from
+         (Mycek et al. 2014, fig. 11b).
+   :width: 5.68in
+
+   Normalised velocity deficit, :math:`\gamma_0`, (%) per grid
+   resolution comparison. Experimental data reverse engineered from
+   (Mycek et al. 2014, fig. 11b).
+
+Axial velocity at :math:`x^*=5` (3% TI)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The root mean square error (RMSE) for this transect at the finest grid
 resolution of 0.0625m was 0.1167.
@@ -147,16 +196,59 @@ resolution of 0.0625m was 0.1167.
    0.0625         0.116704
    ============== ========
 
-.. figure:: transect_u0_1.png
-   :alt: Normalised velocity, :math:`u^*_0`, (m/s) per grid resolution comparison. Experimental data reverse engineered from (Mycek et al. 2014, fig. A12a).
+.. figure:: transect_u0_2.png
+   :alt: Normalised velocity, :math:`u^*_0`, (m/s) per grid resolution
+         comparison. Experimental data reverse engineered from (Mycek et al.
+         2014, fig. A12a).
    :width: 5.68in
 
    Normalised velocity, :math:`u^*_0`, (m/s) per grid resolution
    comparison. Experimental data reverse engineered from (Mycek et al.
    2014, fig. A12a).
 
-.. figure:: transect_gamma0_1.png
-   :alt: Normalised velocity deficit, :math:`\gamma_0`, (%) per grid resolution comparison. Experimental data reverse engineered from (Mycek et al. 2014, fig. A12a).
+.. figure:: transect_gamma0_2.png
+   :alt: Normalised velocity deficit, :math:`\gamma_0`, (%) per grid
+         resolution comparison. Experimental data reverse engineered from
+         (Mycek et al. 2014, fig. A12a).
+   :width: 5.68in
+
+   Normalised velocity deficit, :math:`\gamma_0`, (%) per grid
+   resolution comparison. Experimental data reverse engineered from
+   (Mycek et al. 2014, fig. A12a).
+
+Axial velocity at :math:`x^*=5` (15% TI)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The root mean square error (RMSE) for this transect at the finest grid
+resolution of 0.0625m was 0.06263.
+
+.. table:: Root mean square error (RMSE) for the normalised velocity,
+           :math:`u^*_0`, per grid resolution.
+
+   ============== =========
+   resolution (m) RMSE
+   ============== =========
+   1              0.0609747
+   0.5            0.0330307
+   0.25           0.0432415
+   0.125          0.053325
+   0.0625         0.0626312
+   ============== =========
+
+.. figure:: transect_u0_3.png
+   :alt: Normalised velocity, :math:`u^*_0`, (m/s) per grid resolution
+         comparison. Experimental data reverse engineered from (Mycek et al.
+         2014, fig. A12a).
+   :width: 5.68in
+
+   Normalised velocity, :math:`u^*_0`, (m/s) per grid resolution
+   comparison. Experimental data reverse engineered from (Mycek et al.
+   2014, fig. A12a).
+
+.. figure:: transect_gamma0_3.png
+   :alt: Normalised velocity deficit, :math:`\gamma_0`, (%) per grid
+         resolution comparison. Experimental data reverse engineered from
+         (Mycek et al. 2014, fig. A12a).
    :width: 5.68in
 
    Normalised velocity deficit, :math:`\gamma_0`, (%) per grid

diff --git a/docs/validation/fm/linux/transect_gamma0_0.png b/docs/validation/fm/linux/transect_gamma0_0.png
diff --git a/docs/validation/fm/linux/transect_gamma0_1.png b/docs/validation/fm/linux/transect_gamma0_1.png
diff --git a/docs/validation/fm/linux/transect_gamma0_2.png b/docs/validation/fm/linux/transect_gamma0_2.png
diff --git a/docs/validation/fm/linux/transect_gamma0_3.png b/docs/validation/fm/linux/transect_gamma0_3.png
diff --git a/docs/validation/fm/linux/transect_u0_0.png b/docs/validation/fm/linux/transect_u0_0.png
diff --git a/docs/validation/fm/linux/transect_u0_1.png b/docs/validation/fm/linux/transect_u0_1.png
diff --git a/docs/validation/fm/linux/transect_u0_2.png b/docs/validation/fm/linux/transect_u0_2.png
diff --git a/docs/validation/fm/linux/transect_u0_3.png b/docs/validation/fm/linux/transect_u0_3.png
diff --git a/docs/validation/fm/linux/u_infty_convergence.png b/docs/validation/fm/linux/u_infty_convergence.png
diff --git a/docs/validation/fm/linux/u_wake_convergence.png b/docs/validation/fm/linux/u_wake_convergence.png