Understanding the Variable Metadata#
How Variable Metadata Works#
Every variable in an Aviary variable hierarchy must have metadata associated with it. This metadata is used for setting initial values, setting Aviary inputs and outputs, and various other functionalities throughout the code. It is also helpful information for the user to have regarding each variable and the metadata dictionary allows all that information to live in one organized location. Unlike variable hierarchies, which are broken up into different categories based on the type of information they contain, the variable metadata all lives in the same dictionary, regardless of which variable hierarchy its variables come from.
The variable metadata dictionary is exactly what it sounds like: a Python dictionary, or more explicitly a Python dictionary of dictionaries. The entire metadata is one dictionary, and within that metadata dictionary each variable (the key) has its own sub-dictionary including all the information relevant to that variable. The information included in each sub-dictionary is:
Key Name in Metadata |
Default Value |
Information |
|---|---|---|
key |
|
Name |
units |
|
Units |
default_value |
|
Default Value |
types |
|
Type Restrictions |
multivalue |
|
Can variable be vectorized? |
option |
|
Is Option? |
desc |
|
Description |
historical_name |
|
Historical Variable Name(s) |
Many of these variables are self-explanatory, but many require additional discussion.
key is the variable name, which must be a string compatible with OpenMDAO’s variable name rules. Units must be a string, also compatible with OpenMDAO’s list of supported units.
default_value is what Aviary will use if the variable is not provided by the user as an input or does not come from another part of the problem (computed by another component, provided by Dymos as a state/control/timeseries , etc.)
types is a Python type or tuple of types that this variable is allowed to be. If not provided, types defaults to the type of default_value (which in turn is defaulted to a float).
multivalue is a boolean flag that tells Aviary if this variable can be a iterable (typically a list, numpy array, or tuple). If this flag is True, those iterable types are also allowable types in addition to whatever is listed in types. When doing type checks, Aviary will check the value of each index in a provided iterable against types. So if your variable is expected to be a list of floats, then types should be set to float, and multivalue should be True. If you provide an iterable type in types while multivalue is True, then you are telling Aviary that you can have a multidimensional array (e.g. a list that contains lists). Expected array size is not set in metadata, but instead in OpenMDAO system definition, when inputs/outputs/options are added to the system.
If multivalue is False and an iterable type is given in types, then Aviary will not know how to enforce type checks for values inside the iterable! Any iterable that matches types will pass, regardless of what it contains - this is technically fine, but opens you up to an accidental TypeError later down the line. We don’t reccomend setting up variables like this. In general, only add iterable types to types if you are working with multidimensional arrays.
option is a boolean flag if your variable is used as an OpenMDAO option, rather than a component input or output. Set this flag to True to ensure your variable correctly gets connected to any components that ask for it through options.
desc is a string that should describe what the variable represents, how it is used, and any other information that would be helpful for an aircraft designer setting a value for that variable in their input file.
historical_name is a dictionary that connects this variable with any potential matching variables in legacy codes Aviary inherrited from. Variable names under the keys FLOPS or GASP will be used by the fortran_to_aviary input file conversion utility to attempt to match legacy input files with Aviary variables.
The information in the metadata dictionary is accessed just like information in any other Python dictionary. For example, if you wanted to know the units of the Aircraft.Wing.SPAN variable from the Aviary-core Aircraft variable hierarchy along with whether or not the variable was an option, you would access those units using the following code:
import aviary.api as av
AviaryAircraft = av.Aircraft
wingspan_units = av.CoreMetaData[AviaryAircraft.Wing.SPAN]['units']
wingspan_is_option = av.CoreMetaData[AviaryAircraft.Wing.SPAN]['option']
print(wingspan_units)
print(wingspan_is_option)
In this example we use the variable hierarchy to provide the name of the variable we are seeking to Aviary’s CoreMetaData, and we use the keys from the metadata dictionary to provide the specific information that we would like to know. This would return
ft
False
which tells you that the units of the variable Aircraft.Wing.SPAN from the Aviary-core Aircraft variable hierarchy are feet, and that Aircraft.Wing.SPAN is not an option.
Note
Many of the weight and aerodynamic estimating relationships in Aviary originated from historical codes called GASP and FLOPS. For engineers who are familiar with GASP and FLOPS it is helpful to know what an Aviary variable was called in those historical codes.
The historical variable name portion of the metadata allows us to associate any names that an Aviary variable may have had in a previous code. This piece of the metadata is actually a dictionary within each subdictionary belonging to each variable. This dictionary is used by adding an entry for each historical code, where the key is the name of the historical code, and the value for that key is a string or list of strings illustrating the name(s) that variable held in the historic code. This is an optional feature, but can be helpful for users who are porting old codes into new formats. If a tilde (~) is attached to a historical variable, it is a local variable or parameter in GASP or FLOPS. More details about the naming convention is described in utils/develop_metadata.py.
The Aviary-core Metadata#
The Aviary code provides metadata for every variable in the Aviary-core variable hierarchies. As noted above, the metadata is not broken up into multiple dictionaries like the variable hierarchy, but instead the metadata for every variable lives in the same dictionary. As such there is only one Aviary-core metadata dictionary, which can be viewed here and accessed in the following way:
import aviary.api as av
MetaData = av.CoreMetaData
In the Aviary-core metadata dictionary, due to the size of the data we have adopted a structure of organizing the metadata alphabetically by variable hierarchy. Thus, while all the variables are part of the same metadata dictionary, you will notice that the organization structure of the file is the same alphabetical hierarchal organization structure as the Aviary-core variable hierarchy. This is a convention that we encourage to improve the cleanliness of code, but it is not strictly required.
Building Your Own Metadata#
Unlike the variable hierarchies, which are separated out into different hierarchies for different types of data, there is only one metadata dictionary for all variables in every variable hierarchy. Technically the user may build a metadata dictionary from scratch instead of extending the Aviary-core metadata, however, there is no real value to this as you will eventually have to merge back in the Aviary-core metadata anyway, so there are no normal circumstances under which this is the recommended practice. However, just like with variable hierarchies, you can have several different metadata dictionaries which will eventually be merged together. This may be necessary when there are multiple people developing different external subsystems in different locations.
There are two different ways to change the metadata in a metadata dictionary. The first is to add a new variable to the dictionary, and add that variable’s metadata along with it. This makes use of the add_meta_data() function. This function takes in the variable name of the variable to be added to the metadata dictionary be provided, as well as the dictionary itself that the variable should be added to. It also optionally takes in all of the metadata information listed at the beginning of this page. The function returns nothing, but it internally updates the provided metadata dictionary so that dictionary will contain the new variable and its metadata.
The second way to change the metadata in a metadata dictionary is by updating the metadata associated with a variable that is already in the dictionary. This is accomplished using the update_meta_data() function. This function behaves almost identically to the add_meta_data() function, the only difference being that instead of adding a new variable to the dictionary, it will take the input of metadata information that you provide and overwrite the old metadata of the given variable with the new metadata.
There are two pitfalls that may occur when using these functions. The first pitfall is attempting to call the add_meta_data() function for a variable that already exists in the metadata. This will throw an error, because the add_meta_data() function is only for new variables to the metadata. Conversely, attempting to update the metadata of a variable that is not in the metadata dictionary via update_meta_data() will throw an error because that function is only for variables that already exist in the metadata.
The methods outlined above for updating and adding to the variable metadata are the crux of how the variable metadata can be extended for new variables. The user will simply import the existing Aviary-core metadata and add to it as they see fit.
Note
The variable metadata dictionary that is imported from the Aviary API is actually a copy of the original Aviary metadata dictionary to avoid mutating the original dictionary. That being said, it functions just as a metadata dictionary that you would input to an Aviary model and you can extend it or input it to a model as-is depending on your needs.
Lets examine how we would extend the variable metadata dictionary in practice. Say we have just extended the Aviary-core Aircraft variable hierarchy to add some center of gravity, flap, and jury strut information using the extension below:
import aviary.api as av
AviaryAircraft = av.Aircraft
class ExtendedAircraft(AviaryAircraft):
CG = 'aircraft:center_of_gravity'
class Wing(AviaryAircraft.Wing):
class Flap:
AREA = 'aircraft:wing:flap:area'
ROOT_CHORD = 'aircraft:wing:flap:root_chord'
SPAN = 'aircraft:wing:flap:span'
class Jury:
MASS = 'aircraft:jury:mass'
Now we want to extend the Aviary-core metadata into our own metadata that includes metadata for each one of these variables in the same code:
ExtendedMetaData = av.CoreMetaData
av.add_meta_data(
ExtendedAircraft.CG,
meta_data=av.CoreMetaData,
units='ft',
desc='Center of gravity',
default_value=0,
option=False,
)
av.add_meta_data(
ExtendedAircraft.Wing.Flap.AREA,
meta_data=ExtendedMetaData,
units='ft**2',
desc='planform area of flap',
default_value=10,
option=False,
)
av.add_meta_data(
ExtendedAircraft.Wing.Flap.ROOT_CHORD,
meta_data=ExtendedMetaData,
units='ft',
desc='chord of flap at root of wing',
default_value=1,
option=False,
)
av.add_meta_data(
ExtendedAircraft.Wing.Flap.SPAN,
meta_data=ExtendedMetaData,
units='ft',
desc='span of flap',
default_value=60,
option=False,
)
av.add_meta_data(
ExtendedAircraft.Jury.MASS,
meta_data=ExtendedMetaData,
units='kg',
desc='mass of jury strut',
default_value=50,
option=False,
)
ExtendedMetaData now contains the metadata of all the Aviary-core variables along with the metadata information that we just added.
Merging Independent Metadata#
Extending the metadata is great, but sometimes users will end up with multiple metadata dictionaries because different subsystem developers extended the metadata (and created associated variable hierarchies) to suit their own needs. Aviary needs to be given one single metadata dictionary which contains metadata of all the variables it has been given, so we need to be able to merge together multiple metadata dictionaries into one. The merge_meta_data() function has been provided to combine all the different metadata into one. The merge_meta_data() function behaves quite similarly to the merge_hierarchies() function. It takes in a string of metadata dictionaries that need to be merged together, and it returns a single metadata dictionary containing the metadata from all the individual dictionaries.
Let’s say that we have created our ExtendedAircraft and ExtendedMetaData from above, and that elsewhere we have a subsystem that requires information about engine cooling system mass as well as whether the aircraft has winglets. Below is the buildup of the Aircraft type hierarchy and the metadata for our new subsystem:
import aviary.api as av
class ExtendedAircraft2(av.Aircraft):
class Engine(av.Aircraft.Engine):
class Cooling:
MASS = 'aircraft:engine:cooling:mass'
class Wing(av.Aircraft.Wing):
WINGLETS = 'aircraft:wing:winglets'
ExtendedMetaData2 = av.CoreMetaData
av.add_meta_data(
ExtendedAircraft2.Engine.Cooling.MASS,
units='kg',
desc='mass of cooling system for one engine',
default_value=100,
meta_data=ExtendedMetaData2,
historical_name=None,
)
av.add_meta_data(
ExtendedAircraft2.Wing.WINGLETS,
units=None,
desc='Tells whether the aircraft has winglets',
default_value=True,
option=True,
types=bool,
meta_data=ExtendedMetaData2,
historical_name=None,
)
# Testing Cell
glue_variable(get_variable_name(ExtendedAircraft2), md_code=True)
glue_variable(get_variable_name(ExtendedMetaData2), md_code=True)
We can see from the above code that we have an Aircraft type variable hierarchy named ExtendedAircraft2 and that we have created our own metadata dictionary ExtendedMetaData2 which is an extension of the CoreMetaData dictionary in Aviary-core. Now we have two different Aircraft type variable hierarchy extensions, ExtendedAircraft and ExtendedAircraft2. We also have two different metadata extensions, ExtendedMetaData and ExtendedMetaData2. We need a single Aircraft type variable hierarchy, and single metadata dictionary. Thus, we will use the merging functions built into Aviary:
FinalAircraft = av.merge_hierarchies([ExtendedAircraft, ExtendedAircraft2])
FinalMetaData = av.merge_meta_data([ExtendedMetaData, ExtendedMetaData2])
Above we merged together our hierarchy and metadata extensions, and now we have one single Aircraft type hierarchy FinalAircraft and one single metadata dictionary FinalMetaData which we can provide to the Aviary model.
There is one situation when an attempt to merge together multiple metadata dictionaries will cause errors, and that situation is if more than one metadata dictionary contains the same variable with different metadata. If multiple dictionaries contain the same variable with identical metadata the merge will proceed, but if the metadata differs at all the merge will halt and force the user to rectify the discrepancy.
More syntactical data on the merging functions can be found here.
Providing Aviary with Necessary Variable Metadata#
This section is under development.
Searchable Metadata Table#
The table below contains all the metadata for every variable in the Aviary-core variable hierarchies. The table is searchable and sortable and is created automatically from the Aviary core metadata dictionary.
Loading ITables v2.9.1 from the init_notebook_mode cell...
(need help?)
|
| ⓘvariable name | units | desc | option | default_value | types | multivalue | historical_name |
|---|---|---|---|---|---|---|---|
| aircraft:air_conditioning:mass | lbm | Environmental control mass (air conditioning) | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:air_conditioning:mass_coefficient | unitless | mass trend coefficient of air conditioning | False | 1.0 | <class 'float'> | False | GASP: INGASP.CW(6)<br />FLOPS: None |
| aircraft:air_conditioning:mass_scaler | unitless | air conditioning system mass scaler | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.WAC |
| aircraft:anti_icing:mass | lbm | Anti-icing system mass | False | 0.0 | <class 'float'> | False | GASP: INGASP.CW(7)<br />FLOPS: None |
| aircraft:anti_icing:mass_scaler | unitless | anti-icing system mass scaler | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.WAI |
| aircraft:apu:mass | lbm | mass of auxiliary power unit | False | 0.0 | <class 'float'> | False | GASP: INGASP.CW(1)<br />FLOPS: None |
| aircraft:apu:mass_scaler | unitless | mass scaler for auxiliary power unit | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.WAPU |
| aircraft:avionics:mass | lbm | Avionics group mass. Includes equipment and installation mass. | False | 0.0 | <class 'float'> | False | GASP: INGASP.CW(5)<br />FLOPS: None |
| aircraft:avionics:mass_scaler | unitless | avionics mass scaler | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.WAVONC |
| aircraft:battery:additional_mass | lbm | mass of non energy-storing parts of the battery | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:battery:discharge_limit | unitless | default constraint on how far the battery can discharge, as a proportion of total energy capacity | False | 0.2 | <class 'float'> | False | GASP: INGASP.SOCMIN<br />FLOPS: None |
| aircraft:battery:efficiency | unitless | battery pack efficiency | False | 1.0 | <class 'float'> | False | GASP: INGASP.EFF_BAT<br />FLOPS: None |
| aircraft:battery:energy_capacity | kJ | total energy the battery can store | False | 0.0 | <class 'float'> | False | GASP: EBATTAVL<br />FLOPS: None |
| aircraft:battery:mass | lbm | total mass of the battery | False | 0.0 | <class 'float'> | False | GASP: INGASP.WBATTIN<br />FLOPS: None |
| aircraft:battery:pack_energy_density | W*h/kg | specific energy density of the battery pack | False | 1.0 | <class 'float'> | False | GASP: INGASP.ENGYDEN<br />FLOPS: None |
| aircraft:battery:pack_mass | lbm | mass of the energy-storing components of the battery | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:battery:pack_volumetric_density | kW*h/L | volumetric density of the battery pack | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:battery:volume | ft*3 | total volume of the battery pack | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:blended_wing_body_design:detailed_wing_provided | unitless | Flag if the detailed wing model is provided | True | True | <class 'bool'> | False | GASP: None<br />FLOPS: None |
| aircraft:blended_wing_body_design:max_bay_width | ft | maximum bay width | True | 0 | <class 'float'> | False | GASP: None<br />FLOPS: FUSEIN.BAYWMX<br />LEAPS1: None |
| aircraft:blended_wing_body_design:max_num_bays | unitless | fixed number of bays | True | 0 | <class 'int'> | False | GASP: None<br />FLOPS: FUSEIN.NBAYMX |
| aircraft:blended_wing_body_design:num_bays | unitless | fixed number of passenger bays | False | [0] | <class 'int'> | True | GASP: None<br />FLOPS: FUSEIN.NBAY |
| aircraft:blended_wing_body_design:passenger_leading_edge_sweep | deg | forebody sweep angle | False | 0.0 | <class 'float'> | False | GASP: ['INGASP.SWP_FB']<br />FLOPS: FUSEIN.SWPLE |
| aircraft:canard:area | ft**2 | canard theoretical area | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.SCAN |
| aircraft:canard:aspect_ratio | unitless | canard theoretical aspect ratio | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.ARCAN |
| aircraft:canard:characteristic_length | ft | Reynolds characteristic length for the canard | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:canard:fineness | unitless | canard fineness ratio | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:canard:laminar_flow_lower | unitless | define percent laminar flow for canard lower surface | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: AERIN.TRLC |
| aircraft:canard:laminar_flow_upper | unitless | define percent laminar flow for canard upper surface | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: AERIN.TRUC |
| aircraft:canard:mass | lbm | mass of canards | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:canard:mass_scaler | unitless | mass scaler for canard structure | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.FRCAN |
| aircraft:canard:taper_ratio | unitless | canard theoretical taper ratio | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.TRCAN |
| aircraft:canard:thickness_to_chord | unitless | canard thickness-chord ratio | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.TCCAN |
| aircraft:canard:wetted_area | ft**2 | canard wetted area | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:canard:wetted_area_scaler | unitless | canard wetted area scaler | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: AERIN.SWETC |
| aircraft:controls:cockpit_control_mass | lbm | cockpit controls mass | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:controls:cockpit_control_mass_scaler | unitless | technology factor on cockpit controls mass | False | 1.0 | <class 'float'> | False | GASP: INGASP.CK15<br />FLOPS: None |
| aircraft:controls:control_mass_increment | lbm | incremental flight controls mass | False | 0.0 | <class 'float'> | False | GASP: INGASP.DELWFC<br />FLOPS: None |
| aircraft:controls:mass | lbm | Flight controls group mass. Contains cockpit controls, automatic flight control system and system controls. | False | 0.0 | <class 'float'> | False | GASP: INGASP.WFC<br />FLOPS: None |
| aircraft:controls:stability_augmentation_system_mass | lbm | scaled mass of stability augmentation system | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:controls:stability_augmentation_system_mass_scaler | unitless | technology factor on stability augmentation system mass | False | 1.0 | <class 'float'> | False | GASP: INGASP.CK19<br />FLOPS: None |
| aircraft:controls:stability_augmentation_system_reference_mass | lbm | reference mass of stability augmentation system | False | 0.0 | <class 'float'> | False | GASP: INGASP.SKSAS<br />FLOPS: None |
| aircraft:crew_and_payload:baggage_mass | lbm | mass of passenger baggage | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:crew_and_payload:baggage_mass_per_passenger | lbm | baggage mass per passenger | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.BPP |
| aircraft:crew_and_payload:cabin_crew_mass | lbm | total mass of the non-flight crew and their baggage | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:crew_and_payload:cabin_crew_mass_scaler | unitless | scaler for total mass of the non-flight crew and their baggage | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.WSTUAB |
| aircraft:crew_and_payload:cargo_container_mass | lbm | mass of cargo containers | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:crew_and_payload:cargo_container_mass_scaler | unitless | Scaler for mass of cargo containers | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.WCON |
| aircraft:crew_and_payload:cargo_mass | lbm | total mass of as-flown cargo | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:crew_and_payload:catering_items_mass_per_passenger | lbm | mass of catering items per passenger | False | 0.0 | <class 'float'> | False | GASP: INGASP.CW(12)<br />FLOPS: None |
| aircraft:crew_and_payload:flight_crew_mass | lbm | total mass of the flight crew and their baggage | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:crew_and_payload:flight_crew_mass_scaler | unitless | scaler for total mass of the flight crew and their baggage | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.WFLCRB |
| aircraft:crew_and_payload:mass_per_passenger | lbm | mass per passenger | False | 165.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.WPPASS |
| aircraft:crew_and_payload:mass_per_passenger_with_bags | lbm | total mass of one passenger and their bags | False | 200.0 | <class 'float'> | False | GASP: INGASP.UWPAX<br />FLOPS: None |
| aircraft:crew_and_payload:misc_cargo | lbm | cargo (other than passenger baggage) carried in fuselage | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.CARGOF |
| aircraft:crew_and_payload:num_business_class | unitless | number of business class passengers | True | 0 | <class 'int'> | False | GASP: None<br />FLOPS: None |
| aircraft:crew_and_payload:num_cabin_crew | unitless | Total number of cabin crew. In FLOPS this includes galley and flight attendants | True | 0 | <class 'int'> | False | GASP: None<br />FLOPS: None |
| aircraft:crew_and_payload:num_economy_class | unitless | number of economy class passengers | True | 0 | <class 'int'> | False | GASP: None<br />FLOPS: None |
| aircraft:crew_and_payload:num_first_class | unitless | number of first class passengers. | True | 0 | <class 'int'> | False | GASP: None<br />FLOPS: None |
| aircraft:crew_and_payload:num_flight_attendants | unitless | number of flight attendants | True | 0 | <class 'int'> | False | GASP: None<br />FLOPS: WTIN.NSTU |
| aircraft:crew_and_payload:num_flight_crew | unitless | number of flight crew | True | 0 | <class 'int'> | False | GASP: None<br />FLOPS: WTIN.NFLCR |
| aircraft:crew_and_payload:num_galley_crew | unitless | number of galley crew | True | 0 | <class 'int'> | False | GASP: None<br />FLOPS: WTIN.NGALC |
| aircraft:crew_and_payload:num_passengers | unitless | total number of passengers | True | 0 | <class 'int'> | False | GASP: None<br />FLOPS: None |
| aircraft:crew_and_payload:passenger_mass_total | lbm | TBD: total mass of all passengers without their baggage | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:crew_and_payload:passenger_payload_mass | lbm | mass of passenger payload, including passengers, passenger baggage | False | 0.0 | <class 'float'> | False | GASP: INGASP.WPL<br />FLOPS: None |
| aircraft:crew_and_payload:passenger_service_mass | lbm | mass of passenger service equipment | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:crew_and_payload:passenger_service_mass_per_passenger | lbm | mass of passenger service items mass per passenger | False | 0.0 | <class 'float'> | False | GASP: INGASP.CW(9)<br />FLOPS: None |
| aircraft:crew_and_payload:passenger_service_mass_scaler | unitless | scaler for mass of passenger service equipment | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.WSRV |
| aircraft:crew_and_payload:total_payload_mass | lbm | total mass of payload, including passengers, passenger baggage, and cargo | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:crew_and_payload:uld_mass_per_passenger | lbm | unit mass of ULD (unit load device) for cargo handling per passenger. Used to calculateAicraft.CrewPayload.CARGO_CONTAINER_MASS | True | 0.0 | <class 'float'> | False | GASP: INGASP.CW(14)<br />FLOPS: None |
| aircraft:crew_and_payload:water_mass_per_occupant | lbm | mass of water per occupant (passengers, pilots, and flight attendants) | False | 1.0 | <class 'float'> | False | GASP: INGASP.CW(10)<br />FLOPS: None |
| aircraft:crew_and_payload:wing_cargo | lbm | cargo carried in wing | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.CARGOW |
| aircraft:crew_and_payload:design:cargo_mass | lbm | total mass of cargo flown on design mission | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:crew_and_payload:design:max_cargo_mass | lbm | maximum mass of cargo | False | 0.0 | <class 'float'> | False | GASP: INGASP.WCARGO<br />FLOPS: None |
| aircraft:crew_and_payload:design:num_business_class | unitless | number of business class passengers that the aircraft is designed to accommodate | True | 0 | <class 'int'> | False | GASP: None<br />FLOPS: WTIN.NPB |
| aircraft:crew_and_payload:design:num_economy_class | unitless | number of economy class passengers that the aircraft is designed to accommodate | True | 0 | <class 'int'> | False | GASP: None<br />FLOPS: WTIN.NPT |
| aircraft:crew_and_payload:design:num_first_class | unitless | number of first class passengers that the aircraft is designed to accommodate. In GASP, the input is the percentage of total number of passengers. | True | 0 | <class 'int'> | False | GASP: INGASP.PCT_FC<br />FLOPS: WTIN.NPF |
| aircraft:crew_and_payload:design:num_passengers | unitless | total number of passengers that the aircraft is designed to accommodate | True | 0 | <class 'int'> | False | GASP: INGASP.PAX<br />FLOPS: None |
| aircraft:crew_and_payload:design:num_seats_abreast_business | unitless | Number of business class seats abreast. | True | 5 | <class 'int'> | False | GASP: None<br />FLOPS: FUSEIN.NBABR |
| aircraft:crew_and_payload:design:num_seats_abreast_economy | unitless | Number of economy class seats abreast. | True | 6 | <class 'int'> | False | GASP: INGASP.SAB<br />FLOPS: FUSEIN.NTABR |
| aircraft:crew_and_payload:design:num_seats_abreast_first | unitless | Number of first class seats abreast. | True | 4 | <class 'int'> | False | GASP: None<br />FLOPS: FUSEIN.NFABR |
| aircraft:crew_and_payload:design:seat_pitch_business | inch | pitch of the business class seats. | True | 39.0 | <class 'float'> | False | GASP: None<br />FLOPS: FUSEIN.BPITCH |
| aircraft:crew_and_payload:design:seat_pitch_economy | inch | pitch of the economy class seats. | True | 32.0 | <class 'float'> | False | GASP: INGASP.PS<br />FLOPS: FUSEIN.TPITCH |
| aircraft:crew_and_payload:design:seat_pitch_first | inch | pitch of the first class seats. | True | 61.0 | <class 'float'> | False | GASP: None<br />FLOPS: FUSEIN.FPITCH |
| aircraft:design:base_area | ft**2 | Aircraft base area (total exit cross-section area minus inlet capture areas for internally mounted engines) | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: AERIN.SBASE |
| aircraft:design:cg_delta | unitless | allowable center-of-gravity (cg) travel as a fraction of the mean aerodynamic chord | False | 0.0 | <class 'float'> | False | GASP: INGASP.DELCG<br />FLOPS: None |
| aircraft:design:characteristic_lengths | ft | Reynolds characteristic length for each component | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:design:cockpit_control_mass_coefficient | unitless | mass trend coefficient of cockpit controls | False | 0.0 | <class 'float'> | False | GASP: INGASP.SKCC<br />FLOPS: None |
| aircraft:design:compressibility_drag_factor | unitless | compressibility aero calibration factor | False | 1.0 | <class 'float'> | False | GASP: INGASP.FCMPC<br />FLOPS: None |
| aircraft:design:compute_htail_volume_coeff | unitless | if true, use empirical tail volume coefficient equation. This is true if VBARHX is 0 in GASP. | True | False | <class 'bool'> | False | GASP: None<br />FLOPS: None |
| aircraft:design:compute_vtail_volume_coeff | unitless | if true, use empirical tail volume coefficient equation. This is true if VBARVX is 0 in GASP. | True | False | <class 'bool'> | False | GASP: None<br />FLOPS: None |
| aircraft:design:cruise_altitude | ft | design mission cruise altitude | True | 25000.0 | <class 'float'> | False | GASP: INGASP.CRALT<br />FLOPS: None |
| aircraft:design:cruise_mach | unitless | aircraft cruise Mach number | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: CONFIN.VCMN |
| aircraft:design:drag_coefficient_increment | unitless | increment to the profile drag coefficient | False | 0.0 | <class 'float'> | False | GASP: INGASP.DELCD<br />FLOPS: None |
| aircraft:design:drag_divergence_shift | unitless | shift in drag divergence Mach number due to supercritical design | False | 0.0 | <class 'float'> | False | GASP: INGASP.SCFAC<br />FLOPS: None |
| aircraft:design:drag_polar | unitless | Drag polar computed during Aviary pre-mission. | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| aircraft:design:emergency_equipment_mass | lbm | mass of emergency equipment | False | 0.0 | <class 'float'> | False | GASP: INGASP.CW(11)<br />FLOPS: None |
| aircraft:design:empennage_mass | lbm | Empennage group mass. Contains mass of canards, horizontal/vertical stabilizers and fins, and ventral fins, and any supporting structure for mounted engines on those surfaces. | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:design:empty_mass | lbm | Empty mass of the aircraft. Includes structure group, propulsion group, and total systems and equipment mass. | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:design:empty_mass_margin | lbm | empty mass margin | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:design:empty_mass_margin_scaler | unitless | empty mass margin scaler | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.EWMARG |
| aircraft:design:excrescence_drag_factor | unitless | excrescence aero drag factor | False | 1.0 | <class 'float'> | False | GASP: INGASP.FEXCRT<br />FLOPS: None |
| aircraft:design:external_subsystems_mass | lbm | Total mass of all user-defined external subsystems. These are bookkept as part of empty mass. | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:design:fineness | unitless | table of component fineness ratios | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:design:gross_mass | lbm | Design gross mass of the aircraft. Includes zero fuel mass plus useable fuel. | False | 0.0 | <class 'float'> | False | GASP: INGASP.WG<br />FLOPS: WTIN.DGW |
| ijeff | unitless | A flag used by Jeff V. Bowles to debug GASP code during his 53 years supporting the development of GASP. This flag is planted here to thank him for his hard work and dedication, Aviary wouldn't be what it is today without his help. | False | 0.0 | <class 'float'> | False | GASP: INGASP.IJEFF<br />FLOPS: None |
| aircraft:design:interference_drag_factor | unitless | interference aero calibration factor (including technology factor INGASP.FCKIT) | False | 1.0 | <class 'float'> | False | GASP: INGASP.FCKIC<br />FLOPS: None |
| aircraft:design:laminar_flow_lower | unitless | table of percent laminar flow over lower component surfaces | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:design:laminar_flow_upper | unitless | table of percent laminar flow over upper component surfaces | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:design:landing_to_takeoff_mass_ratio | unitless | ratio of maximum landing mass to maximum takeoff mass | False | 1.0 | <class 'float'> | False | GASP: INGASP.WLPCT<br />FLOPS: AERIN.WRATIO |
| aircraft:design:lift_coefficient | unitless | Fixed design lift coefficient. If input, overrides design lift coefficient computed by EDET. | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: AERIN.FCLDES |
| aircraft:design:lift_coefficient_max_flaps_up | unitless | maximum lift coefficient from flaps model when flaps are up (not deployed) | False | 0.0 | <class 'float'> | False | GASP: ['INGASP.CLMWFU', 'INGASP.CLMAX']<br />FLOPS: None |
| aircraft:design:lift_curve_slope | 1/rad | lift curve slope at cruise Mach number | False | 0.0 | <class 'float'> | False | GASP: INGASP.CLALPH<br />FLOPS: None |
| aircraft:design:lift_dependent_drag_coeff_factor | unitless | Scaling factor for lift-dependent drag coefficient | False | 1.0 | <class 'float'> | False | GASP: INGASP.FSA7C<br />FLOPS: MISSIN.FCDI |
| aircraft:design:lift_dependent_drag_polar | unitless | Lift dependent drag polar computed during Aviary pre-mission. | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| aircraft:design:lift_independent_drag_polar | unitless | Lift independent drag polar computed during Aviary pre-mission. | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| aircraft:design:lift_polar | unitless | Lift polar computed during Aviary pre-mission. | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| aircraft:design:mach | unitless | aircraft design Mach number | False | 0.0 | <class 'float'> | False | GASP: INGASP.CRMACH<br />FLOPS: AERIN.FMDES |
| aircraft:design:max_fuselage_pitch_angle | deg | maximum fuselage pitch allowed | False | 15.0 | <class 'float'> | False | GASP: INGASP.THEMAX<br />FLOPS: None |
| aircraft:design:max_structural_speed | mi/h | maximum structural design flight speed in miles per hour | False | 0.0 | <class 'float'> | False | GASP: INGASP.VMLFSL<br />FLOPS: None |
| aircraft:design:part25_structural_category | unitless | part 25 structural category | True | 3 | <class 'int'> | False | GASP: INGASP.CATD<br />FLOPS: None |
| aircraft:design:percent_excrescence_drag | unitless | excrescence drag as percentage of fuselage, wing, nacelle, (winglet), empennage and strut | True | 0.0 | <class 'float'> | False | GASP: INGASP.PCT_EXCR<br />FLOPS: None |
| aircraft:design:range | NM | The design range of the aircraft used for sizing of FLOPS based subsystems and mission target length if not provided in phase_info | False | 0.0 | <class 'float'> | False | GASP: INGASP.ARNGE<br />FLOPS: CONFIN.DESRNG |
| aircraft:design:smooth_mass_discontinuities | unitless | eliminates discontinuities in GASP-based mass estimation code if true | True | False | <class 'bool'> | False | GASP: None<br />FLOPS: None |
| aircraft:design:static_margin | unitless | aircraft static margin as a fraction of mean aerodynamic chord | False | 0.0 | <class 'float'> | False | GASP: INGASP.STATIC<br />FLOPS: None |
| aircraft:design:structural_mass_increment | lbm | structural mass increment that is added (or removed) after the structural mass is calculated | False | 0.0 | <class 'float'> | False | GASP: INGASP.DELWST<br />FLOPS: None |
| aircraft:design:structure_mass | lbm | Total structure group mass. Includes the following groups: wing, epennage, fuselage, landing gear, air induction. | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:design:subsonic_drag_coeff_factor | unitless | Scaling factor for subsonic drag | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: MISSIN.FCDSUB |
| aircraft:design:supersonic_drag_coeff_factor | unitless | Scaling factor for supersonic drag | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: MISSIN.FCDSUP |
| aircraft:design:systems_and_equipment_mass | lbm | Systems and equipment group mass. Includes flight controls, auxilary power, instruments, hydraulics, pneumatics, electrical, avionics, furnishings and equipment, environmental control, and anti-icing mass. | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:design:systems_and_equipment_mass_base | lbm | Total systems & equipment group mass without additional 1% of empty mass | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:design:thrust_to_weight_ratio | unitless | ratio of total sea-level-static thrust to aircraft takeoff gross weight | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:design:total_wetted_area | ft**2 | total aircraft wetted area | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:design:touchdown_mass_max | lbm | Maximum mass at touchdown used to size landing gear | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.WLDG |
| aircraft:design:type | unitless | aircraft type: BWB for blended wing body, transport otherwise | True | AircraftTypes.TRANSPORT | (AircraftTypes.TRANSPORT, AircraftTypes.BLENDED_WING_BODY) | False | GASP: INGASP.IHWB<br />FLOPS: ['OPTION.IFITE'] |
| aircraft:design:ulf_calculated_from_maneuver | unitless | if true, ULF (ultimate load factor) is forced to be calculated from the maneuver load factor, even if the gust load factor is larger. This was set to true with a negative CATD in GASP. | True | False | <class 'bool'> | False | GASP: CATD<br />FLOPS: None |
| aircraft:design:use_alt_mass | unitless | control whether the alternate mass equations are to be used or not | True | False | <class 'bool'> | False | GASP: None<br />FLOPS: WTIN.IALTWT |
| aircraft:design:useful_load_mass | lbm | Useful load of the aircraft is the difference between the max_gross_mass and the empty_mass.This includes operating_items, total_payload and total_fuel. | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:design:wetted_areas | ft**2 | table of component wetted areas | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:design:wing_loading | lbf/ft**2 | ratio of aircraft gross takeoff weight to projected wing area | False | 0 | <class 'float'> | False | GASP: ['INGASP.WGS', 'INGASP.WOS']<br />FLOPS: None |
| aircraft:design:zero_lift_drag_coeff_factor | unitless | Scaling factor for zero-lift drag coefficient | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: MISSIN.FCDO |
| aircraft:electrical:has_hybrid_system | unitless | if true there is an augmented electrical system | True | False | <class 'bool'> | False | GASP: None<br />FLOPS: None |
| aircraft:electrical:hybrid_cable_length | ft | length of cable for hybrid electric augmented system | False | 0.0 | <class 'float'> | False | GASP: INGASP.LCABLE<br />FLOPS: None |
| aircraft:electrical:mass | lbm | mass of the electrical system | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:electrical:mass_scaler | unitless | mass scaler for the electrical system | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.WELEC |
| aircraft:electrical:system_mass_per_passenger | lbm | electrical system weight per passenger. In GASP, default 16.0 | False | 0.0 | <class 'float'> | False | GASP: INGASP.CW(15)<br />FLOPS: None |
| aircraft:engine:additional_mass | lbm | additional engine mass not counted by existing categories (such as engine control and starter mass in FLOPS). In GASP, this is engine installation mass. | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| aircraft:engine:additional_mass_fraction | unitless | fraction of (scaled) engine mass used to calculate additional engine mass (see Aircraft.Engine.ADDITIONAL_MASS) | True | 0.0 | (<class 'float'>, <class 'int'>, <class 'numpy.ndarray'>) | True | GASP: INGASP.SKPEI<br />FLOPS: WTIN.WPMISC |
| aircraft:engine:constant_fuel_mass_consumption | lbm/h | Additional constant fuel flow. This value is not scaled with the engine | True | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: MISSIN.FLEAK |
| aircraft:engine:data_file | unitless | filepath to data file containing engine performance tables | True | None | <class 'str'> | True | GASP: None<br />FLOPS: ENGDIN.EIFILE |
| aircraft:engine:fixed_rpm | rpm | RPM the engine is set to be running at. Overrides RPM provided by engine model or chosen by optimizer. Typically used when pairing a motor or turboshaft using a fixed operating RPM with a propeller. | True | 1.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| aircraft:engine:flight_idle_max_fraction | unitless | If Aircraft.Engine.GENERATE_FLIGHT_IDLE is True, bounds engine performance outputs (other than thrust) at flight idle to be below a decimal fraction of the max value of that output produced by the engine at each flight condition. | True | 1.0 | <class 'float'> | True | GASP: None<br />FLOPS: ENGDIN.FIDMAX |
| aircraft:engine:flight_idle_min_fraction | unitless | If Aircraft.Engine.GENERATE_FLIGHT_IDLE is True, bounds engine performance outputs (other than thrust) at flight idle to be above a decimal fraction of the max value of that output produced by the engine at each flight condition. | True | 0.08 | <class 'float'> | True | GASP: None<br />FLOPS: ENGDIN.FIDMIN |
| aircraft:engine:flight_idle_thrust_fraction | unitless | If Aircraft.Engine.GENERATE_FLIGHT_IDLE is True, defines idle thrust condition as a decimal fraction of max thrust produced by the engine at each flight condition. | True | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| aircraft:engine:fuel_flow_scaler_constant_term | unitless | Constant term in fuel flow scaling equation | True | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: ENGDIN.DFFAC |
| aircraft:engine:fuel_flow_scaler_linear_term | unitless | Linear term in fuel flow scaling equation | True | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: ENGDIN.FFFAC |
| aircraft:engine:generate_flight_idle | unitless | If True, generate flight idle data by extrapolating from engine data. Flight idle is defined as engine performance when thrust is reduced to the level defined by Aircraft.Engine.FLIGHT_IDLE_THRUST_FRACTION. Other engine outputs are extrapolated to this thrust level, bounded by Aircraft.Engine.FLIGHT_IDLE_MIN_FRACT and Aircraft.Engine.FLIGHT_IDLE_MAX_FRACT | True | False | <class 'bool'> | True | GASP: None<br />FLOPS: ENGDIN.IDLE |
| aircraft:engine:geopotential_alt | unitless | If True, engine deck altitudes are geopotential and will be converted to geometric altitudes. If False, engine deck altitudes are geometric. | True | False | <class 'bool'> | True | GASP: None<br />FLOPS: ENGDIN.IGEO |
| aircraft:engine:global_hybrid_throttle | unitless | Flag for engine decks if the range of provided hybrid throttles is consistent across all flight conditions (e.g. the maximum hybrid throttle seen in the entire deck is 1.0, but a given flight condition only goes to 0.9 -> GLOBAL_HYBRID_THROTTLE = TRUE means the engine can be extrapolated out to 1.0 at that point. If GLOBAL_HYBRID_THROTTLE is False, then each flight condition's hybrid throttle range is individually normalized from 0 to 1 independent of other points on the deck). | True | False | <class 'bool'> | True | GASP: None<br />FLOPS: None |
| aircraft:engine:global_throttle | unitless | Flag for engine decks if the range of provided throttles is consistent across all flight conditions (e.g. the maximum throttle seen in the entire deck is 1.0, but a given flight condition only goes to 0.9 -> GLOBAL_THROTTLE = TRUE means the engine can be extrapolated out to 1.0 at that point. If GLOBAL_THROTTLE is False, then each flight condition's throttle range is individually normalized from 0 to 1 independent of other points on the deck). | True | False | <class 'bool'> | True | GASP: None<br />FLOPS: None |
| aircraft:engine:ignore_negative_thrust | unitless | If False, all input or generated points are used, otherwise points in the engine deck with negative net thrust are ignored. | True | False | <class 'bool'> | True | GASP: None<br />FLOPS: ENGDIN.NONEG |
| aircraft:engine:inlet_area_coefficient | unitless | engine inlet area coefficient. Suggested values: 0.000375 for modern engines. | False | 0.0002 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| aircraft:engine:interpolation_method | unitless | method used for interpolation on an engine deck's data file, allowable values are table methods from openmdao.components.interp_util.interp. Engine models only use the methods avilable to the MetaModelSemiStructuredComp component. These are listed here: https://openmdao.org/newdocs/versions/latest/features/building_blocks/components/metamodelsemistructured_comp.html | True | slinear | <class 'str'> | True | GASP: None<br />FLOPS: None |
| aircraft:engine:interpolation_sort | unitless | Specify the first interpolation variable in the semi-structured metamodel. Choose from mach or altitude. Mach is usually the first column in the deck, but altitude is more robust for semi-structured data. | True | mach | <class 'str'> | True | GASP: None<br />FLOPS: None |
| aircraft:engine:mass | lbm | Scaled mass of a single engine. Engine mass includes installation mass, accessory gear boxes & drive, exhaust system, engine cooling, water injection, engien controls starting system, propeller/fan installation, lubricating system, and the drive system. Drive system mass contains gearboxes including lubrication and rotor brakes, transmission drive, rotor shaft, and gas drive. Fuel system is bookept as a separate line item in the propulsion group. For nonconventional engines, such as all-electric, engine mass should also contain masses appropriate for per-engine mass bookeeping (such as motor mass). | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| aircraft:engine:mass_scaler | unitless | scaler for engine mass | False | 1.0 | <class 'float'> | True | GASP: INGASP.CK5<br />FLOPS: WTIN.EEXP |
| aircraft:engine:mass_specific | lbm/lbf | specific mass of one engine (engine weight/SLS thrust) | False | 0.0 | <class 'float'> | True | GASP: INGASP.SWSLS<br />FLOPS: None |
| aircraft:engine:num_engines | unitless | total number of engines per model on the aircraft (fuselage, wing, or otherwise) | True | 2 | <class 'int'> | True | GASP: INGASP.ENP<br />FLOPS: None |
| aircraft:engine:num_fuselage_engines | unitless | number of fuselage mounted engines per model | True | 0 | <class 'int'> | True | GASP: None<br />FLOPS: WTIN.NEF |
| aircraft:engine:num_wing_engines | unitless | number of wing mounted engines per model | True | 0 | <class 'int'> | True | GASP: None<br />FLOPS: WTIN.NEW |
| aircraft:engine:pod_mass | lbm | engine pod mass including nacelles | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| aircraft:engine:pod_mass_scaler | unitless | technology factor on mass of engine pods | False | 1.0 | <class 'float'> | True | GASP: INGASP.CK14<br />FLOPS: None |
| aircraft:engine:pylon_factor | unitless | factor for turbofan engine pylon mass | False | 0.7 | <class 'float'> | True | GASP: INGASP.FPYL<br />FLOPS: None |
| aircraft:engine:reference_mass | lbm | Unscaled mass of a single engine. See Aircraft.Engine.MASS for breakdown of what is included in engine mass. | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: WTIN.WENG |
| aircraft:engine:reference_sls_thrust | lbf | Maximum sea-level static thrust of an unscaled engine. Optional. In EngineDecks, reference thrust will be found from performance data if not provided by user. User-provided values override SLS point found in performance data. | False | 0.0 | <class 'float'> | True | GASP: INGASP.FN_REF<br />FLOPS: WTIN.THRSO |
| aircraft:engine:rpm_design | rpm | the designed output RPM from the engine for fixed-RPM shafts | True | 0.0 | <class 'float'> | True | GASP: INPROP.XNMAX<br />FLOPS: None |
| aircraft:engine:scale_factor | unitless | A scaling factor used to scale engine performance data during mission analysis. | False | 1.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| aircraft:engine:scale_mass | unitless | Toggle for enabling scaling of engine mass based on Aircraft.Engine.SCALE_FACTOR | True | True | <class 'bool'> | True | GASP: None<br />FLOPS: None |
| aircraft:engine:scaled_sls_thrust | lbf | Maximum sea-level static thrust of an engine after scaling. Optional for EngineDecks if Aircraft.Engine.SCALE_FACTOR is provided, in which case this variable is computed. | False | 0.0 | <class 'float'> | True | GASP: INGASP.THIN<br />FLOPS: CONFIN.THRUST |
| aircraft:engine:subsonic_fuel_flow_scaler | unitless | scaling factor on fuel flow when Mach number is subsonic | True | 1.0 | <class 'float'> | True | GASP: INGASP.CKFF<br />FLOPS: ENGDIN.FFFSUB |
| aircraft:engine:supersonic_fuel_flow_scaler | unitless | scaling factor on fuel flow when Mach number is supersonic | True | 1.0 | <class 'float'> | True | GASP: INGASP.CKFF<br />FLOPS: ENGDIN.FFFSUP |
| aircraft:engine:thrust_reversers_mass | lbm | mass of thrust reversers on engines | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| aircraft:engine:thrust_reversers_mass_scaler | unitless | scaler for mass of thrust reversers on engines. In FLOPS default to 0.0 | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: WTIN.WTHR |
| aircraft:engine:type | unitless | specifies engine type used for GASP-based engine mass calculation | True | GASPEngineType.TURBOJET | (GASPEngineType.RECIP_CARB, GASPEngineType.RECIP_FUEL_INJECT, GASPEngineType.RECIP_FUEL_INJECT_GEARED, GASPEngineType.ROTARY, GASPEngineType.TURBOSHAFT, GASPEngineType.TURBOPROP, GASPEngineType.TURBOJET, GASPEngineType.RECIP_CARB_HOPWSZ, GASPEngineType.RECIP_FUEL_INJECT_HOPWSZ, GASPEngineType.RECIP_FUEL_INJECT_GEARED_HOPWSZ, GASPEngineType.ROTARY_RCWSZ) | True | GASP: INGASP.NTYE<br />FLOPS: None |
| aircraft:engine:wing_locations | unitless | Engine wing mount locations as fractions of semispan; (NUM_WING_ENGINES)/2 values are input | False | [0.0] | (<class 'float'>, <class 'list'>, <class 'numpy.ndarray'>) | True | GASP: INGASP.YP<br />FLOPS: WTIN.ETAE |
| aircraft:engine:gearbox:efficiency | unitless | The efficiency of the gearbox. | False | 1.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| aircraft:engine:gearbox:gear_ratio | unitless | Reduction gear ratio, or the ratio of the RPM_in divided by the RPM_out for the gearbox. | False | 1.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| aircraft:engine:gearbox:mass | lbm | The mass of the gearbox. | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| aircraft:engine:gearbox:shaft_power_design | hp | A guess for the maximum power that will be transmitted through the gearbox during the mission (max shp input). | False | 1.0 | <class 'float'> | True | GASP: INPROP.HPMSLS<br />FLOPS: None |
| aircraft:engine:gearbox:specific_torque | lbf*ft/lbm | The specific torque of the gearbox, used to calculate gearbox mass. | False | 100.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| aircraft:engine:motor:data_file | unitless | filepath to data file containing electric motor performance table | True | None | <class 'str'> | True | GASP: None<br />FLOPS: None |
| aircraft:engine:motor:mass | lbm | Total motor mass (considers number of motors) | False | 0.0 | <class 'float'> | True | GASP: WMOTOR<br />FLOPS: None |
| aircraft:engine:motor:torque_max | lbf*ft | Max torque value that can be output from a single motor. Used to determine motor mass in pre-mission | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| aircraft:engine:propeller:activity_factor | unitless | propeller actitivty factor per Blade (Range: 80 to 200) | False | 0.0 | <class 'float'> | True | GASP: INPROP.AF<br />FLOPS: None |
| aircraft:engine:propeller:compute_installation_loss | unitless | if true, compute installation loss factor based on blockage factor | True | True | <class 'bool'> | True | GASP: INPROP.FT<br />FLOPS: None |
| aircraft:engine:propeller:data_file | unitless | filepath to data file containing propeller data map | True | None | <class 'str'> | True | GASP: None<br />FLOPS: None |
| aircraft:engine:propeller:diameter | ft | propeller diameter | False | 0.0 | <class 'float'> | True | GASP: INPROP.DPROP<br />FLOPS: None |
| aircraft:engine:propeller:integrated_lift_coefficient | unitless | propeller blade integrated design lift coefficient (Range: 0.3 to 0.8) | False | 0.5 | <class 'float'> | True | GASP: INPROP.CLI<br />FLOPS: None |
| aircraft:engine:propeller:mass | lbm | mass of propellers on engine (sum of all blades) | False | 0 | <class 'float'> | True | GASP: None<br />FLOPS: None<br />LEAPS1: None |
| aircraft:engine:propeller:num_blades | unitless | number of blades per propeller | True | 0 | <class 'int'> | True | GASP: INPROP.BL<br />FLOPS: None |
| aircraft:engine:propeller:tip_mach_max | unitless | maximum allowable Mach number at propeller tip (based on helical speed) | False | 1.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| aircraft:engine:propeller:tip_speed_max | ft/s | maximum allowable propeller linear tip speed | False | 800.0 | <class 'float'> | True | GASP: ['INPROP.TSPDMX', 'INPROP.TPSPDMXe']<br />FLOPS: None |
| aircraft:fins:area | ft**2 | vertical fin theoretical area | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.SFIN |
| aircraft:fins:mass | lbm | mass of vertical fins | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:fins:mass_scaler | unitless | mass scaler for fin structure | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.FRFIN |
| aircraft:fins:num_fins | unitless | number of fins | True | 0 | <class 'int'> | False | GASP: None<br />FLOPS: WTIN.NFIN |
| aircraft:fins:taper_ratio | unitless | vertical fin theoretical taper ratio | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.TRFIN |
| aircraft:fuel:auxiliary_fuel_mass_capacity | lbm | fuel capacity of the auxiliary tank | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.FULAUX |
| aircraft:fuel:burn_per_passenger_mile | lbm/NM | average fuel burn per passenger per mile flown | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:fuel:density | lbm/galUS | fuel density (jet fuel typical density of 6.7 lbm/galUS used in the calculation of wing_capacity(if wing_capacity is not input) and in the calculation of fuel system weight. | False | 6.7 | <class 'float'> | False | GASP: INGASP.FUELD<br />FLOPS: WTIN.FULDEN |
| aircraft:fuel:fuel_system_mass | lbm | Fuel system mass. Includes tanks (both protected and unprotected), plumbing, and similar masses. | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:fuel:fuel_system_mass_coefficient | unitless | mass trend coefficient of fuel system | False | 0.0 | <class 'float'> | False | GASP: INGASP.SKFS<br />FLOPS: None |
| aircraft:fuel:fuel_system_mass_scaler | unitless | scaler for fuel system mass | False | 1.0 | <class 'float'> | False | GASP: INGASP.CK21<br />FLOPS: WTIN.WFSYS |
| aircraft:fuel:fuselage_fuel_mass_capacity | lbm | fuel capacity of the fuselage | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.FULFMX |
| aircraft:fuel:ignore_fuel_capacity_constraint | unitless | Flag to control enforcement of fuel_capacity constraint. If False (default) Aviary will add the excess fuel constraint and only converge if there is enough fuel capacity to complete the mission.If set True Aviary will ignore this constraint, and allow mission fuel > total_fuel_capacity. Use carefully! | False | False | <class 'bool'> | False | GASP: None<br />FLOPS: WTIN.IFUFU |
| aircraft:fuel:num_tanks | unitless | number of fuel tanks | True | 7 | <class 'int'> | False | GASP: None<br />FLOPS: WTIN.NTANK |
| aircraft:fuel:total_capacity | lbm | Total fuel capacity of the aircraft including wing, fuselage and auxiliary tanks. Used in generating payload-range diagram (Default = wing_capacity + fuselage_capacity + aux_capacity) | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.FMXTOT |
| aircraft:fuel:total_volume | galUS | Total fuel volume | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:fuel:unusable_fuel_mass | lbm | unusable fuel mass | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:fuel:unusable_fuel_mass_coefficient | unitless | mass trend coefficient of trapped fuel factor | False | 0.0 | <class 'float'> | False | GASP: INGASP.CW(13)<br />FLOPS: None |
| aircraft:fuel:unusable_fuel_mass_scaler | unitless | scaler for Unusable fuel mass | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.WUF |
| aircraft:fuel:volume_margin | unitless | Extra volume required in the wing fuel tank as a percentage of design mission fuel mass.Only used in GASP wing tank mass and fuel system mass sizing calculations. | False | 0.0 | <class 'float'> | False | GASP: INGASP.FVOL_MRG<br />FLOPS: None |
| aircraft:fuel:wing_fuel_fraction | unitless | fraction of total theoretical wing volume used for wing fuel | False | 0.0 | <class 'float'> | False | GASP: INGASP.SKWF<br />FLOPS: None |
| aircraft:fuel:wing_fuel_mass_capacity | lbm | fuel capacity of the auxiliary tank | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.FULWMX |
| aircraft:fuel:wing_ref_capacity | lbm | reference fuel volume | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.FUELRF |
| aircraft:fuel:wing_ref_capacity_area | unitless | reference wing area for fuel capacity | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.FSWREF |
| aircraft:fuel:wing_ref_capacity_term_a | unitless | scaling factor A | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.FUSCLA |
| aircraft:fuel:wing_ref_capacity_term_b | unitless | scaling factor B | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.FUSCLB |
| aircraft:fuel:wing_volume_design | ft**3 | wing tank fuel volume when carrying design fuel plus fuel margin | False | 0.0 | <class 'float'> | False | GASP: INGASP.FVOLREQ<br />FLOPS: None |
| aircraft:fuel:wing_volume_geometric_max | ft**3 | wing tank fuel volume based on geometry | False | 0.0 | <class 'float'> | False | GASP: INGASP.FVOLW_GEOM<br />FLOPS: None |
| aircraft:fuel:wing_volume_structural_max | ft**3 | wing tank volume based on maximum wing fuel weight | False | 0.0 | <class 'float'> | False | GASP: INGASP.FVOLW_MAX<br />FLOPS: None |
| aircraft:furnishings:mass | lbm | Total furnishings mass | False | 0.0 | <class 'float'> | False | GASP: INGASP.CW(8)<br />FLOPS: None |
| aircraft:furnishings:mass_base | lbm | For FLOPS based, base furnishings system mass without additional 1% empty mass | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:furnishings:mass_scaler | unitless | Furnishings system mass scaler. In GASP based, it is applicale if gross mass > 10000 lbs and number of passengers >= 50. Set it to 0.0 if not use. | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.WFURN |
| aircraft:furnishings:use_empirical_equation | unitless | In GASP based, indicate whether use commonly used empirical furnishing weight equation. This applies only when gross mass > 10000 and number of passengers >= 50. | True | True | <class 'bool'> | False | GASP: None<br />FLOPS: None |
| aircraft:fuselage:aftbody_mass | lbm | aftbody mass | False | 0.0 | <class 'float'> | False | GASP: WGT_AB<br />FLOPS: None |
| aircraft:fuselage:aftbody_mass_per_unit_area | lbm/ft**2 | aftbody structural areal unit weight | False | 0.0 | <class 'float'> | False | GASP: INGASP.UWT_AFT<br />FLOPS: None |
| aircraft:fuselage:aisle_width | inch | width of the aisles in the passenger cabin | True | 24.0 | <class 'float'> | False | GASP: INGASP.WAS<br />FLOPS: None |
| aircraft:fuselage:avg_diameter | ft | average fuselage diameter | False | 0.0 | <class 'float'> | False | GASP: ['INGASP.WC', 'INGASP.SWF']<br />FLOPS: None |
| aircraft:fuselage:cabin_area | ft**2 | fixed area of passenger cabin for blended wing body transports | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: FUSEIN.ACABIN |
| aircraft:fuselage:characteristic_length | ft | Reynolds characteristic length for the fuselage | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:fuselage:cross_section | ft**2 | fuselage cross sectional area | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:fuselage:delta_diameter | ft | mean fuselage cabin diameter minus mean fuselage nose diameter | False | 0.0 | <class 'float'> | False | GASP: INGASP.HCK<br />FLOPS: None |
| aircraft:fuselage:diameter_to_wing_span | unitless | fuselage diameter to wing span ratio | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:fuselage:drag_factor | unitless | fuselage aero calibration factor (including technology factor INGASP.FCFFT) | False | 1.0 | <class 'float'> | False | GASP: INGASP.FCFFC<br />FLOPS: None |
| aircraft:fuselage:fineness | unitless | fuselage fineness ratio | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:fuselage:flat_plate_area_increment | ft**2 | increment to fuselage flat plate area | False | 0.0 | <class 'float'> | False | GASP: INGASP.DELFE<br />FLOPS: None |
| aircraft:fuselage:forebody_mass | lbm | forebody mass | False | 0.0 | <class 'float'> | False | GASP: WGT_FB<br />FLOPS: None |
| aircraft:fuselage:form_factor | unitless | fuselage form factor | False | 0.0 | <class 'float'> | False | GASP: INGASP.CKF<br />FLOPS: None |
| aircraft:fuselage:height_to_width_ratio | unitless | fuselage height-to-width ratio | False | 1.0 | <class 'float'> | False | GASP: INGASP.HGTqWID<br />FLOPS: WTIN.TCF |
| aircraft:fuselage:hydraulic_diameter | ft | the geometric mean of cabin height and cabin width | False | 0.0 | <class 'float'> | False | GASP: DHYDRAL<br />FLOPS: None |
| aircraft:fuselage:laminar_flow_lower | unitless | define percent laminar flow for fuselage lower surface | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: AERIN.TRLB |
| aircraft:fuselage:laminar_flow_upper | unitless | define percent laminar flow for fuselage upper surface | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: AERIN.TRUB |
| aircraft:fuselage:length | ft | Define the Fuselage total length. If total_length is not input for a passenger transport, FLOPS will calculate the fuselage length, width and depth and the length of the passenger compartment. | False | 0.0 | <class 'float'> | False | GASP: INGASP.ELF<br />FLOPS: WTIN.XL |
| aircraft:fuselage:length_to_diameter | unitless | fuselage length to diameter ratio | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:fuselage:lift_coefficient_ratio_body_to_wing | unitless | lift coefficient of body over lift coefficient of wing ratio | False | 0.0 | <class 'float'> | False | GASP: INGASP.CLBqCLW<br />FLOPS: None |
| aircraft:fuselage:lift_curve_slope_mach0 | 1/rad | lift curve slope of fuselage at Mach 0 | False | 0.0 | <class 'float'> | False | GASP: INGASP.CLALPH_B0<br />FLOPS: None |
| aircraft:fuselage:mass | lbm | Fuselage group mass. Contains basic structure and secondary structures such as enclosures, flooring, doors, ramps, panels, etc. | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:fuselage:mass_coefficient | unitless | mass trend coefficient of fuselage | False | 136.0 | <class 'float'> | False | GASP: INGASP.SKB<br />FLOPS: None |
| aircraft:fuselage:mass_scaler | unitless | mass scaler of the fuselage structure | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.FRFU |
| aircraft:fuselage:max_height | ft | maximum fuselage height | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.DF |
| aircraft:fuselage:max_width | ft | maximum fuselage width | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.WF |
| aircraft:fuselage:military_cargo_floor | unitless | indicate whether or not there is a military cargo aircraft floor | True | False | <class 'bool'> | False | GASP: None<br />FLOPS: WTIN.CARGF |
| aircraft:fuselage:nose_fineness | unitless | length to diameter ratio of nose cone | False | 1.0 | <class 'float'> | False | GASP: INGASP.ELODN<br />FLOPS: None |
| aircraft:fuselage:num_aisles | unitless | number of aisles in the passenger cabin | True | 1 | <class 'int'> | False | GASP: INGASP.AS<br />FLOPS: None |
| aircraft:fuselage:num_fuselages | unitless | number of fuselages | True | 1 | <class 'int'> | False | GASP: None<br />FLOPS: WTIN.NFUSE |
| aircraft:fuselage:passenger_compartment_length | ft | length of passenger compartment | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.XLP |
| aircraft:fuselage:pilot_compartment_length | ft | length of the pilot compartment | False | 0.0 | <class 'float'> | False | GASP: INGASP.ELPC<br />FLOPS: None |
| aircraft:fuselage:planform_area | ft**2 | fuselage planform area | False | 0.0 | <class 'float'> | False | GASP: SPF_BODY<br />FLOPS: None |
| aircraft:fuselage:pressure_differential | psi | fuselage pressure differential during cruise | False | 0.0 | <class 'float'> | False | GASP: INGASP.DELP<br />FLOPS: None |
| aircraft:fuselage:pressurized_width_additional | ft | additional pressurized fuselage width for cargo bay | False | 0.0 | <class 'float'> | False | GASP: INGASP.WPRFUS<br />FLOPS: None |
| aircraft:fuselage:ref_diameter | ft | A coarse average diameter calculated using the mean of max width and depth. | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: ['EDETIN.XD'] |
| aircraft:fuselage:seat_width | inch | width of the economy class seats | True | 0.0 | <class 'float'> | False | GASP: INGASP.WS<br />FLOPS: None |
| aircraft:fuselage:sidebody_thickness_to_chord | unitless | fuselage thickness/chord ratio at side of body | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.TCSOB<br />LEAPS1: None |
| aircraft:fuselage:simple_layout | unitless | carry out simple or detailed layout of fuselage (for FLOPS based geometry). | True | True | <class 'bool'> | False | GASP: None<br />FLOPS: None |
| aircraft:fuselage:tail_fineness | unitless | length to diameter ratio of tail cone | False | 1.0 | <class 'float'> | False | GASP: INGASP.ELODT<br />FLOPS: None |
| aircraft:fuselage:wetted_area | ft**2 | fuselage wetted area | False | 0.0 | <class 'float'> | False | GASP: INGASP.SF<br />FLOPS: None |
| aircraft:fuselage:wetted_area_ratio_aftbody_to_total | unitless | aftbody wetted area to total body wetted area | False | 0.0 | <class 'float'> | False | GASP: INGASP.SAFTqS<br />FLOPS: None |
| aircraft:fuselage:wetted_area_scaler | unitless | fuselage wetted area scaler | False | 1.0 | <class 'float'> | False | GASP: INGASP.SF_FAC<br />FLOPS: AERIN.SWETF |
| aircraft:horizontal_tail:area | ft**2 | horizontal tail theoretical area; overridden by vol_coeff, if vol_coeff > 0.0 | False | 0.0 | <class 'float'> | False | GASP: INGASP.SHT<br />FLOPS: WTIN.SHT |
| aircraft:horizontal_tail:aspect_ratio | unitless | horizontal tail theoretical aspect ratio | False | 0.0 | <class 'float'> | False | GASP: INGASP.ARHT<br />FLOPS: WTIN.ARHT |
| aircraft:horizontal_tail:average_chord | ft | mean aerodynamic chord of horizontal tail | False | 0.0 | <class 'float'> | False | GASP: INGASP.CBARHT<br />FLOPS: None |
| aircraft:horizontal_tail:characteristic_length | ft | Reynolds characteristic length for the horizontal tail | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:horizontal_tail:drag_factor | unitless | horizontal tail aero calibration factor (including technology factor INGASP.FCFHTT) | False | 1.0 | <class 'float'> | False | GASP: INGASP.FCFHTC<br />FLOPS: None |
| aircraft:horizontal_tail:fineness | unitless | horizontal tail fineness ratio | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:horizontal_tail:form_factor | unitless | horizontal tail form factor | False | 0.0 | <class 'float'> | False | GASP: INGASP.CKHT<br />FLOPS: None |
| aircraft:horizontal_tail:laminar_flow_lower | unitless | define percent laminar flow for horizontal tail lower surface | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: AERIN.TRLH |
| aircraft:horizontal_tail:laminar_flow_upper | unitless | define percent laminar flow for horizontal tail upper surface | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: AERIN.TRUH |
| aircraft:horizontal_tail:mass | lbm | mass of horizontal tail | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:horizontal_tail:mass_coefficient | unitless | mass trend coefficient of horizontal tail | False | 0.0 | <class 'float'> | False | GASP: INGASP.SKY<br />FLOPS: None |
| aircraft:horizontal_tail:mass_scaler | unitless | mass scaler of the horizontal tail structure | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.FRHT |
| aircraft:horizontal_tail:moment_arm | ft | moment arm of horizontal tail | False | 0.0 | <class 'float'> | False | GASP: INGASP.ELTH<br />FLOPS: None |
| aircraft:horizontal_tail:moment_ratio | unitless | Ratio of wing chord to horizontal tail moment arm | False | 0.0 | <class 'float'> | False | GASP: INGASP.COELTH<br />FLOPS: None |
| aircraft:horizontal_tail:num_tails | unitless | number of horizontal tails | True | 1 | <class 'int'> | False | GASP: None<br />FLOPS: None |
| aircraft:horizontal_tail:root_chord | ft | horizontal tail root chord | False | 0.0 | <class 'float'> | False | GASP: INGASP.CRCLHT<br />FLOPS: None |
| aircraft:horizontal_tail:span | ft | span of horizontal tail | False | 0.0 | <class 'float'> | False | GASP: INGASP.BHT<br />FLOPS: None |
| aircraft:horizontal_tail:sweep | deg | quarter-chord sweep of horizontal tail | False | 0.0 | <class 'float'> | False | GASP: INGASP.DWPQCH<br />FLOPS: WTIN.SWPHT |
| aircraft:horizontal_tail:taper_ratio | unitless | horizontal tail theoretical taper ratio | False | 0.0 | <class 'float'> | False | GASP: INGASP.SLMH<br />FLOPS: WTIN.TRHT |
| aircraft:horizontal_tail:thickness_to_chord | unitless | horizontal tail thickness-chord ratio | False | 0.0 | <class 'float'> | False | GASP: INGASP.TCHT<br />FLOPS: WTIN.TCHT |
| aircraft:horizontal_tail:vertical_tail_mount_location | unitless | Define the decimal fraction of vertical tail span where horizontal tail is mounted. Defaults: 0.0 == for body mounted (default for transport with all engines on wing); 1.0 == for T tail (default for transport with multiple engines on fuselage) | False | 0.0 | <class 'float'> | False | GASP: INGASP.SAH<br />FLOPS: WTIN.HHT |
| aircraft:horizontal_tail:volume_coefficient | unitless | tail volume coefficicient of horizontal tail | False | 0.0 | <class 'float'> | False | GASP: INGASP.VBARHX<br />FLOPS: None |
| aircraft:horizontal_tail:wetted_area | ft**2 | horizontal tail wetted area | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:horizontal_tail:wetted_area_scaler | unitless | horizontal tail wetted area scaler | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: AERIN.SWETH |
| aircraft:hydraulics:flight_control_mass_coefficient | unitless | mass trend coefficient of hydraulics for flight control system | False | 0.0 | <class 'float'> | False | GASP: INGASP.CW(3)<br />FLOPS: None |
| aircraft:hydraulics:gear_mass_coefficient | unitless | mass trend coefficient of hydraulics for landing gear | False | 0.0 | <class 'float'> | False | GASP: INGASP.CW(4)<br />FLOPS: None |
| aircraft:hydraulics:mass | lbm | mass of hydraulic system | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:hydraulics:mass_scaler | unitless | mass scaler of the hydraulic system | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.WHYD |
| aircraft:hydraulics:system_pressure | psi | hydraulic system pressure | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.HYDPR |
| aircraft:instruments:mass | lbm | instrument group mass | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:instruments:mass_coefficient | unitless | mass trend coefficient of instruments | False | 0.0 | <class 'float'> | False | GASP: INGASP.CW(2)<br />FLOPS: None |
| aircraft:instruments:mass_scaler | unitless | mass scaler of the instrument group | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.WIN |
| aircraft:landing_gear:drag_coefficient | unitless | landing gear drag coefficient | True | 0.0 | <class 'float'> | False | FLOPS: TOLIN.CDGEAR<br />GASP: None |
| aircraft:landing_gear:fixed_gear | unitless | Type of landing gear. In GASP, 0 is retractable and 1 is fixed. Here, false is retractable and true is fixed. | True | True | <class 'bool'> | False | GASP: INGASP.IGEAR<br />FLOPS: None |
| aircraft:landing_gear:main_gear_location | unitless | span fraction of main gear on wing (0=on fuselage, 1=at tip) | False | 0.0 | <class 'float'> | False | GASP: INGASP.YMG<br />FLOPS: None |
| aircraft:landing_gear:main_gear_mass | lbm | mass of main landing gear (WMG in GASP) | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:landing_gear:main_gear_mass_fraction | unitless | fraction of total landing gear mass that is main gear mass | False | 0.0 | <class 'float'> | False | GASP: INGASP.SKMG<br />FLOPS: None |
| aircraft:landing_gear:main_gear_mass_scaler | unitless | mass scaler of the main landing gear structure | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.FRLGM |
| aircraft:landing_gear:main_gear_oleo_length | inch | length of extended main landing gear oleo | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.XMLG |
| aircraft:landing_gear:mass_coefficient | unitless | mass trend coefficient of landing gear | False | 0.0 | <class 'float'> | False | GASP: INGASP.SKLG<br />FLOPS: None |
| aircraft:landing_gear:nose_gear_mass | lbm | mass of nose landing gear | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:landing_gear:nose_gear_mass_scaler | unitless | mass scaler of the nose landing gear structure | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.FRLGN |
| aircraft:landing_gear:nose_gear_oleo_length | inch | length of extended nose landing gear oleo | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.XNLG |
| aircraft:landing_gear:tail_hook_mass_scaler | unitless | factor on tail mass for arresting hook | False | 1.0 | <class 'float'> | False | GASP: INGASP.SKTL<br />FLOPS: None |
| aircraft:landing_gear:total_mass | lbm | total mass of landing gear | False | 0.0 | <class 'float'> | False | GASP: INGASP.WLG<br />FLOPS: None |
| aircraft:landing_gear:total_mass_scaler | unitless | technology factor on landing gear mass | False | 1.0 | <class 'float'> | False | GASP: INGASP.CK12<br />FLOPS: None |
| aircraft:nacelle:avg_diameter | ft | Average diameter of engine nacelles for each engine model | False | 0.0 | <class 'float'> | True | GASP: INGASP.DBARN<br />FLOPS: WTIN.DNAC |
| aircraft:nacelle:avg_length | ft | Average length of nacelles for each engine model | False | 0.0 | <class 'float'> | True | GASP: INGASP.ELN<br />FLOPS: WTIN.XNAC |
| aircraft:nacelle:characteristic_length | ft | Reynolds characteristic length for nacelle for each engine model | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| aircraft:nacelle:clearance_ratio | unitless | the minimum number of nacelle diameters above the ground that the bottom of the nacelle must be | False | 0.0 | <class 'float'> | True | GASP: INGASP.CLEARqDN<br />FLOPS: None |
| aircraft:nacelle:core_diameter_ratio | unitless | ratio of nacelle diameter to engine core diameter | False | 1.25 | <class 'float'> | True | GASP: INGASP.DNQDE<br />FLOPS: None |
| aircraft:nacelle:drag_factor | unitless | nacelle aero calibration factor (including technology factor INGASP.FCFNT) | False | 1.0 | <class 'float'> | False | GASP: INGASP.FCFNC<br />FLOPS: None |
| aircraft:nacelle:fineness | unitless | nacelle fineness ratio | False | 0.0 | <class 'float'> | True | GASP: INGASP.XLQDE<br />FLOPS: None |
| aircraft:nacelle:form_factor | unitless | nacelle form factor | False | 0.0 | <class 'float'> | True | GASP: INGASP.CKN<br />FLOPS: None |
| aircraft:nacelle:laminar_flow_lower | unitless | define percent laminar flow for nacelle lower surface for each engine model | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: AERIN.TRLN |
| aircraft:nacelle:laminar_flow_upper | unitless | define percent laminar flow for nacelle upper surface for each engine model | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: AERIN.TRUN |
| aircraft:nacelle:mass | lbm | estimated mass of a single nacelle for each engine model | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| aircraft:nacelle:mass_scaler | unitless | mass scaler of the nacelle structure for each engine model | False | 1.0 | <class 'float'> | True | GASP: None<br />FLOPS: WTIN.FRNA |
| aircraft:nacelle:mass_specific | lbm/ft**2 | nacelle mass/nacelle surface area; lbm per sq ft. | False | 0.0 | <class 'float'> | True | GASP: INGASP.UWNAC<br />FLOPS: None |
| aircraft:nacelle:percent_diam_buried_in_fuselage | unitless | percentage of nacelle diameter buried in fuselage over nacelle diameter | False | 0.0 | <class 'float'> | True | GASP: INGASP.HEBQDN<br />FLOPS: None |
| aircraft:nacelle:pylon_drag_factor | unitless | pylon aero calibration factor | False | 1.0 | <class 'float'> | False | GASP: INGASP.FPYLND<br />FLOPS: None |
| aircraft:nacelle:surface_area | ft**2 | surface area of the outside of one entire nacelle, not just the wetted area | False | 0.0 | <class 'float'> | True | GASP: INGASP.SN<br />FLOPS: None |
| aircraft:nacelle:total_wetted_area | ft**2 | total nacelles wetted area | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| aircraft:nacelle:wetted_area | ft**2 | wetted area of a single nacelle for each engine model | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| aircraft:nacelle:wetted_area_scaler | unitless | nacelle wetted area scaler for each engine model | False | 1.0 | <class 'float'> | True | GASP: None<br />FLOPS: AERIN.SWETN |
| aircraft:oxygen_system:mass | lbm | Mass of passenger oxygen system | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:oxygen_system:mass_scaler | unitless | Mass Scaler for the Passenger Oxygen System | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:paint:mass | lbm | mass of paint for all wetted area | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:paint:mass_per_unit_area | lbm/ft**2 | mass of paint per unit area for all wetted area | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.WPAINT |
| aircraft:propulsion:energy_system_mass | lbm | Energy system mass. Contains mass for energy storage and transmission, including the fuel system, battery, and electric powertrain. | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:propulsion:engine_oil_mass_scaler | unitless | Scaler for engine oil mass | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.WOIL |
| aircraft:propulsion:engine_position_factor | unitless | engine position factor | False | 0.0 | <class 'float'> | False | GASP: INGASP.SKEPOS<br />FLOPS: None |
| aircraft:propulsion:mass | lbm | Propulsion group mass. Total mass of all engines on the aircraft, as well as energy system mass. | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:propulsion:misc_mass_scaler | unitless | scaler applied to miscellaneous engine mass (in FLOPS, sum of engine control, starter, and additional mass. In GASP, applied to ADDITIONAL_MASS, which is engine installation mass) | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.WPMSC |
| aircraft:propulsion:total_engine_controls_mass | lbm | total estimated mass of the engine controls for all engines on aircraft | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:propulsion:total_engine_mass | lbm | total mass of all engines on aircraft | False | 0.0 | <class 'float'> | False | GASP: INGASP.WEP<br />FLOPS: None |
| aircraft:propulsion:total_engine_oil_mass | lbm | engine oil mass | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:propulsion:total_engine_pod_mass | lbm | total engine pod mass for all engines on aircraft | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:propulsion:total_misc_mass | lbm | sum of engine control, starter, and additional mass for all engines on aircraft | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:propulsion:total_num_engines | unitless | total number of engines for the aircraft (fuselage, wing, or otherwise) | True | 0 | <class 'int'> | False | GASP: None<br />FLOPS: None |
| aircraft:propulsion:total_num_fuselage_engines | unitless | total number of fuselage-mounted engines for the aircraft | True | 0 | <class 'int'> | False | GASP: None<br />FLOPS: None |
| aircraft:propulsion:total_num_wing_engines | unitless | total number of wing-mounted engines for the aircraft | True | 0 | <class 'int'> | False | GASP: None<br />FLOPS: None |
| aircraft:propulsion:total_reference_sls_thrust | lbf | total maximum thrust of all unscalsed engines on aircraft, sea-level static | True | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:propulsion:total_scaled_sls_thrust | lbf | total maximum thrust of all scaled engines on aircraft, sea-level static | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:propulsion:total_starter_mass | lbm | total mass of starters for all engines on aircraft | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:propulsion:total_thrust_reversers_mass | lbm | total mass of thrust reversers for all engines on aircraft | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:strut:area | ft**2 | strut area | False | 0.0 | <class 'float'> | False | GASP: INGASP.STRTWS<br />FLOPS: None |
| aircraft:strut:area_ratio | unitless | ratio of strut area to wing area | False | 0.0 | <class 'float'> | False | GASP: INGASP.SSTQSW<br />FLOPS: None |
| aircraft:strut:attachment_location | ft | attachment location of strut the full attachment-to-attachment span | False | 0.0 | <class 'float'> | False | GASP: ['INGASP.STRUT', 'INGASP.STRUTX', 'INGASP.XSTRUT']<br />FLOPS: None |
| aircraft:strut:attachment_location_dimensionless | unitless | attachment location of strut as fraction of the half-span | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:strut:chord | ft | chord of the strut | False | 0.0 | <class 'float'> | False | GASP: INGASP.STRTCHD<br />FLOPS: None |
| aircraft:strut:dimensional_location_specified | unitless | if true the location of the strut is given dimensionally, otherwise it is given non-dimensionally. In GASP this depended on STRUT | True | True | <class 'bool'> | False | GASP: None<br />FLOPS: None |
| aircraft:strut:drag_factor | unitless | strut aero calibration factor (including technology factor INGASP.FCFSTRT) | False | 1.0 | <class 'float'> | False | GASP: INGASP.FCFSTRC<br />FLOPS: None |
| aircraft:strut:fuselage_interference_factor | unitless | strut/fuselage interference factor | False | 0.0 | <class 'float'> | False | GASP: INGASP.CKSTRT<br />FLOPS: None |
| aircraft:strut:length | ft | length of the strut | False | 0.0 | <class 'float'> | False | GASP: INGASP.STRTLNG<br />FLOPS: None |
| aircraft:strut:mass | lbm | mass of the strut | False | 0.0 | <class 'float'> | False | GASP: INGASP.WSTRUT<br />FLOPS: None |
| aircraft:strut:mass_coefficient | unitless | mass trend coefficient of the strut | False | 0.0 | <class 'float'> | False | GASP: INGASP.SKSTRUT<br />FLOPS: None |
| aircraft:strut:thickness_to_chord | unitless | thickness to chord ratio of the strut | False | 0.0 | <class 'float'> | False | GASP: INGASP.TCSTRT<br />FLOPS: None |
| aircraft:tail_boom:length | ft | cabin length for the tail boom fuselage | False | 0.0 | <class 'float'> | False | GASP: INGASP.ELFFC<br />FLOPS: None |
| aircraft:vertical_tail:area | ft**2 | vertical tail theoretical area (per tail); overridden by vol_coeff if vol_coeff > 0.0 | False | 0.0 | <class 'float'> | False | GASP: INGASP.SVT<br />FLOPS: WTIN.SVT |
| aircraft:vertical_tail:aspect_ratio | unitless | vertical tail theoretical aspect ratio | False | 0.0 | <class 'float'> | False | GASP: INGASP.ARVT<br />FLOPS: WTIN.ARVT |
| aircraft:vertical_tail:average_chord | ft | mean aerodynamic chord of vertical tail | False | 0.0 | <class 'float'> | False | GASP: INGASP.CBARVT<br />FLOPS: None |
| aircraft:vertical_tail:characteristic_length | ft | Reynolds characteristic length for the vertical tail | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:vertical_tail:drag_factor | unitless | vertical tail aero calibration factor (including technology factor INGASP.FCFVTT) | False | 1.0 | <class 'float'> | False | GASP: INGASP.FCFVTC<br />FLOPS: None |
| aircraft:vertical_tail:fineness | unitless | vertical tail fineness ratio | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:vertical_tail:form_factor | unitless | vertical tail form factor | False | 0.0 | <class 'float'> | False | GASP: INGASP.CKVT<br />FLOPS: None |
| aircraft:vertical_tail:laminar_flow_lower | unitless | define percent laminar flow for vertical tail lower surface | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: AERIN.TRLV |
| aircraft:vertical_tail:laminar_flow_upper | unitless | define percent laminar flow for vertical tail upper surface | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: AERIN.TRUV |
| aircraft:vertical_tail:mass | lbm | mass of vertical tail | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:vertical_tail:mass_coefficient | unitless | mass trend coefficient of the vertical tail | False | 0.0 | <class 'float'> | False | GASP: INGASP.SKZ<br />FLOPS: None |
| aircraft:vertical_tail:mass_scaler | unitless | mass scaler of the vertical tail structure | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.FRVT |
| aircraft:vertical_tail:moment_arm | ft | moment arm of vertical tail | False | 0.0 | <class 'float'> | False | GASP: INGASP.ELTV<br />FLOPS: None |
| aircraft:vertical_tail:moment_ratio | unitless | ratio of wing span to vertical tail moment arm | False | 0.0 | <class 'float'> | False | GASP: INGASP.BOELTV<br />FLOPS: None |
| aircraft:vertical_tail:num_tails | unitless | number of vertical tails | True | 1 | <class 'int'> | False | GASP: None<br />FLOPS: WTIN.NVERT |
| aircraft:vertical_tail:root_chord | ft | root chord of vertical tail | False | 0.0 | <class 'float'> | False | GASP: INGASP.CRCLVT<br />FLOPS: None |
| aircraft:vertical_tail:span | ft | span of vertical tail | False | 0.0 | <class 'float'> | False | GASP: INGASP.BVT<br />FLOPS: None |
| aircraft:vertical_tail:sweep | deg | quarter-chord sweep of vertical tail | False | 0.0 | <class 'float'> | False | GASP: INGASP.DWPQCV<br />FLOPS: WTIN.SWPVT |
| aircraft:vertical_tail:taper_ratio | unitless | vertical tail theoretical taper ratio | False | 0.0 | <class 'float'> | False | GASP: INGASP.SLMV<br />FLOPS: WTIN.TRVT |
| aircraft:vertical_tail:thickness_to_chord | unitless | vertical tail thickness-chord ratio | False | 0.0 | <class 'float'> | False | GASP: INGASP.TCVT<br />FLOPS: WTIN.TCVT |
| aircraft:vertical_tail:volume_coefficient | unitless | tail volume coefficient of the vertical tail | False | 0.0 | <class 'float'> | False | GASP: INGASP.VBARVX<br />FLOPS: None |
| aircraft:vertical_tail:wetted_area | ft**2 | vertical tails wetted area | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:vertical_tail:wetted_area_scaler | unitless | vertical tail wetted area scaler | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: AERIN.SWETV |
| aircraft:wing:aeroelastic_tailoring_factor | unitless | Define the decimal fraction of amount of aeroelastic tailoring used in design of wing where: 0.0 == no aeroelastic tailoring; 1.0 == maximum aeroelastic tailoring. | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.FAERT |
| aircraft:wing:airfoil_technology | unitless | Airfoil technology parameter. Limiting values are: 1.0 represents conventional technology wing (Default); 2.0 represents advanced technology wing. | True | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: AERIN.AITEK |
| aircraft:wing:area | ft**2 | reference wing area | False | 0.0 | <class 'float'> | False | GASP: INGASP.SW<br />FLOPS: CONFIN.SW |
| aircraft:wing:aspect_ratio | unitless | ratio of the wing span to its mean chord | False | 0.0 | <class 'float'> | False | GASP: INGASP.AR<br />FLOPS: CONFIN.AR |
| aircraft:wing:aspect_ratio_reference | unitless | Reference aspect ratio, used for detailed wing mass estimation. | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.ARREF |
| aircraft:wing:average_chord | ft | mean aerodynamic chord of the wing | False | 0.0 | <class 'float'> | False | GASP: INGASP.CBARW<br />FLOPS: None |
| aircraft:wing:bending_material_factor | unitless | Wing bending material factor with sweep adjustment. Used to compute Aircraft.Wing.BENDING_MATERIAL_MASS | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:wing:bending_material_mass | lbm | wing mass breakdown term 1 | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:wing:bending_material_mass_scaler | unitless | mass scaler of the bending wing mass term | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.FRWI1 |
| aircraft:wing:bwb_aftbody_mass | lbm | wing mass breakdown term 4 | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:wing:bwb_aftbody_mass_scaler | unitless | mass scaler of the blended-wing-body aft-body wing mass term | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.FRWI4 |
| aircraft:wing:center_chord | ft | wing chord at fuselage centerline, usually called root chord | False | 0.0 | <class 'float'> | False | GASP: INGASP.CRCLW<br />FLOPS: None |
| aircraft:wing:center_distance | unitless | distance (percent fuselage length) from nose to the wing aerodynamic center | False | 0.0 | <class 'float'> | False | GASP: INGASP.XWQLF<br />FLOPS: None |
| aircraft:wing:characteristic_length | ft | Reynolds characteristic length for the wing | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:wing:choose_fold_location | unitless | if true, fold location is based on your chosen value, otherwise it is based on strut location. In GASP this depended on STRUT or YWFOLD | True | True | <class 'bool'> | False | GASP: None<br />FLOPS: None |
| aircraft:wing:chord_per_semispan_distribution | unitless | chord lengths as fractions of semispan at station locations; overwrites station_chord_lengths | False | [0.0] | <class 'float'> | True | GASP: None<br />FLOPS: WTIN.CHD |
| aircraft:wing:composite_fraction | unitless | Define the decimal fraction of amount of composites used in wing structure where: 0.0 == no composites; 1.0 == maximum use of composites, approximately equivalent bending_mat_weight=.6, struct_weights=.83, misc_weight=.7 (not necessarily all composite). | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.FCOMP |
| aircraft:wing:control_surface_area | ft**2 | area of wing control surfaces | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:wing:control_surface_area_ratio | unitless | Defines the ratio of total moveable wing control surface areas (flaps, elevators, spoilers, etc.) to reference wing area. | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.FLAPR |
| aircraft:wing:detailed_wing | unitless | Flag that sets if FLOPS mass should use the detailed wing model | True | False | <class 'bool'> | False | GASP: None<br />FLOPS: None |
| aircraft:wing:dihedral | deg | wing dihedral (positive) or anhedral (negative) angle | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.DIH |
| aircraft:wing:drag_factor | unitless | wing aero calibration factor (including technology factor INGASP.FCFWT) | False | 1.0 | <class 'float'> | False | GASP: INGASP.FCFWC<br />FLOPS: None |
| aircraft:wing:eng_pod_inertia_factor | unitless | Engine inertia relief factor for wingspan inboard of engine locations. Used to compute Aircraft.Wing.BENDING_MATERIAL_MASS | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:wing:exposed_area | ft**2 | exposed wing area, i.e. wing area outside the fuselage, True for both Tube&Wing and HWB | False | 0.0 | <class 'float'> | False | GASP: SW_EXP<br />FLOPS: None |
| aircraft:wing:fineness | unitless | wing fineness ratio | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:wing:flap_chord_ratio | unitless | ratio of flap chord to wing chord | False | 0.0 | <class 'float'> | False | GASP: INGASP.CFOC<br />FLOPS: None |
| aircraft:wing:flap_deflection_landing | deg | Deflection of flaps for landing | False | 40.0 | <class 'float'> | False | GASP: INGASP.DFLPLD<br />FLOPS: None |
| aircraft:wing:flap_deflection_takeoff | deg | Deflection of flaps for takeoff | False | 10.0 | <class 'float'> | False | GASP: INGASP.DFLPTO<br />FLOPS: None |
| aircraft:wing:flap_drag_increment_optimum | unitless | drag coefficient increment due to optimally deflected trailing edge flaps (default depends on flap type) | False | 0.0 | <class 'float'> | False | GASP: INGASP.DCDOTE<br />FLOPS: None |
| aircraft:wing:flap_lift_increment_optimum | unitless | lift coefficient increment due to optimally deflected trailing edge flaps (default depends on flap type) | False | 0.0 | <class 'float'> | False | GASP: INGASP.DCLMTE<br />FLOPS: None |
| aircraft:wing:flap_span_ratio | unitless | fraction of wing trailing edge with flaps | False | 0.65 | <class 'float'> | False | GASP: INGASP.BTEOB<br />FLOPS: None |
| aircraft:wing:flap_type | unitless | Set the flap type. Available choices are: plain, split, single_slotted, double_slotted, triple_slotted, fowler, and double_slotted_fowler. In GASP this was JFLTYP and was provided as an int from 1-7 | True | FlapType.DOUBLE_SLOTTED | (FlapType.PLAIN, FlapType.SPLIT, FlapType.SINGLE_SLOTTED, FlapType.DOUBLE_SLOTTED, FlapType.TRIPLE_SLOTTED, FlapType.FOWLER, FlapType.DOUBLE_SLOTTED_FOWLER) | True | GASP: INGASP.JFLTYP<br />FLOPS: None |
| aircraft:wing:fold_dimensional_location_specified | unitless | if true, fold location from the chosen input is an actual fold span, if false it is normalized to the half span. In GASP this depended on STRUT or YWFOLD | True | False | <class 'bool'> | False | GASP: None<br />FLOPS: None |
| aircraft:wing:fold_mass | lbm | mass of the folding area of the wing | False | 0.0 | <class 'float'> | False | GASP: INGASP.WWFOLD<br />FLOPS: None |
| aircraft:wing:fold_mass_coefficient | unitless | mass trend coefficient of the wing fold | False | 0.0 | <class 'float'> | False | GASP: INGASP.SKWFOLD<br />FLOPS: None |
| aircraft:wing:folded_span | ft | folded wingspan | False | 0.0 | <class 'float'> | False | GASP: INGASP.YWFOLD<br />FLOPS: None |
| aircraft:wing:folded_span_dimensionless | unitless | folded wingspan | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:wing:folding_area | ft**2 | wing area of folding part of wings | False | 0.0 | <class 'float'> | False | GASP: INGASP.SWFOLD<br />FLOPS: None |
| aircraft:wing:form_factor | unitless | wing form factor | False | 0.0 | <class 'float'> | False | GASP: INGASP.CKW<br />FLOPS: None |
| aircraft:wing:fuselage_interference_factor | unitless | wing/fuselage interference factor | False | 0.0 | <class 'float'> | False | GASP: INGASP.CKI<br />FLOPS: None |
| aircraft:wing:glove_and_bat | ft**2 | total glove and bat area beyond theoretical wing | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.GLOV |
| aircraft:wing:has_fold | unitless | if true a fold will be included in the wing | True | False | <class 'bool'> | False | GASP: None<br />FLOPS: None |
| aircraft:wing:has_strut | unitless | if true then aircraft has a strut. In GASP this depended on STRUT | True | False | <class 'bool'> | False | GASP: None<br />FLOPS: None |
| aircraft:wing:height | ft | wing height above ground during ground run, measured at roughly location of mean aerodynamic chord at the mid plane of the wing | False | 0.0 | <class 'float'> | False | GASP: INGASP.HTG<br />FLOPS: None |
| aircraft:wing:high_lift_mass | lbm | mass of the high lift devices | False | 0.0 | <class 'float'> | False | GASP: INGASP.WHLDEV<br />FLOPS: None |
| aircraft:wing:high_lift_mass_coefficient | unitless | mass trend coefficient of high lift devices (default depends on flap type) | False | 0.0 | <class 'float'> | False | GASP: INGASP.WCFLAP<br />FLOPS: None |
| aircraft:wing:incidence | deg | incidence angle of the wings with respect to the fuselage | False | 0.0 | <class 'float'> | False | GASP: INGASP.EYEW<br />FLOPS: None |
| aircraft:wing:input_station_distribution | unitless | wing station locations as fractions of semispan; overwrites station_locations | True | [0.0] | <class 'float'> | True | GASP: None<br />FLOPS: WTIN.ETAW |
| aircraft:wing:laminar_flow_lower | unitless | define percent laminar flow for wing lower surface | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: AERIN.TRLW |
| aircraft:wing:laminar_flow_upper | unitless | define percent laminar flow for wing upper surface | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: AERIN.TRUW |
| aircraft:wing:leading_edge_sweep | rad | sweep angle at leading edge of wing | False | 0.0 | <class 'float'> | False | GASP: INGASP.SWPLE<br />FLOPS: None |
| aircraft:wing:load_distribution_control | unitless | controls spatial distribution of integration stations for detailed wing, in [1, 3] | True | 2.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.PDIST |
| aircraft:wing:load_fraction | unitless | fraction of load carried by defined wing | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.PCTL |
| aircraft:wing:load_path_sweep_distribution | deg | Define the sweep of load path at station locations. Typically parallel to rear spar tending toward max t/c of airfoil. The Ith value is used between wing stations I and I+1. | False | [0.0] | <class 'float'> | True | GASP: None<br />FLOPS: WTIN.SWL |
| aircraft:wing:loading_above_20 | unitless | if true the wing loading is stated to be above 20 psf. In GASP this depended on WGS | True | True | <class 'bool'> | False | GASP: None<br />FLOPS: None |
| aircraft:wing:mass | lbm | Wing group mass. Contains basic & secondary structures, ailerons/elevons, spoilers, flaps, and slats. | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:wing:mass_coefficient | unitless | mass trend coefficient of the wing without high lift devices | False | 0.0 | <class 'float'> | False | GASP: INGASP.SKWW<br />FLOPS: None |
| aircraft:wing:mass_scaler | unitless | mass scaler of the overall wing | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.FRWI |
| aircraft:wing:material_factor | unitless | correction factor for the use of non optimum material | False | 0.0 | <class 'float'> | False | GASP: INGASP.SKNO<br />FLOPS: None |
| aircraft:wing:max_camber_at_70_semispan | unitless | Maximum camber at 70 percent semispan, percent of local chord | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: AERIN.CAM |
| aircraft:wing:max_lift_ref | unitless | input reference maximum lift coefficient for basic wing | False | 0.0 | <class 'float'> | False | GASP: INGASP.RCLMAX<br />FLOPS: None |
| aircraft:wing:max_slat_deflection_landing | deg | leading edge slat deflection during landing | False | 10.0 | <class 'float'> | False | GASP: INGASP.DELLED<br />FLOPS: None |
| aircraft:wing:max_slat_deflection_takeoff | deg | leading edge slat deflection during takeoff | False | 10.0 | <class 'float'> | False | GASP: INGASP.DELLED<br />FLOPS: None |
| aircraft:wing:max_thickness_location | unitless | location (percent chord) of max wing thickness | False | 0.0 | <class 'float'> | False | GASP: INGASP.XCTCMX<br />FLOPS: None |
| aircraft:wing:min_pressure_location | unitless | location (percent chord) of peak suction | False | 0.0 | <class 'float'> | False | GASP: INGASP.XCPS<br />FLOPS: None |
| aircraft:wing:misc_mass | lbm | wing mass breakdown term 3 | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:wing:misc_mass_scaler | unitless | mass scaler of the miscellaneous wing mass term | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.FRWI3 |
| aircraft:wing:num_flap_segments | unitless | number of flap segments per wing panel | True | 2 | <class 'int'> | False | GASP: INGASP.FLAPN<br />FLOPS: None |
| aircraft:wing:num_integration_stations | unitless | number of integration stations | True | 50 | <class 'int'> | False | GASP: None<br />FLOPS: WTIN.NSTD |
| aircraft:wing:optimum_flap_deflection | deg | optimum flap deflection angle (default depends on flap type) | False | 0.0 | <class 'float'> | False | GASP: INGASP.DELTEO<br />FLOPS: None |
| aircraft:wing:optimum_slat_deflection | deg | optimum slat deflection angle | False | 20.0 | <class 'float'> | False | GASP: INGASP.DELLEO<br />FLOPS: None |
| aircraft:wing:outboard_semispan | ft | Outboard semispan (used if a detailed wing outboard is being added to a BWB fuselage) | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: FUSEIN.OSSPAN |
| aircraft:wing:root_chord | ft | wing chord length at at the wing/fuselage intersection | False | 0.0 | <class 'float'> | False | GASP: INGASP.CROOTW<br />FLOPS: WTIN.XLW |
| aircraft:wing:shear_control_mass | lbm | wing mass breakdown term 2 | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:wing:shear_control_mass_scaler | unitless | mass scaler of the shear and control term | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.FRWI2 |
| aircraft:wing:slat_chord_ratio | unitless | ratio of slat chord to wing chord | False | 0.0 | <class 'float'> | False | GASP: INGASP.CLEOC<br />FLOPS: None |
| aircraft:wing:slat_lift_increment_optimum | unitless | lift coefficient increment due to optimally deflected LE slats | False | 0.0 | <class 'float'> | False | GASP: INGASP.DCLMLE<br />FLOPS: None |
| aircraft:wing:slat_span_ratio | unitless | fraction of wing leading edge with slats | False | 0.0 | <class 'float'> | False | GASP: INGASP.BLEOB<br />FLOPS: None |
| aircraft:wing:span | ft | span of main wing | False | 0.0 | <class 'float'> | False | GASP: INGASP.B<br />FLOPS: WTIN.SPAN |
| aircraft:wing:span_efficiency_factor | unitless | coefficient for calculating span efficiency for extreme taper ratios | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: AERIN.E |
| aircraft:wing:span_efficiency_reduction | unitless | Define a switch for span efficiency reduction for extreme taper ratios: True == a span efficiency factor (*wing_span_efficiency_factor0*) is calculated based on wing taper ratio and aspect ratio; False == a span efficiency factor (*wing_span_efficiency_factor0*) is set to 1.0. | True | False | <class 'bool'> | False | GASP: None<br />FLOPS: AERIN.MIKE |
| aircraft:wing:strut_bracing_factor | unitless | Define the wing strut-bracing factor where: 0.0 == no wing-strut; 1.0 == full benefit from strut bracing. | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.FSTRT |
| aircraft:wing:surface_control_mass | lbm | mass of surface controls | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:wing:surface_control_mass_coefficient | unitless | Surface controls weight coefficient | False | 0.0 | <class 'float'> | False | GASP: INGASP.SKFW<br />FLOPS: None |
| aircraft:wing:surface_control_mass_scaler | unitless | Surface controls mass scaler | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.FRSC |
| aircraft:wing:sweep | deg | quarter-chord sweep angle of the wing | False | 0.0 | <class 'float'> | False | GASP: INGASP.DLMC4<br />FLOPS: CONFIN.SWEEP |
| aircraft:wing:taper_ratio | unitless | taper ratio of the wing | False | 0.0 | <class 'float'> | False | GASP: INGASP.SLM<br />FLOPS: CONFIN.TR |
| aircraft:wing:thickness_to_chord | unitless | wing thickness-chord ratio (weighted average) | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: CONFIN.TCA |
| aircraft:wing:thickness_to_chord_distribution | unitless | the thickeness-chord ratios at station locations | False | [0.0] | <class 'float'> | True | GASP: None<br />FLOPS: WTIN.TOC |
| aircraft:wing:thickness_to_chord_reference | unitless | Reference thickness-to-chord ratio, used for detailed wing mass estimation. | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.TCREF |
| aircraft:wing:thickness_to_chord_root | unitless | thickness-to-chord ratio at the root of the wing | False | 0.0 | <class 'float'> | False | GASP: INGASP.TCR<br />FLOPS: None |
| aircraft:wing:thickness_to_chord_tip | unitless | thickness-to-chord ratio at the tip of the wing | False | 0.0 | <class 'float'> | False | GASP: INGASP.TCT<br />FLOPS: None |
| aircraft:wing:thickness_to_chord_unweighted | unitless | wing thickness-chord ratio at the wing station of the mean aerodynamic chord | False | 0.0 | <class 'float'> | False | GASP: INGASP.TC<br />FLOPS: None |
| aircraft:wing:ultimate_load_factor | unitless | structural ultimate load factor | False | 0.0 | <class 'float'> | False | GASP: INGASP.ULF<br />FLOPS: WTIN.ULF |
| aircraft:wing:var_sweep_mass_penalty | unitless | Define the fraction of wing variable sweep mass penalty where: 0.0 == fixed-geometry wing; 1.0 == full variable-sweep wing. | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.VARSWP |
| aircraft:wing:vertical_mount_location | unitless | vertical wing mount location on fuselage (0 = low wing, 1 = high wing). It is continuous variable between 0 and 1 are acceptable. | False | 0.0 | <class 'float'> | False | GASP: INGASP.HWING<br />FLOPS: None |
| aircraft:wing:wetted_area | ft**2 | wing wetted area | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| aircraft:wing:wetted_area_scaler | unitless | wing wetted area scaler | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: AERIN.SWETW |
| aircraft:wing:zero_lift_angle | deg | zero lift angle of attack | False | 0.0 | <class 'float'> | False | GASP: INGASP.ALPHL0<br />FLOPS: None |
| density | lbm/ft**3 | Atmospheric density at the vehicle's current altitude | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| dynamic_pressure | lbf/ft**2 | Atmospheric dynamic pressure at the vehicle's current flight condition | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| dynamic_viscosity | lbf*s/ft**2 | Atmospheric dynamic viscosity at the vehicle's current flight condition | False | 0.0 | <class 'float'> | True | GASP: XKV<br />FLOPS: None |
| kinematic_viscosity | ft**2/s | Atmospheric kinematic viscosity at the vehicle's current flight condition | False | 0.0 | <class 'float'> | True | GASP: XKV<br />FLOPS: None |
| mach | unitless | Current Mach number of the vehicle | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| mach_rate | unitless | Current rate at which the Mach number of the vehicle is changing | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| speed_of_sound | ft/s | Atmospheric speed of sound at vehicle's current flight condition | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| static_pressure | lbf/ft**2 | Atmospheric static pressure at the vehicle's current flight condition | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| temperature | degR | Atmospheric temperature at vehicle's current flight condition | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| altitude | ft | Current geometric altitude of the vehicle | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| altitude_rate | ft/s | Current rate of altitude change (climb rate) of the vehicle | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| altitude_rate_max | ft/s | Current maximum possible rate of altitude change (climb rate) of the vehicle (at hypothetical maximum thrust condition) | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| distance | NM | The total distance the vehicle has traveled since brake release at the current time | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: range |
| distance_rate | NM/s | The rate at which the distance traveled is changing at the current time | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: range_rate |
| flight_path_angle | rad | Current flight path angle | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| flight_path_angle_rate | rad/s | Current rate at which flight path angle is changing | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| specific_energy | m/s | Rate of change in specific energy (energy per unit weight) of the vehicle at current flight condition | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| specific_energy_rate | m/s | Rate of change in specific energy (specific power) of the vehicle at current flight condition | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| specific_energy_rate_excess | m/s | Specific excess power of the vehicle at current flight condition and at hypothetical maximum thrust | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| velocity | ft/s | Current velocity of the vehicle along its body axis | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| velocity_rate | ft/s**2 | Current rate of change in velocity (acceleration) of the vehicle along its body axis | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| angle_of_attack | deg | Angle between aircraft wing cord and relative wind | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| battery_state_of_charge | unitless | battery's current state of charge | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| cumulative_electric_energy_used | kJ | Total amount of electric energy consumed by the vehicle up until this point in the mission | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| drag | lbf | Current total drag experienced by the vehicle | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| drag_coefficient | unitless | Current total drag coefficient experienced by the vehicle | False | 1.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| lift | lbf | Current total lift produced by the vehicle | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| lift_coefficient | unitless | Current total lift coefficient produced by the vehicle | False | 1.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| mass | lbm | Current total mass of the vehicle | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| mass_rate | lbm/s | Current rate at which the mass of the vehicle is changing | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| electric_power_in | kW | The electric power consumption of each engine during the mission. | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| electric_power_in_total | kW | Current total electric power consumption of the vehicle | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| fuel_flow_rate | lbm/h | Current rate of fuel consumption of the vehicle, per single instance of each engine model. Consumption (i.e. mass reduction) of fuel is defined as positive. | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| fuel_flow_rate_negative | lbm/h | Current rate of fuel consumption of the vehicle, per single instance of each engine model. Consumption (i.e. mass reduction) of fuel is defined as negative. | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| fuel_flow_rate_negative_total | lbm/h | Current rate of total fuel consumption of the vehicle. Consumption (i.e. mass reduction) of fuel is defined as negative. | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| fuel_flow_rate_total | lbm/h | Current rate of total fuel consumption of the vehicle. Consumption (i.e. mass reduction) of fuel is defined as positive. | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| hybrid_throttle | unitless | Current secondary throttle setting of each individual engine model on the vehicle, used as an additional degree of control for hybrid engines | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| nox_rate | lbm/h | Current rate of nitrous oxide (NOx) production by the vehicle, per single instance of each engine model | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| nox_rate_total | lbm/h | Current total rate of nitrous oxide (NOx) production by the vehicle | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| propeller_tip_speed | ft/s | linear propeller tip speed due to rotation (not airspeed at propeller tip) | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| rotations_per_minute | rpm | Rotational rate of shaft, per engine. | False | 0.0 | <class 'float'> | True | GASP: ['RPM', 'RPMe']<br />FLOPS: None |
| shaft_power | hp | current shaft power, per engine | False | 0.0 | <class 'float'> | True | GASP: ['SHP, EHP']<br />FLOPS: None |
| shaft_power_max | hp | The maximum possible shaft power currently producible, per engine | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| t4 | degR | Current turbine exit temperature (T4) of turbine engines on vehicle, per single instance of each engine model | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| throttle | unitless | Current throttle setting for each individual engine model on the vehicle | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| thrust_net | lbf | Current net thrust produced by engines, per single instance of each engine model | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| thrust_net_max | lbf | Hypothetical maximum possible net thrust that can be produced per single instance of each engine model at the vehicle's current flight condition | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| thrust_net_max_total | lbf | Hypothetical maximum possible net thrust produced by the vehicle at its current flight condition | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| thrust_net_total | lbf | Current total net thrust produced by the vehicle | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| torque | N*m | Current torque being produced, per engine | False | 0.0 | <class 'float'> | True | GASP: TORQUE<br />FLOPS: None |
| torque_max | N*m | Hypothetical maximum possible torque being produced at the current flight condition, per engine | False | 0.0 | <class 'float'> | True | GASP: None<br />FLOPS: None |
| mission:block_fuel_mass | lbm | Fuel burned from taxi out of the gate through the regular missions to taxi into the gate.This does not include fuel burned in reserve phases. This works for energy-state EOM. Not used in 2DOF EOM | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:final_mass | lbm | The final weight of the vehicle at the end of the last regular_phase (does not include reserve phases). | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:final_time | min | Total mission time from the start of the first regular_phaseto the end of the last regular_phase (does not include reserve phases). | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:fuel_mass | lbm | Fuel burned from taxi-out through all regular phases of the mission (e.g. takeoff, climb, cruse, descent, landing).This does not include fuel burned in reserve phases or taxi-in.The only time taxi-in would be included in this is if the userspecifies a taxi phase as part of the regular mission phases. | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:gravity | m/s**2 | Gravitational acceleration of the planet. This model is updatedin preprocess_options() based on which atmosphere is selected.This ensures the gravity model matches the planet. | True | 9.80665 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:gross_mass | lbm | Gross takeoff mass of aircraft for the mission being flown.May differ from Aircraft.Design.GROSS_MASS for off-design missions. | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:operating_items_mass | lbm | Operating Items group. Includes crew, unusable fuel, and oil mass. | False | 0.0 | <class 'float'> | False | GASP: INGASP.WFUL<br />FLOPS: None |
| mission:operating_items_mass_additional | lbm | Other operating items (e.g. external tanks, life rafts). | False | 0.0 | <class 'float'> | False | GASP: CW(16)<br />FLOPS: None |
| mission:operating_mass | lbm | Operating mass of the aircraft. Includes structure mass, crew (and crew baggage), unusable fuel, oil, and operational items like cargo containers and passenger service mass. | False | 0.0 | <class 'float'> | False | GASP: INGASP.OWE<br />FLOPS: MISSIN.DOWE |
| mission:range | NM | actual range that the aircraft flies on this mission. Equal to Aircraft.Design.RANGE value in the design case. | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:reserve_fuel_margin | unitless | required fuel reserves: given as a precentage of mission fuel.Mission fuel only includes normal phases and excludes reserve phases. | True | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:reserve_fuel_mass | lbm | fuel burned during reserve phases, this does not include fuel burned in regular phases | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:reserve_fuel_mass_additional | lbm | required fuel reserves: directly in lbm | True | 0.0 | <class 'float'> | False | GASP: INGASP.FRESF<br />FLOPS: None |
| mission:sea_level_density | kg/m**3 | Atmospheric density at seal level for this planet. | True | 1.225 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:total_fuel_mass | lbm | total fuel carried at the beginnning of a mission includes fuel burned in the mission, reserve fuel and fuel margin | False | 0.0 | <class 'float'> | False | GASP: INGASP.WFA<br />FLOPS: None |
| mission:total_reserve_fuel_mass | lbm | the total fuel reserves which is the sum of: Mission.RESERVE_FUEL_MASS, Mission.RESERVE_FUEL_MASS_ADDITIONAL, Mission.RESERVE_FUEL_MARGIN | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:zero_fuel_mass | lbm | Aircraft zero fuel mass. Includes operating mass, passengers, baggage, and cargo. | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:constraints:excess_fuel_mass_capacity | lbm | Difference between the usable fuel capacity on the aircraft and the total fuel (including reserve) required for the mission. Must be >= 0 to ensure that the aircraft has enough fuel to complete the mission | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:constraints:gearbox_shaft_power_residual | kW | Must be zero or positive to ensure that the gearbox is sized large enough to handle the maximum shaft power the engine could output during any part of the mission | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:constraints:mass_residual | lbm | residual to make sure aircraft mass closes on actual gross takeoff mass, value should be zero at convergence (within acceptable tolerance) | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:constraints:max_mach | unitless | aircraft cruise Mach number | True | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: WTIN.VMMO |
| mission:constraints:range_residual | NM | residual to make sure aircraft range is equal to the targeted range, value should be zero at convergence (within acceptable tolerance) | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:constraints:range_residual_reserve | NM | residual to make sure aircraft reserve mission range is equal to the targeted range, value should be zero at convergence (within acceptable tolerance) | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:landing:airport_altitude | ft | altitude of airport where aircraft lands | False | 0.0 | <class 'float'> | False | GASP: INGASP.ALTLND<br />FLOPS: None |
| mission:landing:braking_delay | s | time delay between touchdown and the application of brakes | False | 1.0 | <class 'float'> | False | GASP: INGASP.TDELAY<br />FLOPS: None |
| mission:landing:braking_friction_coefficient | unitless | landing coefficient of friction, with brakes on | False | 0.3 | <class 'float'> | False | FLOPS: None<br />GASP: INGASP.MUB |
| mission:landing:drag_coefficient_flap_increment | unitless | drag coefficient increment at landing due to flaps | False | 0.0 | <class 'float'> | False | GASP: INGASP.DCD<br />FLOPS: None |
| mission:landing:drag_coefficient_min | unitless | Minimum drag coefficient for takeoff. Typically this is CD at zero lift. | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: TOLIN.CDMLD |
| mission:landing:field_length | ft | FAR landing field length | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:landing:flare_rate | deg/s | flare rate in detailed landing | False | 2.0 | <class 'float'> | False | GASP: None<br />FLOPS: TOLIN.VANGLD |
| mission:landing:glide_to_stall_ratio | unitless | ratio of glide (approach) speed to stall speed | False | 1.3 | <class 'float'> | False | GASP: INGASP.VRATT<br />FLOPS: None |
| mission:landing:ground_distance | ft | distance covered over the ground during landing | False | 0.0 | <class 'float'> | False | GASP: INGASP.DLT<br />FLOPS: None |
| mission:landing:initial_altitude | ft | altitude where landing calculations begin | False | 0.0 | <class 'float'> | False | GASP: INGASP.HIN<br />FLOPS: None |
| mission:landing:initial_mach | unitless | approach Mach number | False | 0.1 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:landing:initial_velocity | ft/s | approach velocity | False | 0.0 | <class 'float'> | False | GASP: VGL<br />FLOPS: None |
| mission:landing:lift_coefficient_flap_increment | unitless | lift coefficient increment at landing due to flaps | False | 0.0 | <class 'float'> | False | GASP: INGASP.DCL<br />FLOPS: None |
| mission:landing:lift_coefficient_max | unitless | maximum lift coefficient for landing | False | 0.0 | <class 'float'> | False | GASP: INGASP.CLMWLD<br />FLOPS: AERIN.CLLDM |
| mission:landing:maximum_flare_load_factor | unitless | maximum load factor during landing flare | False | 1.15 | <class 'float'> | False | GASP: INGASP.XLFMX<br />FLOPS: None |
| mission:landing:maximum_sink_rate | ft/min | maximum rate of sink during glide | False | 1000.0 | <class 'float'> | False | GASP: INGASP.RSMX<br />FLOPS: None |
| mission:landing:obstacle_height | ft | landing obstacle height above the ground at airport altitude | False | 50.0 | <class 'float'> | False | GASP: INGASP.HAPP<br />FLOPS: None |
| mission:landing:rolling_friction_coefficient | unitless | coefficient of rolling friction for groundroll portion of takeoff | False | 0.025 | <class 'float'> | False | FLOPS: None<br />GASP: None |
| mission:landing:spoiler_drag_coefficient | unitless | drag coefficient for spoilers during landing rollout | False | 0.0 | <class 'float'> | False | FLOPS: None<br />GASP: None |
| mission:landing:spoiler_lift_coefficient | unitless | lift coefficient for spoilers during landing rollout | False | 0.0 | <class 'float'> | False | FLOPS: None<br />GASP: None |
| mission:landing:stall_velocity | ft/s | stall speed during approach | False | 0.0 | <class 'float'> | False | GASP: INGASP.VST<br />FLOPS: None |
| mission:landing:touchdown_mass | lbm | computed mass of aircraft for landing, is only required to be equal to Aircraft.Design.TOUCHDOWN_MASS_MAX when the design case is being run for ENERGY_STATE missions this is the mass at the end of the last regular phase (non-reserve phase) | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:landing:touchdown_sink_rate | ft/s | sink rate at touchdown | False | 3.0 | <class 'float'> | False | GASP: INGASP.SINKTD<br />FLOPS: None |
| mission:objectives:fuel | unitless | regularized objective that minimizes total fuel mass subject to other necessary additions | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:objectives:range | unitless | regularized objective that maximizes range subject to other necessary additions | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:takeoff:airport_altitude | ft | altitude of airport where aircraft takes off | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:takeoff:angle_of_attack_runway | deg | angle of attack on ground | True | 0.0 | <class 'float'> | False | FLOPS: TOLIN.ALPRUN<br />GASP: None |
| mission:takeoff:ascent_duration | s | duration of the ascent phase of takeoff | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:takeoff:ascent_t_initial | s | time that the ascent phase of takeoff starts at | False | 10.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:takeoff:braking_friction_coefficient | unitless | takeoff coefficient of friction, with brakes on | False | 0.3 | <class 'float'> | False | FLOPS: TOLIN.BRAKMU<br />GASP: None |
| mission:takeoff:climbout_thrust_fraction | unitless | Fraction of Aircraft.Propulsion.TOTAL_SCALED_SLS_THRUST to use forclimbout phase of simple takeoff calculations. For 2 engine aircraft set = 0.5 for one engine out. | False | 1.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:takeoff:decision_speed_increment | kn | increment of engine failure decision speed above stall speed | False | 5.0 | <class 'float'> | False | GASP: INGASP.DV1<br />FLOPS: None |
| mission:takeoff:drag_coefficient_flap_increment | unitless | drag coefficient increment at takeoff due to flaps | False | 0.0 | <class 'float'> | False | GASP: INGASP.DCD<br />FLOPS: None |
| mission:takeoff:drag_coefficient_min | unitless | Minimum drag coefficient for takeoff. Typically this is CD at zero lift. | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: TOLIN.CDMTO |
| mission:takeoff:field_length | ft | FAR takeoff field length | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:takeoff:final_altitude | ft | altitude of aircraft at the end of takeoff | False | 35.0 | <class 'float'> | False | GASP: None<br />FLOPS: TOLIN.OBSTO |
| mission:takeoff:final_mach | unitless | Mach number of aircraft after taking off and clearing a 35 foot obstacle | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:takeoff:final_mass | lbm | mass after aircraft has cleared 35 ft obstacle | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:takeoff:final_velocity | m/s | velocity of aircraft after taking off and clearing a 35 foot obstacle | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:takeoff:fuel_mass | lbm | Fuel burned during takeoff for energy-state EOM. Not used in 2DOF EOM. | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: MISSIN.FTKOFL |
| mission:takeoff:ground_distance | ft | ground distance covered by takeoff with all engines operating | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:takeoff:lift_coefficient_flap_increment | unitless | lift coefficient increment at takeoff due to flaps | False | 0.0 | <class 'float'> | False | GASP: INGASP.DCL<br />FLOPS: None |
| mission:takeoff:lift_coefficient_max | unitless | maximum lift coefficient for takeoff | False | 2.0 | <class 'float'> | False | GASP: INGASP.CLMWTO<br />FLOPS: ['AERIN.CLTOM', 'TOLIN.CLTOM'] |
| mission:takeoff:lift_over_drag | unitless | ratio of lift to drag at takeoff | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:takeoff:obstacle_height | ft | takeoff obstacle height above the ground at airport altitude | True | 35.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:takeoff:rolling_friction_coefficient | unitless | coefficient of rolling friction for groundroll portion of takeoff | False | 0.025 | <class 'float'> | False | GASP: INGASP.UM<br />FLOPS: TOLIN.ROLLMU |
| mission:takeoff:rotation_speed_increment | kn | increment of takeoff rotation speed above engine failure decision speed | False | 5.0 | <class 'float'> | False | GASP: INGASP.DVR<br />FLOPS: None |
| mission:takeoff:rotation_velocity | kn | rotation velocity | False | 0.0 | <class 'float'> | False | GASP: INGASP.VR<br />FLOPS: None |
| mission:takeoff:spoiler_drag_coefficient | unitless | drag coefficient for spoilers during takeoff abort | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: TOLIN.CDSPOL |
| mission:takeoff:spoiler_lift_coefficient | unitless | lift coefficient for spoilers during takeoff abort | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: TOLIN.CLSPOL |
| mission:takeoff:thrust_incidence | deg | thrust incidence on ground | True | 0.0 | <class 'float'> | False | FLOPS: TOLIN.TINC<br />GASP: None |
| mission:taxi:duration | h | time spent taxiing before takeoff | True | 0.167 | <class 'float'> | False | GASP: INGASP.DELTT<br />FLOPS: None |
| mission:taxi:fuel_mass_taxi_in | lbm | Fuel burned to taxi from the runway to the gate. Can be used with energy-stand and 2DOF EOM. | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:taxi:fuel_mass_taxi_out | lbm | Fuel burned to taxi from the gate to the runway. Only used in energy-state EOM. Not used in 2DOF EOM. | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| mission:taxi:mach | unitless | speed during taxi | False | 0.0 | <class 'float'> | False | GASP: None<br />FLOPS: None |
| settings:aerodynamics_method | unitless | Sets which legacy code's methods will be used for aerodynamics estimation | True | None | (FLOPS, GASP) | False | GASP: None<br />FLOPS: None |
| settings:atmosphere_model | unitless | The atmospheric model used. Chose one of: standard, tropical, polar, hot, cold, mars_reference, mars_hellas_hot, mars_hellas_cold, mars_equator_hot, mars_equator_cold, mars_polar_hot, mars_polar_cold, venus_reference | True | AtmosphereModel.STANDARD | (AtmosphereModel.STANDARD, AtmosphereModel.COLD, AtmosphereModel.HOT, AtmosphereModel.TROPICAL, AtmosphereModel.POLAR, AtmosphereModel.MARS_REFERENCE, AtmosphereModel.MARS_HELLAS_HOT, AtmosphereModel.MARS_HELLAS_COLD, AtmosphereModel.MARS_EQUATOR_HOT, AtmosphereModel.MARS_EQUATOR_COLD, AtmosphereModel.MARS_POLAR_HOT, AtmosphereModel.MARS_POLAR_COLD, AtmosphereModel.VENUS_REFERENCE) | False | GASP: None<br />FLOPS: None |
| settings:equations_of_motion | unitless | Sets which equations of motion Aviary will use in mission analysis | True | None | (EquationsOfMotion.ENERGY_STATE, EquationsOfMotion.TWO_DEGREES_OF_FREEDOM, EquationsOfMotion.SOLVED_2DOF, EquationsOfMotion.CUSTOM) | False | GASP: None<br />FLOPS: None |
| settings:mass_method | unitless | Sets which legacy code's methods will be used for mass estimation | True | None | (FLOPS, GASP) | False | GASP: None<br />FLOPS: None |
| settings:payload_range | unitless | for SIZING missions only. If True, run a set of off-design missions to create a payload range diagram. Assumes SIZING mission describes the max payload + fuel point | True | False | <class 'bool'> | False | GASP: None<br />FLOPS: None |
| settings:problem_type | unitless | Select from Aviary's built in problem types: SIZING, OFF_DESIGN_MIN_FUEL, OFF_DESIGN_MAX_RANGE and MULTI_MISSION | True | None | (ProblemType.SIZING, ProblemType.OFF_DESIGN_MIN_FUEL, ProblemType.OFF_DESIGN_MAX_RANGE, ProblemType.MULTI_MISSION) | False | GASP: None<br />FLOPS: None |
| settings:verbosity | unitless | Sets how much information Aviary outputs when run. Options include:0. QUIET: All output except errors are suppressed1. BRIEF: Only important information is output, in human-readable format2. VERBOSE: All user-relevant information is output, in human-readable format3. DEBUG: Any information can be outtputed, including warnings, intermediate calculations, etc., with no formatting requirement | True | 1 | (0, 1, 2, 3) | False | GASP: None<br />FLOPS: None |
| aircraft:center_of_gravity | ft | Center of gravity | False | 0.0 | <class 'float'> | False | NaN |
| aircraft:wing:flap:area | ft**2 | planform area of flap | False | 10.0 | <class 'float'> | False | NaN |
| aircraft:wing:flap:root_chord | ft | chord of flap at root of wing | False | 1.0 | <class 'float'> | False | NaN |
| aircraft:wing:flap:span | ft | span of flap | False | 60.0 | <class 'float'> | False | NaN |
| aircraft:jury:mass | kg | mass of jury strut | False | 50.0 | <class 'float'> | False | NaN |
| aircraft:engine:cooling:mass | kg | mass of cooling system for one engine | False | 100.0 | <class 'float'> | False | NaN |
| aircraft:wing:winglets | unitless | Tells whether the aircraft has winglets | True | True | <class 'bool'> | False | NaN |