libICEpost.src.thermophysicalModels.specie.reactions.ReactionModel.Stoichiometry
================================================================================

.. py:module:: libICEpost.src.thermophysicalModels.specie.reactions.ReactionModel.Stoichiometry

.. autoapi-nested-parse::

   @author: F. Ramognino       <federico.ramognino@polimi.it>
   Last update:        12/06/2023



Classes
-------

.. autoapisummary::

   libICEpost.src.thermophysicalModels.specie.reactions.ReactionModel.Stoichiometry.Stoichiometry


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

.. py:class:: Stoichiometry(reactants: libICEpost.src.thermophysicalModels.specie.specie.Mixture.Mixture, *, oxidizer: libICEpost.src.thermophysicalModels.specie.specie.Molecule.Molecule = database.chemistry.specie.Molecules.O2, dissociationModels: Iterable[libICEpost.src.thermophysicalModels.specie.reactions.ReactionModel.DissociationModel.DissociationModel.DissociationModel] = None)

   Bases: :py:obj:`libICEpost.src.thermophysicalModels.specie.reactions.ReactionModel.ReactionModel.ReactionModel`


   Reaction model of fuel combustion with infinitely fast chemistry

   TODO:
   Extend to handle a generic reaction set, where there might be more then one oxidizer

   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   .. attribute:: oxidiser

      Molecule
      The oxidiser

   .. attribute:: reactants

      (Mixture)
      The mixture of the reactants

   .. attribute:: products

      (Mixture)
      The mixture of products of the reaction

   .. attribute:: reactions

      (_Database)
      Database of oxidation reactions. Reference to database.chemistry.reactions


   .. py:attribute:: _ReactionType
      :type:  str
      :value: 'StoichiometricReaction'


      The type for reactions to lookup for in the database


   .. py:attribute:: _productsPreDissociation
      :type:  libICEpost.src.thermophysicalModels.specie.specie.Mixture.Mixture

      The combustion products before applying the dissociation models


   .. py:attribute:: dissociationModels
      :type:  list[libICEpost.src.thermophysicalModels.specie.reactions.ReactionModel.DissociationModel.DissociationModel.DissociationModel]

      A list of the dissociation models to apply


   .. py:property:: fuel

      The sub-mixture of reactants with the fuels


   .. py:property:: oxidizer

      The oxidizer


   .. py:method:: fromDictionary(dictionary)
      :classmethod:


      Construct from dictionary.

      :param dictionary: The dictionary from which constructing, containing:
                         reactants (Mixture): the mixture of reactants
                         oxidiser (Molecule): the oxidizer
                         dissociationModels (dict[str:dict]): Construction dictionaries for dissociation models in the form:
                         {
                             <DissociationModelType>: construction dictionary for the specific model
                             ...
                         }
      :type dictionary: dict



   .. py:attribute:: _oxidizer


   .. py:method:: _updateFuels()

      Update list of fuels



   .. py:method:: _update(reactants: libICEpost.src.thermophysicalModels.specie.specie.Mixture.Mixture = None, *, state: libICEpost.src.thermophysicalModels.thermoModels.ThermoState.ThermoState = None) -> bool

      Method to update the products.

      :param reactants: Update mixture of reactants. Defaults to None.
      :type reactants: Mixture, optional
      :param state: Thermodynamic state to update the reaction model. (NOT USED)
      :type state: ThermoState, optional

      :returns: if something changed
      :rtype: bool