aerosandbox.library.power_turboshaft
====================================

.. py:module:: aerosandbox.library.power_turboshaft


Attributes
----------

.. autoapisummary::

   aerosandbox.library.power_turboshaft.x


Functions
---------

.. autoapisummary::

   aerosandbox.library.power_turboshaft.overall_pressure_ratio_turboshaft_technology_limit
   aerosandbox.library.power_turboshaft.power_turboshaft
   aerosandbox.library.power_turboshaft.thermal_efficiency_turboshaft


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

.. py:function:: overall_pressure_ratio_turboshaft_technology_limit(mass_turboshaft)

   Estimates the maximum-practically-achievable overall pressure ratio (OPR) of a turboshaft engine, as a function
   of its mass. A regression to historical data.

   Based on an envelope of data for both civilian and military turboshafts (including RC-scale turboshafts), available in:
   `aerosandbox/library/datasets/turbine_engines/data.xlsx`

   See study in `/AeroSandbox/studies/TurboshaftStudies/make_fit_overall_pressure_ratio.py` for model details.

   :param mass_turboshaft: The mass of the turboshaft engine. [kg]

   :returns: The maximum-practically-achievable overall pressure ratio (OPR) of the turboshaft engine. [-]


.. py:function:: power_turboshaft(mass_turboshaft, overall_pressure_ratio = None)

   Estimates the maximum rated power of a turboshaft engine, given its mass. A regression to historical data.

   Based on data for both civilian and military turboshafts, available in:
   `aerosandbox/library/datasets/turbine_engines/data.xlsx`

   See studies in `/AeroSandbox/studies/TurboshaftStudies/make_fit_power.py` for model details.

   :param mass_turboshaft: The mass of the turboshaft engine. [kg]
   :param overall_pressure_ratio: The overall pressure ratio of the turboshaft engine. [-] If unspecified, a sensible
                                  default based on the technology envelope (with a 0.7x knockdown) will be used.

   :returns: The maximum (rated takeoff) power of the turboshaft engine. [W]


.. py:function:: thermal_efficiency_turboshaft(mass_turboshaft, overall_pressure_ratio = None, throttle_setting = 1)

   Estimates the thermal efficiency of a turboshaft engine. A regression to historical data.

   Based on data for both civilian and military turboshafts, available in:
   `aerosandbox/library/datasets/turbine_engines/data.xlsx`

   See studies in `/AeroSandbox/studies/TurboshaftStudies/make_turboshaft_fits.py` for model details.

   Thermal efficiency knockdown at partial power is based on:
       Ingmar Geiß, "Sizing of the Series Hybrid-electric Propulsion System of General Aviation Aircraft", 2020.
       PhD Thesis, University of Stuttgart. Page 18, Figure 3.2.

   :param mass_turboshaft: The mass of the turboshaft engine. [kg]
   :param overall_pressure_ratio: The overall pressure ratio of the turboshaft engine. [-] If unspecified, a sensible
                                  default based on the technology envelope (with a 0.7x knockdown) will be used.
   :param throttle_setting: The throttle setting of the turboshaft engine. [-] 1 is full throttle, 0 is no throttle.

   :returns: The thermal efficiency of the turboshaft engine. [-]


.. py:data:: x