Problem definition#
A DMDO problem is described by a dictionary, usually read from a YAML file with load_setup() and built
by Session (or build_mdo(), main()). This page lists every section and key.
examples/basic_problem.yaml is a complete example (Getting started).
Important
Three settings have defaults that are easy to get wrong:
declare real variables with the type
REAL. OMADS optimizes variables of any other type, including the short formR, on an integer lattice;gammadefaults to0: every link whose inconsistency is not exactly zero then counts as stalled and its penalty weight grows at every outer iteration. Values around0.2–0.5are usual;scalingis used only when it is a float (0.1, not10); otherwise the scale factors are computed from the variable bounds.
variables#
One entry per variable copy; each entry is a list:
variables:
# [name, subproblem, link, coupling, lb, baseline, ub, dim, type]
v0: ["u", 1, 2, s, 0., 1., 10., 1, REAL]
v1: ["v", 1, None, u, 0., 1., 10., 1, REAL]
Item |
Meaning |
|---|---|
|
Variable name. Copies of the same quantity in different subproblems share the name. |
|
Index of the subproblem that holds this copy. |
|
Index of the subproblem holding the copy this one must agree with (a list for several), or |
|
|
|
Bounds. They also set the default scale of the inconsistencies (Background). |
|
Starting value. |
|
Dimension (vector-valued variables have one inconsistency per component). |
|
|
DA: disciplinary analyses#
Key |
Meaning |
|---|---|
|
Analysis index, referenced from |
|
Variable keys the analysis reads, in the order the callable receives them. |
|
Variable keys the analysis computes, in the order the callable returns them. |
|
Name of the analysis: a key of the session’s |
|
|
|
Descriptive: the subproblem the outputs go to and the coupling type ( |
MDA: analyses per subproblem#
Key |
Meaning |
|---|---|
|
MDA index, referenced from the subproblem. |
|
Number and indices of the analyses evaluated, in order, for each design of the subproblem. |
|
Variable keys the analyses read from the subproblem. |
|
Variable keys the analyses compute. |
coord: the coordinator#
Key |
Default |
Meaning |
|---|---|---|
|
(required) |
Coordinator index, referenced from the subproblems and |
|
(required) |
|
|
(required) |
Maximum number of outer iterations. |
|
(required) |
Number of subproblems. |
|
(required) |
Subproblem that holds the system objective. |
|
|
Penalty growth factor \(\beta > 1\). |
|
|
Stall threshold \(\gamma\): a link stalls when \(|q^{t}| > \gamma |q^{t-1}|\). |
|
(required) |
Which stalled links grow: |
|
bounds |
A float scales every inconsistency by that constant; any other value uses \(0.1/(u-\ell)\) per copy. |
|
(required) |
|
|
(required) |
Console output of the coordinator; whether to store the inconsistency history. |
|
|
Name of the coordination policy (Extending DMDO). |
subproblem#
Key |
Default |
Meaning |
|---|---|---|
|
(required) |
Subproblem index and number of design variables. |
|
(required) |
Variable keys of the design vector |
|
(required) |
Variable keys of the responses |
|
(required) |
|
|
(required) |
Indices of the subproblem’s MDA and coordinator. |
|
(required) |
Name of the objective callable (resolved like |
|
|
Inner solver: |
|
(required) |
Evaluation budget of each inner solve. |
|
SLSQP |
For |
|
none |
Name of an entry of the |
|
|
Initial OMADS frame size, and how it carries over between outer iterations ( |
|
|
Initial best objective. |
|
none |
A reference value of the objective, used to report the relative objective error of the master subproblem. |
|
|
Console output of the inner solver. |
CONFIG: OMADS settings#
Named blocks of OMADS options, referenced by configurations. Each has an options part (seed, budget,
tol, psize_init, opportunistic, rich_direction, check_cache, store_cache, …) and a
search part (type, s_method, ns); see the OMADS documentation [Bayoumy, 2022] for their meaning.
CONFIG:
CSP1:
options: {seed: 12345, budget: 250, tol: 1.0e-9, psize_init: 2.0, opportunistic: False,
check_cache: True, store_cache: True, rich_direction: True}
search: {type: sampling, s_method: ACTIVE, ns: 10}
MDO: the run#
Key |
Default |
Meaning |
|---|---|---|
|
(required) |
Coordinator index and the list of subproblem indices, in sweep order. |
|
(required) |
Variable keys of all analysis responses. |
|
|
Stop when the maximum inconsistency is below this value and no longer changes (must be a float). |
|
|
Stop when the maximum inconsistency has not improved for this many outer iterations. |
|
|
One progress line per outer iteration. |
|
|
Initial stopping message, reported if no criterion triggers. |
|
|
Initial values of the run’s records. |
|
|
Informational; DMDO solves the distributed NHATC formulation of Background. |
Sets and USER#
Sets defines named value sets for categorical and discrete variables. USER holds free-form user data,
attached to the built problem.