:py:mod:`pytmosph3r.planetary_system.star.star_blackbody`
=========================================================

.. py:module:: pytmosph3r.planetary_system.star.star_blackbody


Module Contents
---------------

.. py:function:: luminosity_from_temperature(temperature: astropy.units.Quantity[pytmosph3r.util.pt.temperature], radius: astropy.units.Quantity[pytmosph3r.util.pt.length]) -> astropy.units.W

   This function allows retrieving of the luminosity [Power] of a star behaving as a blackbody from
   its temperature [Temperature] and its radius [Length].

   :param temperature: Effective temperature of the star.
   :type temperature: u.Quantity
   :param radius: Radius of the star.
   :type radius: u.Quantity

   :returns: Luminosity of the star in Watt [Power].


.. py:function:: temperature_from_luminosity(luminosity: astropy.units.Quantity, radius: astropy.units.Quantity) -> astropy.units.K

   This function allows retrieving of the effective temperature [Temperature] of a star behaving as a blackbody from
   its luminosity [Luminosity] and its radius [Length].

   :param luminosity: Luminosity of the star.
   :type luminosity: u.Quantity
   :param radius: Radius of the star.
   :type radius: u.Quantity

   :returns: Effective temperature of the star in Kelvin [Temperature].


.. py:class:: BlackbodyStar(temperature: float = 5780, radius: float = 695700000.0, mass: Optional[float] = None, **kwargs)


   Bases: :py:obj:`pytmosph3r.planetary_system.star.base.BaseStar`

   Star which behave as a blackbody.


   :param temperature: Stellar temperature in `K`. Default to the solar effective temperature.
   :type temperature: float, optional
   :param radius: Radius of the star in `m`. Default to the solar radius.
   :type radius: float, optional
   :param mass: Mass of the star in `kg`. Optional.
   :type mass: float, optional

   :returns: An object behaving as a `Star`, with a flux matching a blackbody of the given effective temperature.

   .. py:attribute:: temperature

      Star effective temperature (in `K`).

   .. py:method:: fromEffectiveTemperature(temperature: astropy.units.Quantity, radius: astropy.units.Quantity, mass: Optional[astropy.units.Quantity] = None)
      :classmethod:

          Create a `BlackbodyStar` object from its effective temperature.
      :param temperature: Stellar effective temperature [Temperature].
      :type temperature: Quantity['temperature']
      :param radius: Stellar radius [Length].
      :type radius: Quantity['length']
      :param mass: Stellar mass [Mass].
      :type mass: Quantity['mass']

      :returns: `BlackbodyStar` matching the provided effective temperature.


   .. py:method:: fromBolometricLuminosity(bolometric_luminosity: astropy.units.Quantity, radius: astropy.units.Quantity, mass: Optional[astropy.units.Quantity] = None)
      :classmethod:

          Create a `BlackbodyStar` object from its bolometric luminosity.
      :param bolometric_luminosity: Bolometric luminosity of the star [Power].
      :type bolometric_luminosity: Quantity['power']
      :param radius: Stellar radius [Length].
      :type radius: Quantity['length']
      :param mass: Stellar mass [Mass].
      :type mass: Quantity['mass']

      :returns: `BlackbodyStar` matching the provided luminosity.


   .. py:method:: fromSolar(temperature: float = 5770, radius: float = 1.0, mass: float = 1.0)
      :classmethod:

      Create a `Star` object using solar values (except temperature, which is in Kelvin).

      :param temperature: Stellar effective temperature [Temperature].
      :type temperature: Quantity['temperature']
      :param radius: radius, scaled to the Sun.
      :type radius: float
      :param mass: Mass of the star in `Msun`.
      :type mass: float