wecopttool.wave_excitation

wave_excitation(exc_coeff, waves)[source]

Calculate the complex, frequency-domain, excitation force due to waves.

The resulting force is indexed only by frequency and not direction angle. The input waves frequencies must be same as exc_coeff, but the directions can be a subset.

Parameters:
  • exc_coeff (DataArray) – Complex excitation coefficients indexed by frequency and direction angle.

  • waves (Dataset) – Complex frequency-domain wave elevation.

Raises:
  • ValueError – If the frequency vectors of exc_coeff and waves are different.

  • ValueError – If any of the directions in waves is not in exc_coeff.

Return type:

ndarray