FIX: Support for Maxwell Transient APhi Solver renaming in 2025R2 (#6414)

Co-authored-by: pyansys-ci-bot <[email protected]>
Co-authored-by: Giulia Malinverno <[email protected]>
Co-authored-by: Samuel Lopez <[email protected]>
Co-authored-by: Samuelopez-ansys <[email protected]>
Co-authored-by: Sébastien Morais <[email protected]>

Author: 5 people

doc/changelog.d/6414.fixed.md

@@ -0,0 +1 @@
+Support for maxwell transient aphi solver renaming in 2025r2

src/ansys/aedt/core/extensions/project/configure_layout.py

@@ -20,7 +20,7 @@
 # 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.
-# Extension template to help get started
+
 from dataclasses import dataclass
 import json
 import os
@@ -35,7 +35,6 @@
 
 from pyedb import Edb
 import toml
-import tomli
 
 import ansys.aedt.core
 from ansys.aedt.core.examples.downloads import download_file
@@ -45,6 +44,9 @@
 from ansys.aedt.core.extensions.misc import get_port
 from ansys.aedt.core.extensions.misc import get_process_id
 from ansys.aedt.core.extensions.misc import is_student
+from ansys.aedt.core.generic.file_utils import read_json
+from ansys.aedt.core.generic.file_utils import read_toml
+from ansys.aedt.core.generic.file_utils import write_configuration_file
 from ansys.aedt.core.generic.settings import settings
 from ansys.aedt.core.internal.errors import AEDTRuntimeError
 
@@ -89,8 +91,7 @@ def __init__(self, data):
 
     def __init__(self, file_path: Union[Path, str]):
         self._file_path = Path(file_path)
-        with open(self._file_path, "rb") as f:
-            data = tomli.load(f)
+        data = read_toml(self._file_path)
         self.title = data["title"]
         self.version = data["version"]
         self.layout_file = Path(data["layout_file"])
@@ -101,7 +102,8 @@ def __init__(self, file_path: Union[Path, str]):
 
         supplementary_json = data.get("supplementary_json", "")
         if supplementary_json != "":
-            self.supplementary_json = str(self._file_path.with_name(supplementary_json))
+            Path(supplementary_json)
+            self.supplementary_json = str(self._file_path.with_name(Path(supplementary_json).name))
         else:  # pragma: no cover
             self.supplementary_json = ""
         self.check()
@@ -265,8 +267,8 @@ def call_back_load(self):
 
         if self.tk_vars.load_overwrite.get():
             desktop = ansys.aedt.core.Desktop(
-                new_desktop_session=False,
-                specified_version=VERSION,
+                new_desktop=False,
+                version=VERSION,
                 port=PORT,
                 aedt_process_id=AEDT_PROCESS_ID,
                 student_version=IS_STUDENT,
@@ -443,32 +445,36 @@ def load_config(config, working_directory, overwrite):
 
     @staticmethod
     def export_template_config(working_directory):
+        export_directory = Path(working_directory)
         msg = []
+
+        # Read examples serdes
         example_master_config = Path(__file__).parent / "resources" / "configure_layout" / "example_serdes.toml"
-        example_slave_config = (
-            Path(__file__).parent / "resources" / "configure_layout" / "example_serdes_supplementary.json"
-        )
-        export_directory = Path(working_directory)
-        with open(example_master_config, "r", encoding="utf-8") as file:
-            content = file.read()
+        content = read_toml(example_master_config)
+        content["version"] = VERSION
 
-        example_edb = download_file(source="edb/ANSYS_SVP_V1_1.aedb", local_path=working_directory)
+        # Not download in tests
+        if "PYTEST_CURRENT_TEST" not in os.environ:  # pragma: no cover
+            example_edb = download_file(source="edb/ANSYS_SVP_V1_1.aedb", local_path=export_directory)
+        else:
+            example_edb = export_directory / "ANSYS_SVP_V1_1.aedb"
+        content["layout_file"] = str(example_edb)
 
         if bool(example_edb):
             msg.append(f"Example Edb is downloaded to {example_edb}")
         else:  # pragma: no cover
             msg.append("Failed to download example board.")
 
-        with open(export_directory / example_master_config.name, "w", encoding="utf-8") as f:
-            f.write(content)
-            msg.append(f"Example master configure file is copied to {export_directory / example_master_config.name}")
+        example_config = Path(__file__).parent / "resources" / "configure_layout" / "example_serdes_supplementary.json"
+        example_config_content = read_json(example_config)
+        example_path = working_directory / "example_serdes_supplementary.json"
+        write_configuration_file(example_config_content, example_path)
+        msg.append(f"Example configure file is copied to {export_directory / example_config.name}")
 
-        with open(example_slave_config, "r", encoding="utf-8") as file:
-            content = file.read()
-        with open(export_directory / example_slave_config.name, "w", encoding="utf-8") as f:
-            f.write(content)
-            msg.append(f"Example slave configure file is copied to {export_directory / example_slave_config.name}")
+        content["supplementary_json"] = str(example_path)
 
+        write_configuration_file(content, export_directory / "example_serdes.toml")
+        msg.append(f"Example master configure file is copied to {export_directory / example_master_config.name}")
         return True, "\n\n".join(msg)
 
     @staticmethod

src/ansys/aedt/core/maxwell.py

@@ -786,6 +786,7 @@ def assign_current(self, assignment, amplitude=1, phase="0deg", solid=True, swap
                 SolutionsMaxwell3D.ElectricTransient,
                 SolutionsMaxwell3D.TransientAPhiFormulation,
                 SolutionsMaxwell3D.ElectroDCConduction,
+                SolutionsMaxwell3D.TransientAPhi,
             ):
                 props["Phase"] = phase
             if self.solution_type not in (
@@ -2190,7 +2191,11 @@ def export_element_based_harmonic_force(
         >>> m3d.export_element_based_harmonic_force()
         >>> m3d.release_desktop(True, True)
         """
-        if self.solution_type not in (SolutionsMaxwell3D.Transient, SolutionsMaxwell3D.TransientAPhiFormulation):
+        if self.solution_type not in (
+            SolutionsMaxwell3D.Transient,
+            SolutionsMaxwell3D.TransientAPhi,
+            SolutionsMaxwell3D.TransientAPhiFormulation,
+        ):
             raise AEDTRuntimeError("This methods work only with Maxwell Transient Analysis.")
 
         if not output_directory:
@@ -2832,6 +2837,7 @@ def assign_insulating(self, assignment, insulation=None):
             SolutionsMaxwell3D.EddyCurrent,
             SolutionsMaxwell3D.ACMagnetic,
             SolutionsMaxwell3D.Transient,
+            SolutionsMaxwell3D.TransientAPhi,
             SolutionsMaxwell3D.TransientAPhiFormulation,
             SolutionsMaxwell3D.DCConduction,
             SolutionsMaxwell3D.ACConduction,
@@ -3639,7 +3645,7 @@ def order_coil_terminals(self, winding_name, list_of_terminals):
         ... ]
         >>> app.order_coil_terminals(winding_name=winding, list_of_terminals=updated_connection_order)
         """
-        if self.solution_type != "TransientAPhiFormulation":
+        if self.solution_type not in (SolutionsMaxwell3D.TransientAPhi, SolutionsMaxwell3D.TransientAPhiFormulation):
             raise AEDTRuntimeError("Only available in Transient A-Phi Formulation solution type.")
 
         self.oboundary.OrderCoilTerminals(["Name:" + winding_name, *list_of_terminals])

src/ansys/aedt/core/modeler/cad/primitives_3d.py

@@ -1776,7 +1776,8 @@ def insert_layout_component(
         """
         if layout_coordinate_systems is None:
             layout_coordinate_systems = []
-        if self._app.solution_type != "Terminal" and self._app.solution_type != "TransientAPhiFormulation":
+        if (self._app.solution_type != "Terminal" and
+                self._app.solution_type not in ("Transient APhi", "TransientAPhiFormulation")):
             self.logger.warning("Solution type must be terminal in HFSS or APhi in Maxwell")
             return False
 

tests/system/extensions/conftest.py

@@ -113,6 +113,8 @@
 
 logger = pyaedt_logger
 
+os.environ["PYAEDT_SCRIPT_VERSION"] = config["desktopVersion"]
+
 
 def generate_random_string(length):
     characters = string.ascii_letters + string.digits

tests/system/extensions/example_models/T45/ANSYS_SVP_V1_1.aedb/edb.def

@@ -25,13 +25,26 @@
 from pathlib import Path
 from unittest.mock import patch
 
+import pytest
 import requests
 
 import ansys.aedt.core
 from ansys.aedt.core.extensions.project.configure_layout import GUIDE_LINK
 from ansys.aedt.core.extensions.project.configure_layout import INTRO_LINK
 from ansys.aedt.core.extensions.project.configure_layout import ConfigureLayoutExtension
 
+AEDB_FILE_NAME = "ANSYS_SVP_V1_1"
+TEST_SUBFOLDER = "T45"
+AEDT_FILE_PATH = Path(__file__).parent / "example_models" / TEST_SUBFOLDER / (AEDB_FILE_NAME + ".aedb")
+
+
+@pytest.fixture(autouse=True)
+def setup_model_in_scratch(local_scratch):
+    folder = AEDB_FILE_NAME + ".aedb"
+    target_folder = Path(local_scratch.path) / folder
+    local_scratch.copyfolder(AEDT_FILE_PATH, target_folder)
+    return target_folder
+
 
 def test_links():
     for link in [GUIDE_LINK, INTRO_LINK]:
@@ -51,22 +64,24 @@ def test_configure_layout_load(mock_askdirectory, mock_askopenfilename, local_sc
     """Test applying configuration to active design, and saving the new project in a temporary folder."""
     test_dir = Path(local_scratch.path)
     mock_askdirectory.return_value = str(test_dir)
-    extension = ConfigureLayoutExtension(withdraw=False)
+    extension = ConfigureLayoutExtension(withdraw=True)
 
     extension.root.nametowidget("notebook").nametowidget("load").nametowidget("active_design").invoke()
     extension.root.nametowidget("notebook").nametowidget("load").nametowidget("generate_template").invoke()
     assert (test_dir / "example_serdes.toml").exists()
 
     fpath_config = test_dir / "example_serdes.toml"
+
     mock_askopenfilename.return_value = str(fpath_config)
     extension.root.nametowidget("notebook").nametowidget("load").nametowidget("load_config_file").invoke()
     assert Path(extension.tabs["Load"].new_aedb).exists()
+    extension.root.destroy()
 
 
 @patch("tkinter.filedialog.askdirectory")
 def test_configure_layout_export(mock_askdirectory, local_scratch, add_app):
     test_dir = Path(local_scratch.path)
-    extension = ConfigureLayoutExtension(withdraw=False)
+    extension = ConfigureLayoutExtension(withdraw=True)
 
     add_app("ANSYS-HSD_V1", application=ansys.aedt.core.Hfss3dLayout, subfolder="T45")
     mock_askdirectory.return_value = str(test_dir)
@@ -83,7 +98,7 @@ def test_configure_layout_export(mock_askdirectory, local_scratch, add_app):
 def test_configure_layout_load_overwrite_active_design(mock_askdirectory, mock_askopenfilename, local_scratch, add_app):
     """Test applying configuration to active design, and overwriting active design."""
     test_dir = Path(local_scratch.path)
-    extension = ConfigureLayoutExtension(withdraw=False)
+    extension = ConfigureLayoutExtension(withdraw=True)
 
     add_app("ANSYS-HSD_V1", application=ansys.aedt.core.Hfss3dLayout, subfolder="T45")
     mock_askdirectory.return_value = str(test_dir)
@@ -102,7 +117,7 @@ def test_configure_layout_batch(mock_askdirectory, local_scratch):
 
     test_dir = Path(local_scratch.path)
     mock_askdirectory.return_value = str(test_dir)
-    extension = ConfigureLayoutExtension(withdraw=False)
+    extension = ConfigureLayoutExtension(withdraw=True)
     extension.root.nametowidget("notebook").nametowidget("load").nametowidget("generate_template").invoke()
 
     main(str(test_dir / "output"), str(Path(test_dir) / "example_serdes.toml"))

tests/system/extensions/test_configure_layout.py

@@ -32,13 +32,14 @@
 from ansys.aedt.core.extensions.hfss3dlayout.cutout import CutoutData
 from ansys.aedt.core.extensions.hfss3dlayout.cutout import main
 from ansys.aedt.core.hfss3dlayout import Hfss3dLayout
+from tests.system.extensions.conftest import config
 
 AEDB_FILE_NAME = "ANSYS-HSD_V1"
 TEST_SUBFOLDER = "T45"
 AEDT_FILE_PATH = Path(__file__).parent / "example_models" / TEST_SUBFOLDER / (AEDB_FILE_NAME + ".aedb")
 
 
-def test_cutout_success(add_app):
+def test_cutout_success(add_app, local_scratch):
     """Test the successful execution of the cutout operation in Hfss3dLayout."""
 
     # All DDR4 nets are used as signal nets, GND is used as reference net.
@@ -173,15 +174,18 @@ def test_cutout_success(add_app):
         expansion_factor=3.0,
         fix_disjoints=True,
     )
+    file_name = AEDB_FILE_NAME + ".aedb"
+    file_path = Path(local_scratch.path) / file_name
+    local_scratch.copyfolder(AEDT_FILE_PATH, file_path)
 
     # Check with Edb that nets exist in the original AEDB file.
-    edb_app = Edb(edbpath=str(AEDT_FILE_PATH))
+    edb_app = Edb(edbpath=str(file_path), edbversion=config["desktopVersion"])
     edb_app_nets = edb_app.nets
     assert all(net in edb_app_nets for net in SIGNAL_NETS + REFERENCE_NETS + OTHER_NETS)
     edb_app.close_edb()
 
     # Perform the cutout operation.
-    app = add_app(AEDB_FILE_NAME, application=Hfss3dLayout, subfolder=TEST_SUBFOLDER)
+    app = add_app(str(file_path), application=Hfss3dLayout, just_open=True)
     cutout_path = main(DATA)
     app.close_project()