pybamm-team#1048 fixed typos

brosaplanella · Jun 22, 2020 · 3a03134 · 3a03134
1 parent 84fc9ed
commit 3a03134
Show file tree

Hide file tree

Showing 15 changed files with 110 additions and 14 deletions.
diff --git a/...ectrolytes/lipf6_EC_DMC_1_1_Landesfeind2019/electrolyte_TDF_EC_DMC_1_1_Landesfeind2019.py b/...ectrolytes/lipf6_EC_DMC_1_1_Landesfeind2019/electrolyte_TDF_EC_DMC_1_1_Landesfeind2019.py
@@ -4,22 +4,26 @@
 
 def electrolyte_TDF_EC_DMC_1_1_Landesfeind2019(c_e, T=298.15):
     """
-    Diffusivity of LiPF6 in EC:DMC (1:1 w:w) as a function of ion concentration and
-    temperature. The data comes from [1].
+    Thermodynamic factor of LiPF6 in EC:DMC (1:1 w:w) as a function of ion
+    concentration and temperature. The data comes from [1].
+
     References
     ----------
     .. [1] Landesfeind, J. and Gasteiger, H.A., 2019. Temperature and Concentration
     Dependence of the Ionic Transport Properties of Lithium-Ion Battery Electrolytes.
     Journal of The Electrochemical Society, 166(14), pp.A3079-A3097.
+
+    Parameters
     ----------
     c_e: :class:`pybamm.Symbol`
         Dimensional electrolyte concentration
     T: :class:`pybamm.Symbol`
         Dimensional temperature
+
     Returns
     -------
     :class:`pybamm.Symbol`
-        Electrolyte diffusivity
+        Electrolyte thermodynamic factor
     """
     coeffs = np.array(
         [-5.58, 7.17, 3.80e-2, 1.91, -6.65e-2, -5.08e-5, 1.1e-1, -6.10e-3, 1.51e-4]

diff --git a/...ium-ion/electrolytes/lipf6_EC_DMC_1_1_Landesfeind2019/electrolyte_base_Landesfeind2019.py b/...ium-ion/electrolytes/lipf6_EC_DMC_1_1_Landesfeind2019/electrolyte_base_Landesfeind2019.py
@@ -5,18 +5,22 @@ def electrolyte_conductivity_base_Landesfeind2019(c_e, T, coeffs):
     """
     Conductivity of LiPF6 in solvent_X as a function of ion concentration and
     temperature. The data comes from [1].
+
     References
     ----------
     .. [1] Landesfeind, J. and Gasteiger, H.A., 2019. Temperature and Concentration
     Dependence of the Ionic Transport Properties of Lithium-Ion Battery Electrolytes.
     Journal of The Electrochemical Society, 166(14), pp.A3079-A3097.
+
+    Parameters
     ----------
     c_e: :class:`pybamm.Symbol`
         Dimensional electrolyte concentration
     T: :class:`pybamm.Symbol`
         Dimensional temperature
     coeffs: :class:`pybamm.Symbol`
         Fitting parameter coefficients
+
     Returns
     -------
     :class:`pybamm.Symbol`
@@ -36,18 +40,22 @@ def electrolyte_diffusivity_base_Landesfeind2019(c_e, T, coeffs):
     """
     Diffusivity of LiPF6 in solvent_X as a function of ion concentration and
     temperature. The data comes from [1].
+
     References
     ----------
     .. [1] Landesfeind, J. and Gasteiger, H.A., 2019. Temperature and Concentration
     Dependence of the Ionic Transport Properties of Lithium-Ion Battery Electrolytes.
     Journal of The Electrochemical Society, 166(14), pp.A3079-A3097.
+
+    Parameters
     ----------
     c_e: :class:`pybamm.Symbol`
         Dimensional electrolyte concentration
     T: :class:`pybamm.Symbol`
         Dimensional temperature
     coeffs: :class:`pybamm.Symbol`
         Fitting parameter coefficients
+
     Returns
     -------
     :class:`pybamm.Symbol`
@@ -67,18 +75,22 @@ def electrolyte_TDF_base_Landesfeind2019(c_e, T, coeffs):
     """
     Thermodynamic factor (TDF) of LiPF6 in solvent_X as a function of ion concentration
     and temperature. The data comes from [1].
+
     References
     ----------
     .. [1] Landesfeind, J. and Gasteiger, H.A., 2019. Temperature and Concentration
     Dependence of the Ionic Transport Properties of Lithium-Ion Battery Electrolytes.
     Journal of The Electrochemical Society, 166(14), pp.A3079-A3097.
+
+    Parameters
     ----------
     c_e: :class:`pybamm.Symbol`
         Dimensional electrolyte concentration
     T: :class:`pybamm.Symbol`
         Dimensional temperature
     coeffs: :class:`pybamm.Symbol`
         Fitting parameter coefficients
+
     Returns
     -------
     :class:`pybamm.Symbol`
@@ -105,18 +117,22 @@ def electrolyte_transference_number_base_Landesfeind2019(c_e, T, coeffs):
     """
     Transference number of LiPF6 in solvent_X as a function of ion concentration and
     temperature. The data comes from [1].
+
     References
     ----------
     .. [1] Landesfeind, J. and Gasteiger, H.A., 2019. Temperature and Concentration
     Dependence of the Ionic Transport Properties of Lithium-Ion Battery Electrolytes.
     Journal of The Electrochemical Society, 166(14), pp.A3079-A3097.
+
+    Parameters
     ----------
     c_e: :class:`pybamm.Symbol`
         Dimensional electrolyte concentration
     T: :class:`pybamm.Symbol`
         Dimensional temperature
     coeffs: :class:`pybamm.Symbol`
         Fitting parameter coefficients
+
     Returns
     -------
     :class:`pybamm.Symbol`

diff --git a/...s/lipf6_EC_DMC_1_1_Landesfeind2019/electrolyte_conductivity_EC_DMC_1_1_Landesfeind2019.py b/...s/lipf6_EC_DMC_1_1_Landesfeind2019/electrolyte_conductivity_EC_DMC_1_1_Landesfeind2019.py
@@ -8,16 +8,20 @@ def electrolyte_conductivity_EC_DMC_1_1_Landesfeind2019(c_e, T):
     """
     Conductivity of LiPF6 in EC:DMC (1:1 w:w) as a function of ion concentration and
     temperature. The data comes from [1].
+
     References
     ----------
     .. [1] Landesfeind, J. and Gasteiger, H.A., 2019. Temperature and Concentration
     Dependence of the Ionic Transport Properties of Lithium-Ion Battery Electrolytes.
     Journal of The Electrochemical Society, 166(14), pp.A3079-A3097.
+
+    Parameters
     ----------
     c_e: :class:`pybamm.Symbol`
         Dimensional electrolyte concentration
     T: :class:`pybamm.Symbol`
         Dimensional temperature
+
     Returns
     -------
     :class:`pybamm.Symbol`

diff --git a/...es/lipf6_EC_DMC_1_1_Landesfeind2019/electrolyte_diffusivity_EC_DMC_1_1_Landesfeind2019.py b/...es/lipf6_EC_DMC_1_1_Landesfeind2019/electrolyte_diffusivity_EC_DMC_1_1_Landesfeind2019.py
@@ -8,16 +8,20 @@ def electrolyte_diffusivity_EC_DMC_1_1_Landesfeind2019(c_e, T):
     """
     Diffusivity of LiPF6 in EC:DMC (1:1 w:w) as a function of ion concentration and
     temperature. The data comes from [1].
+
     References
     ----------
     .. [1] Landesfeind, J. and Gasteiger, H.A., 2019. Temperature and Concentration
     Dependence of the Ionic Transport Properties of Lithium-Ion Battery Electrolytes.
     Journal of The Electrochemical Society, 166(14), pp.A3079-A3097.
+
+    Parameters
     ----------
     c_e: :class:`pybamm.Symbol`
         Dimensional electrolyte concentration
     T: :class:`pybamm.Symbol`
         Dimensional temperature
+
     Returns
     -------
     :class:`pybamm.Symbol`

diff --git a/..._EC_DMC_1_1_Landesfeind2019/electrolyte_transference_number_EC_DMC_1_1_Landesfeind2019.py b/..._EC_DMC_1_1_Landesfeind2019/electrolyte_transference_number_EC_DMC_1_1_Landesfeind2019.py
@@ -6,18 +6,22 @@
 
 def electrolyte_transference_number_EC_DMC_1_1_Landesfeind2019(c_e, T=298.15):
     """
-    Transference number of LiPF6 in EC:DMC (1:1 w:w) as a function of ion concentration
-    and temperature. The data comes from [1].
+    Transference number (TDF) of LiPF6 in EC:DMC (1:1 w:w) as a function of ion
+    concentration and temperature. The data comes from [1].
+
     References
     ----------
     .. [1] Landesfeind, J. and Gasteiger, H.A., 2019. Temperature and Concentration
     Dependence of the Ionic Transport Properties of Lithium-Ion Battery Electrolytes.
     Journal of The Electrochemical Society, 166(14), pp.A3079-A3097.
+
+    Parameters
     ----------
     c_e: :class:`pybamm.Symbol`
         Dimensional electrolyte concentration
     T: :class:`pybamm.Symbol`
         Dimensional temperature
+
     Returns
     -------
     :class:`pybamm.Symbol`

diff --git a/...ectrolytes/lipf6_EC_EMC_3_7_Landesfeind2019/electrolyte_TDF_EC_EMC_3_7_Landesfeind2019.py b/...ectrolytes/lipf6_EC_EMC_3_7_Landesfeind2019/electrolyte_TDF_EC_EMC_3_7_Landesfeind2019.py
@@ -4,22 +4,26 @@
 
 def electrolyte_TDF_EC_EMC_3_7_Landesfeind2019(c_e, T=298.15):
     """
-    Diffusivity of LiPF6 in EC:EMC (3:7 w:w) as a function of ion concentration and
-    temperature. The data comes from [1].
+    Thermodynamic factor of LiPF6 in EC:EMC (3:7 w:w) as a function of ion
+    concentration and temperature. The data comes from [1].
+
     References
     ----------
     .. [1] Landesfeind, J. and Gasteiger, H.A., 2019. Temperature and Concentration
     Dependence of the Ionic Transport Properties of Lithium-Ion Battery Electrolytes.
     Journal of The Electrochemical Society, 166(14), pp.A3079-A3097.
+
+    Parameters
     ----------
     c_e: :class:`pybamm.Symbol`
         Dimensional electrolyte concentration
     T: :class:`pybamm.Symbol`
         Dimensional temperature
+
     Returns
     -------
     :class:`pybamm.Symbol`
-        Electrolyte diffusivity
+        Electrolyte thermodynamic factor
     """
     coeffs = np.array(
         [2.57e1, -4.51e1, -1.77e-1, 1.94, 2.95e-1, 3.08e-4, 2.59e-1, -9.46e-3, -4.54e-4]

diff --git a/...ium-ion/electrolytes/lipf6_EC_EMC_3_7_Landesfeind2019/electrolyte_base_Landesfeind2019.py b/...ium-ion/electrolytes/lipf6_EC_EMC_3_7_Landesfeind2019/electrolyte_base_Landesfeind2019.py
@@ -5,18 +5,22 @@ def electrolyte_conductivity_base_Landesfeind2019(c_e, T, coeffs):
     """
     Conductivity of LiPF6 in solvent_X as a function of ion concentration and
     temperature. The data comes from [1].
+
     References
     ----------
     .. [1] Landesfeind, J. and Gasteiger, H.A., 2019. Temperature and Concentration
     Dependence of the Ionic Transport Properties of Lithium-Ion Battery Electrolytes.
     Journal of The Electrochemical Society, 166(14), pp.A3079-A3097.
+
+    Parameters
     ----------
     c_e: :class:`pybamm.Symbol`
         Dimensional electrolyte concentration
     T: :class:`pybamm.Symbol`
         Dimensional temperature
     coeffs: :class:`pybamm.Symbol`
         Fitting parameter coefficients
+
     Returns
     -------
     :class:`pybamm.Symbol`
@@ -36,18 +40,22 @@ def electrolyte_diffusivity_base_Landesfeind2019(c_e, T, coeffs):
     """
     Diffusivity of LiPF6 in solvent_X as a function of ion concentration and
     temperature. The data comes from [1].
+
     References
     ----------
     .. [1] Landesfeind, J. and Gasteiger, H.A., 2019. Temperature and Concentration
     Dependence of the Ionic Transport Properties of Lithium-Ion Battery Electrolytes.
     Journal of The Electrochemical Society, 166(14), pp.A3079-A3097.
+
+    Parameters
     ----------
     c_e: :class:`pybamm.Symbol`
         Dimensional electrolyte concentration
     T: :class:`pybamm.Symbol`
         Dimensional temperature
     coeffs: :class:`pybamm.Symbol`
         Fitting parameter coefficients
+
     Returns
     -------
     :class:`pybamm.Symbol`
@@ -67,18 +75,22 @@ def electrolyte_TDF_base_Landesfeind2019(c_e, T, coeffs):
     """
     Thermodynamic factor (TDF) of LiPF6 in solvent_X as a function of ion concentration
     and temperature. The data comes from [1].
+
     References
     ----------
     .. [1] Landesfeind, J. and Gasteiger, H.A., 2019. Temperature and Concentration
     Dependence of the Ionic Transport Properties of Lithium-Ion Battery Electrolytes.
     Journal of The Electrochemical Society, 166(14), pp.A3079-A3097.
+
+    Parameters
     ----------
     c_e: :class:`pybamm.Symbol`
         Dimensional electrolyte concentration
     T: :class:`pybamm.Symbol`
         Dimensional temperature
     coeffs: :class:`pybamm.Symbol`
         Fitting parameter coefficients
+
     Returns
     -------
     :class:`pybamm.Symbol`
@@ -105,18 +117,22 @@ def electrolyte_transference_number_base_Landesfeind2019(c_e, T, coeffs):
     """
     Transference number of LiPF6 in solvent_X as a function of ion concentration and
     temperature. The data comes from [1].
+
     References
     ----------
     .. [1] Landesfeind, J. and Gasteiger, H.A., 2019. Temperature and Concentration
     Dependence of the Ionic Transport Properties of Lithium-Ion Battery Electrolytes.
     Journal of The Electrochemical Society, 166(14), pp.A3079-A3097.
+
+    Parameters
     ----------
     c_e: :class:`pybamm.Symbol`
         Dimensional electrolyte concentration
     T: :class:`pybamm.Symbol`
         Dimensional temperature
     coeffs: :class:`pybamm.Symbol`
         Fitting parameter coefficients
+
     Returns
     -------
     :class:`pybamm.Symbol`

diff --git a/...s/lipf6_EC_EMC_3_7_Landesfeind2019/electrolyte_conductivity_EC_EMC_3_7_Landesfeind2019.py b/...s/lipf6_EC_EMC_3_7_Landesfeind2019/electrolyte_conductivity_EC_EMC_3_7_Landesfeind2019.py
@@ -8,16 +8,20 @@ def electrolyte_conductivity_EC_EMC_3_7_Landesfeind2019(c_e, T):
     """
     Conductivity of LiPF6 in EC:EMC (3:7 w:w) as a function of ion concentration and
     temperature. The data comes from [1].
+
     References
     ----------
     .. [1] Landesfeind, J. and Gasteiger, H.A., 2019. Temperature and Concentration
     Dependence of the Ionic Transport Properties of Lithium-Ion Battery Electrolytes.
     Journal of The Electrochemical Society, 166(14), pp.A3079-A3097.
+
+    Parameters
     ----------
     c_e: :class:`pybamm.Symbol`
         Dimensional electrolyte concentration
     T: :class:`pybamm.Symbol`
         Dimensional temperature
+
     Returns
     -------
     :class:`pybamm.Symbol`

diff --git a/...es/lipf6_EC_EMC_3_7_Landesfeind2019/electrolyte_diffusivity_EC_EMC_3_7_Landesfeind2019.py b/...es/lipf6_EC_EMC_3_7_Landesfeind2019/electrolyte_diffusivity_EC_EMC_3_7_Landesfeind2019.py
@@ -8,16 +8,20 @@ def electrolyte_diffusivity_EC_EMC_3_7_Landesfeind2019(c_e, T):
     """
     Diffusivity of LiPF6 in EC:EMC (3:7 w:w) as a function of ion concentration and
     temperature. The data comes from [1].
+
     References
     ----------
     .. [1] Landesfeind, J. and Gasteiger, H.A., 2019. Temperature and Concentration
     Dependence of the Ionic Transport Properties of Lithium-Ion Battery Electrolytes.
     Journal of The Electrochemical Society, 166(14), pp.A3079-A3097.
+
+    Parameters
     ----------
     c_e: :class:`pybamm.Symbol`
         Dimensional electrolyte concentration
     T: :class:`pybamm.Symbol`
         Dimensional temperature
+
     Returns
     -------
     :class:`pybamm.Symbol`

diff --git a/..._EC_EMC_3_7_Landesfeind2019/electrolyte_transference_number_EC_EMC_3_7_Landesfeind2019.py b/..._EC_EMC_3_7_Landesfeind2019/electrolyte_transference_number_EC_EMC_3_7_Landesfeind2019.py
@@ -6,18 +6,22 @@
 
 def electrolyte_transference_number_EC_EMC_3_7_Landesfeind2019(c_e, T=298.15):
     """
-    Transference number of LiPF6 in EC:EMC (3:7 w:w) as a function of ion concentration
-    and temperature. The data comes from [1].
+    Transference number (TDF) of LiPF6 in EC:EMC (3:7 w:w) as a function of ion
+    concentration and temperature. The data comes from [1].
+
     References
     ----------
     .. [1] Landesfeind, J. and Gasteiger, H.A., 2019. Temperature and Concentration
     Dependence of the Ionic Transport Properties of Lithium-Ion Battery Electrolytes.
     Journal of The Electrochemical Society, 166(14), pp.A3079-A3097.
+
+    Parameters
     ----------
     c_e: :class:`pybamm.Symbol`
         Dimensional electrolyte concentration
     T: :class:`pybamm.Symbol`
         Dimensional temperature
+
     Returns
     -------
     :class:`pybamm.Symbol`