PySDM 2.63__py3-none-any.whl → 2.65__py3-none-any.whl

PySDM/initialisation/init_fall_momenta.py

@@ -12,8 +12,7 @@ from PySDM.particulator import Particulator
 
 
 def init_fall_momenta(
-    volume: np.ndarray,
-    rho_w: float,  # TODO #798 - we plan to use masses instead of volumes soon
+    water_mass: np.ndarray,
     zero: bool = False,
     terminal_velocity_approx=GunnKinzer1949,  # TODO #1155
 ):
@@ -24,24 +23,26 @@ def init_fall_momenta(
     `PySDM.attributes.physics.relative_fall_velocity.RelativeFallVelocity` attribute)
 
     Parameters:
-        - volume: a numpy array of superdroplet volumes
-        - rho_w: the density of water (generally found in formulae.constants)
+        - water_mass: a numpy array of superdroplet water masses
 
     Returns:
         - a numpy array of initial momentum values
     """
     if zero:
-        return np.zeros_like(volume)
+        return np.zeros_like(water_mass)
 
     particulator = Particulator(0, CPU(Formulae()))  # TODO #1155
 
     approximation = terminal_velocity_approx(particulator=particulator)
 
-    radii_arr = particulator.formulae.trivia.radius(volume)
+    volume_arr = particulator.formulae.particle_shape_and_density.mass_to_volume(
+        water_mass
+    )
+    radii_arr = particulator.formulae.trivia.radius(volume=volume_arr)
     radii = particulator.Storage.from_ndarray(radii_arr)
 
-    output = particulator.Storage.empty((len(volume),), dtype=float)
+    output = particulator.Storage.empty((len(water_mass),), dtype=float)
 
     approximation(output=output, radius=radii)
 
-    return output.to_ndarray() * volume * rho_w  # TODO #798 this assumes no ice
+    return output.to_ndarray() * water_mass

PySDM/products/impl/concentration_product.py

@@ -7,19 +7,23 @@ from PySDM.products.impl.moment_product import MomentProduct
 
 
 class ConcentrationProduct(MomentProduct):
+    @staticmethod
+    def check_ctor_arguments(specific, stp):
+        if stp and specific:
+            raise ValueError(
+                "std-temperature-and-pressure precludes specific conc. option"
+            )
+
     def __init__(self, *, unit: str, name: str, specific: bool, stp: bool):
         """
         `stp` toggles expressing the concentration in terms of standard temperature
         and pressure conditions (ground level of the ICAO standard atmosphere, zero humidity)
         """
+        self.check_ctor_arguments(specific, stp)
         super().__init__(unit=unit, name=name)
         self.specific = specific
         self.stp = stp
         self.rho_stp = None
-        if self.stp and self.specific:
-            raise ValueError(
-                "std-temperature-and-pressure precludes specific conc. option"
-            )
 
     def register(self, builder):
         super().register(builder)

PySDM/products/size_spectral/particle_size_spectrum.py

@@ -7,13 +7,26 @@ from abc import ABC
 import numpy as np
 
 from PySDM.products.impl.spectrum_moment_product import SpectrumMomentProduct
+from PySDM.products.impl.concentration_product import ConcentrationProduct
 
 
 class ParticleSizeSpectrum(SpectrumMomentProduct, ABC):
-    def __init__(self, *, radius_bins_edges, name, unit, dry=False, specific=False):
+    def __init__(
+        self,
+        *,
+        stp: bool,
+        radius_bins_edges,
+        name: str,
+        unit: str,
+        dry: bool = False,
+        specific: bool = False,
+    ):
+        ConcentrationProduct.check_ctor_arguments(specific, stp)
         self.volume_attr = "dry volume" if dry else "volume"
         self.radius_bins_edges = radius_bins_edges
         self.specific = specific
+        self.stp = stp
+        self.rho_stp = None
         super().__init__(name=name, unit=unit, attr_unit="m^3")
 
     def register(self, builder):
@@ -29,6 +42,7 @@ class ParticleSizeSpectrum(SpectrumMomentProduct, ABC):
         super().register(builder)
 
         self.shape = (*builder.particulator.mesh.grid, len(self.attr_bins_edges) - 1)
+        self.rho_stp = builder.formulae.constants.rho_STP
 
     def _impl(self, **kwargs):
         vals = np.empty([self.particulator.mesh.n_cell, len(self.attr_bins_edges) - 1])
@@ -42,7 +56,7 @@ class ParticleSizeSpectrum(SpectrumMomentProduct, ABC):
 
         vals[:] /= self.particulator.mesh.dv
 
-        if self.specific:
+        if self.specific or self.stp:
             self._download_to_buffer(self.particulator.environment["rhod"])
 
         for i in range(len(self.attr_bins_edges) - 1):
@@ -50,29 +64,42 @@ class ParticleSizeSpectrum(SpectrumMomentProduct, ABC):
                 volume=self.attr_bins_edges[i + 1]
             ) - self.formulae.trivia.radius(volume=self.attr_bins_edges[i])
             vals[:, i] /= dr
-            if self.specific:
+            if self.specific or self.stp:
                 vals[:, i] /= self.buffer.ravel()
+                if self.stp:
+                    vals[:, i] *= self.rho_stp
 
         return np.squeeze(vals.reshape(self.shape))
 
 
 class ParticleSizeSpectrumPerMassOfDryAir(ParticleSizeSpectrum):
-    def __init__(self, radius_bins_edges, dry=False, name=None, unit="kg^-1 m^-1"):
+    def __init__(
+        self,
+        *,
+        radius_bins_edges,
+        dry=False,
+        name=None,
+        unit="kg^-1 m^-1",
+    ):
         super().__init__(
             radius_bins_edges=radius_bins_edges,
             dry=dry,
             specific=True,
             name=name,
             unit=unit,
+            stp=False,
         )
 
 
 class ParticleSizeSpectrumPerVolume(ParticleSizeSpectrum):
-    def __init__(self, radius_bins_edges, dry=False, name=None, unit="m^-3 m^-1"):
+    def __init__(
+        self, *, radius_bins_edges, dry=False, name=None, unit="m^-3 m^-1", stp=False
+    ):
         super().__init__(
             radius_bins_edges=radius_bins_edges,
             dry=dry,
             specific=False,
             name=name,
             unit=unit,
+            stp=stp,
         )

{PySDM-2.63.dist-info → PySDM-2.65.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PySDM
-Version: 2.63
+Version: 2.65
 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
@@ -34,7 +34,7 @@ Provides-Extra: tests
 Requires-Dist: matplotlib ; extra == 'tests'
 Requires-Dist: pytest ; extra == 'tests'
 Requires-Dist: pytest-timeout ; extra == 'tests'
-Requires-Dist: PyPartMC ==1.3.1 ; extra == 'tests'
+Requires-Dist: PyPartMC ==1.3.3 ; extra == 'tests'
 Requires-Dist: pyrcel ; extra == 'tests'
 Requires-Dist: jupyter-core <5.0.0 ; extra == 'tests'
 Requires-Dist: ipywidgets !=8.0.3 ; extra == 'tests'

{PySDM-2.63.dist-info → PySDM-2.65.dist-info}/RECORD

@@ -177,7 +177,7 @@ PySDM/impl/wall_timer.py,sha256=cDApBqoTS_kUfnBzzQtP-XTJxBMBmyqv4m9mODaA2CE,465
 PySDM/initialisation/__init__.py,sha256=Li4IboyzZBIwoLbNKceZq9nDUgJpShQr8QyibDZM_5Q,351
 PySDM/initialisation/discretise_multiplicities.py,sha256=D_8EsoXwSLsgIGUyOuLDDVuaQpZAQbtEDtJfcXK90Bw,779
 PySDM/initialisation/equilibrate_wet_radii.py,sha256=mQSMWChcF3YnfH9AIYAzYgjZXmXxZ3NaS0yNVCk5nuY,3774
-PySDM/initialisation/init_fall_momenta.py,sha256=u5fHphFE6wBo8e2m7_GGwTgXg33mQyGWY3Z8FyW86XA,1482
+PySDM/initialisation/init_fall_momenta.py,sha256=LFMTVm5DaO8B2_txi4yj9jvHGpgNX3JxYXzdaCai_VE,1427
 PySDM/initialisation/aerosol_composition/__init__.py,sha256=IsaPAyhxPXHaXY2nu9cyYdtjWnwxAGKZejvpRsv3Dyc,206
 PySDM/initialisation/aerosol_composition/dry_aerosol.py,sha256=FxFqPyR7Fhg1mi5lYfim4Z4PsnWrwIKGsVRiWa2HW6s,4372
 PySDM/initialisation/impl/__init__.py,sha256=vejuF9ebIGXb7l9zEiBBbNjs1Qct1KZuZRPLh8w3SJE,125
@@ -345,7 +345,7 @@ PySDM/products/housekeeping/time.py,sha256=LvGhRNtCHtZGO8Anfc_Vo_xtA34T3w41HvtBh
 PySDM/products/housekeeping/timers.py,sha256=bgaQNhqI6KuMDLUqDCCZNIAs4Ldvxf6okyv7Mm-t59Q,1085
 PySDM/products/impl/__init__.py,sha256=uIZwUK-EysFR7rvJGxWIasDz9pqGFm1Cju1AeoNMZM0,387
 PySDM/products/impl/activation_filtered_product.py,sha256=JUr-Wmna7SYItM_qq3XTNNq4gpnHyvssh5z9mNCAKFk,829
-PySDM/products/impl/concentration_product.py,sha256=UNbjrft_nS8Co2iEsA02Mg9x_e7LW9_mWgDXHTCw9aE,1402
+PySDM/products/impl/concentration_product.py,sha256=eOsKFu24Fb0R0pe4Y8wSF1IqtUAL-2xS1g_Qua9nEO4,1505
 PySDM/products/impl/moist_environment_product.py,sha256=czIPLjGV2hiX-sHHiXwuflcFZGbhvRyQ_QpIv3S-Hdo,889
 PySDM/products/impl/moment_product.py,sha256=rlYlTCNxdk0-oyCzVOq-4E6SZqNrGZGggDZerNmZLxg,1483
 PySDM/products/impl/product.py,sha256=z9kQWfQ8CKP0gRJ3LDVKL8JLfXhHjb3b9hjTox5ql_o,3412
@@ -368,15 +368,15 @@ PySDM/products/size_spectral/mean_volume_radius.py,sha256=fU8R0Dpglz7SExbQKgxGda
 PySDM/products/size_spectral/number_size_spectrum.py,sha256=UU4gzvh3eSEwqt-Qs0hMKCogsiwLZVy2BwXDHtv16lU,1422
 PySDM/products/size_spectral/particle_concentration.py,sha256=vhJqjqILq2NmZRVf1ZDd08TU-ok5Oz-QIGh1fw95o7c,1377
 PySDM/products/size_spectral/particle_concentration_activated.py,sha256=b7FYPz82uSZosqI6DQjPsDJ0WPSBJ3lTDgLt7hmlT8s,1565
-PySDM/products/size_spectral/particle_size_spectrum.py,sha256=EAGKhcdlMO8PKwIyCjM6w1RoTDd6vCCure8E6k2oI98,2631
+PySDM/products/size_spectral/particle_size_spectrum.py,sha256=8TWlg1hnVbN2cZHsSvHdJn5al4FK3Nxxwmays8xgd3k,3218
 PySDM/products/size_spectral/particle_volume_versus_radius_logarithm_spectrum.py,sha256=cnSwy2coAcjoZQiLTI8JCa1Tk_NhjAUe7GMN5UpIYjg,1711
 PySDM/products/size_spectral/radius_binned_number_averaged_terminal_velocity.py,sha256=DZbDh5wx3INvHjk9eQXVbLAwcSUd_6sTA92bRztK9Z0,1358
 PySDM/products/size_spectral/size_standard_deviation.py,sha256=ikW_BefV27gwUlDPoFDnxrP45Pb9SWIIcp8vJUlpNUU,2104
 PySDM/products/size_spectral/total_particle_concentration.py,sha256=stDEn67KGhxEkrOC4CCfCFVgjtQPMphZTfJ1Vy_H5aw,454
 PySDM/products/size_spectral/total_particle_specific_concentration.py,sha256=z6SfknIoXgT2XbVeuswrwBew9yTlmbW7qWFRmD4rqUg,460
 PySDM/products/size_spectral/water_mixing_ratio.py,sha256=i2g2s8Hj_ZTmggZvXuGRWnqyxutSknncY8Imzw_Vfhk,1301
-PySDM-2.63.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-PySDM-2.63.dist-info/METADATA,sha256=WDf4jw4wUNJaG7JbbbcmqX-h5mQEo39TKt1JvG58VOU,45787
-PySDM-2.63.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-PySDM-2.63.dist-info/top_level.txt,sha256=6NYaDAhUnaYMD7ebD_dQ7HlhiJS7NMuKEXb0ck7Wcsg,6
-PySDM-2.63.dist-info/RECORD,,
+PySDM-2.65.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+PySDM-2.65.dist-info/METADATA,sha256=2hjCWA1nYn4fr__zSllUrdgc7ese3FonreX3gRIKa9A,45787
+PySDM-2.65.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+PySDM-2.65.dist-info/top_level.txt,sha256=6NYaDAhUnaYMD7ebD_dQ7HlhiJS7NMuKEXb0ck7Wcsg,6
+PySDM-2.65.dist-info/RECORD,,