OceanTides#

class ansys.stk.core.stkobjects.OceanTides#

Class defining the contribution of ocean tides.

Overview#

maximum_degree

Maximum degree: limit the ocean tide model to contributions of a specified maximum degree. Dimensionless.

maximum_order

Maximum order: limit the ocean tide model to contributions of a specified maximum order. Dimensionless.

minimum_amplitude

Minimum amplitude: include only those constituents whose tidal amplitude is sufficiently large by specifying the minimum amplitude to include in the computation. Uses SmallDistanceUnit Dimension.

Import detail#

from ansys.stk.core.stkobjects import OceanTides

Property detail#

property OceanTides.maximum_degree: int#

Maximum degree: limit the ocean tide model to contributions of a specified maximum degree. Dimensionless.

property OceanTides.maximum_order: int#

Maximum order: limit the ocean tide model to contributions of a specified maximum order. Dimensionless.

property OceanTides.minimum_amplitude: float#

Minimum amplitude: include only those constituents whose tidal amplitude is sufficiently large by specifying the minimum amplitude to include in the computation. Uses SmallDistanceUnit Dimension.