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

Disciplines
===========

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

.. warning::
   All the features of the wrapped 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>



.. _Aerodynamics_options:

Aerodynamics
------------



Module: :class:`gemseo.problems.mdo.aerostructure.aerostructure`






















.. _AnalyticDiscipline_options:

AnalyticDiscipline
------------------



Module: :class:`gemseo.disciplines.analytic`






























.. raw:: html

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

    <li>

**expressions** : *Mapping[str, str | Expr]*

The outputs expressed as functions of the inputs.

.. raw:: html

    </li>

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



.. raw:: html

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


    <li>

**name** : *str*

The name of the discipline.
If empty, use the name of the class.


By default it is set to .


.. raw:: html

    </li>

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



.. _ArrayBasedFunctionDiscipline_options:

ArrayBasedFunctionDiscipline
----------------------------



Module: :class:`gemseo.disciplines.array_based_function`










































.. raw:: html

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

    <li>

**function** : *Callable[[RealArray], RealArray]*

The function of interest
whose both the unique argument and the output are NumPy arrays.

.. raw:: html

    </li>

    <li>

**input_names_to_sizes** : *dict[str, int]*

The mapping from the names to the sizes for the input.

.. raw:: html

    </li>

    <li>

**output_names_to_sizes** : *dict[str, int]*

The mapping
from the names to the sizes for the output.

.. raw:: html

    </li>

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



.. raw:: html

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


    <li>

**jac_function** : *Callable[[RealArray], RealArray] | None, optional*

The function
computing the derivatives of the function of interest;
both its unique argument and its output (i.e. a Jacobian matrix)
are NumPy arrays.
If ``None``, the derivatives will have to be approximated if required.


By default it is set to None.


.. raw:: html

    </li>

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



.. _AutoPyDiscipline_options:

AutoPyDiscipline
----------------



Module: :class:`gemseo.disciplines.auto_py`










































.. raw:: html

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

    <li>

**py_func** : *Callable*

The Python function to compute the outputs from the inputs.

.. raw:: html

    </li>

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



.. raw:: html

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


    <li>

**name** : *str*

The name of the discipline.
If empty, use the name of the Python function.


By default it is set to .


.. raw:: html

    </li>

    <li>

**py_jac** : *Callable | None, optional*

The Python function to compute the Jacobian from the inputs;
its output value must be a 2D NumPy array
with rows corresponding to the outputs and columns to the inputs.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**use_arrays** : *bool, optional*

Whether the function is expected
to take arrays as inputs and give outputs as arrays.


By default it is set to False.


.. raw:: html

    </li>

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



.. _Concatenater_options:

Concatenater
------------



Module: :class:`gemseo.disciplines.concatenater`




































.. raw:: html

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

    <li>

**input_variables** : *Sequence[str]*

The input variables to concatenate.

.. raw:: html

    </li>

    <li>

**output_variable** : *str*

The output variable name.

.. raw:: html

    </li>

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



.. raw:: html

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


    <li>

**input_coefficients** : *dict[str, float] | None, optional*

The coefficients
related to the different input variables.


By default it is set to None.


.. raw:: html

    </li>

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



.. _ConstraintAggregation_options:

ConstraintAggregation
---------------------



Module: :class:`gemseo.disciplines.constraint_aggregation`













































.. raw:: html

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

    <li>

**aggregation_function** : *EvaluationFunction*

The aggregation function or its name,
e.g. IKS, lower_bound_KS,upper_bound_KS, POS_SUM and SUM.

.. raw:: html

    </li>

    <li>

**constraint_names** : *Sequence[str]*

The names of the constraints to aggregate,
which must be discipline outputs.

.. raw:: html

    </li>

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



.. raw:: html

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


    <li>

**name** : *str*

The name of the discipline.
If empty, use the name of the class.


By default it is set to .


.. raw:: html

    </li>

    <li>

****options** : *Any, optional*

The options for the aggregation method.



.. raw:: html

    </li>

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



.. _DensityFilter_options:

DensityFilter
-------------



Module: :class:`gemseo.problems.topology_optimization.density_filter_disc`












































.. raw:: html

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


    <li>

**min_member_size** : *float, optional*

The minimum structural member size.


By default it is set to 1.5.


.. raw:: html

    </li>

    <li>

**n_x** : *int, optional*

The number of elements in the x-direction.


By default it is set to 100.


.. raw:: html

    </li>

    <li>

**n_y** : *int, optional*

The number of elements in the y-direction.


By default it is set to 100.


.. raw:: html

    </li>

    <li>

**name** : *str*

The name of the discipline.
If empty, use the name of the class.


By default it is set to .


.. raw:: html

    </li>

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



.. _DiscFromExe_options:

DiscFromExe
-----------



Module: :class:`gemseo.disciplines.wrappers.disc_from_exe`


























































































.. raw:: html

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

    <li>

**command_line** : *str*

The command line to run the executable.
E.g. ``python my_script.py -i input.txt -o output.txt``

.. raw:: html

    </li>

    <li>

**input_filename** : *str | Path*

The name of the input file
to be generated in the output folder.
E.g. ``"input.txt"``.

.. raw:: html

    </li>

    <li>

**input_template** : *str | Path*

The path to the input template file.
The input locations in the file are marked
by ``GEMSEO_INPUT{input_name::1.0}``,
where ``input_name`` is the name of the input variable,
and ``1.0`` is its default value.

.. raw:: html

    </li>

    <li>

**output_filename** : *str | Path*

The name of the output file
to be generated in the output folder.
E.g. ``"output.txt"``.

.. raw:: html

    </li>

    <li>

**output_template** : *str | Path*

The path to the output template file.
The output locations in the file are marked
by ``GEMSEO_OUTPUT{output_name::1.0}``,
where ``output_name`` is the name of the output variable,
and ``1.0`` is its default value.

.. raw:: html

    </li>

    <li>

**root_directory** : *str | Path*

The base path of the execution directories.

.. raw:: html

    </li>

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



.. raw:: html

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


    <li>

**clean_after_execution** : *bool, optional*

Whether to clean the last created directory after
execution.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**directory_naming_method** : *DirectoryNamingMethod, optional*

The method to create the execution directories.


By default it is set to NUMBERED.


.. raw:: html

    </li>

    <li>

**name** : *str*

The name of the discipline.
If empty, use the name of the class.


By default it is set to .


.. raw:: html

    </li>

    <li>

**parse_out_separator** : *str, optional*

The separator used for the
:attr:`~.Parser.KEY_VALUE` output parser.


By default it is set to =.


.. raw:: html

    </li>

    <li>

**parse_outfile_method** : *Parser | OutputParser, optional*

The optional method that can be provided
by the user to parse the output template file.
If the :attr:`~.Parser.KEY_VALUE` is used as
output parser, the user may specify the separator key.


By default it is set to TEMPLATE.


.. raw:: html

    </li>

    <li>

**write_input_file_method** : *InputWriter | None, optional*

The method to write the input data file.
If ``None``,
use :func:`~.write_input_file`.


By default it is set to None.


.. raw:: html

    </li>

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



.. _FilteringDiscipline_options:

FilteringDiscipline
-------------------



Module: :class:`gemseo.disciplines.wrappers.filtering_discipline`
















































.. raw:: html

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

    <li>

**discipline** : *Discipline*

The original discipline.

.. raw:: html

    </li>

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



.. raw:: html

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


    <li>

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

The names of the inputs of interest.
If ``None``, use all the inputs.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**keep_in** : *bool, optional*

Whether to keep the inputs of interest.
Otherwise, remove them.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**keep_out** : *bool, optional*

Whether to keep the outputs of interest.
Otherwise, remove them.


By default it is set to True.


.. raw:: html

    </li>

    <li>

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

The names of the outputs of interest.
If ``None``, use all the outputs.


By default it is set to None.


.. raw:: html

    </li>

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



.. _FiniteElementAnalysis_options:

FiniteElementAnalysis
---------------------



Module: :class:`gemseo.problems.topology_optimization.fea_disc`










































































.. raw:: html

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


    <li>

**f_amplitude** : *int | Sequence[int], optional*

The force amplitude for each pair ``(f_node, f_direction)``.


By default it is set to -1.


.. raw:: html

    </li>

    <li>

**f_direction** : *int | Sequence[int], optional*

The force direction for each ``f_node``,
either 0 for x or 1 for y.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**f_node** : *int | Sequence[int], optional*

The indices of the nodes where the forces are applied.


By default it is set to 10200.


.. raw:: html

    </li>

    <li>

**fixed_dir** : *int | Sequence[int] | None, optional*

The clamped direction for each node, encode 0 for x and 1 for y.
If ``None``, a default value is used.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**fixed_nodes** : *int | Sequence[int] | None, optional*

The indices of the nodes where the structure is clamped.
If ``None``, a default value is used.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**n_x** : *int, optional*

The number of elements in the x-direction.


By default it is set to 100.


.. raw:: html

    </li>

    <li>

**n_y** : *int, optional*

The number of elements in the y-direction.


By default it is set to 100.


.. raw:: html

    </li>

    <li>

**name** : *str*

The name of the discipline.
If empty, use the name of the class.


By default it is set to .


.. raw:: html

    </li>

    <li>

**nu** : *float, optional*

The material Poisson's ratio.


By default it is set to 0.3.


.. raw:: html

    </li>

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



.. _IshigamiDiscipline_options:

IshigamiDiscipline
------------------



Module: :class:`gemseo.problems.uncertainty.ishigami.ishigami_discipline`






















.. _JobSchedulerDisciplineWrapper_options:

JobSchedulerDisciplineWrapper
-----------------------------



Module: :class:`gemseo.disciplines.wrappers.job_schedulers.discipline_wrapper`




























































.. raw:: html

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

    <li>

**discipline** : *Discipline*

The discipline to wrap in the job scheduler.

.. raw:: html

    </li>

    <li>

**workdir_path** : *Path*

The path to the workdir where the files will be generated.

.. raw:: html

    </li>

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



.. raw:: html

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


    <li>

**job_out_filename** : *str, optional*

The output job file name.


By default it is set to batch.srun.


.. raw:: html

    </li>

    <li>

**job_template_path** : *Path | str | None, optional*

The path to the template to be used to make a
submission to the job scheduler command.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**scheduler_run_command** : *str, optional*

The command to call the job scheduler and submit
the generated script.


By default it is set to sbatch --wait.


.. raw:: html

    </li>

    <li>

**setup_cmd** : *str*

The command used before running the executable.


By default it is set to .


.. raw:: html

    </li>

    <li>

**use_template** : *bool, optional*

whether to use template based interface to the job scheduler.


By default it is set to True.


.. raw:: html

    </li>

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



.. _LSF_options:

LSF
---



Module: :class:`gemseo.disciplines.wrappers.job_schedulers.lsf`





























































































.. raw:: html

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

    <li>

**discipline** : *Discipline*

The discipline to wrap in the job scheduler.

.. raw:: html

    </li>

    <li>

**workdir_path** : *Path*

The path to the workdir where the files will be generated.

.. raw:: html

    </li>

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



.. raw:: html

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


    <li>

**job_out_filename** : *str, optional*

The output job file name.


By default it is set to batch.sh.


.. raw:: html

    </li>

    <li>

**job_template_path** : *Path | str | None, optional*

The path to the template to be used to make a
submission to the job scheduler command.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**mem_per_cpu** : *str, optional*

The memory per CPU.


By default it is set to 1G.


.. raw:: html

    </li>

    <li>

**ntasks** : *int, optional*

The number of tasks.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**ntasks_per_node** : *int, optional*

The number of tasks per node.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**scheduler_run_command** : *str, optional*

The command to call the job scheduler and submit
the generated script.


By default it is set to bsub -K.


.. raw:: html

    </li>

    <li>

**setup_cmd** : *str*

The command used before running the executable.


By default it is set to .


.. raw:: html

    </li>

    <li>

**user_email** : *str*

The user email to send the run status.


By default it is set to .


.. raw:: html

    </li>

    <li>

**wall_time** : *str, optional*

The wall time.


By default it is set to 24:00:00.


.. raw:: html

    </li>

    <li>

****options** : *dict[str:Any], optional*

The job scheduler specific options to be used in the template.



.. raw:: html

    </li>

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



.. _LinearCombination_options:

LinearCombination
-----------------



Module: :class:`gemseo.disciplines.linear_combination`
















































.. raw:: html

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

    <li>

**input_names** : *Iterable[str]*

The names of input variables.

.. raw:: html

    </li>

    <li>

**output_name** : *str*

The name of the output variable.

.. raw:: html

    </li>

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



.. raw:: html

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


    <li>

**input_coefficients** : *dict[str, float] | None, optional*

The coefficients related to the input variables.
If ``None``, use 1 for all the input variables.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**input_size** : *int | None, optional*

The size of the inputs.
If ``None``, the default inputs are initialized with size 1 arrays.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**offset** : *float, optional*

The output value when all the input variables are equal to zero.


By default it is set to 0.0.


.. raw:: html

    </li>

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



.. _LinearDiscipline_options:

LinearDiscipline
----------------



Module: :class:`gemseo.problems.mdo.scalable.linear.linear_discipline`


































































.. raw:: html

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

    <li>

**input_names** : *Sequence[str]*

The input data names.

.. raw:: html

    </li>

    <li>

**name** : *str*

The discipline name.

.. raw:: html

    </li>

    <li>

**output_names** : *Sequence[str]*

The output data names.

.. raw:: html

    </li>

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



.. raw:: html

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


    <li>

**inputs_size** : *int, optional*

The size of input data vectors,
each input data is of shape (inputs_size,).


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**matrix_density** : *float, optional*

The percentage of non-zero elements when the matrix is
sparse.


By default it is set to 0.1.


.. raw:: html

    </li>

    <li>

**matrix_format** : *MatrixFormat, optional*

The format of the Jacobian matrix.


By default it is set to dense.


.. raw:: html

    </li>

    <li>

**matrix_free_jacobian** : *bool, optional*

Whether the Jacobians are casted as linear operators.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**outputs_size** : *int, optional*

The size of output data vectors,
each output data is of shape (outputs_size,).


By default it is set to 1.


.. raw:: html

    </li>

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



.. _MDOAdditiveChain_options:

MDOAdditiveChain
----------------



Module: :class:`gemseo.core.chains.additive_chain`
















































.. raw:: html

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

    <li>

**disciplines** : *Sequence[Discipline]*

The disciplines.

.. raw:: html

    </li>

    <li>

**outputs_to_sum** : *Iterable[str]*

The names of the outputs to sum.

.. raw:: html

    </li>

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



.. raw:: html

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


    <li>

**n_processes** : *int | None, optional*

The maximum simultaneous number of threads,
if ``use_threading`` is True, or processes otherwise,
used to parallelize the execution.
If ``None``, uses the number of disciplines.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**name** : *str*

The name of the discipline.
If ``None``, use the class name.


By default it is set to .


.. raw:: html

    </li>

    <li>

**use_threading** : *bool, optional*

Whether to use threads instead of processes
to parallelize the execution;
multiprocessing will copy (serialize) all the disciplines,
while threading will share all the memory.
This is important to note
if you want to execute the same discipline multiple times,
you shall use multiprocessing.


By default it is set to True.


.. raw:: html

    </li>

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



.. _MDOChain_options:

MDOChain
--------



Module: :class:`gemseo.core.chains.chain`






























.. raw:: html

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

    <li>

**disciplines** : *Sequence[Discipline]*

The disciplines.

.. raw:: html

    </li>

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



.. raw:: html

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


    <li>

**name** : *str*

The name of the discipline.
If ``None``, use the class name.


By default it is set to .


.. raw:: html

    </li>

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



.. _MDOInitializationChain_options:

MDOInitializationChain
----------------------



Module: :class:`gemseo.core.chains.initialization_chain`




































.. raw:: html

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

    <li>

**disciplines** : *Sequence[Discipline]*

The disciplines.

.. raw:: html

    </li>

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



.. raw:: html

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


    <li>

**available_data_names** : *Iterable[str], optional*

The data names that are assumed to be available
at runtime, in addition to the default_input_data.


By default it is set to ().


.. raw:: html

    </li>

    <li>

**name** : *str*

The name of the discipline.
If ``None``, use the class name.


By default it is set to .


.. raw:: html

    </li>

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



.. _MDOObjectiveScenarioAdapter_options:

MDOObjectiveScenarioAdapter
---------------------------



Module: :class:`gemseo.disciplines.scenario_adapters.mdo_objective_scenario_adapter`




















































































.. raw:: html

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

    <li>

**input_names** : *Sequence[str]*

The inputs to overload at sub-scenario execution.

.. raw:: html

    </li>

    <li>

**output_names** : *Sequence[str]*

The outputs to get from the sub-scenario execution.

.. raw:: html

    </li>

    <li>

**scenario** : *BaseScenario*

The scenario to adapt.

.. raw:: html

    </li>

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



.. raw:: html

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


    <li>

**keep_opt_history** : *bool, optional*

Whether to keep databases copies after each execution.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**name** : *str*

The name of the scenario adapter.
If empty,
use the name of the scenario adapter suffixed by ``"_adapter"``.


By default it is set to .


.. raw:: html

    </li>

    <li>

**opt_history_file_prefix** : *str*

The base name for the databases to be exported.
The full names of the databases are built from
the provided base name suffixed by ``"_i.h5"``
where ``i`` is replaced by the execution number,
i.e the number of stored databases.
If empty, the databases are not exported.
The databases can be exported only is ``keep_opt_history=True``.


By default it is set to .


.. raw:: html

    </li>

    <li>

**output_multipliers** : *bool, optional*

If ``True``,
the Lagrange multipliers of the scenario optimal solution are computed
and added to the outputs.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**reset_x0_before_opt** : *bool, optional*

If ``True``, reset the initial guess
before running the sub optimization.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**scenario_log_level** : *int | None, optional*

The level of the root logger
during the scenario execution.
If ``None``, do not change the level of the root logger.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**set_bounds_before_opt** : *bool, optional*

If ``True``, set the bounds of the design space.
This is useful for trust regions.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**set_x0_before_opt** : *bool, optional*

If ``True``, set the initial guess of the sub-scenario.
This is useful for multi-start optimization.


By default it is set to False.


.. raw:: html

    </li>

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



.. _MDOParallelChain_options:

MDOParallelChain
----------------



Module: :class:`gemseo.core.chains.parallel_chain`
















































.. raw:: html

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

    <li>

**disciplines** : *Sequence[Discipline]*

The disciplines.

.. raw:: html

    </li>

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



.. raw:: html

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


    <li>

**n_processes** : *int | None, optional*

The maximum simultaneous number of threads,
if ``use_threading`` is True, or processes otherwise,
used to parallelize the execution.
If ``None``, uses the number of disciplines.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**name** : *str*

The name of the discipline.
If ``None``, use the class name.


By default it is set to .


.. raw:: html

    </li>

    <li>

**use_deep_copy** : *bool, optional*

Whether to deepcopy the discipline input data.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**use_threading** : *bool, optional*

Whether to use threads instead of processes
to parallelize the execution;
multiprocessing will copy (serialize) all the disciplines,
while threading will share all the memory.
This is important to note
if you want to execute the same discipline multiple times,
you shall use multiprocessing.


By default it is set to True.


.. raw:: html

    </li>

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



.. _MDOScenarioAdapter_options:

MDOScenarioAdapter
------------------



Module: :class:`gemseo.disciplines.scenario_adapters.mdo_scenario_adapter`




















































































.. raw:: html

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

    <li>

**input_names** : *Sequence[str]*

The inputs to overload at sub-scenario execution.

.. raw:: html

    </li>

    <li>

**output_names** : *Sequence[str]*

The outputs to get from the sub-scenario execution.

.. raw:: html

    </li>

    <li>

**scenario** : *BaseScenario*

The scenario to adapt.

.. raw:: html

    </li>

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



.. raw:: html

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


    <li>

**keep_opt_history** : *bool, optional*

Whether to keep databases copies after each execution.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**name** : *str*

The name of the scenario adapter.
If empty,
use the name of the scenario adapter suffixed by ``"_adapter"``.


By default it is set to .


.. raw:: html

    </li>

    <li>

**opt_history_file_prefix** : *str*

The base name for the databases to be exported.
The full names of the databases are built from
the provided base name suffixed by ``"_i.h5"``
where ``i`` is replaced by the execution number,
i.e the number of stored databases.
If empty, the databases are not exported.
The databases can be exported only is ``keep_opt_history=True``.


By default it is set to .


.. raw:: html

    </li>

    <li>

**output_multipliers** : *bool, optional*

If ``True``,
the Lagrange multipliers of the scenario optimal solution are computed
and added to the outputs.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**reset_x0_before_opt** : *bool, optional*

If ``True``, reset the initial guess
before running the sub optimization.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**scenario_log_level** : *int | None, optional*

The level of the root logger
during the scenario execution.
If ``None``, do not change the level of the root logger.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**set_bounds_before_opt** : *bool, optional*

If ``True``, set the bounds of the design space.
This is useful for trust regions.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**set_x0_before_opt** : *bool, optional*

If ``True``, set the initial guess of the sub-scenario.
This is useful for multi-start optimization.


By default it is set to False.


.. raw:: html

    </li>

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



.. _MDOWarmStartedChain_options:

MDOWarmStartedChain
-------------------



Module: :class:`gemseo.core.chains.warm_started_chain`




































.. raw:: html

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

    <li>

**disciplines** : *Sequence[Discipline]*

The disciplines.

.. raw:: html

    </li>

    <li>

**variable_names_to_warm_start** : *Sequence[str]*

The names of the variables to be warm started.
These names must be outputs of the disciplines in the chain.
If the list is empty, no variables are warm started.

.. raw:: html

    </li>

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



.. raw:: html

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


    <li>

**name** : *str*

The name of the discipline.
If ``None``, use the class name.


By default it is set to .


.. raw:: html

    </li>

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



.. _MainDiscipline_options:

MainDiscipline
--------------



Module: :class:`gemseo.problems.mdo.scalable.parametric.disciplines.main_discipline`

































.. raw:: html

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

    <li>

**t_i** : *NDArray[float]*

The threshold vectors :math:`t_1,\ldots,t_N`.

.. raw:: html

    </li>

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



.. raw:: html

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


    <li>

****default_input_values** : *NDArray[float], optional*

The default values of the input variables.



.. raw:: html

    </li>

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



.. _MaterialModelInterpolation_options:

MaterialModelInterpolation
--------------------------



Module: :class:`gemseo.problems.topology_optimization.material_model_interpolation_disc`




























































.. raw:: html

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

    <li>

**e0** : *float*

The full material Young modulus.

.. raw:: html

    </li>

    <li>

**empty_elements** : *Sequence[int]*

The index of an empty element
ids that are not part of the design space.

.. raw:: html

    </li>

    <li>

**full_elements** : *Sequence[int]*

The index of full element
ids that are not part of the design space.

.. raw:: html

    </li>

    <li>

**n_x** : *int*

The number of elements in the x-direction.

.. raw:: html

    </li>

    <li>

**n_y** : *int*

The number of elements in the y-direction.

.. raw:: html

    </li>

    <li>

**penalty** : *float*

The SIMP penalty coefficient.

.. raw:: html

    </li>

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



.. raw:: html

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


    <li>

**contrast** : *float, optional*

The ratio between the full material Young's modulus
and void material Young's modulus.


By default it is set to 1000000000.0.


.. raw:: html

    </li>

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



.. _Mission_options:

Mission
-------



Module: :class:`gemseo.problems.mdo.aerostructure.aerostructure`
































.. raw:: html

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


    <li>

**lift_val** : *float, optional*

The threshold to compute the lift constraint.


By default it is set to 0.5.


.. raw:: html

    </li>

    <li>

**r_val** : *float, optional*

The threshold to compute the reserve factor constraint.


By default it is set to 0.5.


.. raw:: html

    </li>

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



.. _ODEDiscipline_options:

ODEDiscipline
-------------



Module: :class:`gemseo.disciplines.ode.ode_discipline`





























































































.. raw:: html

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

    <li>

**discipline** : *Discipline*

The discipline defining the right-hand side function of the ODE.

.. raw:: html

    </li>

    <li>

**times** : *ArrayLike*

Either the initial and final times
or the times of interest where the state must be stored,
including the initial and final times.
When only initial and final times are provided,
the times of interest are the instants chosen by the ODE solver
to compute the state trajectories.

.. raw:: html

    </li>

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



.. raw:: html

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


    <li>

**final_state_names** : *Mapping[str, str], optional*

The names of the state variables
bound to their names at final time.
If empty,
use ``state_name_final`` for a state variable named ``state_name``.


By default it is set to {}.


.. raw:: html

    </li>

    <li>

**name** : *str*

The name of the discipline.
If empty, use the name of the class.


By default it is set to .


.. raw:: html

    </li>

    <li>

**ode_solver_name** : *str, optional*

The name of the ODE solver.


By default it is set to RK45.


.. raw:: html

    </li>

    <li>

**return_trajectories** : *bool, optional*

Whether to output
both the trajectories of the state variables
and their values at final time.
Otherwise, output only their values at final time.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**solve_at_algorithm_times** : *bool | None, optional*

Whether to solve the ODE chosen by the algorithm.
Otherwise, use times defined in the vector `times`.
If ``None``,
it is initialized as ``False``
if no terminal event is considered,
and ``True`` otherwise.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**state_names** : *Iterable[str] | Mapping[str, str], optional*

Either the names of the state variables,
passed as ``(state_name, ...)``,
or the names of the state variables
bound to the associated discipline outputs,
passed as ``{state_name: output_name, ...}``.
If empty, use all the discipline inputs.


By default it is set to ().


.. raw:: html

    </li>

    <li>

**state_trajectory_names** : *Mapping[str, str], optional*

The names of the state variables
bound to the names of their trajectories.
If empty,
use ``state_name_trajectory`` for a state variable named ``state_name``.


By default it is set to {}.


.. raw:: html

    </li>

    <li>

**termination_event_disciplines** : *Iterable[Discipline], optional*

The disciplines encoding termination events.
Each discipline must have the same inputs as ``discipline``
and only one output defined as an arrays of size 1
indicating the value of an event function.
The resolution of the ODE problem stops
when one of the event functions crosses the threshold 0.
If empty, the integration covers the entire time interval.


By default it is set to ().


.. raw:: html

    </li>

    <li>

**time_name** : *str, optional*

The name of the time variable.


By default it is set to time.


.. raw:: html

    </li>

    <li>

****ode_solver_settings** : *Any, optional*

The settings of the ODE solver.



.. raw:: html

    </li>

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



.. _OscillatorDiscipline_options:

OscillatorDiscipline
--------------------



Module: :class:`gemseo.problems.ode.oscillator_discipline`










































.. raw:: html

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

    <li>

**omega** : *float*

The positive angular velocity of the oscillator.

.. raw:: html

    </li>

    <li>

**times** : *RealArray*

Either the initial and final times
or the times of interest where the state must be stored,
including the initial and final times.
When only initial and final times are provided,
the times of interest are the instants chosen by the ODE solver
to compute the state trajectories.

.. raw:: html

    </li>

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



.. raw:: html

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


    <li>

**final_state_names** : *Mapping[str, str], optional*

The names of the state variables
bound to their names at final time.
If empty,
use ``state_name_final`` for a state variable named ``state_name``.


By default it is set to {}.


.. raw:: html

    </li>

    <li>

**return_trajectories** : *bool, optional*

Whether to output
both the trajectories of the state variables
and their values at final time.
Otherwise, output only their values at final time.


By default it is set to False.


.. raw:: html

    </li>

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



.. _PropaneComb1_options:

PropaneComb1
------------



Module: :class:`gemseo.problems.mdo.propane.propane`






















.. _PropaneComb2_options:

PropaneComb2
------------



Module: :class:`gemseo.problems.mdo.propane.propane`






















.. _PropaneComb3_options:

PropaneComb3
------------



Module: :class:`gemseo.problems.mdo.propane.propane`






















.. _PropaneReaction_options:

PropaneReaction
---------------



Module: :class:`gemseo.problems.mdo.propane.propane`






















.. _RemappingDiscipline_options:

RemappingDiscipline
-------------------



Module: :class:`gemseo.disciplines.remapping`




































.. raw:: html

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

    <li>

**discipline** : *Discipline*

The original discipline.

.. raw:: html

    </li>

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



.. raw:: html

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


    <li>

**input_mapping** : *NameMapping, optional*

The input names to the original input names.


By default it is set to {}.


.. raw:: html

    </li>

    <li>

**output_mapping** : *NameMapping, optional*

The output names to the original output names.


By default it is set to {}.


.. raw:: html

    </li>

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



.. _RosenMF_options:

RosenMF
-------



Module: :class:`gemseo.problems.optimization.rosen_mf`


























.. raw:: html

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


    <li>

**dimension** : *int, optional*

The dimension of the design space.


By default it is set to 2.


.. raw:: html

    </li>

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



.. _SLURM_options:

SLURM
-----



Module: :class:`gemseo.disciplines.wrappers.job_schedulers.slurm`















































































































.. raw:: html

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

    <li>

**discipline** : *Discipline*

The discipline to wrap in the job scheduler.

.. raw:: html

    </li>

    <li>

**workdir_path** : *Path*

The path to the workdir where the files will be generated.

.. raw:: html

    </li>

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



.. raw:: html

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


    <li>

**cpus_per_task** : *int, optional*

The number of CPUS per task.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**job_out_filename** : *str, optional*

The output job file name.


By default it is set to batch.sh.


.. raw:: html

    </li>

    <li>

**job_template_path** : *Path | str | None, optional*

The path to the template to be used to make a
submission to the job scheduler command.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**mem_per_cpu** : *str, optional*

The memory per CPU.


By default it is set to 1G.


.. raw:: html

    </li>

    <li>

**nodes_number** : *int, optional*

The number nodes.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**ntasks** : *int, optional*

The number of tasks.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**ntasks_per_node** : *int, optional*

The number of tasks per node.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**scheduler_run_command** : *str, optional*

The command to call the job scheduler and submit
the generated script.


By default it is set to sbatch --wait.


.. raw:: html

    </li>

    <li>

**setup_cmd** : *str*

The command used before running the executable.


By default it is set to .


.. raw:: html

    </li>

    <li>

**use_template** : *bool, optional*

whether to use template based interface to the job scheduler.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**user_email** : *str*

The user email to send the run status.


By default it is set to .


.. raw:: html

    </li>

    <li>

**wall_time** : *str, optional*

The wall time.


By default it is set to 24:00:00.


.. raw:: html

    </li>

    <li>

****options** : *dict[str:Any], optional*

The job scheduler specific options to be used in the template.



.. raw:: html

    </li>

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



.. _ScalableDiscipline_options:

ScalableDiscipline
------------------



Module: :class:`gemseo.problems.mdo.scalable.data_driven.discipline`













































.. raw:: html

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

    <li>

**data** : *IODataset*

The learning dataset.

.. raw:: html

    </li>

    <li>

**name** : *str*

The name of the class of the scalable model.

.. raw:: html

    </li>

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



.. raw:: html

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


    <li>

**sizes** : *Mapping[str, int], optional*

The sizes of the input and output variables.
If empty, use the original sizes.


By default it is set to {}.


.. raw:: html

    </li>

    <li>

****parameters** : *Any, optional*

The parameters for the model.



.. raw:: html

    </li>

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



.. _Sellar1_options:

Sellar1
-------



Module: :class:`gemseo.problems.mdo.sellar.sellar_1`
































.. raw:: html

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


    <li>

**k** : *float, optional*

The shared coefficient controlling the coupling strength.


By default it is set to 1.0.


.. raw:: html

    </li>

    <li>

**n** : *int, optional*

The size of the local design variables and coupling variables.


By default it is set to 1.


.. raw:: html

    </li>

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



.. _Sellar2_options:

Sellar2
-------



Module: :class:`gemseo.problems.mdo.sellar.sellar_2`
































.. raw:: html

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


    <li>

**k** : *float, optional*

The shared coefficient controlling the coupling strength


By default it is set to 1.0.


.. raw:: html

    </li>

    <li>

**n** : *int, optional*

The size of the local design variables and coupling variables.


By default it is set to 1.


.. raw:: html

    </li>

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



.. _SellarSystem_options:

SellarSystem
------------



Module: :class:`gemseo.problems.mdo.sellar.sellar_system`


























.. raw:: html

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


    <li>

**n** : *int, optional*

The size of the local design variables and coupling variables.


By default it is set to 1.


.. raw:: html

    </li>

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



.. _SobieskiAerodynamics_options:

SobieskiAerodynamics
--------------------



Module: :class:`gemseo.problems.mdo.sobieski.disciplines`


























.. raw:: html

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


    <li>

**dtype** : *SobieskiBase.DataType, optional*

The data type for the NumPy arrays, either "float64" or "complex128".


By default it is set to float64.


.. raw:: html

    </li>

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



.. _SobieskiAerodynamicsSG_options:

SobieskiAerodynamicsSG
----------------------



Module: :class:`gemseo.problems.mdo.sobieski._disciplines_sg`


























.. raw:: html

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


    <li>

**dtype** : *SobieskiBase.DataType, optional*

The data type for the NumPy arrays, either "float64" or "complex128".


By default it is set to float64.


.. raw:: html

    </li>

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



.. _SobieskiChain_options:

SobieskiChain
-------------



Module: :class:`gemseo.problems.mdo.sobieski.process.mdo_chain`


























.. raw:: html

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


    <li>

**dtype** : *SobieskiBase.DataType, optional*

The NumPy type for data arrays, either "float64" or "complex128".


By default it is set to float64.


.. raw:: html

    </li>

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



.. _SobieskiMDAGaussSeidel_options:

SobieskiMDAGaussSeidel
----------------------



Module: :class:`gemseo.problems.mdo.sobieski.process.mda_gauss_seidel`









































.. raw:: html

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


    <li>

**dtype** : *SobieskiBase.DataType, optional*

The NumPy type for data arrays, either "float64" or "complex128".


By default it is set to float64.


.. raw:: html

    </li>

    <li>

**settings_model** : *MDAGaussSeidel_Settings | None, optional*

The MDA settings as a Pydantic model.
If ``None``, use ``**settings``.


By default it is set to None.


.. raw:: html

    </li>

    <li>

****settings** : *Any, optional*

The settings of the MDA.



.. raw:: html

    </li>

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



.. _SobieskiMDAJacobi_options:

SobieskiMDAJacobi
-----------------



Module: :class:`gemseo.problems.mdo.sobieski.process.mda_jacobi`



































.. raw:: html

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


    <li>

**dtype** : *SobieskiBase.DataType, optional*

The NumPy type for data arrays, either "float64" or "complex128".


By default it is set to float64.


.. raw:: html

    </li>

    <li>

****settings** : *Any, optional*

The settings of the MDA.



.. raw:: html

    </li>

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



.. _SobieskiMission_options:

SobieskiMission
---------------



Module: :class:`gemseo.problems.mdo.sobieski.disciplines`
































.. raw:: html

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


    <li>

**dtype** : *SobieskiBase.DataType, optional*

The data type for the NumPy arrays, either "float64" or "complex128".


By default it is set to float64.


.. raw:: html

    </li>

    <li>

**enable_delay** : *bool | float, optional*

If ``True``, wait one second before computation.
If a positive number, wait the corresponding number of seconds.
If ``False``, compute directly.


By default it is set to False.


.. raw:: html

    </li>

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



.. _SobieskiMissionSG_options:

SobieskiMissionSG
-----------------



Module: :class:`gemseo.problems.mdo.sobieski._disciplines_sg`


























.. raw:: html

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


    <li>

**dtype** : *SobieskiBase.DataType, optional*

The data type for the NumPy arrays, either "float64" or "complex128".


By default it is set to float64.


.. raw:: html

    </li>

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



.. _SobieskiPropulsion_options:

SobieskiPropulsion
------------------



Module: :class:`gemseo.problems.mdo.sobieski.disciplines`


























.. raw:: html

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


    <li>

**dtype** : *SobieskiBase.DataType, optional*

The data type for the NumPy arrays, either "float64" or "complex128".


By default it is set to float64.


.. raw:: html

    </li>

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



.. _SobieskiPropulsionSG_options:

SobieskiPropulsionSG
--------------------



Module: :class:`gemseo.problems.mdo.sobieski._disciplines_sg`


























.. raw:: html

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


    <li>

**dtype** : *SobieskiBase.DataType, optional*

The data type for the NumPy arrays, either "float64" or "complex128".


By default it is set to float64.


.. raw:: html

    </li>

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



.. _SobieskiStructure_options:

SobieskiStructure
-----------------



Module: :class:`gemseo.problems.mdo.sobieski.disciplines`


























.. raw:: html

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


    <li>

**dtype** : *SobieskiBase.DataType, optional*

The data type for the NumPy arrays, either "float64" or "complex128".


By default it is set to float64.


.. raw:: html

    </li>

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



.. _SobieskiStructureSG_options:

SobieskiStructureSG
-------------------



Module: :class:`gemseo.problems.mdo.sobieski._disciplines_sg`


























.. raw:: html

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


    <li>

**dtype** : *SobieskiBase.DataType, optional*

The data type for the NumPy arrays, either "float64" or "complex128".


By default it is set to float64.


.. raw:: html

    </li>

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



.. _Splitter_options:

Splitter
--------



Module: :class:`gemseo.disciplines.splitter`






























.. raw:: html

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

    <li>

**input_name** : *str*

The name of the input to split.

.. raw:: html

    </li>

    <li>

**output_names_to_input_indices** : *dict[str, Iterable[int] | int]*

The input indices associated with the
output names.

.. raw:: html

    </li>

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





.. _Structure_options:

Structure
---------



Module: :class:`gemseo.problems.mdo.aerostructure.aerostructure`






















.. _SurrogateDiscipline_options:

SurrogateDiscipline
-------------------



Module: :class:`gemseo.disciplines.surrogate`





































































.. raw:: html

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

    <li>

**surrogate** : *str | BaseRegressor*

Either the name of a subclass of :class:`.BaseRegressor`
or an instance of this subclass.

.. raw:: html

    </li>

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



.. raw:: html

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


    <li>

**data** : *IODataset | None, optional*

The learning dataset to train the regression model.
If ``None``, the regression model is supposed to be trained.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**default_input_data** : *dict[str, ndarray], optional*

The default values of the input variables.
If empty,
use the center of the learning input space.


By default it is set to {}.


.. raw:: html

    </li>

    <li>

**disc_name** : *str*

The name to be given to the surrogate discipline.
If empty,
the name will be ``f"{surrogate.SHORT_ALGO_NAME}_{data.name}``.


By default it is set to .


.. raw:: html

    </li>

    <li>

**input_names** : *Iterable[str], optional*

The names of the input variables.
If empty,
consider all input variables mentioned in the learning dataset.


By default it is set to ().


.. raw:: html

    </li>

    <li>

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

The names of the output variables.
If empty,
consider all input variables mentioned in the learning dataset.


By default it is set to ().


.. raw:: html

    </li>

    <li>

**transformer** : *TransformerType, optional*

The strategies to transform the variables.
This argument is ignored
when ``surrogate`` is a :class:`.BaseRegressor`;
in this case,
these strategies are defined
with the ``transformer`` argument of this :class:`.BaseRegressor`,
whose default value is :attr:`.BaseMLAlgo.IDENTITY`,
which means no transformation.
In the other cases,
the values of the dictionary are instances of :class:`.BaseTransformer`
while the keys can be variable names,
the group name ``"inputs"``
or the group name ``"outputs"``.
If a group name is specified,
the :class:`.BaseTransformer` will be applied
to all the variables of this group.
If :attr:`.BaseMLAlgo.IDENTITY`, do not transform the variables.
The :attr:`.BaseRegressor.DEFAULT_TRANSFORMER` uses
the :class:`.MinMaxScaler` strategy for both input and output variables.


By default it is set to {'inputs': <gemseo.mlearning.transformers.scaler.min_max_scaler.MinMaxScaler object at 0x7f6dfa7ca280>, 'outputs': <gemseo.mlearning.transformers.scaler.min_max_scaler.MinMaxScaler object at 0x7f6dfa7ca490>}.


.. raw:: html

    </li>

    <li>

****settings** : *MLAlgoSettingsType, optional*

The settings of the machine learning algorithm.



.. raw:: html

    </li>

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



.. _TaylorDiscipline_options:

TaylorDiscipline
----------------



Module: :class:`gemseo.disciplines.taylor`




































.. raw:: html

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

    <li>

**discipline** : *Discipline*

The discipline to be approximated by a Taylor polynomial.

.. raw:: html

    </li>

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



.. raw:: html

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


    <li>

**input_data** : *Mapping[str, NDArray[float]], optional*

The point of expansion.
If empty, use the default inputs of ``discipline``.


By default it is set to {}.


.. raw:: html

    </li>

    <li>

**name** : *str*

The name of the discipline.
If empty, use the name of the class.


By default it is set to .


.. raw:: html

    </li>

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



.. _VolumeFraction_options:

VolumeFraction
--------------



Module: :class:`gemseo.problems.topology_optimization.volume_fraction_disc`


















































.. raw:: html

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


    <li>

**empty_elements** : *Sequence[int] | None, optional*

The index of the empty element
ids that are not part of the design space.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**full_elements** : *Sequence[int] | None, optional*

The index of the full element
ids that are not part of the design space.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**n_x** : *int, optional*

The number of elements in the x-direction.


By default it is set to 100.


.. raw:: html

    </li>

    <li>

**n_y** : *int, optional*

The number of elements in the y-direction.


By default it is set to 100.


.. raw:: html

    </li>

    <li>

**name** : *str*

The name of the discipline.
If empty, use the name of the class.


By default it is set to .


.. raw:: html

    </li>

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



.. _XLSDiscipline_options:

XLSDiscipline
-------------



Module: :class:`gemseo.disciplines.wrappers.xls_discipline`
















































.. raw:: html

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

    <li>

**xls_file_path** : *Path | str*

The path to the Excel file. If the file is a XLSM,
a macro named "execute" must exist and will be called by the
:meth:`~.XLSDiscipline._run` method before retrieving the outputs.

.. raw:: html

    </li>

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



.. raw:: html

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


    <li>

**copy_xls_at_setstate** : *bool, optional*

If ``True``, create a copy of the original Excel file
for each of the pickled parallel processes. This option is required
to be set to ``True`` for parallelization in Windows platforms.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**macro_name** : *str | None, optional*

The name of the macro to be executed for a XLSM file.
If ``None`` is provided, do not run a macro.


By default it is set to execute.


.. raw:: html

    </li>

    <li>

**name** : *str*

The name of the discipline.
If empty, use the name of the class.


By default it is set to .


.. raw:: html

    </li>

    <li>

**recreate_book_at_run** : *bool, optional*

Whether to rebuild the xls objects at each ``_run``
call.


By default it is set to False.


.. raw:: html

    </li>

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