Merge pull request #4628 from firedrakeproject/connorjward/merge-release

Author: connorjward

.github/workflows/core.yml

@@ -15,6 +15,10 @@ on:
         description: Whether to run the test suite
         type: boolean
         default: true
+      build_docs:
+        description: Whether to build the documentation
+        type: boolean
+        default: true
       test_macos:
         description: Whether to test using macOS
         type: boolean
@@ -42,6 +46,10 @@ on:
         description: Whether to run the test suite
         type: boolean
         default: true
+      build_docs:
+        description: Whether to build the documentation
+        type: boolean
+        default: true
       test_macos:
         description: Whether to test using macOS
         type: boolean
@@ -195,7 +203,7 @@ jobs:
 
           : # Install from an sdist so we can make sure that it is not ill-formed
           pip install build
-          python -m build ./firedrake-repo --sdist "$EXTRA_BUILD_ARGS"
+          python -m build ./firedrake-repo --sdist $EXTRA_BUILD_ARGS
 
           pip install --verbose $EXTRA_PIP_FLAGS \
             --no-binary h5py \
@@ -476,6 +484,7 @@ jobs:
         run: make lint GITHUB_ACTIONS_FORMATTING=1
 
   build_docs:
+    if: inputs.build_docs
     name: Build documentation
     runs-on: [self-hosted, Linux]
     container:

.github/workflows/release.yml

@@ -47,6 +47,7 @@ jobs:
       source_ref: ${{ inputs.branch }}
       target_branch: release
       run_tests: false
+      build_docs: false
       upload_pypi: true
     secrets: inherit
 
@@ -57,10 +58,11 @@ jobs:
     permissions:
       contents: write
     steps:
+      - uses: actions/checkout@v5
       - name: Create release
         env:
           GH_TOKEN: ${{ github.token }}
-        run: gh release create ${{ inputs.version }} --title ${{ inputs.version }} --generate-notes
+        run: gh release create --title ${{ inputs.version }} --target ${{ inputs.branch }} --generate-notes ${{ inputs.version }}
 
   docker:
     name: Build Docker containers

demos/full_waveform_inversion/full_waveform_inversion.py.rst

@@ -83,7 +83,7 @@ for 3 wave sources. Therefore, we will have 3 emsemble members, each with 2 rank
 processes launched by mpiexec must therefore be equal to the product of number of ensemble members
 (3, in this case) with the number of processes to be used for each ensemble member (``M=2``, in this case).
 Additional details about the ensemble parallelism can be found in the
-`Firedrake documentation <https://www.firedrakeproject.org/parallelism.html#ensemble-parallelism>`_.
+`Firedrake documentation <https://www.firedrakeproject.org/ensemble_parallelism.html>`_.
 
 The subcommunicators in each ensemble member are: ``Ensemble.comm`` and ``Ensemble.ensemble_comm``.
 ``Ensemble.comm`` is the spatial communicator. ``Ensemble.ensemble_comm`` allows communication between

docs/source/conf.py

@@ -172,6 +172,8 @@
     r'https://www.hilton.com/en/hotels/leehnhn-hilton-leeds-city/',
     r'https://www.radissonhotels.com/en-us/hotels/park-plaza-leeds',
     r'https://www.radissonhotels.com/en-us/hotels/radisson-blu-leeds'
+    r'https://www.radissonhotels.com/en-us/hotels/radisson-blu-leeds',
+    r'https://all.accor.com/hotel/*',
 ]
 linkcheck_timeout = 30
 

docs/source/install.rst

@@ -60,9 +60,19 @@ firedrake-configure
 -------------------
 
 To simplify the installation process, Firedrake provides a utility script called
-``firedrake-configure``. This script can be downloaded by executing::
+``firedrake-configure``. This script can be downloaded by executing:
 
-  $ curl -O https://raw.githubusercontent.com/firedrakeproject/firedrake/main/scripts/firedrake-configure
+.. only:: release
+
+   .. code-block:: text
+
+      $ curl -O https://raw.githubusercontent.com/firedrakeproject/firedrake/release/scripts/firedrake-configure
+
+.. only:: main
+
+   .. code-block:: text
+
+      $ curl -O https://raw.githubusercontent.com/firedrakeproject/firedrake/main/scripts/firedrake-configure
 
 Note that ``firedrake-configure`` **does not install Firedrake for you**. It
 is simply a helper script that emits the configuration options that Firedrake

firedrake/adjoint/ensemble_reduced_functional.py

@@ -85,7 +85,7 @@ class EnsembleReducedFunctional(AbstractReducedFunctional):
     The functionals :math:`J_i` and the control must be defined over a common
     `ensemble.comm` communicator. To understand more about how ensemble parallelism
     works, please refer to the `Firedrake manual
-    <https://www.firedrakeproject.org/parallelism.html#ensemble-parallelism>`_.
+    <https://www.firedrakeproject.org/ensemble_parallelism.html>`_.
     """
     def __init__(self, functional, control, ensemble, scatter_control=True,
                  gather_functional=None,

firedrake/adjoint_utils/variational_solver.py

@@ -27,7 +27,7 @@ def wrapper(self, *args, **kwargs):
                     # Try again without expanding derivatives,
                     # as dFdu might have been simplied to an empty Form
                     self._ad_adj_F = adjoint(dFdu, derivatives_expanded=True)
-            except (TypeError, NotImplementedError):
+            except (ValueError, TypeError, NotImplementedError):
                 self._ad_adj_F = None
             self._ad_kwargs = {'Jp': self.Jp, 'form_compiler_parameters': self.form_compiler_parameters, 'is_linear': self.is_linear}
             self._ad_count_map = {}

firedrake/assemble.py

@@ -60,17 +60,23 @@ def assemble(expr, *args, **kwargs):
         `ufl.classes.Measure` in the form. For example, if a
         ``quadrature_degree`` of 4 is specified in this argument, but a degree of
         3 is requested in the measure, the latter will be used.
-    mat_type : str
+    mat_type : str | None
         String indicating how a 2-form (matrix) should be
         assembled -- either as a monolithic matrix (``"aij"`` or ``"baij"``),
-        a block matrix (``"nest"``), or left as a `matrix.ImplicitMatrix` giving
+        a block matrix (``"nest"``), or left as a :class:`firedrake.matrix.ImplicitMatrix` giving
         matrix-free actions (``'matfree'``). If not supplied, the default value in
-        ``parameters["default_matrix_type"]`` is used.  BAIJ differs
-        from AIJ in that only the block sparsity rather than the dof
+        ``parameters["default_matrix_type"]`` is used.  ``"baij"``` differs
+        from ``"aij"`` in that only the block sparsity rather than the DoF
         sparsity is constructed.  This can result in some memory
         savings, but does not work with all PETSc preconditioners.
-        BAIJ matrices only make sense for non-mixed matrices.
-    sub_mat_type : str
+        ``"baij"`` matrices only make sense for non-mixed matrices with arguments
+        on a :func:`firedrake.functionspace.VectorFunctionSpace`.
+
+        NOTE
+        ----
+        For the assembly of a 0-form or 1-form arising from the action of a 2-form,
+        the default matrix type is ``"matfree"``.
+    sub_mat_type : str | None
         String indicating the matrix type to
         use *inside* a nested block matrix.  Only makes sense if
         ``mat_type`` is ``nest``.  May be one of ``"aij"`` or ``"baij"``.  If
@@ -154,7 +160,10 @@ def get_assembler(form, *args, **kwargs):
     is_base_form_preprocessed = kwargs.pop('is_base_form_preprocessed', False)
     fc_params = kwargs.get('form_compiler_parameters', None)
     if isinstance(form, ufl.form.BaseForm) and not is_base_form_preprocessed:
-        mat_type = kwargs.get('mat_type', None)
+        # If not assembling a matrix, internal BaseForm nodes are matfree by default
+        # Otherwise, the default matrix type is firedrake.parameters["default_matrix_type"]
+        default_mat_type = "matfree" if len(form.arguments()) < 2 else None
+        mat_type = kwargs.get('mat_type', default_mat_type)
         # Preprocess the DAG and restructure the DAG
         # Only pre-process `form` once beforehand to avoid pre-processing for each assembly call
         form = BaseFormAssembler.preprocess_base_form(form, mat_type=mat_type, form_compiler_parameters=fc_params)

firedrake/variational_solver.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import ufl
 from itertools import chain
 from contextlib import ExitStack
@@ -131,14 +133,38 @@ def dm(self):
         return self.u_restrict.function_space().dm
 
     @staticmethod
-    def compute_bc_lifting(J, u):
-        """Return the action of the bilinear form J (without bcs) on a Function u."""
+    def compute_bc_lifting(J: ufl.BaseForm | slate.TensorBase,
+                           u: Function,
+                           L: ufl.BaseForm | slate.TensorBase | 0 = 0):
+        """Compute the residual after lifting DirichletBCs.
+
+        Parameters
+        ----------
+        J
+            The Jacobian bilinear form.
+        u
+            The Function on which DirichletBCs are applied.
+        L
+            The unlifted residual linear form.
+
+        Return
+        ------
+        F : ufl.BaseForm | slate.TensorBase
+            The residual J*u-L after lifting DirichletBCs.
+        """
         if isinstance(J, MatrixBase) and J.has_bcs:
             # Extract the full form without bcs
             if not isinstance(J.a, (ufl.BaseForm, slate.slate.TensorBase)):
                 raise TypeError(f"Could not remove bcs from {type(J).__name__}.")
             J = J.a
-        return ufl_expr.action(J, u)
+        F = ufl_expr.action(J, u)
+        if isinstance(F, slate.slate.TensorBase) and not isinstance(L, (ufl.Form, slate.slate.TensorBase)):
+            # Slate expressions should not combine with assembled Cofunctions
+            # because assemble(AssembledVector(L)) repeats element summation on L
+            F = ufl.FormSum((F, 1), (L, -1))
+        elif L != 0:
+            F = F - L
+        return F
 
 
 class NonlinearVariationalSolver(OptionsManager, NonlinearVariationalSolverMixin):
@@ -403,14 +429,12 @@ def __init__(self, a, L, u, bcs=None, aP=None,
         """
         # In the linear case, the Jacobian is the equation LHS (J=a).
         # Jacobian is checked in superclass, but let's check L here.
-        if not isinstance(L, (ufl.BaseForm, slate.slate.TensorBase)) and L == 0:
-            F = self.compute_bc_lifting(a, u)
-        else:
-            if not isinstance(L, (ufl.BaseForm, slate.slate.TensorBase)):
-                raise TypeError("Provided RHS is a '%s', not a Form or Slate Tensor" % type(L).__name__)
+        if isinstance(L, (ufl.BaseForm, slate.slate.TensorBase)):
             if len(L.arguments()) != 1 and not L.empty():
                 raise ValueError("Provided RHS is not a linear form")
-            F = self.compute_bc_lifting(a, u) - L
+        elif L != 0:
+            raise TypeError(f"Provided RHS is a '{type(L).__name__}', not a Form or Slate Tensor")
+        F = self.compute_bc_lifting(a, u, L=L)
 
         super(LinearVariationalProblem, self).__init__(F, u, bcs=bcs, J=a, Jp=aP,
                                                        form_compiler_parameters=form_compiler_parameters,

pyproject.toml

@@ -2,7 +2,7 @@
 name = "firedrake"
 # <year>.<month>.<patch>
 # TODO RELEASE
-version = "2025.11.0.dev0"
+version = "2025.10.2.dev0"
 description = "An automated system for the portable solution of partial differential equations using the finite element method"
 readme = "README.rst"
 license = "LGPL-3.0-or-later"
@@ -20,22 +20,21 @@ dependencies = [
   "decorator<=4.4.2",
   "mpi4py>3; python_version >= '3.13'",
   "mpi4py; python_version < '3.13'",
-  # TODO RELEASE: use releases
-  "fenics-ufl @ git+https://github.com/FEniCS/ufl.git@main",
-  "firedrake-fiat @ git+https://github.com/firedrakeproject/fiat.git",
+  # TODO RELEASE
+  "fenics-ufl @ git+https://github.com/FEniCS/ufl.git@release",
+  # TODO RELEASE
+  "firedrake-fiat @ git+https://github.com/firedrakeproject/fiat.git@release",
   "h5py>3.12.1",
+  "immutabledict",
   "libsupermesh",
   "loopy>2024.1",
   "numpy",
   "packaging",
-  # TODO RELEASE
-  # "petsc4py==3.23.4",
-  # TODO RELEASE
-  # "petsctools",
+  "petsc4py==3.24.0",
+  "petsctools",
   "pkgconfig",
   "progress",
-  # TODO RELEASE: use a release
-  "pyadjoint-ad @ git+https://github.com/dolfin-adjoint/pyadjoint",
+  "pyadjoint-ad>=2025.10.0",
   "pycparser",
   "pytools[siphash]",
   "requests",
@@ -91,12 +90,10 @@ jax = [
   "jax",
 ]
 netgen = [
-  # TODO RELEASE
-  # "ngsPETSc",
+  "ngsPETSc>=0.1.1",
 ]
 slepc = [
-  # TODO RELEASE
-  # "slepc4py==3.23.2",
+  "slepc4py==3.24.0",
 ]
 torch = [  # requires passing '--extra-index-url' to work
   "torch",
@@ -110,16 +107,15 @@ ci = [
   "mpi-pytest>=2025.7",
   "nbval",
   "networkx",
-  "ngsPETSc",
+  "ngsPETSc>=0.1.1",
   "pdf2image",
   "pygraphviz",
   "pylit",
   "pytest",
   "pytest-split",  # needed for firedrake-run-split-tests
   "pytest-timeout",
   "pytest-xdist",
-  # TODO RELEASE
-  # "slepc4py==3.23.2",
+  "slepc4py==3.24.0",
   "torch",  # requires passing '--extra-index-url' to work
 ]
 docker = [  # Used in firedrake-vanilla container
@@ -135,8 +131,7 @@ docker = [  # Used in firedrake-vanilla container
   "pytest-split",  # needed for firedrake-run-split-tests
   "pytest-timeout",
   "pytest-xdist",
-  # TODO RELEASE
-  # "slepc4py==3.23.2",
+  "slepc4py==3.24.0",
 ]
 
 [build-system]
@@ -150,8 +145,7 @@ requires = [
   "pkgconfig",
   "pybind11",
   "setuptools>=77.0.3",
-  # TODO RELEASE
-  # "petsc4py==3.23.4",
+  "petsc4py==3.24.0",
   "rtree>=1.2",
 ]
 build-backend = "setuptools.build_meta"