..
   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_formulation_algos:

Options for MDO Formulation algorithms
======================================


.. _BiLevel_options:

BiLevel
-------

Module: :class:`gemseo.formulations.bilevel`





Here are the options available in |g|:

.. 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">Options</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

****mda_options** (*Any*)

The options passed to the MDA at construction.



.. raw:: html

    </li>


    <li>

**apply_cstr_to_system** (*bool*)

Whether the :meth:`.add_constraint` method adds the constraint to the optimization problem of the system scenario.


By default it is set to True.


.. raw:: html

    </li>


    <li>

**apply_cstr_tosub_scenarios** (*bool*)

Whether the :meth:`.add_constraint` method adds the constraint to the optimization problem of the sub-scenario capable of computing the constraint.


By default it is set to True.


.. raw:: html

    </li>


    <li>

**design_space** (*DesignSpace*)

The design space.



.. raw:: html

    </li>


    <li>

**disciplines** (*Sequence[MDODiscipline]*)

The disciplines.



.. raw:: html

    </li>


    <li>

**grammar_type** (*str*)

The type of the input and output grammars, either :attr:`.MDODiscipline.JSON_GRAMMAR_TYPE` or :attr:`.MDODiscipline.SIMPLE_GRAMMAR_TYPE`.


By default it is set to JSONGrammar.


.. raw:: html

    </li>


    <li>

**maximize_objective** (*bool*)

If True, the objective function is maximized.


By default it is set to False.


.. raw:: html

    </li>


    <li>

**mda_name** (*str*)

The name of the MDA class to be used.


By default it is set to MDAChain.


.. raw:: html

    </li>


    <li>

**multithread_scenarios** (*bool*)

If True and parallel_scenarios=True, the sub-scenarios are run in parallel using multi-threading; if False and parallel_scenarios=True, multi-processing is used.


By default it is set to True.


.. raw:: html

    </li>


    <li>

**objective_name** (*str*)

The name of the objective function.



.. raw:: html

    </li>


    <li>

**parallel_scenarios** (*bool*)

Whether to run the sub-scenarios in parallel.


By default it is set to False.


.. raw:: html

    </li>


    <li>

**reset_x0_before_opt** (*bool*)

Whether to restart the sub optimizations from the initial guesses, otherwise warm start them.


By default it is set to False.


.. raw:: html

    </li>



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


.. _DisciplinaryOpt_options:

DisciplinaryOpt
---------------

Module: :class:`gemseo.formulations.disciplinary_opt`





Here are the options available in |g|:

.. 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">Options</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**design_space** (*DesignSpace*)

The design space.



.. raw:: html

    </li>


    <li>

**disciplines** (*Sequence[MDODiscipline]*)

The disciplines.



.. raw:: html

    </li>


    <li>

**grammar_type** (*str*)

The type of the input and output grammars, either :attr:`.MDODiscipline.JSON_GRAMMAR_TYPE` or :attr:`.MDODiscipline.SIMPLE_GRAMMAR_TYPE`.


By default it is set to JSONGrammar.


.. raw:: html

    </li>


    <li>

**maximize_objective** (*bool*)

If True, the objective function is maximized.


By default it is set to False.


.. raw:: html

    </li>


    <li>

**objective_name** (*str*)

The name of the objective function.



.. raw:: html

    </li>



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


.. _IDF_options:

IDF
---

Module: :class:`gemseo.formulations.idf`





Here are the options available in |g|:

.. 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">Options</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**design_space** (*DesignSpace*)

The design space.



.. raw:: html

    </li>


    <li>

**disciplines** (*Sequence[MDODiscipline]*)

The disciplines.



.. raw:: html

    </li>


    <li>

**grammar_type** (*str*)

The type of the input and output grammars, either :attr:`.MDODiscipline.JSON_GRAMMAR_TYPE` or :attr:`.MDODiscipline.SIMPLE_GRAMMAR_TYPE`.


By default it is set to JSONGrammar.


.. raw:: html

    </li>


    <li>

**maximize_objective** (*bool*)

If True, the objective function is maximized.


By default it is set to False.


.. raw:: html

    </li>


    <li>

**normalize_constraints** (*bool*)

If True, the outputs of the coupling consistency constraints are scaled.


By default it is set to True.


.. raw:: html

    </li>


    <li>

**objective_name** (*str*)

The name of the objective function.



.. raw:: html

    </li>


    <li>

**parallel_exec** (*bool*)

If True, all constraints and objectives are computed in parallel. At every iteration, all disciplines are executed in parallel. Otherwise, a separate constraint is created for each discipline with couplings.


By default it is set to False.


.. raw:: html

    </li>


    <li>

**start_at_equilibrium** (*bool*)

If True, an MDA is used to initialize the coupling variables.


By default it is set to False.


.. raw:: html

    </li>


    <li>

**use_threading** (*bool*)

If True and parallel_exec=True, the disciplines are run in parallel using multi-threading. If False and parallel_exec=True, multi-processing is used.


By default it is set to True.


.. raw:: html

    </li>



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


.. _MDF_options:

MDF
---

Module: :class:`gemseo.formulations.mdf`





Here are the options available in |g|:

.. 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">Options</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

****mda_options** (*Any*)

The options passed to the MDA at construction.



.. raw:: html

    </li>


    <li>

**design_space** (*DesignSpace*)

The design space.



.. raw:: html

    </li>


    <li>

**disciplines** (*Sequence[MDODiscipline]*)

The disciplines.



.. raw:: html

    </li>


    <li>

**grammar_type** (*str*)

The type of the input and output grammars, either :attr:`.MDODiscipline.JSON_GRAMMAR_TYPE` or :attr:`.MDODiscipline.SIMPLE_GRAMMAR_TYPE`.


By default it is set to JSONGrammar.


.. raw:: html

    </li>


    <li>

**main_mda_class** (*str*)

The name of the class used for the main MDA, typically the :class:`.MDAChain`, but one can force to use :class:`.MDAGaussSeidel` for instance.


By default it is set to MDAChain.


.. raw:: html

    </li>


    <li>

**maximize_objective** (*bool*)

If True, the objective function is maximized.


By default it is set to False.


.. raw:: html

    </li>


    <li>

**objective_name** (*str*)

The name of the objective function.



.. raw:: html

    </li>


    <li>

**sub_mda_class** (*str*)

The name of the class used for the sub-MDA.


By default it is set to MDAJacobi.


.. raw:: html

    </li>



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