enums.py

class aviary.variable_info.enums.AlphaModes(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

AlphaModes is used to specify how angle of attack is defined during

climb and descent.

DEFAUT:

Alpha is an input

ROTATION

Alpha is calculated as the initial angle plus the rotation rate times the duration of the rotation.

LOAD_FACTOR

Alpha is limited to ensure the load factor never exceeds a specified maximum.

FUSELAGE_PITCH

Alpha is calculated to set a particular floor angle given the current flight path angle.

DECELERATION

Alpha is calculated to target a specified TAS rate, the default is a TAS rate of 0 (Constant TAS).

REQUIRED_LIFT

Alpha is calculated such that the aircraft produces a particular lifting force.

ALTITUDE_RATE

Alpha is calculated to target a specified altitude rate, the default is 0 (Constant Altitude).

ALTITUDE_RATE = 7

CONSTANT_ALTITUDE = 8

DECELERATION = 5

DEFAULT = 1

FLIGHT_PATH_ANGLE = 9

FUSELAGE_PITCH = 4

LOAD_FACTOR = 3

REQUIRED_LIFT = 6

ROTATION = 2

class aviary.variable_info.enums.AnalysisScheme(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

AnalysisScheme is used to select from Collocation and shooting.

COLLOCATION uses the collocation method to optimize all points simultaneously and can be run in parallel. However, it requires reasonable initial guesses for the trajectory and is fairly sensitive to those initial guesses.

SHOOTING is a forward in time integration method that simulates the trajectory. This does not require initial guesses and will always produce physically valid trajectories, even during optimizer failures. The shooting method cannot be run in parallel.

COLLOCATION = 1

SHOOTING = 2

class aviary.variable_info.enums.EquationsOfMotion(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Available equations of motion for use during mission analysis

HEIGHT_ENERGY = 'height_energy'

SOLVED_2DOF = 'solved_2DOF'

TWO_DEGREES_OF_FREEDOM = '2DOF'

class aviary.variable_info.enums.FlapType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Defines the type of flap used on the wing. Used in GASP-based aerodynamics and mass calculations.

DOUBLE_SLOTTED = 4

DOUBLE_SLOTTED_FOWLER = 7

FOWLER = 6

PLAIN = 1

SINGLE_SLOTTED = 3

SPLIT = 2

TRIPLE_SLOTTED = 5

class aviary.variable_info.enums.GASPEngineType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Defines the type of engine to use in GASP-based mass calculations. Note that only the value for the first engine model will be used. Currenly only the TURBOJET option is implemented, but other types of engines will be added in the future.

RECIP_CARB = 1

RECIP_CARB_HOPWSZ = 11

RECIP_FUEL_INJECT = 2

RECIP_FUEL_INJECT_GEARED = 3

RECIP_FUEL_INJECT_GEARED_HOPWSZ = 13

RECIP_FUEL_INJECT_HOPWSZ = 12

ROTARY = 4

ROTARY_RCWSZ = 14

TURBOJET = 7

TURBOPROP = 6

TURBOSHAFT = 5

class aviary.variable_info.enums.LegacyCode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Flag for legacy codebases

FLOPS = 'FLOPS'

GASP = 'GASP'

class aviary.variable_info.enums.OutMachType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

OutMachType is an indicator which mach number to output. helical_mach = sqrt(mach*mach + tip_mach*tip_mach)

HELICAL_MACH = 'helical_mach'

MACH = 'mach'

TIP_MACH = 'tip_mach'

classmethod get_element_by_value(val: str)

class aviary.variable_info.enums.ProblemType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

ProblemType is used to switch between different combinations of design variables and constraints.

SIZING: Varies the design gross weight and actual gross weight to close to design range. This causes the empty weight and the fuel weight to change.

ALTERNATE: Requires a pre-sized aircraft. It holds the design gross weight and empty weight constant. It then varies the fuel weight and actual gross weight until the range closes to the off-design range.

FALLOUT: Requires a pre-sized aircraft. It holds the design gross weight and empty weight constant. Using the specified actual gross weight, it will then find the maximum distance the off-design aircraft can fly.

ALTERNATE = 'alternate'

FALLOUT = 'fallout'

SIZING = 'sizing'

class aviary.variable_info.enums.SpeedType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

SpeedType is used to specify the type of speed being used. EAS is equivalent airspeed. TAS is true airspeed. MACH is mach

EAS = 'EAS'

MACH = 'mach'

TAS = 'TAS'

class aviary.variable_info.enums.ThrottleAllocation(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Specifies how to handle the throttles for multiple engines.

FIXED is a user-specified value. STATIC is specified by the optimizer as one value for the whole phase. DYNAMIC is specified by the optimizer at each point in the phase.

DYNAMIC = 3

FIXED = 1

STATIC = 2

class aviary.variable_info.enums.Verbosity(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: IntEnum

Sets how much information Aviary outputs when run

Verbosity levels are based on ubuntu’s standard: https://discourse.ubuntu.com/t/cli-verbosity-levels/26973

BRIEF = 1

DEBUG = 3

QUIET = 0

VERBOSE = 2

classmethod values()