FIX: previous setup support in icepak (#4821)

Author: lorenzovecchietti

_unittest/test_98_Icepak.py

@@ -1695,3 +1695,27 @@ def test_76_design_settings(self):
         assert d["GravityDir"] == "Positive"
         d["GravityVec"] = "Global::Y"
         assert d["GravityVec"] == "Global::Y"
+
+    def test_78_restart_solution(self):
+        self.aedtapp.insert_design("test_78-1")
+        self.aedtapp.insert_design("test_78-2")
+        self.aedtapp.set_active_design("test_78-1")
+        self.aedtapp["a"] = "1mm"
+        self.aedtapp.modeler.create_box([0, 0, 0], ["a", "1", "2"])
+        s1 = self.aedtapp.create_setup()
+        self.aedtapp.set_active_design("test_78-2")
+        self.aedtapp["b"] = "1mm"
+        self.aedtapp.modeler.create_box([0, 0, 0], ["b", "1", "2"])
+        s2 = self.aedtapp.create_setup()
+        assert s2.start_continue_from_previous_setup(
+            "test_78-1", "{} : SteadyState".format(s1.name), parameters={"a": "1mm"}
+        )
+        s2.delete()
+        s2 = self.aedtapp.create_setup()
+        assert s2.start_continue_from_previous_setup("test_78-1", "{} : SteadyState".format(s1.name), parameters=None)
+        s2.delete()
+        s2 = self.aedtapp.create_setup()
+        assert not s2.start_continue_from_previous_setup(
+            "test_78-1", "{} : SteadyState".format(s1.name), project="FakeFolder123"
+        )
+        assert not s2.start_continue_from_previous_setup("test_78-12", "{} : SteadyState".format(s1.name))

pyaedt/application/Analysis.py

@@ -64,6 +64,7 @@
 from pyaedt.modules.SolveSetup import Setup
 from pyaedt.modules.SolveSetup import SetupHFSS
 from pyaedt.modules.SolveSetup import SetupHFSSAuto
+from pyaedt.modules.SolveSetup import SetupIcepak
 from pyaedt.modules.SolveSetup import SetupMaxwell
 from pyaedt.modules.SolveSetup import SetupQ3D
 from pyaedt.modules.SolveSetup import SetupSBR
@@ -1326,6 +1327,8 @@ def _create_setup(self, name="MySetupAuto", setup_type=None, props=None):
             setup = SetupMaxwell(self, setup_type, name)
         elif setup_type == 14:
             setup = SetupQ3D(self, setup_type, name)
+        elif setup_type in [11, 36]:
+            setup = SetupIcepak(self, setup_type, name)
         else:
             setup = SetupHFSS(self, setup_type, name)
 

pyaedt/icepak.py

@@ -4032,7 +4032,7 @@ def assign_stationary_wall_with_htc(
         )
 
     @pyaedt_function_handler(setupname="name", setuptype="setup_type")
-    def create_setup(self, name="MySetupAuto", setup_type=None, **kwargs):
+    def create_setup(self, name=None, setup_type=None, **kwargs):
         """Create an analysis setup for Icepak.
         Optional arguments are passed along with ``setup_type`` and ``name``.  Keyword
         names correspond to the ``setup_type``
@@ -4045,7 +4045,7 @@ def create_setup(self, name="MySetupAuto", setup_type=None, **kwargs):
         Parameters
         ----------
         name : str, optional
-            Name of the setup. The default is ``"Setup1"``.
+            Name of the setup.
         setup_type : int, str, optional
             Type of the setup. Options are ``"IcepakSteadyState"``
             and ``"IcepakTransient"``. The default is ``"IcepakSteadyState"``.

pyaedt/modules/SolveSetup.py

@@ -903,6 +903,54 @@ def add_mesh_link(
             self.auto_update = auto_update
             return False
 
+    def _parse_link_parameters(self, map_variables_by_name, parameters):
+        # parameters
+        params = OrderedDict({})
+        if map_variables_by_name:
+            parameters = self.p_app.available_variations.nominal_w_values_dict
+            for k, v in parameters.items():
+                params[k] = k
+        elif parameters is None:
+            parameters = self.p_app.available_variations.nominal_w_values_dict
+            for k, v in parameters.items():
+                params[k] = v
+        else:
+            for k, v in parameters.items():
+                if k in list(self._app.available_variations.nominal_w_values_dict.keys()):
+                    params[k] = v
+                else:
+                    params[k] = parameters[v]
+        return params
+
+    def _parse_link_solution(self, project, design, solution):
+        prev_solution = OrderedDict({})
+
+        # project name
+        if project != "This Project*":
+            if os.path.exists(project):
+                prev_solution["Project"] = project
+                self.props["PathRelativeTo"] = "SourceProduct"
+            else:
+                raise ValueError("Project file path provided does not exist.")
+        else:
+            prev_solution["Project"] = project
+            self.props["PathRelativeTo"] = "TargetProject"
+
+        # design name
+        if not design or design is None:
+            raise ValueError("Provide design name to add mesh link to.")
+        elif design not in self.p_app.design_list:
+            raise ValueError("Design does not exist in current project.")
+        else:
+            prev_solution["Design"] = design
+
+        # solution name
+        if solution:
+            prev_solution["Soln"] = solution
+        else:
+            raise ValueError("Provide a valid solution name.")
+        return prev_solution
+
     @pyaedt_function_handler(
         design_name="design", solution_name="solution", parameters_dict="parameters", project_name="project"
     )
@@ -922,7 +970,7 @@ def start_continue_from_previous_setup(
         ----------
         design : str
             Name of the design.
-        solution : str, optional
+        solution : str
             Name of the solution in the format ``"name : solution_name"``.
             For example, ``"Setup1 : Transient", "MySetup : LastAdaptive"``.
         map_variables_by_name : bool, optional
@@ -962,49 +1010,9 @@ def start_continue_from_previous_setup(
         try:
             self.auto_update = False
 
-            # parameters
-            params = OrderedDict({})
-            if map_variables_by_name:
-                parameters = self.p_app.available_variations.nominal_w_values_dict
-                for k, v in parameters.items():
-                    params[k] = k
-            elif parameters is None:
-                parameters = self.p_app.available_variations.nominal_w_values_dict
-                for k, v in parameters.items():
-                    params[k] = v
-            else:
-                for k, v in parameters.items():
-                    if k in list(self._app.available_variations.nominal_w_values_dict.keys()):
-                        params[k] = v
-                    else:
-                        params[k] = parameters[v]
-
-            prev_solution = OrderedDict({})
-
-            # project name
-            if project != "This Project*":
-                if os.path.exists(project):
-                    prev_solution["Project"] = project
-                    self.props["PathRelativeTo"] = "SourceProduct"
-                else:
-                    raise ValueError("Project file path provided does not exist.")
-            else:
-                prev_solution["Project"] = project
-                self.props["PathRelativeTo"] = "TargetProject"
-
-            # design name
-            if not design or design is None:
-                raise ValueError("Provide design name to add mesh link to.")
-            elif design not in self.p_app.design_list:
-                raise ValueError("Design does not exist in current project.")
-            else:
-                prev_solution["Design"] = design
+            params = self._parse_link_parameters(map_variables_by_name, parameters)
 
-            # solution name
-            if solution:
-                prev_solution["Soln"] = solution
-            else:
-                raise ValueError("Provide a valid solution name.")
+            prev_solution = self._parse_link_solution(project, design, solution)
 
             self.props["PrevSoln"] = prev_solution
 
@@ -3883,3 +3891,85 @@ def update(self, properties=None):
 
         self.omodule.EditSetup(self.name, arg)
         return True
+
+
+class SetupIcepak(Setup, object):
+    def __init__(self, app, solution_type, setup_name, is_new_setup=True):
+        Setup.__init__(self, app, solution_type, setup_name, is_new_setup)
+
+    def start_continue_from_previous_setup(
+        self,
+        design,
+        solution,
+        map_variables_by_name=True,
+        parameters=None,
+        project="This Project*",
+        force_source_to_solve=True,
+        preserve_partner_solution=True,
+        frozen_flow=False,
+    ):
+        """Start or continue from a previously solved setup.
+
+        Parameters
+        ----------
+        design : str
+            Name of the design.
+        solution : str
+            Name of the solution in the format ``"name : solution_name"``.
+            For example, ``"Setup1 : Transient"``, ``"Setup1 : SteadyState"``.
+        map_variables_by_name : bool, optional
+            Whether variables are mapped by name from the source design. The default is
+            ``True``.
+        parameters : dict, optional
+            Dictionary of the parameters. This argument is not considered if
+            ``map_variables_by_name=True``. If ``None``, the default is
+            ``appname.available_variations.nominal_w_values_dict``.
+        project : str, optional
+            Name of the project with the design. The default is ``"This Project*"``.
+            However, you can supply the full path and name to another project.
+        force_source_to_solve : bool, optional
+            The default is ``True``.
+        preserve_partner_solution : bool, optional
+            The default is ``True``.
+        frozen_flow : bool, optional
+            Whether to freeze the flow to the previous solution. The default is ``False``.
+
+        Returns
+        -------
+        bool
+            ``True`` when successful, ``False`` when failed.
+
+        References
+        ----------
+
+        >>> oModule.EditSetup
+
+        Examples
+        --------
+        >>> ipk = pyaedt.Icepak()
+        >>> setup = ipk.get_setup("Setup1")
+        >>> setup.start_continue_from_previous_setup(design="IcepakDesign1",solution="Setup1 : SteadyState")
+
+        """
+
+        auto_update = self.auto_update
+        try:
+            self.auto_update = False
+
+            params = self._parse_link_parameters(map_variables_by_name, parameters)
+
+            prev_solution = self._parse_link_solution(project, design, solution)
+
+            self.props["RestartSoln"] = prev_solution
+
+            self.props["RestartSoln"]["Params"] = params
+            self.props["RestartSoln"]["ForceSourceToSolve"] = force_source_to_solve
+            self.props["RestartSoln"]["PreservePartnerSoln"] = preserve_partner_solution
+            self.props["Frozen Flow Simulation"] = frozen_flow
+
+            self.update()
+            self.auto_update = auto_update
+            return True
+        except Exception:
+            self.auto_update = auto_update
+            return False