dolfinx.fem

Tools for assembling and manipulating finite element forms.

Functions

create_matrix(a[, block_mode])	Create a sparse matrix that is compatible with a given bilinear form.
functionspace(mesh, element[, ...])	Create a finite element function space.
create_sparsity_pattern(a)	Create a sparsity pattern from a bilinear form.
discrete_gradient(space0, space1)	Assemble a discrete gradient operator.
assemble_scalar(M[, constants, coeffs])	Assemble functional.
assemble_matrix()	Assemble bilinear form into a matrix.
assemble_vector(-> ~dolfinx.la.Vector)
apply_lifting(b, a, bcs[, x0, scale, ...])	Modify RHS vector b for lifting of Dirichlet boundary conditions.
set_bc(b, bcs[, x0, scale])	Insert boundary condition values into vector.
dirichletbc(value, dofs[, V])	Create a representation of Dirichlet boundary condition which is imposed on a linear system.
bcs_by_block(spaces, bcs)	Arrange Dirichlet boundary conditions by the function space that they constrain.
form(form[, dtype, form_compiler_options, ...])	Create a Form or an array of Forms.
create_vector(L)	Create a Vector that is compatible with a given linear form
locate_dofs_geometrical(V, marker)	Locate degrees-of-freedom geometrically using a marker function.
locate_dofs_topological(V, entity_dim, entities)	Locate degrees-of-freedom belonging to mesh entities topologically.
extract_function_spaces(forms[, index])	Extract common function spaces from an array of forms.
create_nonmatching_meshes_interpolation_data(...)	Generate data needed to interpolate discrete functions across different meshes.
coordinate_element()	Create a Lagrange CoordinateElement from element metadata.
form_cpp_class(dtype)	Return the wrapped C++ class of a variational form of a specific scalar type.

Classes

Constant(domain, c)	A constant with respect to a domain.
Expression(e, X[, comm, ...])	Create a DOLFINx Expression.
Function(*args, **kw)	A finite element function that is represented by a function space (domain, element and dofmap) and a vector holding the degrees-of-freedom.
ElementMetaData(family, degree[, shape, ...])	Data for representing a finite element
FunctionSpace(mesh, element, cppV)	A space on which Functions (fields) can be defined.
DirichletBC(bc)	Representation of Dirichlet boundary condition which is imposed on a linear system.
DofMap(dofmap)	Degree-of-freedom map
Form(form[, ufcx_form, code])	A finite element form
IntegralType
CoordinateElement(cmap)	Coordinate element describing the geometry map for mesh cells

class dolfinx.fem.Constant(domain, c: ndarray | Sequence | floating | complexfloating)

Bases: Constant

A constant with respect to a domain.

Parameters:

• domain – DOLFINx or UFL mesh

• c – Value of the constant.

property dtype: dtype

property value

The value of the constant

class dolfinx.fem.CoordinateElement(cmap: CoordinateElement_float32 | CoordinateElement_float64)

Bases: object

Coordinate element describing the geometry map for mesh cells

Create a coordinate map element.

Note

This initialiser is for internal use and not normally called in user code. Use coordinate_element() to create a CoordinateElement.

Parameters:

cmap – A C++ CoordinateElement.

property dtype: dtype

Scalar type for the coordinate element.

class dolfinx.fem.DirichletBC(bc)

Bases: object

Representation of Dirichlet boundary condition which is imposed on a linear system.

Note

Dirichlet boundary conditions should normally be constructed using fem.dirichletbc() and not using this class initialiser. This class is combined with different base classes that depend on the scalar type of the boundary condition.

Parameters:

• value – Lifted boundary values function.

• dofs – Local indices of degrees of freedom in function space to which boundary condition applies. Expects array of size (number of dofs, 2) if function space of the problem, V is passed. Otherwise assumes function space of the problem is the same of function space of boundary values function.

• V – Function space of a problem to which boundary conditions are applied.

property function_space: FunctionSpace

The function space on which the boundary condition is defined

property g: Union[Function, Constant, np.ndarray]

The boundary condition value(s)

class dolfinx.fem.DofMap(dofmap: DofMap)

Bases: object

Degree-of-freedom map

This class handles the mapping of degrees of freedom. It builds a dof map based on a ufcx_dofmap on a specific mesh.

property bs

Returns the block size of the dofmap

cell_dofs(cell_index: int)

Cell local-global dof map

Parameters:

cell – The cell index

Returns:

Local-global dof map for the cell (using process-local indices)

property dof_layout

Layout of dofs on an element

property index_map

Index map that described the parallel distribution of the dofmap

property index_map_bs

Block size of the index map

property list

Adjacency list with dof indices for each cell

class dolfinx.fem.ElementMetaData(family: str, degree: int, shape: Optional[tuple[int, ...]] = None, symmetry: Optional[bool] = None)

Bases: NamedTuple

Data for representing a finite element

Parameters:

• family – Element type.

• degree – Polynomial degree of the element.

• shape – Shape for vector/tensor valued elements that are constructed from blocked scalar elements (e.g., Lagrange).

• symmetry – Symmetry option for blocked tensor elements.

Create new instance of ElementMetaData(family, degree, shape, symmetry)

degree: int

Alias for field number 1

family: str

Alias for field number 0

shape: tuple[int, ...] | None

Alias for field number 2

symmetry: bool | None

Alias for field number 3

class dolfinx.fem.Expression(e: ufl.core.expr.Expr, X: np.ndarray, comm: Optional[_MPI.Comm] = None, form_compiler_options: Optional[dict] = None, jit_options: Optional[dict] = None, dtype: Optional[npt.DTypeLike] = None)

Bases: object

Create a DOLFINx Expression.

Represents a mathematical expression evaluated at a pre-defined set of points on the reference cell. This class closely follows the concept of a UFC Expression.

This functionality can be used to evaluate a gradient of a Function at the quadrature points in all cells. This evaluated gradient can then be used as input to a non-FEniCS function that calculates a material constitutive model.

Parameters:

• e – UFL expression.

• X – Array of points of shape (num_points, tdim) on the reference element.

• comm – Communicator that the Expression is defined on.

• form_compiler_options – Options used in FFCx compilation of this Expression. Run ffcx --help in the commandline to see all available options.

• jit_options – Options controlling JIT compilation of C code.

Note

This wrapper is responsible for the FFCx compilation of the UFL Expr and attaching the correct data to the underlying C++ Expression.

X() → ndarray

Evaluation points on the reference cell

property argument_function_space: FunctionSpace | None

The argument function space if expression has argument

property code: str

C code strings

property dtype: dtype

eval(mesh: Mesh, entities: np.ndarray, values: Optional[np.ndarray] = None) → np.ndarray

Evaluate Expression on entities.

Parameters:

• mesh – Mesh to evaluate Expression on.

• entities – Either an array of cells (index local to process) or an array of integral tuples (cell index, local facet index). The array is flattened.

• values – Array to fill with evaluated values. If None, storage will be allocated. Otherwise must have shape (num_entities, num_points * value_size * num_all_argument_dofs)

Returns:

Expression evaluated at points for entities.

property ufcx_expression

The compiled ufcx_expression object

property ufl_expression

Original UFL Expression

property value_size: int

Value size of the expression

class dolfinx.fem.Form(form: Form_complex64 | Form_complex128 | Form_float32 | Form_float64, ufcx_form=None, code: str | None = None)

Bases: object

A finite element form

Note

Forms should normally be constructed using form() and not using this class initialiser. This class is combined with different base classes that depend on the scalar type used in the Form.

Parameters:

• form – Compiled form object.

• ufcx_form – UFCx form

• code – Form C++ code

property code: str | None

C code strings

property dtype: dtype

Scalar type of this form

property function_spaces: list[FunctionSpace]

Function spaces on which this form is defined

property integral_types

Integral types in the form

property mesh: Mesh_float32 | Mesh_float64

Mesh on which this form is defined.

property rank: int

property ufcx_form

The compiled ufcx_form object

class dolfinx.fem.Function(*args, **kw)

Bases: Coefficient

A finite element function that is represented by a function space (domain, element and dofmap) and a vector holding the degrees-of-freedom.

Initialize a finite element Function.

Parameters:

• V – The function space that the Function is defined on.

• x – Function degree-of-freedom vector. Typically required only when reading a saved Function from file.

• name – Function name.

• dtype – Scalar type. Is not set, the DOLFINx default scalar type is used.

collapse() → Function

copy() → Function

Create a copy of the Function. The function space is shared and the degree-of-freedom vector is copied.

property dtype: dtype

eval(x: _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes], cells: _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes], u=None) → ndarray

Evaluate Function at points x, where x has shape (num_points, 3), and cells has shape (num_points,) and cell[i] is the index of the cell containing point x[i]. If the cell index is negative the point is ignored.

property function_space: FunctionSpace

The FunctionSpace that the Function is defined on

interpolate(u: Union[Callable, Expression, Function], cells: Optional[np.ndarray] = None, cell_map: Optional[np.ndarray] = None, expr_mesh: Optional[Mesh] = None, nmm_interpolation_data: Optional[PointOwnershipData] = None) → None

Interpolate an expression

Parameters:

• u – The function, Expression or Function to interpolate.

• cells – The cells to interpolate over. If None then all cells are interpolated over.

• cell_map – Mapping from cells to to cells in the mesh that u is defined over.

• expr_mesh – If an Expression with coefficients or constants from another mesh than the function is supplied, the mesh associated with this expression has to be provided, along with cell_map.

• nmm_interpolation_data – Data needed to interpolate functions defined on other meshes

property name: str

Name of the Function.

split() → tuple[Function, ...]

Extract (any) sub-functions.

A sub-function can be extracted from a discrete function that is in a mixed, vector, or tensor FunctionSpace. The sub-function resides in the subspace of the mixed space.

Returns:

First level of subspaces of the function space.

sub(i: int) → Function

Return a sub-function (a view into the Function).

Sub-functions are indexed i = 0, …, N-1, where N is the number of sub-spaces.

Parameters:

i – Index of the sub-function to extract.

Returns:

A view into the parent Function.

Note

If the sub-Function is re-used, for performance reasons the returned Function should be stored by the caller to avoid repeated re-computation of the subspac.

property vector

PETSc vector holding the degrees-of-freedom.

Upon first call, this function creates a PETSc Vec object that wraps the degree-of-freedom data. The Vec object is cached and the cached Vec is returned upon subsequent calls.

Note

Prefer :func`x` where possible.

property x: Vector

Vector holding the degrees-of-freedom.

class dolfinx.fem.FunctionSpace(mesh: Mesh, element: ufl.FiniteElementBase, cppV: Union[_cpp.fem.FunctionSpace_float32, _cpp.fem.FunctionSpace_float64])

Bases: FunctionSpace

A space on which Functions (fields) can be defined.

Create a finite element function space.

Note

This initialiser is for internal use and not normally called in user code. Use functionspace() to create a function space.

Parameters:

• mesh – Mesh that space is defined on

• element – UFL finite element

• cppV – Compiled C++ function space.

clone() → FunctionSpace

Create a new FunctionSpace \(W\) which shares data with this FunctionSpace \(V\), but with a different unique integer ID.

This function is helpful for defining mixed problems and using blocked linear algebra. For example, a matrix block defined on the spaces \(V \times W\) where, \(V\) and \(W\) are defined on the same finite element and mesh can be identified as an off-diagonal block whereas the \(V \times V\) and \(V \times V\) matrices can be identified as diagonal blocks. This is relevant for the handling of boundary conditions.

Returns:

A new function space that shares data

collapse() → tuple[FunctionSpace, ndarray]

Collapse a subspace and return a new function space and a map from new to old dofs.

Returns:

A new function space and the map from new to old degrees-of-freedom.

component()

Return the component relative to the parent space.

contains(V) → bool

Check if a space is contained in, or is the same as (identity), this space.

Parameters:

V – The space to check to for inclusion.

Returns:

True if V is contained in, or is the same as, this space

property dofmap: DofMap

Degree-of-freedom map associated with the function space.

property element: FiniteElement_float32 | FiniteElement_float64

Function space finite element.

property mesh: Mesh

Mesh on which the function space is defined.

property num_sub_spaces: int

Number of sub spaces.

sub(i: int) → FunctionSpace

Return the i-th sub space.

Parameters:

i – Index of the subspace to extract.

Returns:

A subspace.

Note

If the subspace is re-used, for performance reasons the returned subspace should be stored by the caller to avoid repeated re-computation of the subspace.

tabulate_dof_coordinates() → ndarray[Any, dtype[float64]]

Tabulate the coordinates of the degrees-of-freedom in the function space.

Returns:

Coordinates of the degrees-of-freedom.

Note

This method is only for elements with point evaluation degrees-of-freedom.

ufl_function_space() → FunctionSpace

UFL function space.

property value_shape: tuple[int, ...]

Value shape.

class dolfinx.fem.IntegralType

Bases: object

cell = dolfinx.cpp.fem.IntegralType.cell

exterior_facet = dolfinx.cpp.fem.IntegralType.exterior_facet

interior_facet = dolfinx.cpp.fem.IntegralType.interior_facet

vertex = dolfinx.cpp.fem.IntegralType.vertex

dolfinx.fem.apply_lifting(b: ndarray, a: list[Form], bcs: list[list[DirichletBC]], x0: list[ndarray] | None = None, scale: float = 1.0, constants=None, coeffs=None) → None

Modify RHS vector b for lifting of Dirichlet boundary conditions.

It modifies b such that:

\[b \leftarrow b - \text{scale} * A_j (g_j - x0_j)\]

where j is a block (nest) index. For a non-blocked problem j = 0. The boundary conditions bcs are on the trial spaces V_j. The forms in [a] must have the same test space as L (from which b was built), but the trial space may differ. If x0 is not supplied, then it is treated as zero.

Note

Ghost contributions are not accumulated (not sent to owner). Caller is responsible for calling VecGhostUpdateBegin/End.

dolfinx.fem.assemble_matrix(a: Any, bcs: list[DirichletBC] | None = None, diagonal: float = 1.0, constants=None, coeffs=None, block_mode: BlockMode | None = None)

dolfinx.fem.assemble_matrix(A: MatrixCSR, a: Form, bcs: list[DirichletBC] | None = None, diagonal: float = 1.0, constants=None, coeffs=None) → MatrixCSR

Assemble bilinear form into a matrix.

Parameters:

• a – The bilinear form assemble.

• bcs – Boundary conditions that affect the assembled matrix. Degrees-of-freedom constrained by a boundary condition will have their rows/columns zeroed and the value diagonal set on on the matrix diagonal.

• constants – Constants that appear in the form. If not provided, any required constants will be computed.

• coeffs –

  Coefficients that appear in the form. If not provided,

  any required coefficients will be computed.

  block_mode: Block size mode for the returned space matrix. If

  None, default is used.

Returns:

Matrix representation of the bilinear form a.

Note

The returned matrix is not finalised, i.e. ghost values are not accumulated.

dolfinx.fem.assemble_scalar(M: Form, constants=None, coeffs=None)

Assemble functional. The returned value is local and not accumulated across processes.

Parameters:

• M – The functional to compute.

• constants – Constants that appear in the form. If not provided, any required constants will be computed.

• coeffs – Coefficients that appear in the form. If not provided, any required coefficients will be computed.

Returns:

The computed scalar on the calling rank.

Note

Passing constants and coefficients is a performance optimisation for when a form is assembled multiple times and when (some) constants and coefficients are unchanged.

To compute the functional value on the whole domain, the output of this function is typically summed across all MPI ranks.

dolfinx.fem.assemble_vector(L: Any, constants=None, coeffs=None)

dolfinx.fem.assemble_vector(L: Form, constants=None, coeffs=None) → Vector

dolfinx.fem.assemble_vector(b: ndarray, L: Form, constants=None, coeffs=None)

dolfinx.fem.bcs_by_block(spaces: Iterable[FunctionSpace | None], bcs: Iterable[DirichletBC]) → list[list[DirichletBC]]

Arrange Dirichlet boundary conditions by the function space that they constrain.

Given a sequence of function spaces spaces and a sequence of DirichletBC objects bcs, return a list where the ith entry is the list of DirichletBC objects whose space is contained in space[i].

dolfinx.fem.coordinate_element(celltype: ~dolfinx.cpp.mesh.CellType, degree: int, variant=0, dtype: ~numpy.dtype[~typing.Any] | None | type[~typing.Any] | ~numpy._typing._dtype_like._SupportsDType[~numpy.dtype[~typing.Any]] | str | tuple[~typing.Any, int] | tuple[~typing.Any, ~typing.SupportsIndex | ~collections.abc.Sequence[~typing.SupportsIndex]] | list[~typing.Any] | ~numpy._typing._dtype_like._DTypeDict | tuple[~typing.Any, ~typing.Any] = <class 'numpy.float64'>)

dolfinx.fem.coordinate_element(e: FiniteElement)

Create a Lagrange CoordinateElement from element metadata.

Coordinate elements are typically used to create meshes.

Parameters:

• celltype – Cell shape

• degree – Polynomial degree of the coordinate element map.

• variant – Basix Lagrange variant (affects node placement).

• dtype – Scalar type for the coordinate element.

Returns:

A coordinate element.

dolfinx.fem.create_matrix(a: Form, block_mode: BlockMode | None = None) → MatrixCSR

Create a sparse matrix that is compatible with a given bilinear form. :param a: Bilinear form to assemble. :param block_mode: Block mode of the CSR matrix. If None, default :param is used.:

Returns:

Assembled sparse matrix.

dolfinx.fem.create_nonmatching_meshes_interpolation_data(mesh_to: Mesh | Geometry_float64 | Geometry_float32, element: FiniteElement_float32 | FiniteElement_float64, mesh_from: Mesh, cells: ndarray[Any, dtype[int32]] | None = None, padding: float = 1e-14) → PointOwnershipData

Generate data needed to interpolate discrete functions across different meshes.

Parameters:

• mesh_to – Mesh or geometry of the mesh of the function space to interpolate into

• element – Element of the function space to interpolate into

• mesh_from – Mesh that the function to interpolate from is defined on

• cells – Indices of the cells in the destination mesh on which to interpolate.

• padding – Absolute padding of bounding boxes of all entities on mesh_to

Returns:

Data needed to interpolation functions defined on function spaces on the meshes.

dolfinx.fem.create_sparsity_pattern(a: Form)

Create a sparsity pattern from a bilinear form.

Parameters:

a – Bilinear form to build a sparsity pattern for.

Returns:

Sparsity pattern for the form a.

Note

The pattern is not finalised, i.e. the caller is responsible for calling assemble on the sparsity pattern.

dolfinx.fem.create_vector(L: Form) → Vector

Create a Vector that is compatible with a given linear form

dolfinx.fem.dirichletbc(value: Union[Function, Constant, np.ndarray], dofs: numpy.typing.NDArray[np.int32], V: Optional[dolfinx.fem.FunctionSpace] = None) → DirichletBC

Create a representation of Dirichlet boundary condition which is imposed on a linear system.

Parameters:

• value – Lifted boundary values function. It must have a dtype

• property.

• dofs – Local indices of degrees of freedom in function space to which boundary condition applies. Expects array of size (number of dofs, 2) if function space of the problem, V, is passed. Otherwise assumes function space of the problem is the same of function space of boundary values function.

• V – Function space of a problem to which boundary conditions are applied.

Returns:

A representation of the boundary condition for modifying linear systems.

dolfinx.fem.discrete_gradient(space0: FunctionSpace, space1: FunctionSpace) → MatrixCSR

Assemble a discrete gradient operator.

The discrete gradient operator interpolates the gradient of a H1 finite element function into a H(curl) space. It is assumed that the H1 space uses an identity map and the H(curl) space uses a covariant Piola map.

Parameters:

• space0 – H1 space to interpolate the gradient from

• space1 – H(curl) space to interpolate into

Returns:

Discrete gradient operator

dolfinx.fem.extract_function_spaces(forms: Union[Iterable[Form], Iterable[Iterable[Form]]], index: int = 0) → Iterable[Union[None, function.FunctionSpace]]

Extract common function spaces from an array of forms. If forms is a list of linear form, this function returns of list of the corresponding test functions. If forms is a 2D array of bilinear forms, for index=0 the list common test function space for each row is returned, and if index=1 the common trial function spaces for each column are returned.

dolfinx.fem.form(form: typing.Union[ufl.Form, typing.Iterable[ufl.Form]], dtype: npt.DTypeLike = <class 'numpy.float64'>, form_compiler_options: typing.Optional[dict] = None, jit_options: typing.Optional[dict] = None, entity_maps: dict[_cpp.mesh.Mesh, np.typing.NDArray[np.int32]] = {})

Create a Form or an array of Forms.

Parameters:

• form – A UFL form or list(s) of UFL forms.

• dtype – Scalar type to use for the compiled form.

• form_compiler_options – See ffcx_jit

• jit_options – See ffcx_jit.

• entity_maps – If any trial functions, test functions, or coefficients in the form are not defined over the same mesh as the integration domain, entity_maps must be supplied. For each key (a mesh, different to the integration domain mesh) a map should be provided relating the entities in the integration domain mesh to the entities in the key mesh e.g. for a key-value pair (msh, emap) in entity_maps, emap[i] is the entity in msh corresponding to entity i in the integration domain mesh.

Returns:

Compiled finite element Form.

Note

This function is responsible for the compilation of a UFL form (using FFCx) and attaching coefficients and domains specific data to the underlying C++ form. It dynamically create a Form instance with an appropriate base class for the scalar type, e.g. _cpp.fem.Form_float64().

dolfinx.fem.form_cpp_class(dtype: dtype[Any] | None | type[Any] | _SupportsDType[dtype[Any]] | str | tuple[Any, int] | tuple[Any, SupportsIndex | Sequence[SupportsIndex]] | list[Any] | _DTypeDict | tuple[Any, Any]) → Form_float32 | Form_float64 | Form_complex64 | Form_complex128

Return the wrapped C++ class of a variational form of a specific scalar type.

Parameters:

dtype – Scalar type of the required form class.

Returns:

Wrapped C++ form class of the requested type.

Note

This function is for advanced usage, typically when writing custom kernels using Numba or C.

dolfinx.fem.functionspace(mesh: Mesh, element: Union[ufl.FiniteElementBase, ElementMetaData, tuple[str, int, tuple, bool]], form_compiler_options: Optional[dict[str, Any]] = None, jit_options: Optional[dict[str, Any]] = None) → FunctionSpace

Create a finite element function space.

Parameters:

• mesh – Mesh that space is defined on

• element – Finite element description

• form_compiler_options – Options passed to the form compiler

• jit_options – Options controlling just-in-time compilation

Returns:

A function space.

dolfinx.fem.locate_dofs_geometrical(V: FunctionSpace | Iterable[FunctionSpace], marker: Callable) → ndarray

Locate degrees-of-freedom geometrically using a marker function.

Parameters:

• V – Function space(s) in which to search for degree-of-freedom indices.

• marker – A function that takes an array of points x with shape (gdim, num_points) and returns an array of booleans of length num_points, evaluating to True for entities whose degree-of-freedom should be returned.

Returns:

An array of degree-of-freedom indices (local to the process) for degrees-of-freedom whose coordinate evaluates to True for the marker function.

If V is a list of two function spaces, then a 2-D array of shape (number of dofs, 2) is returned.

Returned degree-of-freedom indices are unique and ordered by the first column.

dolfinx.fem.locate_dofs_topological(V: FunctionSpace | Iterable[FunctionSpace], entity_dim: int, entities: ndarray[Any, dtype[int32]], remote: bool = True) → ndarray

Locate degrees-of-freedom belonging to mesh entities topologically.

Parameters:

• V – Function space(s) in which to search for degree-of-freedom indices.

• entity_dim – Topological dimension of entities where degrees-of-freedom are located.

• entities – Indices of mesh entities of dimension entity_dim where degrees-of-freedom are located.

• remote – True to return also “remotely located” degree-of-freedom indices.

Returns:

An array of degree-of-freedom indices (local to the process) for degrees-of-freedom topologically belonging to mesh entities.

If V is a list of two function spaces, then a 2-D array of shape (number of dofs, 2) is returned.

Returned degree-of-freedom indices are unique and ordered by the first column.

dolfinx.fem.set_bc(b: ndarray, bcs: list[DirichletBC], x0: ndarray | None = None, scale: float = 1.0) → None

Insert boundary condition values into vector.

Only local (owned) entries are set, hence communication after calling this function is not required unless ghost entries need to be updated to the boundary condition value.