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

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

.. autoapi-nested-parse::

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



Classes
-------

.. autoapisummary::

   libICEpost.src.thermophysicalModels.specie.reactions.ReactionModel.Equilibrium._equilibriumComputationMethods
   libICEpost.src.thermophysicalModels.specie.reactions.ReactionModel.Equilibrium.Equilibrium


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

.. py:class:: _equilibriumComputationMethods(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Create a collection of name/value pairs.

   Example enumeration:

   >>> class Color(Enum):
   ...     RED = 1
   ...     BLUE = 2
   ...     GREEN = 3

   Access them by:

   - attribute access::

   >>> Color.RED
   <Color.RED: 1>

   - value lookup:

   >>> Color(1)
   <Color.RED: 1>

   - name lookup:

   >>> Color['RED']
   <Color.RED: 1>

   Enumerations can be iterated over, and know how many members they have:

   >>> len(Color)
   3

   >>> list(Color)
   [<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

   Methods can be added to enumerations, and members can have their own
   attributes -- see the documentation for details.


   .. py:attribute:: average
      :value: 'average'



   .. py:attribute:: burntGas
      :value: 'burntGas'



   .. py:attribute:: adiabatiFlame
      :value: 'adiabaticFlame'



.. py:class:: Equilibrium(reactants: libICEpost.src.thermophysicalModels.specie.specie.Mixture.Mixture, mechanism: str, *, method: Literal['average', 'adiabatiFlame', 'burntGas'], state: libICEpost.src.thermophysicalModels.thermoModels.ThermoState.ThermoState)

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


   Reaction model based on computation of chemical equilibrium which CANTERA.

   .. attribute:: oxidiser

      The oxidiser

      :type: Molecule

   .. attribute:: reactants

      The mixture of the reactants

      :type: Mixture

   .. attribute:: products

      The mixture of products of the reaction

      :type: Mixture

   .. attribute:: specie

      The molecules to consider in the equilibrium

      :type: list[Molecule]

   .. attribute:: mechanism

      The path where the mechanism in yaml is stored

      :type: str


   .. py:attribute:: _ReactionType
      :type:  str
      :value: None


      The type for reactions to lookup for in the database


   .. py:attribute:: _reactor
      :type:  cantera.Solution

      The ractor used to compute equilibrium in CANTERA


   .. py:attribute:: _mechamism
      :type:  str

      The path of the mechanism


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


      Constructs from dictionary

      :param dictionary: The dictionary from which constructing:
                         reactants (Mixture): the mixture of reactants
                         mechanism (str): The path where is stored the chemical mechanism to use (yaml)
      :type dictionary: dict



   .. py:property:: mechanism
      :type: str


      The path where the mechanism is stored.


   .. py:property:: method

      The method used to compute the equilibrium.


   .. py:attribute:: _mechanism


   .. py:attribute:: _method


   .. py:method:: _update(reactants: libICEpost.src.thermophysicalModels.specie.specie.Mixture.Mixture = None, *, state: libICEpost.src.thermophysicalModels.thermoModels.ThermoState.ThermoState) -> 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.
      :type state: ThermoState

      :returns: wether the system was updated
      :rtype: bool