ross.ClearanceResults

ross.ClearanceResults#

class ross.ClearanceResults(speed_rpm, bearing_nodes, magnitudes, clearance, clearance_75)#

Results for clearance analysis.

Stores vibration amplitudes at bearing locations and compares them with bearing radial clearance limits. Inherits Results for save / load like other analysis result types.

Parameters:
speed_rpmfloat

Rotor speed in RPM.

bearing_nodeslist

List of bearing node numbers.

magnitudesndarray

Peak-to-peak vibration amplitudes (microns).

clearancendarray

Radial clearance (microns).

clearance_75ndarray

75% of radial clearance (microns).

Methods

__init__(speed_rpm, bearing_nodes, magnitudes, clearance, clearance_75)#
classmethod load(file)#

Load results from a .toml or .json file.

This function will load the simulation results from a .toml or .json file. The file must have all the argument’s names and values that are needed to reinstantiate the class.

Parameters:
filestr, pathlib.Path

The name of the file the results will be loaded from.

Examples

>>> # Example running a stochastic unbalance response
>>> from tempfile import tempdir
>>> from pathlib import Path
>>> import ross as rs
>>> # Running an example
>>> rotor = rs.rotor_example()
>>> freq_range = np.linspace(0, 500, 31)
>>> n = 3
>>> m = 0.01
>>> p = 0.0
>>> results = rotor.run_unbalance_response(n, m, p, freq_range)
>>> # create path for a temporary file
>>> file = Path(tempdir) / 'unb_resp.toml'
>>> results.save(file)
>>> # Loading file
>>> results2 = rs.ForcedResponseResults.load(file)
>>> abs(results2.forced_resp).all() == abs(results.forced_resp).all()
True
plot(fig=None, **kwargs)#

Plot vibration response against clearance limits.

Parameters:
figplotly.graph_objects.Figure, optional

Existing figure to add traces to.

**kwargsoptional

Additional layout arguments.

Returns:
figplotly.graph_objects.Figure
classmethod read_toml_data(data)#

Read and parse data stored in a .toml file.

The data passed to this method needs to be according to the format saved in the .toml file by the .save() method.

Parameters:
datadict

Dictionary obtained from toml.load().

Returns:
The result object.
save(file)#

Save results in a .toml or .json file.

This function will save the simulation results to a .toml or .json file. The file will have all the argument’s names and values that are needed to reinstantiate the class.

Parameters:
filestr, pathlib.Path

The name of the file the results will be saved in. The format is determined by the file extension (.toml or .json).

Examples

>>> # Example running a unbalance response
>>> from tempfile import tempdir
>>> from pathlib import Path
>>> import ross as rs

>>> # Running an example
>>> rotor = rs.rotor_example()
>>> speed = np.linspace(0, 1000, 101)
>>> response = rotor.run_unbalance_response(node=3,
...                                         unbalance_magnitude=0.001,
...                                         unbalance_phase=0.0,
...                                         frequency=speed)

>>> # create path for a temporary file
>>> file = Path(tempdir) / 'unb_resp.toml'
>>> response.save(file)
Contents