Merge branch 'VMD' of https://github.com/ElmiraShamlou/watertap into VMD

docs/conf.py

@@ -35,9 +35,9 @@
 author = "NAWI"
 
 # The full version, including alpha/beta/rc tags
-release = "1.2.dev0"
+release = "1.3.dev0"
 # The short X.Y version
-version = "1.2.dev0"
+version = "1.3.dev0"
 # -- General configuration ---------------------------------------------------
 
 

docs/how_to_guides/how_to_use_debugging_solver_wrapper.rst

@@ -21,7 +21,7 @@ In a python module containing the model and script to solve that model, the user
 
 .. testcode::
 
-    from watertap.core.util.model_debug_mode import activate
+    from watertap_solvers.model_debug_mode import activate
     activate()
 
 

docs/technical_reference/unit_models/index.rst

@@ -33,6 +33,7 @@ Unit Models
    pump
    reverse_osmosis_0D
    reverse_osmosis_1D
+   steam_ejector
    stoichiometric_reactor
    thickener
    translators/index

docs/technical_reference/unit_models/steam_ejector.rst

@@ -0,0 +1,76 @@
+Steam Jet Ejector
+================================
+This Steam Jet Ejector unit model:
+   * Simulates the performance of a steam jet ejector for thermal vapor compression.
+   * Uses semi-empirical correlations for entrainment ratio, pressure correction factor (PCF), and temperature correction factor (TCF), based on El-Dessouky (1997).
+   * Operates in steady-state only.
+   * Assumes the discharge mixture pressure equals its saturation pressure.
+
+.. index::
+   pair: watertap.unit_models.steam_ejector;steam_ejector
+
+.. currentmodule:: watertap.unit_models.steam_ejector
+
+Degrees of Freedom
+-------------------
+In addition to the inlet state variables (i.e., temperature, pressure, and component flowrates for motive steam and entrained vapor), the Steam Ejector model has at least 1 degree of freedom that must be fixed for the unit to be fully specified. Typically, the following variables are fixed:
+
+    * Entrainment ratio
+    * Compression ratio
+
+Model Structure
+------------------
+This Steam Ejector model consists of state blocks for the properties of the motive steam inlet, entrained vapor inlet, and discharge mixture. It incorporates semi-empirical equations to model key performance parameters.
+
+
+
+Sets
+----
+.. csv-table::
+   :header: "Description", "Symbol", "Indices"
+
+   "Time", ":math:`t`", "[0]"
+   "Inlet/Outlet", ":math:`x`", "['in', 'out']"
+   "Phases", ":math:`p`", "['Liq', 'Vap']"
+   "Components", ":math:`j`", "['H2O']"
+
+Performance Metrics
+--------------------
+.. csv-table::
+   :header: "Metric", "Equation"
+
+   "Entrainment Ratio", ":math:`Ra = \frac{\dot{m}_{motive}}{\dot{m}_{entrained}}`"
+   "Compression Ratio", ":math:`CR = \frac{P_s}{P_{ev}}`"
+
+Variables
+----------
+.. csv-table::
+   :header: "Description", "Symbol", "Variable Name", "Units", "Bounds"
+
+   "Entrainment Ratio", ":math:`Ra`", "entrainment_ratio", "Dimensionless", "<4"
+   "Compression Ratio", ":math:`CR`", "compression_ratio", "Dimensionless", ">1.89"
+   "Pressure Correction Factor", ":math:`PCF`", "PCF", "Dimensionless", "N/A"
+   "Temperature Correction Factor", ":math:`TCF`", "TCF", "Dimensionless", "N/A"
+   "Motive Steam Pressure", ":math:`P_m`", "properties_motive_steam[0].pressure", "kPa", "[100, 3500]"
+   "Entrained Vapor Pressure", ":math:`P_{ev}`", "properties_entrained_vapor[0].pressure", "kPa", "N/A"
+   "Discharge Mixture Pressure", ":math:`P_s`", "properties_discharge_mix[0].pressure", "kPa", "N/A"
+
+Equations
+---------
+.. csv-table::
+   :header: "Description", "Equation"
+
+   "Pressure Correction Factor", ":math:`PCF = 3 \times 10^{-7} P_m^2 - 0.0009 P_m + 1.6101`"
+   "Temperature Correction Factor", ":math:`TCF = 2 \times 10^{-8} T_{ev}^2 - 0.0006 T_{ev} + 1.0047`"
+   "Entrainment Ratio Model", ":math:`Ra \times TCF = 0.296 \frac{P_s^{1.19}}{P_{ev}^{1.04}} \left(\frac{P_m}{P_{ev}}\right)^{0.015} PCF`"
+   "Entrainment Ratio Definition", ":math:`Ra = \frac{\dot{m}_{motive}}{\dot{m}_{entrained}}`"
+   "Compression Ratio", ":math:`CR = \frac{P_s}{P_{ev}}`"
+
+
+Class Documentation
+-------------------
+* :mod:`watertap.unit_models.steam_ejector`
+
+References
+----------
+El-Dessouky, H., Modeling and simulation of thermal vapor compression desalination plant. Symposium on Desalination of Seawater with Nuclear Energy, Taejon, Republic of Korea, 26-30 May, 1997.

setup.py

@@ -27,7 +27,7 @@
 setup(
     name="watertap",
     url="https://github.com/watertap-org/watertap",
-    version="1.2.dev0",
+    version="1.3.dev0",
     description="WaterTAP modeling library",
     long_description=long_description,
     long_description_content_type="text/markdown",
@@ -64,11 +64,12 @@
     packages=find_packages(
         include=("watertap*",),
     ),
-    python_requires=">=3.8",
+    python_requires=">=3.9",
     install_requires=[
         # primary requirements for unit and property models
         "idaes-pse >=2.7.0,<2.8.0rc0",
         "pyomo>=6.6.1",
+        "watertap-solvers",
         "pyyaml",  # watertap.core.wt_database
         # for parameter_sweep
         "parameter-sweep >=0.1.0",

watertap/__init__.py

@@ -9,10 +9,3 @@
 # information, respectively. These files are also available online at the URL
 # "https://github.com/watertap-org/watertap/"
 #################################################################################
-import pathlib
-
-_ROOT = pathlib.Path(__file__).parent.absolute()
-
-# create the ipopt-watertap solver and register
-# it as the default IDAES solver
-import watertap.core.plugins