mdo_objective_scenario_adapter module¶
A scenario adapter overwriting the local data with the optimal objective.
- class gemseo.disciplines.scenario_adapters.mdo_objective_scenario_adapter.MDOObjectiveScenarioAdapter(scenario, input_names, output_names, reset_x0_before_opt=False, set_x0_before_opt=False, set_bounds_before_opt=False, cache_type=CacheType.SIMPLE, output_multipliers=False, grammar_type=GrammarType.JSON, name=None, keep_opt_history=False, opt_history_file_prefix='', scenario_log_level=None)[source]
Bases:
MDOScenarioAdapter
A scenario adapter overwriting the local data with the optimal objective.
Initialize self. See help(type(self)) for accurate signature.
- Parameters:
scenario (Scenario) – The scenario to adapt.
input_names (Sequence[str]) – The inputs to overload at sub-scenario execution.
output_names (Sequence[str]) – The outputs to get from the sub-scenario execution.
reset_x0_before_opt (bool) –
If
True
, reset the initial guess before running the sub optimization.By default it is set to False.
set_x0_before_opt (bool) –
If
True
, set the initial guess of the sub-scenario. This is useful for multi-start optimization.By default it is set to False.
set_bounds_before_opt (bool) –
If
True
, set the bounds of the design space. This is useful for trust regions.By default it is set to False.
cache_type (MDODiscipline.CacheType) –
The type of cache policy.
By default it is set to “SimpleCache”.
output_multipliers (bool) –
If
True
, the Lagrange multipliers of the scenario optimal solution are computed and added to the outputs.By default it is set to False.
grammar_type (MDODiscipline.GrammarType) –
The type of the input and output grammars.
By default it is set to “JSONGrammar”.
name (str | None) – The name of the scenario adapter. If
None
, use the name of the scenario adapter suffixed by"_adapter"
.keep_opt_history (bool) –
Whether to keep databases copies after each execution.
By default it is set to False.
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"
wherei
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 iskeep_opt_history=True
.By default it is set to “”.
scenario_log_level (int | None) – The level of the root logger during the scenario execution. If
None
, do not change the level of the root logger.
- Raises:
ValueError – If both reset_x0_before_opt and set_x0_before_opt are True.
- cache: AbstractCache | None
The cache containing one or several executions of the discipline according to the cache policy.
- data_processor: DataProcessor
A tool to pre- and post-process discipline data.
- exec_for_lin: bool
Whether the last execution was due to a linearization.
- input_grammar: BaseGrammar
The input grammar.
- jac: MutableMapping[str, MutableMapping[str, ndarray | csr_array | JacobianOperator]]
The Jacobians of the outputs wrt inputs.
The structure is
{output: {input: matrix}}
.
- keep_opt_history: bool
Whether to keep databases copies after each execution.
- name: str
The name of the discipline.
- output_grammar: BaseGrammar
The output grammar.
- post_optimal_analysis: PostOptimalAnalysis
The post-optimal analysis.
- re_exec_policy: ReExecutionPolicy
The policy to re-execute the same discipline.
- residual_variables: dict[str, str]
The output variables mapping to their inputs, to be considered as residuals; they shall be equal to zero.
- run_solves_residuals: bool
Whether the run method shall solve the residuals.
- scenario: Scenario
The scenario to be adapted.