update docstrings, add doc section for tabel data

Author: drunsinn

docs/source/index.rst

@@ -9,6 +9,7 @@
    README.md
    pyXSteam
    pyXSteamDemo
+   pyXSteamTables
 
 .. automodule:: pyXSteam.XSteam
    :noindex:

docs/source/pyXSteam.rst

@@ -73,6 +73,22 @@ pyXSteam.IAPWS_R4 module
     :undoc-members:
     :show-inheritance:
 
+pyXSteam.IAPWS_R6 module
+-----------------------------------
+
+.. automodule:: pyXSteam.IAPWS_R6
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pyXSteam.IAPWS_R12 module
+-----------------------------------
+
+.. automodule:: pyXSteam.IAPWS_R12
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 pyXSteam.IAPWS_R14 module
 -----------------------------------
 
@@ -81,6 +97,14 @@ pyXSteam.IAPWS_R14 module
     :undoc-members:
     :show-inheritance:
 
+pyXSteam.IAPWS_R15 module
+-----------------------------------
+
+.. automodule:: pyXSteam.IAPWS_R15
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 Module contents
 ---------------
 

docs/source/pyXSteamTables.rst

@@ -0,0 +1,10 @@
+IAWPS Tabels submodule
+======================
+
+pyXSteam.tables module
+----------------------
+
+.. automodule:: pyXSteam.tables
+    :members: R1_76, R5_85, R6_95, R7_97, R12_08, R14_08, R15_11, SR1_86, SR2_01, SR3_03, SR4_04, SR5_05
+    :undoc-members:
+    :show-inheritance:

pyXSteam/IAPWS_R14.py

@@ -47,7 +47,8 @@ def pmelt_T_iceIII(T: float) -> float:
 
 def Tmelt_p_iceIII(p: float) -> float:
     """inverse of `pmelt_T_iceIII`
-    :param T: melting preasure in [MPa]
+
+    :param p: melting preasure in [MPa]
 
     :return: temperature in [K]
     """
@@ -74,7 +75,8 @@ def pmelt_T_iceV(T: float) -> float:
 
 def Tmelt_p_iceV(p: float) -> float:
     """inversee of `pmelt_T_iceV`
-    :param T: melting preasure in [MPa]
+
+    :param p: melting preasure in [MPa]
 
     :return: temperature in [K]
     """
@@ -100,7 +102,8 @@ def pmelt_T_iceVI(T: float) -> float:
 
 def Tmelt_p_iceVI(p: float) -> float:
     """inversee of `pmelt_T_iceVI`
-    :param T: melting preasure in [MPa]
+
+    :param p: melting preasure in [MPa]
 
     :return: temperature in [K]
     """

pyXSteam/Regions.py

@@ -345,13 +345,18 @@ def v2_pT(cls, p: float, T: float) -> float:
         return _R * T / p * Pi * (g0_pi + gr_pi) / 1000  # see table 12
 
     @staticmethod
-    def v2_pT_meta(p, T):
+    def v2_pT_meta(p: float, T: float) -> float:
         """
         6 Equations for Region 2, Section. 6.2 Supplementary Equation for the Metastable-Vapor Region
 
         Table 16, Page 18
 
         specific volume
+
+        :param p: preasure in [MPa]
+        :param T: temperature in [K]
+
+        :return: specific volume in [m³ / kg]
         """
         Pi = p  # Eq 1
         tau = 540 / T  # Eq 1
@@ -367,7 +372,7 @@ def v2_pT_meta(p, T):
         return _R * T / p * Pi * (g0_pi + gr_pi) / 1000  # see table 12
 
     @staticmethod
-    def h2_pT(p, T):
+    def h2_pT(p: float, T: float) -> float:
         """function h2_pT = h2_pT(p, T)
 
         6 Equations for Region 2, Section. 6.1 Basic Equation
@@ -393,13 +398,18 @@ def h2_pT(p, T):
         return _R * T * tau * (g0_tau + gr_tau)
 
     @staticmethod
-    def h2_pT_meta(p, T):
+    def h2_pT_meta(p: float, T: float) -> float:
         """
         6 Equations for Region 2, Section. 6.2 Supplementary Equation for the Metastable-Vapor Region
 
         Table 16, Page 18
 
         specific volume
+
+        :param p: preasure in [MPa]
+        :param T: temperature in [K]
+
+        :return: enthalpy in [kJ / kg]
         """
         Pi = p  # Eq 1
         tau = 540 / T  # Eq 1
@@ -417,7 +427,7 @@ def h2_pT_meta(p, T):
         return _R * T * tau * (g0_tau + gr_tau)  # h2_pT
 
     @staticmethod
-    def u2_pT(p, T):
+    def u2_pT(p: float, T: float) -> float:
         """function u2_pT = u2_pT(p, T)
 
         6 Equations for Region 2, Section. 6.1 Basic Equation
@@ -426,6 +436,7 @@ def u2_pT(p, T):
 
         :param p: preasure in [MPa]
         :param T: temperature in [K]
+
         :return: specific internal energy in [kJ / kg]
         """
         Pi = p
@@ -446,13 +457,18 @@ def u2_pT(p, T):
         return _R * T * (tau * (g0_tau + gr_tau) - Pi * (g0_pi + gr_pi))
 
     @staticmethod
-    def u2_pT_meta(p, T):
+    def u2_pT_meta(p: float, T: float) -> float:
         """
         6 Equations for Region 2, Section. 6.2 Supplementary Equation for the Metastable-Vapor Region
 
         Table 16, Page 18
 
         specific volume
+
+        :param p: preasure in [MPa]
+        :param T: temperature in [K]
+
+        :return: specific internal energy in [kJ / kg]
         """
         Pi = p  # Eq 1
         tau = 540 / T  # Eq 1
@@ -478,7 +494,7 @@ def u2_pT_meta(p, T):
         return _R * T * (tau * (g0_tau + gr_tau) - Pi * (g0_pi + gr_pi))  # u2_pT
 
     @staticmethod
-    def s2_pT(p, T):
+    def s2_pT(p: float, T: float) -> float:
         """function s2_pT = s2_pT(p, T)
 
         6 Equations for Region 2, Section. 6.1 Basic Equation
@@ -508,13 +524,18 @@ def s2_pT(p, T):
         return _R * (tau * (g0_tau + gr_tau) - (g0 + gr))
 
     @staticmethod
-    def s2_pT_meta(p, T):
+    def s2_pT_meta(p: float, T: float) -> float:
         """
         6 Equations for Region 2, Section. 6.2 Supplementary Equation for the Metastable-Vapor Region
 
         Table 16, Page 18
 
         specific volume
+
+        :param p: preasure in [MPa]
+        :param T: temperature in [K]
+
+        :return: specific entropy in [kJ / (kg K)]
         """
         Pi = p  # Eq 1
         tau = 540 / T  # Eq 1
@@ -542,7 +563,7 @@ def s2_pT_meta(p, T):
         return _R * (tau * (g0_tau + gr_tau) - (g0 + gr))  # s2_pT
 
     @staticmethod
-    def Cp2_pT(p, T):
+    def Cp2_pT(p: float, T: float) -> float:
         """function Cp2_pT = Cp2_pT(p, T)
 
         6 Equations for Region 2, Section. 6.1 Basic Equation
@@ -568,13 +589,18 @@ def Cp2_pT(p, T):
         return -_R * tau**2 * (g0_tautau + gr_tautau)
 
     @staticmethod
-    def Cp2_pT_meta(p, T):
+    def Cp2_pT_meta(p: float, T: float) -> float:
         """
         6 Equations for Region 2, Section. 6.2 Supplementary Equation for the Metastable-Vapor Region
 
         Table 16, Page 18
 
         specific volume
+
+        :param p: preasure in [MPa]
+        :param T: temperature in [K]
+
+        :return: specific isobaric heat capacity in [kJ / (kg K)]
         """
         Pi = p  # Eq 1
         tau = 540 / T  # Eq 1
@@ -592,7 +618,7 @@ def Cp2_pT_meta(p, T):
         return -_R * tau**2 * (g0_tautau + gr_tautau)  # Cp2_pT
 
     @staticmethod
-    def Cv2_pT(p, T):
+    def Cv2_pT(p: float, T: float) -> float:
         """function Cv2_pT = Cv2_pT(p, T)
 
         6 Equations for Region 2, Section. 6.1 Basic Equation
@@ -662,13 +688,18 @@ def w2_pT(cls, p: float, T: float) -> float:
         ) ** 0.5
 
     @staticmethod
-    def w2_pT_meta(p, T):
+    def w2_pT_meta(p: float, T: float) -> float:
         """
         6 Equations for Region 2, Section. 6.2 Supplementary Equation for the Metastable-Vapor Region
 
         Table 16, Page 18
 
         specific volume
+
+        :param p: preasure in [MPa]
+        :param T: temperature in [K]
+
+        :return: speed of sound in [m / s]
         """
         Pi = p  # Eq 1
         tau = 540 / T  # Eq 1
@@ -710,7 +741,7 @@ def w2_pT_meta(p, T):
         return math.sqrt(1000 * _R * T * part_1 / (part_2_a + part_2_b / part_2_c))
 
     @staticmethod
-    def T2_ph(p, h):
+    def T2_ph(p: float, h: float) -> float:
         """function T2_ph = T2_ph(p, h)
 
         6 Equations for Region 2, 6.3.1 The Backward Equations T(p, h) for

pyXSteam/TransportProperties.py

@@ -19,6 +19,11 @@ def my_AllRegions_pT(p: float, T: float) -> float:
     """function my_AllRegions_pT = my_AllRegions_pT(p, T)
 
     Section 5.1 Viscosity (IAPWS formulation 1985, Revised 2003)
+
+    :param p: preasure in [MPa]
+    :param T: temperature in [K]
+
+    :return: dynamic viscosity in [Pa s]
     """
     h0 = [0.5132047, 0.3205656, 0, 0, -0.7782567, 0.1885447]
     h1 = [0.2151778, 0.7317883, 1.241044, 1.476783, 0, 0]
@@ -81,6 +86,11 @@ def my_AllRegions_ph(p: float, h: float) -> float:
     """function my_AllRegions_ph = my_AllRegions_ph(p, h)
 
     Section 5.1 Viscosity (IAPWS formulation 1985, Revised 2003)
+
+    :param p: preasure in [MPa]
+    :param h: enthalpy in [kJ / kg]
+
+    :return: dynamic viscosity in [Pa s]
     """
     h0 = [0.5132047, 0.3205656, 0, 0, -0.7782567, 0.1885447]
     h1 = [0.2151778, 0.7317883, 1.241044, 1.476783, 0, 0]
@@ -161,6 +171,12 @@ def tc_ptrho(p: float, T: float, rho: float) -> float:
     Revised release on the IAPWS formulation 1985 for the Thermal Conductivity of ordinary water IAPWS, September 1998
 
     Page 8
+
+    :param p: preasure in [MPa]
+    :param T: temperature in [K]
+    :param rho: density in [kg / m³]
+
+    :return: thermal conductivity in [W / (m K)]
     """
 
     # ver2.6 Start corrected bug
@@ -209,9 +225,9 @@ def surface_tension_T(T: float) -> float:
     IAPWS Revised Release on Surface Tension of Ordinary Water Substance, June 2014 R1-76(2014)
     http://www.iapws.org/relguide/Surf-H2O-2014.pdf
 
-    :param T: temperature in Kelvin
+    :param T: temperature in [K]
 
-    :return: surface tension in mN/m
+    :return: surface tension in [N / m]
     """
     B = 235.8  # N/m
     bb = -0.625

pyXSteam/TransportProperties_HW.py

@@ -23,11 +23,13 @@ def my_AllRegions_pT() -> float:
     # 0 < p ≤ pt pt ≤ p ≤ 100 MPa 100 MPa < p ≤ 200 MPa 200 MPa < p ≤ 960 MPa and and and and Tt ≤ T ≤ 775 K
     # Tm(p) ≤ T ≤ 775 K
     # Tm(p) ≤ T ≤ 473 K Tm(p) ≤ T ≤ 373 K
+    raise NotImplementedError()
     return
 
 
 def tc_() -> float:
     """R18-21 calculate thermal conductivity of heavy water, replaces IAPWS R4-84(2007)"""
+    raise NotImplementedError()
     return
 
 
@@ -37,9 +39,9 @@ def surface_tension_T(T: float) -> float:
     IAPWS Release on Surface Tension of Heavy Water Substance
     http://www.iapws.org/relguide/surfd2o.pdf
 
-    :param T: temperature in Kelvin
+    :param T: temperature in [K]
 
-    :return: surface tension in mN/m
+    :return: surface tension in [N / m]
     """
     B = 238.0  # N/m
     bb = -0.639