ross.BearingResults

class ross.BearingResults(frequency, pressure_fields, temperature_fields, initial_time=None, final_time=None)

Abstract base class for fluid film bearing post-processing results.

Each bearing class (FluidFilmBearing and its subclasses, ThrustPad, SqueezeFilmDamper) creates a _results attribute of the corresponding subclass after the solver runs. The bearing then delegates every plot_* and show_* call to that object via __getattr__, so the end user never needs to access _results directly.

Subclasses implement bearing-specific visualization while sharing common infrastructure (execution-time display and the plot_results orchestrator).

Parameters:

frequencyarray_like

Operating frequencies in rad/s (one value per solved point).

pressure_fieldslist of ndarray

Pressure field arrays, one per frequency.

temperature_fieldslist of ndarray

Temperature field arrays, one per frequency.

initial_timefloat, optional

Epoch timestamp recorded at the start of the solver run.

final_timefloat, optional

Epoch timestamp recorded at the end of the solver run.

Examples

>>> from ross.bearings.tilting_pad import tilting_pad_adiabatic_example
>>> bearing = tilting_pad_adiabatic_example()
>>> type(bearing).__name__
'TiltingPad'

Methods

__init__(frequency, pressure_fields, temperature_fields, initial_time=None, final_time=None)

abstractmethod plot_film_temperature_3d(freq_index=0, fig=None, **kwargs)

Return a 3-D surface plot of the oil film temperature field.

The plotted quantity is the temperature of the lubricant film. Solid (pad) temperatures are not shown here.

Parameters:

freq_indexint, optional

Frequency index. Default is 0.

figgo.Figure, optional

Existing figure to add the trace to.

Returns:

figgo.Figure

plot_pad_temperature_3d(freq_index=0, fig=None, **kwargs)

Return a 3-D mesh of the bearing pads colored by temperature.

This is the through-pad (circumferential x radial) counterpart of plot_film_temperature_3d: the pad geometry is drawn at its physical position and colored by the solid pad / babbitt temperature, showing how much heat crosses from the film into the pad.

The method is part of the common bearing plotting API, so it exists on every bearing result class. Classes whose model does not compute a solid pad temperature field raise NotImplementedError.

Parameters:

freq_indexint, optional

Frequency index. Default is 0.

figgo.Figure, optional

Existing figure to add the trace to.

Returns:

figgo.Figure

Raises:

NotImplementedError

When the bearing model does not provide a solid pad temperature field.

abstractmethod plot_pressure_2d(freq_index=0, fig=None, **kwargs)

Return a 2-D contour plot of the pressure field.

Parameters:

freq_indexint, optional

Frequency index. Default is 0.

figgo.Figure, optional

Existing figure to add the trace to.

Returns:

figgo.Figure

abstractmethod plot_pressure_3d(freq_index=0, fig=None, **kwargs)

Return a 3-D surface plot of the pressure field.

Parameters:

freq_indexint, optional

Frequency index. Default is 0.

figgo.Figure, optional

Existing figure to add the trace to.

Returns:

figgo.Figure

plot_results(show_plots=False, freq_index=0)

Generate and return all standard bearing result plots.

Calls the four abstract plot_* methods and collects their figures into a standardized dictionary. Subclasses may override this method to add bearing-specific figures while calling super().plot_results().

Parameters:

show_plotsbool, optional

When True each figure is displayed immediately via fig.show(). Default is False.

freq_indexint, optional

Index into the frequency array selecting which solved point to visualize. Default is 0 (first frequency).

Returns:

figuresdict

Dictionary with keys "pressure_2d", "pressure_3d", "temperature_2d", and "film_temperature_3d". Each value is a plotly.graph_objects.Figure.

abstractmethod plot_temperature_2d(freq_index=0, fig=None, **kwargs)

Return a 2-D contour plot of the temperature field.

Parameters:

freq_indexint, optional

Frequency index. Default is 0.

figgo.Figure, optional

Existing figure to add the trace to.

Returns:

figgo.Figure

plot_temperature_3d(*args, **kwargs)

Deprecated alias for plot_film_temperature_3d().

Deprecated since version 2.4.0: plot_temperature_3d is deprecated and will be removed in a future version. Use plot_film_temperature_3d instead, which states explicitly that the plotted field is the oil film temperature.

Returns:

figgo.Figure

abstractmethod show_coefficients_comparison()

Print a table comparing dynamic coefficients across frequencies.

Returns:

None

show_execution_time()

Display the total solver execution time.

Parameters:

None

Returns:

None

Prints the elapsed time in seconds to the console.

abstractmethod show_results()

Print a formatted summary of the bearing analysis results.

Returns:

None