SAWE standard applied to GASP mass buildup

aviary/core/aviary_group.py

@@ -260,7 +260,7 @@ def load_inputs(
 
         if phase_info is None:
             phase_info = self.configurator.get_default_phase_info(self)
-            if verbosity is not None and verbosity >= Verbosity.BRIEF:
+            if verbosity > Verbosity.BRIEF:  # VERBOSE, DEBUG
                 print(
                     f'Loaded default phase_info for {self.mission_method.value.lower()} equations '
                     'of motion.'

aviary/core/aviary_problem.py

@@ -785,12 +785,12 @@ def add_composite_objective(self, *args, ref: float = None):
             Example inputs can be any of the following:
             ('fuel')
             (Mission.FUEL)
-            (Mission.FUEL, Mission.Summary.CO2)
+            (Mission.FUEL, Mission.CO2)
             ('model1', Mission.FUEL)
             (Mission.FUEL, 1.0)
-            (Mission.FUEL, 1.0), (Mission.Summary.CO2, 2.0)
-            ('model1', Mission.FUEL), ('model2', Mission.Summary.CO2)
-            ('model1', Mission.FUEL, 1.0), ('model2', Mission.Summary.CO2, 2.0)
+            (Mission.FUEL, 1.0), (Mission.CO2, 2.0)
+            ('model1', Mission.FUEL), ('model2', Mission.CO2)
+            ('model1', Mission.FUEL, 1.0), ('model2', Mission.CO2, 2.0)
 
         ref : float, optional
             Reference value for the final objective for scaling.
@@ -866,7 +866,7 @@ def add_composite_objective(self, *args, ref: float = None):
             objectives.append((model, output, weight))
             # objectives = [
             # ('model1', Mission.FUEL, 1),
-            # ('model2', Mission.Summary.CO2, 1),
+            # ('model2', Mission.CO2, 1),
             #  ...
             # ]
 

aviary/docs/source_docs/phase_info_detailed.ipynb

@@ -95,7 +95,11 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
+   "metadata": {
+    "tags": [
+     "remove-input"
+    ]
+   },
    "outputs": [],
    "source": [
     "om.show_options_table(\n",
@@ -115,7 +119,11 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
+   "metadata": {
+    "tags": [
+     "remove-input"
+    ]
+   },
    "outputs": [],
    "source": [
     "om.show_options_table('aviary.mission.two_dof.phases.flight_phase.FlightPhaseOptions')"
@@ -133,7 +141,11 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
+   "metadata": {
+    "tags": [
+     "remove-input"
+    ]
+   },
    "outputs": [],
    "source": [
     "om.show_options_table('aviary.mission.two_dof.phases.simple_cruise_phase.SimpleCruisePhaseOptions')"
@@ -151,7 +163,11 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
+   "metadata": {
+    "tags": [
+     "remove-input"
+    ]
+   },
    "outputs": [],
    "source": [
     "om.show_options_table('aviary.mission.two_dof.phases.takeoff_phase.TakeoffPhaseOptions')"

aviary/models/aircraft/blended_wing_body/generic_BWB_GASP.csv

@@ -88,7 +88,7 @@ aircraft:hydraulics:gear_mass_coefficient,0.135,unitless
 aircraft:instruments:mass_coefficient,0.116,unitless
 aircraft:landing_gear:fixed_gear,False,unitless
 aircraft:landing_gear:main_gear_location,0,unitless
-aircraft:landing_gear:main_gear_mass_coefficient,0.85,unitless
+aircraft:landing_gear:main_gear_mass_fraction,0.85,unitless
 aircraft:landing_gear:mass_coefficient,0.052,unitless
 aircraft:landing_gear:tail_hook_mass_scaler,1,unitless
 aircraft:landing_gear:total_mass_scaler,1,unitless

aviary/models/aircraft/large_single_aisle_1/V3_bug_fixed_IO.py

@@ -112,7 +112,7 @@
 V3_bug_fixed_options.set_val(Aircraft.Controls.CONTROL_MASS_INCREMENT, val=0, units='lbm')
 V3_bug_fixed_options.set_val(Aircraft.LandingGear.MASS_COEFFICIENT, val=0.04, units='unitless')
 V3_bug_fixed_options.set_val(
-    Aircraft.LandingGear.MAIN_GEAR_MASS_COEFFICIENT, val=0.85, units='unitless'
+    Aircraft.LandingGear.MAIN_GEAR_MASS_FRACTION, val=0.85, units='unitless'
 )
 V3_bug_fixed_options.set_val(Aircraft.Nacelle.CLEARANCE_RATIO, val=0.2, units='unitless')
 V3_bug_fixed_options.set_val(Aircraft.Engine.MASS_SPECIFIC, val=0.21366, units='lbm/lbf')

aviary/models/aircraft/large_single_aisle_1/large_single_aisle_1_GASP.csv

@@ -73,7 +73,7 @@ aircraft:hydraulics:gear_mass_coefficient,0.14,unitless
 aircraft:instruments:mass_coefficient,0.0736,unitless
 aircraft:landing_gear:fixed_gear,False,unitless
 aircraft:landing_gear:main_gear_location,0.15,unitless
-aircraft:landing_gear:main_gear_mass_coefficient,0.85,unitless
+aircraft:landing_gear:main_gear_mass_fraction,0.85,unitless
 aircraft:landing_gear:mass_coefficient,0.04,unitless
 aircraft:landing_gear:tail_hook_mass_scaler,1,unitless
 aircraft:landing_gear:total_mass_scaler,1,unitless

aviary/models/aircraft/large_turboprop_freighter/large_turboprop_freighter_GASP.csv

@@ -112,7 +112,7 @@ aircraft:horizontal_tail:volume_coefficient, 0.8614, unitless
 # Landing Gear
 aircraft:landing_gear:fixed_gear, False, unitless
 aircraft:landing_gear:main_gear_location, 0, unitless
-aircraft:landing_gear:main_gear_mass_coefficient, 0.916, unitless
+aircraft:landing_gear:main_gear_mass_fraction, 0.916, unitless
 aircraft:landing_gear:mass_coefficient, 0.0337, unitless
 aircraft:landing_gear:tail_hook_mass_scaler, 1, unitless
 aircraft:landing_gear:total_mass_scaler, 1, unitless

aviary/models/aircraft/small_single_aisle/small_single_aisle_GASP.csv

@@ -74,7 +74,7 @@ aircraft:hydraulics:gear_mass_coefficient,0.14,unitless
 aircraft:instruments:mass_coefficient,0.06,unitless
 aircraft:landing_gear:fixed_gear,False,unitless
 aircraft:landing_gear:main_gear_location,0.199,unitless
-aircraft:landing_gear:main_gear_mass_coefficient,0.85,unitless
+aircraft:landing_gear:main_gear_mass_fraction,0.85,unitless
 aircraft:landing_gear:mass_coefficient,0.036,unitless
 aircraft:landing_gear:tail_hook_mass_scaler,1,unitless
 aircraft:landing_gear:total_mass_scaler,1,unitless

aviary/models/aircraft/test_aircraft/aircraft_for_bench_FwGm.csv

@@ -72,7 +72,7 @@ aircraft:horizontal_tail:vertical_tail_mount_location,0.0,unitless
 aircraft:horizontal_tail:volume_coefficient,1.189,unitless
 aircraft:landing_gear:fixed_gear,False,unitless
 aircraft:landing_gear:main_gear_location,0.15,unitless
-aircraft:landing_gear:main_gear_mass_coefficient,0.85,unitless
+aircraft:landing_gear:main_gear_mass_fraction,0.85,unitless
 aircraft:landing_gear:mass_coefficient,0.04,unitless
 aircraft:landing_gear:tail_hook_mass_scaler,1,unitless
 aircraft:landing_gear:total_mass_scaler,1,unitless

aviary/models/aircraft/test_aircraft/aircraft_for_bench_GwFm.csv

@@ -77,7 +77,7 @@ aircraft:hydraulics:gear_mass_coefficient,0.14,unitless
 aircraft:instruments:mass_coefficient,0.0736,unitless
 aircraft:landing_gear:fixed_gear,False,unitless
 aircraft:landing_gear:main_gear_location,0.15,unitless
-aircraft:landing_gear:main_gear_mass_coefficient,0.85,unitless
+aircraft:landing_gear:main_gear_mass_fraction,0.85,unitless
 aircraft:landing_gear:mass_coefficient,0.04,unitless
 aircraft:landing_gear:tail_hook_mass_scaler,1,unitless
 aircraft:landing_gear:total_mass_scaler,1,unitless

aviary/models/aircraft/test_aircraft/aircraft_for_bench_GwGm.csv

@@ -77,7 +77,7 @@ aircraft:hydraulics:gear_mass_coefficient,0.14,unitless
 aircraft:instruments:mass_coefficient,0.0736,unitless
 aircraft:landing_gear:fixed_gear,False,unitless
 aircraft:landing_gear:main_gear_location,0.15,unitless
-aircraft:landing_gear:main_gear_mass_coefficient,0.85,unitless
+aircraft:landing_gear:main_gear_mass_fraction,0.85,unitless
 aircraft:landing_gear:mass_coefficient,0.04,unitless
 aircraft:landing_gear:tail_hook_mass_scaler,1,unitless
 aircraft:landing_gear:total_mass_scaler,1,unitless

aviary/models/aircraft/test_aircraft/configuration_test_GASP.csv

@@ -74,7 +74,7 @@ aircraft:hydraulics:gear_mass_coefficient,0.105,unitless
 aircraft:instruments:mass_coefficient,0.0736,unitless
 aircraft:landing_gear:fixed_gear,False,unitless
 aircraft:landing_gear:main_gear_location,0,unitless
-aircraft:landing_gear:main_gear_mass_coefficient,0.85,unitless
+aircraft:landing_gear:main_gear_mass_fraction,0.85,unitless
 aircraft:landing_gear:mass_coefficient,0.0339,unitless
 aircraft:landing_gear:tail_hook_mass_scaler,1,unitless
 aircraft:landing_gear:total_mass_scaler,1,unitless

aviary/subsystems/mass/flops_based/fuel_capacity.py

@@ -1,8 +1,9 @@
 import openmdao.api as om
+from openmdao.utils.units import convert_units
 
+from aviary.constants import GRAV_ENGLISH_LBM
 from aviary.variable_info.functions import add_aviary_input, add_aviary_output
 from aviary.variable_info.variables import Aircraft
-from openmdao.utils.units import convert_units
 
 
 class FuelCapacityGroup(om.Group):
@@ -117,7 +118,7 @@ class WingFuelCapacity(om.ExplicitComponent):
     """Compute the maximum fuel that can be carried in the wing's enclosed space."""
 
     def setup(self):
-        add_aviary_input(self, Aircraft.Fuel.DENSITY, units='lbm/galUS')
+        add_aviary_input(self, Aircraft.Fuel.DENSITY, units='lbm/ft**3')
         add_aviary_input(self, Aircraft.Fuel.WING_REF_CAPACITY, units='lbm')
         add_aviary_input(self, Aircraft.Fuel.WING_REF_CAPACITY_AREA, units='unitless')
         add_aviary_input(self, Aircraft.Fuel.WING_REF_CAPACITY_TERM_A, units='unitless')
@@ -149,7 +150,7 @@ def compute(self, inputs, outputs):
             )
 
         else:
-            fuel_density = convert_units(inputs[Aircraft.Fuel.DENSITY], 'lbm/galUS', 'lbm/ft**3')
+            fuel_density = inputs[Aircraft.Fuel.DENSITY] * GRAV_ENGLISH_LBM
             volume_fraction = inputs[Aircraft.Fuel.WING_FUEL_FRACTION]
             span = inputs[Aircraft.Wing.SPAN]
             taper_ratio = inputs[Aircraft.Wing.TAPER_RATIO]
@@ -193,7 +194,7 @@ def compute_partials(self, inputs, partials):
             )
 
         else:
-            fuel_density = convert_units(inputs[Aircraft.Fuel.DENSITY], 'lbm/galUS', 'lbm/ft**3')
+            fuel_density = inputs[Aircraft.Fuel.DENSITY] * GRAV_ENGLISH_LBM
             volume_fraction = inputs[Aircraft.Fuel.WING_FUEL_FRACTION]
             span = inputs[Aircraft.Wing.SPAN]
             taper_ratio = inputs[Aircraft.Wing.TAPER_RATIO]
@@ -203,10 +204,9 @@ def compute_partials(self, inputs, partials):
             tr_fact = 1.0 - taper_ratio / den**2
             dfact = -1.0 / den**2 + 2.0 * taper_ratio / den**3
 
-            conversion_factor = convert_units(1.0, 'lbm/galUS', 'lbm/ft**3')
             partials[Aircraft.Fuel.WING_FUEL_CAPACITY, Aircraft.Fuel.DENSITY] = (
                 volume_fraction * (2 / 3) * wing_area**2 * thickness_to_chord * tr_fact / span
-            ) * conversion_factor
+            )
 
             partials[Aircraft.Fuel.WING_FUEL_CAPACITY, Aircraft.Fuel.WING_FUEL_FRACTION] = (
                 fuel_density * (2 / 3) * wing_area**2 * thickness_to_chord * tr_fact / span

aviary/subsystems/mass/flops_based/mass_premission.py

@@ -325,3 +325,5 @@ def setup(self):
         self.add_subsystem(
             'mass_summation', MassSummation(), promotes_inputs=['*'], promotes_outputs=['*']
         )
+
+        self.set_input_defaults(Aircraft.Fuel.DENSITY, val=6.7, units='lbm/galUS')

aviary/subsystems/mass/flops_based/mass_summation.py

@@ -280,6 +280,7 @@ def initialize(self):
     def setup(self):
         alt_mass = self.options[Aircraft.Design.USE_ALT_MASS]
 
+        # Empty mass margin is calculated here to avoid feedback loop
         self.add_subsystem(
             'empty_mass_margin', EmptyMassMargin(), promotes_inputs=['*'], promotes_outputs=['*']
         )

aviary/subsystems/mass/gasp_based/air_conditioning.py

@@ -6,9 +6,7 @@
 
 
 class ACMass(om.ExplicitComponent):
-    """
-    Computation of air conditioning mass.
-    """
+    """Computation of air conditioning mass."""
 
     def setup(self):
         add_aviary_input(self, Aircraft.AirConditioning.MASS_COEFFICIENT, units='unitless')
@@ -97,9 +95,7 @@ def compute_partials(self, inputs, J):
 
 
 class BWBACMass(om.ExplicitComponent):
-    """
-    Computation of air conditioning mass for BWB
-    """
+    """Computation of air conditioning mass for BWB."""
 
     def setup(self):
         add_aviary_input(self, Aircraft.AirConditioning.MASS_COEFFICIENT, units='unitless')

aviary/subsystems/mass/gasp_based/anti_icing.py

@@ -1,7 +1,6 @@
 import openmdao.api as om
 
 from aviary.constants import GRAV_ENGLISH_LBM
-
 from aviary.variable_info.functions import add_aviary_input, add_aviary_option, add_aviary_output
 from aviary.variable_info.variables import Aircraft
 

aviary/subsystems/mass/gasp_based/apu.py

@@ -1,10 +1,9 @@
 import openmdao.api as om
 
+from aviary.constants import GRAV_ENGLISH_LBM
 from aviary.variable_info.functions import add_aviary_option, add_aviary_output
 from aviary.variable_info.variables import Aircraft
 
-from aviary.constants import GRAV_ENGLISH_LBM
-
 
 class APUMass(om.ExplicitComponent):
     """

aviary/subsystems/mass/gasp_based/cargo.py → aviary/subsystems/mass/gasp_based/cargo_containers.py

@@ -6,14 +6,13 @@
 
 import openmdao.api as om
 
+from aviary.constants import GRAV_ENGLISH_LBM
 from aviary.variable_info.functions import add_aviary_option, add_aviary_output
 from aviary.variable_info.variables import Aircraft
 
-from aviary.constants import GRAV_ENGLISH_LBM
-
 
-class CargoMass(om.ExplicitComponent):
-    """Calculate the mass of any passengers, their baggage, and other cargo."""
+class CargoContainerMass(om.ExplicitComponent):
+    """Calculate the mass of cargo containers."""
 
     def initialize(self):
         add_aviary_option(self, Aircraft.CrewPayload.Design.NUM_PASSENGERS)

aviary/subsystems/mass/gasp_based/crew.py

@@ -1,18 +1,18 @@
 """
-Define utilities to calculate the estimated mass of the crew (both flight and
-non-flight) as well as their baggage.
+Define utilities to calculate the estimated mass of the crew (both flight and  cabin) as well as
+their baggage.
 """
 
 import openmdao.api as om
 
+from aviary.constants import GRAV_ENGLISH_LBM
 from aviary.variable_info.enums import GASPEngineType
 from aviary.variable_info.functions import add_aviary_input, add_aviary_option, add_aviary_output
 from aviary.variable_info.variables import Aircraft
-from aviary.constants import GRAV_ENGLISH_LBM
 
 
-class NonFlightCrewMass(om.ExplicitComponent):
-    """Calculate the estimated mass for the non-flight and their baggage."""
+class CabinCrewMass(om.ExplicitComponent):
+    """Calculate the estimated mass for the cabin crew and their baggage."""
 
     def initialize(self):
         add_aviary_option(self, Aircraft.Engine.TYPE)

aviary/subsystems/mass/gasp_based/design_load.py

@@ -2,7 +2,7 @@
 import openmdao.api as om
 
 from aviary.constants import RHO_SEA_LEVEL_ENGLISH
-from aviary.utils.math import sigmoidX, dSigmoidXdx
+from aviary.utils.math import dSigmoidXdx, sigmoidX
 from aviary.variable_info.enums import Verbosity
 from aviary.variable_info.functions import add_aviary_input, add_aviary_option, add_aviary_output
 from aviary.variable_info.variables import Aircraft, Mission, Settings
@@ -1139,9 +1139,7 @@ def compute_partials(self, inputs, partials):
 
 
 class DesignLoadGroup(om.Group):
-    """
-    Design load group for GASP-based tube and wing type aircraft mass.
-    """
+    """Design load group for GASP-based tube and wing type aircraft mass."""
 
     def setup(self):
         self.add_subsystem(
@@ -2200,9 +2198,7 @@ def compute_partials(self, inputs, partials):
 
 
 class BWBDesignLoadGroup(om.Group):
-    """
-    Design load group for GASP-based BWB type aircraft mass.
-    """
+    """Design load group for GASP-based BWB type aircraft mass."""
 
     def setup(self):
         self.add_subsystem(

aviary/subsystems/mass/gasp_based/emergency_equipment.py

@@ -4,11 +4,10 @@
 
 import openmdao.api as om
 
+from aviary.constants import GRAV_ENGLISH_LBM
 from aviary.variable_info.functions import add_aviary_option, add_aviary_output
 from aviary.variable_info.variables import Aircraft
 
-from aviary.constants import GRAV_ENGLISH_LBM
-
 
 class EmergencyEquipment(om.ExplicitComponent):
     """

aviary/subsystems/mass/gasp_based/engine_oil.py

@@ -1,10 +1,9 @@
 import openmdao.api as om
 
+from aviary.constants import GRAV_ENGLISH_LBM
 from aviary.variable_info.enums import GASPEngineType, Verbosity
-from aviary.variable_info.variables import Aircraft, Settings
 from aviary.variable_info.functions import add_aviary_input, add_aviary_option, add_aviary_output
-
-from aviary.constants import GRAV_ENGLISH_LBM
+from aviary.variable_info.variables import Aircraft, Settings
 
 
 class EngineOilMass(om.ExplicitComponent):