Merge pull request #1950 from Vaibhav-Chopra-GT/Rename_tortuosity_to_transport_efficiency3

Rename tortuosity to transport efficiency

Author: valentinsulzer

docs/source/models/submodels/index.rst

@@ -18,4 +18,4 @@ Submodels
     particle_mechanics/index
     porosity/index
     thermal/index
-    tortuosity/index
+    transport_efficiency/index

docs/source/models/submodels/tortuosity/base_tortuosity.rst

@@ -0,0 +1,6 @@
+Base Model
+===========
+
+.. autoclass:: pybamm.transport_efficiency.BaseModel
+    :members:
+

docs/source/models/submodels/tortuosity/bruggeman_tortuosity.rst

@@ -0,0 +1,8 @@
+Bruggeman Model 
+===============
+
+.. autoclass:: pybamm.transport_efficiency.Bruggeman
+    :members:
+
+
+

docs/source/models/submodels/tortuosity/index.rst

@@ -0,0 +1,9 @@
+transport_efficiency
+====================
+
+.. toctree::
+  :maxdepth: 1
+
+  base_transport_efficiency
+  bruggeman_transport_efficiency
+

docs/source/models/submodels/transport_efficiency/base_transport_efficiency.rst

@@ -118,7 +118,7 @@
     particle,
     porosity,
     thermal,
-    tortuosity,
+    transport_efficiency,
     particle_mechanics,
 )
 from .models.submodels.interface import kinetics

docs/source/models/submodels/transport_efficiency/bruggeman_transport_efficiency.rst

@@ -111,7 +111,7 @@ def print(self, filename=None, output_format="text"):
 
 
 def print_citations(filename=None, output_format="text"):
-    """ See :meth:`Citations.print` """
+    """See :meth:`Citations.print`"""
     pybamm.citations.print(filename, output_format)
 
 

docs/source/models/submodels/transport_efficiency/index.rst

@@ -181,5 +181,3 @@ def _function_evaluate(self, evaluated_children):
                 return res[:, np.newaxis]
         else:  # pragma: no cover
             raise ValueError("Invalid dimension: {0}".format(self.dimension))
-
-