add new example for ventilation factors (Pruppacher and Rasmussen 1979) --- from #1494 (#1573)

Co-authored-by: Sylwester Arabas <[email protected]>

Author: AgnieszkaZaba

PySDM/physics/constants_defaults.py

@@ -518,8 +518,8 @@
 
 PRUPPACHER_RASMUSSEN_1979_XTHRES = 1.4 * si.dimensionless
 """
-[Pruppacher & Rasmussen 1979](https://doi.org/10.1175/1520-0469(1979)036%3C1255:AWTIOT%3E2.0.CO;2)
-"""
+[Pruppacher & Rasmussen 1979](https://doi.org/10.1175/1520-0469%281979%29036%3C1255:AWTIOT%3E2.0.CO;2)
+"""  # pylint: disable=line-too-long
 PRUPPACHER_RASMUSSEN_1979_CONSTSMALL = 1.0 * si.dimensionless
 """ 〃 """
 PRUPPACHER_RASMUSSEN_1979_COEFFSMALL = 0.108 * si.dimensionless

PySDM/physics/ventilation/pruppacher_rasmussen_1979.py

@@ -1,12 +1,12 @@
 """
 ventilation coefficient as a function of dimensionless Reynolds (Re) and Schmidt (Sc)
 numbers for liquid drops following
-[Pruppacher & Rasmussen (1979)](https://doi.org/10.1175/1520-0469(1979)036%3C1255:AWTIOT%3E2.0.CO;2)
+[Pruppacher & Rasmussen 1979](https://doi.org/10.1175/1520-0469%281979%29036%3C1255:AWTIOT%3E2.0.CO;2)
 NB: this parameterization is only experimentally validated for Re < 2600
 but is hypothesized to be valid for spheres with Re < 8 × 10⁴
 based on theory (Pruppacher & Rasmussen, 1979).
 the parameterization also does not account for effects of air turbulence.
-"""
+"""  # pylint: disable=line-too-long
 
 import numpy as np
 

docs/bibliography.json

@@ -626,10 +626,13 @@
     "label": "Bartman et al. 2022 (J. Open Source Soft. 7)",
     "title": "PySDM v1: particle-based cloud modeling package for warm-rain microphysics and aqueous chemistry"
   },
-  "https://doi.org/10.1175/1520-0469(1979)036%3C1255:AWTIOT%3E2.0.CO;2": {
+  "https://doi.org/10.1175/1520-0469%281979%29036%3C1255:AWTIOT%3E2.0.CO;2": {
     "usages": [
       "PySDM/physics/constants_defaults.py",
-      "PySDM/physics/ventilation/pruppacher_rasmussen_1979.py"
+      "PySDM/physics/ventilation/pruppacher_rasmussen_1979.py",
+      "examples/PySDM_examples/Pruppacher_and_Rasmussen_1979/fig_1.ipynb",
+      "examples/PySDM_examples/Pruppacher_and_Rasmussen_1979/__init__.py",
+      "tests/smoke_tests/no_env/pruppacher_and_rasmussen_1979/test_fig_1.py"
     ],
     "label": "Pruppacher & Rasmussen 1979 (J. Atmos. Sci. 36)",
     "title": "A Wind Tunnel Investigation of the Rate of Evaporation of Large Water Drops Falling at Terminal Velocity in Air"

examples/PySDM_examples/Pruppacher_and_Rasmussen_1979/__init__.py

@@ -0,0 +1,10 @@
+"""
+based on Pruppacher and Rasmussen 1979 (J. Atmos. Sci.)
+https://doi.org/10.1175/1520-0469%281979%29036%3C1255:AWTIOT%3E2.0.CO;2
+
+fig_1.ipynb:
+.. include:: ./fig_1.ipynb.badges.md
+
+"""
+
+# pylint: disable=invalid-name

examples/PySDM_examples/Pruppacher_and_Rasmussen_1979/fig_1.ipynb

@@ -39,6 +39,7 @@ def findfiles(path, regex):
         "Bolin_1958",
         "Stewart_1975",
         "Kinzer_And_Gunn_1951",
+        "Pruppacher_and_Rasmussen_1979",
     ],
     "condensation_a": [
         "Lowe_et_al_2019",

tests/examples_tests/conftest.py

@@ -0,0 +1,51 @@
+"""
+regression tests checking values against paper Fig 1 from [Pruppacher and Rasmussen
+1979](https://doi.org/10.1175/1520-0469%281979%29036%3C1255:AWTIOT%3E2.0.CO;2)
+"""
+
+from pathlib import Path
+
+import numpy as np
+import pytest
+
+from open_atmos_jupyter_utils import notebook_vars
+from PySDM_examples import Pruppacher_and_Rasmussen_1979
+
+PLOT = False
+
+
+@pytest.fixture(scope="session", name="notebook_local_variables")
+def notebook_local_variables_fixture():
+    return notebook_vars(
+        Path(Pruppacher_and_Rasmussen_1979.__file__).parent / "fig_1.ipynb", plot=PLOT
+    )
+
+
+class TestFig1:
+    @staticmethod
+    @pytest.mark.parametrize(
+        "sqrt_re_times_cbrt_sc, vent_coeff",
+        (
+            (3, 1.7),
+            (20, 7),
+            (44, 14),
+        ),
+    )
+    def test_values_match(notebook_local_variables, sqrt_re_times_cbrt_sc, vent_coeff):
+        plot_x = notebook_local_variables["sqrt_re_times_cbrt_sc"]
+        plot_y = notebook_local_variables["vent_coef"]
+        eps = 0.1
+        ((index,),) = np.where(abs(plot_x - sqrt_re_times_cbrt_sc) < eps)
+        np.testing.assert_approx_equal(
+            actual=plot_y[index], desired=vent_coeff, significant=2
+        )
+
+    @staticmethod
+    def test_monotonic_x(notebook_local_variables):
+        plot_x = notebook_local_variables["sqrt_re_times_cbrt_sc"]
+        assert (np.diff(plot_x) > 0).all()
+
+    @staticmethod
+    def test_monotonic_y(notebook_local_variables):
+        plot_y = notebook_local_variables["vent_coef"]
+        assert (np.diff(plot_y) > 0).all()