Sea Level Density overhaul -> Requires OpenMDAO bugfix

.github/workflows/test_benchmarks.yml

@@ -38,7 +38,10 @@ jobs:
         with:
           NAME: 'latest'
           OPENMDAO_PIXI_ENVIRONMENT: 'py313'
-          OPENMDAO_INSTALL_FROM: 'pypi'
+          #OPENMDAO_INSTALL_FROM: 'pypi'
+          #OPENMDAO: ''
+          # Bug fix on dev.
+          OPENMDAO_INSTALL_FROM: 'github'
           OPENMDAO: ''
           SNOPT: '7.7'
           DYMOS: 'latest'

.github/workflows/test_docs.yml

@@ -38,7 +38,10 @@ jobs:
         with:
           NAME: 'latest'
           OPENMDAO_PIXI_ENVIRONMENT: 'py313'
-          OPENMDAO_INSTALL_FROM: 'pypi'
+          #OPENMDAO_INSTALL_FROM: 'pypi'
+          #OPENMDAO: ''
+          # Bug fix on dev.
+          OPENMDAO_INSTALL_FROM: 'github'
           OPENMDAO: ''
           SNOPT: '7.7'
           DYMOS: 'latest'

.github/workflows/test_workflow.yml

@@ -42,8 +42,11 @@ jobs:
           - NAME: oldest-supported
             OS: ubuntu-24.04
             OPENMDAO_PIXI_ENVIRONMENT: 'py311'
-            OPENMDAO_INSTALL_FROM: 'pypi'
-            OPENMDAO: '3.43.0'
+            #OPENMDAO_INSTALL_FROM: 'pypi'
+            #OPENMDAO: '3.43.0'
+            # Bug fix on dev.
+            OPENMDAO_INSTALL_FROM: 'github'
+            OPENMDAO: ''
             SNOPT: '7.7'
             DYMOS: '1.13.1'
             COVERAGE: true

aviary/api.py

@@ -59,8 +59,6 @@
     GRAV_ENGLISH_LBM,
     GRAV_METRIC_GASP,
     PSLS_PSF,
-    RHO_SEA_LEVEL_ENGLISH,
-    RHO_SEA_LEVEL_METRIC,
     TSLS_DEGR,
 )
 from aviary.subsystems.test.subsystem_tester import (

aviary/constants.py

@@ -31,10 +31,9 @@
 GRAV_METRIC_GASP = 9.81  # m/s^2
 GRAV_ENGLISH_GASP = 32.2  # ft/s^2
 GRAV_ENGLISH_LBM = 1.0  # lbf/lbm
-# See issue 1169 for the value of RHO_SEA_LEVEL_ENGLISH
-RHO_SEA_LEVEL_ENGLISH = 0.0023769  # slug/ft^3
-RHO_SEA_LEVEL_METRIC = 1.225  # kg/m^3
+
 # sea level standard pressure in psf
 PSLS_PSF = 2116.22
+
 # sea level standard temperature in deg R
 TSLS_DEGR = 518.67

aviary/interface/test/sizing_results_for_test.json

@@ -982,7 +982,7 @@
     ],
     [
         "aircraft:design:gross_mass",
-        175400.0,
+        175399.99999999997,
         "lbm",
         "<class 'float'>"
     ],
@@ -1136,9 +1136,15 @@
         "m/s**2",
         "<class 'float'>"
     ],
+    [
+        "mission:sea_level_density",
+        0.0023769,
+        "slug/ft**3",
+        "<class 'float'>"
+    ],
     [
         "mission:gross_mass",
-        175400.0,
+        175399.99999999997,
         "lbm",
         "<class 'float'>"
     ],
@@ -1154,4 +1160,4 @@
         "unitless",
         "<class 'bool'>"
     ]
-]
+]

aviary/interface/test/test_save_results.py

@@ -9,6 +9,7 @@
 from aviary.core.aviary_problem import reload_aviary_problem
 from aviary.models.missions.energy_state_default import phase_info, phase_info_parameterization
 from aviary.utils.functions import get_path
+from aviary.variable_info.variables import Mission
 
 
 @use_tempdirs
@@ -34,6 +35,8 @@ def test_save_json(self):
 
         # Preprocess inputs
         prob.check_and_preprocess_inputs()
+        prob.aviary_inputs.set_val(Mission.SEA_LEVEL_DENSITY, 0.0023769, units='slug/ft**3')
+
         prob.add_pre_mission_systems()
         prob.add_phases()
         prob.add_post_mission_systems()

aviary/mission/energy_state/phases/simplified_landing.py

@@ -1,14 +1,17 @@
 import openmdao.api as om
 
-from aviary.constants import GRAV_ENGLISH_LBM, RHO_SEA_LEVEL_ENGLISH
+from aviary.constants import GRAV_ENGLISH_LBM
 from aviary.subsystems.atmosphere.atmosphere import Atmosphere
-from aviary.variable_info.functions import add_aviary_input, add_aviary_output
+from aviary.variable_info.functions import add_aviary_input, add_aviary_option, add_aviary_output
 from aviary.variable_info.variables import Aircraft, Dynamic, Mission
 
 
 class LandingCalc(om.ExplicitComponent):
     """Calculate the distance covered over the ground and approach velocity during landing."""
 
+    def initialize(self):
+        add_aviary_option(self, Mission.SEA_LEVEL_DENSITY, units='slug/ft**3')
+
     def setup(self):
         add_aviary_input(self, Mission.FINAL_MASS, units='lbm')
         add_aviary_input(self, Dynamic.Atmosphere.DENSITY, units='slug/ft**3')
@@ -22,7 +25,8 @@ def setup(self):
         self.declare_partials(Mission.Landing.GROUND_DISTANCE, '*')
 
     def compute(self, inputs, outputs):
-        rho_SL = RHO_SEA_LEVEL_ENGLISH
+        rho_SL = self.options[Mission.SEA_LEVEL_DENSITY][0]
+
         landing_weight = inputs[Mission.FINAL_MASS] * GRAV_ENGLISH_LBM
         rho = inputs[Dynamic.Atmosphere.DENSITY]
         planform_area = inputs[Aircraft.Wing.AREA]
@@ -43,7 +47,7 @@ def compute(self, inputs, outputs):
         outputs[Mission.Landing.INITIAL_VELOCITY] = V_app
 
     def compute_partials(self, inputs, J):
-        rho_SL = RHO_SEA_LEVEL_ENGLISH
+        rho_SL = self.options[Mission.SEA_LEVEL_DENSITY][0]
         landing_weight = inputs[Mission.FINAL_MASS] * GRAV_ENGLISH_LBM
         rho = inputs[Dynamic.Atmosphere.DENSITY]
         planform_area = inputs[Aircraft.Wing.AREA]

aviary/mission/energy_state/phases/simplified_takeoff.py

@@ -1,8 +1,8 @@
 import openmdao.api as om
 
-from aviary.constants import GRAV_ENGLISH_LBM, RHO_SEA_LEVEL_METRIC
+from aviary.constants import GRAV_ENGLISH_LBM
 from aviary.subsystems.atmosphere.atmosphere import Atmosphere
-from aviary.variable_info.functions import add_aviary_input, add_aviary_output
+from aviary.variable_info.functions import add_aviary_input, add_aviary_option, add_aviary_output
 from aviary.variable_info.variables import Aircraft, Dynamic, Mission
 
 
@@ -87,6 +87,9 @@ class FinalTakeoffConditions(om.ExplicitComponent):
     final mass, and final altitude.
     """
 
+    def initialize(self):
+        add_aviary_option(self, Mission.SEA_LEVEL_DENSITY, units='kg/m**3')
+
     def setup(self):
         self.add_input(
             'v_stall',
@@ -151,7 +154,7 @@ def setup_partials(self):
         )
 
     def compute(self, inputs, outputs):
-        rho_SL = RHO_SEA_LEVEL_METRIC
+        rho_SL = self.options[Mission.SEA_LEVEL_DENSITY][0]
 
         v_stall = inputs['v_stall']
         gross_mass = inputs['mass']
@@ -195,7 +198,7 @@ def compute(self, inputs, outputs):
         outputs[Mission.Takeoff.FINAL_ALTITUDE] = 35
 
     def compute_partials(self, inputs, J):
-        rho_SL = RHO_SEA_LEVEL_METRIC
+        rho_SL = self.options[Mission.SEA_LEVEL_DENSITY][0]
 
         ramp_weight = inputs['mass'] * GRAV_ENGLISH_LBM
         rho = inputs[Dynamic.Atmosphere.DENSITY]

aviary/mission/energy_state/phases/test/test_building_landing.py

@@ -5,6 +5,8 @@
 from openmdao.utils.testing_utils import use_tempdirs
 
 from aviary.mission.energy_state.phases.build_landing import Landing
+from aviary.variable_info.functions import setup_model_options
+from aviary.variable_info.options import get_option_defaults
 from aviary.variable_info.variables import Aircraft, Mission
 
 
@@ -29,7 +31,12 @@ def test_case1(self):
             Mission.FINAL_MASS,
             val=150_000,
         )
+
+        options = get_option_defaults()
+        options.set_val(Mission.SEA_LEVEL_DENSITY, 0.0023769, units='slug/ft**3')
+        setup_model_options(prob, options)
         prob.run_model()
+
         partial_data = prob.check_partials(
             out_stream=None, method='cs', compact_print=False, excludes=['*atmosphere*']
         )

aviary/mission/energy_state/phases/test/test_building_takeoff.py

@@ -5,6 +5,8 @@
 from openmdao.utils.testing_utils import use_tempdirs
 
 from aviary.mission.energy_state.phases.build_takeoff import Takeoff
+from aviary.variable_info.functions import setup_model_options
+from aviary.variable_info.options import get_option_defaults
 from aviary.variable_info.variables import Aircraft, Mission
 
 
@@ -27,7 +29,12 @@ def test_case1(self):
         )
         prob.setup(force_alloc_complex=True)
         prob.set_val(Mission.Takeoff.LIFT_OVER_DRAG, 2)
+
+        options = get_option_defaults()
+        options.set_val(Mission.SEA_LEVEL_DENSITY, 0.0023769, units='slug/ft**3')
+        setup_model_options(prob, options)
         prob.run_model()
+
         partial_data = prob.check_partials(
             out_stream=None, method='cs', compact_print=False, excludes=['*atmosphere*']
         )

aviary/mission/energy_state/phases/test/test_simplified_landing.py

@@ -4,7 +4,6 @@
 from openmdao.utils.assert_utils import assert_check_partials, assert_near_equal
 from openmdao.utils.testing_utils import use_tempdirs
 
-from aviary import constants
 from aviary.mission.energy_state.phases.simplified_landing import LandingCalc, LandingGroup
 from aviary.variable_info.variables import Aircraft, Dynamic, Mission
 
@@ -22,9 +21,7 @@ def setUp(self):
         )
 
         self.prob.model.set_input_defaults(Mission.FINAL_MASS, val=152800.0, units='lbm')
-        self.prob.model.set_input_defaults(
-            Dynamic.Atmosphere.DENSITY, val=constants.RHO_SEA_LEVEL_METRIC, units='kg/m**3'
-        )
+        self.prob.model.set_input_defaults(Dynamic.Atmosphere.DENSITY, val=1.225, units='kg/m**3')
         self.prob.model.set_input_defaults(Aircraft.Wing.AREA, val=1370.0, units='ft**2')
         self.prob.model.set_input_defaults(
             Mission.Landing.LIFT_COEFFICIENT_MAX, val=3, units='unitless'

aviary/mission/energy_state/phases/test/test_simplified_takeoff.py

@@ -10,7 +10,6 @@
 from openmdao.utils.assert_utils import assert_check_partials, assert_near_equal
 from openmdao.utils.testing_utils import use_tempdirs
 
-from aviary import constants
 from aviary.mission.energy_state.phases.simplified_takeoff import (
     FinalTakeoffConditions,
     StallSpeed,
@@ -33,7 +32,7 @@ def setUp(self):
 
         self.prob.model.set_input_defaults('mass', val=181200.0, units='lbm')  # check
         self.prob.model.set_input_defaults(
-            Dynamic.Atmosphere.DENSITY, val=constants.RHO_SEA_LEVEL_METRIC, units='kg/m**3'
+            Dynamic.Atmosphere.DENSITY, val=1.225, units='kg/m**3'
         )  # check
         self.prob.model.set_input_defaults(
             'planform_area', val=1370.0, units='ft**2'
@@ -59,14 +58,21 @@ class FinalConditionsTest(unittest.TestCase):
 
     def setUp(self):
         self.prob = om.Problem()
-        self.prob.model.add_subsystem('comp', FinalTakeoffConditions(), promotes=['*'])
+        opts = {
+            Mission.SEA_LEVEL_DENSITY: (0.0023769, 'slug/ft**3'),
+        }
+        self.prob.model.add_subsystem(
+            'comp',
+            FinalTakeoffConditions(**opts),
+            promotes=['*'],
+        )
 
         self.prob.model.set_input_defaults('v_stall', val=100, units='m/s')  # not actual value
         self.prob.model.set_input_defaults('mass', val=181200.0, units='lbm')  # check
         self.prob.model.set_input_defaults(Mission.Takeoff.FUEL_MASS, val=577, units='lbm')  # check
         self.prob.model.set_input_defaults(
             Dynamic.Atmosphere.DENSITY,
-            val=constants.RHO_SEA_LEVEL_ENGLISH,
+            val=0.0023769,
             units='slug/ft**3',
         )  # check
         self.prob.model.set_input_defaults(Aircraft.Wing.AREA, val=1370.0, units='ft**2')  # check
@@ -127,7 +133,7 @@ def test_case1(self):
         prob.model.set_input_defaults(Mission.Takeoff.FUEL_MASS, val=577, units='lbm')  # check
         prob.model.set_input_defaults(
             Dynamic.Atmosphere.DENSITY,
-            val=constants.RHO_SEA_LEVEL_ENGLISH,
+            val=0.0023769,
             units='slug/ft**3',
         )  # check
         prob.model.set_input_defaults(Aircraft.Wing.AREA, val=1370.0, units='ft**2')  # check

aviary/mission/solved_two_dof/ode/test/test_unsteady_flight_conditions.py

@@ -5,7 +5,6 @@
 from openmdao.utils.assert_utils import assert_check_partials, assert_near_equal
 from openmdao.utils.testing_utils import use_tempdirs
 
-from aviary.constants import RHO_SEA_LEVEL_METRIC
 from aviary.mission.solved_two_dof.ode.unsteady_solved_flight_conditions import (
     UnsteadySolvedFlightConditions,
 )
@@ -68,7 +67,7 @@ def _test_unsteady_flight_conditions(self, ground_roll=False, input_speed_type=S
         tas = p.get_val(Dynamic.Mission.VELOCITY, units='m/s')
         sos = p.get_val(Dynamic.Atmosphere.SPEED_OF_SOUND, units='m/s')
         rho = p.get_val(Dynamic.Atmosphere.DENSITY, units='kg/m**3')
-        rho_sl = RHO_SEA_LEVEL_METRIC
+        rho_sl = 1.225  # kg/m**3
         dTAS_dt_approx = p.get_val('dTAS_dt_approx')
 
         assert_near_equal(mach, tas / sos)

aviary/mission/solved_two_dof/ode/unsteady_control_iter_group.py

@@ -1,7 +1,6 @@
 import numpy as np
 import openmdao.api as om
 
-from aviary.constants import RHO_SEA_LEVEL_ENGLISH
 from aviary.mission.solved_two_dof.ode.unsteady_solved_eom import UnsteadySolvedEOM
 from aviary.utils.aviary_values import AviaryValues
 from aviary.variable_info.variables import Dynamic
@@ -140,11 +139,6 @@ def setup(self):
 
         # Set common default values for promoted inputs
         onn = np.ones(nn)
-        self.set_input_defaults(
-            name=Dynamic.Atmosphere.DENSITY,
-            val=RHO_SEA_LEVEL_ENGLISH * onn,
-            units='slug/ft**3',
-        )
         self.set_input_defaults(
             name=Dynamic.Atmosphere.SPEED_OF_SOUND, val=1116.4 * onn, units='ft/s'
         )

aviary/mission/solved_two_dof/ode/unsteady_solved_flight_conditions.py

@@ -1,10 +1,9 @@
 import numpy as np
 import openmdao.api as om
-from aviary.variable_info.functions import add_aviary_input, add_aviary_output
+from aviary.variable_info.functions import add_aviary_input, add_aviary_option, add_aviary_output
 
-from aviary import constants
 from aviary.variable_info.enums import SpeedType
-from aviary.variable_info.variables import Dynamic
+from aviary.variable_info.variables import Dynamic, Mission
 
 
 class UnsteadySolvedFlightConditions(om.ExplicitComponent):
@@ -59,6 +58,7 @@ def initialize(self):
             'Removes altitude rate as an output and adjust '
             'the TAS rate equation.',
         )
+        add_aviary_option(self, Mission.SEA_LEVEL_DENSITY, units='kg/m**3')
 
     def setup(self):
         nn = self.options['num_nodes']
@@ -302,7 +302,7 @@ def compute(self, inputs, outputs):
         ground_roll = self.options['ground_roll']
 
         rho = inputs[Dynamic.Atmosphere.DENSITY]
-        rho_sl = constants.RHO_SEA_LEVEL_METRIC
+        rho_sl = self.options[Mission.SEA_LEVEL_DENSITY][0]
         sqrt_rho_rho_sl = np.sqrt(rho / rho_sl)
         sos = inputs[Dynamic.Atmosphere.SPEED_OF_SOUND]
 
@@ -345,7 +345,7 @@ def compute_partials(self, inputs, partials):
         ground_roll = self.options['ground_roll']
 
         rho = inputs[Dynamic.Atmosphere.DENSITY]
-        rho_sl = constants.RHO_SEA_LEVEL_METRIC
+        rho_sl = self.options[Mission.SEA_LEVEL_DENSITY][0]
         sqrt_rho_rho_sl = np.sqrt(rho / rho_sl)
         dsqrt_rho_rho_sl_drho = 0.5 / sqrt_rho_rho_sl / rho_sl
         sos = inputs[Dynamic.Atmosphere.SPEED_OF_SOUND]

aviary/mission/solved_two_dof/ode/unsteady_solved_ode.py

@@ -1,7 +1,6 @@
 import numpy as np
 import openmdao.api as om
 
-from aviary.constants import RHO_SEA_LEVEL_ENGLISH as rho_sl
 from aviary.mission.two_dof.ode.two_dof_ode import TwoDOFODE
 from aviary.mission.solved_two_dof.ode.gamma_comp import GammaComp
 from aviary.mission.solved_two_dof.ode.unsteady_solved_eom import UnsteadySolvedEOM
@@ -278,12 +277,6 @@ def setup(self):
         )
 
         onn = np.ones(nn)
-        self.set_input_defaults(
-            name=Dynamic.Atmosphere.DENSITY, val=rho_sl * onn, units='slug/ft**3'
-        )
-        self.set_input_defaults(
-            name=Dynamic.Atmosphere.SPEED_OF_SOUND, val=1116.4 * onn, units='ft/s'
-        )
         if not self.options['ground_roll']:
             self.set_input_defaults(
                 name=Dynamic.Mission.FLIGHT_PATH_ANGLE, val=0.0 * onn, units='rad'