class pyfes.core.Wave

Bases: pybind11_object

Wave definition

__init__(*args, **kwargs)

class TidalType

Bases: pybind11_object

Possible type of tidal wave

Members:

kLongPeriod : Long period tidal waves

kShortPeriod : Short period tidal waves

property name

property admittance

Returns True if the wave is computed by admittance.

doodson_numbers(self: pyfes.core.Wave) → Annotated[list[int], 'FixedSize(7)']

Gets the Doodson representation of the wave.

Note

The 7th number follows the convention established in Doodson & Warburg’s 1941 book. This number can be 0, 1, 2, or -1, representing multiples of 90 degrees added to the tidal argument when using cosine functions.

Returns:

Doodson numbers.

property dynamic

Returns True if the wave is computed by dynamically.

property f

Gets the nodal correction for amplitude

property freq

Gets the wave frequency (radians per seconds)

property ident

Gets the wave ident

name(self: pyfes.core.Wave) → str

Gets the wave name

nodal_a(self: pyfes.core.Wave, a: pyfes.core.AstronomicAngle) → None

Compute nodal corrections from SCHUREMAN (1958).

Parameters:

a – Astronomic angle

nodal_g(self: pyfes.core.Wave, a: pyfes.core.AstronomicAngle) → None

Compute nodal corrections from SCHUREMAN (1958).

Parameters:

a – Astronomic angle

period(self: pyfes.core.Wave) → float

Gets the wave period in hours.

property tide

Gets the tide associated to the wave.

property type

Gets the wave type

property u

Gets the nodal correction for phase

v(self: pyfes.core.Wave) → float

Gets \(v\) (greenwich argument)

vu(self: pyfes.core.Wave) → float

Gets \(v\) (greenwich argument) + \(u\) (nodal correction for phase)

xdo_alphabetical(self: pyfes.core.Wave) → str

Gets the XDO alphabetical representation of the wave.

Returns:

XDO alphabetical representation.

xdo_numerical(self: pyfes.core.Wave) → str

Gets the XDO numerical representation of the wave.

Returns:

XDO numerical representation.