Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

GitHub Workflow Status GitHub release (latest by date) jossstatus

PyPI PyPI - Implementation PyPI - Downloads

Docker Pulls badge

lite-badge

Documentation

A preliminary collection of documentation (demos, tutorials, mini API) can be found here and is also part of the i-tutorials of NGSolve, see here. A simple doxygen collection of NGSolve, ngsxfem and ngstrefftz C++ API can be found here.

About ngsxfem

ngsxfem is an add-on library to the finite element package Netgen/NGSolve which enables the use of unfitted finite element technologies known as XFEM, CutFEM, TraceFEM, Finite Cell, ... . ngsxfem is an academic software. Its primary intention is to facilitate the development and validation of new numerical methods for partial differential equations.

The features of ngsxfem

The main features of ngsxfem are:

  • Tools to work on a subset of the triangulation, the "active mesh" only
  • Numerical integration on geometries that are (implicitly) described through level set functions.
  • Higher order representation of level set geometries
  • Space-Time Finite Elements for the treatment of moving domain problems
  • All these features combined with the usual flexibility and power of NGSolve.

ngsxfem has been used in a variety of applications. In the document doc/feature-details.md (see also compiled pdf ) more details on the features is given and in doc/literature.md (see also the rendered literature page and the compiled pdf ) an overview of the scientific literature where ngsxfem is used is provided. If you have used ngsxfem in a publication that is missing there, please open an issue or a pull request (the list is generated from doc/literature.yaml).

Not all features of ngsxfem and NGSolve can directly be combined. Here is an overview of ngsxfem and NGSolve features and if they can directly be combined:

Features ⇲ CFE XFE DG Iso MLS ST Gh Ag Hex Tet MPI
CFE: CutFEM form. / / y y y y y y y y y
XFE: XFEM formulation / / y y n n y n y y y
DG: Discont. Galerkin y y / y n y y y y y n
Iso: isoparametric map y y y / n y y y y y y
MLS: multiple level set y n n n / n y y n y y
ST: space-time FEM y n y y n / y n y y y
Gh: Ghost penalty y y y y y y / / y y n
Ag: Agg. FEM y n y y y n / / y y n
Hex: quads / hexes y y y y n y y y / / y
Tet: trigs./tets y y y y y y y y / / y
MPI: MPI y y n y y y n n y y /

Some of the nos are work in progress and some have not been considered so far. If you need a certain combination to work, please contact us and we will see what we can do (MPI for Gh is planned for the not so far future).

Examples and Documentation

We provide two main sources with which to learn how to use ngsxfem:

  • At https://github.com/ngsxfem/ngsxfem-jupyter you can find tutorial-style jupyter notebooks for ngsxfem. These explain the core functionalities and usage of the tools provided by ngsxfem. You can run those tutorials interactively (without the need of a local installation) through binder.
  • In the demos-directory we provide several examples that demonstrate the usage of ngsxfem features. See demos/README.md for details.

Installation

We provide installation instructions for building/installing through pip and building/installing from sources in INSTALLATION.md. Further, a docker image is available which can be used to run ngsxfem through docker.

List of contributing authors

Major contributions:

  • Christoph Lehrenfeld (main author)
  • Fabian Heimann (cut integration, space-time, AggFEM)
  • Henry von Wahl (multiple levelsets, mac support, AggFEM)
  • Janosch Preuss (space-time)
  • Thomas Ludescher (multigrid)
  • Paul Stocker (CI, docu, builds, AggFEM)

Additional contributions:

  • Pedro Costa Klein (CI, docu)
  • Maximilian Zienecker (SIMD, CI)

Community guidelines

If you observe any problems with the software / examples / documentation / installation or want to contribute, you can get in touch with us through either:

Citing

If you use ngsxfem for academic work, please consider citing our publication:

C. Lehrenfeld, F. Heimann, J. Preuß and H. von Wahl
ngsxfem: Add-on to NGSolve for geometrically unfitted finite element discretizations
Journal of Open Source Software, 6(64), 3237,
https://doi.org/10.21105/joss.03237

Metadata

Release files for xfem 2.1.2608rc2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for xfem 2.1.2608rc2
File Size Uploaded Provenance Actions
xfem-2.1.2608rc2.tar.gz 2.2 MB Without provenance Details for xfem-2.1.2608rc2.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for xfem 2.1.2608rc2
File Actions
xfem-2.1.2608rc2-cp314-cp314-win_amd64.whl CPython 3.14 CPython 3.14 Windows x86-64 Details for xfem-2.1.2608rc2-cp314-cp314-win_amd64.whl
xfem-2.1.2608rc2-cp314-cp314-manylinux_2_28_x86_64.manylinux2014_x86_64.whl CPython 3.14 CPython 3.14 Linux glibc 2.17+ x86-64, Linux glibc 2.28+ x86-64 Details for xfem-2.1.2608rc2-cp314-cp314-manylinux_2_28_x86_64.manylinux2014_x86_64.whl
xfem-2.1.2608rc2-cp314-cp314-macosx_10_9_universal2.whl CPython 3.14 CPython 3.14 macOS 10.9+ universal2 (ARM64, x86-64) Details for xfem-2.1.2608rc2-cp314-cp314-macosx_10_9_universal2.whl
xfem-2.1.2608rc2-cp313-cp313-win_amd64.whl CPython 3.13 CPython 3.13 Windows x86-64 Details for xfem-2.1.2608rc2-cp313-cp313-win_amd64.whl
xfem-2.1.2608rc2-cp313-cp313-manylinux_2_28_x86_64.manylinux2014_x86_64.whl CPython 3.13 CPython 3.13 Linux glibc 2.17+ x86-64, Linux glibc 2.28+ x86-64 Details for xfem-2.1.2608rc2-cp313-cp313-manylinux_2_28_x86_64.manylinux2014_x86_64.whl
xfem-2.1.2608rc2-cp313-cp313-macosx_10_9_universal2.whl CPython 3.13 CPython 3.13 macOS 10.9+ universal2 (ARM64, x86-64) Details for xfem-2.1.2608rc2-cp313-cp313-macosx_10_9_universal2.whl
xfem-2.1.2608rc2-cp312-cp312-win_amd64.whl CPython 3.12 CPython 3.12 Windows x86-64 Details for xfem-2.1.2608rc2-cp312-cp312-win_amd64.whl
xfem-2.1.2608rc2-cp312-cp312-manylinux_2_28_x86_64.manylinux2014_x86_64.whl CPython 3.12 CPython 3.12 Linux glibc 2.17+ x86-64, Linux glibc 2.28+ x86-64 Details for xfem-2.1.2608rc2-cp312-cp312-manylinux_2_28_x86_64.manylinux2014_x86_64.whl
xfem-2.1.2608rc2-cp312-cp312-macosx_10_9_universal2.whl CPython 3.12 CPython 3.12 macOS 10.9+ universal2 (ARM64, x86-64) Details for xfem-2.1.2608rc2-cp312-cp312-macosx_10_9_universal2.whl
xfem-2.1.2608rc2-cp311-cp311-win_amd64.whl CPython 3.11 CPython 3.11 Windows x86-64 Details for xfem-2.1.2608rc2-cp311-cp311-win_amd64.whl
xfem-2.1.2608rc2-cp311-cp311-manylinux_2_28_x86_64.manylinux2014_x86_64.whl CPython 3.11 CPython 3.11 Linux glibc 2.17+ x86-64, Linux glibc 2.28+ x86-64 Details for xfem-2.1.2608rc2-cp311-cp311-manylinux_2_28_x86_64.manylinux2014_x86_64.whl
xfem-2.1.2608rc2-cp311-cp311-macosx_10_9_universal2.whl CPython 3.11 CPython 3.11 macOS 10.9+ universal2 (ARM64, x86-64) Details for xfem-2.1.2608rc2-cp311-cp311-macosx_10_9_universal2.whl
xfem-2.1.2608rc2-cp310-cp310-win_amd64.whl CPython 3.10 CPython 3.10 Windows x86-64 Details for xfem-2.1.2608rc2-cp310-cp310-win_amd64.whl
xfem-2.1.2608rc2-cp310-cp310-manylinux_2_28_x86_64.manylinux2014_x86_64.whl CPython 3.10 CPython 3.10 Linux glibc 2.17+ x86-64, Linux glibc 2.28+ x86-64 Details for xfem-2.1.2608rc2-cp310-cp310-manylinux_2_28_x86_64.manylinux2014_x86_64.whl
xfem-2.1.2608rc2-cp310-cp310-macosx_10_9_universal2.whl CPython 3.10 CPython 3.10 macOS 10.9+ universal2 (ARM64, x86-64) Details for xfem-2.1.2608rc2-cp310-cp310-macosx_10_9_universal2.whl

Total release size: 36.1 MB

Release files / xfem-2.1.2608rc2.tar.gz

Download URL xfem-2.1.2608rc2.tar.gz
Size 2.2 MB
Tags Source
SHA-256 checksum
How to use checksums
c5c35d473a11830e2b6704115a36c0f8a27077e882949be9ed28b77ff98081c6
BLAKE2b-256 checksum
How to use checksums
afce17c57985ea5da135998e5bc4301413708f5537e1d021025e054dd3ff4b4e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / xfem-2.1.2608rc2-cp314-cp314-win_amd64.whl

Download URL xfem-2.1.2608rc2-cp314-cp314-win_amd64.whl
Size 1.9 MB
Tags CPython 3.14 Windows x86-64
SHA-256 checksum
How to use checksums
c7ca8aff3cf1a3aab9846ee949258b87015c305d8845a696a63fe0f448521ad1
BLAKE2b-256 checksum
How to use checksums
6dae25207d8483f65efc5ce00c89112e096188440f2ce7f303631cd7bc28d2f8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / xfem-2.1.2608rc2-cp314-cp314-manylinux_2_28_x86_64.manylinux2014_x86_64.whl

Download URL xfem-2.1.2608rc2-cp314-cp314-manylinux_2_28_x86_64.manylinux2014_x86_64.whl
Size 1.9 MB
Tags CPython 3.14 Linux glibc 2.17+ x86-64 Linux glibc 2.28+ x86-64
SHA-256 checksum
How to use checksums
489e4a375333e756c9d490e18d8009b867c358e760786741cbb9710841303a62
BLAKE2b-256 checksum
How to use checksums
04e8198c2c5fc0eabf09bda88c5ccb0683d4e30bd5274040bf2cc77713828391
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / xfem-2.1.2608rc2-cp314-cp314-macosx_10_9_universal2.whl

Download URL xfem-2.1.2608rc2-cp314-cp314-macosx_10_9_universal2.whl
Size 3.0 MB
Tags CPython 3.14 macOS 10.9+ universal2 (ARM64, x86-64)
SHA-256 checksum
How to use checksums
5ba3c1f8fbc3dd2864d5511ff6d73c0683098ee293a5bd891b0f085f40800b89
BLAKE2b-256 checksum
How to use checksums
0467d9d653dabff8974d222d405cae9caf03972688ccf8f5ee836c0da0258222
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / xfem-2.1.2608rc2-cp313-cp313-win_amd64.whl

Download URL xfem-2.1.2608rc2-cp313-cp313-win_amd64.whl
Size 1.9 MB
Tags CPython 3.13 Windows x86-64
SHA-256 checksum
How to use checksums
d776ea943d948a73d1fa01e5ce0b91a5b9df19aaa6365f19c3711d12417b97d9
BLAKE2b-256 checksum
How to use checksums
d76c3562c642f23cc0af8e4170d85ff6f8b72fcf76437d022a6cc04fe03663f0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / xfem-2.1.2608rc2-cp313-cp313-manylinux_2_28_x86_64.manylinux2014_x86_64.whl

Download URL xfem-2.1.2608rc2-cp313-cp313-manylinux_2_28_x86_64.manylinux2014_x86_64.whl
Size 1.9 MB
Tags CPython 3.13 Linux glibc 2.17+ x86-64 Linux glibc 2.28+ x86-64
SHA-256 checksum
How to use checksums
14e467ee8cbf4a1815fea9054f2a7840bca7cd80a5b0a32f80109c889893baeb
BLAKE2b-256 checksum
How to use checksums
ae8e2e0096ded508e61f3888635cee54f6af4f8dd4032d29db269d86d655551d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / xfem-2.1.2608rc2-cp313-cp313-macosx_10_9_universal2.whl

Download URL xfem-2.1.2608rc2-cp313-cp313-macosx_10_9_universal2.whl
Size 3.0 MB
Tags CPython 3.13 macOS 10.9+ universal2 (ARM64, x86-64)
SHA-256 checksum
How to use checksums
dd64a316ceda5a99874da25023fd771e5ae5b930aeb4df27275eded9af675cec
BLAKE2b-256 checksum
How to use checksums
fb50b1a9c8a12430a479bd0103c79bdc1788997e1ea88a4670075c9400b47d58
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / xfem-2.1.2608rc2-cp312-cp312-win_amd64.whl

Download URL xfem-2.1.2608rc2-cp312-cp312-win_amd64.whl
Size 1.9 MB
Tags CPython 3.12 Windows x86-64
SHA-256 checksum
How to use checksums
76979e3a47208fe37aaf8fdb78c13e6d958a6d8cb6cf6a4e4b4b2c085f51f646
BLAKE2b-256 checksum
How to use checksums
1d5ed4d8ef2b16124f434fa58bb069b62a31c57b24bc4d725ac05f7bdaff0bfb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / xfem-2.1.2608rc2-cp312-cp312-manylinux_2_28_x86_64.manylinux2014_x86_64.whl

Download URL xfem-2.1.2608rc2-cp312-cp312-manylinux_2_28_x86_64.manylinux2014_x86_64.whl
Size 1.9 MB
Tags CPython 3.12 Linux glibc 2.17+ x86-64 Linux glibc 2.28+ x86-64
SHA-256 checksum
How to use checksums
29bfa7c59d224a176ce48b3cd227ac4f09fad56bbfbe83eff78031c901249053
BLAKE2b-256 checksum
How to use checksums
42edbb09adf9a58a11e3860c6732e64a553584e91af97dd39263d561840cd223
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / xfem-2.1.2608rc2-cp312-cp312-macosx_10_9_universal2.whl

Download URL xfem-2.1.2608rc2-cp312-cp312-macosx_10_9_universal2.whl
Size 3.0 MB
Tags CPython 3.12 macOS 10.9+ universal2 (ARM64, x86-64)
SHA-256 checksum
How to use checksums
d830f3a3c3b25ff4f407836fa82486c7292729617dae047eb7f199eaf78702cf
BLAKE2b-256 checksum
How to use checksums
363535aea1e67dbf9ebca13d82011532bf4d284b032808cb42c421bc9a71cee7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / xfem-2.1.2608rc2-cp311-cp311-win_amd64.whl

Download URL xfem-2.1.2608rc2-cp311-cp311-win_amd64.whl
Size 1.9 MB
Tags CPython 3.11 Windows x86-64
SHA-256 checksum
How to use checksums
8af416623ab3ebaccbecdf31aacde581ea909093e50c07041eb64313106c81a0
BLAKE2b-256 checksum
How to use checksums
13efde65455ffcc3aa27f9b00b14ada25c33cee85d4331bc0cff148d6a626375
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / xfem-2.1.2608rc2-cp311-cp311-manylinux_2_28_x86_64.manylinux2014_x86_64.whl

Download URL xfem-2.1.2608rc2-cp311-cp311-manylinux_2_28_x86_64.manylinux2014_x86_64.whl
Size 1.9 MB
Tags CPython 3.11 Linux glibc 2.17+ x86-64 Linux glibc 2.28+ x86-64
SHA-256 checksum
How to use checksums
bc7e3dfb0f8979b1d00e0e5cea02596f20b5d7490a773afa640b05a303a917f1
BLAKE2b-256 checksum
How to use checksums
8023aff3eb69ba34903ea6258430ab085bb57a2fab8ef50b6231ce1efc4bb347
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / xfem-2.1.2608rc2-cp311-cp311-macosx_10_9_universal2.whl

Download URL xfem-2.1.2608rc2-cp311-cp311-macosx_10_9_universal2.whl
Size 3.0 MB
Tags CPython 3.11 macOS 10.9+ universal2 (ARM64, x86-64)
SHA-256 checksum
How to use checksums
8f1c7aed073c2aec6328e1591ebb93d2304318010187e1c57dbeee5f84b0fb7e
BLAKE2b-256 checksum
How to use checksums
0b8c7ca3e7ed0f70c103cf7e8295ce4f54e111c9da7e7aba2fbde0bb96322d40
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / xfem-2.1.2608rc2-cp310-cp310-win_amd64.whl

Download URL xfem-2.1.2608rc2-cp310-cp310-win_amd64.whl
Size 1.9 MB
Tags CPython 3.10 Windows x86-64
SHA-256 checksum
How to use checksums
7d7b0fbb89939d489433dfad452a2c8358f4805855c2e60925a94a37d09af29a
BLAKE2b-256 checksum
How to use checksums
7d199c89610eae49c0f4c4c11a9bd776caa39bfe5212cc83a568dd0d3d2437a1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / xfem-2.1.2608rc2-cp310-cp310-manylinux_2_28_x86_64.manylinux2014_x86_64.whl

Download URL xfem-2.1.2608rc2-cp310-cp310-manylinux_2_28_x86_64.manylinux2014_x86_64.whl
Size 1.9 MB
Tags CPython 3.10 Linux glibc 2.17+ x86-64 Linux glibc 2.28+ x86-64
SHA-256 checksum
How to use checksums
de6351a22378bec58dde548adfb90f605548d81639ba2be50e9c3180053e45ef
BLAKE2b-256 checksum
How to use checksums
e57233ed19824cfca15cf9d871acf19553ccbbb3f601240cb34171c03288ec32
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / xfem-2.1.2608rc2-cp310-cp310-macosx_10_9_universal2.whl

Download URL xfem-2.1.2608rc2-cp310-cp310-macosx_10_9_universal2.whl
Size 3.0 MB
Tags CPython 3.10 macOS 10.9+ universal2 (ARM64, x86-64)
SHA-256 checksum
How to use checksums
3dffa0997e5a312b6a115d0d356cd52dd8f074565fb7212db4edaecf761a9aee
BLAKE2b-256 checksum
How to use checksums
3a55637aa0ae409804c0c7a77eb2ba7f6413f4767adade712dced94d0ae34fd8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for xfem 2.1.2608rc2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page