PySDM 2.97__py3-none-any.whl → 2.99__py3-none-any.whl

PySDM/physics/constants_defaults.py

@@ -30,6 +30,7 @@ from .constants import (  # pylint: disable=unused-import
 from .trivia import Trivia
 
 # https://physics.nist.gov/cgi-bin/Star/compos.pl?matno=104
+# TODO #1507
 Md = (
     0.755267 * Substance.from_formula("N2").mass * si.gram / si.mole
     + 0.231781 * Substance.from_formula("O2").mass * si.gram / si.mole
@@ -37,134 +38,240 @@ Md = (
     + 0.000124 * Substance.from_formula("C").mass * si.gram / si.mole
 )
 
-# https://web.archive.org/web/20200729203147/https://nucleus.iaea.org/rpst/documents/VSMOW_SLAP.pdf
-# heavy-to-light isotope abundance ratios
 VSMOW_R_2H = 155.76 * PPM
+"""
+[IAEA VSMOW-SLAP](https://web.archive.org/web/20200729203147/https://nucleus.iaea.org/rpst/documents/VSMOW_SLAP.pdf)
+heavy-to-light isotope abundance ratio for deuterium
+"""  # pylint: disable=line-too-long
 VSMOW_R_3H = 1.85e-11 * PPM
+"""
+〃 for tritium
+"""
 VSMOW_R_18O = 2005.20 * PPM
+"""
+〃 for oxygen-18
+"""
 VSMOW_R_17O = 379.9 * PPM
+"""
+〃 for oxygen-17
+"""
 
-# https://physics.nist.gov/cgi-bin/Compositions/stand_alone.pl?ele=H
 M_1H = 1.00782503224 * si.g / si.mole
+"""
+hydrogen atomic weight as in
+[NIST database](https://physics.nist.gov/cgi-bin/Compositions/stand_alone.pl?ele=H)
+"""
 M_2H = 2.01410177812 * si.g / si.mole
+"""
+deuterium atomic weight as in
+[NIST database](https://physics.nist.gov/cgi-bin/Compositions/stand_alone.pl?ele=H)
+"""
 M_3H = 3.01604927792 * si.g / si.mole
+"""
+tritium atomic weight as in
+[NIST database](https://physics.nist.gov/cgi-bin/Compositions/stand_alone.pl?ele=H)
+"""
 
-# https://physics.nist.gov/cgi-bin/Compositions/stand_alone.pl?ele=O
 M_16O = 15.99491461957 * si.g / si.mole
+"""
+oxygen-16 atomic weight as in
+[NIST database](https://physics.nist.gov/cgi-bin/Compositions/stand_alone.pl?ele=O)
+"""
 M_17O = 16.99913175651 * si.g / si.mole
+"""
+oxygen-17 atomic weight as in
+[NIST database](https://physics.nist.gov/cgi-bin/Compositions/stand_alone.pl?ele=O)
+"""
 M_18O = 17.99915961287 * si.g / si.mole
+"""
+oxygen-18 atomic weight as in
+[NIST database](https://physics.nist.gov/cgi-bin/Compositions/stand_alone.pl?ele=O)
+"""
 
 R_str = sci.R * si.joule / si.kelvin / si.mole
-N_A = sci.N_A / si.mole
+""" universal gas constant (value from SciPy) """
 
-D0 = 2.26e-5 * si.metre**2 / si.second
-D_exp = 1.81
-
-K0 = 2.4e-2 * si.joules / si.metres / si.seconds / si.kelvins
+N_A = sci.N_A / si.mole
+""" Avogadro constant (value from SciPy) """
 
-# mass and heat accommodation coefficients
 MAC = 1.0
+""" mass accommodation coefficient of unity as recommended in
+[Laaksonen et al. 2005](https://doi.org/10.5194/acp-5-461-2005) """
 HAC = 1.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
+""" thermal accommodation coefficient of uniy as recommended in
+[Laaksonen et al. 2005](https://doi.org/10.5194/acp-5-461-2005) """
 
 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))
+"""  # pylint: disable=line-too-long
 ARM_C2 = 17.625 * si.dimensionless
+""" 〃 """
 ARM_C3 = 243.04 * si.kelvin
+""" 〃 """
 
 FWC_C0 = 6.115836990e000 * si.hPa
+""" [Flatau et al. 1992](https://doi.org/10.1175/1520-0450(1992)031%3C1507:PFTSVP%3E2.0.CO;2)
+polynomial fit coefficients """
 FWC_C1 = 0.444606896e000 * si.hPa / si.K
+""" 〃 """
 FWC_C2 = 0.143177157e-01 * si.hPa / si.K**2
+""" 〃 """
 FWC_C3 = 0.264224321e-03 * si.hPa / si.K**3
+""" 〃 """
 FWC_C4 = 0.299291081e-05 * si.hPa / si.K**4
+""" 〃 """
 FWC_C5 = 0.203154182e-07 * si.hPa / si.K**5
+""" 〃 """
 FWC_C6 = 0.702620698e-10 * si.hPa / si.K**6
+""" 〃 """
 FWC_C7 = 0.379534310e-13 * si.hPa / si.K**7
+""" 〃 """
 FWC_C8 = -0.321582393e-15 * si.hPa / si.K**8
-
+""" 〃 """
 FWC_I0 = 6.098689930e000 * si.hPa
+""" 〃 """
 FWC_I1 = 0.499320233e000 * si.hPa / si.K
+""" 〃 """
 FWC_I2 = 0.184672631e-01 * si.hPa / si.K**2
+""" 〃 """
 FWC_I3 = 0.402737184e-03 * si.hPa / si.K**3
+""" 〃 """
 FWC_I4 = 0.565392987e-05 * si.hPa / si.K**4
+""" 〃 """
 FWC_I5 = 0.521693933e-07 * si.hPa / si.K**5
+""" 〃 """
 FWC_I6 = 0.307839583e-09 * si.hPa / si.K**6
+""" 〃 """
 FWC_I7 = 0.105785160e-11 * si.hPa / si.K**7
+""" 〃 """
 FWC_I8 = 0.161444444e-14 * si.hPa / si.K**8
+""" 〃 """
 
 L77W_A0 = 6.107799961 * si.hPa
+""" polynomial fits from
+[Lowe et al. 1977](https://doi.org/10.1175/1520-0450(1977)016%3C0100:AAPFTC%3E2.0.CO;2) """
 L77W_A1 = 4.436518521e-1 * si.hPa / si.K
+""" 〃 """
 L77W_A2 = 1.428945805e-2 * si.hPa / si.K**2
+""" 〃 """
 L77W_A3 = 2.650648471e-4 * si.hPa / si.K**3
+""" 〃 """
 L77W_A4 = 3.031240396e-6 * si.hPa / si.K**4
+""" 〃 """
 L77W_A5 = 2.034080948e-8 * si.hPa / si.K**5
+""" 〃 """
 L77W_A6 = 6.136820929e-11 * si.hPa / si.K**6
-
+""" 〃 """
 L77I_A0 = 6.109177956 * si.hPa
+""" 〃 """
 L77I_A1 = 5.03469897e-1 * si.hPa / si.K
+""" 〃 """
 L77I_A2 = 1.886013408e-2 * si.hPa / si.K**2
+""" 〃 """
 L77I_A3 = 4.176223716e-4 * si.hPa / si.K**3
+""" 〃 """
 L77I_A4 = 5.824720280e-6 * si.hPa / si.K**4
+""" 〃 """
 L77I_A5 = 4.838803174e-8 * si.hPa / si.K**5
+""" 〃 """
 L77I_A6 = 1.838826904e-10 * si.hPa / si.K**6
+""" 〃 """
 
-rho_w = 1 * si.kilograms / si.litres
 rho_i = 916.8 * si.kg / si.metres**3
+""" density of ice, for discussion, see [Pounder 1965](https://doi.org/10.1016/C2013-0-08278-3) """
+rho_w = 1 * si.kilograms / si.litres
+""" 〃 of water, 〃 """
+
 pH_w = 7
-sgm_w = 0.072 * si.joule / si.metre**2
+""" pH of pure water """
 
-p_tri = 611.73 * si.pascal
+p1000 = 1000 * si.hectopascals
+""" 1000 hPa reference pressure as in the definition of potential temperature"""
+
+p_tri = 611.657 * si.pascal
+""" water triple point characteristics as recommended in
+[Murphy & Koop 2005](https://doi.org/10.1256/qj.04.94) """
 T_tri = 273.16 * si.kelvin
+""" 〃 """
+
 l_tri = 2.5e6 * si.joule / si.kilogram
 
-# Seinfeld and Pandis, Appendix 16.1, 16A.2
-# default constant values according to Lowe et al. (2019), from ICPM code
 l_l19_a = 0.167 * si.dimensionless
+""" [Seinfeld and Pandis](https://archive.org/details/0237-pdf-atmospheric-chemistry-and-physics-2nd-ed-j.-seinfeld-s.-pandis-wiley-2006-ww)
+Appendix 16.1, 16A.2 default constant values according to
+[Lowe et al. 2019](https://doi.org/10.1038/s41467-019-12982-0),
+from ICPM code """  # pylint: disable=line-too-long
 l_l19_b = 3.65e-4 / si.kelvin
+""" 〃 """
 
-# Thermal diffusivity constants from Lowe et al. (2019)
 k_l19_a = 4.2e-3 * si.joules / si.metres / si.seconds / si.kelvins
+""" Thermal diffusivity constants from
+[Lowe et al. 2019](https://doi.org/10.1038/s41467-019-12982-0) """
 k_l19_b = 1.0456 * si.dimensionless
+""" 〃 """
 k_l19_c = 0.017 / si.kelvin
+""" 〃 """
 
-# Delta v for diffusivity in Pruppacher & Klett eq. 13-14
 dv_pk05 = 0.0 * si.metres
+""" Delta v for diffusivity in [Pruppacher & Klett](https://doi.org/10.1007/978-0-306-48100-0)
+eq. 13-14 """
 
-# Seinfeld & Pandis eq. 15.65 (Hall & Pruppacher 1976)
 d_l19_a = 0.211e-4 * si.metre**2 / si.second
+""" [Seinfeld & Pandis](https://archive.org/details/0237-pdf-atmospheric-chemistry-and-physics-2nd-ed-j.-seinfeld-s.-pandis-wiley-2006-ww)
+eq. 15.65
+[Hall & Pruppacher 1976](https://doi.org/10.1175/1520-0469(1976)033%3C1995:TSOIPF%3E2.0.CO;2)
+"""  # pylint: disable=line-too-long
 d_l19_b = 1.94
+""" 〃 """
 
 MK05_ICE_C1 = 1 * si.Pa
+""" [Murphy and Koop 2005](https://doi.org/10.1256/qj.04.94) """
 MK05_ICE_C2 = 9.550426 * si.dimensionless
+""" 〃 """
 MK05_ICE_C3 = 5723.265 * si.K
+""" 〃 """
 MK05_ICE_C4 = 3.53068 * si.dimensionless
+""" 〃 """
 MK05_ICE_C5 = 1 * si.K
+""" 〃 """
 MK05_ICE_C6 = 0.00728332 / si.K
-
+""" 〃 """
 MK05_LIQ_C1 = 1 * si.Pa
+""" 〃 """
 MK05_LIQ_C2 = 54.842763 * si.dimensionless
+""" 〃 """
 MK05_LIQ_C3 = 6763.22 * si.K
+""" 〃 """
 MK05_LIQ_C4 = 4.210 * si.dimensionless
+""" 〃 """
 MK05_LIQ_C5 = 1 * si.K
+""" 〃 """
 MK05_LIQ_C6 = 0.000367 / si.K
+""" 〃 """
 MK05_LIQ_C7 = 0.0415 / si.K
+""" 〃 """
 MK05_LIQ_C8 = 218.8 * si.K
+""" 〃 """
 MK05_LIQ_C9 = 53.878 * si.dimensionless
+""" 〃 """
 MK05_LIQ_C10 = 1331.22 * si.K
+""" 〃 """
 MK05_LIQ_C11 = 9.44523 * si.dimensionless
+""" 〃 """
 MK05_LIQ_C12 = 1 * si.K
+""" 〃 """
 MK05_LIQ_C13 = 0.014025 / si.K
+""" 〃 """
 
-# standard pressure and temperature (ICAO)
 T_STP = (sci.zero_Celsius + 15) * si.kelvin
+""" standard temperature (ICAO) ... """
 p_STP = 101325 * si.pascal
+""" ... and pressure """
 
 ROOM_TEMP = T_tri + 25 * si.K
+""" room temperature """
+
 dT_u = si.K
 
 sgm_org = np.nan
@@ -181,258 +288,334 @@ BIGG_DT_MEDIAN = np.nan
 NIEMAND_A = np.nan
 NIEMAND_B = np.nan
 
+ABIFM_UNIT = 1 / si.cm**2 / si.s
+""" ice nucleation rate using ABIFM
+([Knopf & Alpert 2013](https://doi.org/10.1039/C3FD00035D)) """
 ABIFM_M = np.inf
+""" 〃 """
 ABIFM_C = np.inf
-ABIFM_UNIT = 1 / si.cm**2 / si.s
+""" 〃 """
 
 J_HET = np.nan
+""" constant ice nucleation rate """
 
 STRAUB_E_D1 = 0.04 * si.cm
+""" [Straub et al. 2010](https://doi.org/10.1175/2009JAS3175.1) """
 STRAUB_MU2 = 0.095 * si.cm
+""" 〃 """
 
 VEDDER_1987_b = 89 / 880
+""" [Vedder 1987](https://doi.org/10.1119/1.15018) """
 VEDDER_1987_A = 993 / 880 / 3 / VEDDER_1987_b
+""" 〃 """
 
-""" [eq. 5 in Merlivat and Nief 1967](https://doi.org/10.3402/tellusa.v19i1.9756) """
 MERLIVAT_NIEF_1967_ALPHA_L_2H_T2 = 15013 * si.K**2
+""" [eq. 5 in Merlivat and Nief 1967](https://doi.org/10.3402/tellusa.v19i1.9756) """
 MERLIVAT_NIEF_1967_ALPHA_L_2H_T1 = 0 * si.K
+""" 〃 """
 MERLIVAT_NIEF_1967_ALPHA_L_2H_T0 = -0.1
-
+""" 〃 """
 MERLIVAT_NIEF_1967_ALPHA_I_2H_T2 = 16289 * si.K**2
+""" 〃 """
 MERLIVAT_NIEF_1967_ALPHA_I_2H_T1 = 0 * si.K
+""" 〃 """
 MERLIVAT_NIEF_1967_ALPHA_I_2H_T0 = -0.0945
+""" 〃 """
 
-""" [Lamb et al. 2017](https://doi.org/10.1073/pnas.1618374114) """
 LAMB_ET_AL_2017_ALPHA_I_2H_T2 = 13525 * si.K**2
+""" [Lamb et al. 2017](https://doi.org/10.1073/pnas.1618374114) """
 LAMB_ET_AL_2017_ALPHA_I_2H_T1 = 0 * si.K
+""" 〃 """
 LAMB_ET_AL_2017_ALPHA_I_2H_T0 = -0.0559
+""" 〃 """
 
-""" [Ellehoj et al. 2013](https://doi.org/10.1002/rcm.6668) """
 ELLEHOJ_ET_AL_2013_ALPHA_I_2H_T2 = 48888 * si.K**2
+""" [Ellehoj et al. 2013](https://doi.org/10.1002/rcm.6668) """
 ELLEHOJ_ET_AL_2013_ALPHA_I_2H_T1 = -203.1 * si.K
+""" 〃 """
 ELLEHOJ_ET_AL_2013_ALPHA_I_2H_T0 = 0.2133
+""" 〃 """
 
-""" [Majoube 1971](https://doi.org/10.1051/jcp/1971681423) """
-# values taken from Jouzel 1986 (eqs. 1)
 MAJOUBE_1971_ALPHA_L_18O_T2 = 1137 * si.K**2
+""" [Majoube 1971](https://doi.org/10.1051/jcp/1971681423)
+(values taken from [Jouzel 1986](https://doi.org/10.1016/b978-0-444-42225-5.50007-3)) """
 MAJOUBE_1971_ALPHA_L_18O_T1 = -0.4156 * si.K
+""" 〃 """
 MAJOUBE_1971_ALPHA_L_18O_T0 = -0.0020667
-
-# values taken from Jouzel 1986 (eqs. 2)
+""" 〃 """
 MAJOUBE_1971_ALPHA_L_2H_T2 = 24844 * si.K**2
+""" 〃 """
 MAJOUBE_1971_ALPHA_L_2H_T1 = -76.248 * si.K
+""" 〃 """
 MAJOUBE_1971_ALPHA_L_2H_T0 = 0.052612
+""" 〃 """
 
-""" [Majoube 1970](https://doi.org/10.1038/2261242a0) """
 MAJOUBE_1970_ALPHA_I_18O_T2 = 0 * si.K**2
+""" [Majoube 1970](https://doi.org/10.1038/2261242a0) """
 MAJOUBE_1970_ALPHA_I_18O_T1 = 11.839 * si.K
+""" 〃 """
 MAJOUBE_1970_ALPHA_I_18O_T0 = -0.028224
+""" 〃 """
 
-""" [Van Hook 1968](https://doi.org/10.1021/j100850a028) """
 VAN_HOOK_1968_ALPHA_I_2H_A = 11484.5 * si.K**2
+""" [Van Hook 1968](https://doi.org/10.1021/j100850a028) """
 VAN_HOOK_1968_ALPHA_I_2H_B = 35.3315 * si.K
+""" 〃 """
 VAN_HOOK_1968_ALPHA_I_2H_C = -0.159290
-
+""" 〃 """
 VAN_HOOK_1968_ALPHA_L_2H_A = 26398.8 * si.K**2
+""" 〃 """
 VAN_HOOK_1968_ALPHA_L_2H_B = -89.6065 * si.K
+""" 〃 """
 VAN_HOOK_1968_ALPHA_L_2H_C = 0.075802
-
+""" 〃 """
 VAN_HOOK_1968_ALPHA_I_18O_A = 1740.59 * si.K**2
+""" 〃 """
 VAN_HOOK_1968_ALPHA_I_18O_B = 2.2965 * si.K
+""" 〃 """
 VAN_HOOK_1968_ALPHA_I_18O_C = -0.005793
-
+""" 〃 """
 VAN_HOOK_1968_ALPHA_L_18O_A = 1991.1 * si.K**2
+""" 〃 """
 VAN_HOOK_1968_ALPHA_L_18O_B = -4.1887 * si.K
+""" 〃 """
 VAN_HOOK_1968_ALPHA_L_18O_C = 0.001197
-
+""" 〃 """
 VAN_HOOK_1968_ALPHA_I_17O_A = 933.651 * si.K**2
+""" 〃 """
 VAN_HOOK_1968_ALPHA_I_17O_B = 1.0953 * si.K
+""" 〃 """
 VAN_HOOK_1968_ALPHA_I_17O_C = -0.002805
-
+""" 〃 """
 VAN_HOOK_1968_ALPHA_L_17O_A = 1057.8 * si.K**2
+""" 〃 """
 VAN_HOOK_1968_ALPHA_L_17O_B = -2.24 * si.K
+""" 〃 """
 VAN_HOOK_1968_ALPHA_L_17O_C = 0.000668
-
+""" 〃 """
 VAN_HOOK_1968_ALPHA_I_3H_A = 18464.5 * si.K**2
+""" 〃 """
 VAN_HOOK_1968_ALPHA_I_3H_B = 31.0436 * si.K
+""" 〃 """
 VAN_HOOK_1968_ALPHA_I_3H_C = -0.20752
-
+""" 〃 """
 VAN_HOOK_1968_ALPHA_L_3H_A = 37813.2 * si.K**2
+""" 〃 """
 VAN_HOOK_1968_ALPHA_L_3H_B = -136.751 * si.K
+""" 〃 """
 VAN_HOOK_1968_ALPHA_L_3H_C = 0.124096
-
+""" 〃 """
 VAN_HOOK_1968_ALPHA_I_TOT_A = 33453.7 * si.K**2
+""" 〃 """
 VAN_HOOK_1968_ALPHA_I_TOT_B = 62.4058 * si.K
+""" 〃 """
 VAN_HOOK_1968_ALPHA_I_TOT_C = -0.395542
-
+""" 〃 """
 VAN_HOOK_1968_ALPHA_L_TOT_A = 68702.3 * si.K**2
+""" 〃 """
 VAN_HOOK_1968_ALPHA_L_TOT_B = -244.687 * si.K
+""" 〃 """
 VAN_HOOK_1968_ALPHA_L_TOT_C = 0.224388
-
+""" 〃 """
 VAN_HOOK_1968_ALPHA_I_DOT_A = 27722.4 * si.K**2
+""" 〃 """
 VAN_HOOK_1968_ALPHA_I_DOT_B = 66.5930 * si.K
+""" 〃 """
 VAN_HOOK_1968_ALPHA_I_DOT_C = -0.351698
-
+""" 〃 """
 VAN_HOOK_1968_ALPHA_L_DOT_A = 59313.4 * si.K**2
+""" 〃 """
 VAN_HOOK_1968_ALPHA_L_DOT_B = -204.941 * si.K
+""" 〃 """
 VAN_HOOK_1968_ALPHA_L_DOT_C = 0.182686
-
+""" 〃 """
 VAN_HOOK_1968_ALPHA_I_DOD_A = 21577.6 * si.K**2
+""" 〃 """
 VAN_HOOK_1968_ALPHA_I_DOD_B = 69.3358 * si.K
+""" 〃 """
 VAN_HOOK_1968_ALPHA_I_DOD_C = -0.305394
-
+""" 〃 """
 VAN_HOOK_1968_ALPHA_L_DOD_A = 49314.9 * si.K**2
+""" 〃 """
 VAN_HOOK_1968_ALPHA_L_DOD_B = -164.266 * si.K
+""" 〃 """
 VAN_HOOK_1968_ALPHA_L_DOD_C = 0.140049
+""" 〃 """
 
-""" [Horita and Wesolowski 1994](https://doi.org/10.1016/0016-7037(94)90096-5) """
 HORITA_AND_WESOLOWSKI_1994_ALPHA_L_18O_T3 = 1e-3 * 0.35041e9 * si.K**3
+""" [Horita and Wesolowski 1994](https://doi.org/10.1016/0016-7037(94)90096-5) """
 HORITA_AND_WESOLOWSKI_1994_ALPHA_L_18O_T2 = 1e-3 * -1.6664e6 * si.K**2
+""" 〃 """
 HORITA_AND_WESOLOWSKI_1994_ALPHA_L_18O_T1 = 1e-3 * 6.7123e3 * si.K
+""" 〃 """
 HORITA_AND_WESOLOWSKI_1994_ALPHA_L_18O_T0 = 1e-3 * -7.685
-
+""" 〃 """
 HORITA_AND_WESOLOWSKI_1994_ALPHA_L_2H_T3 = 1e-3 * 2.9992e9 * si.K**3
+""" 〃 """
 HORITA_AND_WESOLOWSKI_1994_ALPHA_L_2H_T_0 = 1e-3 * -161.04
+""" 〃 """
 HORITA_AND_WESOLOWSKI_1994_ALPHA_L_2H_T_1 = 1e-3 * 794.84e-3 / si.K
+""" 〃 """
 HORITA_AND_WESOLOWSKI_1994_ALPHA_L_2H_T_2 = 1e-3 * -1620.1e-6 / si.K**2
+""" 〃 """
 HORITA_AND_WESOLOWSKI_1994_ALPHA_L_2H_T_3 = 1e-3 * 1158.8e-9 / si.K**3
+""" 〃 """
 
-""" [Barkan and Luz 2005](https://doi.org/10.1002/rcm.2250) """
 BARKAN_AND_LUZ_2005_EXPONENT = 0.529
+""" [Barkan and Luz 2005](https://doi.org/10.1002/rcm.2250) """
 
-""" eq. 11 in [Barkan and Luz 2007](https://doi.org/10.1002/rcm.3180) """
 BARKAN_AND_LUZ_2007_EXCESS_18O_COEFF = 0.528
+""" eq. 11 in [Barkan and Luz 2007](https://doi.org/10.1002/rcm.3180) """
 
-""" [Craig 1961](https://doi.org/10.1126/science.133.3465.1702) """
 CRAIG_1961_SLOPE_COEFF = 8
+""" [Craig 1961](https://doi.org/10.1126/science.133.3465.1702) """
 CRAIG_1961_INTERCEPT_COEFF = 10 * PER_MILLE
+""" 〃 """
 
-""" [Bohren 1987](https://doi.org/10.1119/1.15109) """
 asymmetry_g = 0.85  # forward scattering from cloud droplets
+""" [Bohren 1987](https://doi.org/10.1119/1.15109) """
 
-""" [Grabowski et al. 2011](https://doi.org/10.1016/j.atmosres.2010.10.020) """
 diffusion_thermics_D_G11_A = 1e-5 * si.m**2 / si.s
+""" [Grabowski et al. 2011](https://doi.org/10.1016/j.atmosres.2010.10.020) """
 diffusion_thermics_D_G11_B = 0.015 / si.K
+""" 〃 """
 diffusion_thermics_D_G11_C = -1.9
-
+""" 〃 """
 diffusion_thermics_K_G11_A = 1.5e-11 * si.W / si.m / si.K**4
+""" 〃 """
 diffusion_thermics_K_G11_B = -4.8e-8 * si.W / si.m / si.K**3
+""" 〃 """
 diffusion_thermics_K_G11_C = 1e-4 * si.W / si.m / si.K**2
+""" 〃 """
 diffusion_thermics_K_G11_D = -3.9e-4 * si.W / si.m / si.K
+""" 〃 """
 
+PRUPPACHER_RASMUSSEN_1979_XTHRES = 1.4 * si.dimensionless
 """
 [Pruppacher & Rasmussen 1979](https://doi.org/10.1175/1520-0469(1979)036%3C1255:AWTIOT%3E2.0.CO;2)
 """
-PRUPPACHER_RASMUSSEN_1979_XTHRES = 1.4 * si.dimensionless
 PRUPPACHER_RASMUSSEN_1979_CONSTSMALL = 1.0 * si.dimensionless
+""" 〃 """
 PRUPPACHER_RASMUSSEN_1979_COEFFSMALL = 0.108 * si.dimensionless
+""" 〃 """
 PRUPPACHER_RASMUSSEN_1979_POWSMALL = 2 * si.dimensionless
+""" 〃 """
 PRUPPACHER_RASMUSSEN_1979_CONSTBIG = 0.78 * si.dimensionless
+""" 〃 """
 PRUPPACHER_RASMUSSEN_1979_COEFFBIG = 0.308 * si.dimensionless
+""" 〃 """
 
-"""[Zografos et al. 1987](https://doi.org/10.1016/0045-7825(87)90003-X) Table 1"""
 ZOGRAFOS_1987_COEFF_T3 = 2.5914e-15 * si.K ** (-3) * si.Pa * si.s
+"""[Zografos et al. 1987](https://doi.org/10.1016/0045-7825(87)90003-X) Table 1"""
 ZOGRAFOS_1987_COEFF_T2 = -1.4346e-11 * si.K ** (-2) * si.Pa * si.s
+""" 〃 """
 ZOGRAFOS_1987_COEFF_T1 = 5.0523e-8 / si.K * si.Pa * si.s
+""" 〃 """
 ZOGRAFOS_1987_COEFF_T0 = 4.1130e-6 * si.Pa * si.s
+""" 〃 """
 
-
+FROESSLING_1938_A = 1
 """ Froessling 1938 coefficients as given on page 61 in
     [Squires 1952](https://doi.org/10.1071/CH9520059) """
-FROESSLING_1938_A = 1
 FROESSLING_1938_B = 0.276
+""" 〃 """
 
-
-""" fit coefficients from [Hellmann & Harvey 2020](https://doi.org/10.1029/2020GL089999) """
 HELLMANN_HARVEY_T_UNIT = 100 * si.K
+""" fit coefficients from [Hellmann & Harvey 2020](https://doi.org/10.1029/2020GL089999) """
 HELLMANN_HARVEY_EQ6_COEFF0 = 0.98258
+""" 〃 """
 HELLMANN_HARVEY_EQ6_COEFF1 = -0.02546
+""" 〃 """
 HELLMANN_HARVEY_EQ6_COEFF2 = 0.02421
+""" 〃 """
 HELLMANN_HARVEY_EQ7_COEFF0 = 0.98284
+""" 〃 """
 HELLMANN_HARVEY_EQ7_COEFF1 = 0.003517
+""" 〃 """
 HELLMANN_HARVEY_EQ7_COEFF2 = -0.001996
+""" 〃 """
 HELLMANN_HARVEY_EQ8_COEFF0 = 0.96671
+""" 〃 """
 HELLMANN_HARVEY_EQ8_COEFF1 = 0.007406
+""" 〃 """
 HELLMANN_HARVEY_EQ8_COEFF2 = -0.004861
+""" 〃 """
 
-
-""" terminal velocity formulation from Rogers & Yau (equations: 8.5, 8.6, 8.8) """
 ROGERS_YAU_TERM_VEL_SMALL_K = 1.19e6 / si.cm / si.s
+""" terminal velocity formulation from
+[Rogers & Yau 1989](https://archive.org/details/shortcourseinclo0000roge_m3k2)
+(equations: 8.5, 8.6, 8.8) """
 ROGERS_YAU_TERM_VEL_MEDIUM_K = 8e3 / si.s
+""" 〃 """
 ROGERS_YAU_TERM_VEL_LARGE_K = 2.01e3 * si.cm**0.5 / si.s
+""" 〃 """
 ROGERS_YAU_TERM_VEL_SMALL_R_LIMIT = 35 * si.um
+""" 〃 """
 ROGERS_YAU_TERM_VEL_MEDIUM_R_LIMIT = 600 * si.um
-
-
-def compute_derived_values(c: dict):
-    """
-    computes derived quantities such as molar mass ratios, etc.
-
-    water molar mass is computed from molecular masses and VSMOW isotope abundances
-    (and neglecting molecular binding energies)
-    for discussion, see:
-    - caption of Table 2.1 in [Gat 2010](https://doi.org/10.1142/p027)
-    - [IAPWS Guidelines](http://www.iapws.org/relguide/fundam.pdf)
-    """
-
-    c["Mv"] = (
-        (
-            1
-            - 2 * Trivia.mixing_ratio_to_specific_content(c["VSMOW_R_2H"])
-            - 2 * Trivia.mixing_ratio_to_specific_content(c["VSMOW_R_3H"])
-            - 1 * Trivia.mixing_ratio_to_specific_content(c["VSMOW_R_17O"])
-            - 1 * Trivia.mixing_ratio_to_specific_content(c["VSMOW_R_18O"])
-        )
-        * (c["M_1H"] * 2 + c["M_16O"])
-        + 2
-        * Trivia.mixing_ratio_to_specific_content(c["VSMOW_R_2H"])
-        * (c["M_2H"] + c["M_1H"] + c["M_16O"])
-        + 2
-        * Trivia.mixing_ratio_to_specific_content(c["VSMOW_R_3H"])
-        * (c["M_3H"] + c["M_1H"] + c["M_16O"])
-        + 1
-        * Trivia.mixing_ratio_to_specific_content(c["VSMOW_R_17O"])
-        * (c["M_1H"] * 2 + c["M_17O"])
-        + 1
-        * Trivia.mixing_ratio_to_specific_content(c["VSMOW_R_18O"])
-        * (c["M_1H"] * 2 + c["M_18O"])
-    )
-
-    c["eps"] = c["Mv"] / c["Md"]
-    c["Rd"] = c["R_str"] / c["Md"]
-    c["Rv"] = c["R_str"] / c["Mv"]
-
-    c["Rd_over_c_pd"] = c["Rd"] / c["c_pd"]
-
-    c["water_molar_volume"] = c["Mv"] / c["rho_w"]
-    c["rho_STP"] = c["p_STP"] / c["Rd"] / c["T_STP"]
-    c["H_u"] = c["M"] / c["p_STP"]
-
+""" 〃 """
 
 W76W_G0 = -2.9912729e3 * si.K**2
+""" [Wexler 1976](https://doi.org/10.6028/jres.080A.071) saturation vapour pressure """
 W76W_G1 = -6.0170128e3 * si.K
+""" 〃 """
 W76W_G2 = 1.887643854e1
+""" 〃 """
 W76W_G3 = -2.8354721e-2 * si.K**-1
+""" 〃 """
 W76W_G4 = 1.7838301e-5 * si.K**-2
+""" 〃 """
 W76W_G5 = -8.4150417e-10 * si.K**-3
+""" 〃 """
 W76W_G6 = 4.4412543e-13 * si.K**-4
+""" 〃 """
 W76W_G7 = 2.858487
+""" 〃 """
 W76W_G8 = 1 * si.Pa
+""" 〃 """
+one_kelvin = 1 * si.K
+""" 〃 """
 
 B80W_G0 = 6.112 * si.hPa
+""" [Bolton 1980](https://doi.org/10.1175/1520-0493(1980)108%3C1046:TCOEPT%3E2.0.CO;2)
+saturation vapour pressure """
 B80W_G1 = 17.67 * si.dimensionless
+""" 〃 """
 B80W_G2 = 243.5 * si.K
+""" 〃 """
 
-one_kelvin = 1 * si.K
+sgm_w = 0.072 * si.joule / si.metre**2
+""" surface tension of water/air interface, value compatible with the kappa-Koehler hygroscopicity
+ parameterisation [Petters & Kreidenweis 2007](https://doi.org/10.5194/acp-7-1961-2007) """
+
+D0 = 2.26e-5 * si.metre**2 / si.second
+""" diffusivity of water vapor in air (Tracy et al. 2010, "Properties of Air", page 22) """
+D_exp = 1.81
+""" 〃 """
+
+K0 = 2.4e-2 * si.joules / si.metres / si.seconds / si.kelvins
+""" thermal conductivity of air (see Tracy et al. 2010, "Properties of Air", page 32) """
+
+c_pd = 1005 * si.joule / si.kilogram / si.kelvin
+""" specific heat at constant pressure of dry air, as in Table 2.1 in
+ [Cotton et al. 2011](https://doi.org/10.1016/S0074-6142(10)09908-0) """
+c_pv = 1850 * si.joule / si.kilogram / si.kelvin
+""" 〃 of water vapour 〃 """
+c_pw = 4218 * si.joule / si.kilogram / si.kelvin
+""" 〃 of liquid water 〃 """
+
+g_std = sci.g * si.metre / si.second**2
+""" standard gravitational acceleration (value from SciPy) """
 
 bulk_phase_partitioning_T_cold = 235 * si.K
+""" [Kaul et al. 2015](https://doi.org/10.1175/MWR-D-14-00319.1) """
 bulk_phase_partitioning_T_warm = 273 * si.K
+""" 〃 """
 bulk_phase_partitioning_exponent = np.nan
-
+""" 〃 """
 
 BOLIN_ISOTOPE_TIMESCALE_COEFF_C1 = np.nan * si.dimensionless
 """
-Coeffitient c1 used in [Bolin 1958](https://https://digitallibrary.un.org/record/3892725)
+Coefficient c1 used in [Bolin 1958](https://https://digitallibrary.un.org/record/3892725)
 for the falling drop evaporation timescale of equilibration with ambient air void of a given
 isotopologue; in the paper timescale is calculated for tritium with assumption of no tritium
 in the environment around the drop (Table 1).
@@ -456,3 +639,48 @@ PICCIOTTO_18O_TO_2H_SLOPE_COEFF = 0.8 * PER_CENT / PER_MILLE
 """
 PICCIOTTO_18O_TO_2H_INTERCEPT_COEFF = -1.8 * PER_CENT
 """〃"""
+
+
+def compute_derived_values(c: dict):
+    """
+    computes derived quantities such as molar mass ratios, etc.
+
+    water molar mass is computed from molecular masses and VSMOW isotope abundances
+    (and neglecting molecular binding energies)
+    for discussion, see:
+    - caption of Table 2.1 in [Gat 2010](https://doi.org/10.1142/p027)
+    - [IAPWS Guidelines](http://www.iapws.org/relguide/fundam.pdf)
+    """
+
+    c["Mv"] = (
+        (
+            1
+            - 2 * Trivia.mixing_ratio_to_specific_content(c["VSMOW_R_2H"])
+            - 2 * Trivia.mixing_ratio_to_specific_content(c["VSMOW_R_3H"])
+            - 1 * Trivia.mixing_ratio_to_specific_content(c["VSMOW_R_17O"])
+            - 1 * Trivia.mixing_ratio_to_specific_content(c["VSMOW_R_18O"])
+        )
+        * (c["M_1H"] * 2 + c["M_16O"])
+        + 2
+        * Trivia.mixing_ratio_to_specific_content(c["VSMOW_R_2H"])
+        * (c["M_2H"] + c["M_1H"] + c["M_16O"])
+        + 2
+        * Trivia.mixing_ratio_to_specific_content(c["VSMOW_R_3H"])
+        * (c["M_3H"] + c["M_1H"] + c["M_16O"])
+        + 1
+        * Trivia.mixing_ratio_to_specific_content(c["VSMOW_R_17O"])
+        * (c["M_1H"] * 2 + c["M_17O"])
+        + 1
+        * Trivia.mixing_ratio_to_specific_content(c["VSMOW_R_18O"])
+        * (c["M_1H"] * 2 + c["M_18O"])
+    )
+
+    c["eps"] = c["Mv"] / c["Md"]
+    c["Rd"] = c["R_str"] / c["Md"]
+    c["Rv"] = c["R_str"] / c["Mv"]
+
+    c["Rd_over_c_pd"] = c["Rd"] / c["c_pd"]
+
+    c["water_molar_volume"] = c["Mv"] / c["rho_w"]
+    c["rho_STP"] = c["p_STP"] / c["Rd"] / c["T_STP"]
+    c["H_u"] = c["M"] / c["p_STP"]

PySDM/physics/terminal_velocity/rogers_yau.py

@@ -1,5 +1,6 @@
 """
-Rogers & Yau "A short course in cloud physics" (equations: 8.5, 8.6, 8.8)
+equations 8.5, 8.6, 8.8 in
+[Rogers & Yau 1989](https://archive.org/details/shortcourseinclo0000roge_m3k2)
 """
 
 import numpy as np

{PySDM-2.97.dist-info → PySDM-2.99.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PySDM
-Version: 2.97
+Version: 2.99
 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,6 +34,8 @@ Provides-Extra: tests
 Requires-Dist: matplotlib ; extra == 'tests'
 Requires-Dist: pytest ; extra == 'tests'
 Requires-Dist: pytest-timeout ; extra == 'tests'
+Requires-Dist: PySDM-examples ; extra == 'tests'
+Requires-Dist: open-atmos-jupyter-utils >=v1.2.0 ; 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.97.dist-info → PySDM-2.99.dist-info}/RECORD

@@ -200,7 +200,7 @@ PySDM/initialisation/spectra/sum.py,sha256=SaxepweOdCozWlUkxCfr6Udo-KjGKWXgrdS0a
 PySDM/initialisation/spectra/top_hat.py,sha256=xmBr_IrctsnguPNgX-jR7JnQnQl1qzIaEyz75fvAJho,563
 PySDM/physics/__init__.py,sha256=4Bm2NhKc7H-a88ObXTFW5sCyb4FK4e9QnwN02tS2yrM,1918
 PySDM/physics/constants.py,sha256=ETbcdk-nhrVtjHidTREjHiUkAemNBNrSBWED3XjCXb8,1333
-PySDM/physics/constants_defaults.py,sha256=W9Nq89n51lcr-_LGAG3Koq5CqBiMuPmNwRisCQHnjF0,15469
+PySDM/physics/constants_defaults.py,sha256=8h28dYy4ziba0wt_lcxztKMrjVuPoiXM98G7X-GZVMs,21237
 PySDM/physics/dimensional_analysis.py,sha256=Zk6ZHq9eTuOxoETgxyvg-0s0Tv4FDYbyFKCRFqVlCU0,790
 PySDM/physics/trivia.py,sha256=gAF0fUKTGFZbt95D2G_MwnDfAgVymGDWMawncKAMOG0,4048
 PySDM/physics/air_dynamic_viscosity/__init__.py,sha256=cLemG7DDSvwWv0mDwotzIUMHdiVhlLP_OrFENOnD8RM,90
@@ -310,7 +310,7 @@ PySDM/physics/surface_tension/szyszkowski_langmuir.py,sha256=Jng8wErWKhnrliltn1b
 PySDM/physics/terminal_velocity/__init__.py,sha256=LyYiG6t2CM9zIYW1SPGEeZFH0cPdQqbndBT573z7YdA,153
 PySDM/physics/terminal_velocity/gunn_kinzer_1949.py,sha256=qMd7hyE4Ahva7sw58xuzu9yz9wxzXv1xReh2TEY0w9Y,204
 PySDM/physics/terminal_velocity/power_series.py,sha256=TBseiVJcLJdkkK7JnRk7XDP6dKB0v153eoVtgBPL3qc,136
-PySDM/physics/terminal_velocity/rogers_yau.py,sha256=JkUSWnJ8IE_NHkBCp1HrJjnMCOPWkGYp056X2s56-LE,658
+PySDM/physics/terminal_velocity/rogers_yau.py,sha256=-zhBjqo_47DLvnq3wjzHBtCyb6-gNX1z7JhYCENPgL8,690
 PySDM/physics/ventilation/__init__.py,sha256=I3KbAm0iWX3rNaMvLtoIoxviK-FGdXXnZDfAMhgPVYs,181
 PySDM/physics/ventilation/froessling_1938.py,sha256=wC4-Ideeiugav1dswuKbsyvYAj64pNKJcVB_WW90NiU,414
 PySDM/physics/ventilation/neglect.py,sha256=QeTBWlGQQvgQ8qHyaMzCrJ5RSW25HkowTmJg2-ykDu8,330
@@ -387,8 +387,8 @@ PySDM/products/size_spectral/size_standard_deviation.py,sha256=3ee3Wk4XYchMSwH-m
 PySDM/products/size_spectral/total_particle_concentration.py,sha256=K7sO2jgUpYOwWvBK3jXp9KUxLRXk_Ve6ooOdY5q5jd0,470
 PySDM/products/size_spectral/total_particle_specific_concentration.py,sha256=isLZt5j2vJGr-FrzYFcUNPHZqMKhOtl51za1Hogh6hQ,476
 PySDM/products/size_spectral/water_mixing_ratio.py,sha256=PP54hfMy4SPDQDJgV4RNzVP03lmL1THZPa2KXrdgoQ4,1324
-PySDM-2.97.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-PySDM-2.97.dist-info/METADATA,sha256=u2LPAy2kb-JI18oU4u26yDeARcRiAK7srZC7pj-pos4,17010
-PySDM-2.97.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
-PySDM-2.97.dist-info/top_level.txt,sha256=6NYaDAhUnaYMD7ebD_dQ7HlhiJS7NMuKEXb0ck7Wcsg,6
-PySDM-2.97.dist-info/RECORD,,
+PySDM-2.99.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+PySDM-2.99.dist-info/METADATA,sha256=R8CWU986eVvIv3o9TLTRxtfG7UK5qpwMvXhK3vLKiCk,17127
+PySDM-2.99.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
+PySDM-2.99.dist-info/top_level.txt,sha256=6NYaDAhUnaYMD7ebD_dQ7HlhiJS7NMuKEXb0ck7Wcsg,6
+PySDM-2.99.dist-info/RECORD,,