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

.. py:module:: pytmosph3r.chemistry.fastchemistry


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

.. py:function:: fastchem_name(gas)


.. py:function:: create_tempfile(name='tmp')


.. py:class:: FastChemistry(gases=None, filename=None)


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

   Chemistry model based on FastChem: https://github.com/exoclime/FastChem

   :param gases: List of gases in the atmosphere
   :type gases: :obj:`list`
   :param filename: The path to the `parameter file used by FastChem <https://github.com/exoclime/FastChem/blob/master/input/parameters.dat>`_.
   :type filename: str

   .. py:method:: build(atmosphere, input_atmosphere=None)

      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:: 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:: inputs()