PySDM 2.104__tar.gz → 2.105__tar.gz

{pysdm-2.104 → pysdm-2.105}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PySDM
-Version: 2.104
+Version: 2.105
 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.104 → pysdm-2.105}/PySDM/dynamics/freezing.py

@@ -2,10 +2,6 @@
 immersion freezing using either singular or time-dependent formulation
 """
 
-from PySDM.backends.impl_common.freezing_attributes import (
-    SingularAttributes,
-    TimeDependentAttributes,
-)
 from PySDM.physics.heterogeneous_ice_nucleation_rate import Null
 from PySDM.dynamics.impl import register_dynamic
 
@@ -25,7 +21,9 @@ class Freezing:
     def register(self, builder):
         self.particulator = builder.particulator
 
-        assert builder.formulae.particle_shape_and_density.supports_mixed_phase()
+        assert (
+            self.particulator.formulae.particle_shape_and_density.supports_mixed_phase()
+        )
 
         builder.request_attribute("signed water mass")
         if self.singular or self.record_freezing_temperature:
@@ -33,14 +31,14 @@ class Freezing:
 
         if not self.singular:
             assert not isinstance(
-                builder.formulae.heterogeneous_ice_nucleation_rate, Null
+                self.particulator.formulae.heterogeneous_ice_nucleation_rate, Null
             )
             builder.request_attribute("immersed surface area")
             self.rand = self.particulator.Storage.empty(
                 self.particulator.n_sd, dtype=float
             )
             self.rng = self.particulator.Random(
-                self.particulator.n_sd, self.particulator.backend.formulae.seed
+                self.particulator.n_sd, self.particulator.formulae.seed
             )
 
     def __call__(self):
@@ -54,39 +52,12 @@ class Freezing:
             return
 
         if self.singular:
-            self.particulator.backend.freeze_singular(
-                attributes=SingularAttributes(
-                    freezing_temperature=self.particulator.attributes[
-                        "freezing temperature"
-                    ],
-                    signed_water_mass=self.particulator.attributes["signed water mass"],
-                ),
-                temperature=self.particulator.environment["T"],
-                relative_humidity=self.particulator.environment["RH"],
-                cell=self.particulator.attributes["cell id"],
-                thaw=self.thaw,
-            )
+            self.particulator.immersion_freezing_singular(thaw=self.thaw)
         else:
             self.rand.urand(self.rng)
-            self.particulator.backend.freeze_time_dependent(
+            self.particulator.immersion_freezing_time_dependent(
                 rand=self.rand,
-                attributes=TimeDependentAttributes(
-                    immersed_surface_area=self.particulator.attributes[
-                        "immersed surface area"
-                    ],
-                    signed_water_mass=self.particulator.attributes["signed water mass"],
-                ),
-                timestep=self.particulator.dt,
-                cell=self.particulator.attributes["cell id"],
-                a_w_ice=self.particulator.environment["a_w_ice"],
-                temperature=self.particulator.environment["T"],
-                relative_humidity=self.particulator.environment["RH"],
                 record_freezing_temperature=self.record_freezing_temperature,
-                freezing_temperature=(
-                    self.particulator.attributes["freezing temperature"]
-                    if self.record_freezing_temperature
-                    else None
-                ),
                 thaw=self.thaw,
             )
 

{pysdm-2.104 → pysdm-2.105}/PySDM/particulator.py

@@ -5,6 +5,10 @@ The very class exposing `PySDM.particulator.Particulator.run()` method for launc
 import numpy as np
 
 from PySDM.backends.impl_common.backend_methods import BackendMethods
+from PySDM.backends.impl_common.freezing_attributes import (
+    SingularAttributes,
+    TimeDependentAttributes,
+)
 from PySDM.backends.impl_common.index import make_Index
 from PySDM.backends.impl_common.indexed_storage import make_IndexedStorage
 from PySDM.backends.impl_common.pair_indicator import make_PairIndicator
@@ -479,3 +483,38 @@ class Particulator:  # pylint: disable=too-many-public-methods,too-many-instance
         self.attributes.mark_updated("multiplicity")
         for key in self.attributes.get_extensive_attribute_keys():
             self.attributes.mark_updated(key)
+
+    def immersion_freezing_time_dependent(
+        self, *, thaw: bool, record_freezing_temperature: bool, rand: Storage
+    ):
+        self.backend.freeze_time_dependent(
+            rand=rand,
+            attributes=TimeDependentAttributes(
+                immersed_surface_area=self.attributes["immersed surface area"],
+                signed_water_mass=self.attributes["signed water mass"],
+            ),
+            timestep=self.dt,
+            cell=self.attributes["cell id"],
+            a_w_ice=self.environment["a_w_ice"],
+            temperature=self.environment["T"],
+            relative_humidity=self.environment["RH"],
+            record_freezing_temperature=record_freezing_temperature,
+            freezing_temperature=(
+                self.attributes["freezing temperature"]
+                if record_freezing_temperature
+                else None
+            ),
+            thaw=thaw,
+        )
+
+    def immersion_freezing_singular(self, *, thaw: bool):
+        self.backend.freeze_singular(
+            attributes=SingularAttributes(
+                freezing_temperature=self.attributes["freezing temperature"],
+                signed_water_mass=self.attributes["signed water mass"],
+            ),
+            temperature=self.environment["T"],
+            relative_humidity=self.environment["RH"],
+            cell=self.attributes["cell id"],
+            thaw=thaw,
+        )

{pysdm-2.104 → pysdm-2.105}/PySDM.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PySDM
-Version: 2.104
+Version: 2.105
 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.104 → pysdm-2.105}/PySDM.egg-info/SOURCES.txt

@@ -624,6 +624,8 @@ examples/PySDM_examples/Yang_et_al_2018/__init__.py
 examples/PySDM_examples/Yang_et_al_2018/fig_2.ipynb
 examples/PySDM_examples/Yang_et_al_2018/settings.py
 examples/PySDM_examples/Yang_et_al_2018/simulation.py
+examples/PySDM_examples/Zaba_et_al_2025/__init__.py
+examples/PySDM_examples/Zaba_et_al_2025/global_meteoric_water_line.ipynb
 examples/PySDM_examples/_HOWTOs/__init__.py
 examples/PySDM_examples/_HOWTOs/dimensional_analysis.ipynb
 examples/PySDM_examples/_HOWTOs/paraview_hello_world.ipynb
@@ -728,6 +730,8 @@ tests/smoke_tests/no_env/pierchala_et_al_2022/test_fig_4.py
 tests/smoke_tests/no_env/pierchala_et_al_2022/test_supplement.py
 tests/smoke_tests/no_env/toon_et_al_1980/__init__.py
 tests/smoke_tests/no_env/toon_et_al_1980/test_fig_1.py
+tests/smoke_tests/no_env/zaba_et_al_2025/__init__.py
+tests/smoke_tests/no_env/zaba_et_al_2025/test_global_meteoric_water_line.py
 tests/smoke_tests/parcel_a/lowe_et_al_2019/__init__.py
 tests/smoke_tests/parcel_a/lowe_et_al_2019/conftest.py
 tests/smoke_tests/parcel_a/lowe_et_al_2019/test_dz_sensitivity.py
@@ -808,7 +812,6 @@ tests/unit_tests/backends/__init__.py
 tests/unit_tests/backends/test_collisions_methods.py
 tests/unit_tests/backends/test_ctor_defaults.py
 tests/unit_tests/backends/test_fake_thrust.py
-tests/unit_tests/backends/test_freezing_methods.py
 tests/unit_tests/backends/test_isotope_methods.py
 tests/unit_tests/backends/test_moments_methods.py
 tests/unit_tests/backends/test_oxidation.py
@@ -822,6 +825,7 @@ tests/unit_tests/backends/storage/test_index.py
 tests/unit_tests/backends/storage/test_setitem.py
 tests/unit_tests/dynamics/__init__.py
 tests/unit_tests/dynamics/test_eulerian_advection.py
+tests/unit_tests/dynamics/test_immersion_freezing.py
 tests/unit_tests/dynamics/test_impl_register_dynamic.py
 tests/unit_tests/dynamics/test_isotopic_fractionation.py
 tests/unit_tests/dynamics/test_relaxed_velocity.py

{pysdm-2.104 → pysdm-2.105}/docs/bibliography.json

@@ -627,6 +627,7 @@
   },
   "https://doi.org/10.1126/science.133.3465.1702": {
     "usages": [
+      "examples/PySDM_examples/Zaba_et_al_2025/global_meteoric_water_line.ipynb",
       "tests/unit_tests/physics/test_isotope_meteoric_water_line.py",
       "PySDM/physics/constants_defaults.py"
     ],
@@ -766,7 +767,8 @@
   },
   "https://doi.org/10.1016/B978-0-444-42225-5.50008-5": {
     "usages": [
-      "examples/PySDM_examples/Gonfiantini_1986/fig_3_1.ipynb"
+      "examples/PySDM_examples/Gonfiantini_1986/fig_3_1.ipynb",
+      "examples/PySDM_examples/Gonfiantini_1986/__init__.py"
     ],
     "title": "Environmental isotopes in lake stadies",
     "label": "Gonfiantini 1986 (The Terrestrial Environment, B)"

pysdm-2.105/examples/PySDM_examples/Gonfiantini_1986/__init__.py

@@ -0,0 +1,9 @@
+# pylint: disable=invalid-name
+"""
+Formulae-only example depicting Rayleigh fractionation from a flat surface of water
+ at different humidities for Oxygen-18 and Deuterium, based on
+[Gonfiantini 1986](https://doi.org/10.1016/B978-0-444-42225-5.50008-5)
+
+fig_3_1.ipynb:
+.. include:: ./fig_3_1.ipynb.badges.md
+"""