Note
Go to the end to download the full example code
IDF-based MDO on the Sobieski SSBJ test case¶
from __future__ import annotations
from gemseo import configure_logger
from gemseo import create_discipline
from gemseo import create_scenario
from gemseo import generate_n2_plot
from gemseo.problems.sobieski.core.problem import SobieskiProblem
configure_logger()
<RootLogger root (INFO)>
Instantiate the disciplines¶
First, we instantiate the four disciplines of the use case:
SobieskiPropulsion,
SobieskiAerodynamics,
SobieskiMission
and SobieskiStructure.
disciplines = create_discipline(
[
"SobieskiPropulsion",
"SobieskiAerodynamics",
"SobieskiMission",
"SobieskiStructure",
]
)
We can quickly access the most relevant information of any discipline (name, inputs,
and outputs) with Python’s print() function. Moreover, we can get the default
input values of a discipline with the attribute MDODiscipline.default_inputs
for discipline in disciplines:
print(discipline)
print(f"Default inputs: {discipline.default_inputs}")
SobieskiPropulsion
Default inputs: {'x_shared': array([5.0e-02, 4.5e+04, 1.6e+00, 5.5e+00, 5.5e+01, 1.0e+03]), 'x_3': array([0.5]), 'c_3': array([4360.]), 'y_23': array([12562.01206488])}
SobieskiAerodynamics
Default inputs: {'x_2': array([1.]), 'y_32': array([0.50279625]), 'y_12': array([5.06069742e+04, 9.50000000e-01]), 'x_shared': array([5.0e-02, 4.5e+04, 1.6e+00, 5.5e+00, 5.5e+01, 1.0e+03]), 'c_4': array([0.01375])}
SobieskiMission
Default inputs: {'y_14': array([50606.9741711 , 7306.20262124]), 'x_shared': array([5.0e-02, 4.5e+04, 1.6e+00, 5.5e+00, 5.5e+01, 1.0e+03]), 'y_34': array([1.10754577]), 'y_24': array([4.15006276])}
SobieskiStructure
Default inputs: {'y_21': array([50606.9741711]), 'c_0': array([2000.]), 'c_1': array([25000.]), 'x_1': array([0.25, 1. ]), 'x_shared': array([5.0e-02, 4.5e+04, 1.6e+00, 5.5e+00, 5.5e+01, 1.0e+03]), 'y_31': array([6354.32430691]), 'c_2': array([6.])}
You may also be interested in plotting the couplings of your disciplines.
A quick way of getting this information is the API function
generate_n2_plot(). A much more detailed explanation of coupling
visualization is available here.
generate_n2_plot(disciplines, save=False, show=True)
Build, execute and post-process the scenario¶
Then, we build the scenario which links the disciplines
with the formulation and the optimization algorithm. Here, we use the
IDF formulation. We tell the scenario to minimize -y_4 instead of
minimizing y_4 (range), which is the default option.
Instantiate the scenario¶
design_space = SobieskiProblem().design_space
print(design_space)
scenario = create_scenario(
disciplines,
"IDF",
objective_name="y_4",
design_space=design_space,
maximize_objective=True,
)
Design space:
+-------------+-------------+--------------------+-------------+-------+
| name | lower_bound | value | upper_bound | type |
+-------------+-------------+--------------------+-------------+-------+
| x_shared[0] | 0.01 | 0.05 | 0.09 | float |
| x_shared[1] | 30000 | 45000 | 60000 | float |
| x_shared[2] | 1.4 | 1.6 | 1.8 | float |
| x_shared[3] | 2.5 | 5.5 | 8.5 | float |
| x_shared[4] | 40 | 55 | 70 | float |
| x_shared[5] | 500 | 1000 | 1500 | float |
| x_1[0] | 0.1 | 0.25 | 0.4 | float |
| x_1[1] | 0.75 | 1 | 1.25 | float |
| x_2 | 0.75 | 1 | 1.25 | float |
| x_3 | 0.1 | 0.5 | 1 | float |
| y_14[0] | 24850 | 50606.9741711 | 77100 | float |
| y_14[1] | -7700 | 7306.20262124 | 45000 | float |
| y_32 | 0.235 | 0.5027962499999999 | 0.795 | float |
| y_31 | 2960 | 6354.32430691 | 10185 | float |
| y_24 | 0.44 | 4.15006276 | 11.13 | float |
| y_34 | 0.44 | 1.10754577 | 1.98 | float |
| y_23 | 3365 | 12194.2671934 | 26400 | float |
| y_21 | 24850 | 50606.9741711 | 77250 | float |
| y_12[0] | 24850 | 50606.9742 | 77250 | float |
| y_12[1] | 0.45 | 0.95 | 1.5 | float |
+-------------+-------------+--------------------+-------------+-------+
Set the design constraints¶
for c_name in ["g_1", "g_2", "g_3"]:
scenario.add_constraint(c_name, "ineq")
Visualize the XDSM¶
Generate the XDSM file on the fly:
log_workflow_status=Truewill log the status of the workflow in the console,save_html(defaultTrue) will generate a self-contained HTML file, that can be automatically opened usingshow_html=True.
scenario.xdsmize(save_html=False)
Define the algorithm inputs¶
We set the maximum number of iterations, the optimizer and the optimizer options
algo_options = {
"ftol_rel": 1e-10,
"ineq_tolerance": 1e-3,
"eq_tolerance": 1e-3,
"normalize_design_space": True,
}
scn_inputs = {"max_iter": 20, "algo": "SLSQP", "algo_options": algo_options}
Execute the scenario¶
scenario.execute(scn_inputs)
INFO - 16:26:02:
INFO - 16:26:02: *** Start MDOScenario execution ***
INFO - 16:26:02: MDOScenario
INFO - 16:26:02: Disciplines: SobieskiAerodynamics SobieskiMission SobieskiPropulsion SobieskiStructure
INFO - 16:26:02: MDO formulation: IDF
INFO - 16:26:02: Optimization problem:
INFO - 16:26:02: minimize -y_4(x_shared, y_14, y_24, y_34)
INFO - 16:26:02: with respect to x_1, x_2, x_3, x_shared, y_12, y_14, y_21, y_23, y_24, y_31, y_32, y_34
INFO - 16:26:02: subject to constraints:
INFO - 16:26:02: g_1(x_shared, x_1, y_31, y_21) <= 0.0
INFO - 16:26:02: g_2(x_shared, x_2, y_32, y_12) <= 0.0
INFO - 16:26:02: g_3(x_shared, x_3, y_23) <= 0.0
INFO - 16:26:02: y_31_y_32_y_34(x_shared, x_3, y_23): y_31(x_shared, x_3, y_23) - y_31 == 0.0
INFO - 16:26:02: y_32(x_shared, x_3, y_23) - y_32 == 0.0
INFO - 16:26:02: y_34(x_shared, x_3, y_23) - y_34 == 0.0
INFO - 16:26:02: y_21_y_23_y_24(x_shared, x_2, y_32, y_12): y_21(x_shared, x_2, y_32, y_12) - y_21 == 0.0
INFO - 16:26:02: y_23(x_shared, x_2, y_32, y_12) - y_23 == 0.0
INFO - 16:26:02: y_24(x_shared, x_2, y_32, y_12) - y_24 == 0.0
INFO - 16:26:02: y_12_y_14(x_shared, x_1, y_31, y_21): y_12(x_shared, x_1, y_31, y_21) - y_12 == 0.0
INFO - 16:26:02: y_14(x_shared, x_1, y_31, y_21) - y_14 == 0.0
INFO - 16:26:02: over the design space:
INFO - 16:26:02: +-------------+-------------+--------------------+-------------+-------+
INFO - 16:26:02: | name | lower_bound | value | upper_bound | type |
INFO - 16:26:02: +-------------+-------------+--------------------+-------------+-------+
INFO - 16:26:02: | x_shared[0] | 0.01 | 0.05 | 0.09 | float |
INFO - 16:26:02: | x_shared[1] | 30000 | 45000 | 60000 | float |
INFO - 16:26:02: | x_shared[2] | 1.4 | 1.6 | 1.8 | float |
INFO - 16:26:02: | x_shared[3] | 2.5 | 5.5 | 8.5 | float |
INFO - 16:26:02: | x_shared[4] | 40 | 55 | 70 | float |
INFO - 16:26:02: | x_shared[5] | 500 | 1000 | 1500 | float |
INFO - 16:26:02: | x_1[0] | 0.1 | 0.25 | 0.4 | float |
INFO - 16:26:02: | x_1[1] | 0.75 | 1 | 1.25 | float |
INFO - 16:26:02: | x_2 | 0.75 | 1 | 1.25 | float |
INFO - 16:26:02: | x_3 | 0.1 | 0.5 | 1 | float |
INFO - 16:26:02: | y_14[0] | 24850 | 50606.9741711 | 77100 | float |
INFO - 16:26:02: | y_14[1] | -7700 | 7306.20262124 | 45000 | float |
INFO - 16:26:02: | y_32 | 0.235 | 0.5027962499999999 | 0.795 | float |
INFO - 16:26:02: | y_31 | 2960 | 6354.32430691 | 10185 | float |
INFO - 16:26:02: | y_24 | 0.44 | 4.15006276 | 11.13 | float |
INFO - 16:26:02: | y_34 | 0.44 | 1.10754577 | 1.98 | float |
INFO - 16:26:02: | y_23 | 3365 | 12194.2671934 | 26400 | float |
INFO - 16:26:02: | y_21 | 24850 | 50606.9741711 | 77250 | float |
INFO - 16:26:02: | y_12[0] | 24850 | 50606.9742 | 77250 | float |
INFO - 16:26:02: | y_12[1] | 0.45 | 0.95 | 1.5 | float |
INFO - 16:26:02: +-------------+-------------+--------------------+-------------+-------+
INFO - 16:26:02: Solving optimization problem with algorithm SLSQP:
INFO - 16:26:02: ... 0%| | 0/20 [00:00<?, ?it]
INFO - 16:26:02: ... 5%|▌ | 1/20 [00:00<00:00, 228.15 it/sec, obj=-536]
INFO - 16:26:02: ... 10%|█ | 2/20 [00:00<00:00, 58.49 it/sec, obj=-1.49e+3]
INFO - 16:26:02: ... 15%|█▌ | 3/20 [00:00<00:00, 63.49 it/sec, obj=-3.83e+3]
INFO - 16:26:02: ... 20%|██ | 4/20 [00:00<00:00, 67.15 it/sec, obj=-3.87e+3]
INFO - 16:26:02: ... 25%|██▌ | 5/20 [00:00<00:00, 69.73 it/sec, obj=-3.96e+3]
INFO - 16:26:02: ... 30%|███ | 6/20 [00:00<00:00, 71.24 it/sec, obj=-3.96e+3]
INFO - 16:26:02: ... 35%|███▌ | 7/20 [00:00<00:00, 72.31 it/sec, obj=-3.96e+3]
INFO - 16:26:02: ... 40%|████ | 8/20 [00:00<00:00, 77.87 it/sec, obj=-3.96e+3]
INFO - 16:26:02: ... 45%|████▌ | 9/20 [00:00<00:00, 82.95 it/sec, obj=-3.96e+3]
INFO - 16:26:02: ... 50%|█████ | 10/20 [00:00<00:00, 87.49 it/sec, obj=-3.96e+3]
INFO - 16:26:02: ... 55%|█████▌ | 11/20 [00:00<00:00, 91.36 it/sec, obj=-3.96e+3]
INFO - 16:26:02: ... 60%|██████ | 12/20 [00:00<00:00, 95.08 it/sec, obj=-3.96e+3]
INFO - 16:26:02: ... 65%|██████▌ | 13/20 [00:00<00:00, 98.55 it/sec, obj=-3.96e+3]
INFO - 16:26:02: ... 70%|███████ | 14/20 [00:00<00:00, 101.70 it/sec, obj=-3.96e+3]
INFO - 16:26:02: ... 75%|███████▌ | 15/20 [00:00<00:00, 104.63 it/sec, obj=-3.96e+3]
INFO - 16:26:02: ... 80%|████████ | 16/20 [00:00<00:00, 107.32 it/sec, obj=-3.96e+3]
INFO - 16:26:02: ... 85%|████████▌ | 17/20 [00:00<00:00, 109.81 it/sec, obj=-3.96e+3]
INFO - 16:26:02: ... 90%|█████████ | 18/20 [00:00<00:00, 107.69 it/sec, obj=-3.97e+3]
INFO - 16:26:02: ... 95%|█████████▌| 19/20 [00:00<00:00, 109.67 it/sec, obj=-3.97e+3]
INFO - 16:26:02: ... 100%|██████████| 20/20 [00:00<00:00, 111.58 it/sec, obj=-3.96e+3]
INFO - 16:26:02: Optimization result:
INFO - 16:26:02: Optimizer info:
INFO - 16:26:02: Status: None
INFO - 16:26:02: Message: Maximum number of iterations reached. GEMSEO Stopped the driver
INFO - 16:26:02: Number of calls to the objective function by the optimizer: 22
INFO - 16:26:02: Solution:
INFO - 16:26:02: The solution is feasible.
INFO - 16:26:02: Objective: -3966.790848506069
INFO - 16:26:02: Standardized constraints:
INFO - 16:26:02: g_1 = [-0.01812782 -0.03339445 -0.0442868 -0.0518651 -0.05735184 -0.13720865
INFO - 16:26:02: -0.10279135]
INFO - 16:26:02: g_2 = 2.535682693616259e-05
INFO - 16:26:02: g_3 = [-7.67489138e-01 -2.32510862e-01 9.20908972e-05 -1.83255000e-01]
INFO - 16:26:02: y_12_y_14 = [ 3.34629122e-05 -1.85828412e-05 3.35589780e-05 -5.48378413e-05]
INFO - 16:26:02: y_21_y_23_y_24 = [ 0.00000000e+00 9.05477756e-05 -2.83060860e-04]
INFO - 16:26:02: y_31_y_32_y_34 = [6.90641576e-08 6.03563891e-08 1.07078689e-04]
INFO - 16:26:02: Design space:
INFO - 16:26:02: +-------------+-------------+---------------------+-------------+-------+
INFO - 16:26:02: | name | lower_bound | value | upper_bound | type |
INFO - 16:26:02: +-------------+-------------+---------------------+-------------+-------+
INFO - 16:26:02: | x_shared[0] | 0.01 | 0.06000633920673407 | 0.09 | float |
INFO - 16:26:02: | x_shared[1] | 30000 | 60000 | 60000 | float |
INFO - 16:26:02: | x_shared[2] | 1.4 | 1.4 | 1.8 | float |
INFO - 16:26:02: | x_shared[3] | 2.5 | 2.5 | 8.5 | float |
INFO - 16:26:02: | x_shared[4] | 40 | 70 | 70 | float |
INFO - 16:26:02: | x_shared[5] | 500 | 1500 | 1500 | float |
INFO - 16:26:02: | x_1[0] | 0.1 | 0.4 | 0.4 | float |
INFO - 16:26:02: | x_1[1] | 0.75 | 0.75 | 1.25 | float |
INFO - 16:26:02: | x_2 | 0.75 | 0.75 | 1.25 | float |
INFO - 16:26:02: | x_3 | 0.1 | 0.156259134365097 | 1 | float |
INFO - 16:26:02: | y_14[0] | 24850 | 44746.56244377587 | 77100 | float |
INFO - 16:26:02: | y_14[1] | -7700 | 19355.27544458607 | 45000 | float |
INFO - 16:26:02: | y_32 | 0.235 | 0.7325108278699097 | 0.795 | float |
INFO - 16:26:02: | y_31 | 2960 | 9433.274956925387 | 10185 | float |
INFO - 16:26:02: | y_24 | 0.44 | 8.059470045805423 | 11.13 | float |
INFO - 16:26:02: | y_34 | 0.44 | 0.9237614560895575 | 1.98 | float |
INFO - 16:26:02: | y_23 | 3365 | 5552.047264915329 | 26400 | float |
INFO - 16:26:02: | y_21 | 24850 | 44746.56244377587 | 77250 | float |
INFO - 16:26:02: | y_12[0] | 24850 | 44746.56244377587 | 77250 | float |
INFO - 16:26:02: | y_12[1] | 0.45 | 0.9028108618065331 | 1.5 | float |
INFO - 16:26:02: +-------------+-------------+---------------------+-------------+-------+
INFO - 16:26:02: *** End MDOScenario execution (time: 0:00:00.210635) ***
{'max_iter': 20, 'algo_options': {'ftol_rel': 1e-10, 'ineq_tolerance': 0.001, 'eq_tolerance': 0.001, 'normalize_design_space': True}, 'algo': 'SLSQP'}
Save the optimization history¶
We can save the whole optimization problem and its history for further post processing:
scenario.save_optimization_history("idf_history.h5", file_format="hdf5")
INFO - 16:26:02: Export optimization problem to file: idf_history.h5
We can also save only calls to functions and design variables history:
scenario.save_optimization_history("idf_history.xml", file_format="ggobi")
INFO - 16:26:02: Export to ggobi for functions: ['-y_4', 'g_1', 'g_2', 'g_3', 'y_12_y_14', 'y_21_y_23_y_24', 'y_31_y_32_y_34']
INFO - 16:26:02: Export to ggobi file: idf_history.xml
Print optimization metrics¶
scenario.print_execution_metrics()
INFO - 16:26:02: Scenario Execution Statistics
INFO - 16:26:02: Discipline: SobieskiPropulsion
INFO - 16:26:02: Executions number: 20
INFO - 16:26:02: Execution time: 0.0059411359989098855 s
INFO - 16:26:02: Linearizations number: 7
INFO - 16:26:02: Discipline: SobieskiAerodynamics
INFO - 16:26:02: Executions number: 20
INFO - 16:26:02: Execution time: 0.008695222998539975 s
INFO - 16:26:02: Linearizations number: 7
INFO - 16:26:02: Discipline: SobieskiMission
INFO - 16:26:02: Executions number: 20
INFO - 16:26:02: Execution time: 0.0011114160015495145 s
INFO - 16:26:02: Linearizations number: 7
INFO - 16:26:02: Discipline: SobieskiStructure
INFO - 16:26:02: Executions number: 20
INFO - 16:26:02: Execution time: 0.03085114100122155 s
INFO - 16:26:02: Linearizations number: 7
INFO - 16:26:02: Total number of executions calls: 80
INFO - 16:26:02: Total number of linearizations: 28
Plot the optimization history view¶
scenario.post_process("OptHistoryView", save=True, show=True)
/home/docs/checkouts/readthedocs.org/user_builds/gemseo/envs/stable/lib/python3.9/site-packages/genson/schema/strategies/base.py:42: UserWarning: Schema incompatible. Keyword 'description' has conflicting values ('The width and height of the figure in inches, e.g. ``(w, h)``.\nIf ``None``, use the :attr:`.OptPostProcessor.DEFAULT_FIG_SIZE`\nof the post-processor.' vs. 'The width and height of the figure in inches, e.g. `(w, h)`.\nIf ``None``, use the :attr:`.OptPostProcessor.DEFAULT_FIG_SIZE`\nof the post-processor.'). Using 'The width and height of the figure in inches, e.g. ``(w, h)``.\nIf ``None``, use the :attr:`.OptPostProcessor.DEFAULT_FIG_SIZE`\nof the post-processor.'
warn(('Schema incompatible. Keyword {0!r} has conflicting '
<gemseo.post.opt_history_view.OptHistoryView object at 0x7ffae9a6b100>
Plot the quadratic approximation of the objective¶
scenario.post_process("QuadApprox", function="-y_4", save=False, show=True)
<gemseo.post.quad_approx.QuadApprox object at 0x7ffaeb0af490>
Total running time of the script: ( 0 minutes 4.996 seconds)