PySDM 2.112__tar.gz → 2.114__tar.gz

{pysdm-2.112/pysdm.egg-info → pysdm-2.114}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pysdm
-Version: 2.112
+Version: 2.114
 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.114/PySDM/attributes/ice/freezing_temperature.py

@@ -0,0 +1,42 @@
+"""
+particle freezing temperature
+"""
+
+from PySDM.attributes.impl import MaximumAttribute, register_attribute
+from ..impl import DerivedAttribute
+
+
+@register_attribute()
+class FreezingTemperature(MaximumAttribute):
+    """singular variant: assigned at initialisation, modified through collisions only"""
+
+    def __init__(self, builder):
+        super().__init__(builder, name="freezing temperature")
+
+
+@register_attribute()
+class TemperatureOfLastFreezing(DerivedAttribute):
+    """time-dependent variant: assigned upon freezing"""
+
+    def __init__(self, builder):
+        assert "Freezing" in builder.particulator.dynamics
+        assert not builder.particulator.dynamics["Freezing"].singular
+        self.signed_water_mass = builder.get_attribute("signed water mass")
+        self.cell_id = builder.get_attribute("cell id")
+        super().__init__(
+            builder,
+            name="temperature of last freezing",
+            dependencies=(self.signed_water_mass, self.cell_id),
+        )
+        builder.particulator.observers.append(self)
+
+    def notify(self):
+        self.update()
+
+    def recalculate(self):
+        self.particulator.backend.record_freezing_temperatures(
+            data=self.data,
+            cell_id=self.cell_id.data,
+            temperature=self.particulator.environment["T"],
+            signed_water_mass=self.signed_water_mass.data,
+        )

{pysdm-2.112 → pysdm-2.114}/PySDM/backends/impl_numba/methods/freezing_methods.py

@@ -2,7 +2,10 @@
 CPU implementation of backend methods for freezing (singular and time-dependent immersion freezing)
 """
 
+from functools import cached_property
+
 import numba
+import numpy as np
 
 from PySDM.backends.impl_common.backend_methods import BackendMethods
 
@@ -56,7 +59,7 @@ class FreezingMethods(BackendMethods):
         prob_zero_events = self.formulae.trivia.poissonian_avoidance_function
 
         @numba.njit(**self.default_jit_flags)
-        def freeze_time_dependent_body(  # pylint: disable=unused-argument,too-many-arguments
+        def freeze_time_dependent_body(  # pylint: disable=too-many-arguments
             rand,
             attributes,
             timestep,
@@ -64,8 +67,6 @@ class FreezingMethods(BackendMethods):
             a_w_ice,
             temperature,
             relative_humidity,
-            record_freezing_temperature,
-            freezing_temperature,
             thaw,
         ):
             n_sd = len(attributes.signed_water_mass)
@@ -88,8 +89,6 @@ class FreezingMethods(BackendMethods):
                     )
                     if rand[i] < prob:
                         _freeze(attributes.signed_water_mass, i)
-                        # if record_freezing_temperature:
-                        #     freezing_temperature[i] = temperature[cell_id]
 
         self.freeze_time_dependent_body = freeze_time_dependent_body
 
@@ -117,8 +116,6 @@ class FreezingMethods(BackendMethods):
         a_w_ice,
         temperature,
         relative_humidity,
-        record_freezing_temperature,
-        freezing_temperature,
         thaw: bool
     ):
         self.freeze_time_dependent_body(
@@ -132,9 +129,31 @@ class FreezingMethods(BackendMethods):
             a_w_ice.data,
             temperature.data,
             relative_humidity.data,
-            record_freezing_temperature=record_freezing_temperature,
-            freezing_temperature=(
-                freezing_temperature.data if record_freezing_temperature else None
-            ),
             thaw=thaw,
         )
+
+    @cached_property
+    def _record_freezing_temperatures_body(self):
+        ff = self.formulae_flattened
+
+        @numba.njit(**{**self.default_jit_flags, "fastmath": False})
+        def body(data, cell_id, temperature, signed_water_mass):
+            for drop_id in numba.prange(len(data)):  # pylint: disable=not-an-iterable
+                if ff.trivia__unfrozen(signed_water_mass[drop_id]):
+                    if data[drop_id] > 0:
+                        data[drop_id] = np.nan
+                else:
+                    if np.isnan(data[drop_id]):
+                        data[drop_id] = temperature[cell_id[drop_id]]
+
+        return body
+
+    def record_freezing_temperatures(
+        self, *, data, cell_id, temperature, signed_water_mass
+    ):
+        self._record_freezing_temperatures_body(
+            data=data.data,
+            cell_id=cell_id.data,
+            temperature=temperature.data,
+            signed_water_mass=signed_water_mass.data,
+        )

{pysdm-2.112 → pysdm-2.114}/PySDM/backends/impl_thrust_rtc/methods/freezing_methods.py

@@ -118,8 +118,6 @@ class FreezingMethods(ThrustRTCBackendMethods):
         a_w_ice,
         temperature,
         relative_humidity,
-        record_freezing_temperature,
-        freezing_temperature,
         thaw,
     ):
         n_sd = len(attributes.immersed_surface_area)

{pysdm-2.112 → pysdm-2.114}/PySDM/dynamics/freezing.py

@@ -2,16 +2,13 @@
 immersion freezing using either singular or time-dependent formulation
 """
 
-from PySDM.physics.heterogeneous_ice_nucleation_rate import Null
 from PySDM.dynamics.impl import register_dynamic
 
 
 @register_dynamic()
 class Freezing:
-    def __init__(self, *, singular=True, record_freezing_temperature=False, thaw=False):
-        assert not (record_freezing_temperature and singular)
+    def __init__(self, *, singular=True, thaw=False):
         self.singular = singular
-        self.record_freezing_temperature = record_freezing_temperature
         self.thaw = thaw
         self.enable = True
         self.rand = None
@@ -26,12 +23,13 @@ class Freezing:
         )
 
         builder.request_attribute("signed water mass")
-        if self.singular or self.record_freezing_temperature:
+        if self.singular:
             builder.request_attribute("freezing temperature")
 
         if not self.singular:
-            assert not isinstance(
-                self.particulator.formulae.heterogeneous_ice_nucleation_rate, Null
+            assert (
+                self.particulator.formulae.heterogeneous_ice_nucleation_rate.__name__
+                != "Null"
             )
             builder.request_attribute("immersed surface area")
             self.rand = self.particulator.Storage.empty(
@@ -57,10 +55,5 @@ class Freezing:
             self.rand.urand(self.rng)
             self.particulator.immersion_freezing_time_dependent(
                 rand=self.rand,
-                record_freezing_temperature=self.record_freezing_temperature,
                 thaw=self.thaw,
             )
-
-        self.particulator.attributes.mark_updated("signed water mass")
-        if self.record_freezing_temperature:
-            self.particulator.attributes.mark_updated("freezing temperature")

{pysdm-2.112 → pysdm-2.114}/PySDM/particulator.py

@@ -509,9 +509,7 @@ class Particulator:  # pylint: disable=too-many-public-methods,too-many-instance
         # TODO #1524 - should we update here?
         # self.update_TpRH(only_if_not_last='VapourDepositionOnIce')
 
-    def immersion_freezing_time_dependent(
-        self, *, thaw: bool, record_freezing_temperature: bool, rand: Storage
-    ):
+    def immersion_freezing_time_dependent(self, *, thaw: bool, rand: Storage):
         self.backend.freeze_time_dependent(
             rand=rand,
             attributes=TimeDependentAttributes(
@@ -523,14 +521,9 @@ class Particulator:  # pylint: disable=too-many-public-methods,too-many-instance
             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,
         )
+        self.attributes.mark_updated("signed water mass")
 
     def immersion_freezing_singular(self, *, thaw: bool):
         self.backend.freeze_singular(
@@ -543,3 +536,4 @@ class Particulator:  # pylint: disable=too-many-public-methods,too-many-instance
             cell=self.attributes["cell id"],
             thaw=thaw,
         )
+        self.attributes.mark_updated("signed water mass")

{pysdm-2.112 → pysdm-2.114}/docs/bibliography.json

@@ -574,7 +574,9 @@
   "https://doi.org/10.1029/JC080i009p01133": {
     "usages": [
       "PySDM/physics/isotope_diffusivity_ratios/stewart_1975.py",
-      "PySDM/physics/isotope_kinetic_fractionation_factors/jouzel_and_merlivat_1984.py"
+      "PySDM/physics/isotope_kinetic_fractionation_factors/jouzel_and_merlivat_1984.py",
+      "examples/PySDM_examples/Stewart_1975/__init__.py",
+      "examples/PySDM_examples/Stewart_1975/fig_1.ipynb"
     ],
     "label": "Stewart 1975 (J. Geophys. Res. Oceans 80)",
     "title": "Stable isotope fractionation due to evaporation and isotopic exchange of falling waterdrops: Applications to atmospheric processes and evaporation of lakes"
@@ -790,9 +792,27 @@
       "examples/PySDM_examples/Gonfiantini_1986/fig_3_1.ipynb",
       "examples/PySDM_examples/Gonfiantini_1986/__init__.py"
     ],
-    "title": "Environmental isotopes in lake stadies",
+    "title": "Environmental isotopes in lake studies",
     "label": "Gonfiantini 1986 (The Terrestrial Environment, B)"
   },
+  "https://doi.org/10.1029/JC080i009p01133": {
+    "usages": [
+      "PySDM/physics/isotope_diffusivity_ratios/stewart_1975.py",
+      "PySDM/physics/isotope_kinetic_fractionation_factors/jouzel_and_merlivat_1984.py",
+      "examples/PySDM_examples/Stewart_1975/__init__.py",
+      "examples/PySDM_examples/Stewart_1975/fig_1.ipynb"
+    ],
+    "title": "Stable Isotope Fractionation Due to Evaporation and Isotopic Exchange of Falling Waterdrops: Applications to Atmospheric Processes and Evaporation of Lakes",
+    "label": "Stewart 1975 (J. Geophys. Res.)"
+  },
+  "https://doi.org/10.1175/1520-0469(1951)008%3C0071:TETATR%3E2.0.CO;2": {
+    "usages": [
+      "examples/PySDM_examples/Kinzer_And_Gunn_1951/table_1_and_2.py",
+      "examples/PySDM_examples/Kinzer_And_Gunn_1951/__init__.py"
+    ],
+    "title": "The Evaporation, Temperature and Thermal Relaxation-Time of Freely Falling Waterdrops",
+    "label": "Kinzer & Gunn 1951 (J. Meteor.)"
+  },
   "https://doi.org/10.1029/2001JD000470": {
     "usages": [
       "PySDM/physics/constants_defaults.py"