Skip to main content

README

DOI

Ambit is an open-source multi-physics finite element solver written in Python, supporting solid and fluid mechanics, fluid-structure interaction (FSI), and lumped-parameter models. It is tailored towards solving problems in cardiac mechanics, but may also be used for more general nonlinear finite element analysis. It uses the finite element backend FEniCSx and linear algebra library PETSc.

https://github.com/user-attachments/assets/6a8a1f96-066d-4c68-a71e-b65ecf12d4da

Fully coupled 3D fluid-structure interaction simulation (~3M dofs) in a patient-specific 4-chamber heart coupled to a closed-loop circulation model.

https://github.com/marchirschvogel/ambit/assets/52761273/8e681cb6-7a4f-4d1f-b34a-cefb642f44b7

FSI simulation (Turek benchmark, FSI2 case) of an elastic flag in incompressible channel flow.

The following is supported:

  • Solid mechanics
    • Finite strain elastodynamics, implementing a range of hyperelastic isotropic and anisotropic as well as viscous constitutive laws
    • Active stress for modeling of cardiac contraction mechanics
    • Quasi-static, generalized-alpha, or one-step theta time integration
    • Nearly incompressible as well as fully incompressible formulations
    • Inverse mechanics formulations for recovery of a stress-free reference configuration, and a so-called prestressing method (MULF)
    • Volumetric growth & remodeling: Prescribed, strain-, and stress-mediated growth
  • Fluid dynamics
    • Incompressible Navier-Stokes/Stokes equations, either in nonconservative or conservative formulation
    • Navier-Stokes/Stokes flow in an Arbitrary Lagrangian Eulerian (ALE) reference frame
    • Cahn-Hilliard-Navier-Stokes equations (Eulerian or ALE) for multiphase flow
    • BDF2, one-step theta, or generalized-alpha time integration
    • SUPG/PSPG stabilization for equal-order approximations of velocity and pressure
  • Scalar transport
    • Supports n scalar transport equations, either in Eulerian or ALE reference frame
    • Coupling between the individual equations provided by special constitutive laws or easily extensible by user
    • Can be hooked to any solid mechanics problem (fluid coupling to be implemented)
  • Lumped (0D) models
    • Systemic and pulmonary circulation flow models
    • 2-element as well as 4-element Windkessel models
    • Signalling network model
  • Coupling of different physics:
    • Fluid-solid interaction (FSI): Monolithic FSI in ALE formulation, single- or multiphase fluid
    • Monolithic coupling of 3D solid/fluid/ALE-fluid and FSI with lumped 0D flow models
    • Multiscale-in-time analysis of growth & remodeling (staggered solution of 3D-0D coupled solid-flow0d and G&R solid problem)
  • Fluid-reduced-solid interaction (FrSI)
    • Boundary subspace-projected physics-reduced solid model (incl. hyperelastic, viscous, and active parts) in an ALE fluid reference frame
  • POD-based model order reduction (MOR)
    • Projection-based model order reduction applicable to main fluid or solid field (also in a coupled problem), by either projecting the full problem or a boundary to a lower dimensional subspace spanned by POD modes

Still experimental / to-do:

  • Finite strain plasticity / sophisticated solid constitutive models beyond hyperelasticity
  • Electrophysiology
  • ... whatever might be wanted in some future ...

Documentation

Documentation can be viewed at https://ambit.readthedocs.io

Installation

In order to use Ambit, you need to install FEniCSx

Latest Ambit-compatible dolfinx release version: v0.11.0.post0
Latest tested Ambit-compatible dolfinx development version: to be tested...

Ambit can then be installed using pip, either the current release

python3 -m pip install ambit-fe

or latest development version:

python3 -m pip install git+https://github.com/marchirschvogel/ambit.git

Alternatively, you can pull a pre-built Docker image with FEniCSx and Ambit installed:

docker pull ghcr.io/marchirschvogel/ambit:latest

If a Docker image for development is desired, the following image contains all dependencies needed to install and run Ambit:

docker pull ghcr.io/marchirschvogel/ambit:devenv

Usage

Check out the examples for the basic problem types in demos/ to quickly get started running solid, fluid, or 0D model problems. Further, you can have a look at input files in tests/ and the file ambit_template.py in the main folder as example of all available input options.

Best, check if all testcases run and pass, by navigating to tests/ and executing

./runtests.py

Build your input file and run it with the command

mpiexec -n <NUMBER_OF_CORES> python3 your_file.py

References

Software paper:

Papers explicitly using and citing Ambit:

  • Hirschvogel M, Bonini M, Balmus M, Nordsletten D. Effective Block Preconditioners for Fluid Dynamics Coupled to Reduced Models of a Non-Local Nature. Computer Methods in Applied Mechanics and Engineering, 435, 2025, DOI: https://doi.org/10.1016/j.cma.2024.117541
  • Aróstica R, Nolte D, Brown A, Gebauer A, Karabelas E, Jilberto J, Salvador M, Bucelli M, Piersanti R, Osouli K, Augustin C, Finsberg H, Shi L, Hirschvogel M, Pfaller M, Africa PC, Gsell M, Marsden A, Nordsletten D, Regazzoni F, Plank G, Sundnes J, Dede' L, Peirlinck M, Vedula V, Wall WA, Bertoglio C. A software benchmark for cardiac elastodynamics. Computer Methods in Applied Mechanics and Engineering, 435, 2025, DOI: https://doi.org/10.1016/j.cma.2024.117485

Metadata

Release files for ambit-fe 2026.1.0

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

Source distribution (sdist)

Source distribution for ambit-fe 2026.1.0
File Size Uploaded Provenance Actions
ambit_fe-2026.1.0.tar.gz 359.7 kB Without provenance Details for ambit_fe-2026.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ambit-fe 2026.1.0
File Interpreter ABI Platform Actions
ambit_fe-2026.1.0-py3-none-any.whl Python 3 none any Details for ambit_fe-2026.1.0-py3-none-any.whl

Total release size: 701.4 kB

Release files / ambit_fe-2026.1.0.tar.gz

Download URL ambit_fe-2026.1.0.tar.gz
Size 359.7 kB
Tags Source
SHA-256 checksum
How to use checksums
bf1724b87ef8d1318f45847c9cfea4692f9391c925cf7b7633aec0b10538b30d
BLAKE2b-256 checksum
How to use checksums
6a9eb4016916155edd35e7334e4e7006628ca8533f358de92718c9d7bb37603b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.10.12

Release files / ambit_fe-2026.1.0-py3-none-any.whl

Download URL ambit_fe-2026.1.0-py3-none-any.whl
Size 341.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
732052ef28575c83de97086c79646621cef5730aa07257fcfc2e984d0923d354
BLAKE2b-256 checksum
How to use checksums
b431610100cefac0ddff1724221928c393f1f13cb57295dc732ebd5ee26f2b35
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.10.12

Security for ambit-fe 2026.1.0

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.

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