gemseo / scenarios / scenario_results

Show inherited members

bilevel_scenario_result module

BiLevel scenario result.

class gemseo.scenarios.scenario_results.bilevel_scenario_result.BiLevelScenarioResult(scenario)

Bases: ScenarioResult

The result of a Scenario using a BiLevel formulation.

Parameters:

scenario (Scenario | str | Path) – The scenario to post-process or the path to its HDF5 file.

Raises:

ValueError – When the scenario has not yet been executed.

get_sub_optimization_result(index)

Return the optimization result of a sub-optimization problem if any.

Parameters:

index (int) – The index of the sub-optimization problem, between 0 and N-1 where N is the number of sub-optimization problems.

Returns:

The optimization result of a sub-optimization problem.

Raises:

ValueError – If the index is greater than N-1.

Return type:

OptimizationResult | None

get_top_optimization_result()

Return the optimization result of the top-level optimization problem.

Return type:

OptimizationResult

design_variable_names_to_values: dict[str, ndarray]

The design variable names bound to the optimal values.

optimization_problems_to_results: dict[str, OptimizationResult]

The optimization results associated with the different optimization problems.