wecopttool.core.force_from_rao_transfer_function

force_from_rao_transfer_function(rao_transfer_mat, zero_freq=True)[source]

Create a force function from its position transfer matrix.

This is the position equivalent to the velocity-based wecopttool.force_from_impedance().

If zero_freq = False (not default), the mean (DC) component of the transfer matrix (first row) is excluded.

Parameters:

  • rao_transfer_mat (DataArray) – Complex position transfer matrix.

  • zero_freq (bool | None) – Whether the first frequency should be zero. Default is True.

Return type:

StateFunction

See also

force_from_impedance