Multi mission opt

aviary/docs/_toc.yml

@@ -45,6 +45,7 @@ parts:
       - file: user_guide/features/overriding
       - file: user_guide/FLOPS_based_detailed_takeoff_and_landing
       - file: user_guide/reserve_missions
+      - file: user_guide/multi_mission
       - file: user_guide/off_design_missions
       - file: user_guide/SGM_capabilities
     - file: user_guide/troubleshooting
@@ -57,6 +58,7 @@ parts:
     - file: examples/coupled_aircraft_mission_optimization
     - file: examples/additional_flight_phases
     - file: examples/reserve_missions
+    - file: examples/multi_mission
     - file: examples/off_design_example
     - file: examples/OAS_subsystem
     - file: examples/level_2_detailed_takeoff_and_landing

aviary/docs/user_guide/FLOPS_based_detailed_takeoff_and_landing.ipynb

@@ -38,13 +38,25 @@
    "execution_count": null,
    "id": "5fe75e1d",
    "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "ename": "",
+     "evalue": "",
+     "output_type": "error",
+     "traceback": [
+      "\u001b[1;31mRunning cells with 'base (Python 3.12.5)' requires the ipykernel package.\n",
+      "\u001b[1;31mRun the following command to install 'ipykernel' into the Python environment. \n",
+      "\u001b[1;31mCommand: 'conda install -n base ipykernel --update-deps --force-reinstall'"
+     ]
+    }
+   ],
    "source": [
     "from aviary.api import Dynamic, Mission\n",
     "\n",
     "import aviary.api as av\n",
     "\n",
     "from aviary.models.N3CC.N3CC_data import inputs\n",
+    "from aviary.utils.preprocessors import preprocess_options\n",
     "\n",
     "aviary_options = inputs.deepcopy()\n",
     "\n",
@@ -82,6 +94,7 @@
     "# We also need propulsion analysis for takeoff and landing. No additional configuration\n",
     "# is needed for this builder\n",
     "engine = av.build_engine_deck(aviary_options)\n",
+    "preprocess_options(aviary_options, engine_models=engine)\n",
     "prop_builder = av.CorePropulsionBuilder(engine_models=engine)"
    ]
   },
@@ -633,7 +646,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "base",
    "language": "python",
    "name": "python3"
   },
@@ -647,7 +660,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.13"
+   "version": "3.12.5"
   }
  },
  "nbformat": 4,

aviary/docs/user_guide/multi_mission.ipynb

@@ -0,0 +1,83 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": [
+     "remove-cell"
+    ]
+   },
+   "outputs": [
+    {
+     "ename": "",
+     "evalue": "",
+     "output_type": "error",
+     "traceback": [
+      "\u001b[1;31mRunning cells with 'base (Python 3.12.5)' requires the ipykernel package.\n",
+      "\u001b[1;31mRun the following command to install 'ipykernel' into the Python environment. \n",
+      "\u001b[1;31mCommand: 'conda install -n base ipykernel --update-deps --force-reinstall'"
+     ]
+    }
+   ],
+   "source": [
+    "# Testing Cell\n",
+    "\n",
+    "from aviary.docs.tests.utils import glue_variable\n",
+    "from aviary.api import Aircraft, AviaryProblem\n",
+    "\n",
+    "glue_variable(f'{Aircraft.CrewPayload.Design.NUM_PASSENGERS=}'.split('=')[0], md_code=True)\n",
+    "glue_variable(f'{Aircraft.CrewPayload.NUM_PASSENGERS=}'.split('=')[0], md_code=True)\n",
+    "\n",
+    "glue_variable('capi',AviaryProblem.check_and_preprocess_inputs.__name__+'()',md_code=True)\n",
+    "glue_variable(f'{Aircraft.CrewPayload.NUM_BUSINESS_CLASS=}'.split('=')[0], md_code=True)\n",
+    "glue_variable(f'{Aircraft.CrewPayload.NUM_FIRST_CLASS=}'.split('=')[0], md_code=True)\n",
+    "glue_variable(f'{Aircraft.CrewPayload.NUM_TOURIST_CLASS=}'.split('=')[0], md_code=True)\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Multi-Mission Optimization\n",
+    "\n",
+    "## Overview\n",
+    "\n",
+    "Multi-missions adds the capability to optimize an aircraft design considering two or more missions that the aircraft will perform. This is in contrast to designing an aircraft for a single mission, and hopefully helps to represent the conditions the aircraft will be flying in better. In the example provided, a large single aisle passenger aircraft is designed based on a mission with every seat filled, and a second 'deadhead' mission where there are no passengers. A weighting is provided by the user to determine how often the missions are full of passengers vs. how often the flights are empty. A cargo example could be constructed where one mission is designed for maximum range and a second mission designed for maximum payload. \n",
+    "\n",
+    "To impact the structure of aviaryproblems as little as possible, after instantiation of the pre-mission, mission, and post-mission systems, the connections between those systems are created. Then those groups are then copied over into a regular openmdao problem. This enables the use all the basic aviary connection and checking functions with minimal modification. \n",
+    "\n",
+    "The objective function is based on combining the fuel-burn values from both missions and the optimizers objective is to minimize the weighted fuel-burn. Other objectives, like max range, have not been tested yet.\n",
+    "\n",
+    "## Design vs. As-Flown\n",
+    "To support the need to design an aircraft with a certain number of seats, but then possibly fly missions with unfilled seats, a distinction in the metadata was introduced between {glue:md}`Aircraft.CrewPayload.Design.NUM_PASSENGERS` and {glue:md}`Aircraft.CrewPayload.NUM_PASSENGERS`. The individual passenger classes ({glue:md}`Aircraft.CrewPayload.NUM_FIRST_CLASS`, {glue:md}`Aircraft.CrewPayload.NUM_BUSINESS_CLASS`, {glue:md}`Aircraft.CrewPayload.NUM_TOURIST_CLASS`) also have these distinctions. The Design values represent how many seats are available in the aircraft. Whereas the non-design values represent an as-flow value of how many passengers are on a particular flight. \n",
+    "\n",
+    "A number of checks exist in {glue:md}`capi` to help the user in the case that incomplete as-flow or design passenger information is provided. This was done to provide backward compatability for older aircraft models.\n",
+    "\n",
+    "## Example\n",
+    "An example of a multi-mission as well as Setup, Theory, and Results, is presented in [Multi-Mission Examples](../examples/multi_mission)."
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "base",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.12.5"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}