TidalPy.stellar package

Submodules

TidalPy.stellar.insolation module

TidalPy.stellar.insolation.calc_equilibrium_temperature(insolation_heating: FloatArray, radius: float, internal_heating: FloatArray = None, emissivity: float = 1.0) → FloatArray[source]

Calculates the surface equilibrium temperature of a planet that is heated by stellar and internal heating

References

Parameters:

  • insolation_heating (FloatArray) – Heat received from a host star [W]

  • radius (float) – Radius of the world [m]

  • internal_heating (FloatArray = None) – Heat received from the interior of the world [W]

  • emissivity (float = 1.0) – Planet’s grey-body emissivity

Returns:

equilibrium_temperature – World’s surface equilibrium temperature [K]

Return type:

FloatArray

TidalPy.stellar.insolation.equilibrium_insolation_mendez(luminosity: float, semi_major_axis: FloatArray, albedo: float, radius: float, eccentricity: FloatArray) → FloatArray[source]

Calculate the insolation heating using the mendez method for elliptical orbits

Based on Mendez & Rivera-Valentin (ApJL 837 1, 2017)

Parameters:

  • luminosity (float) – Stellar luminosity in [W]

  • semi_major_axis (FloatArray) – Target planet’s semi-major axis to the star (you want to use the host planet’s semi-a) in [m]

  • albedo (float) – Target planet’s geometric albedo

  • radius (float) – Target planet’s radius in [m]

  • eccentricity (FloatArray) – Target planet’s semi-major axis relative to the star (you want to use the host planet’s e)

Returns:

insolation_heating – Heating at the target planet’s surface in [W]

Return type:

FloatArray

See also

equilibrium_insolation_williams, equilibrium_insolation_no_eccentricity

TidalPy.stellar.insolation.equilibrium_insolation_no_eccentricity(luminosity: float, semi_major_axis: FloatArray, albedo: float, radius: float, eccentricity: FloatArray = None) → FloatArray[source]

Calculate the insolation heating assuming a circular orbit

Parameters:

  • luminosity (float) – Stellar luminosity in [W]

  • semi_major_axis (FloatArray) – Target planet’s semi-major axis to the star (you want to use the host planet’s semi-a) in [m]

  • albedo (float) – Target planet’s geometric albedo

  • radius (float) – Target planet’s radius in [m]

  • eccentricity (FloatArray) – This is not used - It is here to keep the signature of all the insolation heating functions the same

Returns:

insolation_heating – Heating at the target planet’s surface in [W]

Return type:

FloatArray

See also

equilibrium_insolation_williams, equilibrium_insolation_mendez

TidalPy.stellar.insolation.equilibrium_insolation_williams(luminosity: float, semi_major_axis: FloatArray, albedo: float, radius: float, eccentricity: FloatArray) → FloatArray[source]

Calculate the insolation heating using the williams method for elliptical orbits

Based on *NEED WILLIAMS REF

Parameters:

  • luminosity (float) – Stellar luminosity in [W]

  • semi_major_axis (FloatArray) – Target planet’s semi-major axis to the star (you want to use the host planet’s semi-a) in [m]

  • albedo (float) – Target planet’s geometric albedo

  • radius (float) – Target planet’s radius in [m]

  • eccentricity (FloatArray) – Target planet’s semi-major axis relative to the star (you want to use the host planet’s e)

Returns:

insolation_heating – Heating at the target planet’s surface in [W]

Return type:

FloatArray

See also

equilibrium_insolation_no_eccentricity, equilibrium_insolation_mendez

TidalPy.stellar.stellar module

TidalPy.stellar.stellar.efftemp_from_luminosity(luminosity: float, radius: float)[source]

Calculates a star’s effective surface temperature provided a luminosity

Parameters:

  • luminosity – <float> StarWorld’s luminosity [Watts]

  • radius – <float> StarWorld’s Surface Radius [m]

Returns:

<float> StarWorld’s Effective Surface temperature [K]

TidalPy.stellar.stellar.luminosity_from_efftemp(effective_temperature: float, radius: float)[source]

Calculates a star’s luminosity provided an effective surface temperature

Parameters:

  • effective_temperature – <Float> StarWorld’s Effective Surface temperature [K]

  • radius – <float> StarWorld’s Surface Radius [m]

Returns:

<float> StarWorld’s luminosity [Watt]

TidalPy.stellar.stellar.luminosity_from_mass(stellar_mass: float)[source]

Estimates stellar luminosity from a star’s mass

Partially based on Cuntz & Wang 2018 (doi:10.3847/2515-5172/aaaa67) and wikipedia.org/wiki/Mass–luminosity_relation

Parameters:

stellar_mass – <float> StarWorld’s mass [kg]

Returns:

<float> StarWorld’s luminosity [Watts]