Welcome to Python-VPP’s documentation!

class src.VPPMod.VPP(Yacht)

A VPP Class that run an analysis on a given Yacht.

polar(n=1, save=False)

Generate a polar plot of the equilibrium variables.

Parameters

  • n – An integer, number of plots to show, default is 1 (Vb).

  • save – A logical, save figure or not, default is False.

resid(x0, twa, tws)

Computes the residuals of the force/moment equilibrium at the given state.

Parameters

  • x0 – A numpy array of the variables (DOF).

  • twa – A float of the TWA at which to compute the residuals.

  • tws – A float of the TWs at which to compute the residuals.

Returns

Residuals on each DOF

Return type

Numpy.Array

run(verbose=False)

Run the analysis for the given analysis range.

Parameters

verbose – A logical, if True, prints results of equilibrium at each TWA/TWS.

set_analysis(tws_range, twa_range)

Sets the analysis range.

Parameters

  • tws_range – A numpy.array with the different TWS to run the analysis at.

  • twa_range – A numpy.array with the different TWA to run the analysis at.

Indices and tables