PySDM 2.128__tar.gz → 2.130__tar.gz

{pysdm-2.128 → pysdm-2.130}/.github/workflows/tests.yml

@@ -17,6 +17,7 @@ on:
     paths-ignore: ['docs/**', '**.md']
   pull_request:
     branches: [ main ]
+    paths-ignore: ['docs/**', '**.md']
   schedule:
     - cron: '0 13 * * 4'
 

{pysdm-2.128/pysdm.egg-info → pysdm-2.130}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pysdm
-Version: 2.128
+Version: 2.130
 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
 Author-email: "https://github.com/open-atmos/PySDM/graphs/contributors" <sylwester.arabas@agh.edu.pl>
 License-Expression: GPL-3.0-only
@@ -62,7 +62,6 @@ Dynamic: requires-dist
 [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0.html)
 
 [![Github Actions Build Status](https://github.com/open-atmos/PySDM/workflows/tests/badge.svg?branch=main)](https://github.com/open-atmos/PySDM/actions)
-[![Appveyor Build status](http://ci.appveyor.com/api/projects/status/github/open-atmos/PySDM?branch=main&svg=true)](https://ci.appveyor.com/project/slayoo/pysdm/branch/main)
 [![Coverage Status](https://codecov.io/gh/open-atmos/PySDM/branch/main/graph/badge.svg)](https://app.codecov.io/gh/open-atmos/PySDM)    
 [![PyPI version](https://badge.fury.io/py/PySDM.svg)](https://pypi.org/project/PySDM)
 [![API docs](https://shields.mitmproxy.org/badge/docs-pdoc.dev-brightgreen.svg)](https://open-atmos.github.io/PySDM/)

{pysdm-2.128 → pysdm-2.130}/PySDM/attributes/impl/__init__.py

@@ -11,3 +11,4 @@ from .extensive_attribute import ExtensiveAttribute
 from .maximum_attribute import MaximumAttribute
 from .attribute_registry import register_attribute, get_attribute_class
 from .intensive_attribute import IntensiveAttribute
+from .temperature_variation_option_attribute import TemperatureVariationOptionAttribute

pysdm-2.130/PySDM/attributes/impl/temperature_variation_option_attribute.py

@@ -0,0 +1,18 @@
+"""common code for attributes offering an option to neglect temperature variation,
+intended for use with Parcel environment only"""
+
+
+class TemperatureVariationOptionAttribute:  # pylint: disable=too-few-public-methods
+    """base class"""
+
+    def __init__(self, builder, neglect_temperature_variations: bool):
+        if neglect_temperature_variations:
+            assert builder.particulator.environment.mesh.dimension == 0
+        self.neglect_temperature_variations = neglect_temperature_variations
+        self.initial_temperature = (
+            builder.particulator.Storage.from_ndarray(
+                builder.particulator.environment["T"].to_ndarray()
+            )
+            if neglect_temperature_variations
+            else None
+        )

{pysdm-2.128 → pysdm-2.130}/PySDM/attributes/physics/__init__.py

@@ -3,11 +3,11 @@ attributes carrying information on particle physical properties
 """
 
 from .area import Area
-from .critical_supersaturation import CriticalSupersaturation
+from .critical_saturation import CriticalSaturation
 from .critical_volume import CriticalVolume, WetToCriticalVolumeRatio
 from .dry_radius import DryRadius
 from .dry_volume import DryVolume
-from .equilibrium_supersaturation import EquilibriumSupersaturation
+from .equilibrium_saturation import EquilibriumSaturation
 from .heat import Heat
 from .hygroscopicity import Kappa, KappaTimesDryVolume
 from .water_mass import SignedWaterMass

pysdm-2.130/PySDM/attributes/physics/critical_saturation.py

@@ -0,0 +1,54 @@
+"""
+kappa-Koehler critical saturation calculated for either initial or actual environment temperature
+"""
+
+from PySDM.attributes.impl import (
+    DerivedAttribute,
+    register_attribute,
+    TemperatureVariationOptionAttribute,
+)
+
+
+@register_attribute()
+class CriticalSaturation(DerivedAttribute, TemperatureVariationOptionAttribute):
+    def __init__(self, builder, neglect_temperature_variations=False):
+        assert builder.particulator.mesh.dimension == 0
+
+        self.v_crit = builder.get_attribute("critical volume")
+        self.v_dry = builder.get_attribute("dry volume")
+        self.kappa = builder.get_attribute("kappa")
+        self.f_org = builder.get_attribute("dry volume organic fraction")
+        TemperatureVariationOptionAttribute.__init__(
+            self, builder, neglect_temperature_variations
+        )
+        DerivedAttribute.__init__(
+            self,
+            builder=builder,
+            name="critical saturation",
+            dependencies=(self.v_crit, self.kappa, self.v_dry, self.f_org),
+        )
+
+    def recalculate(self):
+        temperature = (
+            self.initial_temperature
+            if self.neglect_temperature_variations
+            else self.particulator.environment["T"]
+        )
+        r_cr = self.formulae.trivia.radius(self.v_crit.data.data)
+        rd3 = self.v_dry.data.data / self.formulae.constants.PI_4_3
+        sgm = self.formulae.surface_tension.sigma(
+            temperature.data,
+            self.v_crit.data.data,
+            self.v_dry.data.data,
+            self.f_org.data.data,
+        )
+
+        self.data.data[:] = self.formulae.hygroscopicity.RH_eq(
+            r_cr, T=temperature.data, kp=self.kappa.data.data, rd3=rd3, sgm=sgm
+        )
+
+
+@register_attribute()
+class CriticalSaturationNeglectingTemperatureVariations(CriticalSaturation):
+    def __init__(self, builder):
+        super().__init__(builder, neglect_temperature_variations=True)

pysdm-2.130/PySDM/attributes/physics/critical_volume.py

@@ -0,0 +1,88 @@
+"""
+critical wet volume (kappa-Koehler, computed using actual or initial temperature)
+"""
+
+from PySDM.attributes.impl import (
+    DerivedAttribute,
+    register_attribute,
+    TemperatureVariationOptionAttribute,
+)
+
+
+@register_attribute()
+class CriticalVolume(DerivedAttribute, TemperatureVariationOptionAttribute):
+    def __init__(self, builder, neglect_temperature_variations=False):
+        self.cell_id = builder.get_attribute("cell id")
+        self.v_dry = builder.get_attribute("dry volume")
+        self.v_wet = builder.get_attribute("volume")
+        self.kappa = builder.get_attribute("kappa")
+        self.f_org = builder.get_attribute("dry volume organic fraction")
+        self.environment = builder.particulator.environment
+        self.particles = builder.particulator
+
+        dependencies = [self.v_dry, self.v_wet, self.cell_id]
+        TemperatureVariationOptionAttribute.__init__(
+            self, builder, neglect_temperature_variations
+        )
+        DerivedAttribute.__init__(
+            self, builder, name="critical volume", dependencies=dependencies
+        )
+
+    def recalculate(self):
+        temperature = (
+            self.initial_temperature
+            if self.neglect_temperature_variations
+            else self.environment["T"]
+        )
+        self.particulator.backend.critical_volume(
+            v_cr=self.data,
+            kappa=self.kappa.get(),
+            f_org=self.f_org.get(),
+            v_dry=self.v_dry.get(),
+            v_wet=self.v_wet.get(),
+            T=temperature,
+            cell=self.cell_id.get(),
+        )
+
+
+@register_attribute()
+class CriticalVolumeNeglectingTemperatureVariations(CriticalVolume):
+    def __init__(self, builder):
+        super().__init__(builder, neglect_temperature_variations=True)
+
+
+@register_attribute()
+class WetToCriticalVolumeRatio(DerivedAttribute):
+    def __init__(
+        self,
+        builder,
+        neglect_temperature_variations=False,
+        name="wet to critical volume ratio",
+    ):
+        self.critical_volume = builder.get_attribute(
+            "critical volume"
+            + (
+                " neglecting temperature variations"
+                if neglect_temperature_variations
+                else ""
+            )
+        )
+        self.volume = builder.get_attribute("volume")
+        super().__init__(
+            builder,
+            name=name,
+            dependencies=(self.critical_volume, self.volume),
+        )
+
+    def recalculate(self):
+        self.data.ratio(self.volume.get(), self.critical_volume.get())
+
+
+@register_attribute()
+class WetToCriticalVolumeRatioNeglectingTemperatureVariations(WetToCriticalVolumeRatio):
+    def __init__(self, builder):
+        super().__init__(
+            builder,
+            neglect_temperature_variations=True,
+            name="wet to critical volume ratio neglecting temperature variations",
+        )

pysdm-2.128/PySDM/attributes/physics/equilibrium_supersaturation.py → pysdm-2.130/PySDM/attributes/physics/equilibrium_saturation.py

@@ -1,12 +1,12 @@
 """
-kappa-Koehler equilibrium supersaturation calculated for actual environment temperature
+kappa-Koehler equilibrium saturation calculated for actual environment temperature
 """
 
 from PySDM.attributes.impl import DerivedAttribute, register_attribute
 
 
 @register_attribute()
-class EquilibriumSupersaturation(DerivedAttribute):
+class EquilibriumSaturation(DerivedAttribute):
     def __init__(self, builder):
         self.r_wet = builder.get_attribute("radius")
         self.v_wet = builder.get_attribute("volume")
@@ -16,7 +16,7 @@ class EquilibriumSupersaturation(DerivedAttribute):
 
         super().__init__(
             builder=builder,
-            name="equilibrium supersaturation",
+            name="equilibrium saturation",
             dependencies=(self.kappa, self.v_dry, self.f_org, self.r_wet),
         )
 

{pysdm-2.128 → pysdm-2.130}/PySDM/backends/impl_common/freezing_attributes.py

@@ -25,3 +25,14 @@ class TimeDependentAttributes(
     """groups attributes required in time-dependent regime"""
 
     __slots__ = ()
+
+
+class TimeDependentHomogeneousAttributes(
+    namedtuple(
+        typename="TimeDependentHomogeneousAttributes",
+        field_names=("volume", "signed_water_mass"),
+    )
+):
+    """groups attributes required in time-dependent regime for homogeneous freezing"""
+
+    __slots__ = ()

{pysdm-2.128 → pysdm-2.130}/PySDM/backends/impl_numba/methods/freezing_methods.py

@@ -1,5 +1,6 @@
 """
-CPU implementation of backend methods for freezing (singular and time-dependent immersion freezing)
+CPU implementation of backend methods for homogeneous freezing and
+heterogeneous freezing (singular and time-dependent immersion freezing)
 """
 
 from functools import cached_property
@@ -12,31 +13,40 @@ from PySDM.backends.impl_common.backend_methods import BackendMethods
 from ...impl_common.freezing_attributes import (
     SingularAttributes,
     TimeDependentAttributes,
+    TimeDependentHomogeneousAttributes,
 )
 
 
 class FreezingMethods(BackendMethods):
-    def __init__(self):
-        BackendMethods.__init__(self)
-        unfrozen_and_saturated = self.formulae.trivia.unfrozen_and_saturated
-        frozen_and_above_freezing_point = (
-            self.formulae.trivia.frozen_and_above_freezing_point
-        )
-
-        @numba.njit(**{**self.default_jit_flags, "parallel": False})
-        def _freeze(water_mass, i):
-            water_mass[i] = -1 * water_mass[i]
+    @cached_property
+    def _freeze(self):
+        @numba.njit(**{**self.default_jit_flags, **{"parallel": False}})
+        def body(signed_water_mass, i):
+            signed_water_mass[i] = -1 * signed_water_mass[i]
             # TODO #599: change thd (latent heat)!
 
-        @numba.njit(**{**self.default_jit_flags, "parallel": False})
-        def _thaw(water_mass, i):
-            water_mass[i] = -1 * water_mass[i]
+        return body
+
+    @cached_property
+    def _thaw(self):
+        @numba.njit(**{**self.default_jit_flags, **{"parallel": False}})
+        def body(signed_water_mass, i):
+            signed_water_mass[i] = -1 * signed_water_mass[i]
             # TODO #599: change thd (latent heat)!
 
+        return body
+
+    @cached_property
+    def _freeze_singular_body(self):
+        _thaw = self._thaw
+        _freeze = self._freeze
+        frozen_and_above_freezing_point = (
+            self.formulae.trivia.frozen_and_above_freezing_point
+        )
+        unfrozen_and_saturated = self.formulae.trivia.unfrozen_and_saturated
+
         @numba.njit(**self.default_jit_flags)
-        def freeze_singular_body(
-            attributes, temperature, relative_humidity, cell, thaw
-        ):
+        def body(attributes, temperature, relative_humidity, cell, thaw):
             n_sd = len(attributes.freezing_temperature)
             for i in numba.prange(n_sd):  # pylint: disable=not-an-iterable
                 if attributes.freezing_temperature[i] == 0:
@@ -53,13 +63,21 @@ class FreezingMethods(BackendMethods):
                 ):
                     _freeze(attributes.signed_water_mass, i)
 
-        self.freeze_singular_body = freeze_singular_body
+        return body
 
+    @cached_property
+    def _freeze_time_dependent_body(self):
+        _thaw = self._thaw
+        _freeze = self._freeze
+        frozen_and_above_freezing_point = (
+            self.formulae.trivia.frozen_and_above_freezing_point
+        )
+        unfrozen_and_saturated = self.formulae.trivia.unfrozen_and_saturated
         j_het = self.formulae.heterogeneous_ice_nucleation_rate.j_het
         prob_zero_events = self.formulae.trivia.poissonian_avoidance_function
 
         @numba.njit(**self.default_jit_flags)
-        def freeze_time_dependent_body(  # pylint: disable=too-many-arguments
+        def body(  # pylint: disable=too-many-arguments
             rand,
             attributes,
             timestep,
@@ -90,12 +108,69 @@ class FreezingMethods(BackendMethods):
                     if rand[i] < prob:
                         _freeze(attributes.signed_water_mass, i)
 
-        self.freeze_time_dependent_body = freeze_time_dependent_body
+        return body
+
+    @cached_property
+    def _freeze_time_dependent_homogeneous_body(self):
+        _thaw = self._thaw
+        _freeze = self._freeze
+        frozen_and_above_freezing_point = (
+            self.formulae.trivia.frozen_and_above_freezing_point
+        )
+        unfrozen_and_ice_saturated = self.formulae.trivia.unfrozen_and_ice_saturated
+        j_hom = self.formulae.homogeneous_ice_nucleation_rate.j_hom
+        prob_zero_events = self.formulae.trivia.poissonian_avoidance_function
+        d_a_w_ice_within_range = (
+            self.formulae.homogeneous_ice_nucleation_rate.d_a_w_ice_within_range
+        )
+        d_a_w_ice_maximum = (
+            self.formulae.homogeneous_ice_nucleation_rate.d_a_w_ice_maximum
+        )
+
+        @numba.njit(**self.default_jit_flags)
+        def body(  # pylint: disable=unused-argument,too-many-arguments
+            rand,
+            attributes,
+            timestep,
+            cell,
+            a_w_ice,
+            temperature,
+            relative_humidity_ice,
+            thaw,
+        ):
+
+            n_sd = len(attributes.signed_water_mass)
+            for i in numba.prange(n_sd):  # pylint: disable=not-an-iterable
+                cell_id = cell[i]
+                if thaw and frozen_and_above_freezing_point(
+                    attributes.signed_water_mass[i], temperature[cell_id]
+                ):
+                    _thaw(attributes.signed_water_mass, i)
+                elif unfrozen_and_ice_saturated(
+                    attributes.signed_water_mass[i], relative_humidity_ice[cell_id]
+                ):
+                    d_a_w_ice = (relative_humidity_ice[cell_id] - 1.0) * a_w_ice[
+                        cell_id
+                    ]
+
+                    if d_a_w_ice_within_range(d_a_w_ice):
+                        d_a_w_ice = d_a_w_ice_maximum(d_a_w_ice)
+                        rate_assuming_constant_temperature_within_dt = (
+                            j_hom(temperature[cell_id], d_a_w_ice)
+                            * attributes.volume[i]
+                        )
+                        prob = 1 - prob_zero_events(
+                            r=rate_assuming_constant_temperature_within_dt, dt=timestep
+                        )
+                        if rand[i] < prob:
+                            _freeze(attributes.signed_water_mass, i)
+
+        return body
 
     def freeze_singular(
         self, *, attributes, temperature, relative_humidity, cell, thaw: bool
     ):
-        self.freeze_singular_body(
+        self._freeze_singular_body(
             SingularAttributes(
                 freezing_temperature=attributes.freezing_temperature.data,
                 signed_water_mass=attributes.signed_water_mass.data,
@@ -118,7 +193,7 @@ class FreezingMethods(BackendMethods):
         relative_humidity,
         thaw: bool,
     ):
-        self.freeze_time_dependent_body(
+        self._freeze_time_dependent_body(
             rand.data,
             TimeDependentAttributes(
                 immersed_surface_area=attributes.immersed_surface_area.data,
@@ -132,6 +207,32 @@ class FreezingMethods(BackendMethods):
             thaw=thaw,
         )
 
+    def freeze_time_dependent_homogeneous(
+        self,
+        *,
+        rand,
+        attributes,
+        timestep,
+        cell,
+        a_w_ice,
+        temperature,
+        relative_humidity_ice,
+        thaw: bool,
+    ):
+        self._freeze_time_dependent_homogeneous_body(
+            rand.data,
+            TimeDependentHomogeneousAttributes(
+                volume=attributes.volume.data,
+                signed_water_mass=attributes.signed_water_mass.data,
+            ),
+            timestep,
+            cell.data,
+            a_w_ice.data,
+            temperature.data,
+            relative_humidity_ice.data,
+            thaw=thaw,
+        )
+
     @cached_property
     def _record_freezing_temperatures_body(self):
         ff = self.formulae_flattened

{pysdm-2.128 → pysdm-2.130}/PySDM/dynamics/freezing.py

@@ -1,14 +1,25 @@
 """
-immersion freezing using either singular or time-dependent formulation
+droplet freezing using either singular or
+time-dependent formulation for immersion freezing
+and homogeneous freezing and thaw
 """
 
 from PySDM.dynamics.impl import register_dynamic
 
 
 @register_dynamic()
-class Freezing:
-    def __init__(self, *, singular=True, thaw=False):
+class Freezing:  # pylint: disable=too-many-instance-attributes
+    def __init__(
+        self,
+        *,
+        singular=True,
+        homogeneous_freezing=False,
+        immersion_freezing=True,
+        thaw=False,
+    ):
         self.singular = singular
+        self.homogeneous_freezing = homogeneous_freezing
+        self.immersion_freezing = immersion_freezing
         self.thaw = thaw
         self.enable = True
         self.rand = None
@@ -26,12 +37,21 @@ class Freezing:
         if self.singular:
             builder.request_attribute("freezing temperature")
 
-        if not self.singular:
+        if not self.singular and self.immersion_freezing:
             assert (
                 self.particulator.formulae.heterogeneous_ice_nucleation_rate.__name__
                 != "Null"
             )
             builder.request_attribute("immersed surface area")
+
+        if self.homogeneous_freezing:
+            assert (
+                self.particulator.formulae.homogeneous_ice_nucleation_rate.__name__
+                != "Null"
+            )
+            builder.request_attribute("volume")
+
+        if self.homogeneous_freezing or not self.singular:
             self.rand = self.particulator.Storage.empty(
                 self.particulator.n_sd, dtype=float
             )
@@ -49,11 +69,19 @@ class Freezing:
         if not self.enable:
             return
 
-        if self.singular:
-            self.particulator.immersion_freezing_singular(thaw=self.thaw)
-        else:
+        if self.immersion_freezing:
+            if self.singular:
+                self.particulator.immersion_freezing_singular(thaw=self.thaw)
+            else:
+                self.rand.urand(self.rng)
+                self.particulator.immersion_freezing_time_dependent(
+                    rand=self.rand,
+                    thaw=self.thaw,
+                )
+
+        if self.homogeneous_freezing:
             self.rand.urand(self.rng)
-            self.particulator.immersion_freezing_time_dependent(
+            self.particulator.homogeneous_freezing_time_dependent(
                 rand=self.rand,
                 thaw=self.thaw,
             )

{pysdm-2.128 → pysdm-2.130}/PySDM/environments/parcel.py

@@ -2,7 +2,7 @@
 Zero-dimensional adiabatic parcel framework
 """
 
-from typing import List, Optional
+from typing import List, Optional, Union
 
 import numpy as np
 
@@ -25,7 +25,7 @@ class Parcel(Moist):  # pylint: disable=too-many-instance-attributes
         p0: float,
         initial_water_vapour_mixing_ratio: float,
         T0: float,
-        w: [float, callable],
+        w: Union[float, callable],
         z0: float = 0,
         mixed_phase=False,
         variables: Optional[List[str]] = None,

{pysdm-2.128 → pysdm-2.130}/PySDM/formulae.py

@@ -47,6 +47,7 @@ class Formulae:  # pylint: disable=too-few-public-methods,too-many-instance-attr
         hydrostatics: str = "ConstantGVapourMixingRatioAndThetaStd",
         freezing_temperature_spectrum: str = "Null",
         heterogeneous_ice_nucleation_rate: str = "Null",
+        homogeneous_ice_nucleation_rate: str = "Null",
         fragmentation_function: str = "AlwaysN",
         isotope_equilibrium_fractionation_factors: str = "Null",
         isotope_kinetic_fractionation_factors: str = "Null",
@@ -86,6 +87,7 @@ class Formulae:  # pylint: disable=too-few-public-methods,too-many-instance-attr
         self.hydrostatics = hydrostatics
         self.freezing_temperature_spectrum = freezing_temperature_spectrum
         self.heterogeneous_ice_nucleation_rate = heterogeneous_ice_nucleation_rate
+        self.homogeneous_ice_nucleation_rate = homogeneous_ice_nucleation_rate
         self.fragmentation_function = fragmentation_function
         self.isotope_equilibrium_fractionation_factors = (
             isotope_equilibrium_fractionation_factors

{pysdm-2.128 → pysdm-2.130}/PySDM/particulator.py

@@ -8,6 +8,7 @@ from PySDM.backends.impl_common.backend_methods import BackendMethods
 from PySDM.backends.impl_common.freezing_attributes import (
     SingularAttributes,
     TimeDependentAttributes,
+    TimeDependentHomogeneousAttributes,
 )
 from PySDM.backends.impl_common.index import make_Index
 from PySDM.backends.impl_common.indexed_storage import make_IndexedStorage
@@ -537,3 +538,18 @@ class Particulator:  # pylint: disable=too-many-public-methods,too-many-instance
             thaw=thaw,
         )
         self.attributes.mark_updated("signed water mass")
+
+    def homogeneous_freezing_time_dependent(self, *, thaw: bool, rand: Storage):
+        self.backend.freeze_time_dependent_homogeneous(
+            rand=rand,
+            attributes=TimeDependentHomogeneousAttributes(
+                volume=self.attributes["volume"],
+                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_ice=self.environment["RH_ice"],
+            thaw=thaw,
+        )

{pysdm-2.128 → pysdm-2.130}/PySDM/physics/__init__.py

@@ -27,6 +27,7 @@ from . import (
     fragmentation_function,
     freezing_temperature_spectrum,
     heterogeneous_ice_nucleation_rate,
+    homogeneous_ice_nucleation_rate,
     hydrostatics,
     hygroscopicity,
     impl,

{pysdm-2.128 → pysdm-2.130}/PySDM/physics/constants_defaults.py

@@ -106,13 +106,6 @@ HAC_ice = 0.7
 """ thermal accommodation coefficient for vapour deposition as recommended in
 [Pruppacher & Klett](https://doi.org/10.1007/978-0-306-48100-0) """
 
-p1000 = 1000 * si.hectopascals
-c_pd = 1005 * si.joule / si.kilogram / si.kelvin
-c_pv = 1850 * si.joule / si.kilogram / si.kelvin
-g_std = sci.g * si.metre / si.second**2
-
-c_pw = 4218 * si.joule / si.kilogram / si.kelvin
-
 ARM_C1 = 6.1094 * si.hectopascal
 """ [August](https://doi.org/10.1002/andp.18280890511) Roche Magnus formula coefficients
 (values from [Alduchov & Eskridge 1996](https://doi.org/10.1175%2F1520-0450%281996%29035%3C0601%3AIMFAOS%3E2.0.CO%3B2))
@@ -295,7 +288,7 @@ T_STP = (sci.zero_Celsius + 15) * si.kelvin
 p_STP = 101325 * si.pascal
 """ ... and pressure """
 
-ROOM_TEMP = T_tri + 25 * si.K
+ROOM_TEMP = T0 + 25 * si.K
 """ room temperature """
 
 dT_u = si.K
@@ -322,8 +315,44 @@ ABIFM_M = np.inf
 ABIFM_C = np.inf
 """ 〃 """
 
+KOOP_2000_C1 = -906.7
+""" homogeneous ice nucleation rate
+([Koop et al. 2000](https://doi.org/10.1038/35020537)) """
+KOOP_2000_C2 = 8502
+""" 〃 """
+KOOP_2000_C3 = -26924
+""" 〃 """
+KOOP_2000_C4 = 29180
+""" 〃 """
+KOOP_UNIT = 1 / si.cm**3 / si.s
+""" 〃 """
+KOOP_MIN_DA_W_ICE = 0.26
+""" 〃 """
+KOOP_MAX_DA_W_ICE = 0.34
+
+KOOP_CORR = -1.522
+""" homogeneous ice nucleation rate correction factor
+([Spichtinger et al. 2023](https://doi.org/10.5194/acp-23-2035-2023)) """
+
+KOOP_MURRAY_C0 = -3020.684
+""" homogeneous ice nucleation rate for pure water droplets
+([Koop & Murray 20016](https://doi.org/10.1063/1.4962355)) """
+KOOP_MURRAY_C1 = -425.921 / si.K
+""" 〃 """
+KOOP_MURRAY_C2 = -25.9779 / si.K**2
+""" 〃 """
+KOOP_MURRAY_C3 = -0.868451 / si.K**3
+""" 〃 """
+KOOP_MURRAY_C4 = -1.66203e-2 / si.K**4
+""" 〃 """
+KOOP_MURRAY_C5 = -1.71736e-4 / si.K**5
+""" 〃 """
+KOOP_MURRAY_C6 = -7.46953e-7 / si.K**6
+""" 〃 """
+
 J_HET = np.nan
-""" constant ice nucleation rate """
+J_HOM = np.nan
+""" constant ice nucleation rates """
 
 STRAUB_E_D1 = 0.04 * si.cm
 """ [Straub et al. 2010](https://doi.org/10.1175/2009JAS3175.1) """

pysdm-2.130/PySDM/physics/homogeneous_ice_nucleation_rate/__init__.py

@@ -0,0 +1,9 @@
+"""
+homogeneous-freezing rate (aka J_hom) formulations
+"""
+
+from .constant import Constant
+from .null import Null
+from .koop import Koop2000
+from .koop_corr import Koop_Correction
+from .koop_murray import KoopMurray2016