Adding MPhys Interface (#401)

* first implementation of mphys builder for aero solver

* Adding compressible states to mphys builder

* Formatting changes

* adding tests

* Fixing promotion bug in mphys AeroFuncsGroup

* Adding mphys install to github workflow

* minor black reformat

* adding mphys module to setup.py package

* adding catch for missing mphys package

* adding tecplot files to gitignore

* changing surface_contour file extension to .plt

* Adding mphys aero example

* minor flake fix for mphys example

* Adding first mphys test

* Adding compressible mphys test

* Adding capability to run aero mphys builder in parallel

* Updating mphys aero inputs to match mphys naming convention

* Adding mphys optimization examples

* minor edit

* updating mphys import procedure

* minor black reformat

* Update mphys_chord_opt.py

* Adding missing vsp file for mphys opt examples

* minor black reformat

* renming examples

* Adding descriptions to mphys optimization examples

* Adding descriptions to docstrings to mphys wrapper

* Minor docstring edit

* Updating pygeo mphys examples to match new pygeo API

* Updating `generate_vsp_surfaces` to use `VSPVehicle` class

* Updating OpenMDAO upper version requirement to 3.24

* Adding total lift/drag component to mphys wrapper

* black fixes

* black/flake fixes

* fixing missing mphys module in CI

* Another black fix

* Adding mphys docs

* Updating min mphys req in setup.py

* Adding missing vsp model to mphys docs

* Adding dimensional lift and drag to total performance

* Breaking up mphys wrapper into smaller files

* Adding more mphys unit tests

* Adding one more mphys unit test

* adding default units to mphys `yaw` variable

* Setting mphys default for `mach` var

* update mphys test

* black fixes

* fixing problem with setting default mach for incompresssible cases in mphys

* fixing viscous nan in test_aero_funcs_group.py

* Addressing review comments

* Adding lift distribution writer component to mphys

* flake fix

---------

Co-authored-by: Eytan Adler <eytana@umich.edu>

Author: timryanb

.github/workflows/oas.yml

@@ -27,7 +27,8 @@ jobs:
         PYTHON_VERSION_LATEST: ['3.11']
         NUMPY_VERSION_OLDEST: ['1.20']  # latest is most recent on PyPI
         SCIPY_VERSION_OLDEST: ['1.6.0']  # latest is most recent on PyPI
-        OPENMDAO_VERSION_OLDEST: ['3.10']  # latest is most recent on PyPI
+        OPENMDAO_VERSION_OLDEST: ['3.15']  # latest is most recent on PyPI
+        MPHYS_VERSION_OLDEST: ['1.0.0']  # latest is most recent on PyPI
         PYGEO_VERSION_OLDEST: ['1.6.0']  # latest is pulled from main branch, for some reason anything after 1.12.2 seg faults on the old build
         VSP_VERSION: ['3.27.1']  # used for both builds
 
@@ -89,13 +90,13 @@ jobs:
       if: ${{ matrix.dep-versions == 'oldest' }}
       run: |
         python -m pip install --upgrade pip wheel
-        pip install numpy==${{ matrix.NUMPY_VERSION_OLDEST }} scipy==${{ matrix.SCIPY_VERSION_OLDEST }} openmdao==${{ matrix.OPENMDAO_VERSION_OLDEST }}
+        pip install numpy==${{ matrix.NUMPY_VERSION_OLDEST }} scipy==${{ matrix.SCIPY_VERSION_OLDEST }} openmdao==${{ matrix.OPENMDAO_VERSION_OLDEST }} mphys==${{ matrix.MPHYS_VERSION_OLDEST }}
         pip install -e .[test]
     - name: Install OAS and its dependencies (latest versions)
       if: ${{ matrix.dep-versions == 'latest' }}
       run: |
         python -m pip install --upgrade pip wheel
-        pip install -e .[test]
+        pip install -e .[test,mphys]
 
     # We need pySpline/pyGeo to run FFD tests.
     - name: Install pySpline

.gitignore

@@ -21,3 +21,4 @@ src/adjoint/tempReverse/
 src/adjoint/tempForward/
 openaerostruct.egg-info/ 
 .vscode
+*.plt

README.md

@@ -78,14 +78,15 @@ Version Information
 -------------------
 The oldest and latest versions of the dependencies that we test regularly are the following (other versions may work, but no guarantees):
 
-| Dependency | oldest | latest |
-| ---------- | ------ | ------ |
-| Python     | 3.8    | 3.11   |
-| NumPy      | 1.20   | latest |
-| SciPy      | 1.6.0  | latest |
-| OpenMDAO   | 3.10   | latest |
-| Matplotlib | latest | latest |
-| pyGeo (optional) | 1.6.0 | latest |
+| Dependency         | oldest | latest |
+|--------------------|--------| ------ |
+| Python             | 3.8    | 3.11   |
+| NumPy              | 1.20   | latest |
+| SciPy              | 1.6.0  | latest |
+| OpenMDAO           | 3.15   | latest |
+| MPhys              | 1.0.0  | latest |
+| Matplotlib         | latest | latest |
+| pyGeo (optional)   | 1.6.0  | latest |
 | OpenVSP (optional) | 3.27.1 | 3.27.1 |
 
 If you are looking to use the previous version of OpenAeroStruct which uses OpenMDAO 1.7.4, use OpenAeroStruct 1.0 from [here](https://github.com/mdolab/OpenAeroStruct/releases).

openaerostruct/aerodynamics/coeffs.py

@@ -26,11 +26,11 @@ class Coeffs(om.ExplicitComponent):
     """
 
     def setup(self):
-        self.add_input("S_ref", val=1.0, units="m**2")
+        self.add_input("S_ref", val=1.0, units="m**2", tags=["mphys_coupling"])
         self.add_input("L", val=1.0, units="N")
         self.add_input("D", val=1.0, units="N")
-        self.add_input("v", val=1.0, units="m/s")
-        self.add_input("rho", val=1.0, units="kg/m**3")
+        self.add_input("v", val=1.0, units="m/s", tags=["mphys_input"])
+        self.add_input("rho", val=1.0, units="kg/m**3", tags=["mphys_input"])
 
         self.add_output("CL1", val=0.0)
         self.add_output("CDi", val=0.0)

openaerostruct/aerodynamics/collocation_points.py

@@ -72,7 +72,7 @@ def setup(self):
 
             # Take in a deformed mesh for each surface.
             mesh_name = name + "_def_mesh"
-            self.add_input(mesh_name, shape=(nx, ny, 3), units="m")
+            self.add_input(mesh_name, shape=(nx, ny, 3), units="m", tags=["mphys_coupling"])
 
             mesh_indices = np.arange(nx * ny * 3).reshape((nx, ny, 3))
 

openaerostruct/aerodynamics/convert_velocity.py

@@ -55,9 +55,9 @@ def setup(self):
 
         self.system_size = system_size
 
-        self.add_input("alpha", val=0.0, units="deg")
-        self.add_input("beta", val=0.0, units="deg")
-        self.add_input("v", val=1.0, units="m/s")
+        self.add_input("alpha", val=0.0, units="deg", tags=["mphys_input"])
+        self.add_input("beta", val=0.0, units="deg", tags=["mphys_input"])
+        self.add_input("v", val=1.0, units="m/s", tags=["mphys_input"])
 
         if rotational:
             self.add_input("rotational_velocities", shape=(system_size, 3), units="m/s")

openaerostruct/aerodynamics/eval_mtx.py

@@ -163,7 +163,7 @@ def setup(self):
         eval_name = self.options["eval_name"]
         num_eval_points = self.options["num_eval_points"]
 
-        self.add_input("alpha", val=1.0, units="deg")
+        self.add_input("alpha", val=1.0, units="deg", tags=["mphys_input"])
 
         self.surface_indices_repeated = dict()
 

openaerostruct/aerodynamics/eval_velocities.py

@@ -56,7 +56,7 @@ def setup(self):
         self.system_size = system_size
 
         self.add_input("freestream_velocities", shape=(system_size, 3), units="m/s")
-        self.add_input("circulations", shape=system_size, units="m**2/s")
+        self.add_input("circulations", shape=system_size, units="m**2/s", tags=["mphys_coupling"])
 
         # Get the correct output name; the velocities output depends on which
         # set of evaluation points we use, either collocation or force.

openaerostruct/aerodynamics/geometry.py

@@ -48,16 +48,16 @@ def setup(self):
         ny = self.ny = mesh.shape[1]
 
         # All of these computations only need the deformed mesh
-        self.add_input("def_mesh", val=np.zeros((nx, ny, 3)), units="m")
+        self.add_input("def_mesh", val=np.zeros((nx, ny, 3)), units="m", tags=["mphys_coupling"])
 
         rng = np.random.default_rng(314)
-        self.add_output("b_pts", val=rng.random((nx - 1, ny, 3)), units="m")
-        self.add_output("widths", val=np.ones((ny - 1)), units="m")
-        self.add_output("lengths_spanwise", val=np.ones((ny - 1)), units="m")
-        self.add_output("lengths", val=np.zeros((ny)), units="m")
-        self.add_output("chords", val=np.zeros((ny)), units="m")
-        self.add_output("normals", val=np.zeros((nx - 1, ny - 1, 3)))
-        self.add_output("S_ref", val=1.0, units="m**2")
+        self.add_output("b_pts", val=rng.random((nx - 1, ny, 3)), units="m", tags=["mphys_coupling"])
+        self.add_output("widths", val=np.ones((ny - 1)), units="m", tags=["mphys_coupling"])
+        self.add_output("lengths_spanwise", val=np.ones((ny - 1)), units="m", tags=["mphys_coupling"])
+        self.add_output("lengths", val=np.zeros((ny)), units="m", tags=["mphys_coupling"])
+        self.add_output("chords", val=np.zeros((ny)), units="m", tags=["mphys_coupling"])
+        self.add_output("normals", val=np.zeros((nx - 1, ny - 1, 3)), tags=["mphys_coupling"])
+        self.add_output("S_ref", val=1.0, units="m**2", tags=["mphys_coupling"])
 
         # Next up we have a lot of rows and cols settings for the sparse
         # Jacobians. Each set of partials needs a different rows/cols setup

openaerostruct/aerodynamics/horseshoe_circulations.py

@@ -45,7 +45,7 @@ def setup(self):
 
         self.system_size = system_size
 
-        self.add_input("circulations", shape=system_size, units="m**2/s")
+        self.add_input("circulations", shape=system_size, units="m**2/s", tags=["mphys_coupling"])
         self.add_output("horseshoe_circulations", shape=system_size, units="m**2/s")
 
         # To convert between the two circulations, we simply need to set up a