fix, improve docstrings

HugoMVale · Oct 30, 2023 · 245ee06 · 245ee06
1 parent c0d4378
commit 245ee06
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 6 deletions.
diff --git a/src/polykin/properties/pvt_polymer/base.py b/src/polykin/properties/pvt_polymer/base.py
@@ -115,7 +115,7 @@ def eval(self, T: FloatOrArray, P: FloatOrArray) -> FloatOrArray:
         -------
         FloatOrArray
             Specific volume.
-            Unit = m³/kg
+            Unit = m³/kg.
         """
         pass
 

diff --git a/src/polykin/properties/pvt_polymer/eos.py b/src/polykin/properties/pvt_polymer/eos.py
@@ -46,6 +46,24 @@ def eval(self,
              T: FloatOrArray,
              P: FloatOrArray
              ) -> FloatOrArray:
+        r"""Evaluate specific volume, $\hat{V}$, at given SI conditions without
+        unit conversions or checks.
+
+        Parameters
+        ----------
+        T : FloatOrArray
+            Temperature.
+            Unit = K.
+        P : FloatOrArray
+            Pressure.
+            Unit = Pa.
+
+        Returns
+        -------
+        FloatOrArray
+            Specific volume.
+            Unit = m³/kg.
+        """
         t = T/self.T0
         p = P/self.P0
         solution = root_scalar(f=self.equation,
@@ -85,6 +103,7 @@ def alpha(self,
         -------
         FloatOrArray
             Thermal expansion coefficient, $\alpha$.
+            Unit = 1/K.
         """
         dT = 0.5
         V2 = self.eval(T + dT, P)
@@ -112,6 +131,7 @@ def beta(self,
         -------
         FloatOrArray
             Isothermal compressibility coefficient, $\beta$.
+            Unit = 1/Pa.
         """
         dP = 1e5
         P2 = P + dP
@@ -338,7 +358,7 @@ def equation(v: float, t: float, p: float) -> tuple[float, float, float]:
         tuple[float, float, float]
             Equation of state, first derivative, second derivative.
         """
-        f = 1/v**2 + p + t*(np.log(1 - 1/v) + 1/v)
+        f = 1/v**2 + p + t*(np.log(1 - 1/v) + 1/v)  # =0
         d1f = ((t - 2)*v + 2)/((v - 1)*v**3)
         d2f = (-3*(t - 2)*v**2 + 2*(t - 6)*v + 6)/((v - 1)**2*v**4)
         return (f, d1f, d2f)
diff --git a/src/polykin/properties/pvt_polymer/tait.py b/src/polykin/properties/pvt_polymer/tait.py
@@ -135,7 +135,7 @@ def eval(self,
         -------
         FloatOrArray
             Specific volume.
-            Unit = m³/kg
+            Unit = m³/kg.
         """
         TC = T - 273.15
         V0 = self.A0 + self.A1*TC + self.A2*TC**2
@@ -158,7 +158,7 @@ def _B(self,
         -------
         FloatOrArray
             B(T).
-            Unit = Pa
+            Unit = Pa.
         """
         return self.B0*np.exp(-self.B1*(T - 273.15))
 
@@ -182,7 +182,8 @@ def alpha(self,
         Returns
         -------
         FloatOrArray
-            alpha.
+            Thermal expansion coefficient, $\alpha$.
+            Unit = 1/K.
         """
         A0 = self.A0
         A1 = self.A1
@@ -211,7 +212,8 @@ def beta(self,
         Returns
         -------
         FloatOrArray
-            beta.
+            Isothermal compressibility coefficient, $\beta$.
+            Unit = 1/Pa.
         """
         B = self._B(T)
         return (self._C/(P + B))/(1 - self._C*np.log(1 + P/B))