Merge pull request #1200 from jguarato/dev/print-table

Add format_table methods

Author: raphaeltimbo

requirements.txt

@@ -7,4 +7,5 @@ xlrd
 pint>=0.18
 methodtools
 numba
-ccp-performance
+ccp-performance
+prettytable

ross/bearing_seal_element.py

@@ -8,6 +8,7 @@
 import toml
 import warnings
 from inspect import signature
+from prettytable import PrettyTable
 from numpy.polynomial import Polynomial
 from plotly import graph_objects as go
 from scipy import interpolate as interpolate
@@ -259,6 +260,19 @@ def _process_coefficient(self, coefficient):
 
         return coefficient, interpolated
 
+    def _get_coefficient_list(self, ignore_mass=False):
+        """List with all bearing coefficients as strings"""
+        coefficients = [
+            attr.replace("_interpolated", "")
+            for attr in self.__dict__.keys()
+            if "_interpolated" in attr
+        ]
+
+        if ignore_mass:
+            coefficients = [coeff for coeff in coefficients if "m" not in coeff]
+
+        return coefficients
+
     def plot(
         self,
         coefficients=None,
@@ -357,6 +371,97 @@ def plot(
 
         return fig
 
+    @check_units
+    def format_table(
+        self,
+        frequency=None,
+        coefficients=None,
+        frequency_units="rad/s",
+        stiffness_units="N/m",
+        damping_units="N*s/m",
+        mass_units="kg",
+    ):
+        """Return frequency vs coefficients in table format.
+
+        Parameters
+        ----------
+        frequency : array, pint.Quantity, optional
+            Array with frequencies (rad/s).
+            Default is 5 values from min to max frequency.
+        coefficients : list, str, optional
+            List or str with the coefficients to include.
+            Defaults is a list of stiffness and damping coefficients.
+        frequency_units : str, optional
+            Frequency units.
+            Default is rad/s.
+        stiffness_units : str, optional
+            Stiffness units.
+            Default is N/m.
+        damping_units : str, optional
+            Damping units.
+            Default is N*s/m.
+        mass_units : str, optional
+            Mass units.
+            Default is kg.
+
+        Returns
+        -------
+        table : PrettyTable object
+            Table object with bearing coefficients to be printed.
+
+        Example
+        -------
+        >>> bearing = bearing_example()
+        >>> table = bearing.format_table(
+        ...     frequency=[0, 50, 100, 150, 200],
+        ...     coefficients=['kxx', 'kxy', 'cxx', 'cxy']
+        ... )
+        >>> print(table)
+        +-------------------+-----------+-----------+-------------+-------------+
+        | Frequency [rad/s] | kxx [N/m] | kxy [N/m] | cxx [N*s/m] | cxy [N*s/m] |
+        +-------------------+-----------+-----------+-------------+-------------+
+        |        0.0        | 1000000.0 |    0.0    |    200.0    |     0.0     |
+        |        50.0       | 1000000.0 |    0.0    |    200.0    |     0.0     |
+        |       100.0       | 1000000.0 |    0.0    |    200.0    |     0.0     |
+        |       150.0       | 1000000.0 |    0.0    |    200.0    |     0.0     |
+        |       200.0       | 1000000.0 |    0.0    |    200.0    |     0.0     |
+        +-------------------+-----------+-----------+-------------+-------------+
+        """
+        if isinstance(coefficients, str):
+            coefficients = [coefficients]
+        elif coefficients is None:
+            coefficients = self._get_coefficient_list(ignore_mass=True)
+
+        default_units = {"k": "N/m", "c": "N*s/m", "m": "kg"}
+        y_units = {"k": stiffness_units, "c": damping_units, "m": mass_units}
+
+        if frequency is None:
+            frequency = np.linspace(min(self.frequency), max(self.frequency), 5)
+        frequency_range = Q_(frequency, "rad/s").to(frequency_units).m
+
+        headers = [f"Frequency [{frequency_units}]"]
+        data = [frequency_range]
+
+        table = PrettyTable()
+
+        for coeff in coefficients:
+            headers.append(f"{coeff} [{default_units[coeff[0]]}]")
+            columns = (
+                Q_(
+                    getattr(self, f"{coeff}_interpolated")(frequency),
+                    default_units[coeff[0]],
+                )
+                .to(y_units[coeff[0]])
+                .m
+            )
+            data.append(columns)
+
+        table.field_names = headers
+        for row in np.array(data).T:
+            table.add_row(row.round(5))
+
+        return table
+
     def __repr__(self):
         """Return a string representation of a bearing element.
 
@@ -412,11 +517,7 @@ def __eq__(self, other):
                 self.__dict__.keys()
             )
 
-            coefficients = {
-                attr.replace("_interpolated", "")
-                for attr in self.__dict__.keys()
-                if "_interpolated" in attr
-            }
+            coefficients = set(self._get_coefficient_list())
 
             compared_attributes = list(coefficients.union(init_args))
             compared_attributes.sort()
@@ -449,11 +550,7 @@ def save(self, file):
             self.__dict__.keys()
         )
 
-        coefficients = {
-            attr.replace("_interpolated", "")
-            for attr in self.__dict__.keys()
-            if "_interpolated" in attr
-        }
+        coefficients = set(self._get_coefficient_list())
 
         args = list(coefficients.union(init_args))
         args.sort()

ross/results.py

@@ -6,6 +6,7 @@
 import copy
 import inspect
 from abc import ABC
+from prettytable import PrettyTable
 from collections.abc import Iterable
 from warnings import warn
 
@@ -1520,7 +1521,7 @@ class CriticalSpeedResults(Results):
     _wn : array
         Undamped critical speeds array.
     _wd : array
-        Undamped critical speeds array.
+        Damped critical speeds array.
     log_dec : array
         Logarithmic decrement for each critical speed.
     damping_ratio : array
@@ -1781,7 +1782,6 @@ def whirl_values(self):
     def data_mode(
         self,
         mode=None,
-        length_units="m",
         frequency_units="rad/s",
         damping_parameter="log_dec",
     ):
@@ -1791,9 +1791,9 @@ def data_mode(
         ----------
         mode : int
             The n'th vibration mode
-        length_units : str, optional
-            length units.
-            Default is 'm'.
+        frequency_units : str, optional
+            Frequency units.
+            Default is "rad/s".
         damping_parameter : str, optional
             Define which value to show for damping. We can use "log_dec" or "damping_ratio".
             Default is "log_dec".
@@ -1825,6 +1825,44 @@ def data_mode(
 
         return df
 
+    def format_table(
+        self,
+        frequency_units="rad/s",
+    ):
+        """Return natural frequencies and damping ratios of modes in table format
+
+        Parameters
+        ----------
+        frequency_units : str, optional
+            Frequency units.
+            Default is "rad/s".
+
+        Returns
+        -------
+        table : PrettyTable object
+            Table object with natural frequencies and damping ratios of modes.
+        """
+
+        wn = Q_(self.wn, "rad/s").to(frequency_units).m
+        wd = Q_(self.wd, "rad/s").to(frequency_units).m
+        damping_ratio = self.damping_ratio
+        log_dec = self.log_dec
+
+        headers = [
+            "Mode",
+            f"Undamped natural frequencies [{frequency_units}]",
+            f"Damped natural frequencies [{frequency_units}]",
+            "Damping ratio",
+            "Logarithmic decrement",
+        ]
+
+        table = PrettyTable()
+        table.field_names = headers
+        for row in zip(range(len(wn)), wn, wd, damping_ratio, log_dec):
+            table.add_row(row)
+
+        return table
+
     def plot_mode_3d(
         self,
         mode=None,
@@ -1883,7 +1921,7 @@ def plot_mode_3d(
         if fig is None:
             fig = go.Figure()
 
-        df = self.data_mode(mode, length_units, frequency_units, damping_parameter)
+        df = self.data_mode(mode, frequency_units, damping_parameter)
 
         damping_name = df["damping_name"].values[0]
         damping_value = df["damping_value"].values[0]
@@ -1962,7 +2000,6 @@ def plot_mode_2d(
         orientation="major",
         frequency_type="wd",
         title=None,
-        length_units="m",
         frequency_units="rad/s",
         damping_parameter="log_dec",
         **kwargs,
@@ -1986,9 +2023,6 @@ def plot_mode_2d(
             A brief title to the mode shape plot, it will be displayed above other
             relevant data in the plot area. It does not modify the figure layout from
             Plotly.
-        length_units : str, optional
-            length units.
-            Default is 'm'.
         frequency_units : str, optional
             Frequency units that will be used in the plot title.
             Default is rad/s.
@@ -2006,7 +2040,7 @@ def plot_mode_2d(
             The figure object with the plot.
         """
 
-        df = self.data_mode(mode, length_units, frequency_units, damping_parameter)
+        df = self.data_mode(mode, frequency_units, damping_parameter)
 
         damping_name = df["damping_name"].values[0]
         damping_value = df["damping_value"].values[0]
@@ -2059,9 +2093,6 @@ def plot_orbit(
         mode=None,
         nodes=None,
         fig=None,
-        frequency_type="wd",
-        title=None,
-        frequency_units="rad/s",
         **kwargs,
     ):
         """Plot (2D view) the mode shapes.
@@ -2075,17 +2106,6 @@ def plot_orbit(
             Int or list of ints with the nodes selected to be plotted.
         fig : Plotly graph_objects.Figure()
             The figure object with the plot.
-        frequency_type : str, optional
-            "wd" calculates de map for the damped natural frequencies.
-            "wn" calculates de map for the undamped natural frequencies.
-            Defaults is "wd".
-        title : str, optional
-            A brief title to the mode shape plot, it will be displayed above other
-            relevant data in the plot area. It does not modify the figure layout from
-            Plotly.
-        frequency_units : str, optional
-            Frequency units that will be used in the plot title.
-            Default is rad/s.
         kwargs : optional
             Additional key word arguments can be passed to change the plot layout only
             (e.g. width=1000, height=800, ...).
@@ -4470,7 +4490,6 @@ def plot_bending_moment(
     def plot_deflected_shape(
         self,
         speed,
-        samples=101,
         frequency_units="rad/s",
         amplitude_units="m",
         phase_units="rad",
@@ -4493,9 +4512,6 @@ def plot_deflected_shape(
         speed : float, pint.Quantity
             The rotor rotation speed. Must be an element from the speed_range argument
             passed to the class (rad/s).
-        samples : int, optional
-            Number of samples to generate the orbit for each node.
-            Default is 101.
         frequency_units : str, optional
             Frequency units.
             Default is "rad/s"

ross/rotor_assembly.py

@@ -769,12 +769,12 @@ def run_modal(self, speed, num_modes=12, sparse=True, synchronous=False):
         """Run modal analysis.
 
         Method to calculate eigenvalues and eigvectors for a given rotor system.
-        Tthe natural frequencies and dampings ratios are calculated for a given
+        The natural frequencies and dampings ratios are calculated for a given
         rotor speed. It means that for each speed input there's a different set of
         eigenvalues and eigenvectors, hence, different natural frequencies and damping
         ratios are returned.
         This method will return a ModalResults object which stores all data generated
-        and also provides so methods for plotting.
+        and also provides methods for plotting.
 
         Available plotting methods:
             .plot_mode_2d()