TidalPy.tides package

Subpackages

• TidalPy.tides.ctl_funcs package
  • Submodules
  • TidalPy.tides.ctl_funcs.ctl_funcs module
    • linear_dt()
    • linear_dt_with_q()
• TidalPy.tides.eccentricity_funcs package
  • Submodules
  • TidalPy.tides.eccentricity_funcs.orderl2 module
    • eccentricity_funcs_trunc10()
    • eccentricity_funcs_trunc12()
    • eccentricity_funcs_trunc14()
    • eccentricity_funcs_trunc16()
    • eccentricity_funcs_trunc18()
    • eccentricity_funcs_trunc2()
    • eccentricity_funcs_trunc20()
    • eccentricity_funcs_trunc22()
    • eccentricity_funcs_trunc4()
    • eccentricity_funcs_trunc6()
    • eccentricity_funcs_trunc8()
  • TidalPy.tides.eccentricity_funcs.orderl3 module
    • eccentricity_funcs_trunc10()
    • eccentricity_funcs_trunc12()
    • eccentricity_funcs_trunc14()
    • eccentricity_funcs_trunc16()
    • eccentricity_funcs_trunc18()
    • eccentricity_funcs_trunc2()
    • eccentricity_funcs_trunc20()
    • eccentricity_funcs_trunc4()
    • eccentricity_funcs_trunc6()
    • eccentricity_funcs_trunc8()
  • TidalPy.tides.eccentricity_funcs.orderl4 module
    • eccentricity_funcs_trunc10()
    • eccentricity_funcs_trunc12()
    • eccentricity_funcs_trunc14()
    • eccentricity_funcs_trunc16()
    • eccentricity_funcs_trunc18()
    • eccentricity_funcs_trunc2()
    • eccentricity_funcs_trunc20()
    • eccentricity_funcs_trunc4()
    • eccentricity_funcs_trunc6()
    • eccentricity_funcs_trunc8()
  • TidalPy.tides.eccentricity_funcs.orderl5 module
    • eccentricity_funcs_trunc10()
    • eccentricity_funcs_trunc12()
    • eccentricity_funcs_trunc14()
    • eccentricity_funcs_trunc16()
    • eccentricity_funcs_trunc18()
    • eccentricity_funcs_trunc2()
    • eccentricity_funcs_trunc20()
    • eccentricity_funcs_trunc4()
    • eccentricity_funcs_trunc6()
    • eccentricity_funcs_trunc8()
  • TidalPy.tides.eccentricity_funcs.orderl6 module
    • eccentricity_funcs_trunc10()
    • eccentricity_funcs_trunc12()
    • eccentricity_funcs_trunc14()
    • eccentricity_funcs_trunc16()
    • eccentricity_funcs_trunc18()
    • eccentricity_funcs_trunc2()
    • eccentricity_funcs_trunc20()
    • eccentricity_funcs_trunc4()
    • eccentricity_funcs_trunc6()
    • eccentricity_funcs_trunc8()
  • TidalPy.tides.eccentricity_funcs.orderl7 module
    • eccentricity_funcs_trunc10()
    • eccentricity_funcs_trunc12()
    • eccentricity_funcs_trunc14()
    • eccentricity_funcs_trunc16()
    • eccentricity_funcs_trunc18()
    • eccentricity_funcs_trunc2()
    • eccentricity_funcs_trunc20()
    • eccentricity_funcs_trunc4()
    • eccentricity_funcs_trunc6()
    • eccentricity_funcs_trunc8()
• TidalPy.tides.inclination_funcs package
  • get_inclination_func()
  • Submodules
  • TidalPy.tides.inclination_funcs.orderl2 module
    • calc_inclination()
    • calc_inclination_off()
  • TidalPy.tides.inclination_funcs.orderl3 module
    • calc_inclination()
    • calc_inclination_off()
  • TidalPy.tides.inclination_funcs.orderl4 module
    • calc_inclination()
    • calc_inclination_off()
  • TidalPy.tides.inclination_funcs.orderl5 module
    • calc_inclination()
    • calc_inclination_off()
  • TidalPy.tides.inclination_funcs.orderl6 module
    • calc_inclination()
    • calc_inclination_off()
  • TidalPy.tides.inclination_funcs.orderl7 module
    • calc_inclination()
    • calc_inclination_off()
• TidalPy.tides.methods package
  • Submodules
  • TidalPy.tides.methods.base module
    • TidesBase
      • TidesBase.eccentricity_truncation_lvl
      • TidesBase.max_tidal_order_lvl
      • TidesBase.use_obliquity_tides
      • TidesBase.multiply_modes_by_sign
      • TidesBase.eccentricity_results
      • TidesBase.obliquity_results
      • TidesBase.tidal_susceptibility_reduced
      • TidesBase.tidal_susceptibility
      • TidesBase.unique_tidal_frequencies
      • TidesBase.tidal_terms_by_frequency
      • TidesBase.tidal_heating_global
      • TidesBase.global_negative_imk_by_orderl
      • TidesBase.global_love_by_orderl
      • TidesBase.effective_q_by_orderl
      • TidesBase.dUdM
      • TidesBase.dUdw
      • TidesBase.dUdO
      • TidesBase.fixed_q
      • TidesBase.fixed_dt
      • TidesBase.fixed_k2
      • TidesBase.thermal_set
      • TidesBase.orbit_set
      • TidesBase.calculate_complex_love_number()
      • TidesBase.calculate_effective_rigidity()
      • TidesBase.calculate_tidal_susceptibility()
      • TidesBase.clear_state()
      • TidesBase.collapse_modes()
      • TidesBase.dUdM
      • TidesBase.dUdO
      • TidesBase.dUdw
      • TidesBase.eccentricity
      • TidesBase.eccentricity_results
      • TidesBase.eccentricity_truncation_lvl
      • TidesBase.effective_q_by_orderl
      • TidesBase.fixed_dt
      • TidesBase.fixed_k2
      • TidesBase.fixed_q
      • TidesBase.fixed_q_dt_changed()
      • TidesBase.global_love_by_orderl
      • TidesBase.global_negative_imk_by_orderl
      • TidesBase.max_tidal_order_lvl
      • TidesBase.model
      • TidesBase.moi
      • TidesBase.multiply_modes_by_sign
      • TidesBase.obliquity
      • TidesBase.obliquity_results
      • TidesBase.orbit_set
      • TidesBase.orbit_spin_changed()
      • TidesBase.orbital_frequency
      • TidesBase.post_orbit_initialize()
      • TidesBase.radius
      • TidesBase.reinit()
      • TidesBase.semi_major_axis
      • TidesBase.set_fixed_dt()
      • TidesBase.set_fixed_q()
      • TidesBase.set_state()
      • TidesBase.spin_frequency
      • TidesBase.thermal_set
      • TidesBase.tidal_heating_global
      • TidesBase.tidal_host
      • TidesBase.tidal_susceptibility
      • TidesBase.tidal_susceptibility_reduced
      • TidesBase.tidal_terms_by_frequency
      • TidesBase.unique_tidal_frequencies
      • TidesBase.use_obliquity_tides
      • TidesBase.world_config_key
  • TidalPy.tides.methods.global_approx module
    • GlobalApproxTides
      • GlobalApproxTides.use_ctl
      • GlobalApproxTides.tidal_inputs
      • GlobalApproxTides.complex_love_by_unique_freq
      • GlobalApproxTides.ctl_calc_method()
      • GlobalApproxTides.ctl_calc_input_getter()
      • GlobalApproxTides.clear_state()
      • GlobalApproxTides.collapse_modes()
      • GlobalApproxTides.complex_love_by_unique_freq
      • GlobalApproxTides.ctl_calc_input_getter
      • GlobalApproxTides.ctl_calc_method
      • GlobalApproxTides.fixed_q_dt_changed()
      • GlobalApproxTides.model
      • GlobalApproxTides.orbit_spin_changed()
      • GlobalApproxTides.reinit()
      • GlobalApproxTides.tidal_inputs
      • GlobalApproxTides.use_ctl
    • cpl_neg_imk_helper_func()
    • ctl_neg_imk_helper_func()
  • TidalPy.tides.methods.layered module
    • LayeredTides
      • LayeredTides.tidal_heating_by_layer
      • LayeredTides.negative_imk_by_layer_by_orderl
      • LayeredTides.clear_state()
      • LayeredTides.collapse_modes()
      • LayeredTides.complex_compliances_changed()
      • LayeredTides.model
      • LayeredTides.negative_imk_by_layer_by_orderl
      • LayeredTides.reinit()
      • LayeredTides.tidal_heating_by_layer
• TidalPy.tides.modes package
  • Subpackages
    • 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_orderl3 module
      • TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl4 module
      • TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl5 module
      • TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl6 module
      • TidalPy.tides.modes.mode_calc_helper.eccen_calc_orderl7 module
      • TidalPy.tides.modes.mode_calc_helper.inclin_calc_orderl2 module
      • TidalPy.tides.modes.mode_calc_helper.inclin_calc_orderl3 module
      • TidalPy.tides.modes.mode_calc_helper.inclin_calc_orderl4 module
      • TidalPy.tides.modes.mode_calc_helper.inclin_calc_orderl5 module
      • TidalPy.tides.modes.mode_calc_helper.inclin_calc_orderl6 module
      • TidalPy.tides.modes.mode_calc_helper.inclin_calc_orderl7 module
  • Submodules
  • TidalPy.tides.modes.collapse_modes module
    • collapse_modes()
  • TidalPy.tides.modes.mode_manipulation module
    • calculate_terms()
    • collapse_modes()
    • find_mode_manipulators()
  • TidalPy.tides.modes.modes module
    • find_unique_frequency_dict()
    • find_unique_frequency_list()
  • TidalPy.tides.modes.multilayer_modes module
    • calculate_mode_response_coupled()
    • collapse_multilayer_modes()
• TidalPy.tides.multilayer package
  • Submodules
  • TidalPy.tides.multilayer.displacements module
    • calculate_displacements()
  • TidalPy.tides.multilayer.heating module
    • calc_radial_volumetric_tidal_heating()
    • calc_radial_volumetric_tidal_heating_from_rs_solution()
  • TidalPy.tides.multilayer.sensitivity module
    • calc_sensitivity_to_bulk()
    • calc_sensitivity_to_shear()
  • TidalPy.tides.multilayer.stress_strain module
    • calculate_strain_stress()
• TidalPy.tides.potential package
  • Submodules
  • TidalPy.tides.potential.nsr_med_eccen_gen_obliquity module
    • tidal_potential()
  • TidalPy.tides.potential.nsr_med_eccen_med_obliquity module
    • tidal_potential()
  • TidalPy.tides.potential.nsr_med_eccen_no_obliquity module
    • tidal_potential()
  • TidalPy.tides.potential.nsr_modes_low_eccen_gen_obliquity module
    • tidal_potential()
  • TidalPy.tides.potential.nsr_modes_med_eccen_gen_obliquity module
    • tidal_potential()
  • TidalPy.tides.potential.nsr_modes_med_eccen_med_obliquity module
    • tidal_potential()
  • TidalPy.tides.potential.nsr_modes_med_eccen_no_obliquity module
    • tidal_potential()
  • TidalPy.tides.potential.synchronous_low_e module
    • tidal_potential()

Submodules

TidalPy.tides.dissipation module

TidalPy.tides.dissipation.calc_tidal_susceptibility(host_mass: float, target_radius: float, semi_major_axis: FloatArray) → FloatArray

Calculate the tidal susceptibility for a given target radius, host mass, and their separation.

Parameters:

• host_mass (float) – Mass of central host [kg]

• target_radius (float) – Radius of target body [m]

• semi_major_axis (FloatArray) – Semi-major axis [m]

Returns:

tidal_susceptibility – Tidal Susceptibility [N m]

Return type:

FloatArray

TidalPy.tides.dissipation.calc_tidal_susceptibility_reduced(host_mass: float, target_radius: float) → float

Calculate the tidal susceptibility (reduced) for a given target radius and host mass.

The reduced tidal susceptibility excludes the semi-major axis.

Parameters:

• host_mass (float) – Mass of central host [kg]

• target_radius (float) – Radius of target body [m]

Returns:

tidal_susceptibility_reduced – Tidal Susceptibility [N m]

Return type:

np.ndarray

TidalPy.tides.heating module

Functions used to estimate tidal heating within a solid planet or layer.

TidalPy.tides.heating.calculate_volumetric_heating(stress: ndarray, strain: ndarray) → ndarray

Calculates the tidal heating rate per unit volume based on the tidal stresses and strains.

Parameters:

• stress (np.ndarray) – Tidal stress tensor (complex np.ndarray) [Pa]

• strain (np.ndarray) – Tidal strain tensor (complex np.ndarray) [unitless]

Returns:

volumetric_heating – Tidal heating rate per unit volume [W m-3]

Return type:

np.ndarray

TidalPy.tides.love1d module

TidalPy.tides.love1d.complex_love(complex_compliance: FloatArray, shear_modulus: FloatArray, eff_rigidity: FloatArray) → FloatArray

Calculates the 2nd order complex Love number

Parameters:

• complex_compliance (FloatArray) – Complex compliance (rheology based) [Pa-1]

• shear_modulus (FloatArray) – Temperature modulated rigidity [Pa]

• eff_rigidity (FloatArray) – 2nd order effective rigidity

Returns:

cmplx_love – 2nd order complex Love number

Return type:

FloatArray

TidalPy.tides.love1d.complex_love_general(complex_compliance: FloatArray, shear_modulus: FloatArray, eff_rigidity_general: FloatArray, order_l: int = 2) → FloatArray

Calculates the l-th order complex Love number

Parameters:

• complex_compliance (FloatArray) – Complex compliance (rheology based) [Pa-1]

• shear_modulus (FloatArray) – Temperature modulated rigidity [Pa]

• eff_rigidity_general (FloatArray) – l-th order effective rigidity

• order_l (int) – Outermost Fourier summation integer

Returns:

cmplx_love – l-th order complex Love number

Return type:

FloatArray

TidalPy.tides.love1d.effective_rigidity(shear_modulus: FloatArray, gravity: float, radius: float, density: float) → FloatArray

Calculates the 2nd order effective rigidity

Parameters:

• shear_modulus (FloatArray) – Temperature modulated rigidity [Pa]

• gravity (float) – Surface (of planet or layer) gravity [m s-2]

• radius (float) – Surface (of planet or layer) radius [m]

• density (float) – Bulk density (of planet or layer) [kg m-3]

Returns:

eff_rigid – 2nd order Effective Rigidity

Return type:

FloatArray

TidalPy.tides.love1d.effective_rigidity_general(shear_modulus: FloatArray, gravity: float, radius: float, density: float, order_l: int = 2) → FloatArray

Calculates the l-th order effective rigidity

Parameters:

• shear_modulus (FloatArray) – Temperature modulated rigidity [Pa]

• gravity (float) – Surface (of planet or layer) gravity [m s-2]

• radius (float) – Surface (of planet or layer) radius [m]

• density (float) – Bulk density (of planet or layer) [kg m-3]

• order_l (int) – Outermost Fourier summation integer

Returns:

eff_rigid – l-th order Effective Rigidity

Return type:

FloatArray

TidalPy.tides.love1d.static_love(eff_rigidity: FloatArray) → FloatArray

Calculate the static (non-complex) 2nd order Love number

Parameters:

eff_rigidity (FloatArray) – 2nd order effective rigidity

Returns:

static_love – 2nd order complex Love number

Return type:

FloatArray

TidalPy.tides.love1d.static_love_general(eff_rigidity_general: FloatArray, order_l: int = 2) → FloatArray

Calculate the static (non-complex) tidal Love number k.

Parameters:

• eff_rigidity_general (FloatArray) – l-th order effective rigidity

• order_l (int) – Outermost Fourier summation integer

Returns:

static_love – l-th order complex Love number

Return type:

FloatArray

TidalPy.tides.universal_coeffs module

Universal coefficients used to calculate tidal heating and tidal potential derivatives Precomputed here to avoid calls to gamma functions in expensive loops. Defined as:

[(l - m)! / (l + m)!] * (2 - delta_0m)

Stored as:

[order_l] [m] Starting with order_l = 2 and m = 0

TidalPy.tides.universal_coeffs.get_universal_coeffs(order_l: int)