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

gemseo_multi_fidelity/core/mapper_adapter.py

@@ -0,0 +1,126 @@
+# 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
+"""Adapter to wrap an EvaluationMapper in a Discipline."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from gemseo.core.discipline.discipline import Discipline
+
+from gemseo_multi_fidelity.core.eval_mapper import EvaluationMapper
+from gemseo_multi_fidelity.core.scenario_adapter import MFScenarioAdapter
+
+if TYPE_CHECKING:
+    from gemseo.typing import StrKeyMapping
+
+
+class MFMapperAdapter(Discipline):
+    """Multi-fidelity evaluation mapper adapter."""
+
+    auto_detect_grammar_files = True
+
+    def __init__(
+        self, name: str, eval_mapper: EvaluationMapper, direct: bool = True
+    ) -> None:
+        """Constructor.
+
+        Args:
+            name: The name of the adapter.
+            eval_mapper: The mapper between two levels.
+            direct: ``True`` to use the direct order.
+        """
+        super().__init__(name=name)
+
+        if not isinstance(eval_mapper, EvaluationMapper):
+            msg = "eval_mapper must be an EvaluationMapper"
+            raise TypeError(msg)
+
+        if not isinstance(direct, bool):
+            msg = "direct must be a boolean"
+            raise TypeError(msg)
+
+        self.eval_mapper = eval_mapper
+        self._is_direct = direct
+        self._init_grammars(self.__class__.__name__)
+
+    def _init_grammars(self, name: str) -> None:
+        """Initialize the grammars."""
+        # comp_dir = Path(inspect.getfile(MFScenarioAdapter)).absolute().parent
+        # input_grammar_file = self.auto_get_grammar_file(True, name, comp_dir)
+        # output_grammar_file = self.auto_get_grammar_file(False, name, comp_dir)
+        # self._instantiate_grammars(input_grammar_file, output_grammar_file)
+
+        if self._is_direct:
+            # Remove the reference data from the output grammar as it should not be
+            # forwarded
+            for item in [MFScenarioAdapter.X_REF, MFScenarioAdapter.OUTPUT_REF]:
+                del self.output_grammar[item]
+
+    def _map_x_best(self) -> None:
+        """Map the output best point as the next starting point."""
+        x_in = self.io.data[MFScenarioAdapter.X_BEST]
+
+        if self._is_direct:
+            map_method = self.eval_mapper.design_space_mapper.map_vars_direct
+        else:
+            map_method = self.eval_mapper.design_space_mapper.map_vars_reverse
+
+        self.io.data[MFScenarioAdapter.X_START] = map_method(x_in, to_array=False)
+
+    def _map_reference_data(self) -> None:
+        """Map the reference data, filters out reference data in direct mode."""
+        tag_x_ref = MFScenarioAdapter.X_REF
+        tag_output_ref = MFScenarioAdapter.OUTPUT_REF
+
+        x_ref = self.io.data.get(tag_x_ref)
+        if x_ref is not None:
+            output_ref = self.io.data[tag_output_ref]
+            if self._is_direct:
+                # Should not forward reference data in forward mode, delete it
+                del self.io.data[tag_x_ref]
+                del self.io.data[tag_output_ref]
+            else:
+                # Map it
+                output_ref, x_ref = self.eval_mapper.map_eval_reverse(
+                    output_ref, x_eval=x_ref, to_arrays=False
+                )
+                self.io.data[tag_x_ref] = x_ref
+                self.io.data[tag_output_ref] = output_ref
+
+    def _forward_options(self) -> None:
+        """Copy the options stored in output options in input options."""
+        output_options = self.io.data.get(MFScenarioAdapter.OUTPUT_OPTIONS)
+        if output_options is not None:
+            self.io.data[MFScenarioAdapter.INPUT_OPTIONS] = output_options
+
+    def _run(self, input_data: StrKeyMapping) -> None:
+        """Run the mapping, filters out reference data in direct mode if present."""
+        # Map the current point
+        self._map_x_best()
+
+        # Map the reference data if needed
+        self._map_reference_data()
+
+        # Forward the options
+        self._forward_options()

gemseo_multi_fidelity/core/mapper_linker.py

@@ -0,0 +1,72 @@
+# 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) 2020 AIRBUS OPERATIONS
+
+#
+# Contributors:
+#    INITIAL AUTHORS - API and implementation and/or documentation
+#      :author: Romain Olivanti
+#    OTHER AUTHORS   - MACROSCOPIC CHANGES
+"""Adapter to link two mappers."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from gemseo.core.discipline.discipline import Discipline
+
+from gemseo_multi_fidelity.core.scenario_adapter import MFScenarioAdapter
+
+if TYPE_CHECKING:
+    from gemseo.typing import StrKeyMapping
+
+
+class MFMapperLinker(Discipline):
+    """Multi-fidelity evaluation mapper adapter."""
+
+    auto_detect_grammar_files = True
+
+    def __init__(self, name: str) -> None:
+        """Constructor.
+
+        Args:
+            name: The name of the adapter.
+        """
+        super().__init__(name=name)
+        self._init_grammars(self.__class__.__name__)
+
+    def _init_grammars(self, name: str) -> None:
+        """Initialize the grammars."""
+        # comp_dir = Path(inspect.getfile(MFScenarioAdapter)).absolute().parent
+        # input_grammar_file = self.auto_get_grammar_file(True, name, comp_dir)
+        # output_grammar_file = self.auto_get_grammar_file(False, name, comp_dir)
+        # self._instantiate_grammars(input_grammar_file, output_grammar_file)
+
+    def _forward_x_best(self) -> None:
+        """Map the output best point as the next starting point."""
+        x_best = self.io.data[MFScenarioAdapter.X_START]
+        self.io.data[MFScenarioAdapter.X_BEST] = x_best
+
+    def _forward_options(self) -> None:
+        """Forward options so they can be used by a mapper."""
+        input_options = self.io.data.get(MFScenarioAdapter.INPUT_OPTIONS)
+        if input_options is not None:
+            self.io.data[MFScenarioAdapter.OUTPUT_OPTIONS] = input_options
+
+    def _run(self, input_data: StrKeyMapping) -> None:
+        """Run."""
+        self._forward_x_best()
+        self._forward_options()