.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "examples/post_process/algorithms/plot_constraints_history.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_examples_post_process_algorithms_plot_constraints_history.py>`
        to download the full example code

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_examples_post_process_algorithms_plot_constraints_history.py:


Constraints history
===================

In this example, we illustrate the use of the :class:`.ConstraintsHistory` plot
on the Sobieski's SSBJ problem.

.. GENERATED FROM PYTHON SOURCE LINES 28-36

.. code-block:: Python


    from __future__ import annotations

    from gemseo import configure_logger
    from gemseo import create_discipline
    from gemseo import create_scenario
    from gemseo.problems.sobieski.core.design_space import SobieskiDesignSpace








.. GENERATED FROM PYTHON SOURCE LINES 37-41

Import
------
The first step is to import some functions from the API
and a method to get the design space.

.. GENERATED FROM PYTHON SOURCE LINES 41-44

.. code-block:: Python


    configure_logger()





.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    <RootLogger root (INFO)>



.. GENERATED FROM PYTHON SOURCE LINES 45-54

Description
-----------

The :class:`.ConstraintsHistory` post-processing
plots the constraints functions history in line charts
with violation indication by color on the background.

This plot is more precise than the constraint plot provided by the
:ref:`opt_history_view` but scales less with the number of constraints.

.. GENERATED FROM PYTHON SOURCE LINES 56-60

Create disciplines
------------------
At this point, we instantiate the disciplines of Sobieski's SSBJ problem:
Propulsion, Aerodynamics, Structure and Mission

.. GENERATED FROM PYTHON SOURCE LINES 60-67

.. code-block:: Python

    disciplines = create_discipline([
        "SobieskiPropulsion",
        "SobieskiAerodynamics",
        "SobieskiStructure",
        "SobieskiMission",
    ])








.. GENERATED FROM PYTHON SOURCE LINES 68-71

Create design space
-------------------
We also create the :class:`.SobieskiDesignSpace`.

.. GENERATED FROM PYTHON SOURCE LINES 71-73

.. code-block:: Python

    design_space = SobieskiDesignSpace()








.. GENERATED FROM PYTHON SOURCE LINES 74-81

Create and execute scenario
---------------------------
The next step is to build an MDO scenario in order to maximize the range,
encoded 'y_4', with respect to the design parameters, while satisfying the
inequality constraints 'g_1', 'g_2' and 'g_3'. We can use the MDF formulation,
the SLSQP optimization algorithm
and a maximum number of iterations equal to 100.

.. GENERATED FROM PYTHON SOURCE LINES 81-94

.. code-block:: Python

    scenario = create_scenario(
        disciplines,
        "MDF",
        "y_4",
        design_space,
        maximize_objective=True,
    )
    scenario.set_differentiation_method()
    all_constraints = ["g_1", "g_2", "g_3"]
    for constraint in all_constraints:
        scenario.add_constraint(constraint, constraint_type="ineq")
    scenario.execute({"algo": "SLSQP", "max_iter": 10})





.. rst-class:: sphx-glr-script-out

 .. code-block:: none

        INFO - 13:56:59:  
        INFO - 13:56:59: *** Start MDOScenario execution ***
        INFO - 13:56:59: MDOScenario
        INFO - 13:56:59:    Disciplines: SobieskiAerodynamics SobieskiMission SobieskiPropulsion SobieskiStructure
        INFO - 13:56:59:    MDO formulation: MDF
        INFO - 13:56:59: Optimization problem:
        INFO - 13:56:59:    minimize -y_4(x_shared, x_1, x_2, x_3)
        INFO - 13:56:59:    with respect to x_1, x_2, x_3, x_shared
        INFO - 13:56:59:    subject to constraints:
        INFO - 13:56:59:       g_1(x_shared, x_1, x_2, x_3) <= 0.0
        INFO - 13:56:59:       g_2(x_shared, x_1, x_2, x_3) <= 0.0
        INFO - 13:56:59:       g_3(x_shared, x_1, x_2, x_3) <= 0.0
        INFO - 13:56:59:    over the design space:
        INFO - 13:56:59:       +-------------+-------------+-------+-------------+-------+
        INFO - 13:56:59:       | Name        | Lower bound | Value | Upper bound | Type  |
        INFO - 13:56:59:       +-------------+-------------+-------+-------------+-------+
        INFO - 13:56:59:       | x_shared[0] |     0.01    |  0.05 |     0.09    | float |
        INFO - 13:56:59:       | x_shared[1] |    30000    | 45000 |    60000    | float |
        INFO - 13:56:59:       | x_shared[2] |     1.4     |  1.6  |     1.8     | float |
        INFO - 13:56:59:       | x_shared[3] |     2.5     |  5.5  |     8.5     | float |
        INFO - 13:56:59:       | x_shared[4] |      40     |   55  |      70     | float |
        INFO - 13:56:59:       | x_shared[5] |     500     |  1000 |     1500    | float |
        INFO - 13:56:59:       | x_1[0]      |     0.1     |  0.25 |     0.4     | float |
        INFO - 13:56:59:       | x_1[1]      |     0.75    |   1   |     1.25    | float |
        INFO - 13:56:59:       | x_2         |     0.75    |   1   |     1.25    | float |
        INFO - 13:56:59:       | x_3         |     0.1     |  0.5  |      1      | float |
        INFO - 13:56:59:       +-------------+-------------+-------+-------------+-------+
        INFO - 13:56:59: Solving optimization problem with algorithm SLSQP:
        INFO - 13:56:59:     10%|█         | 1/10 [00:00<00:00, 10.57 it/sec, obj=-536]
        INFO - 13:56:59:     20%|██        | 2/10 [00:00<00:01,  7.44 it/sec, obj=-2.12e+3]
     WARNING - 13:57:00: MDAJacobi has reached its maximum number of iterations but the normed residual 1.7130677857005655e-05 is still above the tolerance 1e-06.
        INFO - 13:57:00:     30%|███       | 3/10 [00:00<00:01,  6.20 it/sec, obj=-3.75e+3]
        INFO - 13:57:00:     40%|████      | 4/10 [00:00<00:01,  5.90 it/sec, obj=-3.96e+3]
        INFO - 13:57:00:     50%|█████     | 5/10 [00:00<00:00,  5.74 it/sec, obj=-3.96e+3]
        INFO - 13:57:00: Optimization result:
        INFO - 13:57:00:    Optimizer info:
        INFO - 13:57:00:       Status: 8
        INFO - 13:57:00:       Message: Positive directional derivative for linesearch
        INFO - 13:57:00:       Number of calls to the objective function by the optimizer: 6
        INFO - 13:57:00:    Solution:
        INFO - 13:57:00:       The solution is feasible.
        INFO - 13:57:00:       Objective: -3963.408265187933
        INFO - 13:57:00:       Standardized constraints:
        INFO - 13:57:00:          g_1 = [-0.01806104 -0.03334642 -0.04424946 -0.0518346  -0.05732607 -0.13720865
        INFO - 13:57:00:  -0.10279135]
        INFO - 13:57:00:          g_2 = 3.333278582928756e-06
        INFO - 13:57:00:          g_3 = [-7.67181773e-01 -2.32818227e-01  8.30379541e-07 -1.83255000e-01]
        INFO - 13:57:00:       Design space:
        INFO - 13:57:00:          +-------------+-------------+---------------------+-------------+-------+
        INFO - 13:57:00:          | Name        | Lower bound |        Value        | Upper bound | Type  |
        INFO - 13:57:00:          +-------------+-------------+---------------------+-------------+-------+
        INFO - 13:57:00:          | x_shared[0] |     0.01    | 0.06000083331964572 |     0.09    | float |
        INFO - 13:57:00:          | x_shared[1] |    30000    |        60000        |    60000    | float |
        INFO - 13:57:00:          | x_shared[2] |     1.4     |         1.4         |     1.8     | float |
        INFO - 13:57:00:          | x_shared[3] |     2.5     |         2.5         |     8.5     | float |
        INFO - 13:57:00:          | x_shared[4] |      40     |          70         |      70     | float |
        INFO - 13:57:00:          | x_shared[5] |     500     |         1500        |     1500    | float |
        INFO - 13:57:00:          | x_1[0]      |     0.1     |         0.4         |     0.4     | float |
        INFO - 13:57:00:          | x_1[1]      |     0.75    |         0.75        |     1.25    | float |
        INFO - 13:57:00:          | x_2         |     0.75    |         0.75        |     1.25    | float |
        INFO - 13:57:00:          | x_3         |     0.1     |  0.1562448753887276 |      1      | float |
        INFO - 13:57:00:          +-------------+-------------+---------------------+-------------+-------+
        INFO - 13:57:00: *** End MDOScenario execution (time: 0:00:00.996127) ***

    {'max_iter': 10, 'algo': 'SLSQP'}



.. GENERATED FROM PYTHON SOURCE LINES 95-103

Post-process scenario
---------------------
Lastly, we post-process the scenario by means of the
:class:`.ConstraintsHistory` plot which plots the history of constraints
passed as argument by the user. Each constraint history is represented by
a subplot where the value of the constraints is drawn by a line. Moreover,
the background color represents a qualitative view of these values: active
areas are white, violated ones are red and satisfied ones are green.

.. GENERATED FROM PYTHON SOURCE LINES 105-113

.. tip::

   Each post-processing method requires different inputs and offers a variety
   of customization options. Use the API function
   :func:`.get_post_processing_options_schema` to print a table with
   the options for any post-processing algorithm.
   Or refer to our dedicated page:
   :ref:`gen_post_algos`.

.. GENERATED FROM PYTHON SOURCE LINES 113-120

.. code-block:: Python


    scenario.post_process(
        "ConstraintsHistory",
        constraint_names=all_constraints,
        save=False,
        show=True,
    )



.. image-sg:: /examples/post_process/algorithms/images/sphx_glr_plot_constraints_history_001.png
   :alt: Evolution of the constraints w.r.t. iterations, g_1[0] (inequality), g_1[1] (inequality), g_1[2] (inequality), g_1[3] (inequality), g_1[4] (inequality), g_1[5] (inequality), g_1[6] (inequality), g_2 (inequality), g_3[0] (inequality), g_3[1] (inequality), g_3[2] (inequality), g_3[3] (inequality)
   :srcset: /examples/post_process/algorithms/images/sphx_glr_plot_constraints_history_001.png
   :class: sphx-glr-single-img


.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    <gemseo.post.constraints_history.ConstraintsHistory object at 0x7f2d11738be0>




.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 2.124 seconds)


.. _sphx_glr_download_examples_post_process_algorithms_plot_constraints_history.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: plot_constraints_history.ipynb <plot_constraints_history.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: plot_constraints_history.py <plot_constraints_history.py>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_