Merge branch 'main' into dev/model-reduction

Author: jguarato

docs/user_guide/tutorial_part_4.ipynb

@@ -43,6 +43,9 @@ example_26
 example_27
 example_28
 example_29
+example_30
+example_31
+example_32
 fluid_flow_elliptical_bearing
 fluid_flow_short_bearing
 fluid_flow_theory

docs/user_guide/user_guide.md

@@ -9,6 +9,7 @@
 from ross.units import Q_
 
 from ross.disk_element import DiskElement
+from ross.materials import steel
 
 
 __all__ = ["GearElement"]
@@ -29,18 +30,26 @@ class GearElement(DiskElement):
         Diametral moment of inertia.
     Ip : float, pint.Quantity
         Polar moment of inertia.
+    width: float, pint.Quantity
+        width of the gear (mm).
+    n_teth: int, pint.Quantity
+        number of teeth from the gear
     base_diameter : float, pint.Quantity
         Base diameter of the gear (m).
         If given pitch_diameter is not necessary.
     pitch_diameter : float, pint.Quantity
         Pitch diameter of the gear (m).
         If given base_diameter is not necessary.
     pressure_angle : float, pint.Quantity, optional
-        The pressure angle of the gear (rad).
+        The normal pressure angle of the gear (rad).
         Default is 20 deg (converted to rad).
+    material: ross.material, optional
+        material of the gear. Default is steel.
     tag : str, optional
         A tag to name the element.
         Default is None.
+    helix_angle: float, pint.Quantity, optional
+        value of helix angle for helical gears. Default is 0 representing spur gear.
     scale_factor: float or str, optional
         The scale factor is used to scale the gear drawing.
         For gears it is also possible to provide 'mass' as the scale factor.
@@ -55,9 +64,10 @@ class GearElement(DiskElement):
     Examples
     --------
     >>> gear = GearElement(
-    ...        n=0, m=4.67, Id=0.015, Ip=0.030,
+    ...        n=0, m=4.67, Id=0.015, Ip=0.030, width=0.07, n_teeth=50,
     ...        pitch_diameter=0.187,
-    ...        pressure_angle=Q_(22.5, "deg")
+    ...        pressure_angle=Q_(22.5, "deg"),
+    ...        helix_angle=0,
     ... )
     >>> gear.pressure_angle # doctest: +ELLIPSIS
     0.392699...
@@ -69,10 +79,14 @@ def __init__(
         m,
         Id,
         Ip,
+        width,
+        n_teeth,
         pitch_diameter=None,
         base_diameter=None,
         pressure_angle=None,
+        material=steel,
         tag=None,
+        helix_angle=0,
         scale_factor=1.0,
         color="Goldenrod",
     ):
@@ -90,6 +104,18 @@ def __init__(
                 "At least one of the following must be informed for GearElement: base_diameter or pitch_diameter"
             )
 
+        if not pitch_diameter:
+            self.pitch_diameter = (self.base_radius * 2) / np.cos(self.pressure_angle)
+        else:
+            self.pitch_diameter = float(pitch_diameter)
+
+        self.helix_angle = float(helix_angle)
+        self.width = float(width)
+
+        self.material = material
+
+        self.n_teeth = n_teeth
+
         super().__init__(n, m, Id, Ip, tag, scale_factor, color)
 
     @classmethod
@@ -100,8 +126,10 @@ def from_geometry(
         width,
         i_d,
         o_d,
+        n_teeth,
         pressure_angle=None,
         tag=None,
+        helix_angle=0,
         scale_factor=1.0,
         color="Goldenrod",
     ):
@@ -139,12 +167,16 @@ def from_geometry(
             Inner diameter (the diameter of the shaft on which the gear is mounted).
         o_d : float, pint.Quantity
             Outer pitch diameter (m).
+        n_teeth: int, pint.Quantity
+            Number of teeth of the gear.
         pressure_angle : float, pint.Quantity, optional
-            The pressure angle of the gear (rad).
+            The normal pressure angle of the gear (rad).
             Default is 20 deg (converted to rad).
         tag : str, optional
-            A tag to name the element
-            Default is None
+            A tag to name the element. 
+            Default is None.
+        helix_angle: float, pint.Quantity, optional
+            Value of helix angle for helical gears. Default is 0 representing spur gear.
         scale_factor: float, optional
             The scale factor is used to scale the gear drawing.
             Default is 1.
@@ -159,12 +191,12 @@ def from_geometry(
         Id : float
             Diametral moment of inertia.
         Ip : float
-            Polar moment of inertia
+            Polar moment of inertia.
 
         Examples
         --------
         >>> from ross.materials import steel
-        >>> gear = GearElement.from_geometry(0, steel, 0.07, 0.05, 0.28)
+        >>> gear = GearElement.from_geometry(0, steel, 0.07, 0.05, 0.28, 50)
         >>> gear.base_radius # doctest: +ELLIPSIS
         0.131556...
         >>>
@@ -181,9 +213,13 @@ def from_geometry(
             m,
             Id,
             Ip,
+            width=width,
+            n_teeth=n_teeth,
             pitch_diameter=o_d,
             pressure_angle=pressure_angle,
+            material=material,
             tag=tag,
+            helix_angle=helix_angle,
             scale_factor=scale_factor,
             color=color,
         )