Merge branch 'topic/default/type_fft' into 'branch/default'

FLUIDSIM_TYPE_FFT

Closes #164

See merge request fluiddyn/fluidsim!415

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

fluidsim/operators/__init__.py

@@ -6,6 +6,7 @@
 .. autosummary::
    :toctree:
 
+   base
    operators0d
    operators2d
    operators3d

fluidsim/operators/base.py

@@ -5,17 +5,39 @@
 
 Provides:
 
-.. autoclass:: OperatorBase1D
+.. autoclass:: OperatorBase
+   :members:
+   :private-members:
+
+.. autoclass:: OperatorsBase1D
    :members:
    :private-members:
 
 """
 
+import os
+
+from warnings import warn
+
 import numpy as np
 
 from fluiddyn.util import mpi
 
 
+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
+
+
 class OperatorBase:
     def _modify_sim_repr_maker(self, sim_repr_maker):
         if not hasattr(self, "produce_str_describing_oper"):

fluidsim/operators/operators2d.py

@@ -9,9 +9,10 @@
 
 """
 
+import sys
+
 from warnings import warn
 from random import uniform
-import sys
 
 import numpy as np
 
@@ -22,7 +23,7 @@
 from fluidsim.base.params import Parameters
 from ..base.setofvariables import SetOfVariables
 from .. import _is_testing
-from .base import OperatorBase
+from .base import OperatorBase, _get_type_fft_from_params_and_env
 
 ts = Transonic()
 
@@ -139,7 +140,7 @@ def __init__(self, params):
             ny,
             params.oper.Lx,
             params.oper.Ly,
-            fft=params.oper.type_fft,
+            fft=_get_type_fft_from_params_and_env(params, "2D"),
             coef_dealiasing=params.oper.coef_dealiasing,
         )
 

fluidsim/operators/operators3d.py

@@ -25,7 +25,7 @@
 
 from .operators2d import OperatorsPseudoSpectral2D as OpPseudoSpectral2D
 from .. import _is_testing
-from .base import OperatorBase
+from .base import OperatorBase, _get_type_fft_from_params_and_env
 
 ts = Transonic()
 
@@ -226,7 +226,7 @@ def __init__(self, params=None):
             params.oper.Lx,
             params.oper.Ly,
             params.oper.Lz,
-            fft=params.oper.type_fft,
+            fft=_get_type_fft_from_params_and_env(params, "3D"),
             coef_dealiasing=params.oper.coef_dealiasing,
         )
 

fluidsim/operators/test/test_operators2d.py

@@ -32,13 +32,6 @@ def create_oper(type_fft=None, coef_dealiasing=2.0 / 3, **kwargs):
     params.oper.Lx = Lh
     params.oper.Ly = Lh
 
-    if "FLUIDSIM_TYPE_FFT" in os.environ:
-        type_fft = os.environ["FLUIDSIM_TYPE_FFT"]
-        print(f"{type_fft = }")
-
-    if type_fft is not None:
-        params.oper.type_fft = type_fft
-
     params.oper.coef_dealiasing = coef_dealiasing
 
     oper = OperatorsPseudoSpectral2D(params=params)
@@ -173,10 +166,6 @@ def test_coarse(self, allclose):
 
         params.oper.truncation_shape = "spherical"
 
-        if "FLUIDSIM_TYPE_FFT" in os.environ:
-            params.oper.type_fft = os.environ["FLUIDSIM_TYPE_FFT"]
-            print(f"{params.oper.type_fft = }")
-
         oper = self.Oper(params)
 
         params_coarse = deepcopy(params)

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:
@@ -41,10 +41,6 @@ def oper():
     p.oper.nz = 4
     p.oper.Lx = p.oper.Ly = p.oper.Lz = 2 * np.pi
 
-    if "FLUIDSIM_TYPE_FFT" in os.environ:
-        p.oper.type_fft = os.environ["FLUIDSIM_TYPE_FFT"]
-    print(f"{p.oper.type_fft = }")
-
     return OperatorsPseudoSpectral3D(params=p)
 
 

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)