:py:mod:`pytmosph3r.atmosphere.simple2d`
========================================

.. py:module:: pytmosph3r.atmosphere.simple2d


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

.. py:class:: Simple2DTemperature(T_day, T_night, T_deep=None, beta=10, p_iso=1e+99)


   Class to build a `2D` temperature, set to :py:attr:`T_day` on the `day` side of the planet,
   :py:attr:`T_night` on the `night` side of the planet,
   and a linear transition between :py:attr:`T_day` and :py:attr:`T_night` within the :py:attr:`beta` angle between day and night, representing the terminator.
   An annulus is defined at pressures above :py:attr:`p_iso`, where the temperature is set to :py:attr:`T_deep`.

   Initialize the `2D` temperature using simple parameters:

   :param T_day: Temperature on the `day` side of the planet.
   :type T_day: float
   :param T_night: Temperature on the `night` side.
   :type T_night: float
   :param T_deep: Temperature set for layers with a pressure above :py:attr:`p_iso` (overriding the other values).
   :type T_deep: float
   :param beta: Angle between day and night defining the region around the terminator with a linear transition between :py:attr:`T_day` and :py:attr:`T_night`.
   :type beta: float
   :param p_iso: Pressure above which the temperature is overridden with :py:attr:`T_deep`.
   :type p_iso: float

   .. py:property:: beta_rad


   .. py:method:: build(grid, P, model=None)

      This function must return the temperature of the atmosphere, and therefore have a shape compatible with `grid`.

      :param grid: Grid (from Pytmosph3R).
      :type grid: Grid3D
      :param P: Pressure points corresponding to the grid.
      :type P: float, array
      :param model: Entire Pytmosph3R model in case you need something else (chemistry, ...).
      :type model: Model, optional



.. py:function:: simple_2D(grid, day_value, night_value)

   Returns an array with the shape of :py:attr:`grid`,
   of which the values on the day side are equal to :py:attr:`day_value`,
   and the values on the night side are equal to :py:attr:`night_value`.
   See :class:`~pytmosph3r.grid.Grid3D.day_longitudes` for a definition of the day side
   and :class:`~pytmosph3r.grid.Grid3D.night_longitudes` for a definition of the night side.

   :param grid: 3D grid giving the dimensions for the array.
   :type grid: :class:`~pytmosph3r.grid.Grid3D`
   :param day_value: Value for the day side.
   :type day_value: float
   :param night_value: Value for the night side.
   :type night_value: float


.. py:function:: simple_2D_vmr(grid, input_vmr)