pyfes.core.evaluate_tide(tidal_model: pyfes.core.AbstractTidalModelComplex64 | pyfes.core.AbstractTidalModelComplex128, date: VectorDateTime64, longitude: VectorFloat64, latitude: VectorFloat64, num_threads: int = 0) → Tuple[VectorFloat64, VectorFloat64, VectorFloat8]#

Ocean tide calculation.

Parameters:

  • tidal_model – Tidal model used to interpolate the modelized waves

  • date – Date of the tide calculation

  • longitude – Longitude in degrees for the position at which the tide is calculated

  • latitude – Latitude in degrees for the position at which the tide is calculated

Returns:

A tuple of three elements that contains:

  • The height of the diurnal and semi-diurnal constituents of the tidal spectrum (cm)

  • The height of the long period wave constituents of the tidal spectrum (cm)

  • A flag indicating if the tide is correctly estimated or not. Possible values are

    0

    The tide is undefined because the position is outside the domain of the tidal model or the numerical model is undefined for the requested spatial position.

    1

    The tide is extrapolated with the nearest mesh point.

    2

    The tide is extrapolated using a linear interpolation with two surrounding grid points.

    3

    The tide is extrapolated using a linear interpolation with three surrounding grid points.

    4

    The tide is correctly estimated.

Note

The flag value 2, 4 or 8 are only possible if the tidal model used is a Cartesian grid.