Package `huracan`

Welcome to the Huracan API documentation!

Huracan is an open source, 0-dimensional, object-oriented airbreathing engine modelling package for preliminary analysis and design of airbreathing engines, divulgation and educational purposes.

Engine modelling

In the diagram below can be seen how Huracan models an engine. Fundamentally:

Work is distributed through the shafts
Each stream posesses a gas instance which undergoes a series of processes.

Important assumptions

Ideal gas model
Adiabatic compression and expansion
Isobaric heat exchanges (albeit a pressure ratio can be provided in these cases)

Key ideas

Compartmentalization of the gas model, thermodynamic process methods and component classes
Gas splitting and merging operations are conducted at runtime
Stream functions overtaken by system functions at runtime when a system is created

Engine modelling diagram

Component inheritance diagram

Expand source code

# SPDX-FileCopyrightText: © 2024 Antonio López Rivera <antonlopezr99@gmail.com>
# SPDX-License-Identifier: GPL-3.0-only

"""
.. include:: ./documentation.md
"""

component_codes = {
    'fan':                'fn',
    'prop':               'pr',
    'propfan':            'pf',
    'intake':             'it',
    'inlet':              'il',
    'compressor':         'cp',
    'bleed_duct':         'bd',
    'combustion_chamber': 'cc',
    'turbine':            'tb',
    'nozzle':             'nz',
    'intercooler':        'ic',
    'recuperator':        'rc',
    'afterburner':        'ab',
}

Sub-modules

huracan.components: Huracan engine components
huracan.constants: Huracan constants
huracan.engine: Huracan engine elements
huracan.physical_quantities: Information about physical quantities used in Huracan
huracan.thermo: Huracan thermodynamics methods
huracan.utils: Huracan utilities