PySDM 2.52__tar.gz → 2.53__tar.gz

{PySDM-2.52 → PySDM-2.53}/.github/workflows/tests+artifacts+pypi.yml

@@ -58,7 +58,7 @@ jobs:
   pdoc:
     strategy:
       matrix:
-        platform: [ubuntu-latest, macos-latest, windows-latest]
+        platform: [ubuntu-latest, macos-12, windows-latest]
     runs-on: ${{ matrix.platform }}
     steps:
       - uses: actions/checkout@v4.1.1

{PySDM-2.52 → PySDM-2.53}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PySDM
-Version: 2.52
+Version: 2.53
 Summary: Pythonic particle-based (super-droplet) warm-rain/aqueous-chemistry cloud microphysics package with box, parcel & 1D/2D prescribed-flow examples in Python, Julia and Matlab
 Home-page: https://github.com/open-atmos/PySDM
 Author: https://github.com/open-atmos/PySDM/graphs/contributors

{PySDM-2.52 → PySDM-2.53}/PySDM/formulae.py

@@ -34,7 +34,7 @@ class Formulae:  # pylint: disable=too-few-public-methods,too-many-instance-attr
         saturation_vapour_pressure: str = "FlatauWalkoCotton",
         latent_heat: str = "Kirchhoff",
         hygroscopicity: str = "KappaKoehlerLeadingTerms",
-        drop_growth: str = "MaxwellMason",
+        drop_growth: str = "Mason1971",
         surface_tension: str = "Constant",
         diffusion_kinetics: str = "FuchsSutugin",
         diffusion_thermics: str = "Neglect",

{PySDM-2.52 → PySDM-2.53}/PySDM/initialisation/spectra/lognormal.py

@@ -12,6 +12,9 @@ from PySDM.initialisation.impl.spectrum import Spectrum
 
 class Lognormal(Spectrum):
     def __init__(self, norm_factor: float, m_mode: float, s_geom: float):
+        """`norm_factor=1` corresponds to standard normalised probability density,
+        other settings allow to express, e.g., size or mass distributions;
+        `m_mode` is the median value, `s_geom` is the geometric standard deviation"""
         super().__init__(lognorm, (math.log(s_geom), 0, m_mode), norm_factor)
 
     @property

{PySDM-2.52 → PySDM-2.53}/PySDM/physics/drop_growth/__init__.py

@@ -2,4 +2,5 @@
 Formulation of the coupled heat-moisture diffusion problem
 """
 
-from .maxwell_mason import MaxwellMason
+from .mason_1951 import Mason1951
+from .mason_1971 import Mason1971

PySDM-2.53/PySDM/physics/drop_growth/mason_1951.py

@@ -0,0 +1,23 @@
+"""
+single-equation approximation of the vapour and heat diffusion problem
+as derived in [Mason 1951](https://doi.org/10.1088/0370-1301/64/9/307)
+(note that Mason's work did not include the ventilation factor, it
+is included here for code maintainability - to reduce duplication at the
+calling scopes; it is not ignored and is used as a multiplicative factor
+in the same way as in `PySDM.physics.drop_growth.mason_1971.Mason1971`)
+"""
+
+
+class Mason1951:  # pylint: disable=too-few-public-methods
+    def __init__(self, _):
+        pass
+
+    # pylint: disable=too-many-arguments
+    @staticmethod
+    def r_dr_dt(const, RH_eq, T, RH, lv, pvs, D, K, ventilation_factor):
+        return (
+            ventilation_factor
+            * (RH - RH_eq)
+            / const.rho_w
+            / (const.Rv * T / D / pvs + lv**2 / K / T**2 / const.Rv)
+        )

PySDM-2.52/PySDM/physics/drop_growth/maxwell_mason.py → PySDM-2.53/PySDM/physics/drop_growth/mason_1971.py

@@ -1,9 +1,11 @@
 """
 single-equation approximation of the vapour and heat diffusion problem
+as given in eq. 3.11 in [Mason 1971](https://archive.org/details/physicsofclouds0000maso)
+(see also discussion of the ventilation effect on page 125)
 """
 
 
-class MaxwellMason:  # pylint: disable=too-few-public-methods
+class Mason1971:  # pylint: disable=too-few-public-methods
     def __init__(self, _):
         pass
 
@@ -13,8 +15,6 @@ class MaxwellMason:  # pylint: disable=too-few-public-methods
         return (
             ventilation_factor
             * (RH - RH_eq)
-            / (
-                const.rho_w * const.Rv * T / D / pvs
-                + const.rho_w * lv / K / T * (lv / const.Rv / T - 1)
-            )
+            / const.rho_w
+            / (const.Rv * T / D / pvs + lv / K / T * (lv / T / const.Rv - 1))
         )

{PySDM-2.52 → PySDM-2.53}/PySDM.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PySDM
-Version: 2.52
+Version: 2.53
 Summary: Pythonic particle-based (super-droplet) warm-rain/aqueous-chemistry cloud microphysics package with box, parcel & 1D/2D prescribed-flow examples in Python, Julia and Matlab
 Home-page: https://github.com/open-atmos/PySDM
 Author: https://github.com/open-atmos/PySDM/graphs/contributors

{PySDM-2.52 → PySDM-2.53}/PySDM.egg-info/SOURCES.txt

@@ -239,7 +239,8 @@ PySDM/physics/diffusion_thermics/neglect.py
 PySDM/physics/diffusion_thermics/seinfeld_and_pandis_2010.py
 PySDM/physics/diffusion_thermics/tracy_welch_porter.py
 PySDM/physics/drop_growth/__init__.py
-PySDM/physics/drop_growth/maxwell_mason.py
+PySDM/physics/drop_growth/mason_1951.py
+PySDM/physics/drop_growth/mason_1971.py
 PySDM/physics/fragmentation_function/__init__.py
 PySDM/physics/fragmentation_function/always_n.py
 PySDM/physics/fragmentation_function/constant_mass.py
@@ -773,6 +774,7 @@ tests/unit_tests/initialisation/test_aerosol_init.py
 tests/unit_tests/initialisation/test_equilibrate_wet_radii.py
 tests/unit_tests/initialisation/test_init_fall_momenta.py
 tests/unit_tests/initialisation/test_spatial_discretisation.py
+tests/unit_tests/initialisation/test_spectra_lognormal.py
 tests/unit_tests/initialisation/test_spectral_discretisation.py
 tests/unit_tests/initialisation/test_spectro_glacial_discretisation.py
 tests/unit_tests/physics/__init__.py
@@ -780,6 +782,7 @@ tests/unit_tests/physics/test_accommodation_coefficients.py
 tests/unit_tests/physics/test_air_dynamic_viscosity.py
 tests/unit_tests/physics/test_constants.py
 tests/unit_tests/physics/test_dimensional_analysis.py
+tests/unit_tests/physics/test_drop_growth.py
 tests/unit_tests/physics/test_formulae.py
 tests/unit_tests/physics/test_fragmentation_functions.py
 tests/unit_tests/physics/test_freezing_temperature_spectra.py

{PySDM-2.52 → PySDM-2.53}/PySDM.egg-info/requires.txt

@@ -11,7 +11,7 @@ pyevtk
 matplotlib
 pytest
 pytest-timeout
-PyPartMC==1.1.4
+PyPartMC==1.2.0
 pyrcel
 jupyter-core<5.0.0
 ipywidgets!=8.0.3

{PySDM-2.52 → PySDM-2.53}/setup.py

@@ -61,7 +61,7 @@ setup(
             "matplotlib",
             "pytest",
             "pytest-timeout",
-            "PyPartMC==1.1.4",
+            "PyPartMC==1.2.0",
         ]
         + (
             [

PySDM-2.53/tests/unit_tests/initialisation/test_spectra_lognormal.py

@@ -0,0 +1,52 @@
+""" tests for lognormal probability distribution """
+
+import numpy as np
+import pytest
+from PySDM.initialisation.spectra import Lognormal
+
+
+class TestSpectraLognormal:
+    """checks ctor args against computed values"""
+
+    @staticmethod
+    @pytest.mark.parametrize(
+        "m_mode, s_geom",
+        (
+            (0.01, 1.5),
+            (0.1, 1.1),
+            (1, 1.01),
+        ),
+    )
+    def test_median(m_mode, s_geom):
+        # arrange
+        sut = Lognormal(m_mode=m_mode, norm_factor=1, s_geom=s_geom)
+
+        # act
+        median = sut.percentiles(0.5)
+
+        # assert
+        assert median == m_mode
+
+    @staticmethod
+    @pytest.mark.parametrize(
+        "m_mode, s_geom",
+        (
+            (0.01, 3.5),
+            (0.1, 2.1),
+            (1, 1.5),
+        ),
+    )
+    def test_mean(m_mode, s_geom):
+        # arrange
+        sut = Lognormal(m_mode=m_mode, norm_factor=1, s_geom=s_geom)
+        x = np.linspace(m_mode / 1000, m_mode * 1000, num=10000)
+
+        # act
+        mean = np.sum(sut.pdf(x) * x) / np.sum(sut.pdf(x))
+
+        # assert
+        np.testing.assert_approx_equal(
+            actual=np.log(m_mode) + 0.5 * np.log(s_geom) ** 2,
+            desired=np.log(mean),
+            significant=3,
+        )

PySDM-2.53/tests/unit_tests/physics/test_drop_growth.py

@@ -0,0 +1,76 @@
+""" tests for drop growth formulae """
+
+import pytest
+from matplotlib import pyplot
+import numpy as np
+
+from PySDM.formulae import _choices, Formulae
+from PySDM.physics import drop_growth, constants_defaults, si, in_unit
+from PySDM.physics.dimensional_analysis import DimensionalAnalysis
+
+
+class TestDropGrowth:
+    @staticmethod
+    @pytest.mark.parametrize("paper", _choices(drop_growth))
+    def test_unit(paper):
+        """checks dimensionality of the returned value"""
+        with DimensionalAnalysis():
+            # arrange
+            formulae = Formulae(drop_growth=paper)
+
+            # act
+            r_dr_dt = formulae.drop_growth.r_dr_dt(
+                RH_eq=1,
+                T=constants_defaults.T_tri,
+                RH=1.05,
+                lv=constants_defaults.l_tri,
+                pvs=constants_defaults.p_tri,
+                D=constants_defaults.D0,
+                K=constants_defaults.K0,
+                ventilation_factor=1,
+            )
+
+            # assert
+            assert r_dr_dt.check("[area]/[time]")
+
+    @staticmethod
+    def test_mason_1971_vs_1951_difference_vs_temperature(plot=False):
+        """checks the relative difference between Mason's 1951 and 1971 formulae
+        for a range of temperatures"""
+        # arrange
+        temperatures = constants_defaults.T0 + np.linspace(-10, 40) * si.K
+        papers = ("Mason1951", "Mason1971")
+
+        # act
+        formulae = {paper: Formulae(drop_growth=paper) for paper in papers}
+        r_dr_dt = {
+            paper: formulae[paper].drop_growth.r_dr_dt(
+                RH_eq=1,
+                T=temperatures,
+                RH=1.05,
+                lv=constants_defaults.l_tri,
+                pvs=constants_defaults.p_tri,
+                D=constants_defaults.D0,
+                K=constants_defaults.K0,
+                ventilation_factor=1,
+            )
+            for paper in papers
+        }
+        relative_error = r_dr_dt["Mason1971"] / r_dr_dt["Mason1951"] - 1
+
+        # plot
+        pyplot.plot(temperatures, in_unit(relative_error, constants_defaults.PER_CENT))
+        pyplot.title("")
+        pyplot.xlabel("temperature [K]")
+        pyplot.ylabel("r dr/dt relative difference (1971 vs. 1951) [%]")
+        pyplot.grid()
+        pyplot.legend()
+        if plot:
+            pyplot.show()
+        else:
+            pyplot.clf()
+
+        # assert
+        (relative_error < 0.03).all()
+        (relative_error > 0.02).all()
+        (np.diff(relative_error) < 0).all()