TidalPy.tides.eccentricity_funcs package

Submodules

TidalPy.tides.eccentricity_funcs.orderl2 module

Eccentricity functions (squared) for various truncations of e at tidal order-l = 2

TidalPy.tides.eccentricity_funcs.orderl2.eccentricity_funcs_trunc10(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^10 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl2.eccentricity_funcs_trunc12(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^12 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl2.eccentricity_funcs_trunc14(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^14 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl2.eccentricity_funcs_trunc16(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^16 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl2.eccentricity_funcs_trunc18(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^18 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl2.eccentricity_funcs_trunc2(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^2 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl2.eccentricity_funcs_trunc20(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^20 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl2.eccentricity_funcs_trunc22(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^22 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl2.eccentricity_funcs_trunc4(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^4 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl2.eccentricity_funcs_trunc6(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^6 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl2.eccentricity_funcs_trunc8(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^8 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl3 module

Eccentricity functions (squared) for various truncations of e at tidal order-l = 3

TidalPy.tides.eccentricity_funcs.orderl3.eccentricity_funcs_trunc10(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^10 for order-l = 3 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl3.eccentricity_funcs_trunc12(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^12 for order-l = 3 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl3.eccentricity_funcs_trunc14(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^14 for order-l = 3 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl3.eccentricity_funcs_trunc16(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^16 for order-l = 3 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl3.eccentricity_funcs_trunc18(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^18 for order-l = 3 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl3.eccentricity_funcs_trunc2(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^2 for order-l = 3 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl3.eccentricity_funcs_trunc20(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^20 for order-l = 3 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl3.eccentricity_funcs_trunc4(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^4 for order-l = 3 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl3.eccentricity_funcs_trunc6(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^6 for order-l = 3 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl3.eccentricity_funcs_trunc8(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^8 for order-l = 3 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl4 module

Eccentricity functions (squared) for various truncations of e at tidal order-l = 4

TidalPy.tides.eccentricity_funcs.orderl4.eccentricity_funcs_trunc10(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^10 for order-l = 4 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl4.eccentricity_funcs_trunc12(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^12 for order-l = 4 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl4.eccentricity_funcs_trunc14(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^14 for order-l = 4 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl4.eccentricity_funcs_trunc16(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^16 for order-l = 4 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl4.eccentricity_funcs_trunc18(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^18 for order-l = 4 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl4.eccentricity_funcs_trunc2(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^2 for order-l = 4 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl4.eccentricity_funcs_trunc20(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^20 for order-l = 4 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl4.eccentricity_funcs_trunc4(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^4 for order-l = 4 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl4.eccentricity_funcs_trunc6(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^6 for order-l = 4 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl4.eccentricity_funcs_trunc8(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^8 for order-l = 4 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl5 module

Eccentricity functions (squared) for various truncations of e at tidal order-l = 5

TidalPy.tides.eccentricity_funcs.orderl5.eccentricity_funcs_trunc10(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^10 for order-l = 5 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl5.eccentricity_funcs_trunc12(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^12 for order-l = 5 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl5.eccentricity_funcs_trunc14(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^14 for order-l = 5 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl5.eccentricity_funcs_trunc16(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^16 for order-l = 5 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl5.eccentricity_funcs_trunc18(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^18 for order-l = 5 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl5.eccentricity_funcs_trunc2(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^2 for order-l = 5 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl5.eccentricity_funcs_trunc20(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^20 for order-l = 5 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl5.eccentricity_funcs_trunc4(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^4 for order-l = 5 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl5.eccentricity_funcs_trunc6(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^6 for order-l = 5 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl5.eccentricity_funcs_trunc8(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^8 for order-l = 5 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl6 module

Eccentricity functions (squared) for various truncations of e at tidal order-l = 6

TidalPy.tides.eccentricity_funcs.orderl6.eccentricity_funcs_trunc10(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^10 for order-l = 6 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl6.eccentricity_funcs_trunc12(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^12 for order-l = 6 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl6.eccentricity_funcs_trunc14(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^14 for order-l = 6 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl6.eccentricity_funcs_trunc16(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^16 for order-l = 6 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl6.eccentricity_funcs_trunc18(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^18 for order-l = 6 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl6.eccentricity_funcs_trunc2(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^2 for order-l = 6 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl6.eccentricity_funcs_trunc20(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^20 for order-l = 6 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl6.eccentricity_funcs_trunc4(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^4 for order-l = 6 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl6.eccentricity_funcs_trunc6(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^6 for order-l = 6 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl6.eccentricity_funcs_trunc8(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^8 for order-l = 6 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl7 module

Eccentricity functions (squared) for various truncations of e at tidal order-l = 7

TidalPy.tides.eccentricity_funcs.orderl7.eccentricity_funcs_trunc10(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^10 for order-l = 7 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl7.eccentricity_funcs_trunc12(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^12 for order-l = 7 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl7.eccentricity_funcs_trunc14(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^14 for order-l = 7 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl7.eccentricity_funcs_trunc16(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^16 for order-l = 7 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl7.eccentricity_funcs_trunc18(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^18 for order-l = 7 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl7.eccentricity_funcs_trunc2(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^2 for order-l = 7 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl7.eccentricity_funcs_trunc20(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^20 for order-l = 7 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl7.eccentricity_funcs_trunc4(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^4 for order-l = 7 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl7.eccentricity_funcs_trunc6(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^6 for order-l = 7 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput

TidalPy.tides.eccentricity_funcs.orderl7.eccentricity_funcs_trunc8(eccentricity: FloatArray) → EccenOutput

Calculates the eccentricity functions (by mode) truncated to e^8 for order-l = 7 :param eccentricity: Orbital Eccentricity :type eccentricity: FloatArray

Returns:

eccentricity_results_bymode

Return type:

EccenOutput