Merge branch 'main' of github.com:mdolab/OpenAeroStruct into mesh_gen

.readthedocs.yaml

@@ -13,4 +13,3 @@ python:
       path: .
       extra_requirements:
         - docs
-  system_packages: true

README.md

@@ -58,7 +58,7 @@ John P. Jasa, John T. Hwang, and Joaquim R. R. A. Martins. "Open-source coupled
 	Year = {2018}}
 ```
 
-If using the wingbox model, please cite the following [conference paper](https://www.researchgate.net/publication/327654423_Low-Fidelity_Aerostructural_Optimization_of_Aircraft_Wings_with_a_Simplified_Wingbox_Model_Using_OpenAeroStruct).
+If using the wingbox model, fuel-weight inertial loads, or structural-weight inertial loads, please cite the following [conference paper](https://www.researchgate.net/publication/327654423_Low-Fidelity_Aerostructural_Optimization_of_Aircraft_Wings_with_a_Simplified_Wingbox_Model_Using_OpenAeroStruct).
 
 Shamsheer S. Chauhan and Joaquim R. R. A. Martins, “Low-Fidelity Aerostructural Optimization of Aircraft Wings with a Simplified Wingbox Model Using OpenAeroStruct,” Proceedings of the 6th International Conference on Engineering Optimization, EngOpt 2018, Springer, Lisbon, Portugal, September 2018, pp. 418–431. doi:10.1007/978-3-319-97773-7 38
 
@@ -74,6 +74,21 @@ Shamsheer S. Chauhan and Joaquim R. R. A. Martins, “Low-Fidelity Aerostructura
 	Year = {2018}}
 ```
 
+If using point-mass loads or thrust loads, please cite the following [conference paper](https://www.researchgate.net/publication/333806174_How_Certain_Physical_Considerations_Impact_Aerostructural_Wing_Optimization).
+
+John P. Jasa, Shamsheer S. Chauhan, Justin S. Gray, and Joaquim R. R. A. Martins, “How Certain Physical Considerations Impact Aerostructural Wing Optimization,” AIAA/ISSMO Multidisciplinary Analysis and Optimization Conference, Dallas, TX, 2019. doi:10.2514/6.2019-3242
+
+```
+@inproceedings{Jasa2019c,
+	Author = {John P. Jasa and Shamsheer S. Chauhan and Justin S. Gray and Joaquim R. R. A. Martins},
+	Address = {Dallas, TX},
+	Booktitle = {AIAA/ISSMO Multidisciplinary Analysis and Optimization Conference},
+	Doi = {10.2514/6.2019-3242},
+	Title = {How Certain Physical Considerations Impact Aerostructural Wing Optimization},
+	Month = {June},
+	Year = {2019}}
+```
+
 Version Information
 -------------------
 The oldest and latest versions of the dependencies that we test regularly are the following (other versions may work, but no guarantees):

openaerostruct/__init__.py

@@ -1 +1 @@
-__version__ = "2.7.0"
+__version__ = "2.7.1"

openaerostruct/docs/user_reference/mesh_surface_dict.rst

@@ -87,14 +87,42 @@ The surface dict will be provided to Groups, including ``Geometry``, ``AeroPoint
       - 3D ndarray
       - m
       - ``x, y, z`` coordinates of the mesh vertices, can be created by ``generate_mesh``.
+    * - span
+      - 10.0
+      - m
+      - Wing span.
+    * - taper
+      - 0.5
+      - 
+      - Wing taper ratio.
+    * - sweep
+      - 10.0
+      - deg
+      - Wing sweep angle.
+    * - dihedral
+      - 5.0
+      - deg
+      - Wing dihedral.
     * - twist_cp
       - np.array([0, 5])
       - deg
       - B-spline control points for twist distribution. Array convention is ``[wing tip, ..., root]`` in symmetry cases, and ``[tip, ..., root, ... tip]`` when ``symmetry = False``.
     * - chord_cp
       - np.array([0.1, 5])
+      - 
+      - B-spline control points for chord distribution. This is a chord scaler applied to the initial mesh, not the chord value [m] itself. Array convention is the same as ``twist_cp``.
+    * - xshear_cp
+      - np.array([0.1, 0.2])
+      - m
+      - B-spline control points for the x-wise shear deformation of the wing.
+    * - yshear_cp
+      - np.array([0.1, 0.2])
+      - m
+      - B-spline control points for the y-wise shear deformation of the wing.
+    * - zshear_cp
+      - np.array([0.1, 0.2])
       - m
-      - B-spline control points for chord distribution. Array convention is the same than ``twist_cp``.
+      - B-spline control points for the z-wise shear deformation of the wing.
     * - ref_axis_pos
       - 0.25
       - 
@@ -240,6 +268,10 @@ The surface dict will be provided to Groups, including ``Geometry``, ``AeroPoint
       - 0.12
       - 
       - Thickness-over-chord ratio of airfoil provided for the wingbox cross-section.
+    * - strength_factor _for_upper_skin
+      - 1.0
+      - 
+      - A factor to adjust the yield strength of the upper skin relative to the lower skin.
     * - data_x_upper
       - 1D ndarray
       - 
@@ -257,5 +289,21 @@ The surface dict will be provided to Groups, including ``Geometry``, ``AeroPoint
       - 
       - ``y`` coordinates of the wingbox cross-section's lower surface
 
+.. list-table:: FFD parameters
+    :widths: 20 20 5 55
+    :header-rows: 1
+
+    * - Key
+      - Example value
+      - Units
+      - Description
+    * - mx
+      - 2
+      - 
+      - Number of the FFD control points in the x direction.
+    * - my
+      - 2
+      - 
+      - Number of the FFD control points in the y direction.
 ..
   TODO: list default values (if any), and whethre each key is required or optional.

openaerostruct/examples/drag_polar_ground_effect.py

@@ -138,7 +138,7 @@ def compute_drag_polar_ground_effect(Mach, alphas, heights, surfaces, trimmed=Fa
         "wing_type": "rect",
         "symmetry": True,
         "span": 12.0,
-        "chord": 1,
+        "root_chord": 1,
         "span_cos_spacing": 1.0,
         "chord_cos_spacing": 0.0,
     }

openaerostruct/examples/rectangular_wing/drag_polar.py

@@ -37,7 +37,7 @@
     "wing_type": "rect",
     "symmetry": True,
     "span": 10.0,
-    "chord": 1,
+    "root_chord": 1,
     "span_cos_spacing": 1.0,
     "chord_cos_spacing": 1.0,
 }

openaerostruct/examples/rectangular_wing/mphys_example.py

@@ -17,7 +17,7 @@ def setup(self):
             "wing_type": "rect",
             "symmetry": True,
             "span": 10.0,
-            "chord": 1,
+            "root_chord": 1,
             "span_cos_spacing": 1.0,
             "chord_cos_spacing": 1.0,
         }

openaerostruct/examples/rectangular_wing/opt_chord.py

@@ -39,7 +39,7 @@
     "wing_type": "rect",
     "symmetry": True,
     "span": 10.0,
-    "chord": 1,
+    "root_chord": 1,
     "span_cos_spacing": 1.0,
     "chord_cos_spacing": 1.0,
 }
@@ -105,8 +105,9 @@
 prob.driver.options["debug_print"] = ["nl_cons", "objs", "desvars"]
 
 # Setup problem and add design variables, constraint, and objective
+# wing.chord_cp is the chord scaling applied to the initial mesh
 prob.model.add_design_var("alpha", lower=-10.0, upper=15.0)
-prob.model.add_design_var("wing.chord_cp", lower=1e-3, upper=5.0)
+prob.model.add_design_var("wing.chord_cp", lower=1e-3, upper=5.0, units=None)
 prob.model.add_constraint(point_name + ".wing_perf.CL", equals=0.5)
 prob.model.add_constraint(point_name + ".wing.S_ref", equals=10.0)
 prob.model.add_objective(point_name + ".wing_perf.CD", scaler=1e4)

openaerostruct/examples/rectangular_wing/opt_twist.py

@@ -38,7 +38,7 @@
     "wing_type": "rect",
     "symmetry": True,
     "span": 10.0,
-    "chord": 1,
+    "root_chord": 1,
     "span_cos_spacing": 1.0,
     "chord_cos_spacing": 1.0,
 }

openaerostruct/examples/rectangular_wing/run_rect_wing.py

@@ -36,7 +36,7 @@
     "wing_type": "rect",
     "symmetry": True,
     "span": 10.0,
-    "chord": 1,
+    "root_chord": 1,
     "span_cos_spacing": 1.0,
     "chord_cos_spacing": 1.0,
 }

openaerostruct/examples/rectangular_wing/run_roll.py

@@ -37,7 +37,7 @@
     "wing_type": "rect",
     "symmetry": False,
     "span": 9.0,
-    "chord": 1,
+    "root_chord": 1,
     "span_cos_spacing": 1.0,
     "chord_cos_spacing": 1.0,
 }

openaerostruct/geometry/geometry_group.py

@@ -1,6 +1,7 @@
 import numpy as np
 
 import openmdao.api as om
+from openaerostruct.utils.check_surface_dict import check_surface_dict_keys
 
 
 class Geometry(om.Group):
@@ -23,6 +24,9 @@ def initialize(self):
     def setup(self):
         surface = self.options["surface"]
 
+        # key validation of the surface dict
+        check_surface_dict_keys(surface)
+
         # Get the surface name and create a group to contain components
         # only for this surface
         ny = surface["mesh"].shape[1]
@@ -91,10 +95,10 @@ def setup(self):
                     promotes_inputs=["chord_cp"],
                     promotes_outputs=["chord"],
                 )
-                comp.add_spline(y_cp_name="chord_cp", y_interp_name="chord", y_units="m")
+                comp.add_spline(y_cp_name="chord_cp", y_interp_name="chord", y_units=None)
                 bsp_inputs.append("chord")
                 if surface.get("chord_cp_dv", True):
-                    self.set_input_defaults("chord_cp", val=surface["chord_cp"], units="m")
+                    self.set_input_defaults("chord_cp", val=surface["chord_cp"], units=None)
 
             if "t_over_c_cp" in surface.keys():
                 n_cp = len(surface["t_over_c_cp"])

openaerostruct/geometry/geometry_mesh.py

@@ -37,7 +37,7 @@ class GeometryMesh(om.Group):
     twist[ny] : numpy array
         1-D array of rotation angles for each wing slice in degrees.
     chord_dist[ny] : numpy array
-        Chord length for each panel edge.
+        Spanwise distribution of the chord scaler.
     taper : float
         Taper ratio for the wing; 1 is untapered, 0 goes to a point at the tip.
 

openaerostruct/geometry/geometry_mesh_transformations.py

@@ -123,7 +123,7 @@ class ScaleX(om.ExplicitComponent):
     mesh[nx, ny, 3] : numpy array
         Nodal mesh defining the initial aerodynamic surface.
     chord[ny] : numpy array
-        Chord length for each panel edge.
+        Spanwise distribution of the chord scaler.
 
     Returns
     -------
@@ -147,7 +147,7 @@ def setup(self):
         mesh_shape = self.options["mesh_shape"]
         val = self.options["val"]
         self.ref_axis_pos = self.options["ref_axis_pos"]
-        self.add_input("chord", units="m", val=val)
+        self.add_input("chord", units=None, val=val)
         self.add_input("in_mesh", shape=mesh_shape, units="m")
 
         self.add_output("mesh", shape=mesh_shape, units="m")

openaerostruct/geometry/tests/test_geometry_mesh_transformations.py

@@ -164,6 +164,40 @@ def test_scalex_ref_axis_trailing_edge(self):
         # If chord_scaling_pos = 1, TE should not move
         assert_near_equal(mesh[-1, :, :], prob["comp.mesh"][-1, :, :], tolerance=1e-10)
 
+    def test_scalex_chord_value(self):
+        # test actual chord value of a rectangular wing
+
+        mesh_dict = {
+            "num_y": 5,
+            "num_x": 3,
+            "wing_type": "rect",
+            "symmetry": True,
+            "span": 2.0,
+            "root_chord": 0.2,
+        }
+        mesh_in = generate_mesh(mesh_dict)
+
+        # initial chord
+        chord_in = mesh_in[-1, 0, 0] - mesh_in[0, 0, 0]  # TE - LE
+
+        prob = om.Problem()
+        group = prob.model
+        comp = ScaleX(val=np.ones(3), mesh_shape=mesh_in.shape)
+        group.add_subsystem("comp", comp)
+
+        prob.setup()
+        chord_scaling = 1.3
+        prob.set_val("comp.chord", val=chord_scaling, units=None)  # apply chord scaling factor
+        prob.set_val("comp.in_mesh", val=mesh_in, units="m")
+
+        prob.run_model()
+
+        # chord after manipulation
+        mesh_out = prob.get_val("comp.mesh", units="m")
+        chord_out = mesh_out[-1, 0, 0] - mesh_out[0, 0, 0]  # TE - LE
+
+        assert_near_equal(chord_in * chord_scaling, chord_out, tolerance=1e-10)
+
     def test_sweep(self):
         symmetry = False
         mesh = get_mesh(symmetry)

openaerostruct/geometry/tests/test_vsp_mesh.py

@@ -25,7 +25,7 @@ def test_full(self):
             "wing_type": "rect",
             "symmetry": False,
             "span": 10.0,
-            "chord": 1,
+            "root_chord": 1,
             "span_cos_spacing": 0.0,
         }
 
@@ -44,7 +44,7 @@ def test_symm(self):
             "wing_type": "rect",
             "symmetry": True,
             "span": 10.0,
-            "chord": 1,
+            "root_chord": 1,
             "span_cos_spacing": 0.0,
         }