Added model/atmosphere/subgrid_scale_physics/muphys Microphysics

model/atmosphere/subgrid_scale_physics/muphys/LICENSE

@@ -0,0 +1,31 @@
+  ICON4Py - ICON inspired code in Python and GT4Py
+
+  Copyright (c) 2022-2024, ETH Zurich and MeteoSwiss
+  All rights reserved.
+
+  Redistribution and use in source and binary forms, with or without
+  modification, are permitted provided that the following conditions are
+  met:
+
+  1. Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+
+  2. Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
+
+  3. Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+  HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

model/atmosphere/subgrid_scale_physics/muphys/README.md

@@ -0,0 +1,9 @@
+# icon4py-atmosphere-physics-muphys
+
+## Description
+
+Port of the 1-moment 'muphys' microphysics scheme of Bjorn Stevens to gt4py.
+
+## Installation instructions
+
+Check the `README.md` at the root of the `model` folder for installation instructions.

model/atmosphere/subgrid_scale_physics/muphys/pyproject.toml

@@ -0,0 +1,139 @@
+[build-system]
+build-backend = "setuptools.build_meta"
+requires = ["setuptools>=61.0", "wheel>=0.40.0"]
+
+[project]
+authors = [
+  {email = "[email protected]"},
+  {name = "ETH Zurich"}
+]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Science/Research",
+  "License :: OSI Approved :: BSD License",
+  "Operating System :: POSIX",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Topic :: Scientific/Engineering :: Atmospheric Science",
+  "Topic :: Scientific/Engineering :: Mathematics",
+  "Topic :: Scientific/Engineering :: Physics"
+]
+dependencies = [
+  "gt4py>=1.0.1",
+  "icon4py-common>=0.0.6"
+]
+description = "ICON subgrid scale muphys parameterization."
+dynamic = ['version']
+license = {file = "LICENSE"}
+name = "icon4py-atmosphere-muphys"
+readme = "README.md"
+requires-python = ">=3.10"
+
+[project.urls]
+repository = "https://github.com/C2SM/icon4py"
+
+[tool.coverage]
+
+[tool.coverage.html]
+directory = 'tests/_reports/coverage_html'
+
+[tool.coverage.paths]
+source = ['src/icon4py/model/']
+
+[tool.coverage.report]
+exclude_lines = [
+  'raise AssertionError',  # Don't complain if tests don't hit defensive assertion code
+  'raise NotImplementedError',  # Don't complain if tests don't hit defensive assertion code
+  'if 0:',  # Don't complain if non-runnable code isn't run
+  'if __name__ == .__main__.:'  # Don't complain if non-runnable code isn't run
+]
+ignore_errors = true
+
+[tool.coverage.run]
+branch = true
+parallel = true
+source_pkgs = ['muphys']
+
+[tool.mypy]
+disallow_incomplete_defs = true
+disallow_untyped_defs = true
+exclude = [
+  '^tests/*.py'
+]
+ignore_missing_imports = false
+implicit_reexport = true
+install_types = true
+non_interactive = true
+show_column_numbers = true
+show_error_codes = true
+warn_redundant_casts = true
+warn_unused_configs = true
+warn_unused_ignores = true
+
+[tool.pytest]
+
+[tool.pytest.ini_options]
+addopts = ['-p icon4py.model.testing.pytest_config']
+testpaths = 'tests'
+
+[tool.ruff]
+extend-exclude = [
+  '.eggs',
+  '.gt_cache',
+  '.ipynb_checkpoints',
+  '.tox',
+  '_local_',
+  'build',
+  'dist',
+  'docs',
+  '_external_src',
+  'tests/_disabled',
+  'setup.py'
+]
+indent-width = 4
+line-length = 100
+respect-gitignore = true
+show-fixes = true
+# Assume Python 3.10
+target-version = "py310"
+
+[tool.ruff.format]
+docstring-code-format = true
+
+[tool.ruff.lint]
+extend-select = ['E', 'F', 'I', 'B', 'A', 'T10', 'ERA', 'NPY', 'RUF']
+# # Rules sets:
+# E: pycodestyle
+# F: Pyflakes
+# I: isort
+# B: flake8-bugbear
+# A: flake8-builtins
+# T10: flake8-debugger
+# ERA: eradicate
+# NPY: NumPy-specific rules
+# RUF: Ruff-specific rules
+ignore = [
+  'E501',  # Line too long (using Bugbear's B950 warning)
+  'RUF009'  # Do not perform function call in dataclass defaults
+]
+ignore-init-module-imports = true
+
+[tool.ruff.lint.isort]
+combine-as-imports = true
+known-first-party = ['icon4py.model']
+known-third-party = [
+  'gt4py'
+]
+lines-after-imports = 2
+
+[tool.ruff.lint.mccabe]
+max-complexity = 15
+
+[tool.setuptools.dynamic]
+version = {attr = 'icon4py.model.atmosphere.subgrid_scale_physics.muphys.__init__.__version__'}
+
+[tool.setuptools.package-data]
+'icon4py.model.atmosphere.subgrid_scale_physics.muphys' = ['py.typed']

model/atmosphere/subgrid_scale_physics/muphys/requirements-dev.txt

@@ -0,0 +1,3 @@
+-r ../../../../base-requirements-dev.txt
+-e ../../../common
+-e .

model/atmosphere/subgrid_scale_physics/muphys/requirements.txt

@@ -0,0 +1,3 @@
+-r ../../../../base-requirements.txt
+../../../common
+.

model/atmosphere/subgrid_scale_physics/muphys/src/icon4py/model/atmosphere/subgrid_scale_physics/muphys/__init__.py

@@ -0,0 +1,30 @@
+# ICON4Py - ICON inspired code in Python and GT4Py
+#
+# Copyright (c) 2022-2024, ETH Zurich and MeteoSwiss
+# All rights reserved.
+#
+# Please, refer to the LICENSE file in the root directory.
+# SPDX-License-Identifier: BSD-3-Clause
+
+
+from typing import Final
+
+from packaging import version as pkg_version
+
+
+__all__ = [
+    "__author__",
+    "__copyright__",
+    "__license__",
+    "__version__",
+    "__version_info__",
+]
+
+
+__author__: Final = "ETH Zurich,  MeteoSwiss and individual contributors"
+__copyright__: Final = "Copyright (c) 2022-2024 ETH Zurich and MeteoSwiss"
+__license__: Final = "BSD-3-Clause"
+
+
+__version__: Final = "0.0.6"
+__version_info__: Final = pkg_version.parse(__version__)

model/atmosphere/subgrid_scale_physics/muphys/src/icon4py/model/atmosphere/subgrid_scale_physics/muphys/core/common/constants.py

@@ -0,0 +1,102 @@
+class thermodyn:
+    # Thermodynamic constants for the dry and moist atmosphere
+
+    # Dry air
+    rd = 287.04      # [J/K/kg] gas constant
+    cpd = 1004.64    # [J/K/kg] specific heat at constant pressure
+    cvd = cpd - rd   # [J/K/kg] specific heat at constant volume
+    con_m = 1.50E-5  # [m^2/s]  kinematic viscosity of dry air
+    con_h = 2.20E-5  # [m^2/s]  scalar conductivity of dry air
+    con0_h = 2.40e-2 # [J/m/s/K] thermal conductivity of dry air
+    eta0d = 1.717e-5 # [N*s/m2] dyn viscosity of dry air at tmelt
+
+    # H2O
+    # gas
+    rv = 461.51      # [J/K/kg] gas constant for water vapor
+    cpv = 1869.46    # [J/K/kg] specific heat at constant pressure
+    cvv = cpv - rv   # [J/K/kg] specific heat at constant volume
+    dv0 = 2.22e-5    # [m^2/s]  diff coeff of H2O vapor in dry air at tmelt
+    # liquid / water
+    rhoh2o = 1000.0  # [kg/m3]  density of liquid water
+    # solid / ice
+    rhoice = 916.7   # [kg/m3]  density of pure ice
+
+    cv_i = 2000.0
+
+    # phase changes
+    alv = 2.5008e6   # [J/kg]   latent heat for vaporisation
+    als = 2.8345e6   # [J/kg]   latent heat for sublimation
+    alf = als - alv   # [J/kg]   latent heat for fusion
+    tmelt = 273.15    # [K]      melting temperature of ice/snow
+    t3 = 273.16       # [K]      Triple point of water at 611hPa
+
+    # Auxiliary constants
+    rdv = rd / rv                                # [ ]
+    vtmpc1 = rv / rd - 1.0                       # [ ]
+    vtmpc2 = cpv / cpd - 1.0                     # [ ]
+    rcpv = cpd / cpv - 1.0                       # [ ]
+    alvdcp = alv / cpd                           # [K]
+    alsdcp = als / cpd                           # [K]
+    rcpd = 1.0 / cpd                             # [K*kg/J]
+    rcvd = 1.0 / cvd                             # [K*kg/J]
+    rcpl = 3.1733                                # cp_d / cp_l - 1
+
+    clw = (rcpl + 1.0) * cpd                     # specific heat capacity of liquid water
+    cv_v = (rcpv + 1.0) * cpd - rv
+
+class graupel_ct:
+    rho_00 = 1.225  # reference air density
+    q1 = 8.e-6
+    qmin = 1.0e-15  # threshold for computation
+    ams = 0.069  # Formfactor in the mass-size relation of snow particles
+    bms = 2.0  # Exponent in the mass-size relation of snow particles
+    v0s = 25.0  # prefactor in snow fall speed
+    v1s = 0.5  # Exponent in the terminal velocity for snow
+    m0_ice = 1.0e-12  # initial crystal mass for cloud ice nucleation
+    ci = 2108.0  # specific heat of ice
+    tx = 3339.5
+    tfrz_het1 = thermodyn.tmelt - 6.0  # temperature for het. freezing of cloud water with supersat
+    tfrz_het2 = thermodyn.tmelt - 25.0  # temperature for het. freezing of cloud water
+    tfrz_hom = thermodyn.tmelt - 37.0  # temperature for hom. freezing of cloud water
+    lvc = thermodyn.alv - (thermodyn.cpv - thermodyn.clw) * thermodyn.tmelt  # invariant part of vaporization enthalpy
+    lsc = thermodyn.als - (thermodyn.cpv - ci) * thermodyn.tmelt  # invariant part of vaporization enthalpy
+
+class idx:
+    nx = 6  # number of water species
+    np = 4  # number of precipitating water species
+    lqr = 0  # index for rain
+    lqi = 1  # index for ice
+    lqs = 2  # index for snow
+    lqg = 3  # index for graupel
+    lqc = 4  # index for cloud
+    lqv = 5  # index for vapor
+
+    qx_ind = [lqv, lqc, lqr, lqs, lqi, lqg]
+    qp_ind = [lqr, lqi, lqs, lqg]
+
+    lrain = True  # switch for disabling rain
+    lcold = True  # switch for disabling freezing processes
+
+    prefactor_r  = 14.58
+    exponent_r   =  0.111
+    offset_r     =  1.0e-12
+    prefactor_i  =  1.25
+    exponent_i   =  0.160
+    offset_i     =  1.0e-12
+    prefactor_s  = 57.80
+    exponent_s   =  0.5
+    offset_s     =  1.0e-12
+    prefactor_g  = 12.24
+    exponent_g   =  0.217
+    offset_g     =  1.0e-08
+
+    params = [
+    [14.58, 0.111, 1.0e-12],
+    [1.25, 0.160, 1.0e-12],
+    [57.80, 0.5 / 3.0, 1.0e-12],
+    [12.24, 0.217, 1.0e-08]
+    ]
+
+    cloud_num = 200.00e+06  # cloud droplet number concentration (from gscp_data.f90)
+
+    ZERO = 0.0