PySDM 3.0.0rc31__tar.gz → 3.0.0rc33__tar.gz

{pysdm-3.0.0rc31 → pysdm-3.0.0rc33}/.github/workflows/stale.yml

@@ -18,7 +18,7 @@ jobs:
       pull-requests: write
 
     steps:
-    - uses: actions/stale@v10.2.0
+    - uses: actions/stale@v10.3.0
       with:
         repo-token: ${{ secrets.GITHUB_TOKEN }}
         stale-issue-message: 'Stale issue message'

{pysdm-3.0.0rc31 → pysdm-3.0.0rc33}/.github/workflows/tutorial_code.yml

@@ -76,11 +76,11 @@ jobs:
         with:
           release: R2024b
           cache: true
-      - uses: matlab-actions/run-command@v3.1.1
+      - uses: matlab-actions/run-command@v3.1.2
         with:
           command: tutorial_code
       - run: sed -i -e 's/CPU/GPU/g' tutorial_code.m
-      - uses: matlab-actions/run-command@v3.1.1
+      - uses: matlab-actions/run-command@v3.1.2
         with:
           command: tutorial_code
 

{pysdm-3.0.0rc31/pysdm.egg-info → pysdm-3.0.0rc33}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pysdm
-Version: 3.0.0rc31
+Version: 3.0.0rc33
 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
@@ -43,7 +43,7 @@ Requires-Dist: numba==0.60.0; extra == "ci-version-pins"
 Requires-Dist: CURandRTC==0.1.7; extra == "ci-version-pins"
 Requires-Dist: Pint==0.24.4; extra == "ci-version-pins"
 Requires-Dist: chempy==0.10.1; extra == "ci-version-pins"
-Requires-Dist: pyevtk==1.6.0; extra == "ci-version-pins"
+Requires-Dist: pyevtk==1.7.0; extra == "ci-version-pins"
 Dynamic: license-file
 Dynamic: provides-extra
 Dynamic: requires-dist

{pysdm-3.0.0rc31 → pysdm-3.0.0rc33}/PySDM/attributes/ice/__init__.py

@@ -4,4 +4,5 @@ attributes used by the `PySDM.dynamics.freezing.Freezing` dynamic
 
 from .cooling_rate import CoolingRate
 from .freezing_temperature import FreezingTemperature
+from .freezing_supersaturation import SupersaturationOfLastFreezing
 from .immersed_surface_area import ImmersedSurfaceArea

pysdm-3.0.0rc33/PySDM/attributes/ice/freezing_supersaturation.py

@@ -0,0 +1,36 @@
+"""
+particle freezing supersaturation wrt ice
+"""
+
+from PySDM.attributes.impl import register_attribute
+from ..impl import DerivedAttribute
+
+
+@register_attribute()
+class SupersaturationOfLastFreezing(DerivedAttribute):
+    """time-dependent variant: assigned upon freezing"""
+
+    def __init__(self, builder):
+        assert "Freezing" in builder.particulator.dynamics
+        assert (
+            builder.particulator.dynamics["Freezing"].immersion_freezing != "singular"
+        )
+        self.signed_water_mass = builder.get_attribute("signed water mass")
+        self.cell_id = builder.get_attribute("cell id")
+        super().__init__(
+            builder,
+            name="supersaturation 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_supersaturations(
+            data=self.data,
+            cell_id=self.cell_id.data,
+            relative_humidity_ice=self.particulator.environment["RH_ice"],
+            signed_water_mass=self.signed_water_mass.data,
+        )

{pysdm-3.0.0rc31 → pysdm-3.0.0rc33}/PySDM/backends/impl_numba/methods/freezing_methods.py

@@ -299,3 +299,29 @@ class FreezingMethods(BackendMethods):
             temperature=temperature.data,
             signed_water_mass=signed_water_mass.data,
         )
+
+    @cached_property
+    def _record_freezing_supersaturations_body(self):
+        ff = self.formulae_flattened
+
+        @numba.njit(**{**self.default_jit_flags, "fastmath": False})
+        def body(data, cell_id, relative_humidity_ice, 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] = relative_humidity_ice[cell_id[drop_id]]
+
+        return body
+
+    def record_freezing_supersaturations(
+        self, *, data, cell_id, relative_humidity_ice, signed_water_mass
+    ):
+        self._record_freezing_supersaturations_body(
+            data=data.data,
+            cell_id=cell_id.data,
+            relative_humidity_ice=relative_humidity_ice.data,
+            signed_water_mass=signed_water_mass.data,
+        )

{pysdm-3.0.0rc31 → pysdm-3.0.0rc33}/PySDM/builder.py

@@ -17,7 +17,7 @@ from PySDM.physics.particle_shape_and_density import LiquidSpheres, MixedPhaseSp
 
 
 class Builder:
-    def __init__(self, n_sd, backend, environment=None):
+    def __init__(self, n_sd, backend, environment=None, dynamics=None):
         assert not inspect.isclass(backend)
         self.formulae = backend.formulae
         self.particulator = Particulator(n_sd, backend)
@@ -26,11 +26,14 @@ class Builder:
         self.aerosol_radius_threshold = 0
         self.condensation_params = None
         self.particulator.environment = environment.instantiate(builder=self)
+        if dynamics is not None:
+            for dynamic in dynamics:
+                self._register_dynamic(dynamic)
 
     def _set_condensation_parameters(self, **kwargs):
         self.condensation_params = kwargs
 
-    def add_dynamic(self, dynamic):
+    def _register_dynamic(self, dynamic):
         assert self.particulator.environment is not None
         key = inspect.getmro(type(dynamic))[-2].__name__
         assert key not in self.particulator.dynamics

{pysdm-3.0.0rc31 → pysdm-3.0.0rc33}/docs/markdown/pysdm_landing.md

@@ -155,8 +155,7 @@ ParticleVolumeVersusRadiusLogarithmSpectrum = pyimport("PySDM.products").Particl
 radius_bins_edges = 10 .^ range(log10(10*si.um), log10(5e3*si.um), length=32)
 
 env = Box(dt=1 * si.s, dv=1e6 * si.m^3)
-builder = Builder(n_sd=n_sd, backend=CPU(), environment=env)
-builder.add_dynamic(Coalescence(collision_kernel=Golovin(b=1.5e3 / si.s)))
+builder = Builder(n_sd=n_sd, backend=CPU(), environment=env, dynamics=(Coalescence(collision_kernel=Golovin(b=1.5e3 / si.s)),))
 products = [ParticleVolumeVersusRadiusLogarithmSpectrum(radius_bins_edges=radius_bins_edges, name="dv/dlnr")]
 particulator = builder.build(attributes, products)
 ```
@@ -175,8 +174,7 @@ ParticleVolumeVersusRadiusLogarithmSpectrum = py.importlib.import_module('PySDM.
 radius_bins_edges = logspace(log10(10 * si.um), log10(5e3 * si.um), 32);
 
 env = Box(pyargs('dt', 1 * si.s, 'dv', 1e6 * si.m ^ 3));
-builder = Builder(pyargs('n_sd', int32(n_sd), 'backend', CPU(), 'environment', env));
-builder.add_dynamic(Coalescence(pyargs('collision_kernel', Golovin(1.5e3 / si.s))));
+builder = Builder(pyargs('n_sd', int32(n_sd), 'backend', CPU(), 'environment', env, 'dynamics', py.tuple({Coalescence(pyargs('collision_kernel', Golovin(1.5e3 / si.s)))})));
 products = py.list({ ParticleVolumeVersusRadiusLogarithmSpectrum(pyargs( ...
   'radius_bins_edges', py.numpy.array(radius_bins_edges), ...
   'name', 'dv/dlnr' ...
@@ -199,8 +197,7 @@ from PySDM.products import ParticleVolumeVersusRadiusLogarithmSpectrum
 radius_bins_edges = np.logspace(np.log10(10 * si.um), np.log10(5e3 * si.um), num=32)
 
 env = Box(dt=1 * si.s, dv=1e6 * si.m ** 3)
-builder = Builder(n_sd=n_sd, backend=CPU(), environment=env)
-builder.add_dynamic(Coalescence(collision_kernel=Golovin(b=1.5e3 / si.s)))
+builder = Builder(n_sd=n_sd, backend=CPU(), environment=env, dynamics=(Coalescence(collision_kernel=Golovin(b=1.5e3 / si.s)),))
 products = [ParticleVolumeVersusRadiusLogarithmSpectrum(radius_bins_edges=radius_bins_edges, name='dv/dlnr')]
 particulator = builder.build(attributes, products)
 ```
@@ -302,12 +299,11 @@ The resultant plot (generated with the Python code) looks as follows:
 The component submodules used to create this simulation are visualized below:
 ```mermaid
  graph
-    COAL[":Coalescence"] --->|passed as arg to| BUILDER_ADD_DYN(["Builder.add_dynamic()"])
+    COAL[":Coalescence"] --->|passed as arg to| BUILDER_INIT(["Builder.__init__()"])
     BUILDER_INSTANCE["builder :Builder"] -...-|has a method| BUILDER_BUILD(["Builder.build()"])
     ATTRIBUTES[attributes: dict] -->|passed as arg to| BUILDER_BUILD
     N_SD["n_sd :int"] ---->|passed as arg to| BUILDER_INIT
     BUILDER_INIT(["Builder.__init__()"]) --->|instantiates| BUILDER_INSTANCE
-    BUILDER_INSTANCE -..-|has a method| BUILDER_ADD_DYN(["Builder.add_dynamic()"])
     ENV_INIT(["Box.__init__()"]) -->|instantiates| ENV
     DT[dt :float] -->|passed as arg to| ENV_INIT
     DV[dv :float] -->|passed as arg to| ENV_INIT
@@ -340,7 +336,6 @@ The component submodules used to create this simulation are visualized below:
     click COAL "https://open-atmos.github.io/PySDM/PySDM/dynamics/collisions/collision.html#Coalescence"
     click BUILDER_INSTANCE "https://open-atmos.github.io/PySDM/PySDM/builder.html"
     click BUILDER_INIT "https://open-atmos.github.io/PySDM/PySDM/builder.html"
-    click BUILDER_ADD_DYN "https://open-atmos.github.io/PySDM/PySDM/builder.html"
     click ENV_INIT "https://open-atmos.github.io/PySDM/PySDM/environments.html"
     click ENV "https://open-atmos.github.io/PySDM/PySDM/environments.html"
     click KERNEL_INIT "https://open-atmos.github.io/PySDM/PySDM/dynamics/collisions/collision_kernels.html"
@@ -410,9 +405,10 @@ output_points = 40
 n_sd = 256
 
 formulae = Formulae()
-builder = Builder(backend=CPU(formulae), n_sd=n_sd, environment=env)
-builder.add_dynamic(AmbientThermodynamics())
-builder.add_dynamic(Condensation())
+builder = Builder(backend=CPU(formulae), n_sd=n_sd, environment=env, dynamics=(
+    AmbientThermodynamics(),
+    Condensation(),
+))
 
 r_dry, specific_concentration = spectral_sampling.Logarithmic(spectrum).sample_deterministic(n_sd)
 v_dry = formulae.trivia.volume(radius=r_dry)
@@ -491,9 +487,12 @@ output_points = 40;
 n_sd = 256;
 
 formulae = Formulae();
-builder = Builder(pyargs('backend', CPU(formulae), 'n_sd', int32(n_sd), 'environment', env));
-builder.add_dynamic(AmbientThermodynamics());
-builder.add_dynamic(Condensation());
+builder = Builder(pyargs( ...
+    'backend', CPU(formulae), ...
+     'n_sd', int32(n_sd), ...
+      'environment', env, ...
+      'dynamics', py.tuple({AmbientThermodynamics(), Condensation()}) ...
+));
 
 tmp = spectral_sampling.Logarithmic(spectrum).sample_deterministic(int32(n_sd));
 r_dry = tmp{1};
@@ -592,9 +591,10 @@ output_points = 40
 n_sd = 256
 
 formulae = Formulae()
-builder = Builder(backend=CPU(formulae), n_sd=n_sd, environment=env)
-builder.add_dynamic(AmbientThermodynamics())
-builder.add_dynamic(Condensation())
+builder = Builder(backend=CPU(formulae), n_sd=n_sd, environment=env, dynamics=(
+    AmbientThermodynamics(),
+    Condensation(),
+))
 
 r_dry, specific_concentration = spectral_sampling.Logarithmic(spectrum).sample_deterministic(n_sd)
 v_dry = formulae.trivia.volume(radius=r_dry)