capytaine.post_pro.rao module

Experimental function to compute the Response Amplitude Operator.

capytaine.post_pro.rao.rao(dataset, wave_direction=None, dissipation=None, stiffness=None)[source]

Response Amplitude Operator.

Parameters:

  • dataset (xarray Dataset) – The hydrodynamical dataset. This function supposes that variables named ‘inertia_matrix’ and ‘hydrostatic_stiffness’ are in the dataset. Other variables can be computed by Capytaine, by those two should be manually added to the dataset.

  • wave_direction (float, optional) – Select a wave directions for the computation. (Not recommended, kept for legacy.) Default: all wave directions in the dataset.

  • dissipation (array, optional) – An optional dissipation matrix (e.g. Power Take Off) to be included in the RAO. Default: none.

  • stiffness (array, optional) – An optional stiffness matrix (e.g. mooring stiffness) to be included in the RAO. Default: none.

Returns:

The RAO as an array depending of omega and the degree of freedom.

Return type:

xarray DataArray