Guillot10
=========

.. py:module:: Guillot10


Functions
---------

.. autoapisummary::

   Guillot10.guillot_global
   Guillot10.guillot_global_ret
   Guillot10.guillot_metallic_temperature_profile
   Guillot10.guillot_modif
   Guillot10.PT_ret_model


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

.. py:function:: guillot_global(P, kappa_IR, gamma, grav, T_int, T_equ)

   Returns a temperature array, in units of K,
   of the same dimensions as the pressure P
   (in bar). For this the temperature model of Guillot (2010)
   is used (his Equation 29).

   Args:
       P:
           numpy array of floats, containing the input pressure in bars.
       kappa_IR (float):
           The infrared opacity in units of :math:`\\rm cm^2/s`.
       gamma (float):
           The ratio between the visual and infrated opacity.
       grav (float):
           The planetary surface gravity in units of :math:`\\rm cm/s^2`.
       T_int (float):
           The planetary internal temperature (in units of K).
       T_equ (float):
           The planetary equilibrium temperature (in units of K).


.. py:function:: guillot_global_ret(P, delta, gamma, T_int, T_equ)

.. py:function:: guillot_metallic_temperature_profile(pressures, gamma, surface_gravity, intrinsic_temperature, equilibrium_temperature, kappa_ir_z0, metallicity=None)

   Get a Guillot temperature profile depending on metallicity.

   Args:
       pressures: (bar) pressures of the profile
       gamma: ratio between visual and infrated opacity
       surface_gravity: (cm.s-2) surface gravity
       intrinsic_temperature: (K) intrinsic temperature
       equilibrium_temperature: (K) equilibrium temperature
       kappa_ir_z0: (cm2.s-1) infrared opacity
       metallicity: ratio of heavy elements abundance over H abundance with respect to the solar ratio

   Returns:
       temperatures: (K) the temperature at each pressures of the atmosphere


.. py:function:: guillot_modif(P, delta, gamma, T_int, T_equ, ptrans, alpha)

.. py:function:: PT_ret_model(T3, delta, alpha, tint, press, FeH, CO, conv=True)

   Self-luminous retrieval P-T model.

   Args:
       T3 : np.array([t1, t2, t3])
           temperature points to be added on top
           radiative Eddington structure (above tau = 0.1).
           Use spline interpolation, t1 < t2 < t3 < tconnect as prior.
       delta : float
           proportionality factor in tau = delta * press_cgs**alpha
       alpha : float
           power law index in tau = delta * press_cgs**alpha
           For the tau model: use proximity to kappa_rosseland photosphere
           as prior.
       tint : float
           internal temperature of the Eddington model
       press : np.ndarray
           input pressure profile in bar
       conv : bool
           enforce convective adiabat yes/no
       CO : float
           C/O for the nabla_ad interpolation
       FeH : float
           metallicity for the nabla_ad interpolation
   Returns:
       Tret : np.ndarray
           The temperature as a function of atmospheric pressure.