exerpy 0.0.1__py3-none-any.whl

exerpy/parser/from_ebsilon/ebsilon_functions.py

@@ -0,0 +1,181 @@
+import logging
+from typing import Any
+from typing import Optional
+
+from CoolProp.CoolProp import PropsSI as CP
+
+from . import __ebsilon_available__
+from .utils import EpGasTableStub
+from .utils import EpSteamTableStub
+from .utils import require_ebsilon
+
+# Import Ebsilon classes if available
+if __ebsilon_available__:
+    from EbsOpen import EpGasTable
+    from EbsOpen import EpSteamTable
+else:
+    EpSteamTable = EpSteamTableStub
+    EpGasTable = EpGasTableStub
+
+from exerpy.functions import convert_to_SI
+
+from .ebsilon_config import substance_mapping
+from .ebsilon_config import unit_id_to_string
+
+
+@require_ebsilon
+def calc_X_from_PT(app: Any, pipe: Any, property: str, pressure: float, temperature: float) -> Optional[float]:
+    """
+    Calculate a thermodynamic property (enthalpy or entropy) for a given stream based on pressure and temperature.
+
+    This method takes pressure and temperature values and calculates the specified property for any fluid stream.
+    It automatically handles the composition of the stream by setting up appropriate fluid properties and analysis
+    parameters based on the stream's fluid type and composition.
+
+    Parameters
+    ----------
+    app : Ebsilon application instance
+        The Ebsilon application used for creating fluid and analysis objects.
+    pipe : Stream object
+        The stream object containing fluid and composition information.
+    property : str
+        The thermodynamic property to calculate, either 'H' for enthalpy or 'S' for entropy.
+    pressure : float
+        The pressure value (in bar).
+    temperature : float
+        The temperature value (in °C).
+
+    Returns
+    -------
+    float
+        The calculated value of the specified property (in J/kg for enthalpy, J/kgK for entropy).
+        Returns None if an invalid property is specified or an error occurs during calculation.
+
+    Raises
+    ------
+    Exception
+        Logs an error and returns None if any exception occurs during property calculation.
+    """
+
+    # Create a new FluidData object
+    fd = app.NewFluidData()
+
+    # Retrieve the fluid type from the stream
+    fd.FluidType = (pipe.Kind-1000)
+
+    if fd.FluidType == 3 or fd.FluidType == 4:  # steam or water
+            t_sat = CP('T', 'P', pressure, 'Q', 0, 'water')
+            if temperature > t_sat:
+                fd.FluidType = 3  # steam
+                fd.SteamTable = EpSteamTable.epSteamTableFromSuperiorModel
+                fdAnalysis = app.NewFluidAnalysis()
+            else:
+                fd.FluidType == 4  # water
+                fdAnalysis = app.NewFluidAnalysis()
+
+    elif fd.FluidType == 15:  # 2PhaseLiquid
+        fd.Medium = pipe.FMED.Value
+        fdAnalysis = app.NewFluidAnalysis()
+
+    elif fd.FluidType == 16:  # 2PhaseGaseous
+        fd.Medium = pipe.FMED.Value
+        fdAnalysis = app.NewFluidAnalysis()
+
+    elif fd.FluidType == 17:  # Salt water
+        fd.Medium = pipe.FMED.Value
+        fdAnalysis = app.NewFluidAnalysis()
+
+    else:  # flue gas, air etc.
+        fd.GasTable = EpGasTable.epGasTableFromSuperiorModel
+
+        # Set up the fluid analysis based on stream composition
+        fdAnalysis = app.NewFluidAnalysis()
+
+        # Iterate through the substance_mapping and get the corresponding value from the pipe
+        for substance_key, ep_substance_id in substance_mapping.items():
+            fraction = getattr(pipe, substance_key).Value  # Dynamically access the fraction
+            if fraction > 0:  # Only set substances with non-zero fractions
+                fdAnalysis.SetSubstance(ep_substance_id, fraction)
+
+    # Set the analysis in the FluidData object
+    fd.SetAnalysis(fdAnalysis)
+
+    # Validate property input
+    if property not in ['S', 'H']:
+        logging.error('Invalid property selected. You can choose between "H" (enthalpy) and "S" (entropy).')
+        return None
+
+    try:
+        # Calculate the property based on the input property type
+        if property == 'S':  # Entropy
+            res = fd.PropertyS_OF_PT(pressure * 1e-5, temperature - 273.15)  # Ebsilon works with °C and bar
+            res_SI = res * 1e3  # Convert kJ/kgK to J/kgK
+        elif property == 'H':  # Enthalpy
+            res = fd.PropertyH_OF_PT(pressure * 1e-5, temperature - 273.15)  # Ebsilon works with °C and bar
+            res_SI = res * 1e3  # Convert kJ/kg to J/kg
+
+        return res_SI
+
+    except Exception as e:
+        logging.error(f"An error occurred during property calculation: {e}")
+        return None
+
+
+@require_ebsilon
+def calc_eT(app: Any, pipe: Any, pressure: float, Tamb: float, pamb: float) -> float:
+    """
+    Calculate the thermal component of physical exergy.
+
+    Parameters
+    ----------
+    app : Ebsilon application instance
+        The Ebsilon application instance.
+    pipe : Stream object
+        The stream object containing thermodynamic properties.
+    pressure : float
+        The pressure value (in bar).
+    Tamb : float
+        The ambient temperature (in K).
+    pamb : float
+        The ambient pressure (in Pa).
+
+    Returns
+    -------
+    float
+        The thermal exergy component (in J/kg).
+    """
+    h_i = convert_to_SI('h', pipe.H.Value, unit_id_to_string.get(pipe.H.Dimension, "Unknown"))  # in SI unit [J / kg]
+    s_i = convert_to_SI('s', pipe.S.Value, unit_id_to_string.get(pipe.S.Dimension, "Unknown"))  # in SI unit [J / kgK]
+    h_A = calc_X_from_PT(app, pipe, 'H', pressure, Tamb)  # in SI unit [J / kg]
+    s_A = calc_X_from_PT(app, pipe, 'S', pressure, Tamb)  # in SI unit [J / kgK]
+    eT = h_i - h_A - Tamb * (s_i - s_A)  # in SI unit [J / kg]
+
+    return eT
+
+
+@require_ebsilon
+def calc_eM(app: Any, pipe: Any, pressure: float, Tamb: float, pamb: float) -> float:
+    """
+    Calculate the mechanical component of physical exergy.
+
+    Parameters
+    ----------
+    app : Ebsilon application instance
+        The Ebsilon application instance.
+    pipe : Stream object
+        The stream object containing thermodynamic properties.
+    pressure : float
+        The pressure value (in bar).
+    Tamb : float
+        The ambient temperature (in K).
+    pamb : float
+        The ambient pressure (in Pa).
+
+    Returns
+    -------
+    float
+        The mechanical exergy component (in J/kg).
+    """
+    eM = convert_to_SI('e', pipe.E.Value, unit_id_to_string.get(pipe.E.Dimension, "Unknown")) - calc_eT(app, pipe, pressure, Tamb, pamb)
+
+    return eM