TidalPy.tides.modes.mode_calc_helper package

Submodules

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl2 module

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl2.eccentricity_truncation_10_maxl_2(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 10 Max Supported l = 2

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl2.eccentricity_truncation_12_maxl_2(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 12 Max Supported l = 2

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl2.eccentricity_truncation_14_maxl_2(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 14 Max Supported l = 2

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl2.eccentricity_truncation_16_maxl_2(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 16 Max Supported l = 2

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl2.eccentricity_truncation_18_maxl_2(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 18 Max Supported l = 2

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl2.eccentricity_truncation_20_maxl_2(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 20 Max Supported l = 2

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl2.eccentricity_truncation_22_maxl_2(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 22 Max Supported l = 2

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl2.eccentricity_truncation_2_maxl_2(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 2 Max Supported l = 2

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl2.eccentricity_truncation_4_maxl_2(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 4 Max Supported l = 2

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl2.eccentricity_truncation_6_maxl_2(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 6 Max Supported l = 2

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl2.eccentricity_truncation_8_maxl_2(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 8 Max Supported l = 2

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl3 module

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl3.eccentricity_truncation_10_maxl_3(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 10 Max Supported l = 3

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl3.eccentricity_truncation_12_maxl_3(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 12 Max Supported l = 3

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl3.eccentricity_truncation_14_maxl_3(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 14 Max Supported l = 3

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl3.eccentricity_truncation_16_maxl_3(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 16 Max Supported l = 3

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl3.eccentricity_truncation_18_maxl_3(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 18 Max Supported l = 3

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl3.eccentricity_truncation_20_maxl_3(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 20 Max Supported l = 3

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl3.eccentricity_truncation_2_maxl_3(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 2 Max Supported l = 3

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl3.eccentricity_truncation_4_maxl_3(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 4 Max Supported l = 3

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl3.eccentricity_truncation_6_maxl_3(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 6 Max Supported l = 3

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl3.eccentricity_truncation_8_maxl_3(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 8 Max Supported l = 3

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl4 module

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl4.eccentricity_truncation_10_maxl_4(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 10 Max Supported l = 4

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl4.eccentricity_truncation_12_maxl_4(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 12 Max Supported l = 4

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl4.eccentricity_truncation_14_maxl_4(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 14 Max Supported l = 4

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl4.eccentricity_truncation_16_maxl_4(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 16 Max Supported l = 4

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl4.eccentricity_truncation_18_maxl_4(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 18 Max Supported l = 4

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl4.eccentricity_truncation_20_maxl_4(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 20 Max Supported l = 4

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl4.eccentricity_truncation_2_maxl_4(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 2 Max Supported l = 4

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl4.eccentricity_truncation_4_maxl_4(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 4 Max Supported l = 4

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl4.eccentricity_truncation_6_maxl_4(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 6 Max Supported l = 4

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl4.eccentricity_truncation_8_maxl_4(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 8 Max Supported l = 4

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl5 module

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl5.eccentricity_truncation_10_maxl_5(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 10 Max Supported l = 5

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl5.eccentricity_truncation_12_maxl_5(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 12 Max Supported l = 5

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl5.eccentricity_truncation_14_maxl_5(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 14 Max Supported l = 5

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl5.eccentricity_truncation_16_maxl_5(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 16 Max Supported l = 5

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl5.eccentricity_truncation_18_maxl_5(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 18 Max Supported l = 5

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl5.eccentricity_truncation_20_maxl_5(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 20 Max Supported l = 5

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl5.eccentricity_truncation_2_maxl_5(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 2 Max Supported l = 5

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl5.eccentricity_truncation_4_maxl_5(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 4 Max Supported l = 5

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl5.eccentricity_truncation_6_maxl_5(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 6 Max Supported l = 5

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl5.eccentricity_truncation_8_maxl_5(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 8 Max Supported l = 5

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl6 module

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl6.eccentricity_truncation_10_maxl_6(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 10 Max Supported l = 6

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl6.eccentricity_truncation_12_maxl_6(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 12 Max Supported l = 6

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl6.eccentricity_truncation_14_maxl_6(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 14 Max Supported l = 6

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl6.eccentricity_truncation_16_maxl_6(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 16 Max Supported l = 6

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl6.eccentricity_truncation_18_maxl_6(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 18 Max Supported l = 6

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl6.eccentricity_truncation_20_maxl_6(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 20 Max Supported l = 6

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl6.eccentricity_truncation_2_maxl_6(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 2 Max Supported l = 6

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl6.eccentricity_truncation_4_maxl_6(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 4 Max Supported l = 6

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl6.eccentricity_truncation_6_maxl_6(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 6 Max Supported l = 6

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl6.eccentricity_truncation_8_maxl_6(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 8 Max Supported l = 6

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl7 module

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl7.eccentricity_truncation_10_maxl_7(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 10 Max Supported l = 7

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl7.eccentricity_truncation_12_maxl_7(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 12 Max Supported l = 7

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl7.eccentricity_truncation_14_maxl_7(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 14 Max Supported l = 7

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl7.eccentricity_truncation_16_maxl_7(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 16 Max Supported l = 7

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl7.eccentricity_truncation_18_maxl_7(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 18 Max Supported l = 7

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl7.eccentricity_truncation_20_maxl_7(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 20 Max Supported l = 7

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl7.eccentricity_truncation_2_maxl_7(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 2 Max Supported l = 7

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl7.eccentricity_truncation_4_maxl_7(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 4 Max Supported l = 7

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl7.eccentricity_truncation_6_maxl_7(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 6 Max Supported l = 7

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl7.eccentricity_truncation_8_maxl_7(eccentricity: FloatArray) → Dict[int, EccenOutput]

Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)

Truncation level = 8 Max Supported l = 7

Parameters:

eccentricity (FloatArray) – Orbital Eccentricity

Returns:

result_by_orderl – Eccentricity function G^2_lpq truncated. Stored by order-l.

Return type:

Dict[int, EccenOutput]

TidalPy.tides.modes.mode_calc_helper.inclin_calc_orderl2 module

TidalPy.tides.modes.mode_calc_helper.inclin_calc_orderl2.inclination_off_maxl_2(obliquity: FloatArray) → Dict[int, InclinOutput]

Calculates inclination functions (squared) for a given maximum tidal order (going through each l) - Off Mode

Obliquity is assumed to be zero.

Max Supported l = 2

Parameters:

obliquity (FloatArray) – Planet’s obliquity [radians]

Returns:

result_by_orderl – Inclination function L^2_lmp truncated. Stored by order-l.

Return type:

Dict[int, InclinOutput]

TidalPy.tides.modes.mode_calc_helper.inclin_calc_orderl2.inclination_on_maxl_2(obliquity: FloatArray) → Dict[int, InclinOutput]

Calculates inclination functions (squared) for a given maximum tidal order (going through each l) - On Mode

Obliquity can be arbitrary.

Max Supported l = 2

Parameters:

obliquity (FloatArray) – Planet’s obliquity [radians]

Returns:

result_by_orderl – Inclination function L^2_lmp truncated. Stored by order-l.

Return type:

Dict[int, InclinOutput]

TidalPy.tides.modes.mode_calc_helper.inclin_calc_orderl3 module

TidalPy.tides.modes.mode_calc_helper.inclin_calc_orderl3.inclination_off_maxl_3(obliquity: FloatArray) → Dict[int, InclinOutput]

Calculates inclination functions (squared) for a given maximum tidal order (going through each l) - Off Mode

Obliquity is assumed to be zero.

Max Supported l = 3

Parameters:

obliquity (FloatArray) – Planet’s obliquity [radians]

Returns:

result_by_orderl – Inclination function L^2_lmp truncated. Stored by order-l.

Return type:

Dict[int, InclinOutput]

TidalPy.tides.modes.mode_calc_helper.inclin_calc_orderl3.inclination_on_maxl_3(obliquity: FloatArray) → Dict[int, InclinOutput]

Calculates inclination functions (squared) for a given maximum tidal order (going through each l) - On Mode

Obliquity can be arbitrary.

Max Supported l = 3

Parameters:

obliquity (FloatArray) – Planet’s obliquity [radians]

Returns:

result_by_orderl – Inclination function L^2_lmp truncated. Stored by order-l.

Return type:

Dict[int, InclinOutput]

TidalPy.tides.modes.mode_calc_helper.inclin_calc_orderl4 module

TidalPy.tides.modes.mode_calc_helper.inclin_calc_orderl4.inclination_off_maxl_4(obliquity: FloatArray) → Dict[int, InclinOutput]

Calculates inclination functions (squared) for a given maximum tidal order (going through each l) - Off Mode

Obliquity is assumed to be zero.

Max Supported l = 4

Parameters:

obliquity (FloatArray) – Planet’s obliquity [radians]

Returns:

result_by_orderl – Inclination function L^2_lmp truncated. Stored by order-l.

Return type:

Dict[int, InclinOutput]

TidalPy.tides.modes.mode_calc_helper.inclin_calc_orderl4.inclination_on_maxl_4(obliquity: FloatArray) → Dict[int, InclinOutput]

Calculates inclination functions (squared) for a given maximum tidal order (going through each l) - On Mode

Obliquity can be arbitrary.

Max Supported l = 4

Parameters:

obliquity (FloatArray) – Planet’s obliquity [radians]

Returns:

result_by_orderl – Inclination function L^2_lmp truncated. Stored by order-l.

Return type:

Dict[int, InclinOutput]

TidalPy.tides.modes.mode_calc_helper.inclin_calc_orderl5 module

TidalPy.tides.modes.mode_calc_helper.inclin_calc_orderl5.inclination_off_maxl_5(obliquity: FloatArray) → Dict[int, InclinOutput]

Calculates inclination functions (squared) for a given maximum tidal order (going through each l) - Off Mode

Obliquity is assumed to be zero.

Max Supported l = 5

Parameters:

obliquity (FloatArray) – Planet’s obliquity [radians]

Returns:

result_by_orderl – Inclination function L^2_lmp truncated. Stored by order-l.

Return type:

Dict[int, InclinOutput]

TidalPy.tides.modes.mode_calc_helper.inclin_calc_orderl5.inclination_on_maxl_5(obliquity: FloatArray) → Dict[int, InclinOutput]

Calculates inclination functions (squared) for a given maximum tidal order (going through each l) - On Mode

Obliquity can be arbitrary.

Max Supported l = 5

Parameters:

obliquity (FloatArray) – Planet’s obliquity [radians]

Returns:

result_by_orderl – Inclination function L^2_lmp truncated. Stored by order-l.

Return type:

Dict[int, InclinOutput]

TidalPy.tides.modes.mode_calc_helper.inclin_calc_orderl6 module

TidalPy.tides.modes.mode_calc_helper.inclin_calc_orderl6.inclination_off_maxl_6(obliquity: FloatArray) → Dict[int, InclinOutput]

Calculates inclination functions (squared) for a given maximum tidal order (going through each l) - Off Mode

Obliquity is assumed to be zero.

Max Supported l = 6

Parameters:

obliquity (FloatArray) – Planet’s obliquity [radians]

Returns:

result_by_orderl – Inclination function L^2_lmp truncated. Stored by order-l.

Return type:

Dict[int, InclinOutput]

TidalPy.tides.modes.mode_calc_helper.inclin_calc_orderl6.inclination_on_maxl_6(obliquity: FloatArray) → Dict[int, InclinOutput]

Calculates inclination functions (squared) for a given maximum tidal order (going through each l) - On Mode

Obliquity can be arbitrary.

Max Supported l = 6

Parameters:

obliquity (FloatArray) – Planet’s obliquity [radians]

Returns:

result_by_orderl – Inclination function L^2_lmp truncated. Stored by order-l.

Return type:

Dict[int, InclinOutput]

TidalPy.tides.modes.mode_calc_helper.inclin_calc_orderl7 module

TidalPy.tides.modes.mode_calc_helper.inclin_calc_orderl7.inclination_off_maxl_7(obliquity: FloatArray) → Dict[int, InclinOutput]

Calculates inclination functions (squared) for a given maximum tidal order (going through each l) - Off Mode

Obliquity is assumed to be zero.

Max Supported l = 7

Parameters:

obliquity (FloatArray) – Planet’s obliquity [radians]

Returns:

result_by_orderl – Inclination function L^2_lmp truncated. Stored by order-l.

Return type:

Dict[int, InclinOutput]

TidalPy.tides.modes.mode_calc_helper.inclin_calc_orderl7.inclination_on_maxl_7(obliquity: FloatArray) → Dict[int, InclinOutput]

Calculates inclination functions (squared) for a given maximum tidal order (going through each l) - On Mode

Obliquity can be arbitrary.

Max Supported l = 7

Parameters:

obliquity (FloatArray) – Planet’s obliquity [radians]

Returns:

result_by_orderl – Inclination function L^2_lmp truncated. Stored by order-l.

Return type:

Dict[int, InclinOutput]