gemseo-multi-fidelity 0.0.1__py3-none-any.whl

gemseo_multi_fidelity/drivers/settings/__init__.py

@@ -0,0 +1,16 @@
+# Copyright 2021 IRT Saint Exupéry, https://www.irt-saintexupery.com
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 3 as published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program; if not, write to the Free Software Foundation,
+# Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+"""Drivers settings."""

gemseo_multi_fidelity/drivers/settings/base_mf_driver_settings.py

@@ -0,0 +1,59 @@
+# Copyright 2021 IRT Saint Exupéry, https://www.irt-saintexupery.com
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 3 as published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program; if not, write to the Free Software Foundation,
+# Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#               Francois Gallard: portage to GEMSEO 6
+"""Settings for the Refinement algorithm."""
+
+from __future__ import annotations
+
+from pydantic import BaseModel
+from pydantic import Field
+
+
+def check_sizes(model: BaseModel, field_name: str, expected_size: int) -> BaseModel:
+    """Check the sizes of the data.
+
+    If the field is None or of length one, updates its value to a list of expected_size.
+
+    Args:
+        model: The model to be checked.
+        field_name: The name of the field to validate.
+        expected_size: The expected size of the field.
+
+    Returns:
+        The checked model.
+    """
+    field_value = getattr(model, field_name)
+
+    if isinstance(field_value, (bool, str, dict, type(None))):
+        field_value = [field_value] * expected_size
+    elif len(field_value) == 0:
+        field_value = [False] * expected_size
+    elif len(field_value) != expected_size:
+        msg = f"The field {field_name} length must be 0 or {expected_size}."
+        raise ValueError(msg)
+    setattr(model, field_name, field_value)
+    return model
+
+
+class BaseMFDriver_Settings(BaseModel):  # noqa: N801
+    """The Refinement algorithms settings."""
+
+    x_start: object = Field(default=None, description="Optimization initial guess")
+
+    input_level: int = Field(
+        default=0,
+        description="The index (from 0) of the sub scenario level to start the "
+        "optimization.",
+    )

gemseo_multi_fidelity/drivers/settings/mf_refine_settings.py

@@ -0,0 +1,50 @@
+# Copyright 2021 IRT Saint Exupéry, https://www.irt-saintexupery.com
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 3 as published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program; if not, write to the Free Software Foundation,
+# Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#               Francois Gallard: portage to GEMSEO 6
+"""Settings for the MFDriverLibrary algorithm."""
+
+from __future__ import annotations
+
+from pydantic import Field
+from pydantic import model_validator
+
+from gemseo_multi_fidelity.drivers.settings.base_mf_driver_settings import (
+    BaseMFDriver_Settings,
+)
+from gemseo_multi_fidelity.drivers.settings.base_mf_driver_settings import check_sizes
+
+
+class MFRefine_Settings(BaseMFDriver_Settings):  # noqa: N801
+    """The MFRefine Settings."""
+
+    _TARGET_CLASS_NAME = "MF_REFINE"
+
+    n_levels: int = Field(description="The number of fidelity levels.")
+
+    build_precond: list[bool] | bool = Field(
+        default=False, description="Whether to build a preconditioner."
+    )
+
+    forward_precond: list[bool] | bool = Field(
+        default=False,
+        description="Whether to forwards the current preconditioner to the next level.",
+    )
+
+    @model_validator(mode="after")
+    def check_precond(self) -> MFRefine_Settings:
+        """Check preconditioner."""
+        for field_name in "build_precond", "forward_precond":
+            check_sizes(self, field_name, self.n_levels)
+        return self

gemseo_multi_fidelity/formulations/__init__.py

@@ -0,0 +1,16 @@
+# Copyright 2021 IRT Saint Exupéry, https://www.irt-saintexupery.com
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 3 as published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program; if not, write to the Free Software Foundation,
+# Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+"""Formulations."""

gemseo_multi_fidelity/formulations/refinement.py

@@ -0,0 +1,144 @@
+# Copyright 2021 IRT Saint Exupéry, https://www.irt-saintexupery.com
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 3 as published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program; if not, write to the Free Software Foundation,
+# Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+# Copyright (c) 2019 AIRBUS OPERATIONS
+
+#
+# Contributors:
+#    INITIAL AUTHORS - API and implementation and/or documentation
+#      :author: Romain Olivanti
+#    OTHER AUTHORS   - MACROSCOPIC CHANGES
+"""Refinement multi-fidelity formulation."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+from typing import Any
+from typing import ClassVar
+
+from gemseo.algos.opt.factory import OptimizationLibraryFactory
+
+from gemseo_multi_fidelity.core.mapper_adapter import MFMapperAdapter
+from gemseo_multi_fidelity.core.mf_formulation import MFFormulation
+from gemseo_multi_fidelity.core.scenario_adapter import MFScenarioAdapter
+from gemseo_multi_fidelity.core.strict_chain import StrictChain
+
+if TYPE_CHECKING:
+    from collections.abc import Iterable
+    from collections.abc import Mapping
+    from collections.abc import Sequence
+
+    from gemseo.algos.database import Database
+    from gemseo.algos.design_space import DesignSpace
+    from gemseo.scenarios.mdo_scenario import MDOScenario
+
+    from gemseo_multi_fidelity.core.ds_mapper import DesignSpaceMapper
+
+
+class Refinement(MFFormulation):
+    """Refinement multi-fidelity formulation."""
+
+    _ALGO_FACTORY_CLASS: ClassVar[type[OptimizationLibraryFactory]] = (
+        OptimizationLibraryFactory
+    )
+    """Algorithm factory class."""
+
+    def __init__(
+        self,
+        disciplines: Sequence[MDOScenario],
+        objective_name: str,
+        design_space: DesignSpace,
+        design_space_mapping: DesignSpaceMapper = None,
+        functions_mapping: Mapping[str, Any] | None = None,
+        correction_mapping: Iterable[Mapping[str, Any]] | None = None,
+        databases: Iterable[Database] | None = None,
+        **options: Any,
+    ) -> None:
+        """Constructor."""
+        # TODO old style until the bug is fixed
+        # super(Refinement, self).__init__
+        super().__init__(
+            disciplines,
+            objective_name,
+            design_space,
+            design_space_mapping=design_space_mapping,
+            functions_mapping=functions_mapping,
+            correction_mapping=correction_mapping,
+            databases=databases,
+        )
+
+        chain, opt_adapters = self._build_refinement_chain()
+        self._opt_adapters = opt_adapters
+        self._chain = chain
+        self._build_driver_interface()
+
+    def _build_opt_adapter_at_level(self, i: int):
+        scenario = self._scenarios[i]
+        return MFScenarioAdapter(scenario)
+
+    def _build_mapper_adapter_at_level(self, i: int):
+        mapper = self._eval_mappers[i - 1]
+        mapper_name = f"mapper_{i:d}"
+        return MFMapperAdapter(mapper_name, mapper, direct=True)
+
+    def _build_refinement_chain(self):
+        disciplines = []
+        opt_adapters = []
+
+        add_disc = disciplines.append
+        add_opt_adapter = opt_adapters.append
+
+        levels = list(range(len(self._scenarios)))
+
+        # Low-fidelity -> High-fidelity
+        for level in levels[:0:-1]:
+            # Add the sub opt adapter
+            opt_adapter = self._build_opt_adapter_at_level(level)
+            add_disc(opt_adapter)
+            add_opt_adapter(opt_adapter)
+            # Add the mapper to link it with the next level
+            mapper_adapter = self._build_mapper_adapter_at_level(level)
+            add_disc(mapper_adapter)
+
+        # Add the top level which is not linked to anything
+        opt_adapter = self._build_opt_adapter_at_level(0)
+        add_disc(opt_adapter)
+        add_opt_adapter(opt_adapter)
+        chain = StrictChain(disciplines, name="refinement_chain")
+
+        # reverse the opt adapter to provide them in the hierarchical order
+        opt_adapters.reverse()
+        return chain, opt_adapters
+
+    def _build_workflow_runner(self):
+        def run_refinement(x_start, **options):
+            # Prepare options
+            input_data = options
+            input_data[MFScenarioAdapter.X_START] = x_start
+            # Run the chain
+            self._chain.execute(input_data=input_data)
+            # Extract the best point found
+            output = self._chain.get_output_data()
+            return output[MFScenarioAdapter.X_BEST]
+
+        return run_refinement
+
+    def get_expected_workflow(self):
+        """Get the expected workflow."""
+        return self._chain.get_expected_workflow()
+
+    def get_expected_dataflow(self):
+        """Get the expected dataflow."""
+        return self._chain.get_expected_dataflow()

gemseo_multi_fidelity/mapping/__init__.py

@@ -0,0 +1,16 @@
+# Copyright 2021 IRT Saint Exupéry, https://www.irt-saintexupery.com
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 3 as published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program; if not, write to the Free Software Foundation,
+# Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+"""Mapping."""

gemseo_multi_fidelity/mapping/identity_mapper.py

@@ -0,0 +1,74 @@
+# Copyright 2021 IRT Saint Exupéry, https://www.irt-saintexupery.com
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 3 as published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program; if not, write to the Free Software Foundation,
+# Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+# Copyright (c) 2019 AIRBUS OPERATIONS
+
+#
+# Contributors:
+#    INITIAL AUTHORS - API and implementation and/or documentation
+#      :author: Romain Olivanti
+#    OTHER AUTHORS   - MACROSCOPIC CHANGES
+"""Identity mapper."""
+
+from __future__ import annotations
+
+from copy import deepcopy
+from typing import TYPE_CHECKING
+
+from numpy import eye
+
+from gemseo_multi_fidelity.core.ds_mapper import DesignSpaceMapper
+
+if TYPE_CHECKING:
+    from gemseo.algos.design_space import DesignSpace
+    from numpy.typing import NDArray
+
+
+class IdentityMapper(DesignSpaceMapper):
+    """Identity mapper."""
+
+    def _map_vars_direct(self, dvs_dict_in: DesignSpace) -> DesignSpace:
+        """Map vars direct.
+
+        Args:
+            dvs_dict_in: The input design space.
+
+        Returns:
+            The output design space.
+        """
+        return deepcopy(dvs_dict_in)
+
+    def _map_vars_reverse(self, dvs_dict_out: DesignSpace) -> DesignSpace:
+        """Map vars reverse.
+
+        Args:
+            dvs_dict_out: The output design space.
+
+        Returns:
+            The input design space.
+        """
+        return deepcopy(dvs_dict_out)
+
+    def get_jac(self) -> NDArray:
+        """Get jacobian.
+
+        Returns:
+            The jacobian.
+        """
+        jac = {}
+        ds = self.design_space_in
+        for var, var_size in ds.variable_sizes.items():
+            jac[var] = {var: eye(var_size)}
+        return jac