# Documentation of variables used in FAST-GA models
# Each line should be like:
# my:variable||The description of my:variable, as long as needed, but on one line.
# The separator "||" can be surrounded with spaces (that will be ignored)

data:geometry:propeller:blades_number || number of blades on the propeller
data:geometry:propeller:chord_vect || blade chord at the station along the radius stored in radius_ratio_vect
data:geometry:propeller:diameter || propeller diameter
data:geometry:propeller:hub_diameter || propeller hub diameter
data:geometry:propeller:average_rpm || average rotation speed of the propeller
data:geometry:propeller:depth || depth of the propeller
data:geometry:propeller:radius_ratio_vect || blade station at which blade geometric properties are sampled, as a percent of blade radius
data:geometry:propeller:sweep_vect || blade sweep at the station along the radius stored in radius_ratio_vect
data:geometry:propeller:twist_vect || blade twist at the station along the radius stored in radius_ratio_vect
data:geometry:propulsion:tank:LE_chord_percentage || distance between the leading edge and the start of the wing tank as a percentage of the wing chord
data:geometry:propulsion:tank:TE_chord_percentage || distance between the trailing edge device and the start of the wing tank as a percentage of the wing chord
data:geometry:propulsion:tank:y_ratio_tank_beginning || start of the tank as a percentage of the wing span
data:geometry:propulsion:tank:y_ratio_tank_end || end of the tank as a percentage of the wing span
data:geometry:vertical_tail:rudder:chord_ratio || flap rudder as a percentage of the wing chord
data:geometry:vertical_tail:rudder:max_deflection || rudder maximum deflection
data:geometry:vertical_tail:aspect_ratio || vertical tail aspect ratio
data:geometry:vertical_tail:max_thickness:x_ratio || position of the point of maximum thickness as a ratio of vertical tail chord
data:geometry:vertical_tail:sweep_25 || sweep angle at 25% chord of vertical tail
data:geometry:vertical_tail:taper_ratio || taper ratio of vertical tail
data:geometry:vertical_tail:thickness_ratio || thickness ratio of vertical tail
data:geometry:vertical_tail:MAC:at25percent:x:absolute || distance between the nose and the aerodynamic center of the vertical tail
data:geometry:horizontal_tail:MAC:at25percent:x:absolute || distance between the nose and the aerodynamic center of the horizontal tail
data:geometry:wing:aspect_ratio || wing aspect ratio
data:geometry:wing:kink:span_ratio || ratio (Y-position of kink)/(semi-span)
data:geometry:wing:sweep_25 || sweep angle at 25% chord of wing
data:geometry:wing:taper_ratio || taper ratio of wing
data:geometry:wing:thickness_ratio || mean thickness ratio of wing
data:geometry:wing:aileron:chord_ratio || aileron chord as a percentage of the wing chord

data:mission:sizing:cs23:sizing_factor:ultimate_aircraft || ultimate load factor that the aircraft will experience (default value is 5.7)
data:mission:sizing:takeoff:elevator_angle || position of the elevator during takeoff
data:mission:sizing:takeoff:flap_angle || position of the flaps during takeoff
data:mission:sizing:takeoff:friction_coefficient_no_brake || friction coefficient used during the computation of the takeoff phase
data:mission:sizing:takeoff:thrust_rate || thrust rate during takeoff phase
data:mission:sizing:taxi_in:duration || duration of taxi in phase
data:mission:sizing:taxi_in:speed || ground velocity during taxi in phase
data:mission:sizing:taxi_in:thrust_rate || thrust rate during taxi in phase
data:mission:sizing:main_route:climb:climb_rate:cruise_level || target climb rate at the end of climb
data:mission:sizing:main_route:climb:climb_rate:sea_level || target climb rate at sea level
data:mission:sizing:main_route:cruise:altitude || main route cruise phase altitude
data:mission:sizing:main_route:reserve:duration || duration of the reserve segment
data:mission:sizing:main_route:descent:descent_rate || target descent rate for the aircraft
data:mission:sizing:landing:elevator_angle || position of the elevator during landing
data:mission:sizing:landing:flap_angle || position of the flaps during landing
data:mission:sizing:taxi_out:duration || duration of taxi out phase
data:mission:sizing:taxi_out:speed || ground velocity during taxi out phase
data:mission:sizing:taxi_out:thrust_rate || thrust rate during taxi out phase

data:propulsion:fuel_type || engine fuel type (1.0 - gasoline, 2.0 - gasoil)
data:propulsion:IC_engine:max_power || maximum power of the engine
data:propulsion:max_rpm || maximum number of rotation per minute on the engine
data:propulsion:IC_engine:strokes_nb || number of strokes on the engine

data:TLAR:category || aircraft certification category
data:TLAR:level || aircraft certification level
data:TLAR:luggage_mass_design || luggage design mass
data:TLAR:NPAX_design || design number of passengers (two pilots are included de facto, meaning for a 2 seater, NPAX_design is equal to 0)
data:TLAR:range || design range
data:TLAR:v_approach || approach speed
data:TLAR:v_cruise || cruise speed
data:mission:sizing:cs23:characteristic_speed:vd || limit speed
data:TLAR:v_max_sl || maximum speed at sea level

data:weight:aircraft:OWE || operating weight - empty
data:weight:airframe:fuselage:k_factor || proportional corrective factor for fuselage mass
data:weight:airframe:horizontal_tail:k_factor || proportional corrective factor for horizontal tail mass
data:weight:airframe:vertical_tail:k_factor || proportional corrective factor for vertical tail mass
data:weight:airframe:wing:k_factor || proportional corrective factor for wing mass
data:weight:propulsion:engine:mass || total engine mass
data:weight:propulsion:unusable_fuel:mass || total unusable fuel mass

data:handling_qualities:static_margin:target || static margin we want to achieve

settings:weight:aircraft:CG:aft:MAC_position:margin || safety margin aft of the most aft X-position of center of gravity as ratio of mean aerodynamic chord
settings:weight:aircraft:CG:fwd:MAC_position:margin || safety margin fwd of the most fwd X-position of center of gravity as ratio of mean aerodynamic chord
settings:weight:aircraft:CG:range || distance between front position and aft position of CG, as ratio of mean aerodynamic chord (allows to have front position of CG potentially fwd of the computed one, as currently, FAST-OAD uses the aft position of CG as a reference)
settings:weight:aircraft:payload:design_mass_per_passenger || design payload mass carried by passenger
settings:weight:aircraft:payload:max_mass_per_passenger || maximum payload mass carried by passenger
settings:weight:airframe:landing_gear:front:weight_ratio || part of aircraft weight that is supported by front landing gear, should not be lower than 0.08. Roskam
settings:weight:airframe:landing_gear:front:front_fuselage_ratio || Position of front landing gear expressed as fuselage front length ratio
settings:weight:propulsion:engine:k_factor || Engine weight tuning factor

settings:geometry:fuel_tanks:depth || ratio of the tank depth as a percentage of the wing depth

data:weight:airframe:wing:punctual_mass:mass || mass of the punctual masses on the wing used for wing load computation
data:weight:airframe:wing:punctual_mass:y_ratio || position (as a percent of wing semi-span) of the punctual masses on the wing used for wing load computation, only positive ratio will be considered

data:aerodynamics:propeller:installation_effect:effective_advance_ratio || Value to multiply the flight advance ration with to obtain the effective advance ratio due to the presence of cowling (fuselage or nacelle) behind the propeller

data:geometry:propulsion:layout || position of engines (1=under the wing / 2=rear fuselage / 3=nose)
data:propulsion:turboprop:design_point:altitude || altitude of the turboprop design point
data:propulsion:turboprop:design_point:mach || mach number at the turboprop design point
data:propulsion:turboprop:design_point:OPR || overall pressure ratio at the turboprop design point
data:propulsion:turboprop:design_point:power || desired turboprop thermodynamic power at the design point
data:propulsion:turboprop:design_point:turbine_entry_temperature || turboprop turbine entry temperature at the design point
data:propulsion:turboprop:off_design:bleed_usage || usage of the bleed in off-design point, 0 for "low" or 1 for "high"
data:propulsion:turboprop:off_design:itt_limit || inter turbine temperature limitation in off-design point
data:propulsion:turboprop:off_design:opr_limit || pressure ratio limitation in off-design point
data:propulsion:turboprop:off_design:power_limit || mechanical power limitation in off-design point

settings:propulsion:turboprop:bleed:inter_compressor || total compressor airflow extracted after the first  compression stage (in station 25)
settings:propulsion:turboprop:bleed:turbine_cooling || percentage of the total aspirated airflow used for turbine cooling (fixed)
settings:propulsion:turboprop:design_point:first_stage_pressure_ratio || ratio of the first stage pressure ratio to the OPR at the design point
settings:propulsion:turboprop:design_point:mach_exhaust || mach number at the exhaust in the design point
settings:propulsion:turboprop:efficiency:combustion || fuel energy content
settings:propulsion:turboprop:efficiency:first_compressor_stage || first compressor stage polytropic efficiency
settings:propulsion:turboprop:efficiency:gearbox || power shaft mechanical efficiency
settings:propulsion:turboprop:efficiency:high_pressure_axe || high pressure axe mechanical efficiency
settings:propulsion:turboprop:efficiency:high_pressure_turbine || high pressure turbine  polytropic efficiency
settings:propulsion:turboprop:efficiency:power_turbine || power turbine  polytropic efficiency
settings:propulsion:turboprop:efficiency:second_compressor_stage || second compressor stage polytropic efficiency
settings:propulsion:turboprop:electric_power_offtake || power used for electrical generation obtained from the HP shaft
settings:propulsion:turboprop:pressure_loss:combustion_chamber || combustion chamber pressure loss
settings:propulsion:turboprop:pressure_loss:inlet || inlet total pressure loss

data:aerodynamics:cooling:cruise:CD0 || profile drag due to cooling in cruise conditions
data:aerodynamics:cooling:low_speed:CD0 || profile drag due to cooling in low speed conditions

settings:mission:sizing:main_route:reserve:k_factor || fudge factor on the reserve computation, can be used to adjust the model mainly to take into account different speed and altitudes

settings:propulsion:IC_engine:k_factor_sfc || fudge factor to replicate engine installation effect, multiplies the fuel consumption
