refactor: move MAX_MACH to aircraft design namespace

.github/workflows/verify-max-mach-migration.yml

@@ -0,0 +1,21 @@
+name: Verify MAX_MACH migration idempotence
+
+on:
+  push:
+    branches:
+      - refactor/aircraft-design-max-mach
+
+permissions:
+  contents: read
+
+jobs:
+  verify:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Re-run migration and audit
+        run: |
+          python tools/migrate_max_mach_namespace.py --write --check
+          git diff --exit-code
+      - name: Verify Python syntax
+        run: python -m compileall -q aviary tools/migrate_max_mach_namespace.py

aviary/docs/examples_unreviewed/modified_aircraft.csv

@@ -141,7 +141,7 @@ aircraft:wing:ultimate_load_factor,3.75,unitless
 aircraft:wing:var_sweep_mass_penalty,0.0,unitless
 aircraft:wing:wetted_area_scaler,1.0,unitless
 aircraft:wing:wetted_area,2396.56,ft**2
-mission:constraints:max_mach,0.785,unitless
+aircraft:design:max_mach,0.785,unitless
 aircraft:design:cruise_altitude,35000,ft
 aircraft:design:gross_mass,175400.0,lbm
 aircraft:design:range,3500,NM

aviary/docs/user_guide/fundamentals/aircraft_definition.ipynb

@@ -22,7 +22,7 @@
     "glue_variable(get_variable_name(Aircraft.Fuselage.LENGTH), md_code=True)\n",
     "glue_variable(get_variable_name(Aircraft.Wing.AREA), md_code=True)\n",
     "\n",
-    "glue_variable(get_variable_name(Mission.Constraints.MAX_MACH), md_code=True)\n",
+    "glue_variable(get_variable_name(Aircraft.Design.MAX_MACH), md_code=True)\n",
     "glue_variable(get_variable_name(Aircraft.Design.GROSS_MASS), md_code=True)\n",
     "glue_variable(get_variable_name(Aircraft.Design.RANGE), md_code=True)\n",
     "\n",
@@ -65,7 +65,7 @@
     "```\n",
     "...\n",
     "```text\n",
-    "{glue:md}mission:constraints:max_mach,          0.785,   unitless\n",
+    "{glue:md}aircraft:design:max_mach,          0.785,   unitless\n",
     "{glue:md}aircraft:design:gross_mass,            130000,  lbm\n",
     "{glue:md}aircraft:design:range,                 1906,    NM\n",
     "```\n",

aviary/interface/test/sizing_results_for_test.json

@@ -975,7 +975,7 @@
         "<class 'float'>"
     ],
     [
-        "mission:constraints:max_mach",
+        "aircraft:design:max_mach",
         0.785,
         "unitless",
         "<class 'float'>"

aviary/models/aircraft/advanced_single_aisle/advanced_single_aisle_FLOPS.csv

@@ -167,7 +167,7 @@ aircraft:wing:ultimate_load_factor,3.75,unitless
 aircraft:wing:var_sweep_mass_penalty,0,unitless
 aircraft:wing:wetted_area,2210.280228,ft**2
 aircraft:wing:wetted_area_scaler,1,unitless
-mission:constraints:max_mach,0.785,unitless
+aircraft:design:max_mach,0.785,unitless
 aircraft:design:gross_mass,130000,lbm
 aircraft:design:range,3500,NM
 mission:landing:airport_altitude,0,ft

aviary/models/aircraft/blended_wing_body/bwb300_baseline_FLOPS.csv

@@ -174,7 +174,7 @@ aircraft:wing:thickness_to_chord_reference,0.0,unitless
 aircraft:wing:ultimate_load_factor,3.75,unitless
 aircraft:wing:var_sweep_mass_penalty,0.0,unitless
 aircraft:wing:wetted_area_scaler,0.61,unitless
-mission:constraints:max_mach,0.9,unitless
+aircraft:design:max_mach,0.9,unitless
 aircraft:design:gross_mass,600000.0,lbm
 aircraft:design:range,7500.0,NM
 mission:landing:drag_coefficient_min,0.0,unitless

aviary/models/aircraft/blended_wing_body/bwb_detailed_FLOPS.csv

@@ -156,7 +156,7 @@ aircraft:wing:thickness_to_chord_distribution,0.15,0.1132,0.0928,0.0822,0.0764,0
 aircraft:wing:ultimate_load_factor,3.75,unitless
 aircraft:wing:var_sweep_mass_penalty,0.0,unitless
 aircraft:wing:wetted_area_scaler,1.0,unitless
-mission:constraints:max_mach,0.85,unitless
+aircraft:design:max_mach,0.85,unitless
 aircraft:design:gross_mass,874099,lbm
 aircraft:design:range,7750,NM
 mission:landing:initial_velocity,140,ft/s

aviary/models/aircraft/blended_wing_body/bwb_simple_FLOPS.csv

@@ -156,7 +156,7 @@ aircraft:wing:thickness_to_chord_reference,0.11,unitless
 aircraft:wing:ultimate_load_factor,3.75,unitless
 aircraft:wing:var_sweep_mass_penalty,0.0,unitless
 aircraft:wing:wetted_area_scaler,1.0,unitless
-mission:constraints:max_mach,0.85,unitless
+aircraft:design:max_mach,0.85,unitless
 aircraft:design:gross_mass,874099,lbm
 aircraft:design:range,7750,NM
 mission:landing:initial_velocity,140,ft/s

aviary/models/aircraft/large_single_aisle_1/large_single_aisle_1_FLOPS.csv

@@ -152,7 +152,7 @@ aircraft:wing:ultimate_load_factor,3.75,unitless
 aircraft:wing:var_sweep_mass_penalty,0.0,unitless
 aircraft:wing:wetted_area,2396.56,ft**2
 aircraft:wing:wetted_area_scaler,1.0,unitless
-mission:constraints:max_mach,0.785,unitless
+aircraft:design:max_mach,0.785,unitless
 mission:landing:lift_coefficient_max,3.0,unitless
 mission:takeoff:fuel_mass,577.0,lbm
 mission:takeoff:lift_coefficient_max,2.0,unitless

aviary/models/aircraft/large_single_aisle_2/large_single_aisle_2_FLOPS.csv

@@ -148,7 +148,7 @@ aircraft:wing:ultimate_load_factor,3.75,unitless
 aircraft:wing:var_sweep_mass_penalty,0.0,unitless
 aircraft:wing:wetted_area,2423.02,ft**2
 aircraft:wing:wetted_area_scaler,1.0,unitless
-mission:constraints:max_mach,0.82,unitless
+aircraft:design:max_mach,0.82,unitless
 mission:landing:lift_coefficient_max,3.0,unitless
 mission:takeoff:fuel_mass,659.0,lbm
 mission:takeoff:lift_coefficient_max,2.0,unitless

aviary/models/aircraft/large_single_aisle_2/large_single_aisle_2_altwt_FLOPS.csv

@@ -146,7 +146,7 @@ aircraft:wing:ultimate_load_factor,3.75,unitless
 aircraft:wing:var_sweep_mass_penalty,0.0,unitless
 aircraft:wing:wetted_area,2423.02,ft**2
 aircraft:wing:wetted_area_scaler,1.0,unitless
-mission:constraints:max_mach,0.82,unitless
+aircraft:design:max_mach,0.82,unitless
 mission:landing:lift_coefficient_max,3.0,unitless
 mission:takeoff:fuel_mass,659.0,lbm
 mission:takeoff:lift_coefficient_max,2.0,unitless

aviary/models/aircraft/large_single_aisle_2/large_single_aisle_2_detailwing_FLOPS.csv

@@ -148,7 +148,7 @@ aircraft:wing:ultimate_load_factor,3.75,unitless
 aircraft:wing:var_sweep_mass_penalty,0.0,unitless
 aircraft:wing:wetted_area,2423.02,ft**2
 aircraft:wing:wetted_area_scaler,1.0,unitless
-mission:constraints:max_mach,0.82,unitless
+aircraft:design:max_mach,0.82,unitless
 mission:landing:lift_coefficient_max,3.0,unitless
 mission:takeoff:fuel_mass,577.0,lbm
 mission:takeoff:lift_coefficient_max,2.0,unitless

aviary/models/aircraft/minimum_single_aisle/minimum_single_aisle_FLOPS.csv

@@ -49,7 +49,7 @@ aircraft:wing:ultimate_load_factor,3.75,unitless
 aircraft:hydraulics:system_pressure,5000,psi
 
 # Design mission
-mission:constraints:max_mach,0.785,unitless
+aircraft:design:max_mach,0.785,unitless
 aircraft:design:gross_mass,130000,lbm
 aircraft:design:range,1906,NM
 aircraft:design:cruise_mach,0.72,unitless

aviary/subsystems/aerodynamics/flops_based/premission_aero.py

@@ -27,7 +27,7 @@ def __init__(self, **kwargs):
 
     def initialize(self):
         add_aviary_option(self, Aircraft.Wing.AIRFOIL_TECHNOLOGY)
-        add_aviary_option(self, Mission.Constraints.MAX_MACH)
+        add_aviary_option(self, Aircraft.Design.MAX_MACH)
 
     def setup(self):
         # Aircraft design inputs
@@ -45,7 +45,7 @@ def setup_partials(self):
 
     def compute(self, inputs, outputs):
         AITEK = self.options[Aircraft.Wing.AIRFOIL_TECHNOLOGY]
-        VMAX = self.options[Mission.Constraints.MAX_MACH]
+        VMAX = self.options[Aircraft.Design.MAX_MACH]
 
         AR, CAM, SW25, TC = inputs.values()
 
@@ -87,7 +87,7 @@ def compute(self, inputs, outputs):
 
     def compute_partials(self, inputs, partials):
         AITEK = self.options[Aircraft.Wing.AIRFOIL_TECHNOLOGY]
-        VMAX = self.options[Mission.Constraints.MAX_MACH]
+        VMAX = self.options[Aircraft.Design.MAX_MACH]
 
         AR, CAM, SW25, TC = inputs.values()
 

aviary/subsystems/aerodynamics/flops_based/test/test_premission_aero.py

@@ -18,7 +18,7 @@ def test_derivs_supersonic1(self):
 
         options = {}
         options[Aircraft.Wing.AIRFOIL_TECHNOLOGY] = 1.0
-        options[Mission.Constraints.MAX_MACH] = 1.2
+        options[Aircraft.Design.MAX_MACH] = 1.2
 
         model.add_subsystem(
             'design',
@@ -49,7 +49,7 @@ def test_derivs_subsonic1(self):
 
         options = {}
         options[Aircraft.Wing.AIRFOIL_TECHNOLOGY] = 1.0
-        options[Mission.Constraints.MAX_MACH] = 0.9
+        options[Aircraft.Design.MAX_MACH] = 0.9
 
         model.add_subsystem(
             'design',
@@ -80,7 +80,7 @@ def test_derivs_supersonic2(self):
 
         options = {}
         options[Aircraft.Wing.AIRFOIL_TECHNOLOGY] = 1.0
-        options[Mission.Constraints.MAX_MACH] = 1.2
+        options[Aircraft.Design.MAX_MACH] = 1.2
 
         model.add_subsystem(
             'design',
@@ -111,7 +111,7 @@ def test_derivs_subsonic2(self):
 
         options = {}
         options[Aircraft.Wing.AIRFOIL_TECHNOLOGY] = 1.0
-        options[Mission.Constraints.MAX_MACH] = 0.9
+        options[Aircraft.Design.MAX_MACH] = 0.9
 
         model.add_subsystem(
             'design',

aviary/subsystems/mass/flops_based/air_conditioning.py

@@ -14,7 +14,7 @@ class TransportAirCondMass(om.ExplicitComponent):
 
     def initialize(self):
         add_aviary_option(self, Aircraft.CrewPayload.Design.NUM_PASSENGERS)
-        add_aviary_option(self, Mission.Constraints.MAX_MACH)
+        add_aviary_option(self, Aircraft.Design.MAX_MACH)
 
     def setup(self):
         add_aviary_input(self, Aircraft.AirConditioning.MASS_SCALER, units='unitless')
@@ -34,7 +34,7 @@ def compute(self, inputs, outputs, discrete_inputs=None, discrete_outputs=None):
         avionics_wt = inputs[Aircraft.Avionics.MASS] * GRAV_ENGLISH_LBM
         height = inputs[Aircraft.Fuselage.MAX_HEIGHT]
         planform = inputs[Aircraft.Fuselage.PLANFORM_AREA]
-        max_mach = self.options[Mission.Constraints.MAX_MACH]
+        max_mach = self.options[Aircraft.Design.MAX_MACH]
 
         outputs[Aircraft.AirConditioning.MASS] = (
             ((3.2 * (planform * height) ** 0.6 + 9 * pax**0.83) * max_mach + 0.075 * avionics_wt)
@@ -49,7 +49,7 @@ def compute_partials(self, inputs, J):
         avionics_wt = inputs[Aircraft.Avionics.MASS] * GRAV_ENGLISH_LBM
         height = inputs[Aircraft.Fuselage.MAX_HEIGHT]
         planform = inputs[Aircraft.Fuselage.PLANFORM_AREA]
-        max_mach = self.options[Mission.Constraints.MAX_MACH]
+        max_mach = self.options[Aircraft.Design.MAX_MACH]
 
         planform_exp = planform**0.6
         height_exp = height**0.6

aviary/subsystems/mass/flops_based/fuel_system.py

@@ -15,7 +15,7 @@ class TransportFuelSystemMass(om.ExplicitComponent):
 
     def initialize(self):
         add_aviary_option(self, Aircraft.Propulsion.TOTAL_NUM_ENGINES)
-        add_aviary_option(self, Mission.Constraints.MAX_MACH)
+        add_aviary_option(self, Aircraft.Design.MAX_MACH)
 
     def setup(self):
         add_aviary_input(self, Aircraft.Fuel.FUEL_SYSTEM_MASS_SCALER, units='unitless')
@@ -31,7 +31,7 @@ def compute(self, inputs, outputs):
         capacity = inputs[Aircraft.Fuel.MAX_CAPACITY_MASS]
         num_eng = self.options[Aircraft.Propulsion.TOTAL_NUM_ENGINES]
         num_eng_fact = distributed_engine_count_factor(num_eng)
-        max_mach = self.options[Mission.Constraints.MAX_MACH]
+        max_mach = self.options[Aircraft.Design.MAX_MACH]
 
         outputs[Aircraft.Fuel.FUEL_SYSTEM_MASS] = (
             1.07 * capacity**0.58 * num_eng_fact**0.43 * max_mach**0.34 * scaler
@@ -42,7 +42,7 @@ def compute_partials(self, inputs, J):
         capacity = inputs[Aircraft.Fuel.MAX_CAPACITY_MASS]
         num_eng = self.options[Aircraft.Propulsion.TOTAL_NUM_ENGINES]
         num_eng_fact = distributed_engine_count_factor(num_eng)
-        max_mach = self.options[Mission.Constraints.MAX_MACH]
+        max_mach = self.options[Aircraft.Design.MAX_MACH]
 
         J[Aircraft.Fuel.FUEL_SYSTEM_MASS, Aircraft.Fuel.FUEL_SYSTEM_MASS_SCALER] = (
             1.07 * capacity**0.58 * num_eng_fact**0.43 * max_mach**0.34 / GRAV_ENGLISH_LBM

aviary/subsystems/mass/flops_based/hydraulics.py

@@ -18,7 +18,7 @@ class TransportHydraulicsGroupMass(om.ExplicitComponent):
     def initialize(self):
         add_aviary_option(self, Aircraft.Propulsion.TOTAL_NUM_FUSELAGE_ENGINES)
         add_aviary_option(self, Aircraft.Propulsion.TOTAL_NUM_WING_ENGINES)
-        add_aviary_option(self, Mission.Constraints.MAX_MACH)
+        add_aviary_option(self, Aircraft.Design.MAX_MACH)
 
     def setup(self):
         add_aviary_input(self, Aircraft.Fuselage.PLANFORM_AREA, units='ft**2')
@@ -43,7 +43,7 @@ def compute(self, inputs, outputs, discrete_inputs=None, discrete_outputs=None):
         scaler = inputs[Aircraft.Hydraulics.MASS_SCALER]
         area = inputs[Aircraft.Wing.AREA]
         var_sweep = inputs[Aircraft.Wing.VAR_SWEEP_MASS_PENALTY]
-        max_mach = self.options[Mission.Constraints.MAX_MACH]
+        max_mach = self.options[Aircraft.Design.MAX_MACH]
 
         if sys_press <= 0:
             # No hydraulic system (e.g. small electric UAVs): nothing to size.
@@ -72,7 +72,7 @@ def compute_partials(self, inputs, J):
         scaler = inputs[Aircraft.Hydraulics.MASS_SCALER]
         area = inputs[Aircraft.Wing.AREA]
         var_sweep = inputs[Aircraft.Wing.VAR_SWEEP_MASS_PENALTY]
-        max_mach = self.options[Mission.Constraints.MAX_MACH]
+        max_mach = self.options[Aircraft.Design.MAX_MACH]
 
         term1 = planform + 0.27 * area
         term2 = 1.0 + 0.03 * num_wing_eng_fact + 0.05 * num_fuse_eng_fact

aviary/subsystems/mass/flops_based/instruments.py

@@ -19,7 +19,7 @@ def initialize(self):
         add_aviary_option(self, Aircraft.CrewPayload.NUM_FLIGHT_CREW)
         add_aviary_option(self, Aircraft.Propulsion.TOTAL_NUM_FUSELAGE_ENGINES)
         add_aviary_option(self, Aircraft.Propulsion.TOTAL_NUM_WING_ENGINES)
-        add_aviary_option(self, Mission.Constraints.MAX_MACH)
+        add_aviary_option(self, Aircraft.Design.MAX_MACH)
 
     def setup(self):
         add_aviary_input(self, Aircraft.Fuselage.PLANFORM_AREA, units='ft**2')
@@ -37,7 +37,7 @@ def compute(self, inputs, outputs):
         num_fuse_eng_fact = distributed_engine_count_factor(num_fuse_eng)
 
         fuse_area = inputs[Aircraft.Fuselage.PLANFORM_AREA]
-        max_mach = self.options[Mission.Constraints.MAX_MACH]
+        max_mach = self.options[Aircraft.Design.MAX_MACH]
         mass_scaler = inputs[Aircraft.Instruments.MASS_SCALER]
 
         instrument_weight = (
@@ -57,7 +57,7 @@ def compute_partials(self, inputs, J):
         num_fuse_eng_fact = distributed_engine_count_factor(num_fuse_eng)
 
         fuse_area = inputs[Aircraft.Fuselage.PLANFORM_AREA]
-        max_mach = self.options[Mission.Constraints.MAX_MACH]
+        max_mach = self.options[Aircraft.Design.MAX_MACH]
         mass_scaler = inputs[Aircraft.Instruments.MASS_SCALER]
 
         fact = 10.0 + 2.5 * num_crew + num_wing_eng_fact + 1.5 * num_fuse_eng_fact

aviary/subsystems/mass/flops_based/passenger_service.py

@@ -21,7 +21,7 @@ def initialize(self):
         add_aviary_option(self, Aircraft.CrewPayload.Design.NUM_BUSINESS_CLASS)
         add_aviary_option(self, Aircraft.CrewPayload.Design.NUM_FIRST_CLASS)
         add_aviary_option(self, Aircraft.CrewPayload.Design.NUM_ECONOMY_CLASS)
-        add_aviary_option(self, Mission.Constraints.MAX_MACH)
+        add_aviary_option(self, Aircraft.Design.MAX_MACH)
 
     def setup(self):
         add_aviary_input(self, Aircraft.CrewPayload.PASSENGER_SERVICE_MASS_SCALER, units='unitless')
@@ -38,7 +38,7 @@ def compute(self, inputs, outputs, discrete_inputs=None, discrete_outputs=None):
         economy_class_count = self.options[Aircraft.CrewPayload.Design.NUM_ECONOMY_CLASS]
 
         design_range = inputs[Aircraft.Design.RANGE]
-        max_mach = self.options[Mission.Constraints.MAX_MACH]
+        max_mach = self.options[Aircraft.Design.MAX_MACH]
 
         passenger_service_mass_scaler = inputs[Aircraft.CrewPayload.PASSENGER_SERVICE_MASS_SCALER]
 
@@ -57,7 +57,7 @@ def compute_partials(self, inputs, J, discrete_inputs=None):
         economy_class_count = self.options[Aircraft.CrewPayload.Design.NUM_ECONOMY_CLASS]
 
         design_range = inputs[Aircraft.Design.RANGE]
-        max_mach = self.options[Mission.Constraints.MAX_MACH]
+        max_mach = self.options[Aircraft.Design.MAX_MACH]
 
         passenger_service_mass_scaler = inputs[Aircraft.CrewPayload.PASSENGER_SERVICE_MASS_SCALER]
 

aviary/subsystems/mass/flops_based/starter.py

@@ -21,7 +21,7 @@ class TransportStarterMass(om.ExplicitComponent):
     def initialize(self):
         add_aviary_option(self, Aircraft.Engine.NUM_ENGINES)
         add_aviary_option(self, Aircraft.Propulsion.TOTAL_NUM_ENGINES)
-        add_aviary_option(self, Mission.Constraints.MAX_MACH)
+        add_aviary_option(self, Aircraft.Design.MAX_MACH)
 
     def setup(self):
         num_engine_type = len(self.options[Aircraft.Engine.NUM_ENGINES])
@@ -39,7 +39,7 @@ def setup_partials(self):
     def compute(self, inputs, outputs):
         total_engines = self.options[Aircraft.Propulsion.TOTAL_NUM_ENGINES]
         num_engines = self.options[Aircraft.Engine.NUM_ENGINES]
-        max_mach = self.options[Mission.Constraints.MAX_MACH]
+        max_mach = self.options[Aircraft.Design.MAX_MACH]
 
         d_nacelle = inputs[Aircraft.Nacelle.AVG_DIAMETER]
         num_engines_factor = distributed_engine_count_factor(total_engines)
@@ -57,7 +57,7 @@ def compute(self, inputs, outputs):
     def compute_partials(self, inputs, J):
         total_engines = self.options[Aircraft.Propulsion.TOTAL_NUM_ENGINES]
         num_engines = self.options[Aircraft.Engine.NUM_ENGINES]
-        max_mach = self.options[Mission.Constraints.MAX_MACH]
+        max_mach = self.options[Aircraft.Design.MAX_MACH]
 
         d_nacelle = inputs[Aircraft.Nacelle.AVG_DIAMETER]
         eng_count_factor = distributed_engine_count_factor(total_engines)

aviary/subsystems/mass/flops_based/surface_controls.py

@@ -12,7 +12,7 @@ class SurfaceControlMass(om.ExplicitComponent):
     """
 
     def initialize(self):
-        add_aviary_option(self, Mission.Constraints.MAX_MACH)
+        add_aviary_option(self, Aircraft.Design.MAX_MACH)
 
     def setup(self):
         add_aviary_input(self, Aircraft.Wing.SURFACE_CONTROL_MASS_SCALER, units='unitless')
@@ -31,7 +31,7 @@ def setup(self):
 
     def compute(self, inputs, outputs):
         scaler = inputs[Aircraft.Wing.SURFACE_CONTROL_MASS_SCALER]
-        max_mach = self.options[Mission.Constraints.MAX_MACH]
+        max_mach = self.options[Aircraft.Design.MAX_MACH]
         gross_weight = inputs[Aircraft.Design.GROSS_MASS] * GRAV_ENGLISH_LBM
         flap_ratio = inputs[Aircraft.Wing.CONTROL_SURFACE_AREA_RATIO]
         wing_area = inputs[Aircraft.Wing.AREA]
@@ -48,7 +48,7 @@ def compute(self, inputs, outputs):
 
     def compute_partials(self, inputs, J):
         scaler = inputs[Aircraft.Wing.SURFACE_CONTROL_MASS_SCALER]
-        max_mach = self.options[Mission.Constraints.MAX_MACH]
+        max_mach = self.options[Aircraft.Design.MAX_MACH]
         gross_weight = inputs[Aircraft.Design.GROSS_MASS] * GRAV_ENGLISH_LBM
         flap_ratio = inputs[Aircraft.Wing.CONTROL_SURFACE_AREA_RATIO]
         wing_area = inputs[Aircraft.Wing.AREA]