Add a signature to ZeroBaseForm

Author: pbrubeck

test/test_duals.py

@@ -188,6 +188,22 @@ def test_zero_base_form_list_arguments():
     assert hash(f) == hash(ZeroBaseForm((v,)))
 
 
+def test_zero_base_form_signature():
+    domain_2d = Mesh(LagrangeElement(triangle, 1, (2,)))
+    f_2d = LagrangeElement(triangle, 1)
+    V = FunctionSpace(domain_2d, f_2d)
+
+    v = TestFunction(V)
+    f = ZeroBaseForm((v,))
+
+    assert f.signature() == ZeroBaseForm((v,)).signature()
+    assert isinstance(f.signature(), str)
+
+    W = FunctionSpace(domain_2d, LagrangeElement(triangle, 2))
+    w = TestFunction(W)
+    assert f.signature() != ZeroBaseForm((w,)).signature()
+
+
 def test_zero_base_form_reconstruct():
     # ZeroBaseForm._ufl_expr_reconstruct_ inherited BaseForm's default,
     # `type(self)(*operands)`, which unpacks `ufl_operands` into positional

ufl/form.py

@@ -11,6 +11,7 @@
 # Modified by Nacime Bouziani, 2020.
 # Modified by Jørgen S. Dokken 2023.
 
+import hashlib
 import numbers
 import typing
 import warnings
@@ -884,6 +885,7 @@ class ZeroBaseForm(BaseForm):
         "_coefficients",
         "_domains",
         "_hash",
+        "_signature",
         # Pyadjoint compatibility
         "form",
         "ufl_operands",
@@ -896,6 +898,7 @@ def __init__(self, arguments):
         self._arguments = arguments
         self.ufl_operands = arguments
         self._hash = None
+        self._signature = None
         self._domains = None
         self.form = None
 
@@ -927,6 +930,19 @@ def empty(self):
         """Returns whether the ZeroBaseForm has no components, which is always true."""
         return True
 
+    def signature(self):
+        """Return a signature for use with JIT caches."""
+        if self._signature is None:
+            renumbering = {
+                domain: i for i, domain in enumerate(self.ufl_domains())
+            }
+            data = tuple(
+                argument._ufl_signature_data_(renumbering)
+                for argument in self.arguments()
+            )
+            self._signature = hashlib.sha512(str(data).encode("utf-8")).hexdigest()
+        return self._signature
+
     def __ne__(self, other):
         """Overwrite BaseForm.__neq__ which relies on `equals`."""
         return not self == other