Skip to main content

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.2608

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.2608
File Size Uploaded Provenance Actions
xfem-2.1.2608.tar.gz 2.2 MB Without provenance Details for xfem-2.1.2608.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for xfem 2.1.2608
File Actions
xfem-2.1.2608-cp314-cp314-win_amd64.whl CPython 3.14 CPython 3.14 Windows x86-64 Details for xfem-2.1.2608-cp314-cp314-win_amd64.whl
xfem-2.1.2608-cp314-cp314-manylinux_2_28_x86_64.manylinux2014_x86_64.whl CPython 3.14 CPython 3.14 Linux glibc 2.28+ x86-64, Linux glibc 2.17+ x86-64 Details for xfem-2.1.2608-cp314-cp314-manylinux_2_28_x86_64.manylinux2014_x86_64.whl
xfem-2.1.2608-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.2608-cp314-cp314-macosx_10_9_universal2.whl
xfem-2.1.2608-cp313-cp313-win_amd64.whl CPython 3.13 CPython 3.13 Windows x86-64 Details for xfem-2.1.2608-cp313-cp313-win_amd64.whl
xfem-2.1.2608-cp313-cp313-manylinux_2_28_x86_64.manylinux2014_x86_64.whl CPython 3.13 CPython 3.13 Linux glibc 2.28+ x86-64, Linux glibc 2.17+ x86-64 Details for xfem-2.1.2608-cp313-cp313-manylinux_2_28_x86_64.manylinux2014_x86_64.whl
xfem-2.1.2608-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.2608-cp313-cp313-macosx_10_9_universal2.whl
xfem-2.1.2608-cp312-cp312-win_amd64.whl CPython 3.12 CPython 3.12 Windows x86-64 Details for xfem-2.1.2608-cp312-cp312-win_amd64.whl
xfem-2.1.2608-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.2608-cp312-cp312-manylinux_2_28_x86_64.manylinux2014_x86_64.whl
xfem-2.1.2608-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.2608-cp312-cp312-macosx_10_9_universal2.whl
xfem-2.1.2608-cp311-cp311-win_amd64.whl CPython 3.11 CPython 3.11 Windows x86-64 Details for xfem-2.1.2608-cp311-cp311-win_amd64.whl
xfem-2.1.2608-cp311-cp311-manylinux_2_28_x86_64.manylinux2014_x86_64.whl CPython 3.11 CPython 3.11 Linux glibc 2.28+ x86-64, Linux glibc 2.17+ x86-64 Details for xfem-2.1.2608-cp311-cp311-manylinux_2_28_x86_64.manylinux2014_x86_64.whl
xfem-2.1.2608-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.2608-cp311-cp311-macosx_10_9_universal2.whl
xfem-2.1.2608-cp310-cp310-win_amd64.whl CPython 3.10 CPython 3.10 Windows x86-64 Details for xfem-2.1.2608-cp310-cp310-win_amd64.whl
xfem-2.1.2608-cp310-cp310-manylinux_2_28_x86_64.manylinux2014_x86_64.whl CPython 3.10 CPython 3.10 Linux glibc 2.28+ x86-64, Linux glibc 2.17+ x86-64 Details for xfem-2.1.2608-cp310-cp310-manylinux_2_28_x86_64.manylinux2014_x86_64.whl
xfem-2.1.2608-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.2608-cp310-cp310-macosx_10_9_universal2.whl

Total release size: 36.1 MB

Release files / xfem-2.1.2608.tar.gz

Download URL xfem-2.1.2608.tar.gz
Size 2.2 MB
Tags Source
SHA-256 checksum
How to use checksums
7844d9548283803257af9e0485db28d6e9692fed519016a7bf6642689cb7e700
BLAKE2b-256 checksum
How to use checksums
c8ee34649776d09d1da0e1ce3270fc612830c54cbae61b23f68d8030b22c4133
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.2608-cp314-cp314-win_amd64.whl

Download URL xfem-2.1.2608-cp314-cp314-win_amd64.whl
Size 1.9 MB
Tags CPython 3.14 Windows x86-64
SHA-256 checksum
How to use checksums
ecdb9c5f1344ef912aa35d4e85b0ec9df2025a02318f0cb1c20df57566a523f7
BLAKE2b-256 checksum
How to use checksums
8a24ecf9e8e9e6e4ffd753fd9e35d11b3a8b36d99a438642d67064cca85838b0
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.2608-cp314-cp314-manylinux_2_28_x86_64.manylinux2014_x86_64.whl

Download URL xfem-2.1.2608-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
939bfca501ad770e5dfba97b2e86bf53b6f22b6df0d40e75e150b36ce48b0ba5
BLAKE2b-256 checksum
How to use checksums
0381e06e933caac900fb1daa27ba7120eed00a340e01e4c9969987ad4f96612c
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.2608-cp314-cp314-macosx_10_9_universal2.whl

Download URL xfem-2.1.2608-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
33f6c0c9ea2be31f5ee755eab296a9c31e060e9e32a5abb05b91b9e46ba3f571
BLAKE2b-256 checksum
How to use checksums
e69f1804f2cdb943ddbf7022d3f99435d94491a8d25084cbceb0b812128adb80
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.2608-cp313-cp313-win_amd64.whl

Download URL xfem-2.1.2608-cp313-cp313-win_amd64.whl
Size 1.9 MB
Tags CPython 3.13 Windows x86-64
SHA-256 checksum
How to use checksums
e71d1955ef4baaa8583a0976f0795ebd2ee0bbbc2a9d4f8811c75be902230095
BLAKE2b-256 checksum
How to use checksums
bf4a40fb11df231fc6de9eded77d94b829d9e4287dcaffdf4b261d5f39297476
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.2608-cp313-cp313-manylinux_2_28_x86_64.manylinux2014_x86_64.whl

Download URL xfem-2.1.2608-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
47e7a73a685d0403f9694f90c5df95f4e4f46ef35fabe29dc104e3eb54285db7
BLAKE2b-256 checksum
How to use checksums
45d5810179c56028e4df904ae4394004323f124daec0ac04646659b3c5a55692
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.2608-cp313-cp313-macosx_10_9_universal2.whl

Download URL xfem-2.1.2608-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
f396c6c04e436d7934636221ce4a617f7f87982e5d3fcfe0f4764b7fff5cd90f
BLAKE2b-256 checksum
How to use checksums
6d94273b99c453e4f24306ec923345506d63824d64c2ee90caa3df3f80a8f3b3
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.2608-cp312-cp312-win_amd64.whl

Download URL xfem-2.1.2608-cp312-cp312-win_amd64.whl
Size 1.9 MB
Tags CPython 3.12 Windows x86-64
SHA-256 checksum
How to use checksums
4ce059be7920b1f2e9d8146ea43d481492563c7bff28c47e41b4b6266638edce
BLAKE2b-256 checksum
How to use checksums
57b4ee754b35017db7d7dc680784fecd8ed4efb88e68691ff64af2194be1ee80
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.2608-cp312-cp312-manylinux_2_28_x86_64.manylinux2014_x86_64.whl

Download URL xfem-2.1.2608-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
fdac3c8c021ec4dace7b3bdde6fa5bffda7eb68ad487fc1478167b3a624ce754
BLAKE2b-256 checksum
How to use checksums
013673515ac4b7ef6f843bcd7a93da522342d16523c6104f9fa164bf32465735
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.2608-cp312-cp312-macosx_10_9_universal2.whl

Download URL xfem-2.1.2608-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
9b642eeb1c348c5227e7aead421a1e75226c7df23a676e19d7d6b37d51aa579c
BLAKE2b-256 checksum
How to use checksums
c5218f64decc5f13c327fb0818679ebe6f2e75b28bea1ce4a0114c68323e6c11
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.2608-cp311-cp311-win_amd64.whl

Download URL xfem-2.1.2608-cp311-cp311-win_amd64.whl
Size 1.9 MB
Tags CPython 3.11 Windows x86-64
SHA-256 checksum
How to use checksums
54838c4f6b6aa51900a66d71040d2fa448985764355ef060b47009c7c494fc5c
BLAKE2b-256 checksum
How to use checksums
720a4027387728b98a4e566464e34b9aef8bc40afc31c61642868e338527398e
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.2608-cp311-cp311-manylinux_2_28_x86_64.manylinux2014_x86_64.whl

Download URL xfem-2.1.2608-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
84497d9222f9a1a3a960d9c2b5b64459d2bd010990733c38dbf7f6a3475ad177
BLAKE2b-256 checksum
How to use checksums
8fddfb1a6bc28aeff7fb065daca207b4edbf75538d646236a6d417674161dd48
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.2608-cp311-cp311-macosx_10_9_universal2.whl

Download URL xfem-2.1.2608-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
ea10d9a880d678324516a35464d17bb3d0fcc330763326a4e8bb1bd21485f2bf
BLAKE2b-256 checksum
How to use checksums
e7f17b5bdf319756ccdc00c63aee5744009cd683f6f62714dab0b8a932834d09
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.2608-cp310-cp310-win_amd64.whl

Download URL xfem-2.1.2608-cp310-cp310-win_amd64.whl
Size 1.9 MB
Tags CPython 3.10 Windows x86-64
SHA-256 checksum
How to use checksums
29be62ad9c4d566236438e925c9a3c949db5018bea7bcba5fc4d9391b1e8ee5f
BLAKE2b-256 checksum
How to use checksums
0c29e2013c5ae0d95196b81f9233c14ae2223805bfef35dbb86d1317208224c1
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.2608-cp310-cp310-manylinux_2_28_x86_64.manylinux2014_x86_64.whl

Download URL xfem-2.1.2608-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
86d9f826f422324b77539097fc730950a282940b54fb5feb266f1501f32b06da
BLAKE2b-256 checksum
How to use checksums
3aaa31b2edd95fb9063594577dbd3d791e159198ff83c71b68f3b9bbbeae21fa
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.2608-cp310-cp310-macosx_10_9_universal2.whl

Download URL xfem-2.1.2608-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
c2f2334287823031f502622f354d37fd3b4e221db8530c00486cd1583e254acb
BLAKE2b-256 checksum
How to use checksums
549340fc3a06c3f2b72734215f6900c3325cf710db52df7e72a85b76106706a4
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.2608

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

2.1.2608 This release

16 release files No provenance

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