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


stream…
stream…
stream…
shaft_…
shaft_…
W_e
W_e
W_e
W_r
W_r
\eta
\eta
Inlet
Inlet
Fan
Fan
Compressor
Compressor
Combustion chamber
Combustion chamber
Turbine
Turbine
Nozzle
Nozzle
Q_r
stream…
Viewer does not support full SVG 1.1

Component inheritance diagram


component
component
plant
plant
combustor
combustor
compressor
compressor
turbine
turbine
afterburner
afterburner
combustion_chamber
combustion_chamber
prop
prop
propfan
propfan
nozzle
nozzle
electrical_system
electrical_system
screw
screw
intake
intake
inlet
inlet
fan
fan
heat_sink
heat_sink
intercooler
intercooler
hydrogen
hydrogen
electric
electric
heat_source
heat_source
reheater
reheater
implemented
implemented
future versions
future versions
Viewer does not support full SVG 1.1

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

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

Sub-modules

huracan.components

Huracan engine components

huracan.constants

Huracan constants

huracan.engine

Huracan engine elements

huracan.thermo

Huracan thermodynamics methods

huracan.utils

Huracan utilities