:py:mod:`pytmosph3r.chemistry.standard`
=======================================

.. py:module:: pytmosph3r.chemistry.standard


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

.. py:class:: StandardRatioHeH2(gases=None, ratio_HeH2=None)


   Bases: :py:obj:`pytmosph3r.chemistry.chemistry.Chemistry`

   Complete the atmosphere in He and H2 using a ratio_HeH2.

   :param gases: List of gases which are consider in the simulation.
   :type gases: :obj:`dict`
   :param ratio_HeH2: Ratio between the mixing ratio of He and H2. Exemple: ratio_HeH2 = 0.2577 (solar abundance)
   :type ratio_HeH2: float

   .. py:method:: compute_vmr(gas, mix_ratio)

      This function can be overridden to compute the volume mixing ratio of a gas :attr:`gas` using :attr:`mix_ratio`, initialized to an array with the :attr:`~pytmosph3r.Grid3D.shape` of the atmosphere.

      :param gas: Name of the gas
      :type gas: str
      :param mix_ratio: Array full of ones of shape :attr:`~pytmosph3r.Grid3D.shape`. The array is filled with the values in the atmosphere is the gas was already present, or else ones.
      :type mix_ratio: array, np.ndarray


   .. py:method:: build(atmosphere)

      General function that will be called to compute the chemistry after :attr:`atmosphere` has been initialized. It iterates over :attr:`gases` by calling :func:`compute_vmr` on each gas.

      :param atmosphere: Altitude-based atmosphere in which to compute the volume mixing ratios of :attr:`gases`.
      :type atmosphere: :class:`~pytmosph3r.atmosphere.altitudeatmosphere.AltitudeAtmosphere`
      :param input_atmosphere: Input atmosphere if you need it (with input mix_ratios for example).
      :type input_atmosphere: :class:`~pytmosph3r.atmosphere.inputatmosphere.InputAtmosphere`, optional


   .. py:method:: inputs()