Merge branch 'main' into update/readme

Author: jguarato

docs/user_guide/tutorial_part_4.ipynb

@@ -760,6 +760,64 @@ def G(self):
 
         return G
 
+    def _hover_info(self, frequency=None):
+        """Generate hover information for bearing element.
+
+        This method can be overridden by subclasses to customize the hover
+        information displayed when hovering over the bearing element in plots.
+
+        Parameters
+        ----------
+        frequency : float, optional
+            Frequency at which to display coefficients (rad/s).
+            Not used - displays coefficients at first and last frequencies.
+
+        Returns
+        -------
+        customdata : list
+            Data to attach to hover trace.
+        hovertemplate : str
+            Template string for hover display with HTML formatting.
+
+        Examples
+        --------
+        >>> bearing = bearing_example()
+        >>> customdata, hovertemplate = bearing._hover_info()
+        >>> customdata[0]  # node number
+        0
+        """
+        # Get first and last frequencies
+        if self.frequency is not None:
+            if hasattr(self.frequency, "__iter__"):
+                freq_0 = self.frequency[0]
+                freq_1 = self.frequency[-1]
+            else:
+                freq_0 = freq_1 = self.frequency
+        else:
+            freq_0 = freq_1 = 0
+
+        # Convert frequencies to RPM
+        freq_0_rpm = Q_(freq_0, "rad/s").to("RPM").m
+        freq_1_rpm = Q_(freq_1, "rad/s").to("RPM").m
+
+        # Build hover template directly without intermediate list
+        hovertemplate = f"Bearing at Node: {self.n}<br>"
+        if self.tag is not None:
+            hovertemplate = f"Tag: {self.tag}<br>" + hovertemplate
+
+        hovertemplate += f"Frequency: {freq_0_rpm:.2f} ... {freq_1_rpm:.2f} RPM<br>"
+        hovertemplate += (
+            f"Kxx: {self.kxx_interpolated(freq_0):.3e} ... {self.kxx_interpolated(freq_1):.3e} N/m<br>"
+            f"Kyy: {self.kyy_interpolated(freq_0):.3e} ... {self.kyy_interpolated(freq_1):.3e} N/m<br>"
+            f"Cxx: {self.cxx_interpolated(freq_0):.3e} ... {self.cxx_interpolated(freq_1):.3e} N·s/m<br>"
+            f"Cyy: {self.cyy_interpolated(freq_0):.3e} ... {self.cyy_interpolated(freq_1):.3e} N·s/m<br>"
+        )
+
+        # customdata is still needed for plotly, but can be minimal
+        customdata = [self.n]
+
+        return customdata, hovertemplate
+
     def _patch(self, position, fig):
         """Bearing element patch.
 
@@ -806,6 +864,29 @@ def _patch(self, position, fig):
         fig.add_trace(go.Scatter(x=x_bot, y=np.add(yl_bot, yc_pos), **default_values))
         fig.add_trace(go.Scatter(x=x_bot, y=np.add(yu_bot, yc_pos), **default_values))
 
+        # Add hover information marker at the center of bottom base
+        customdata, hovertemplate = self._hover_info()
+        # Scale marker size proportionally to the bearing icon height
+        # icon_h already includes the scale_factor effect from rotor assembly
+        marker_size = icon_h * 200  # proportional to actual bearing size
+        hover_marker_values_top = dict(
+            mode="markers",
+            x=[zpos],
+            y=[ypos + icon_h / 2],
+            marker=dict(size=marker_size, color=self.color, opacity=0),
+            customdata=[customdata],
+            hovertemplate=hovertemplate,
+            hoverinfo="text",
+            name=self.tag,
+            legendgroup="bearings",
+            showlegend=False,
+        )
+        fig.add_trace(go.Scatter(**hover_marker_values_top))
+        # copy the customdata and hovertemplate from the top marker just multiplying the y value by -1
+        hover_marker_values_bottom = hover_marker_values_top.copy()
+        hover_marker_values_bottom["y"] = [-1 * hover_marker_values_top["y"][0]]
+        fig.add_trace(go.Scatter(**hover_marker_values_bottom))
+
         # plot top base
         x_top = [zpos, zpos, zs0, zs1]
         yl_top = [
@@ -1363,6 +1444,63 @@ def __init__(
         # make seals with half the bearing size as a default
         self.scale_factor = scale_factor if scale_factor else self.scale_factor / 2
 
+    def _hover_info(self, frequency=None):
+        """Generate hover information for seal element.
+
+        Overrides the base class method to include seal-specific information
+        such as cross-coupled coefficients and seal leakage.
+
+        Parameters
+        ----------
+        frequency : float, optional
+            Frequency at which to display coefficients (rad/s).
+            Not used - displays coefficients at first and last frequencies.
+
+        Returns
+        -------
+        customdata : list
+            Data to attach to hover trace.
+        hovertemplate : str
+            Template string for hover display with HTML formatting.
+        """
+        # Get first and last frequencies
+        if self.frequency is not None:
+            if hasattr(self.frequency, "__iter__"):
+                freq_0 = self.frequency[0]
+                freq_1 = self.frequency[-1]
+            else:
+                freq_0 = freq_1 = self.frequency
+        else:
+            freq_0 = freq_1 = 0
+
+        # Convert frequencies to RPM
+        freq_0_rpm = Q_(freq_0, "rad/s").to("RPM").m
+        freq_1_rpm = Q_(freq_1, "rad/s").to("RPM").m
+
+        # Build hover template directly
+        hovertemplate = f"Seal at Node: {self.n}<br>"
+        if self.tag is not None:
+            hovertemplate = f"Tag: {self.tag}<br>" + hovertemplate
+
+        hovertemplate += f"Frequency: {freq_0_rpm:.2f} ... {freq_1_rpm:.2f} RPM<br>"
+        hovertemplate += (
+            f"Kxx: {self.kxx_interpolated(freq_0):.3e} ... {self.kxx_interpolated(freq_1):.3e} N/m<br>"
+            f"Kyy: {self.kyy_interpolated(freq_0):.3e} ... {self.kyy_interpolated(freq_1):.3e} N/m<br>"
+            f"Kxy: {self.kxy_interpolated(freq_0):.3e} ... {self.kxy_interpolated(freq_1):.3e} N/m<br>"
+            f"Kyx: {self.kyx_interpolated(freq_0):.3e} ... {self.kyx_interpolated(freq_1):.3e} N/m<br>"
+            f"Cxx: {self.cxx_interpolated(freq_0):.3e} ... {self.cxx_interpolated(freq_1):.3e} N·s/m<br>"
+            f"Cyy: {self.cyy_interpolated(freq_0):.3e} ... {self.cyy_interpolated(freq_1):.3e} N·s/m<br>"
+            f"Cxy: {self.cxy_interpolated(freq_0):.3e} ... {self.cxy_interpolated(freq_1):.3e} N·s/m<br>"
+            f"Cyx: {self.cyx_interpolated(freq_0):.3e} ... {self.cyx_interpolated(freq_1):.3e} N·s/m<br>"
+        )
+
+        if self.seal_leakage is not None:
+            hovertemplate += f"Seal Leakage: {self.seal_leakage:.3e}<br>"
+
+        customdata = [self.n]
+
+        return customdata, hovertemplate
+
 
 class BallBearingElement(BearingElement):
     """A bearing element for ball bearings.
@@ -1490,6 +1628,44 @@ def __init__(
             color=color,
         )
 
+    def _hover_info(self, frequency=None):
+        """Generate hover information for ball bearing element.
+
+        Overrides the base class method to include ball bearing-specific
+        geometric and operating parameters.
+
+        Parameters
+        ----------
+        frequency : float, optional
+            Frequency at which to display coefficients (rad/s).
+            Not used for ball bearings (frequency-independent).
+
+        Returns
+        -------
+        customdata : list
+            Data to attach to hover trace.
+        hovertemplate : str
+            Template string for hover display with HTML formatting.
+        """
+        hovertemplate = f"Ball Bearing at Node: {self.n}<br>"
+        if self.tag is not None:
+            hovertemplate = f"Tag: {self.tag}<br>" + hovertemplate
+
+        hovertemplate += (
+            f"Number of Balls: {self.n_balls:.0f}<br>"
+            f"Ball Diameter: {self.d_balls:.4f} m<br>"
+            f"Static Load: {self.fs:.2f} N<br>"
+            f"Contact Angle: {self.alpha:.3f} rad<br>"
+            f"Kxx: {self.kxx[0]:.3e} N/m<br>"
+            f"Kyy: {self.kyy[0]:.3e} N/m<br>"
+            f"Cxx: {self.cxx[0]:.3e} N·s/m<br>"
+            f"Cyy: {self.cyy[0]:.3e} N·s/m<br>"
+        )
+
+        customdata = [self.n]
+
+        return customdata, hovertemplate
+
 
 class RollerBearingElement(BearingElement):
     """A bearing element for roller bearings.
@@ -1805,6 +1981,46 @@ def __init__(
             color=color,
         )
 
+    def _hover_info(self, frequency=None):
+        """Generate hover information for magnetic bearing element.
+
+        Overrides the base class method to include magnetic bearing-specific
+        electromagnetic and control parameters.
+
+        Parameters
+        ----------
+        frequency : float, optional
+            Frequency at which to display coefficients (rad/s).
+            Not used for magnetic bearings (frequency-independent).
+
+        Returns
+        -------
+        customdata : list
+            Data to attach to hover trace.
+        hovertemplate : str
+            Template string for hover display with HTML formatting.
+        """
+        hovertemplate = f"Magnetic Bearing at Node: {self.n}<br>"
+        if self.tag is not None:
+            hovertemplate = f"Tag: {self.tag}<br>" + hovertemplate
+
+        hovertemplate += (
+            f"Air Gap (g0): {self.g0:.4e} m<br>"
+            f"Bias Current (i0): {self.i0:.2f} A<br>"
+            f"Pole Area: {self.ag:.4e} m²<br>"
+            f"Windings: {self.nw:.0f}<br>"
+            f"PID Kp: {self.kp_pid:.3e}<br>"
+            f"PID Kd: {self.kd_pid:.3e}<br>"
+            f"Kxx: {self.kxx[0]:.3e} N/m<br>"
+            f"Kyy: {self.kyy[0]:.3e} N/m<br>"
+            f"Cxx: {self.cxx[0]:.3e} N·s/m<br>"
+            f"Cyy: {self.cyy[0]:.3e} N·s/m<br>"
+        )
+
+        customdata = [self.n]
+
+        return customdata, hovertemplate
+
     def compute_pid_amb(self, dt, current_offset, setpoint, disp, dof_index):
         """Compute PID control force for a single AMB DoF (x or y).
 
@@ -2080,6 +2296,59 @@ def __init__(
             **kwargs,
         )
 
+    def _hover_info(self, frequency=None):
+        """Generate hover information for cylindrical bearing element.
+
+        Overrides the base class method to include cylindrical bearing-specific
+        fluid film parameters and operating conditions.
+
+        Parameters
+        ----------
+        frequency : float, optional
+            Frequency at which to display coefficients (rad/s).
+            Not used - displays coefficients at first and last speeds.
+
+        Returns
+        -------
+        customdata : list
+            Data to attach to hover trace.
+        hovertemplate : str
+            Template string for hover display with HTML formatting.
+        """
+        # Get first and last speeds
+        freq_0 = self.speed[0]
+        freq_1 = self.speed[-1]
+        idx_0 = 0
+        idx_1 = -1
+
+        # Convert speeds to RPM
+        freq_0_rpm = Q_(freq_0, "rad/s").to("RPM").m
+        freq_1_rpm = Q_(freq_1, "rad/s").to("RPM").m
+
+        hovertemplate = f"Cylindrical Bearing at Node: {self.n}<br>"
+        if self.tag is not None:
+            hovertemplate = f"Tag: {self.tag}<br>" + hovertemplate
+
+        hovertemplate += (
+            f"Length: {self.bearing_length:.4f} m<br>"
+            f"Journal Diameter: {self.journal_diameter:.4f} m<br>"
+            f"Radial Clearance: {self.radial_clearance:.4e} m<br>"
+            f"Oil Viscosity: {self.oil_viscosity:.4f} Pa·s<br>"
+            f"Load: {self.weight:.2f} N<br>"
+            f"Speed: {freq_0_rpm:.2f} ... {freq_1_rpm:.2f} RPM<br>"
+            f"Eccentricity: {self.eccentricity[idx_0]:.4f} ... {self.eccentricity[idx_1]:.4f}<br>"
+            f"Attitude Angle: {self.attitude_angle[idx_0]:.4f} ... {self.attitude_angle[idx_1]:.4f} rad<br>"
+            f"Sommerfeld: {self.sommerfeld[idx_0]:.3e} ... {self.sommerfeld[idx_1]:.3e}<br>"
+            f"Kxx: {self.kxx_interpolated(freq_0):.3e} ... {self.kxx_interpolated(freq_1):.3e} N/m<br>"
+            f"Kyy: {self.kyy_interpolated(freq_0):.3e} ... {self.kyy_interpolated(freq_1):.3e} N/m<br>"
+            f"Cxx: {self.cxx_interpolated(freq_0):.3e} ... {self.cxx_interpolated(freq_1):.3e} N·s/m<br>"
+            f"Cyy: {self.cyy_interpolated(freq_0):.3e} ... {self.cyy_interpolated(freq_1):.3e} N·s/m<br>"
+        )
+
+        customdata = [self.n]
+
+        return customdata, hovertemplate
+
 
 def bearing_example():
     """Create an example of bearing element.

ross/bearing_seal_element.py

@@ -436,6 +436,22 @@ def _patch(self, position, fig):
 
         return fig
 
+    @staticmethod
+    def calculate_mass(rho, width, i_d, o_d):
+        return rho * np.pi * width * (o_d**2 - i_d**2) / 4
+
+    @staticmethod
+    def calculate_Ip(m, i_d, o_d):
+        return m * (o_d**2 + i_d**2) / 8
+
+    @staticmethod
+    def calculate_Id(Ip, m, width):
+        return 1 / 2 * Ip + 1 / 12 * m * width**2
+
+    @staticmethod
+    def calculate_width(rho, m, i_d, o_d):
+        return 4 * m / (rho * np.pi * (o_d**2 - i_d**2))
+
     @classmethod
     @check_units
     def from_geometry(
@@ -500,11 +516,9 @@ def from_geometry(
         >>> disk.Ip
         0.32956362089137037
         """
-        m = material.rho * np.pi * width * (o_d**2 - i_d**2) / 4
-        Ip = m * (o_d**2 + i_d**2) / 8
-        Id = 1 / 2 * Ip + 1 / 12 * m * width**2
-
-        tag = tag
+        m = cls.calculate_mass(material.rho, width, i_d, o_d)
+        Ip = cls.calculate_Ip(m, i_d, o_d)
+        Id = cls.calculate_Id(Ip, m, width)
 
         return cls(n, m, Id, Ip, tag, scale_factor, color)