Adding Function for compatibility

Author: mikaem

examples/darray.py

@@ -1,7 +1,7 @@
 import numpy as np
 from mpi4py import MPI
 from mpi4py_fft.pencil import Subcomm
-from mpi4py_fft.distributedarray import DistributedArray, getDarray
+from mpi4py_fft.distributedarray import DistributedArray, getDarray, Function
 from mpi4py_fft.mpifft import PFFT
 
 # Test DistributedArray. Start with alignment in axis 0, then tranfer to 1 and
@@ -26,7 +26,8 @@
 
 print(z3.local_slice(), z3.substart, z3.commsizes)
 
-v0 = getDarray(fft, forward_output=False, rank=1)
+#v0 = getDarray(fft, forward_output=False, rank=1)
+v0 = Function(fft, forward_output=False, rank=1)
 v0[:] = np.random.random(v0.shape)
 v0c = v0.copy()
 v1 = getDarray(fft, forward_output=True, rank=1)

mpi4py_fft/distributedarray.py

@@ -40,7 +40,7 @@ class DistributedArray(np.ndarray):
 
     """
     def __new__(cls, global_shape, subcomm=None, val=None, dtype=np.float,
-                buffer=None, alignment=None, rank=0):
+                buffer=None, alignment=None, rank=0, **kw):
 
         if isinstance(subcomm, Subcomm):
             pass
@@ -248,3 +248,11 @@ def getDarray(pfft, forward_output=True, val=0, rank=0):
 
     return DistributedArray(global_shape, subcomm=p0.subcomm, val=val,
                             dtype=dtype, rank=rank)
+
+def Function(*args, **kwargs):
+    import warnings
+    warnings.warn("Function() is deprecated; use getDarray().", FutureWarning)
+    if 'tensor' in kwargs:
+        kwargs['rank'] = 1
+        del kwargs['tensor']
+    return getDarray(*args, **kwargs)

mpi4py_fft/utilities/h5py_file.py

@@ -75,11 +75,11 @@ def write(self, step, fields, **kw):
         Example
         -------
         >>> from mpi4py import MPI
-        >>> from mpi4py_fft import PFFT, HDF5File, Function
+        >>> from mpi4py_fft import PFFT, HDF5File, getDarray
         >>> comm = MPI.COMM_WORLD
         >>> T = PFFT(comm, (15, 16, 17))
-        >>> u = Function(T, forward_output=False, val=1)
-        >>> v = Function(T, forward_output=False, val=2)
+        >>> u = getDarray(T, forward_output=False, val=1)
+        >>> v = getDarray(T, forward_output=False, val=2)
         >>> f = HDF5File('h5filename.h5', T)
         >>> f.write(0, {'u': [u, (u, [slice(None), 4, slice(None)])],
         ...             'v': [v, (v, [slice(None), 5, 5])]})