FEAT: edit sources harmonic loss q3d (#6826)

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

Author: gmalinve

doc/changelog.d/6826.added.md

@@ -0,0 +1 @@
+Edit sources harmonic loss q3d

src/ansys/aedt/core/q3d.py

@@ -267,12 +267,7 @@ def export_mesh_stats(self, setup, variations="", output_file=None, setup_type="
         return str(output_file)
 
     @pyaedt_function_handler()
-    def edit_sources(
-        self,
-        cg=None,
-        acrl=None,
-        dcrl=None,
-    ):
+    def edit_sources(self, cg=None, acrl=None, dcrl=None, harmonic_loss=None):
         """Set up the source loaded for Q3D or Q2D in multiple sources simultaneously.
 
         Parameters
@@ -293,6 +288,12 @@ def edit_sources(
             - 1 Magnitude to set up ``0deg`` as the default
             - 2 Values tuple or list (magnitude and phase)
 
+        harmonic_loss: dict, optional
+            Dictionary of real and imaginary currents for each source in order to compute harmonic loss.
+            Dictionary values can be:
+            - 1 Real part of the current
+            - 2 Imag part of the current
+
         Returns
         -------
         bool
@@ -306,11 +307,17 @@ def edit_sources(
         >>> sources_acrl = {"Box1:Source1": ("5A", "0deg")}
         Values can also be passed as lists instead of tuples.
         >>> sources_dcrl = {"Box1_1:Source2": ["5V", "0deg"]}
-        >>> q3d.edit_sources(cg=sources_cg, acrl=sources_acrl, dcrl=sources_dcrl)
+        Assuming to have two TAB files containing respectively the real and imaginary parts
+        of the current for the source ``Box1:Source1``.
+        >>> real_data_set = q3d.import_dataset1d("real_dataset_file_path", name="real_dataset")
+        >>> imag_data_set = q3d.import_dataset1d("imag_dataset_file_path", name="imag_dataset")
+        >>> harmonic_loss = {"Box1:Source1": (real_data_set.name, imag_data_set.name)}
+        >>> q3d.edit_sources(cg=sources_cg, acrl=sources_acrl, dcrl=sources_dcrl, harmonic_loss=harmonic_loss)
         """
         settings_ac = []
         settings_cg = []
         settings_dc = []
+        settings_harmonic_loss = []
         if cg:
             source_list = ["NAME:Source Names"]
             if self.default_solution_type == "Q3D Extractor":
@@ -399,8 +406,36 @@ def edit_sources(
 
             settings_dc = ["NAME:DC", "Value Type:=", magnitude_unit, source_list, magnitude_list, phase_list]
 
+        if harmonic_loss:
+            source_list = ["NAME:Source Names"]
+            source_real_dataset_names = ["NAME:Source real dataset names"]
+            source_imag_dataset_names = ["NAME:Source imag dataset names"]
+            sources = [source.name for source in self.excitations_by_type["Source"]]
+
+            for key, vals in harmonic_loss.items():
+                if key not in sources and key not in self.get_all_sources():
+                    self.logger.error("Not existing source " + key)
+                    return False
+
+                source_list.append(key)
+                if not isinstance(vals, (tuple, list)):
+                    self.logger.error("Real and Imag part of current must be provided")
+                    return False
+                else:
+                    source_real_dataset_names.append(vals[0])
+                    source_imag_dataset_names.append(vals[1])
+
+            settings_harmonic_loss = [
+                "NAME:HarmonicLoss",
+                "Value Type:=",
+                "A",
+                source_list,
+                source_real_dataset_names,
+                source_imag_dataset_names,
+            ]
+
         if self.default_solution_type == "Q3D Extractor":
-            self.osolution.EditSources(settings_ac, settings_cg, settings_dc)
+            self.osolution.EditSources(settings_ac, settings_cg, settings_dc, settings_harmonic_loss)
         else:
             self.osolution.EditSources(settings_cg, settings_ac)
         return True

tests/system/extensions/test_via_clustering.py

@@ -35,6 +35,7 @@
 from tests import TESTS_EXTENSIONS_PATH
 
 
+@pytest.mark.skipif(is_linux, reason="Not supported in Linux.")
 def test_via_clustering_main_function(local_scratch):
     """Test the main function of the Via Clustering extension."""
     # Copy test model to scratch directory

tests/system/solvers/example_models/T31/Q3d_solved.aedtz

@@ -383,6 +383,15 @@ def test_14_edit_sources(self, q3d_solved):
         sources_dc = {"Box1:Source1": "20v"}
         assert q3d_solved.edit_sources(None, None, sources_dc)
 
+        real_dataset = q3d_solved.design_datasets["ds1"].name
+        imag_dataset = q3d_solved.design_datasets["ds2"].name
+        harmonic_loss = {"Box1:Source1": (real_dataset, imag_dataset)}
+        assert q3d_solved.edit_sources(harmonic_loss=harmonic_loss)
+        harmonic_loss = {"invalid": (real_dataset, imag_dataset)}
+        assert not q3d_solved.edit_sources(harmonic_loss=harmonic_loss)
+        harmonic_loss = {"Box1:Source1": real_dataset}
+        assert not q3d_solved.edit_sources(harmonic_loss=harmonic_loss)
+
     def test_15_insert_reduced(self, q3d_solved):
         q3d = q3d_solved
         mm = q3d.insert_reduced_matrix("JoinSeries", ["Source1", "Sink4"], "JointTest_r")