API reference#

Docstrings of the exported and public names of the core library, grouped by stage of a computation. Start with the tutorials; look up a signature or an option here. The solver names are on Solvers and preconditioners, and the SciML and automatic differentiation names on Scientific computing: SciML, AD and solvers. Those two pages also document some names that are neither exported nor public; they are called as Bramble.name. Internals holds the private docstrings, for contributors.

• Utilities: linear algebra backends and other package-wide helpers.

• Geometry: sets, intervals, markers and domains, which describe where a problem lives and how its boundary is labelled.

• Meshes: mesh types and constructors, points and spacings, indexing and boundaries, adaptation, and ghost meshes.

• Grid spaces: function spaces on a mesh, their degrees of freedom, grid functions, restriction and averaging, interpolation between spaces, and spaces with ghost points and boundary relations.

• Difference, jump and average operators: the discrete derivatives and related operators that act on grid functions, and the normal derivatives of a facet.

• Inner products and norms: discrete inner products and the norms built from them.

• Forms: building, assembling and solving bilinear and linear forms, including matrix-free operators, Dirichlet conditions and sparsity analysis.

• Solvers and preconditioners: pde_solve, the sparse direct solvers, and the preconditioners and multigrid for iterative solves.

• Exporters: writing grid functions to files for visualisation.