Removing applyConversion option from field.eval

Keeping it only for VectorField.eval()

Author: erikvansebille

docs/user_guide/v4-migration.md

@@ -39,6 +39,7 @@ Version 4 of Parcels is unreleased at the moment. The information in this migrat
 
 - `Field.eval()` returns an array of floats instead of a single float (related to the vectorization)
 - `Field.eval()` does not throw OutOfBounds or other errors
+- `applyConversion` has been renamed to `apply_conversion` and only works for VectorFields. Conversion of units should be handled in Kernels.
 
 ## GridSet
 

src/parcels/_core/field.py

@@ -177,7 +177,7 @@ def _check_velocitysampling(self):
                 stacklevel=2,
             )
 
-    def eval(self, time: datetime, z, y, x, particles=None, applyConversion=True):
+    def eval(self, time: datetime, z, y, x, particles=None):
         """Interpolate field values in space and time.
 
         We interpolate linearly in time and apply implicit unit

tests/test_field.py

@@ -201,31 +201,31 @@ def test_field_unstructured_z_linear():
 
     # Test above first cell center - for piecewise constant, should return the depth of the first cell center
     assert np.isclose(
-        P.eval(time=[0], z=[10.0], y=[30.0], x=[30.0], applyConversion=False),
+        P.eval(time=[0], z=[10.0], y=[30.0], x=[30.0]),
         55.555557,
     )
     # Test below first cell center, but in the first layer  - for piecewise constant, should return the depth of the first cell center
     assert np.isclose(
-        P.eval(time=[0], z=[65.0], y=[30.0], x=[30.0], applyConversion=False),
+        P.eval(time=[0], z=[65.0], y=[30.0], x=[30.0]),
         55.555557,
     )
     # Test bottom layer  - for piecewise constant, should return the depth of the of the bottom layer cell center
     assert np.isclose(
-        P.eval(time=[0], z=[900.0], y=[30.0], x=[30.0], applyConversion=False),
+        P.eval(time=[0], z=[900.0], y=[30.0], x=[30.0]),
         944.44445801,
     )
 
     W = Field(name="W", data=ds.W, grid=grid, interp_method=UxPiecewiseLinearNode)
     assert np.isclose(
-        W.eval(time=[0], z=[10.0], y=[30.0], x=[30.0], applyConversion=False),
+        W.eval(time=[0], z=[10.0], y=[30.0], x=[30.0]),
         10.0,
     )
     assert np.isclose(
-        W.eval(time=[0], z=[65.0], y=[30.0], x=[30.0], applyConversion=False),
+        W.eval(time=[0], z=[65.0], y=[30.0], x=[30.0]),
         65.0,
     )
     assert np.isclose(
-        W.eval(time=[0], z=[900.0], y=[30.0], x=[30.0], applyConversion=False),
+        W.eval(time=[0], z=[900.0], y=[30.0], x=[30.0]),
         900.0,
     )
 
@@ -239,13 +239,12 @@ def test_field_constant_in_time():
 
     # Assert that the field can be evaluated at any time, and returns the same value
     time = np.datetime64("2000-01-01T00:00:00")
-    P1 = P.eval(time=time, z=[10.0], y=[30.0], x=[30.0], applyConversion=False)
+    P1 = P.eval(time=time, z=[10.0], y=[30.0], x=[30.0])
     P2 = P.eval(
         time=time + np.timedelta64(1, "D"),
         z=[10.0],
         y=[30.0],
         x=[30.0],
-        applyConversion=False,
     )
     assert np.isclose(P1, P2)
 

tests/test_interpolation.py

@@ -176,7 +176,7 @@ def test_interpolation_mesh_type(mesh, npart=10):
     time = 0.0
     u_expected = 1.0 if mesh == "flat" else 1.0 / (1852 * 60 * np.cos(np.radians(lat)))
 
-    assert fieldset.U.eval(time, 0, lat, 0, applyConversion=False) == 1.0
+    assert fieldset.U.eval(time, 0, lat, 0) == 1.0
     assert fieldset.V[time, 0, lat, 0] == 0.0
 
     u, v = fieldset.UV[time, 0, lat, 0]

tests/test_uxarray_fieldset.py

@@ -122,26 +122,29 @@ def test_fesom2_square_delaunay_uniform_z_coordinate_eval():
     P = Field(name="p", data=ds.p, grid=grid, interp_method=UxPiecewiseLinearNode)
     fieldset = FieldSet([UVW, P, UVW.U, UVW.V, UVW.W])
 
+    (u, v, w) = fieldset.UVW.eval(time=[0.0], z=[1.0], y=[30.0], x=[30.0], applyConversion=False)
+    assert np.allclose([u.item(), v.item(), w.item()], [1.0, 1.0, 0.0], rtol=1e-3, atol=1e-6)
+
     assert np.isclose(
-        fieldset.U.eval(time=[0.0], z=[1.0], y=[30.0], x=[30.0], applyConversion=False),
+        fieldset.U.eval(time=[0.0], z=[1.0], y=[30.0], x=[30.0]),
         1.0,
         rtol=1e-3,
         atol=1e-6,
     )
     assert np.isclose(
-        fieldset.V.eval(time=[0.0], z=[1.0], y=[30.0], x=[30.0], applyConversion=False),
+        fieldset.V.eval(time=[0.0], z=[1.0], y=[30.0], x=[30.0]),
         1.0,
         rtol=1e-3,
         atol=1e-6,
     )
     assert np.isclose(
-        fieldset.W.eval(time=[0.0], z=[1.0], y=[30.0], x=[30.0], applyConversion=False),
+        fieldset.W.eval(time=[0.0], z=[1.0], y=[30.0], x=[30.0]),
         0.0,
         rtol=1e-3,
         atol=1e-6,
     )
     assert np.isclose(
-        fieldset.p.eval(time=[0.0], z=[1.0], y=[30.0], x=[30.0], applyConversion=False),
+        fieldset.p.eval(time=[0.0], z=[1.0], y=[30.0], x=[30.0]),
         1.0,
         rtol=1e-3,
         atol=1e-6,
@@ -163,7 +166,7 @@ def test_fesom2_square_delaunay_antimeridian_eval():
     )
     fieldset = FieldSet([P])
 
-    assert np.isclose(fieldset.p.eval(time=[0], z=[1.0], y=[30.0], x=[-170.0], applyConversion=False), 1.0)
-    assert np.isclose(fieldset.p.eval(time=[0], z=[1.0], y=[30.0], x=[-180.0], applyConversion=False), 1.0)
-    assert np.isclose(fieldset.p.eval(time=[0], z=[1.0], y=[30.0], x=[180.0], applyConversion=False), 1.0)
-    assert np.isclose(fieldset.p.eval(time=[0], z=[1.0], y=[30.0], x=[170.0], applyConversion=False), 1.0)
+    assert np.isclose(fieldset.p.eval(time=[0], z=[1.0], y=[30.0], x=[-170.0]), 1.0)
+    assert np.isclose(fieldset.p.eval(time=[0], z=[1.0], y=[30.0], x=[-180.0]), 1.0)
+    assert np.isclose(fieldset.p.eval(time=[0], z=[1.0], y=[30.0], x=[180.0]), 1.0)
+    assert np.isclose(fieldset.p.eval(time=[0], z=[1.0], y=[30.0], x=[170.0]), 1.0)