API Reference

Material

Material(name, rho[, E, G_s, Poisson, color])

Material used on shaft and disks.

Elements

ShaftElement(L, idl, odl[, idr, odr, ...])

A shaft element.

ShaftElement6DoF(L, idl, odl[, idr, odr, ...])

A 6 Degrees of Freedom shaft element.

DiskElement(n, m, Id, Ip[, tag, ...])

A disk element.

BearingElement(n, kxx, cxx[, kyy, kxy, kyx, ...])

A bearing element.

BearingElement6DoF(n, kxx, cxx[, kyy, cyy, ...])

A generalistic 6 DoF bearing element.

SealElement(n, kxx, cxx[, kyy, kxy, kyx, ...])

A seal element.

BallBearingElement(n, n_balls, d_balls, fs, ...)

A bearing element for ball bearings.

RollerBearingElement(n, n_rollers, ...[, ...])

A bearing element for roller bearings.

BearingFluidFlow(n, nz, ntheta, length, ...)

Instantiate a bearing using inputs from its fluid flow.

MagneticBearingElement(n, g0, i0, ag, nw, ...)

Magnetic bearing.

Rotor and Results

Rotor class and available methods for analysis (run_ methods).

Rotor(shaft_elements[, disk_elements, ...])

A rotor object.

Rotor.run_modal(speed[, num_modes, sparse])

Run modal analysis.

Rotor.run_critical_speed([speed_range, ...])

Calculate the critical speeds and damping ratios for the rotor model.

Rotor.run_freq_response([speed_range, ...])

Frequency response for a mdof system.

Rotor.run_forced_response([force, ...])

Forced response for a mdof system.

Rotor.run_unbalance_response(node, ...[, ...])

Unbalanced response for a mdof system.

Rotor.run_campbell(speed_range[, ...])

Calculate the Campbell diagram.

Rotor.run_time_response(speed, F, t)

Calculate the time response.

Rotor.run_level1([n, stiffness_range, num])

Plot level 1 stability analysis.

Rotor.run_ucs([stiffness_range, ...])

Run Undamped Critical Speeds analyzes.

Rotor.run_static()

Run static analysis.

Rotor.run_misalignment([coupling])

Run an analyzes with misalignment.

Rotor.run_rubbing(**kwargs)

Run an analyzes with rubbing.

Rotor.run_crack(**kwargs)

Run an analyzes with rubbing.

Results

These are classes used to store results and to provide useful methods such as plotting.

Orbit(*, node, node_pos, ru_e, rv_e)

Class used to construct orbits for a node in a mode or deflected shape.

Shape(vector, nodes, nodes_pos, ...[, normalize])

Class used to construct a mode or a deflected shape from a eigen or response vector.

CriticalSpeedResults(_wn, _wd, log_dec, ...)

Class used to store results from run_critical_speed() method.

ModalResults(speed, evalues, evectors, wn, ...)

Class used to store results and provide plots for Modal Analysis.

CampbellResults(speed_range, wd, log_dec, ...)

Class used to store results and provide plots for Campbell Diagram.

FrequencyResponseResults(freq_resp, ...)

Class used to store results and provide plots for Frequency Response.

ForcedResponseResults(rotor, forced_resp, ...)

Class used to store results and provide plots for Forced Response analysis.

StaticResults(deformation, Vx, Bm, w_shaft, ...)

Class used to store results and provide plots for Static Analysis.

SummaryResults(df_shaft, df_disks, ...)

Class used to store results and provide plots rotor summary.

ConvergenceResults(el_num, eigv_arr, error_arr)

Class used to store results and provide plots for Convergence Analysis.

TimeResponseResults(rotor, t, yout, xout)

Class used to store results and provide plots for Time Response Analysis.

Level1Results(stiffness_range, log_dec)

Class used to store results and provide plots for Level 1 Stability Analysis.

UCSResults(stiffness_range, stiffness_log, ...)

Class used to store results and provide plots for UCS Analysis.