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

.. only:: html

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

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

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

.. _sphx_glr_examples_api_plot_discipline.py:


Discipline
==========

.. GENERATED FROM PYTHON SOURCE LINES 25-46

.. code-block:: Python


    from __future__ import annotations

    from numpy import array

    from gemseo import configure_logger
    from gemseo import create_discipline
    from gemseo import generate_coupling_graph
    from gemseo import generate_n2_plot
    from gemseo import get_available_disciplines
    from gemseo import get_discipline_inputs_schema
    from gemseo import get_discipline_options_defaults
    from gemseo import get_discipline_options_schema
    from gemseo import get_discipline_outputs_schema
    from gemseo.core.discipline import MDODiscipline
    from gemseo.disciplines.utils import get_all_inputs
    from gemseo.disciplines.utils import get_all_outputs

    configure_logger()






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

 .. code-block:: none


    <RootLogger root (INFO)>



.. GENERATED FROM PYTHON SOURCE LINES 47-58

In this example, we will discover the different functions of the API
related to disciplines, which are the |g|' objects
dedicated to the representation of an input-output process. All classes
implementing disciplines inherit from :class:`.MDODiscipline` which is an
abstract class.

Get available disciplines
-------------------------

The :func:`.get_available_disciplines` function
can list the available disciplines:

.. GENERATED FROM PYTHON SOURCE LINES 58-61

.. code-block:: Python


    get_available_disciplines()





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

 .. code-block:: none


    ['Aerodynamics', 'AnalyticDiscipline', 'AutoPyDiscipline', 'BaseDiscipline', 'CalibrationScenario', 'Calibrator', 'Concatenater', 'ConstraintAggregation', 'DOEScenario', 'DensityFilter', 'DiscFromExe', 'FilteringDiscipline', 'FininiteElementAnalysis', 'IshigamiDiscipline', 'JEPJavaDiscipline', 'JavaDiscipline', 'JobSchedulerDisciplineWrapper', 'LSF', 'LinearCombination', 'LinearDiscipline', 'MDOAdditiveChain', 'MDOChain', 'MDODiscipline', 'MDOObjectiveScenarioAdapter', 'MDOParallelChain', 'MDOScenario', 'MDOScenarioAdapter', 'MDOWarmStartedChain', 'MainDiscipline', 'MaterialModelInterpolation', 'MatlabDiscipline', 'Mission', 'PropaneComb1', 'PropaneComb2', 'PropaneComb3', 'PropaneReaction', 'RemappingDiscipline', 'RosenMF', 'SLURM', 'ScalableDiscipline', 'Scenario', 'ScilabDiscipline', 'Sellar1', 'Sellar2', 'SellarSystem', 'SobieskiAerodynamics', 'SobieskiAerodynamicsSG', 'SobieskiChain', 'SobieskiDiscipline', 'SobieskiDisciplineWithSimpleGrammar', 'SobieskiMDAGaussSeidel', 'SobieskiMDAJacobi', 'SobieskiMission', 'SobieskiMissionSG', 'SobieskiPropulsion', 'SobieskiPropulsionSG', 'SobieskiStructure', 'SobieskiStructureSG', 'Splitter', 'Structure', 'SurrogateDiscipline', 'TaylorDiscipline', 'VolumeFraction', 'XLSDiscipline']



.. GENERATED FROM PYTHON SOURCE LINES 62-68

Create a discipline
-------------------
The :func:`.create_discipline` function can create a
:class:`.MDODiscipline` or a list of :class:`.MDODiscipline`
by using its class name. Specific ``**options`` can be provided in
argument. E.g.

.. GENERATED FROM PYTHON SOURCE LINES 68-75

.. code-block:: Python

    disciplines = create_discipline([
        "SobieskiPropulsion",
        "SobieskiAerodynamics",
        "SobieskiMission",
        "SobieskiStructure",
    ])
    type(disciplines), type(disciplines[0]), isinstance(disciplines[0], MDODiscipline)




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

 .. code-block:: none


    (<class 'list'>, <class 'gemseo.problems.mdo.sobieski.disciplines.SobieskiPropulsion'>, True)



.. GENERATED FROM PYTHON SOURCE LINES 76-79

This function can also be used to create a particular :class:`.MDODiscipline`
from scratch, such as :class:`.AnalyticDiscipline`
or :class:`.AutoPyDiscipline`. E.g.

.. GENERATED FROM PYTHON SOURCE LINES 79-82

.. code-block:: Python

    addition = create_discipline("AnalyticDiscipline", expressions={"y": "x1+x2"})
    addition.execute({"x1": array([1.0]), "x2": array([2.0])})





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

 .. code-block:: none


    {'x1': array([1.]), 'x2': array([2.]), 'y': array([3.])}



.. GENERATED FROM PYTHON SOURCE LINES 83-89

Get all inputs/outputs
----------------------
The :func:`~gemseo.disciplines.utils.get_all_inputs` function can list all the inputs
of a list of disciplines, including the sub-disciplines if the
argument ``recursive`` (default: ``False``) is ``True``,
merging the input data from the discipline grammars. E.g.

.. GENERATED FROM PYTHON SOURCE LINES 89-91

.. code-block:: Python

    get_all_inputs(disciplines)





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

 .. code-block:: none


    ['c_0', 'c_1', 'c_2', 'c_3', 'c_4', 'x_1', 'x_2', 'x_3', 'x_shared', 'y_12', 'y_14', 'y_21', 'y_23', 'y_24', 'y_31', 'y_32', 'y_34']



.. GENERATED FROM PYTHON SOURCE LINES 92-96

The :func:`~gemseo.disciplines.utils.get_all_outputs` function can list all the inputs
of a list of disciplines, including the sub-disciplines if the
argument ``recursive`` (default: ``False``) is ``True``,
merging the input data from the discipline grammars. E.g.

.. GENERATED FROM PYTHON SOURCE LINES 96-98

.. code-block:: Python

    get_all_outputs(disciplines)





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

 .. code-block:: none


    ['g_1', 'g_2', 'g_3', 'y_1', 'y_11', 'y_12', 'y_14', 'y_2', 'y_21', 'y_23', 'y_24', 'y_3', 'y_31', 'y_32', 'y_34', 'y_4']



.. GENERATED FROM PYTHON SOURCE LINES 99-104

Get discipline schemas for inputs, outputs and options
------------------------------------------------------

- The function :func:`.get_discipline_inputs_schema` returns
  the inputs of a discipline. E.g.

.. GENERATED FROM PYTHON SOURCE LINES 104-106

.. code-block:: Python

    get_discipline_inputs_schema(disciplines[0])





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

 .. code-block:: none


    {'$schema': 'http://json-schema.org/draft-04/schema', 'type': 'object', 'properties': {'y_23': {'type': 'array', 'items': {'type': 'number'}}, 'x_3': {'type': 'array', 'items': {'type': 'number'}}, 'x_shared': {'type': 'array', 'items': {'type': 'number'}}, 'c_3': {'description': 'engine weight reference', 'type': 'array', 'items': {'type': 'number'}}}, 'required': ['c_3', 'x_3', 'x_shared', 'y_23']}



.. GENERATED FROM PYTHON SOURCE LINES 107-109

- The function :func:`.get_discipline_outputs_schema` returns
  the outputs of a discipline. E.g.

.. GENERATED FROM PYTHON SOURCE LINES 109-111

.. code-block:: Python

    get_discipline_outputs_schema(disciplines[0])





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

 .. code-block:: none


    {'$schema': 'http://json-schema.org/draft-04/schema', 'type': 'object', 'properties': {'y_32': {'type': 'array', 'items': {'type': 'number'}}, 'y_31': {'type': 'array', 'items': {'type': 'number'}}, 'g_3': {'type': 'array', 'items': {'type': 'number'}}, 'y_3': {'type': 'array', 'items': {'type': 'number'}}, 'y_34': {'type': 'array', 'items': {'type': 'number'}}}, 'required': ['g_3', 'y_3', 'y_31', 'y_32', 'y_34']}



.. GENERATED FROM PYTHON SOURCE LINES 112-114

- The function :func:`.get_discipline_options_schema` returns
  the options of a discipline. E.g.

.. GENERATED FROM PYTHON SOURCE LINES 114-116

.. code-block:: Python

    get_discipline_options_schema("SobieskiMission")





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

 .. code-block:: none


    {'$schema': 'http://json-schema.org/draft-04/schema', 'type': 'object', 'properties': {'linearization_mode': {'description': 'Linearization mode', 'enum': ['auto', 'direct', 'reverse', 'adjoint'], 'type': 'string'}, 'jac_approx_type': {'description': 'Jacobian approximation type', 'enum': ['finite_differences', 'complex_step'], 'type': 'string'}, 'jax_approx_step': {'minimum': 0, 'exclusiveMinimum': True, 'description': 'Step for finite differences or complex step for Jacobian approximation', 'type': 'number'}, 'jac_approx_use_threading': {'description': 'if True, use Threads instead of processes\n to parallelize the execution. \nMultiprocessing will serialize all the disciplines, \nwhile multithreading will share all the memory.\n This is important to note if you want to execute the same\n  discipline multiple times, you shall use multiprocessing', 'type': 'boolean'}, 'jac_approx_wait_time': {'description': 'Time waited between two forks of the process or thread when using parallel jacobian approximations (parallel=True)', 'minimum': 0, 'type': 'number'}, 'jac_approx_n_processes': {'minimum': 1, 'description': 'maximum number of processors or threads on \nwhich the jacobian approximation is performed\n by default, 1 means no parallel calculations', 'type': 'integer'}, 'cache_type': {'description': 'Type of cache to be used.  \nBy default, simple cache stores the last execution inputs and outputs  \nin memory only to avoid computation of the outputs if the inputs are identical.\n To store more executions, use HDF5 caches, which stores data on the disk.\n There is a hashing mechanism which avoids reading on the disk for every calculation.', 'type': 'string'}, 'cache_tolerance': {'minimum': 0, 'description': 'Numerical tolerance on the relative norm of input vectors \n to consider that two sets of inputs are equal, and that the outputs may therefore be returned from the cache without calculations.', 'type': 'number'}, 'cache_hdf_file': {'format': 'uri', 'description': 'Path to the HDF5 file to store the cache data.', 'type': 'string'}, 'cache_hdf_node_path': {'description': 'Name of the HDF dataset to store the discipline\n data. If ``None``, the discipline name is used.', 'type': 'string'}, 'dtype': {'description': 'The data type for the NumPy arrays, either "float64" or "complex128".', 'type': 'string'}, 'enable_delay': {'description': 'If ``True``, wait one second before computation. If a positive number, wait the corresponding number of seconds. If ``False``, compute directly.', 'type': 'boolean'}}}



.. GENERATED FROM PYTHON SOURCE LINES 117-119

- The function :func:`.get_discipline_options_defaults`
  can get the default option values of a discipline. E.g.

.. GENERATED FROM PYTHON SOURCE LINES 119-121

.. code-block:: Python

    get_discipline_options_defaults("SobieskiMission")





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

 .. code-block:: none


    {'dtype': <DataType.FLOAT: 'float64'>, 'enable_delay': False}



.. GENERATED FROM PYTHON SOURCE LINES 122-126

Plot coupling structure
-----------------------
The :func:`.generate_coupling_graph` function plots the
coupling graph of a set of :class:`.MDODiscipline`:

.. GENERATED FROM PYTHON SOURCE LINES 126-131

.. code-block:: Python

    generate_coupling_graph(disciplines, file_path="full_coupling_graph.pdf")
    generate_coupling_graph(
        disciplines, file_path="condensed_coupling_graph.pdf", full=False
    )






.. raw:: html

    <div class="output_subarea output_html rendered_html output_result">
    <?xml version="1.0" encoding="UTF-8" standalone="no"?>
    <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
     "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
    <!-- Generated by graphviz version 2.43.0 (0)
     -->
    <!-- Title: %3 Pages: 1 -->
    <svg width="681pt" height="218pt"
     viewBox="0.00 0.00 681.34 218.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
    <g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 214)">
    <title>%3</title>
    <polygon fill="white" stroke="transparent" points="-4,4 -4,-214 677.34,-214 677.34,4 -4,4"/>
    <!-- MDA of SobieskiPropulsion, SobieskiAerodynamics, SobieskiStructure -->
    <g id="node1" class="node">
    <title>MDA of SobieskiPropulsion, SobieskiAerodynamics, SobieskiStructure</title>
    <ellipse fill="none" stroke="black" cx="336.67" cy="-192" rx="336.84" ry="18"/>
    <text text-anchor="middle" x="336.67" y="-188.3" font-family="Times,serif" font-size="14.00">MDA of SobieskiPropulsion, SobieskiAerodynamics, SobieskiStructure</text>
    </g>
    <!-- SobieskiMission -->
    <g id="node2" class="node">
    <title>SobieskiMission</title>
    <ellipse fill="none" stroke="black" cx="336.67" cy="-105" rx="85.59" ry="18"/>
    <text text-anchor="middle" x="336.67" y="-101.3" font-family="Times,serif" font-size="14.00">SobieskiMission</text>
    </g>
    <!-- MDA of SobieskiPropulsion, SobieskiAerodynamics, SobieskiStructure&#45;&gt;SobieskiMission -->
    <g id="edge1" class="edge">
    <title>MDA of SobieskiPropulsion, SobieskiAerodynamics, SobieskiStructure&#45;&gt;SobieskiMission</title>
    <path fill="none" stroke="black" d="M336.67,-173.8C336.67,-162.16 336.67,-146.55 336.67,-133.24"/>
    <polygon fill="black" stroke="black" points="340.17,-133.18 336.67,-123.18 333.17,-133.18 340.17,-133.18"/>
    <text text-anchor="middle" x="391.17" y="-144.8" font-family="Times,serif" font-size="14.00">y_14,y_24,y_34</text>
    </g>
    <!-- _0 -->
    <!-- SobieskiMission&#45;&gt;_0 -->
    <g id="edge2" class="edge">
    <title>SobieskiMission&#45;&gt;_0</title>
    <path fill="none" stroke="black" d="M336.67,-86.8C336.67,-75.16 336.67,-59.55 336.67,-46.24"/>
    <polygon fill="black" stroke="black" points="340.17,-46.18 336.67,-36.18 333.17,-46.18 340.17,-46.18"/>
    <text text-anchor="middle" x="349.17" y="-57.8" font-family="Times,serif" font-size="14.00">y_4</text>
    </g>
    </g>
    </svg>

    </div>
    <br />
    <br />

.. GENERATED FROM PYTHON SOURCE LINES 132-134

The :func:`.generate_n2_plot` function plots the N2 diagram of
a set of :class:`.MDODiscipline`:

.. GENERATED FROM PYTHON SOURCE LINES 134-135

.. code-block:: Python

    generate_n2_plot(disciplines, save=False, show=True)



.. image-sg:: /examples/api/images/sphx_glr_plot_discipline_001.png
   :alt: plot discipline
   :srcset: /examples/api/images/sphx_glr_plot_discipline_001.png
   :class: sphx-glr-single-img






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

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


.. _sphx_glr_download_examples_api_plot_discipline.py:

.. only:: html

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

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

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

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

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


.. only:: html

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

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