PySDM-examples 2.74__tar.gz → 2.76__tar.gz

{PySDM-examples-2.74 → PySDM-examples-2.76}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PySDM-examples
-Version: 2.74
+Version: 2.76
 Summary: PySDM usage examples reproducing results from literature and depicting how to use PySDM from Python Jupyter notebooks
 Home-page: https://github.com/open-atmos/PySDM
 Author: https://github.com/open-atmos/PySDM/graphs/contributors

PySDM-examples-2.76/PySDM_examples/seeding/__init__.py

@@ -0,0 +1,2 @@
+from .settings import Settings
+from .simulation import Simulation

PySDM-examples-2.76/PySDM_examples/seeding/settings.py

@@ -0,0 +1,65 @@
+import numpy as np
+from pystrict import strict
+from PySDM.initialisation.spectra import Lognormal
+from PySDM.initialisation.sampling.spectral_sampling import ConstantMultiplicity
+from PySDM.physics import si
+from PySDM import Formulae
+
+
+@strict
+class Settings:
+    def __init__(
+        self,
+        *,
+        super_droplet_injection_rate: callable,
+        n_sd_initial: int,
+        n_sd_seeding: int,
+        rain_water_radius_threshold: float,
+        formulae: Formulae,
+        enable_collisions: bool = True,
+    ):
+        self.enable_collisions = enable_collisions
+        self.formulae = formulae
+        self.n_sd_initial = n_sd_initial
+        self.n_sd_seeding = n_sd_seeding
+        self.rain_water_radius_threshold = rain_water_radius_threshold
+
+        self.t_max = 25 * si.min
+        self.w_max = 3 * si.m / si.s
+        self.w_min = 0.025 * si.m / si.s
+
+        self.timestep = 15 * si.s
+        self.mass_of_dry_air = 666 * si.kg
+
+        self.updraft = (
+            lambda t: self.w_min
+            + (self.w_max - self.w_min)
+            * np.maximum(0, np.sin(t / self.t_max * 2 * np.pi)) ** 2
+        )
+        self.initial_water_vapour_mixing_ratio = 666 / 30 * si.g / si.kg
+        self.initial_total_pressure = 1000 * si.hPa
+        self.initial_temperature = 300 * si.K
+        self.initial_aerosol_kappa = 0.5
+        self.initial_aerosol_dry_radii = Lognormal(
+            norm_factor=200 / si.mg * self.mass_of_dry_air,
+            m_mode=75 * si.nm,
+            s_geom=1.6,
+        )
+        self.super_droplet_injection_rate = super_droplet_injection_rate
+
+        r_dry, n_in_dv = ConstantMultiplicity(
+            Lognormal(
+                norm_factor=10 / si.mg * self.mass_of_dry_air,
+                m_mode=1 * si.um,
+                s_geom=1.1,
+            )
+        ).sample(
+            n_sd=n_sd_seeding
+        )  # TODO #1387: does not to be the same?
+        v_dry = self.formulae.trivia.volume(radius=r_dry)
+        self.seeded_particle_multiplicity = n_in_dv
+        self.seeded_particle_extensive_attributes = {
+            "water mass": [0.0001 * si.ng] * n_sd_seeding,
+            "dry volume": v_dry,
+            "kappa times dry volume": 0.8 * v_dry,
+        }

PySDM-examples-2.76/PySDM_examples/seeding/simulation.py

@@ -0,0 +1,97 @@
+import numpy as np
+
+from PySDM_examples.seeding.settings import Settings
+
+from PySDM import Builder
+from PySDM.backends import CPU
+from PySDM.environments import Parcel
+from PySDM.dynamics import Condensation, AmbientThermodynamics, Coalescence, Seeding
+from PySDM.dynamics.collisions.collision_kernels import Geometric
+from PySDM.initialisation.sampling.spectral_sampling import ConstantMultiplicity
+from PySDM import products
+from PySDM.physics import si
+
+
+class Simulation:
+    def __init__(self, settings: Settings):
+        builder = Builder(
+            n_sd=settings.n_sd_seeding + settings.n_sd_initial,
+            backend=CPU(
+                formulae=settings.formulae, override_jit_flags={"parallel": False}
+            ),
+            environment=Parcel(
+                dt=settings.timestep,
+                mass_of_dry_air=settings.mass_of_dry_air,
+                w=settings.updraft,
+                initial_water_vapour_mixing_ratio=settings.initial_water_vapour_mixing_ratio,
+                p0=settings.initial_total_pressure,
+                T0=settings.initial_temperature,
+            ),
+        )
+        builder.add_dynamic(AmbientThermodynamics())
+        builder.add_dynamic(Condensation())
+        if settings.enable_collisions:
+            builder.add_dynamic(Coalescence(collision_kernel=Geometric()))
+        builder.add_dynamic(
+            Seeding(
+                super_droplet_injection_rate=settings.super_droplet_injection_rate,
+                seeded_particle_multiplicity=settings.seeded_particle_multiplicity,
+                seeded_particle_extensive_attributes=settings.seeded_particle_extensive_attributes,
+            )
+        )
+
+        r_dry, n_in_dv = ConstantMultiplicity(
+            settings.initial_aerosol_dry_radii
+        ).sample(n_sd=settings.n_sd_initial, backend=builder.particulator.backend)
+        attributes = builder.particulator.environment.init_attributes(
+            n_in_dv=n_in_dv, kappa=settings.initial_aerosol_kappa, r_dry=r_dry
+        )
+        self.particulator = builder.build(
+            attributes={
+                k: np.pad(
+                    array=v,
+                    pad_width=(0, settings.n_sd_seeding),
+                    mode="constant",
+                    constant_values=np.nan if k == "multiplicity" else 0,
+                )
+                for k, v in attributes.items()
+            },
+            products=(
+                products.SuperDropletCountPerGridbox(name="sd_count"),
+                products.Time(),
+                products.WaterMixingRatio(
+                    radius_range=(settings.rain_water_radius_threshold, np.inf),
+                    name="rain water mixing ratio",
+                ),
+                products.EffectiveRadius(
+                    name="r_eff",
+                    unit="um",
+                    radius_range=(0.5 * si.um, 25 * si.um),
+                ),
+                products.ParticleConcentration(
+                    name="n_drop",
+                    unit="cm^-3",
+                    radius_range=(0.5 * si.um, 25 * si.um),
+                ),
+            ),
+        )
+        self.n_steps = int(settings.t_max // settings.timestep)
+
+    def run(self):
+        output = {
+            "attributes": {"water mass": []},
+            "products": {key: [] for key in self.particulator.products},
+        }
+        for step in range(self.n_steps + 1):
+            if step != 0:
+                self.particulator.run(steps=1)
+            for key, attr in output["attributes"].items():
+                data = self.particulator.attributes[key].to_ndarray(raw=True)
+                data[data == 0] = np.nan
+                attr.append(data)
+            for key, prod in output["products"].items():
+                prod.append(float(self.particulator.products[key].get()))
+        for out in ("attributes", "products"):
+            for key, val in output[out].items():
+                output[out][key] = np.array(val)
+        return output

{PySDM-examples-2.74 → PySDM-examples-2.76}/PySDM_examples.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PySDM-examples
-Version: 2.74
+Version: 2.76
 Summary: PySDM usage examples reproducing results from literature and depicting how to use PySDM from Python Jupyter notebooks
 Home-page: https://github.com/open-atmos/PySDM
 Author: https://github.com/open-atmos/PySDM/graphs/contributors

{PySDM-examples-2.74 → PySDM-examples-2.76}/PySDM_examples.egg-info/SOURCES.txt

@@ -145,6 +145,9 @@ PySDM_examples/deJong_Mackay_et_al_2023/settings_0D.py
 PySDM_examples/deJong_Mackay_et_al_2023/simulation1D.py
 PySDM_examples/deJong_Mackay_et_al_2023/simulation_0D.py
 PySDM_examples/deJong_Mackay_et_al_2023/simulation_ss.py
+PySDM_examples/seeding/__init__.py
+PySDM_examples/seeding/settings.py
+PySDM_examples/seeding/simulation.py
 PySDM_examples/utils/__init__.py
 PySDM_examples/utils/basic_simulation.py
 PySDM_examples/utils/dummy_controller.py