[NDSL] QSat port

GEOSagcm_GridComp/GEOSphysics_GridComp/GEOSmoist_GridComp/pyMoist/.pre-commit-config.yaml

@@ -62,4 +62,4 @@ repos:
       args: [
         "--exclude=docs",
         "--ignore=W503,E302,E203,F841,F401",
-        "--max-line-length=88",]
+        "--max-line-length=100",]

GEOSagcm_GridComp/GEOSphysics_GridComp/GEOSmoist_GridComp/pyMoist/pyMoist/saturation/README.md

@@ -0,0 +1,32 @@
+# Saturation formulations
+
+## In Fortran
+
+### GEOS_QSatX
+
+The code lists 3 ways, with each a specific set of formulation.
+
+- `GEOS_QsatLqu` & `GEOS_QsatIce`:
+    - Latest code, carrying for every subsequent code the "exact" formulations for the different saturations schemes
+    - Can run with in exact mode or in table mode
+- `Qsat` & `DQsat` are the "traditional" called, which are flagged as deprecated in docs but still in use
+    - Can run in exact mode (and ping back to GEOS_QSatLqu/Ice) or in table mode
+
+The table (ESINIT) is a constant computation that leverages the GEOS_QsatLqu/GEOS_QSatIce to freeze results in increment
+of 0.1 Pa (per documenttion)
+
+A lot of the complexity of the code is due to micro-optimization to re-use inlined code instead of using function calls.
+
+### MAPL_EQSatX
+
+TBD
+
+## Our implementation
+
+### Estimated Saturation Table
+
+:warning: This inplements the GEOS_QSatX only
+
+The class `SaturationVaporPressureTable` in `table.py` computes on-demand the table of estimated saturation based on 0.1 Pa
+increments. The `get_table` function in conjection with the `SaturationFormulation` in `fomulation.py` returns the correct table
+to be sampled across a few fields.

GEOSagcm_GridComp/GEOSphysics_GridComp/GEOSmoist_GridComp/pyMoist/pyMoist/saturation/__init__.py

@@ -0,0 +1,2 @@
+from .qsat import QSat, QSat_Float, QSat_Float_Ice, QSat_Float_Liquid, QSat_FloatField
+from .types import SaturationFormulation, TableMethod

GEOSagcm_GridComp/GEOSphysics_GridComp/GEOSmoist_GridComp/pyMoist/pyMoist/saturation/constants.py

@@ -0,0 +1,22 @@
+import numpy as np
+
+from ndsl.dsl.typing import Float
+
+
+# Generic constants to be moved to pyMoist global constant file
+MAPL_TICE = Float(273.16)  # K
+MAPL_AIRMW = Float(28.965)
+MAPL_H2OMW = Float(18.015)  # kg/Kmole
+
+# Saturation specific constants
+TMINTBL = Float(150.0)
+TMAXTBL = Float(333.0)
+TMINLQU = MAPL_TICE - Float(40.0)
+DEGSUBS = np.int32(100)
+DELTA_T = Float(1.0 / DEGSUBS)
+TABLESIZE = np.int32(TMAXTBL - TMINTBL) * DEGSUBS + 1
+TMIX = Float(-20.0)
+ESFAC = MAPL_H2OMW / MAPL_AIRMW
+ERFAC = DEGSUBS / ESFAC
+
+MAX_MIXING_RATIO = Float(1.0)