wecopttool.utilities.plot_power_flow

plot_power_flow(power_flows, tolerance=None)

Plot power flow through a WEC as Sankey diagram.

Parameters:

• power_flows (dict[str, float]) – Power flow dictionary produced by wecopttool.utilities.calculate_power_flows(). Required keys are 'Optimal Excitation', 'Radiated', 'Actual Excitation', 'Electrical (solver)', 'Mechanical (solver)', 'Absorbed', 'Unused Potential', and 'PTO Loss'.

• tolerance (float | None) – Tolerance value for sankey diagram.

Return type:

tuple[Figure, Axes]