Move Aircraft.Fuselage.FORM_FACTOR to premission

aviary/docs/theory_guide/gasp_based_bwb.ipynb

@@ -319,18 +319,20 @@
     "    AeroGeom,\n",
     "    BWBAeroSetup,\n",
     "    BWBBodyLiftCurveSlope,\n",
-    "    BWBFormFactorAndSIWB,\n",
+    "    BWBSIWB,\n",
     "    BWBLiftCoeff,\n",
     "    BWBLiftCoeffClean,\n",
     "    CruiseAero,\n",
     "    LowSpeedAero,\n",
     "    Xlifts,\n",
     ")\n",
+    "from aviary.subsystems.aerodynamics.gasp_based.gasp_aero_coeffs import BWBFormFactor\n",
     "from aviary.subsystems.aerodynamics.gasp_based.table_based import TabularCruiseAero\n",
     "from aviary.utils.doctape import get_all_non_aviary_names, get_variable_name, glue_variable\n",
     "\n",
     "glue_variable(get_variable_name(BWBBodyLiftCurveSlope), md_code=True)\n",
-    "glue_variable(get_variable_name(BWBFormFactorAndSIWB), md_code=True)\n",
+    "glue_variable(get_variable_name(BWBFormFactor), md_code=True)\n",
+    "glue_variable(get_variable_name(BWBSIWB), md_code=True)\n",
     "glue_variable(get_variable_name(BWBAeroSetup), md_code=True)\n",
     "glue_variable(get_variable_name(BWBLiftCoeff), md_code=True)\n",
     "glue_variable(get_variable_name(BWBLiftCoeffClean), md_code=True)\n",
@@ -366,7 +368,8 @@
     "This feature implements GASP aerodynamics subsystems for BWB aircraft. Five new components are added:\n",
     "\n",
     "- {glue:md}`BWBBodyLiftCurveSlope`\n",
-    "- {glue:md}`BWBFormFactorAndSIWB`\n",
+    "- {glue:md}`BWBFormFactor`\n",
+    "- {glue:md}`BWBSIWB`\n",
     "- {glue:md}`BWBAeroSetup`\n",
     "- {glue:md}`BWBLiftCoeff`\n",
     "- {glue:md}`BWBLiftCoeffClean`\n",

aviary/docs/user_guide_unreviewed/subsystems/blended_wing_body_GASP.ipynb

@@ -223,7 +223,7 @@
     "    BWBBodyLiftCurveSlope,\n",
     "    AeroGeom,\n",
     "    AeroSetup,\n",
-    "    FormFactorAndSIWB,\n",
+    "    SIWB,\n",
     "    UFac,\n",
     "    BWBBodyLiftCurveSlope,\n",
     ")\n",
@@ -240,7 +240,7 @@
     "[cl, cd] = get_all_non_aviary_names(AeroForces, include_in_out='in')\n",
     "glue_variable('CL', cl, md_code=True)\n",
     "glue_variable('CD', cd, md_code=True)\n",
-    "siwb = get_all_non_aviary_names(FormFactorAndSIWB)[0]\n",
+    "siwb = get_all_non_aviary_names(SIWB)[0]\n",
     "glue_variable('siwb', siwb, md_code=True)\n",
     "ufac = get_all_non_aviary_names(UFac, include_in_out='out')[0]\n",
     "glue_variable('ufac', ufac, md_code=True)\n",

aviary/mission/two_dof/ode/params.py

@@ -124,7 +124,7 @@ def promote_params(sys, trajs=None, phases=None):
     Aircraft.Wing.VERTICAL_MOUNT_LOCATION: dict(units='unitless', val=0),
     Aircraft.Design.STATIC_MARGIN: dict(units='unitless', val=0.03),
     Aircraft.Design.CG_DELTA: dict(units='unitless', val=0.25),
-    Aircraft.Fuselage.FORM_FACTOR: dict(units='unitless', val=1.25),
+    Aircraft.Fuselage.FORM_FACTOR: dict(units='unitless', val=1.05557953),
     Aircraft.Nacelle.FORM_FACTOR: dict(units='unitless', val=1.5),
     Aircraft.Wing.FUSELAGE_INTERFERENCE_FACTOR: dict(units='unitless', val=1.1),
     Aircraft.Design.DRAG_COEFFICIENT_INCREMENT: dict(units='unitless', val=0.00175),

aviary/mission/two_dof/ode/test/test_breguet_cruise_ode.py

@@ -48,6 +48,7 @@ def test_cruise(self):
         self.prob.set_val(Aircraft.Wing.FORM_FACTOR, 1.25)
         self.prob.set_val(Aircraft.VerticalTail.FORM_FACTOR, 1.25)
         self.prob.set_val(Aircraft.HorizontalTail.FORM_FACTOR, 1.25)
+        self.prob.set_val(Aircraft.Fuselage.FORM_FACTOR, 1.05557953)
 
         set_params_for_unit_tests(self.prob)
 

aviary/mission/two_dof/ode/test/test_flight_ode.py

@@ -61,6 +61,7 @@ def test_start_of_climb(self):
         self.prob.set_val(Aircraft.HorizontalTail.FORM_FACTOR, 1.25)
 
         set_params_for_unit_tests(self.prob)
+        self.prob.set_val(Aircraft.Fuselage.FORM_FACTOR, 1.05557953)
 
         self.prob.run_model()
 
@@ -107,6 +108,7 @@ def test_end_of_climb(self):
         self.prob.set_val(Aircraft.HorizontalTail.FORM_FACTOR, 1.25)
 
         set_params_for_unit_tests(self.prob)
+        self.prob.set_val(Aircraft.Fuselage.FORM_FACTOR, 1.05557953)
 
         self.prob.run_model()
 
@@ -217,6 +219,7 @@ def test_low_alt(self):
         self.prob.set_val(Aircraft.HorizontalTail.FORM_FACTOR, 1.25)
 
         set_params_for_unit_tests(self.prob)
+        self.prob.set_val(Aircraft.Fuselage.FORM_FACTOR, 1.05557953)
 
         self.prob.run_model()
 

aviary/mission/two_dof/ode/test/test_flight_path_ode.py

@@ -49,6 +49,7 @@ def test_case1(self):
         self.prob.set_val(Aircraft.Wing.FORM_FACTOR, 1.25)
         self.prob.set_val(Aircraft.VerticalTail.FORM_FACTOR, 1.25)
         self.prob.set_val(Aircraft.HorizontalTail.FORM_FACTOR, 1.25)
+        self.prob.set_val(Aircraft.Fuselage.FORM_FACTOR, 1.05557953)
 
         self.prob.run_model()
         testvals = {

aviary/mission/two_dof/ode/test/test_takeoff_ode.py

@@ -49,6 +49,7 @@ def test_groundroll_partials(self):
         self.prob.set_val(Aircraft.Wing.FORM_FACTOR, 1.25)
         self.prob.set_val(Aircraft.VerticalTail.FORM_FACTOR, 1.25)
         self.prob.set_val(Aircraft.HorizontalTail.FORM_FACTOR, 1.25)
+        self.prob.set_val(Aircraft.Fuselage.FORM_FACTOR, 1.05557953)
         self.prob.set_val(Dynamic.Mission.VELOCITY, [75, 150], units='kn')
         self.prob.set_val(Dynamic.Vehicle.MASS, [100000, 100000], units='lbm')
 
@@ -105,6 +106,7 @@ def test_rotation_partials(self):
         self.prob.set_val(Aircraft.Wing.FORM_FACTOR, 1.25)
         self.prob.set_val(Aircraft.VerticalTail.FORM_FACTOR, 1.25)
         self.prob.set_val(Aircraft.HorizontalTail.FORM_FACTOR, 1.25)
+        self.prob.set_val(Aircraft.Fuselage.FORM_FACTOR, 1.05557953)
 
         set_params_for_unit_tests(self.prob)
 

aviary/models/aircraft/test_aircraft/aircraft_for_bench_FwGm.csv

@@ -52,7 +52,7 @@ aircraft:fuel:wing_fuel_fraction,0.6,unitless
 aircraft:fuselage:aisle_width,24,inch
 aircraft:fuselage:delta_diameter,4.5,ft
 aircraft:fuselage:flat_plate_area_increment,0.25,ft**2
-aircraft:fuselage:form_factor,1.25,unitless
+aircraft:fuselage:form_factor,1.05557953,unitless
 aircraft:fuselage:mass_coefficient,128,unitless
 aircraft:fuselage:nose_fineness,1,unitless
 aircraft:fuselage:num_aisles,1,unitless

aviary/models/aircraft/test_aircraft/aircraft_for_bench_GwGm.csv

@@ -54,7 +54,6 @@ aircraft:furnishings:mass,11192,lbm
 aircraft:fuselage:aisle_width,24,inch
 aircraft:fuselage:delta_diameter,4.5,ft
 aircraft:fuselage:flat_plate_area_increment,0.25,ft**2
-aircraft:fuselage:form_factor,1.25,unitless
 aircraft:fuselage:mass_coefficient,128,unitless
 aircraft:fuselage:nose_fineness,1,unitless
 aircraft:fuselage:num_aisles,1,unitless

aviary/subsystems/aerodynamics/aerodynamics_builder.py

@@ -786,6 +786,7 @@ def report(self, prob, reports_folder, **kwargs):
     Aircraft.Fuselage.FLAT_PLATE_AREA_INCREMENT,
     Aircraft.Fuselage.LENGTH,
     Aircraft.Fuselage.WETTED_AREA,
+    Aircraft.Fuselage.FORM_FACTOR,
     Aircraft.HorizontalTail.AREA,
     Aircraft.HorizontalTail.AVERAGE_CHORD,
     Aircraft.HorizontalTail.FORM_FACTOR,

aviary/subsystems/aerodynamics/gasp_based/gasp_aero_coeffs.py

@@ -1,8 +1,10 @@
+import warnings
 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.variables import Aircraft, Mission
+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, Settings
 
 SWETFCT = 1.02
 
@@ -181,3 +183,121 @@ def compute_partials(self, inputs, J):
 
         J[Aircraft.Nacelle.FORM_FACTOR, Aircraft.Nacelle.AVG_DIAMETER] = 1.5 * 0.35 / xln
         J[Aircraft.Nacelle.FORM_FACTOR, Aircraft.Nacelle.AVG_LENGTH] = -1.5 * 0.35 * dbarn / xln**2
+
+
+class FormFactor(om.ExplicitComponent):
+    """
+    Compute body form factor
+    Incompressible form factor for streamlined bodies. From Hoerner's "Fluid Dynamic Drag", p. 6-17.
+    """
+
+    def initialize(self):
+        add_aviary_option(self, Settings.VERBOSITY)
+
+    def setup(self):
+        add_aviary_input(self, Aircraft.Fuselage.AVG_DIAMETER, units='ft', desc='SWF')
+        add_aviary_input(self, Aircraft.Fuselage.LENGTH, units='ft', desc='ELF')
+
+        add_aviary_output(
+            self,
+            Aircraft.Fuselage.FORM_FACTOR,
+            units='unitless',
+            desc='FFFUS: fuselage form factor',
+        )
+
+    def setup_partials(self):
+        self.declare_partials(
+            Aircraft.Fuselage.FORM_FACTOR,
+            [
+                Aircraft.Fuselage.AVG_DIAMETER,
+                Aircraft.Fuselage.LENGTH,
+            ],
+        )
+
+    def compute(self, inputs, outputs):
+        verbosity = self.options[Settings.VERBOSITY]
+
+        fus_len = inputs[Aircraft.Fuselage.LENGTH]
+        cabin_width = inputs[Aircraft.Fuselage.AVG_DIAMETER]
+
+        if fus_len == 0.0:
+            if verbosity > Verbosity.BRIEF:
+                warnings.warn('Aircraft.Fuselage.LENGTH should not be 0.0 in FormFactor.')
+
+        # fuselage form drag factor
+        fffus = 1 + 1.5 * (cabin_width / fus_len) ** 1.5 + 7 * (cabin_width / fus_len) ** 3
+        outputs[Aircraft.Fuselage.FORM_FACTOR] = fffus
+
+    def compute_partials(self, inputs, J):
+        fus_len = inputs[Aircraft.Fuselage.LENGTH]
+        cabin_width = inputs[Aircraft.Fuselage.AVG_DIAMETER]
+
+        dfffus_dcabin_width = (
+            2.25 * (cabin_width / fus_len) ** 0.5 / fus_len
+            + 21 * (cabin_width / fus_len) ** 2.0 / fus_len
+        )
+        dfffus_dfus_len = (
+            -2.25 * (cabin_width / fus_len) ** 0.5 * cabin_width / fus_len**2.0
+            - 21.0 * (cabin_width / fus_len) ** 2.0 * cabin_width / fus_len**2.0
+        )
+
+        J[Aircraft.Fuselage.FORM_FACTOR, Aircraft.Fuselage.AVG_DIAMETER] = dfffus_dcabin_width
+        J[Aircraft.Fuselage.FORM_FACTOR, Aircraft.Fuselage.LENGTH] = dfffus_dfus_len
+
+
+class BWBFormFactor(om.ExplicitComponent):
+    """
+    Compute body form factor and SIWB for BWB aircraft
+    Incompressible form factor for streamlined bodies. From Hoerner's "Fluid Dynamic Drag", p. 6-17.
+    """
+
+    def initialize(self):
+        add_aviary_option(self, Settings.VERBOSITY)
+
+    def setup(self):
+        add_aviary_input(self, Aircraft.Fuselage.HYDRAULIC_DIAMETER, units='ft', desc='DHYDRAL')
+        add_aviary_input(self, Aircraft.Fuselage.LENGTH, units='ft', desc='ELF')
+
+        self.add_output(
+            Aircraft.Fuselage.FORM_FACTOR,
+            units='unitless',
+            desc='FFFUS: fuselage form factor',
+        )
+
+    def setup_partials(self):
+        self.declare_partials(
+            Aircraft.Fuselage.FORM_FACTOR,
+            [
+                Aircraft.Fuselage.HYDRAULIC_DIAMETER,
+                Aircraft.Fuselage.LENGTH,
+            ],
+        )
+
+    def compute(self, inputs, outputs):
+        verbosity = self.options[Settings.VERBOSITY]
+
+        fus_len = inputs[Aircraft.Fuselage.LENGTH]
+        diam = inputs[Aircraft.Fuselage.HYDRAULIC_DIAMETER]
+
+        if fus_len == 0.0:
+            if verbosity > Verbosity.BRIEF:
+                warnings.warn('Aircraft.Fuselage.LENGTH should not be 0.0 in BWBFormFactor.')
+
+        # fuselage form drag factor
+        fffus = 1 + 1.5 * (diam / fus_len) ** 1.5 + 7 * (diam / fus_len) ** 3
+        outputs[Aircraft.Fuselage.FORM_FACTOR] = fffus
+
+    def compute_partials(self, inputs, J):
+        fus_len = inputs[Aircraft.Fuselage.LENGTH]
+        diam = inputs[Aircraft.Fuselage.HYDRAULIC_DIAMETER]
+
+        dfffus_ddiam = (
+            2.25 * (diam / fus_len) ** 0.5 / fus_len + 21 * (diam / fus_len) ** 2.0 / fus_len
+        )
+        dfffus_dfus_len = (
+            -2.25 * (diam / fus_len) ** 0.5 * diam / fus_len**2.0
+            - 21.0 * (diam / fus_len) ** 2.0 * diam / fus_len**2.0
+        )
+
+        J[Aircraft.Fuselage.FORM_FACTOR, Aircraft.Fuselage.HYDRAULIC_DIAMETER] = dfffus_ddiam
+        J[Aircraft.Fuselage.FORM_FACTOR, Aircraft.Fuselage.LENGTH] = dfffus_dfus_len