FLUIDSIM_TYPE_FFT2D and FLUIDSIM_TYPE_FFT3D

Author: paugier

Makefile

@@ -103,7 +103,7 @@ pytest_cov_html_full:
 
 define _pytest_mpi_operators3d
 	$(call _init_coverage)
-	FLUIDSIM_TYPE_FFT=$(1) TRANSONIC_NO_REPLACE=1 mpirun -np $(MPI_NUM_PROCS) coverage run -p -m pytest -v --exitfirst fluidsim/operators/test/test_operators3d.py -p no:warnings
+	FLUIDSIM_TYPE_FFT3D=$(1) TRANSONIC_NO_REPLACE=1 mpirun -np $(MPI_NUM_PROCS) coverage run -p -m pytest -v --exitfirst fluidsim/operators/test/test_operators3d.py -p no:warnings
 	$(call _end_coverage_combine)
 endef
 
@@ -118,8 +118,8 @@ pytest_mpi_with_pfft:
 
 pytest_mpi_with_p3dfft:
 	$(call _init_coverage)
-	FLUIDSIM_TYPE_FFT=fft3d.mpi_with_p3dfft TRANSONIC_NO_REPLACE=1 mpirun -np $(MPI_NUM_PROCS) \
+	FLUIDSIM_TYPE_FFT3D=fft3d.mpi_with_p3dfft TRANSONIC_NO_REPLACE=1 mpirun -np $(MPI_NUM_PROCS) \
 	  coverage run -p -m pytest -v --exitfirst fluidsim/operators/test/test_operators3d.py::TestCoarse
-	FLUIDSIM_TYPE_FFT=fft3d.mpi_with_p3dfft TRANSONIC_NO_REPLACE=1 mpirun -np $(MPI_NUM_PROCS) \
+	FLUIDSIM_TYPE_FFT3D=fft3d.mpi_with_p3dfft TRANSONIC_NO_REPLACE=1 mpirun -np $(MPI_NUM_PROCS) \
 	  coverage run -p -m pytest -v --exitfirst fluidsim/operators/test/test_operators3d.py -k "not TestCoarse"
 	$(call _end_coverage_combine)

doc/install.md

@@ -142,8 +142,8 @@ Fluidsim is sensitive to environment variables:
 
 - `FLUIDDYN_PATH_SCRATCH`: working directory (can be useful on some clusters).
 
-- `FLUIDSIM_TYPE_FFT`: set the Fluidfft method (see
-  <https://fluidfft.readthedocs.io/en/latest/plugins.html>).
+- `FLUIDSIM_TYPE_FFT2D` and `FLUIDSIM_TYPE_FFT3D`: set the Fluidfft method
+  (see <https://fluidfft.readthedocs.io/en/latest/plugins.html>).
 
 ## Dependencies with different flavours
 

fluidsim/operators/base.py

@@ -17,20 +17,23 @@
 
 import os
 
+from warnings import warn
+
 import numpy as np
 
 from fluiddyn.util import mpi
 
 
-def _get_type_fft_from_params_and_env(params):
-    if "FLUIDSIM_TYPE_FFT" in os.environ:
-        if params.oper.type_fft != "default":
-            raise ValueError(
-                "FLUIDSIM_TYPE_FFT is set and params.oper.type_fft != 'default'"
-            )
-        type_fft = os.environ["FLUIDSIM_TYPE_FFT"]
-        print(f"Using FLUIDSIM_TYPE_FFT={type_fft}")
-        return type_fft
+def _get_type_fft_from_params_and_env(params, dim: str):
+    var_name = "FLUIDSIM_TYPE_FFT" + dim
+    if var_name in os.environ:
+        if params.oper.type_fft == "default":
+            type_fft = os.environ[var_name]
+            print(f"Using {var_name}={type_fft}")
+            return type_fft
+        elif params.oper.type_fft != "sequential":
+            warn(f"not using {var_name} since params.oper.type_fft != 'default'")
+        return params.oper.type_fft
     else:
         return params.oper.type_fft
 

fluidsim/operators/operators2d.py

@@ -140,7 +140,7 @@ def __init__(self, params):
             ny,
             params.oper.Lx,
             params.oper.Ly,
-            fft=_get_type_fft_from_params_and_env(params),
+            fft=_get_type_fft_from_params_and_env(params, "2D"),
             coef_dealiasing=params.oper.coef_dealiasing,
         )
 

fluidsim/operators/operators3d.py

@@ -226,7 +226,7 @@ def __init__(self, params=None):
             params.oper.Lx,
             params.oper.Ly,
             params.oper.Lz,
-            fft=_get_type_fft_from_params_and_env(params),
+            fft=_get_type_fft_from_params_and_env(params, "3D"),
             coef_dealiasing=params.oper.coef_dealiasing,
         )
 

fluidsim/operators/test/test_operators3d.py

@@ -14,13 +14,13 @@
 
 
 def xfail_if_fluidfft_class_not_importable(func):
-    if not FLUIDFFT_INSTALLED or "FLUIDSIM_TYPE_FFT" not in os.environ:
+    if not FLUIDFFT_INSTALLED or "FLUIDSIM_TYPE_FFT3D" not in os.environ:
         return func
 
     from fluidfft import import_fft_class
 
     try:
-        import_fft_class(os.environ["FLUIDSIM_TYPE_FFT"])
+        import_fft_class(os.environ["FLUIDSIM_TYPE_FFT3D"])
     except ImportError:
         ImportError_fft_class = True
     else:

noxfile.py

@@ -30,7 +30,7 @@ def test_mpi_fft_lib(session, method_fft, nprocs=2, _k_expr=None, env=None):
         env = {}
     else:
         env = env.copy()
-    env.update({"TRANSONIC_NO_REPLACE": "1", "FLUIDSIM_TYPE_FFT": method_fft})
+    env.update({"TRANSONIC_NO_REPLACE": "1", "FLUIDSIM_TYPE_FFT3D": method_fft})
 
     print(f"test for method {method_fft}")
     session.run(*cmd, external=True, env=env)