[#2034] Remove repeatdt references

Author: fluidnumericsJoe

parcels/particleset.py

@@ -14,7 +14,7 @@
 from parcels.grid import GridType
 from parcels.interaction.interactionkernel import InteractionKernel
 from parcels.kernel import Kernel
-from parcels.particle import Particle, Variable
+from parcels.particle import Particle
 from parcels.particledata import ParticleData, ParticleDataIterator
 from parcels.particlefile import ParticleFile
 from parcels.tools.converters import _get_cftime_calendars, convert_to_flat_array
@@ -54,8 +54,6 @@ class ParticleSet:
         Optional list of initial depth values for particles. Default is 0m
     time :
         Optional list of initial time values for particles. Default is fieldset.U.grid.time[0]
-    repeatdt : datetime.timedelta or float, optional
-        Optional interval on which to repeat the release of the ParticleSet. Either timedelta object, or float in seconds.
     lonlatdepth_dtype :
         Floating precision for lon, lat, depth particle coordinates.
         It is either np.float32 or np.float64. Default is np.float32 if fieldset.U.interp_method is 'linear'
@@ -84,49 +82,12 @@ def __init__(
         **kwargs,
     ):
         self.particledata = None
-        self._repeat_starttime = None
-        self._repeatlon = None
-        self._repeatlat = None
-        self._repeatdepth = None
-        self._repeatpclass = None
-        self._repeatkwargs = None
         self._kernel = None
         self._interaction_kernel = None
 
         self.fieldset = fieldset
         self._pclass = pclass
 
-        # ==== first: create a new subclass of the pclass that includes the required variables ==== #
-        # ==== see dynamic-instantiation trick here: https://www.python-course.eu/python3_classes_and_type.php ==== #
-        class_name = pclass.__name__
-        array_class = None
-        if class_name not in dir():
-
-            def ArrayClass_init(self, *args, **kwargs):
-                fieldset = kwargs.get("fieldset", None)
-                ngrids = kwargs.get("ngrids", None)
-                if type(self).ngrids.initial < 0:
-                    numgrids = ngrids
-                    if numgrids is None and fieldset is not None:
-                        numgrids = fieldset.gridset_size
-                    assert numgrids is not None, "Neither fieldsets nor number of grids are specified - exiting."
-                    type(self).ngrids.initial = numgrids
-                self.ngrids = type(self).ngrids.initial
-                if self.ngrids >= 0:
-                    self.ei = np.zeros(self.ngrids, dtype=np.int32)
-                super(type(self), self).__init__(*args, **kwargs)
-
-            array_class_vdict = {
-                "ngrids": Variable("ngrids", dtype=np.int32, to_write=False, initial=-1),
-                "ei": Variable("ei", dtype=np.int32, to_write=False),
-                "__init__": ArrayClass_init,
-            }
-            array_class = type(class_name, (pclass,), array_class_vdict)
-        else:
-            array_class = locals()[class_name]
-        # ==== dynamic re-classing completed ==== #
-        _pclass = array_class
-
         lon = np.empty(shape=0) if lon is None else convert_to_flat_array(lon)
         lat = np.empty(shape=0) if lat is None else convert_to_flat_array(lat)
 
@@ -171,7 +132,7 @@ def ArrayClass_init(self, *args, **kwargs):
                 ), f"{kwvar} and positions (lon, lat, depth) don't have the same lengths."
 
         self.particledata = ParticleData(
-            _pclass,
+            self._pclass,
             lon=lon,
             lat=lat,
             depth=depth,
@@ -356,9 +317,7 @@ def populate_indices(self):
             self.particledata.data["ei"][:, i] = idx  # assumes that we are in the surface layer (zi=0)
 
     @classmethod
-    def from_list(
-        cls, fieldset, pclass, lon, lat, depth=None, time=None, repeatdt=None, lonlatdepth_dtype=None, **kwargs
-    ):
+    def from_list(cls, fieldset, pclass, lon, lat, depth=None, time=None, lonlatdepth_dtype=None, **kwargs):
         """Initialise the ParticleSet from lists of lon and lat.
 
         Parameters
@@ -375,8 +334,6 @@ def from_list(
             Optional list of initial depth values for particles. Default is 0m
         time :
             Optional list of start time values for particles. Default is fieldset.U.time[0]
-        repeatdt :
-            Optional interval (in seconds) on which to repeat the release of the ParticleSet (Default value = None)
         lonlatdepth_dtype :
             Floating precision for lon, lat, depth particle coordinates.
             It is either np.float32 or np.float64. Default is np.float32 if fieldset.U.interp_method is 'linear'
@@ -392,7 +349,6 @@ def from_list(
             lat=lat,
             depth=depth,
             time=time,
-            repeatdt=repeatdt,
             lonlatdepth_dtype=lonlatdepth_dtype,
             **kwargs,
         )
@@ -407,7 +363,6 @@ def from_line(
         size,
         depth=None,
         time=None,
-        repeatdt=None,
         lonlatdepth_dtype=None,
         **kwargs,
     ):
@@ -433,8 +388,6 @@ def from_line(
             Optional list of initial depth values for particles. Default is 0m
         time :
             Optional start time value for particles. Default is fieldset.U.time[0]
-        repeatdt :
-            Optional interval (in seconds) on which to repeat the release of the ParticleSet (Default value = None)
         lonlatdepth_dtype :
             Floating precision for lon, lat, depth particle coordinates.
             It is either np.float32 or np.float64. Default is np.float32 if fieldset.U.interp_method is 'linear'
@@ -451,7 +404,6 @@ def from_line(
             lat=lat,
             depth=depth,
             time=time,
-            repeatdt=repeatdt,
             lonlatdepth_dtype=lonlatdepth_dtype,
             **kwargs,
         )
@@ -528,7 +480,6 @@ def from_field(
         mode="monte_carlo",
         depth=None,
         time=None,
-        repeatdt=None,
         lonlatdepth_dtype=None,
     ):
         """Initialise the ParticleSet randomly drawn according to distribution from a field.
@@ -549,8 +500,6 @@ def from_field(
             Optional list of initial depth values for particles. Default is 0m
         time :
             Optional start time value for particles. Default is fieldset.U.time[0]
-        repeatdt :
-            Optional interval (in seconds) on which to repeat the release of the ParticleSet (Default value = None)
         lonlatdepth_dtype :
             Floating precision for lon, lat, depth particle coordinates.
             It is either np.float32 or np.float64. Default is np.float32 if fieldset.U.interp_method is 'linear'
@@ -566,12 +515,11 @@ def from_field(
             depth=depth,
             time=time,
             lonlatdepth_dtype=lonlatdepth_dtype,
-            repeatdt=repeatdt,
         )
 
     @classmethod
     def from_particlefile(
-        cls, fieldset, pclass, filename, restart=True, restarttime=None, repeatdt=None, lonlatdepth_dtype=None, **kwargs
+        cls, fieldset, pclass, filename, restart=True, restarttime=None, lonlatdepth_dtype=None, **kwargs
     ):
         """Initialise the ParticleSet from a zarr ParticleFile.
         This creates a new ParticleSet based on locations of all particles written
@@ -592,24 +540,13 @@ def from_particlefile(
             time at which the Particles will be restarted. Default is the last time written.
             Alternatively, restarttime could be a time value (including np.datetime64) or
             a callable function such as np.nanmin. The last is useful when running with dt < 0.
-        repeatdt : datetime.timedelta or float, optional
-            Optional interval on which to repeat the release of the ParticleSet. Either timedelta object, or float in seconds.
         lonlatdepth_dtype :
             Floating precision for lon, lat, depth particle coordinates.
             It is either np.float32 or np.float64. Default is np.float32 if fieldset.U.interp_method is 'linear'
             and np.float64 if the interpolation method is 'cgrid_velocity'
         **kwargs :
             Keyword arguments passed to the particleset constructor.
         """
-        if repeatdt is not None:
-            warnings.warn(
-                f"Note that the `repeatdt` argument is not retained from {filename}, and that "
-                "setting a new repeatdt will start particles from the _new_ particle "
-                "locations.",
-                ParticleSetWarning,
-                stacklevel=2,
-            )
-
         pfile = xr.open_zarr(str(filename))
         pfile_vars = [v for v in pfile.data_vars]
 
@@ -675,7 +612,6 @@ def from_particlefile(
             time=vars["time"],
             pid_orig=vars["id"],
             lonlatdepth_dtype=lonlatdepth_dtype,
-            repeatdt=repeatdt,
             **kwargs,
         )