FEAT: Add create EM target design + add tests (#6838)

Co-authored-by: pyansys-ci-bot <[email protected]>

Author: gmalinve

doc/changelog.d/6838.added.md

@@ -0,0 +1 @@
+Add create EM target design + add tests

src/ansys/aedt/core/application/design.py

@@ -83,6 +83,7 @@
 from ansys.aedt.core.generic.numbers_utils import decompose_variable_value
 from ansys.aedt.core.generic.settings import inner_project_settings
 from ansys.aedt.core.internal.aedt_versions import aedt_versions
+from ansys.aedt.core.internal.errors import AEDTRuntimeError
 from ansys.aedt.core.internal.errors import GrpcApiError
 from ansys.aedt.core.internal.load_aedt_file import load_entire_aedt_file
 from ansys.aedt.core.modules.boundary.common import BoundaryObject
@@ -2434,6 +2435,50 @@ def read_only_variable(self, name, value=True):
         self.variable_manager[name].read_only = value
         return True
 
+    @pyaedt_function_handler()
+    def create_em_target_design(self, design, setup=None, design_setup=None):
+        """Create an EM Target design.
+
+        Parameters
+        ----------
+        design : str
+            Name of the target design. Possible choices are ``"Icepak"`` or``"Mechanical"``.
+        setup : str, optional
+            Name of the EM setup to link to the target design.
+            The default is ``None``, in which case the ``LastAdaptive`` setup is used.
+        design_setup : str, optional
+            For Icepak designs, specify ``"Forced"`` for forced convention or
+            ``"Natural"`` for natural convention.
+            The default is ``None``, in which case the ``"Forced"`` option is used.
+
+        Returns
+        -------
+        bool
+            ``True`` when successful, ``False`` when failed.
+
+        References
+        ----------
+        >>> oDesign.CreateEMLossTarget
+
+        Examples
+        --------
+        >>> from ansys.aedt.core import Maxwell3d
+        >>> m3d = Maxwell3d()
+        >>> m3d.create_em_target_design("Icepak", design_setup="Forced")
+        """
+        if self.design_type not in ["HFSS", "Maxwell 3D", "Q3D Extractor"]:
+            raise AEDTRuntimeError("Source design type must be 'HFSS', 'Maxwell' or 'Mechanical'.")
+        if design not in ["Icepak", "Mechanical"]:
+            raise AEDTRuntimeError("Design type must be 'Icepak' or 'Mechanical'.")
+        if design == "Icepak":
+            design_setup = design_setup or "Forced"
+            if design_setup not in ["Forced", "Natural"]:
+                raise AEDTRuntimeError("Design setup must be 'Forced' or 'Natural'.")
+        if not setup:
+            setup = self.nominal_adaptive
+        self.odesign.CreateEMLossTarget(design, setup, design_setup)
+        return True
+
     @pyaedt_function_handler()
     def _get_boundaries_data(self):
         """Retrieve boundary data.

tests/unit/test_target_design.py

@@ -0,0 +1,86 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2021 - 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+from unittest.mock import MagicMock
+from unittest.mock import PropertyMock
+from unittest.mock import patch
+
+import pytest
+
+from ansys.aedt.core.internal.errors import AEDTRuntimeError
+from ansys.aedt.core.maxwell import Maxwell3d
+from ansys.aedt.core.mechanical import Mechanical
+
+
+@pytest.fixture
+def mechanical():
+    """Fixture used to mock the creation of a Mechanical instance."""
+    with patch("ansys.aedt.core.mechanical.Mechanical.__init__", lambda x: None):
+        mock_instance = MagicMock(spec=Mechanical)
+        yield mock_instance
+
+
+@pytest.fixture
+def maxwell_3d():
+    """Fixture used to mock the creation of a Maxwell instance."""
+    with patch("ansys.aedt.core.maxwell.Maxwell3d.__init__", lambda x: None):
+        mock_instance = MagicMock(spec=Maxwell3d)
+        yield mock_instance
+
+
+@patch.object(Mechanical, "design_type", "Dummy")
+def test_mechanical_failure_design_type(mechanical):
+    mechanical = Mechanical()
+
+    with pytest.raises(AEDTRuntimeError):
+        mechanical.create_em_target_design("Icepak")
+
+
+@patch.object(Maxwell3d, "design_type", "Maxwell 3D")
+def test_maxwell_failure_design(maxwell_3d):
+    maxwell = Maxwell3d()
+
+    with pytest.raises(AEDTRuntimeError):
+        maxwell.create_em_target_design("Twinbuilder")
+
+
+@patch.object(Maxwell3d, "nominal_adaptive", new_callable=PropertyMock)
+@patch.object(Maxwell3d, "design_type", "Maxwell 3D")
+def test_maxwell_failure_design_type_create_target_design(mock_nominal, maxwell_3d):
+    mock_nominal.return_value = "setup_name"
+    maxwell = Maxwell3d()
+    maxwell._odesign = MagicMock()
+
+    with pytest.raises(AEDTRuntimeError):
+        assert maxwell.create_em_target_design("Icepak", design_setup="Invalid")
+
+
+@patch.object(Maxwell3d, "nominal_adaptive", new_callable=PropertyMock)
+@patch.object(Maxwell3d, "design_type", "Maxwell 3D")
+def test_maxwell_create_target_design(mock_nominal, maxwell_3d):
+    mock_nominal.return_value = "setup_name"
+    maxwell = Maxwell3d()
+    maxwell._odesign = MagicMock()
+
+    assert maxwell.create_em_target_design("Icepak", design_setup="Forced")