TidalPy.tides.inclination_funcs package

TidalPy.tides.inclination_funcs.get_inclination_func(tidal_order_lvl: int = 2, inclination_nonzero: bool = True)

Submodules

TidalPy.tides.inclination_funcs.orderl2 module

Inclination functions (squared) for tidal order-l = 2. These are exact (no truncation on I)

TidalPy.tides.inclination_funcs.orderl2.calc_inclination(inclination: FloatArray) → InclinOutput

Calculate F^2_lmp for l = 2

TidalPy.tides.inclination_funcs.orderl2.calc_inclination_off(inclination: FloatArray) → InclinOutput

Calculate F^2_lmp (assuming I=0) for l = 2

TidalPy.tides.inclination_funcs.orderl3 module

Inclination functions (squared) for tidal order-l = 3. These are exact (no truncation on I)

TidalPy.tides.inclination_funcs.orderl3.calc_inclination(inclination: FloatArray) → InclinOutput

Calculate F^2_lmp for l = 3

TidalPy.tides.inclination_funcs.orderl3.calc_inclination_off(inclination: FloatArray) → InclinOutput

Calculate F^2_lmp (assuming I=0) for l = 3

TidalPy.tides.inclination_funcs.orderl4 module

Inclination functions (squared) for tidal order-l = 4. These are exact (no truncation on I)

TidalPy.tides.inclination_funcs.orderl4.calc_inclination(inclination: FloatArray) → InclinOutput

Calculate F^2_lmp for l = 4

TidalPy.tides.inclination_funcs.orderl4.calc_inclination_off(inclination: FloatArray) → InclinOutput

Calculate F^2_lmp (assuming I=0) for l = 4

TidalPy.tides.inclination_funcs.orderl5 module

Inclination functions (squared) for tidal order-l = 5. These are exact (no truncation on I)

TidalPy.tides.inclination_funcs.orderl5.calc_inclination(inclination: FloatArray) → InclinOutput

Calculate F^2_lmp for l = 5

TidalPy.tides.inclination_funcs.orderl5.calc_inclination_off(inclination: FloatArray) → InclinOutput

Calculate F^2_lmp (assuming I=0) for l = 5

TidalPy.tides.inclination_funcs.orderl6 module

Inclination functions (squared) for tidal order-l = 6. These are exact (no truncation on I)

TidalPy.tides.inclination_funcs.orderl6.calc_inclination(inclination: FloatArray) → InclinOutput

Calculate F^2_lmp for l = 6

TidalPy.tides.inclination_funcs.orderl6.calc_inclination_off(inclination: FloatArray) → InclinOutput

Calculate F^2_lmp (assuming I=0) for l = 6

TidalPy.tides.inclination_funcs.orderl7 module

Inclination functions (squared) for tidal order-l = 7. These are exact (no truncation on I)

TidalPy.tides.inclination_funcs.orderl7.calc_inclination(inclination: FloatArray) → InclinOutput

Calculate F^2_lmp for l = 7

TidalPy.tides.inclination_funcs.orderl7.calc_inclination_off(inclination: FloatArray) → InclinOutput

Calculate F^2_lmp (assuming I=0) for l = 7