Types

types

This module contains a set of type aliases for isqx physical quantity kinds and units.

When annotating functions, use unconstrained generic types:

from aerocore import types as t

def foo(x: t.StaticTemperatureK) -> t.PressurePA:
    ...

This signals to the static type checker that we want an Unknown type, not the Any type. Do not annotate with NDArray[np.float64] or float.

Reasoning: we wish to support a wide range of numerical libraries, so restricting ourselves to numpy will lead to many false positives in strict mode. See https://docs.jax.dev/en/latest/jep/12049-type-annotations.html for more information.

TEMPERATURE_GRADIENT = QtyKind(
    K * M**-1, ("temperature_gradient",)
)

Temperature lapse rate, e.g., in an atmosphere model.

BelowTropopause = 'below_tropopause'

STATIC_TEMPERATURE_BELOW_TROPO = STATIC_TEMPERATURE[
    BelowTropopause
]

STATIC_PRESSURE_BELOW_TROPO = STATIC_PRESSURE[
    BelowTropopause
]

DENSITY_FACTOR = Dimensionless('density_factor')

COMPRESSIBILITY_FACTOR = Dimensionless(
    "compressibility_factor"
)

LengthM = Annotated[_T, LENGTH(M)]

AngleRad = Annotated[_T, ANGLE(RAD)]

GravitationalAcceleration = Annotated[
    _T, ACCELERATION_OF_FREE_FALL(M_PERS2)
]

PressurePA = Annotated[_T, PRESSURE(PA)]

PressureHPA = Annotated[_T, PRESSURE(HECTO * PA)]

DensityKGM3 = Annotated[_T, DENSITY(KG * M ** -3)]

StaticTemperatureK = Annotated[_T, STATIC_TEMPERATURE(K)]

StaticPressurePA = Annotated[_T, STATIC_PRESSURE(PA)]

DynamicPressurePA = Annotated[_T, DYNAMIC_PRESSURE(PA)]

ImpactPressurePA = Annotated[_T, IMPACT_PRESSURE(PA)]

TotalPressurePA = Annotated[_T, TOTAL_PRESSURE(PA)]

GasConstantJMolK = Annotated[
    _T, MOLAR_GAS_CONSTANT(J * MOL**-1 * K**-1)
]

MolarMassKGMol = Annotated[_T, MOLAR_MASS(KG * MOL ** -1)]

SpecificGasConstantJKGK = Annotated[
    _T, SPECIFIC_GAS_CONSTANT(J * KG**-1 * K**-1)
]

TemperatureGradientKPM = Annotated[
    _T, TEMPERATURE_GRADIENT(K * M**-1)
]

StaticTemperatureKBelowTropo = Annotated[
    _T, STATIC_TEMPERATURE_BELOW_TROPO(K)
]

StaticPressurePABelowTropo = Annotated[
    _T, STATIC_PRESSURE_BELOW_TROPO(PA)
]

CasMPS = Annotated[_T, CALIBRATED_AIRSPEED(M_PERS)]

EasMPS = Annotated[_T, EQUIVALENT_AIRSPEED(M_PERS)]

TasMPS = Annotated[_T, TRUE_AIRSPEED(M_PERS)]

SpeedOfSoundMPS = Annotated[_T, SPEED_OF_SOUND(M_PERS)]

GeopotentialAltitudeM = Annotated[
    _T, GEOPOTENTIAL_ALTITUDE(M)
]

GeometricAltitudeM = Annotated[_T, GEOMETRIC_ALTITUDE(M)]

ThrustN = Annotated[_T, FORCE(N)]

MassFlowKgPS = Annotated[_T, MASS_FLOW_RATE(KG * S ** -1)]

SpecificFuelConsumptionKgPNPS = Annotated[
    _T,
    THRUST_SPECIFIC_FUEL_CONSUMPTION(KG * N**-1 * S**-1),
]

MachNumber = Annotated[_T, MACH_NUMBER]

RatioOfSpecificHeats = Annotated[_T, HEAT_CAPACITY_RATIO]

DensityFactor = Annotated[_T, DENSITY_FACTOR]

CompressibilityFactor = Annotated[
    _T, COMPRESSIBILITY_FACTOR
]

BypassRatio = Annotated[_T, BYPASS_RATIO]

DeltaTemperatureK = Annotated[_T, TEMPERATURE[DELTA](K)]

DeltaLengthM = Annotated[_T, LENGTH[DELTA](M)]