Merge pull request #779 from slayoo/ice_products

adding RHice product + tests

Author: slayoo

PySDM/products/ambient_thermodynamics/ambient_relative_humidity.py

@@ -1,9 +1,18 @@
 """
-ambient relative humidity
+ambient relative humidity (wrt water or ice)
 """
 from PySDM.products.impl.moist_environment_product import MoistEnvironmentProduct
 
 
 class AmbientRelativeHumidity(MoistEnvironmentProduct):
-    def __init__(self, name=None, unit='dimensionless', var=None):
+    def __init__(self, name=None, unit='dimensionless', var=None, ice=False):
         super().__init__(name=name, unit=unit, var=var)
+        self.ice = ice
+
+    def _impl(self, **kwargs):
+        super()._impl()
+        if self.ice:
+            RHw = self.buffer.copy()
+            self._download_to_buffer(self.environment['a_w_ice'])
+            self.buffer[:] = RHw / self.buffer[:]
+        return self.buffer

PySDM/products/size_spectral/__init__.py

@@ -2,7 +2,7 @@
 from .effective_radius import EffectiveRadius
 from .mean_radius import MeanRadius
 from .particle_size_spectrum import ParticleSizeSpectrumPerMass, ParticleSizeSpectrumPerVolume
-from .particles_concentration import ParticleConcentration, ParticleSpecificConcentration
+from .particle_concentration import ParticleConcentration, ParticleSpecificConcentration
 from .particle_volume_versus_radius_logarithm_spectrum import \
     ParticleVolumeVersusRadiusLogarithmSpectrum
 from .total_particle_concentration import TotalParticleConcentration

PySDM/products/size_spectral/particles_concentration.py renamed to PySDM/products/size_spectral/particle_concentration.py

@@ -0,0 +1,43 @@
+# pylint: disable=missing-module-docstring,missing-class-docstring,missing-function-docstring
+import numpy as np
+import pytest
+from PySDM.backends import CPU, GPU
+from PySDM.environments import Parcel
+from PySDM import Builder, products
+from PySDM.physics import si
+
+
+@pytest.mark.parametrize("backend_class", (
+    CPU,
+    pytest.param(GPU, marks=pytest.mark.xfail(strict=True))
+))
+def test_ambient_relative_humidity(backend_class):
+    # arrange
+    n_sd = 1
+    builder = Builder(n_sd, backend=backend_class())
+    env = Parcel(
+        dt=np.nan,
+        mixed_phase=True,
+        mass_of_dry_air=np.nan,
+        p0=1000 * si.hPa,
+        q0=1 * si.g / si.kg,
+        T0=260 * si.K,
+        w=np.nan
+    )
+    builder.set_environment(env)
+    attributes = {
+        'n': np.ones(n_sd),
+        'volume': np.ones(n_sd)
+    }
+    particulator = builder.build(attributes=attributes, products=(
+        products.AmbientRelativeHumidity(name='RHw', var='RH'),
+        products.AmbientRelativeHumidity(name='RHi', var='RH', ice=True),
+    ))
+
+    # act
+    values = {}
+    for name, product in particulator.products.items():
+        values[name] = product.get()[0]
+
+    # assert
+    assert values['RHw'] < values['RHi']

tests/unit_tests/products/__init__.py

@@ -96,7 +96,6 @@ def set_and_notify():
         np.testing.assert_allclose(value1, count / n_steps / dt)
         np.testing.assert_allclose(value2, count / n_steps / dt)
 
-
     @staticmethod
     @pytest.mark.parametrize('in_out_pair', (
         ('CPUTime', 'CPU time'),