gemseo.scenarios.scenario_results.scenario_result module#

Scenario result.

class ScenarioResult(scenario)[source]#

Bases: object

The result of a Scenario.

Parameters:: scenario (BaseScenario | str | Path) -- The scenario to post-process or the path to its HDF5 file.
Raises:: ValueError -- When the scenario has not yet been executed.

plot(name, **settings)[source]#

Visualize the result.

Parameters:

name (str) -- The name of the post-processing.
**settings (Any) -- The settings of the post-processing.

Returns:

The post-processing of the result.

Return type:

BasePost

POST_FACTORY: ClassVar[PostFactory] = +---------------------------------------------------------------------------------------------------------------------+ | BasePost | +---------------------------------------------------------------+---------+-------------------------------------------+ | Module | Is avai | Purpose or error message | +---------------------------------------------------------------+---------+-------------------------------------------+ | Animation | Yes | Animated GIF maker from a | | | | :class:`.BasePost`. | | BasicHistory | Yes | Plot the history of selected constraint, | | | | objective and observable functions. | | ConstraintsHistory | Yes | A matrix of constraint history plots. | | Correlations | Yes | Scatter plots of the correlated | | | | variables. | | GradientSensitivity | Yes | Derivatives of the objective and | | | | constraints at a given iteration. | | HessianHistory | Yes | Plot the history of the diagonal of the | | | | Hessian matrix. | | ObjConstrHist | Yes | History of the maximum constraint and | | | | objective value. | | OptHistoryView | Yes | Plot the history of the design variables, | | | | objective and constraints. | | ParallelCoordinates | Yes | Parallel coordinates plot. | | ParetoFront | Yes | Compute the Pareto front for a multi- | | | | objective problem. | | QuadApprox | Yes | Quadratic approximation of a function. | | RadarChart | Yes | Plot the constraints on a radar chart at | | | | a given dataset index. | | Robustness | Yes | Uncertainty quantification at the | | | | optimum. | | SOM | Yes | Self organizing map clustering | | | | optimization history. | | ScatterPlotMatrix | Yes | Scatter plot matrix among design | | | | variables, output functions and | | | | constraints. | | TopologyView | Yes | Visualization of the solution of a 2D | | | | topology optimization problem. | | VariableInfluence | Yes | First order variable influence analysis. | | gemseo_bilevel_outer_approximation.algos.opt.bilevel_master_o | No | No module named 'ortools' | | uter_approximation.bilevel_master_outer_approximation | | | | gemseo_bilevel_outer_approximation.algos.opt.core.bilevel_out | No | No module named 'ortools' | | er_approximation | | | | gemseo_bilevel_outer_approximation.algos.opt.core.outer_appro | No | No module named 'ortools' | | ximation_optimizer | | | | gemseo_bilevel_outer_approximation.algos.opt.ortools_milp.ort | No | No module named 'ortools' | | ools_milp | | | | gemseo_bilevel_outer_approximation.algos.opt.outer_approximat | No | No module named 'ortools' | | ion.outer_approximation | | | | gemseo_bilevel_outer_approximation.disciplines.scenario_adapt | No | No module named 'ortools' | | ers.mdo_scenario_adapter_benders | | | | gemseo_bilevel_outer_approximation.formulations.benders | No | No module named 'ortools' | | gemseo_bilevel_outer_approximation.formulations.benders_setti | No | No module named 'ortools' | | ngs | | | | gemseo_bilevel_outer_approximation.post.bilevel_outer_approxi | No | No module named 'ortools' | | mation_history | | | | gemseo_bilevel_outer_approximation.post.outer_approximation_h | No | No module named 'ortools' | | istory | | | | gemseo_bilevel_outer_approximation.post.upper_bound_animation | No | No module named 'ortools' | | gemseo_fmu.disciplines.base_fmu_discipline | No | unsupported operand type(s) for |: | | | | 'FMU1Model' and 'FMU2Model' | | gemseo_fmu.disciplines.do_step_fmu_discipline | No | unsupported operand type(s) for |: | | | | 'FMU1Model' and 'FMU2Model' | | gemseo_fmu.disciplines.dynamic_fmu_discipline | No | unsupported operand type(s) for |: | | | | 'FMU1Model' and 'FMU2Model' | | gemseo_fmu.disciplines.fmu_discipline | No | unsupported operand type(s) for |: | | | | 'FMU1Model' and 'FMU2Model' | | gemseo_fmu.disciplines.static_fmu_discipline | No | unsupported operand type(s) for |: | | | | 'FMU1Model' and 'FMU2Model' | | gemseo_fmu.disciplines.time_stepping_system | No | unsupported operand type(s) for |: | | | | 'FMU1Model' and 'FMU2Model' | | gemseo_jax.auto_jax_discipline | No | unsupported operand type(s) for |: | | | | 'types.UnionType' and 'Array' | | gemseo_jax.jax_chain | No | unsupported operand type(s) for |: | | | | 'types.UnionType' and 'Array' | | gemseo_jax.jax_discipline | No | unsupported operand type(s) for |: | | | | 'types.UnionType' and 'Array' | | gemseo_jax.problems.sellar.base | No | unsupported operand type(s) for |: | | | | 'types.UnionType' and 'Array' | | gemseo_jax.problems.sellar.sellar_1 | No | unsupported operand type(s) for |: | | | | 'types.UnionType' and 'Array' | | gemseo_jax.problems.sellar.sellar_2 | No | unsupported operand type(s) for |: | | | | 'types.UnionType' and 'Array' | | gemseo_jax.problems.sellar.sellar_chain | No | unsupported operand type(s) for |: | | | | 'types.UnionType' and 'Array' | | gemseo_jax.problems.sellar.sellar_system | No | unsupported operand type(s) for |: | | | | 'types.UnionType' and 'Array' | | gemseo_jax.problems.sobieski.aerodynamics | No | unsupported operand type(s) for |: | | | | 'types.UnionType' and 'Array' | | gemseo_jax.problems.sobieski.base | No | unsupported operand type(s) for |: | | | | 'types.UnionType' and 'Array' | | gemseo_jax.problems.sobieski.chain | No | unsupported operand type(s) for |: | | | | 'types.UnionType' and 'Array' | | gemseo_jax.problems.sobieski.mission | No | unsupported operand type(s) for |: | | | | 'types.UnionType' and 'Array' | | gemseo_jax.problems.sobieski.propulsion | No | unsupported operand type(s) for |: | | | | 'types.UnionType' and 'Array' | | gemseo_jax.problems.sobieski.structure | No | unsupported operand type(s) for |: | | | | 'types.UnionType' and 'Array' | | gemseo_jax.utils | No | unsupported operand type(s) for |: | | | | 'types.UnionType' and 'Array' | | gemseo_mlearning.algos.opt.smt.smt_ego | No | No package metadata was found for smt | | gemseo_pymoo.post.base_weighted_pymoo_post_algorithms_setting | No | unsupported operand type(s) for |: | | s | | 'Decomposition' and 'NoneType' | | gemseo_pymoo.post.compromise | No | unsupported operand type(s) for |: | | | | 'Decomposition' and 'NoneType' | | gemseo_pymoo.post.compromise_settings | No | unsupported operand type(s) for |: | | | | 'Decomposition' and 'NoneType' | | gemseo_pymoo.post.core.multi_objective_diagram | No | unsupported operand type(s) for |: | | | | 'Decomposition' and 'NoneType' | | gemseo_pymoo.post.petal | No | unsupported operand type(s) for |: | | | | 'Decomposition' and 'NoneType' | | gemseo_pymoo.post.petal_settings | No | unsupported operand type(s) for |: | | | | 'Decomposition' and 'NoneType' | | gemseo_pymoo.post.radar | No | unsupported operand type(s) for |: | | | | 'Decomposition' and 'NoneType' | | gemseo_pymoo.post.radar_settings | No | unsupported operand type(s) for |: | | | | 'Decomposition' and 'NoneType' | +---------------------------------------------------------------+---------+-------------------------------------------+#: The factory of BasePost, if created.

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.

property optimization_result: OptimizationResult#

The optimization result of the main optimization problem.

For some scenarios, such as those based on multi-level formulations, there are several optimization problems including a main one. The current optimization result corresponds to this main optimization problem.

For scenarios with a single optimization problem, the current optimization result corresponds to this unique optimization problem.