DOC: add Lewis factor table to documentation pages

AndreaBlengino · Apr 5, 2024 · 31ed3fd · 31ed3fd
1 parent ac9e385
commit 31ed3fd
Show file tree

Hide file tree

Showing 9 changed files with 81 additions and 3 deletions.
diff --git a/docs/source/_static/custom.css b/docs/source/_static/custom.css
@@ -10,3 +10,8 @@
 .admonition, .topic {
     font-size: 1.0rem;
 }
+
+article table.align-default {
+    display: table;
+    text-align: center;
+}
diff --git a/docs/source/mechanical_objects/HelicalGear/lewis_factor.rst b/docs/source/mechanical_objects/HelicalGear/lewis_factor.rst
@@ -6,3 +6,12 @@ lewis_factor
 
 .. autoproperty:: HelicalGear.lewis_factor
    :no-index:
+
+
+Lewis Factor Table
+------------------
+
+.. csv-table::
+   :file: /../../gearpy/mechanical_objects/gear_data/lewis_factor_table.csv
+   :widths: auto
+   :header-rows: 1
diff --git a/docs/source/mechanical_objects/SpurGear/lewis_factor.rst b/docs/source/mechanical_objects/SpurGear/lewis_factor.rst
@@ -6,3 +6,12 @@ lewis_factor
 
 .. autoproperty:: SpurGear.lewis_factor
    :no-index:
+
+
+Lewis Factor Table
+------------------
+
+.. csv-table::
+   :file: /../../gearpy/mechanical_objects/gear_data/lewis_factor_table.csv
+   :widths: auto
+   :header-rows: 1
diff --git a/docs/source/mechanical_objects/WormGear/helix_angle.rst b/docs/source/mechanical_objects/WormGear/helix_angle.rst
@@ -6,3 +6,12 @@ helix_angle
 
 .. autoproperty:: WormGear.helix_angle
    :no-index:
+
+
+Maximum Helix Angle Table
+-------------------------
+
+.. csv-table::
+   :file: /../../gearpy/mechanical_objects/gear_data/worm_gear_and_wheel_data.csv
+   :widths: auto
+   :header-rows: 1
diff --git a/docs/source/mechanical_objects/WormWheel/helix_angle.rst b/docs/source/mechanical_objects/WormWheel/helix_angle.rst
@@ -6,3 +6,12 @@ helix_angle
 
 .. autoproperty:: WormWheel.helix_angle
    :no-index:
+
+
+Maximum Helix Angle Table
+-------------------------
+
+.. csv-table::
+   :file: /../../gearpy/mechanical_objects/gear_data/worm_gear_and_wheel_data.csv
+   :widths: auto
+   :header-rows: 1
diff --git a/docs/source/mechanical_objects/WormWheel/lewis_factor.rst b/docs/source/mechanical_objects/WormWheel/lewis_factor.rst
@@ -6,3 +6,12 @@ lewis_factor
 
 .. autoproperty:: WormWheel.lewis_factor
    :no-index:
+
+
+Lewis Factor Table
+------------------
+
+.. csv-table::
+   :file: /../../gearpy/mechanical_objects/gear_data/worm_gear_and_wheel_data.csv
+   :widths: auto
+   :header-rows: 1
diff --git a/gearpy/mechanical_objects/helical_gear.py b/gearpy/mechanical_objects/helical_gear.py
@@ -294,6 +294,34 @@ def lewis_factor(self) -> Optional[float]:
         -------
         :py:class:`float`
             Factor used to compute stresses on the gear tooth.
+        """\
+        r"""
+        .. admonition:: Notes
+           :class: tip
+
+           The Lewis factor is a tabular value that depends on the helical gear virtual number of teeth, which can be
+           computed as:
+
+           .. math::
+               z_v = \frac{z}{\cos^2 \beta_b \, \cos \beta}
+
+           where:
+
+           - :math:`z` is the gear number of teeth :py:attr:`n_teeth`,
+           - :math:`\beta` is the gear :py:attr:`helix_angle`,
+           - :math:`\beta_b` is the gear base helix angle.
+
+           The gear base helix angle :math:`\beta_b` can be computed as:
+
+           .. math::
+               \beta_b = \tan^{-1} \left( \cos \alpha_t \, \cos \beta \right)
+
+           where the :math:`\alpha_t` is the gear transverse pressure angle, which can be computed as:
+
+           .. math::
+               \alpha_t = \tan^{-1} \frac{\tan \alpha}{\cos \beta}
+
+           where :math:`\alpha` is the pressure angle of the gear, always equal to 20 degrees.
         """
         return self.__lewis_factor
 

diff --git a/gearpy/mechanical_objects/worm_gear.py b/gearpy/mechanical_objects/worm_gear.py
@@ -194,7 +194,7 @@ def inertia_moment(self) -> InertiaMoment:
     @property
     def helix_angle(self) -> Angle:
         """Helix angle of the worm gear. It must be an instance of :py:class:`Angle <gearpy.units.units.Angle>`. \n
-        The maximum allowable value of helix angle depends on the pressure angle. \n
+        The maximum allowable value of helix angle depends on the :py:attr:`pressure_angle`. \n
         Once set at the worm gear instantiation, it cannot be changed afterward.
 
         Returns

diff --git a/gearpy/mechanical_objects/worm_wheel.py b/gearpy/mechanical_objects/worm_wheel.py
@@ -190,7 +190,7 @@ def inertia_moment(self) -> InertiaMoment:
     @property
     def helix_angle(self) -> Angle:
         """Helix angle of the worm wheel. It must be an instance of :py:class:`Angle <gearpy.units.units.Angle>`. \n
-        The maximum allowable value of helix angle depends on the pressure angle. \n
+        The maximum allowable value of helix angle depends on the :py:attr:`pressure_angle`. \n
         Once set at the worm gear instantiation, it cannot be changed afterward.
 
         Returns
@@ -281,7 +281,7 @@ def face_width(self) -> Optional[Length]:
     @property
     def lewis_factor(self) -> Optional[float]:
         """Factor used to compute stresses on the gear tooth. \n
-        It is a tabular value that in general depends on the :py:attr:`pressure_angle`.
+        It is a tabular value that depends on the :py:attr:`pressure_angle`.
 
         Returns
         -------