..
   Copyright 2021 IRT Saint-Exupéry, https://www.irt-saintexupery.com

   This work is licensed under the Creative Commons Attribution-ShareAlike 4.0
   International License. To view a copy of this license, visit
   http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to Creative
   Commons, PO Box 1866, Mountain View, CA 94042, USA.

.. _gen_sensitivity_algos:

Sensitivity analysis algorithms
===============================

.. warning::
    Some algorithms may require the :ref:`installation <installation>` of |g| with :ref:`all its features <dependencies>`
    and some others may depend on :ref:`plugins <plugins>`.

.. note::
    All the features of the wrapped optimization libraries may not be exposed through |g|.

.. raw:: html

    <style>
    th {
      cursor: pointer;
    }

    th, td {
      text-align: center;
    }

    tr:hover {
        border: 1px solid black;
    }

    tr:nth-child(even) {
      background-color: #f2f2f2
    }
    </style>

    <script>
    function sortTable(n) {
      var table, rows, switching, i, x, y, shouldSwitch, dir, switchcount = 0;
      table = document.getElementById("myTable");
      switching = true;
      dir = "asc";
      while (switching) {
        switching = false;
        rows = table.rows;
        for (i = 1; i < (rows.length - 1); i++) {
          shouldSwitch = false;
          x = rows[i].getElementsByTagName("TD")[n];
          y = rows[i + 1].getElementsByTagName("TD")[n];
          if (dir == "asc") {
            if (x.innerHTML.toLowerCase() > y.innerHTML.toLowerCase()) {
              shouldSwitch= true;
              break;
            }
          } else if (dir == "desc") {
            if (x.innerHTML.toLowerCase() < y.innerHTML.toLowerCase()) {
              shouldSwitch = true;
              break;
            }
          }
        }
        if (shouldSwitch) {
          rows[i].parentNode.insertBefore(rows[i + 1], rows[i]);
          switching = true;
          switchcount ++;
        } else {
          if (switchcount == 0 && dir == "asc") {
            dir = "desc";
            switching = true;
          }
        }
      }
    }
    </script>



.. _CorrelationAnalysis_options:

CorrelationAnalysis
-------------------



Module: :class:`gemseo.uncertainty.sensitivity.correlation.analysis`





.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />































































    <dl class="field-list simple">
    <dt class="field-odd">Required parameters</dt>
    <dd class="field-odd"><ul class="simple">

    <li>

**disciplines** : *Collection[MDODiscipline]*

The discipline or disciplines to use for the analysis.

.. raw:: html

    </li>

    <li>

**n_samples** : *int*

A number of samples. If ``None``, the number of samples is computed by the algorithm.

.. raw:: html

    </li>

    <li>

**parameter_space** : *ParameterSpace*

A parameter space.

.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



    <dl class="field-list simple">
    <dt class="field-odd">Optional parameters</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**algo** : *str | None, optional*

The name of the DOE algorithm. If ``None``, use the :attr:`.SensitivityAnalysis.DEFAULT_DRIVER`.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**algo_options** : *Mapping[str, DOELibraryOptionType] | None, optional*

The options of the DOE algorithm.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**formulation** : *str, optional*

The name of the :class:`.MDOFormulation` to sample the disciplines.


By default it is set to MDF.


.. raw:: html

    </li>

    <li>

**output_names** : *Iterable[str] | None, optional*

The disciplines' outputs to be considered for the analysis. If ``None``, use all the outputs.


By default it is set to None.


.. raw:: html

    </li>

    <li>

****formulation_options** : *Any*

The options of the :class:`.MDOFormulation`.



.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _MorrisAnalysis_options:

MorrisAnalysis
--------------



Module: :class:`gemseo.uncertainty.sensitivity.morris.analysis`





.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />











































































    <dl class="field-list simple">
    <dt class="field-odd">Required parameters</dt>
    <dd class="field-odd"><ul class="simple">

    <li>

**disciplines** : *Collection[MDODiscipline]*

The discipline or disciplines to use for the analysis.

.. raw:: html

    </li>

    <li>

**n_samples** : *int | None*

A number of samples. If ``None``, the number of samples is computed by the algorithm.

.. raw:: html

    </li>

    <li>

**parameter_space** : *ParameterSpace*

A parameter space.

.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



    <dl class="field-list simple">
    <dt class="field-odd">Optional parameters</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**algo** : *str | None, optional*

The name of the DOE algorithm. If ``None``, use the :attr:`.SensitivityAnalysis.DEFAULT_DRIVER`.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**algo_options** : *Mapping[str, DOELibraryOptionType] | None, optional*

The options of the DOE algorithm.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**formulation** : *str, optional*

The name of the :class:`.MDOFormulation` to sample the disciplines.


By default it is set to MDF.


.. raw:: html

    </li>

    <li>

**n_replicates** : *int, optional*

The number of times the OAT method is repeated. Used only if ``n_samples`` is None. Otherwise, this number is the greater integer :math:`r` such that :math:`r(d+1)\leq` ``n_samples`` and :math:`r(d+1)` is the number of samples actually carried out.


By default it is set to 5.


.. raw:: html

    </li>

    <li>

**output_names** : *Iterable[str] | None, optional*

The disciplines' outputs to be considered for the analysis. If ``None``, use all the outputs.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**step** : *float, optional*

The finite difference step of the OAT method.


By default it is set to 0.05.


.. raw:: html

    </li>

    <li>

****formulation_options** : *Any*

The options of the :class:`.MDOFormulation`.



.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _SobolAnalysis_options:

SobolAnalysis
-------------



Module: :class:`gemseo.uncertainty.sensitivity.sobol.analysis`





.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />































































    <dl class="field-list simple">
    <dt class="field-odd">Required parameters</dt>
    <dd class="field-odd"><ul class="simple">

    <li>

**disciplines** : *Collection[MDODiscipline]*

The discipline or disciplines to use for the analysis.

.. raw:: html

    </li>

    <li>

**n_samples** : *int*

A number of samples. If ``None``, the number of samples is computed by the algorithm.

.. raw:: html

    </li>

    <li>

**parameter_space** : *ParameterSpace*

A parameter space.

.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



    <dl class="field-list simple">
    <dt class="field-odd">Optional parameters</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**algo** : *str | None, optional*

The name of the DOE algorithm. If ``None``, use the :attr:`.SensitivityAnalysis.DEFAULT_DRIVER`.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**algo_options** : *Mapping[str, DOELibraryOptionType] | None, optional*

The options of the DOE algorithm.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**formulation** : *str, optional*

The name of the :class:`.MDOFormulation` to sample the disciplines.


By default it is set to MDF.


.. raw:: html

    </li>

    <li>

**output_names** : *Iterable[str] | None, optional*

The disciplines' outputs to be considered for the analysis. If ``None``, use all the outputs.


By default it is set to None.


.. raw:: html

    </li>

    <li>

****formulation_options** : *Any*

The options of the :class:`.MDOFormulation`.



.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>