Merge pull request #2723 from devitocodes/tens-deriv-kw

api: fix derivatives kw for tensors

Author: mloubout

.github/workflows/asv.yml

@@ -13,10 +13,6 @@ on:
     inputs:
       tags:
         description: 'Run ASV'
-  # Trigger the workflow on push to the main branch
-  push:
-    branches:
-      - main
 
 jobs:
 

devito/finite_differences/finite_difference.py

@@ -1,5 +1,8 @@
+from collections.abc import Iterable
+
 from sympy import sympify
 
+from devito.logger import warning
 from .differentiable import EvalDerivative, DiffDerivative, Weights
 from .tools import (left, right, generate_indices, centered, direct, transpose,
                     check_input, fd_weights_registry, process_weights)
@@ -158,6 +161,12 @@ def make_derivative(expr, dim, fd_order, deriv_order, side, matvec, x0, coeffici
     # `coefficients` method (`taylor` or `symbolic`)
     if weights is None:
         weights = fd_weights_registry[coefficients](expr, deriv_order, indices, x0)
+    if isinstance(weights, Iterable) and len(weights) != len(indices):
+        warning(f"Number of weights ({len(weights)}) does not match "
+                f"number of indices ({len(indices)}), reverting to Taylor")
+        scale = False
+        weights = fd_weights_registry['taylor'](expr, deriv_order, indices, x0)
+
     # Did fd_weights_registry return a new Function/Expression instead of a values?
     _, wdim, _ = process_weights(weights, expr, dim)
     if wdim is not None:

devito/operations/interpolators.py

@@ -125,6 +125,8 @@ def __repr__(self):
         return (f"Interpolation({repr(self.expr)} into "
                 f"{repr(self.interpolator.sfunction)})")
 
+    __str__ = __repr__
+
 
 class Injection(UnevaluatedSparseOperation):
 
@@ -152,6 +154,8 @@ def operation(self, **kwargs):
     def __repr__(self):
         return f"Injection({repr(self.expr)} into {repr(self.field)})"
 
+    __str__ = __repr__
+
 
 class GenericInterpolator(ABC):
 

devito/types/basic.py

@@ -1574,6 +1574,16 @@ def adjoint(self, inner=True):
         # Real valued adjoint is transpose
         return self.transpose(inner=inner)
 
+    def __call__(self, **kwargs):
+        """
+        Derivative custom inputs (weights/x0/...) is done through call
+        and needs to be applied to each component through applyfunc
+        """
+        try:
+            return self.applyfunc(lambda x: x(**kwargs))
+        except TypeError as e:
+            raise f"{self.name} not callable with {kwargs}" from e
+
     @call_highest_priority('__radd__')
     def __add__(self, other):
         try:

requirements-optional.txt

@@ -3,4 +3,5 @@ pillow>11,<11.3.1
 pyrevolve==2.2.6
 scipy<1.15.4
 distributed<2025.7.1
-click<9.0
+click<9.0
+cloudpickle<3.1.2

requirements-testing.txt

@@ -6,3 +6,4 @@ nbval<0.11.1
 scipy<1.15.4
 pooch<1.8.3
 click<9.0
+cloudpickle<3.1.2

requirements.txt

@@ -7,5 +7,4 @@ cgen>=2020.1,<2026
 codepy>=2019.1,<2025
 multidict<6.3
 anytree>=2.4.3,<=2.13.0
-cloudpickle<3.1.2
 packaging<25.1

tests/test_derivatives.py

@@ -1229,3 +1229,24 @@ def test_expand_product_rule(self):
             + 10*self.f*Derivative(self.v, self.x)*Derivative(self.u, self.x) \
             + 5*self.f*self.u*Derivative(self.v, (self.x, 2))
         assert diffify(expr.expand(product_rule=True)) == expanded
+
+    def test_fallback_wrong_custom_size(self):
+        """
+        Check an exception is raised when a custom size is not compatible
+        with the derivative order
+        """
+        grid = Grid((10,))
+        x, = grid.dimensions
+        u = Function(name="u", grid=grid, space_order=2, staggered=x)
+        v = Function(name="v", grid=grid, space_order=2, staggered=NODE)
+
+        w = [-2, 2]  # Should 2 coeff since this is staggered
+
+        eq0 = Eq(u, v.dx(w=w)).evaluate
+        exp0 = -2 * v / x.spacing + 2 * v._subs(x, x + x.spacing)/x.spacing
+        # This one should fallback to taylor coeffs since w is too short
+        # for a centered derivative
+        eq1 = Eq(v, v.dx(w=w)).evaluate
+        exp1 = - .5 * (v._subs(x, x - x.spacing) - v._subs(x, x + x.spacing))/x.spacing
+        assert simplify(eq0.rhs - exp0) == 0
+        assert simplify(eq1.rhs - exp1) == 0

tests/test_tensors.py

@@ -442,6 +442,21 @@ def test_custom_coeffs_tensor():
             assert list(drv.weights) == c
 
 
+@pytest.mark.parametrize('func', [TensorFunction, TensorTimeFunction,
+                                  VectorFunction, VectorTimeFunction])
+def test_custom_coeffs_tensor_basic(func):
+    grid = Grid(tuple([5]*3))
+    f = func(name="t", grid=grid, space_order=2)
+
+    # Custom coefficients
+    c = [10, 20, 30]
+
+    df = f.dx(w=c)
+    for (fi, dfi) in zip(f.values(), df.values()):
+        assert dfi == fi.dx(w=c)
+        assert list(dfi.weights) == c
+
+
 @pytest.mark.parametrize('func1', [TensorFunction, TensorTimeFunction,
                                    VectorFunction, VectorTimeFunction])
 def test_rebuild(func1):