Fix/Set default mpi for dmp (#611)

* Added switch '-mpi msmpi' to the launcher when
on windows and dmp is requested.

Resolves #609

* Converted additional switches to lower case.

Added version checking before adding flat msmpi.

Added a flag to enforce 'intel'.

Resolves #609

* Fixing grammar

* Fixing over-indented error.

* move additional switch validation to its own function

* add unit test for msmpi

* Apply suggestions from code review

Co-authored-by: jleonatti <[email protected]>

* Fixing naming

* whitespace fixes

* Fixed spacing

Co-authored-by: Alex Kaszynski <[email protected]>
Co-authored-by: jleonatti <[email protected]>

Author: 3 people

ansys/mapdl/core/launcher.py

@@ -32,6 +32,16 @@
 LOCALHOST = "127.0.0.1"
 MAPDL_DEFAULT_PORT = 50052
 
+INTEL_MSG = """Due to incompatibilites between 'DMP', Windows and VPN connections,
+the flat '-mpi INTELMPI' is overwritten by '-mpi msmpi'.
+
+If you still want to use 'INTEL', set:
+
+launch_mapdl(..., force_intel=True, additional_switches='-mpi INTELMPI')
+
+Be aware of possible errors or unexpected behaviour with this configuration.
+"""
+
 
 def _is_ubuntu():
     """Determine if running as Ubuntu
@@ -673,6 +683,55 @@ def check_lock_file(path, jobname, override):
                 )
 
 
+def _validate_add_sw(add_sw, exec_path, force_intel=False):
+    """Validate additional switches.
+
+    Parameters
+    ----------
+    add_sw : str
+        Additional swtiches.
+    exec_path : str
+        Path to the MAPDL executable.
+    force_intel : bool, optional
+        Force the usage of intelmpi. The default is ``False``.
+
+    Returns
+    -------
+    str
+        Validated additional switches.
+
+    """
+    # Converting additional_switches to lower case to avoid mismatches.
+    add_sw = add_sw.lower()
+
+    # known issues with distributed memory parallel (DMP)
+    if "smp" not in add_sw:  # pragma: no cover
+        # Ubuntu ANSYS fails to launch without I_MPI_SHM_LMT
+        if _is_ubuntu():
+            os.environ['I_MPI_SHM_LMT'] = 'shm'
+        if os.name == 'nt' and not force_intel:
+            # Workaround to fix a problem when launching ansys in 'dmp' mode in the
+            # recent windows version and using VPN.
+            #
+            # There doesn't appear to be an easy way to check if we
+            # are running VPN in Windows in python, it seems we will
+            # need to know a local address where to ping but that will
+            # change for each client/person using the VPN.
+            #
+            # Adding '-mpi msmpi' to the launch parameter fix it.
+
+            if 'intelmpi' in add_sw:
+                # Remove intel flag.
+                regex = "(-mpi)( *?)(intelmpi)"
+                add_sw = re.sub(regex, '', add_sw)
+                warnings.warn(INTEL_MSG)
+
+            if _version_from_path(exec_file) >= 210:
+                add_sw += ' -mpi msmpi'
+
+    return add_sw
+
+
 def launch_mapdl(
     exec_file=None,
     run_location=None,
@@ -973,13 +1032,9 @@ def launch_mapdl(
     check_lock_file(run_location, jobname, override)
     mode = check_mode(mode, _version_from_path(exec_file))
 
-    # known issue with distributed memory parallel
-    # Ubuntu ANSYS fails to launch without I_MPI_SHM_LMT
-    if "smp" not in additional_switches:
-        if _is_ubuntu():
-            os.environ["I_MPI_SHM_LMT"] = "shm"
-
     # cache start parameters
+    additional_switches = _validate_add_sw(additional_switches, exec_file,
+                                          kwargs.pop('force_intel', False))
     start_parm = {
         "exec_file": exec_file,
         "run_location": run_location,

tests/test_launcher.py

@@ -27,6 +27,8 @@
     "195",  # 2019R3
     "201",  # 2020R1
     "202",  # 2020R2
+    "211",  # 2021R1
+    "212",  # 2021R2
 ]
 
 valid_versions = []
@@ -46,11 +48,20 @@
 
 paths = [
     ("/usr/dir_v2019.1/slv/ansys_inc/v211/ansys/bin/ansys211", 211),
-    ("C:/Program Files/ANSYS Inc/v202\\ansys/bin/win64/ANSYS202.exe", 202),
+    ("C:/Program Files/ANSYS Inc/v202/ansys/bin/win64/ANSYS202.exe", 202),
     ("/usr/ansys_inc/v211/ansys/bin/mapdl", 211),
 ]
 
 
+@pytest.mark.skipif(os.name != "nt", reason="Requires Windows")
+def test_validate_sw():
+    # ensure that windows adds msmpi
+    # fake windows path
+    exec_path = "C:/Program Files/ANSYS Inc/v211/ansys/bin/win64/ANSYS211.exe"
+    add_sw = _validate_add_sw('', exec_path)
+    assert 'msmpi' in add_sw
+
+
 @pytest.mark.parametrize("path_data", paths)
 def test_version_from_path(path_data):
     exec_file, version = path_data