Merge branch 'main' into fix_issue1176

Author: Samuelopez-ansys

_unittest/test_11_Setup.py

@@ -67,3 +67,11 @@ def test_03_non_valid_setup(self):
         assert not setup1.enable_adaptive_setup_broadband(1, 2.5, 10, 0.01)
         assert not setup1.enable_adaptive_setup_single(3.5)
         self.aedtapp.solution_type = sol
+
+    def test_04_delete_setup(self):
+        self.aedtapp.duplicate_design("delete_setups")
+        setup1 = self.aedtapp.create_setup("My_HFSS_Setup2", self.aedtapp.SETUPS.HFSSDrivenAuto)
+        assert len(self.aedtapp.setups) == 1
+        assert setup1.delete()
+        assert len(self.aedtapp.setups) == 0
+        assert not self.aedtapp.get_setups()

_unittest/test_12_PostProcessing.py

@@ -147,9 +147,26 @@ def test_03_get_solution_data(self):
         assert os.path.exists(os.path.join(self.local_scratch.path, "output.csv"))
 
     def test_04_export_touchstone(self):
-        self.aedtapp.export_touchstone("Setup1", "Sweep", os.path.join(self.local_scratch.path, "Setup1_Sweep.S2p"))
+        setup_name = "Setup1"
+        sweep_name = "Sweep"
+        self.aedtapp.export_touchstone(
+            setup_name, sweep_name, os.path.join(self.local_scratch.path, "Setup1_Sweep.S2p")
+        )
         assert os.path.exists(os.path.join(self.local_scratch.path, "Setup1_Sweep.S2p"))
 
+        sweep_name = None
+        self.aedtapp.export_touchstone(
+            setup_name, sweep_name, os.path.join(self.local_scratch.path, "Setup1_Sweep2.S2p")
+        )
+        assert os.path.exists(os.path.join(self.local_scratch.path, "Setup1_Sweep2.S2p"))
+        setup_name = None
+        self.aedtapp.export_touchstone(
+            setup_name, sweep_name, os.path.join(self.local_scratch.path, "Setup1_Sweep3.S2p")
+        )
+        assert os.path.exists(os.path.join(self.local_scratch.path, "Setup1_Sweep3.S2p"))
+
+        assert self.aedtapp.export_touchstone(setup_name, sweep_name)
+
     @pytest.mark.skipif(config["build_machine"] == True, reason="Not running in non-graphical mode")
     def test_05_export_report_to_jpg(self):
 
@@ -698,3 +715,10 @@ def test_60_test_parse_vector(self):
         local_path = os.path.dirname(os.path.realpath(__file__))
         out = _parse_streamline(os.path.join(local_path, "example_models", "test_streamline.fldplt"))
         assert isinstance(out, list)
+
+    def test_61_delete_variations(self):
+        assert self.q3dtest.cleanup_solution()
+        vars = self.field_test.available_variations.get_variation_strings()
+        assert self.field_test.available_variations.variations()
+        assert self.field_test.cleanup_solution(vars, entire_solution=False)
+        assert self.field_test.cleanup_solution(vars, entire_solution=True)

_unittest/test_20_HFSS.py

@@ -597,6 +597,7 @@ def test_25_create_parametrics(self):
         )
         oo = self.aedtapp.get_oo_object(self.aedtapp.odesign, r"Optimetrics\ParametricsfromFile")
         assert oo
+        assert self.aedtapp.parametrics.delete("ParametricsfromFile")
 
     def test_26_create_optimization(self):
         calculation = "db(S(Cir1,Cir1))"
@@ -626,13 +627,15 @@ def test_26_create_optimization(self):
             if "NAME:Ranges" in el:
                 break
         assert "rd" in el[2]
+        assert self.aedtapp.optimizations.delete(setup2.name)
 
     def test_27_create_doe(self):
         setup2 = self.aedtapp.optimizations.add("db(S(1,1))", ranges={"Freq": "2.5GHz"}, optim_type="DXDOE")
         assert setup2.add_variation("w1", 0.1, 10, 51)
         assert setup2
         assert setup2.add_goal(calculation="dB(S(1,1))", ranges={"Freq": "2.6GHz"})
         assert setup2.add_calculation(calculation="dB(S(1,1))", ranges={"Freq": "2.5GHz"})
+        assert setup2.delete()
 
     def test_28A_create_dx(self):
         setup2 = self.aedtapp.optimizations.add(None, {"w1": "1mm", "w2": "2mm"}, optim_type="optiSLang")

_unittest/test_21_Circuit.py

@@ -203,7 +203,14 @@ def test_17_create_setup(self):
     def test_18_export_touchstone(self):
         assert self.aedtapp.analyze_nominal()
         time.sleep(30)
-        assert self.aedtapp.export_touchstone("Dom_LNA", "Dom_LNA", os.path.join(self.local_scratch.path, "new.s2p"))
+        solution_name = "Dom_LNA"
+        sweep_name = None
+        file_name = os.path.join(self.local_scratch.path, "new.s2p")
+        assert self.aedtapp.export_touchstone(solution_name, sweep_name, file_name)
+        assert os.path.exists(file_name)
+        assert self.aedtapp.existing_analysis_sweeps[0] == solution_name
+        assert self.aedtapp.setup_names[0] == solution_name
+        assert self.aedtapp.export_touchstone(solution_name, sweep_name)
 
     def test_19A_create_sweeps(self):
         setup_name = "Sweep_LNA"

_unittest/test_41_3dlayout_modeler.py

@@ -364,8 +364,13 @@ def test_19B_analyze_setup(self):
     @pytest.mark.skipif(os.name == "posix", reason="To be investigated on linux.")
     def test_19C_export_touchsthone(self):
         filename = os.path.join(scratch_path, "touchstone.s2p")
-        assert self.aedtapp.export_touchstone("RFBoardSetup3", "Last Adaptive", filename, [], [])
+        solution_name = "RFBoardSetup3"
+        sweep_name = "Last Adaptive"
+        assert self.aedtapp.export_touchstone(solution_name, sweep_name, filename)
         assert os.path.exists(filename)
+        assert self.aedtapp.export_touchstone(solution_name)
+        sweep_name = None
+        assert self.aedtapp.export_touchstone(solution_name, sweep_name)
 
     def test_19D_export_to_hfss(self):
         with Scratch(scratch_path) as local_scratch:

pyaedt/application/Analysis.py

@@ -928,21 +928,20 @@ def variations(self, setup_sweep=None):
 
             >>> oModule.GetAvailableVariations
             """
-            if not setup_sweep:
-                setup_sweep = self._app.existing_analysis_sweeps[0]
-            vs = self._app.osolution.GetAvailableVariations(setup_sweep)
+            vs = self.get_variation_strings(setup_sweep)
             families = []
-            for v in vs:
-                variations = v.split(" ")
-                family = []
-                for el in self.variables:
-                    family.append(el + ":=")
-                    i = 0
-                    while i < len(variations):
-                        if variations[i][0 : len(el)] == el:
-                            family.append([variations[i][len(el) + 2 : -1]])
-                        i += 1
-                families.append(family)
+            if vs:
+                for v in vs:
+                    variations = v.split(" ")
+                    family = []
+                    for el in self.variables:
+                        family.append(el + ":=")
+                        i = 0
+                        while i < len(variations):
+                            if variations[i][0 : len(el)] == el:
+                                family.append([variations[i][len(el) + 2 : -1]])
+                            i += 1
+                    families.append(family)
             return families
 
         @pyaedt_function_handler()
@@ -1709,3 +1708,120 @@ def submit_job(
                     f1.write(line)
         f1.close()
         return self.odesktop.SubmitJob(os.path.join(project_path, "Job_settings.areg"), project_file)
+
+    @pyaedt_function_handler()
+    def _export_touchstone(
+        self, solution_name=None, sweep_name=None, file_name=None, variations=None, variations_value=None
+    ):
+        """Export the Touchstone file to a local folder.
+
+        Parameters
+        ----------
+        solution_name : str, optional
+            Name of the solution that has been solved.
+        sweep_name : str, optional
+            Name of the sweep that has been solved.
+            This parameter has to be ignored or set with same value as solution_name
+        file_name : str, optional
+            Full path and name for the Touchstone file. The default is ``None``,
+            which exports the file to the working directory.
+        variations : list, optional
+            List of all parameter variations. For example, ``["$AmbientTemp", "$PowerIn"]``.
+            The default is ``None``.
+        variations_value : list, optional
+            List of all parameter variation values. For example, ``["22cel", "100"]``.
+            The default is ``None``.
+
+        Returns
+        -------
+        bool
+            ``True`` when successful, ``False`` when failed.
+        """
+        if variations is None:
+            variations = list(self.available_variations.nominal_w_values_dict.keys())
+            if variations_value is None:
+                variations_value = [str(x) for x in list(self.available_variations.nominal_w_values_dict.values())]
+
+        if solution_name is None:
+            nominal_sweep_list = [x.strip() for x in self.nominal_sweep.split(":")]
+            solution_name = nominal_sweep_list[0]
+        if self.design_type == "Circuit Design":
+            sweep_name = solution_name
+        else:
+            if sweep_name is None:
+                for sol in self.existing_analysis_sweeps:
+                    if solution_name == sol.split(":")[0].strip():
+                        sweep_name = sol.split(":")[1].strip()
+                        break
+
+        if self.design_type == "HFSS 3D Layout Design":
+            n = str(len(self.port_list))
+        else:
+            n = str(len(self.excitations))
+        # Normalize the save path
+        if not file_name:
+            appendix = ""
+            for v, vv in zip(variations, variations_value):
+                appendix += "_" + v + vv.replace("'", "")
+            ext = ".S" + n + "p"
+            filename = os.path.join(self.working_directory, solution_name + "_" + sweep_name + appendix + ext)
+        else:
+            filename = file_name.replace("//", "/").replace("\\", "/")
+        self.logger.info("Exporting Touchstone " + filename)
+        DesignVariations = ""
+        for i in range(len(variations)):
+            DesignVariations += str(variations[i]) + "='" + str(variations_value[i].replace("'", "")) + "' "
+            # DesignVariations = "$AmbientTemp=\'22cel\' $PowerIn=\'100\'"
+        # array containing "SetupName:SolutionName" pairs (note that setup and solution are separated by a colon)
+        SolutionSelectionArray = [solution_name + ":" + sweep_name]
+        # 2=tab delimited spreadsheet (.tab), 3= touchstone (.sNp), 4= CitiFile (.cit),
+        # 7=Matlab (.m), 8=Terminal Z0 spreadsheet
+        FileFormat = 3
+        OutFile = filename  # full path of output file
+        # array containin the frequencies to export, use ["all"] for all frequencies
+        FreqsArray = ["all"]
+        DoRenorm = True  # perform renormalization before export
+        RenormImped = 50  # Real impedance value in ohm, for renormalization
+        DataType = "S"  # Type: "S", "Y", or "Z" matrix to export
+        Pass = -1  # The pass to export. -1 = export all passes.
+        ComplexFormat = 0  # 0=Magnitude/Phase, 1=Real/Immaginary, 2=dB/Phase
+        DigitsPrecision = 15  # Touchstone number of digits precision
+        IncludeGammaImpedance = True  # Include Gamma and Impedance in comments
+        NonStandardExtensions = False  # Support for non-standard Touchstone extensions
+
+        if self.design_type == "HFSS":
+            self.osolution.ExportNetworkData(
+                DesignVariations,
+                SolutionSelectionArray,
+                FileFormat,
+                OutFile,
+                FreqsArray,
+                DoRenorm,
+                RenormImped,
+                DataType,
+                Pass,
+                ComplexFormat,
+                DigitsPrecision,
+                False,
+                IncludeGammaImpedance,
+                NonStandardExtensions,
+            )
+        else:
+            self.odesign.ExportNetworkData(
+                DesignVariations,
+                SolutionSelectionArray,
+                FileFormat,
+                OutFile,
+                FreqsArray,
+                DoRenorm,
+                RenormImped,
+                DataType,
+                Pass,
+                ComplexFormat,
+                DigitsPrecision,
+                False,
+                IncludeGammaImpedance,
+                NonStandardExtensions,
+            )
+        self.logger.info("Touchstone correctly exported to %s", filename)
+        return True

pyaedt/application/Analysis3D.py

@@ -798,3 +798,36 @@ def assignmaterial_from_sherlock_files(self, csv_component, csv_material):
             i += 1
             all_objs = [ao for ao in all_objs if ao not in list_mat_obj]
         return True
+
+    @pyaedt_function_handler()
+    def cleanup_solution(self, variations="All", entire_solution=True, field=True, mesh=True, linked_data=True):
+        """Delete a set of Solution Variations or part of them.
+
+        Parameters
+        ----------
+        variations : List, str, optional
+            All variations to delete. Default is `"All"` which deletes all available solutions.
+        entire_solution : bool, optional
+            Either if delete entire Solution or part of it. If `True` other booleans will be ignored
+            as solution will be entirely deleted.
+        field : bool, optional
+            Either if delete entire Fields of variation or not. Default is `True`.
+        mesh : bool, optional
+            Either if delete entire Mesh of variation or not. Default is `True`.
+        linked_data : bool, optional
+            Either if delete entire Linked Data of variation or not. Default is `True`.
+
+        Returns
+        -------
+        bool
+            `True` if Delete operation succeeded.
+        """
+        if isinstance(variations, str):
+            variations = [variations]
+        if entire_solution:
+            self.odesign.DeleteFullVariation(variations, linked_data)
+        elif field:
+            self.odesign.DeleteFieldVariation(variations, mesh, linked_data)
+        elif linked_data:
+            self.odesign.DeleteLinkedDataVariation(variations)
+        return True

pyaedt/circuit.py

@@ -762,19 +762,21 @@ def import_touchstone_solution(self, filename, solution_name="Imported_Data"):
         return portnames
 
     @pyaedt_function_handler()
-    def export_touchstone(self, solutionname, sweepname, filename=None, variation=None, variations_value=None):
+    def export_touchstone(
+        self, solution_name=None, sweep_name=None, file_name=None, variations=None, variations_value=None
+    ):
         """Export the Touchstone file to a local folder.
 
         Parameters
         ----------
-        solutionname : str
+        solution_name : str, optional
             Name of the solution that has been solved.
-        sweepname : str
+        sweep_name : str, optional
             Name of the sweep that has been solved.
-        filename : str, optional
-            Full path and name for the Touchstone file. The default is ``None``,
-            which exports the file to the working directory.
-        variation : list, optional
+        file_name : str, optional
+            Full path and name for the Touchstone file.
+            The default is ``None``, in which case the file is exported to the working directory.
+        variations : list, optional
             List of all parameter variations. For example, ``["$AmbientTemp", "$PowerIn"]``.
             The default is ``None``.
         variations_value : list, optional
@@ -791,62 +793,13 @@ def export_touchstone(self, solutionname, sweepname, filename=None, variation=No
 
         >>> oDesign.ExportNetworkData
         """
-        if variation == None:
-            variation = []
-        if variations_value == None:
-            variations_value = []
-
-        # Normalize the save path
-        if not filename:
-            appendix = ""
-            for v, vv in zip(variation, variations_value):
-                appendix += "_" + v + vv.replace("'", "")
-            ext = ".S" + str(self.oboundary.GetNumExcitations()) + "p"
-            filename = os.path.join(self.working_directory, solutionname + "_" + sweepname + appendix + ext)
-        else:
-            filename = filename.replace("//", "/").replace("\\", "/")
-        self.logger.info("Exporting Touchstone " + filename)
-        DesignVariations = ""
-        i = 0
-        for el in variation:
-            DesignVariations += str(variation[i]) + "='" + str(variations_value[i].replace("'", "")) + "' "
-            i += 1
-            # DesignVariations = "$AmbientTemp=\'22cel\' $PowerIn=\'100\'"
-        # array containing "SetupName:SolutionName" pairs (note that setup and solution are separated by a colon)
-        SolutionSelectionArray = [solutionname + ":" + sweepname]
-        # 2=tab delimited spreadsheet (.tab), 3= touchstone (.sNp), 4= CitiFile (.cit),
-        # 7=Matlab (.m), 8=Terminal Z0 spreadsheet
-        FileFormat = 3
-        OutFile = filename  # full path of output file
-        # array containin the frequencies to export, use ["all"] for all frequencies
-        FreqsArray = ["all"]
-        DoRenorm = True  # perform renormalization before export
-        RenormImped = 50  # Real impedance value in ohm, for renormalization
-        DataType = "S"  # Type: "S", "Y", or "Z" matrix to export
-        Pass = -1  # The pass to export. -1 = export all passes.
-        ComplexFormat = 0  # 0=Magnitude/Phase, 1=Real/Immaginary, 2=dB/Phase
-        DigitsPrecision = 15  # Touchstone number of digits precision
-        IncludeGammaImpedance = True  # Include Gamma and Impedance in comments
-        NonStandardExtensions = False  # Support for non-standard Touchstone extensions
-
-        self.odesign.ExportNetworkData(
-            DesignVariations,
-            SolutionSelectionArray,
-            FileFormat,
-            OutFile,
-            FreqsArray,
-            DoRenorm,
-            RenormImped,
-            DataType,
-            Pass,
-            ComplexFormat,
-            DigitsPrecision,
-            False,
-            IncludeGammaImpedance,
-            NonStandardExtensions,
+        return self._export_touchstone(
+            solution_name=solution_name,
+            sweep_name=sweep_name,
+            file_name=file_name,
+            variations=variations,
+            variations_value=variations_value,
         )
-        self.logger.info("Touchstone correctly exported to %s", filename)
-        return True
 
     @pyaedt_function_handler()
     def export_fullwave_spice(