Rename ParticleFile._analytical to ._is_analytical

OceanParcels · Oct 22, 2024 · f03f80e · f03f80e
1 parent c8d5deb
commit f03f80e
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/parcels/kernel.py b/parcels/kernel.py
@@ -367,7 +367,7 @@ def check_fieldsets_in_kernels(self, pyfunc):
                     )
             elif pyfunc is AdvectionAnalytical:
                 if self.fieldset.particlefile is not None:
-                    self.fieldset.particlefile._analytical = True
+                    self.fieldset.particlefile._is_analytical = True
                 if self._ptype.uses_jit:
                     raise NotImplementedError("Analytical Advection only works in Scipy mode")
                 if self._fieldset.U.interp_method != "cgrid_velocity":

diff --git a/parcels/particlefile.py b/parcels/particlefile.py
@@ -64,7 +64,7 @@ def __init__(self, name, particleset, outputdt=np.inf, chunks=None, create_new_z
                 self.vars_to_write[var.name] = var.dtype
         self._mpi_rank = MPI.COMM_WORLD.Get_rank() if MPI else 0
         self.particleset.fieldset._particlefile = self
-        self._analytical = False  # Flag to indicate if ParticleFile is used for analytical trajectories
+        self._is_analytical = False  # Flag to indicate if ParticleFile is used for analytical trajectories
 
         # Reset obs_written of each particle, in case new ParticleFile created for a ParticleSet
         particleset.particledata.setallvardata("obs_written", 0)
@@ -172,7 +172,7 @@ def fill_value_map(self):
     @property
     @deprecated_made_private  # TODO: Remove 6 months after v3.1.0
     def analytical(self):
-        return self._analytical
+        return self._is_analytical
 
     def _create_variables_attribute_dict(self):
         """Creates the dictionary with variable attributes.

diff --git a/parcels/particleset.py b/parcels/particleset.py
@@ -1188,7 +1188,7 @@ def execute(
 
             if abs(time - next_output) < tol:
                 if output_file:
-                    if output_file._analytical:  # output analytical solution at later time
+                    if output_file._is_analytical:  # output analytical solution at later time
                         output_file.write_latest_locations(self, time)
                     else:
                         output_file.write(self, time_at_startofloop)

diff --git a/tests/test_deprecations.py b/tests/test_deprecations.py
@@ -256,7 +256,7 @@ def test_testing_action_class():
     Action("ParticleFile",     "pids_written",                   "make_private"  ),
     Action("ParticleFile",     "mpi_rank",                       "make_private"  ),
     Action("ParticleFile",     "fill_value_map",                 "make_private"  ),
-    Action("ParticleFile",     "analytical",                     "make_private"  ),
+    Action("ParticleFile",     "analytical",                     "make_private"  , skip_reason = "Was also renamed"),
     Action("Grid",             "lon_grid_to_target()",           "remove"        ),
     Action("Grid",             "lon_remapping",                  "remove"        ),
     Action("Grid",             "lon_grid_to_source()",           "remove"        ),