libICEpost.src.thermophysicalModels.thermoModels.CombustionModel.PremixedCombustion
===================================================================================

.. py:module:: libICEpost.src.thermophysicalModels.thermoModels.CombustionModel.PremixedCombustion

.. autoapi-nested-parse::

   @author: <N. Surname>       <e-mail>
   Last update:        DD/MM/YYYY



Classes
-------

.. autoapisummary::

   libICEpost.src.thermophysicalModels.thermoModels.CombustionModel.PremixedCombustion.PremixedCombustion


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

.. py:class:: PremixedCombustion(/, *, xb: float = 0.0, **kwargs)

   Bases: :py:obj:`libICEpost.src.thermophysicalModels.thermoModels.CombustionModel.CombustionModel.CombustionModel`


   Premixted combustion model

   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

   Attributes:


   .. py:attribute:: _xb
      :type:  float


   .. py:method:: fromDictionary(dictionary: dict | libICEpost.src.base.dataStructures.Dictionary.Dictionary)
      :classmethod:


      Create from dictionary.

      :param dictionary: The dictionary from which constructing, containing:
                         reactants (Mixture): The reactants composition
                         xb (float, optional): The initial progress variable. Defaults to 0.0.
                         reactionModel (str, optional): Model handling reactions. defaults to "Stoichiometry".
                         <reactionModel>Dict (dict, optional): the dictionary for construction of the specific ReactionModel.
                         state (ThermoState, optional): Giving current state to manage state-dependend
                             reaction models(e.g. equilibrium). Defaults to empty state ThermoState().
      :type dictionary: dict



   .. py:method:: update(xb: float = None, *args, **kwargs) -> bool

      Update mixture composition based on progress variable, fuel, and reactants composition.

      :param xb: the burned mass fraction. Defaults to None (no update).
      :type xb: float, None
      :param reactants: update reactants composition. Defaults to None.
      :type reactants: Mixture, optional
      :param state: Giving current state to manage state-dependend
                    reaction models(e.g. equilibrium). Defaults to None.
      :type state: ThermoState, optional

      :returns: if something changed
      :rtype: bool