libICEpost.src.engineModel.functions
====================================

.. py:module:: libICEpost.src.engineModel.functions

.. autoapi-nested-parse::

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

   Generic functions useful for internal combustion engines.



Functions
---------

.. autoapisummary::

   libICEpost.src.engineModel.functions.upMean
   libICEpost.src.engineModel.functions.MFB


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

.. py:function:: upMean(*, n: float, S: float) -> float

   Compute the mean piston speed of a piston engine [m/s].

   :param n: Engine speed [rpm]
   :type n: float
   :param S: Engine stroke [m]
   :type S: float

   :returns: mean piston speed [m/s]
   :rtype: float


.. py:function:: MFB(engine: libICEpost.src.engineModel.EngineModel.EngineModel.EngineModel, xb: float) -> float

   Compute the CA instant at which the engine
   model reaches a given fuel mass fraction (xb).
   Assuming that the xb array was already computed
   and stored in the engine model.

   :param engine: The engine model
   :type engine: EngineModel
   :param xb: The value of xb to reach [0,1]
   :type xb: float

   :returns: CA(xb)
   :rtype: float