Ambit – A FEniCS-based cardiovascular multi-physics solver

Ambit – A FEniCS-based cardiovascular multi-physics solver - Published in JOSS (2024)

https://github.com/marchirschvogel/ambit

Science Score: 98.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 10 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Scientific Fields

Mathematics Computer Science - 37% confidence
Last synced: 4 months ago · JSON representation ·

Repository

FEniCSx-based cardiovascular multi-physics solver

Basic Info
  • Host: GitHub
  • Owner: marchirschvogel
  • License: mit
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 35 MB
Statistics
  • Stars: 51
  • Watchers: 3
  • Forks: 10
  • Open Issues: 0
  • Releases: 9
Created almost 5 years ago · Last pushed 4 months ago
Metadata Files
Readme Contributing License Citation

README.md

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/marchirschvogel/ambit/assets/52761273/a438ff55-9b37-4572-a1c5-499dd3cfba73

Heart cycle simulation of a generic bi-ventricular heart model 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 (latter using pressure dofs)
    • Prestressing using MULF method in displacement formulation
    • Volumetric growth & remodeling
  • 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
    • One-step theta, or generalized-alpha time integration
    • SUPG/PSPG stabilization for equal-order approximations of velocity and pressure
  • 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 using Lagrange multiplier
    • Monolithic coupling of 3D solid/fluid/ALE-fluid 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
  • author: Dr.-Ing. Marc Hirschvogel, marc.hirschvogel@ambit.net

Still experimental / to-do:

  • Finite strain plasticity
  • Electrophysiology/scalar transport
  • ... 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: N/A\ Latest tested Ambit-compatible dolfinx development version dating to 6 Aug 2025

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:

  • Hirschvogel M. Ambit – A FEniCS-based cardiovascular multi-physics solver. Journal of Open Source Software, 9(93), 2024, DOI: https://doi.org/10.21105/joss.05744

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

Owner

  • Name: Marc Hirschvogel
  • Login: marchirschvogel
  • Kind: user
  • Location: Munich / London / Milan / Berlin
  • Company: Bundesanstalt für Materialforschung und -prüfung (BAM), Berlin, Germany

JOSS Publication

Ambit – A FEniCS-based cardiovascular multi-physics solver
Published
January 16, 2024
Volume 9, Issue 93, Page 5744
Authors
Marc Hirschvogel ORCID
Department of Biomedical Engineering, School of Biomedical Engineering & Imaging Sciences, King's College London, London, United Kingdom, MOX, Dipartimento di Matematica, Politecnico di Milano, Milan, Italy
Editor
Kevin M. Moerman ORCID
Tags
cardiovascular mechanics finite strain solid mechanics nonlinear elastodynamics fluid dynamics 0D lumped models fluid-solid interaction fsi multi-physics coupling

Citation (CITATION.cff)

cff-version: "1.2.0"
authors:
- family-names: Hirschvogel
  given-names: Marc
  orcid: "https://orcid.org/0000-0002-4575-9120"
doi: 10.5281/zenodo.10501275
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Hirschvogel
    given-names: Marc
    orcid: "https://orcid.org/0000-0002-4575-9120"
  date-published: 2024-01-16
  doi: 10.21105/joss.05744
  issn: 2475-9066
  issue: 93
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 5744
  title: Ambit – A FEniCS-based cardiovascular multi-physics solver
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.05744"
  volume: 9
title: Ambit – A FEniCS-based cardiovascular multi-physics solver

GitHub Events

Total
  • Release event: 1
  • Watch event: 15
  • Push event: 15
  • Fork event: 4
  • Create event: 1
Last Year
  • Release event: 1
  • Watch event: 15
  • Push event: 15
  • Fork event: 4
  • Create event: 1

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 698
  • Total Committers: 4
  • Avg Commits per committer: 174.5
  • Development Distribution Score (DDS): 0.415
Past Year
  • Commits: 37
  • Committers: 1
  • Avg Commits per committer: 37.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Marc Hirschvogel m****l@s****e 408
Marc Hirschvogel m****l@p****t 142
Marc Hirschvogel m****l@d****m 111
Marc Hirschvogel 5****l 37
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 8
  • Total pull requests: 0
  • Average time to close issues: about 1 month
  • Average time to close pull requests: N/A
  • Total issue authors: 4
  • Total pull request authors: 0
  • Average comments per issue: 1.63
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • finsberg (4)
  • CZHU20 (1)
  • marchirschvogel (1)
  • jorgensd (1)
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 242 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 21
  • Total maintainers: 1
pypi.org: ambit-fe

A FEniCS-based cardiovascular multi-physics solver

  • Homepage: https://github.com/marchirschvogel/ambit
  • Documentation: https://ambit-fe.readthedocs.io/
  • License: MIT License Copyright (c) 2024 Marc Hirschvogel Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  • Latest release: 1.2.9
    published over 1 year ago
  • Versions: 21
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 242 Last month
Rankings
Dependent packages count: 7.5%
Average: 38.6%
Dependent repos count: 69.8%
Maintainers (1)
Last synced: 4 months ago

Dependencies

.github/workflows/test.yml actions
.github/workflows/docker-image.yml actions
  • actions/checkout v3 composite
  • docker/build-push-action f2a1d5e99d037542a71f64918e516c093c6f3fc4 composite
  • docker/login-action 65b78e6e13532edd9afa3aa52ac7964289d1a9c1 composite
  • docker/metadata-action 9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7 composite
docker/Dockerfile docker
  • ghcr.io/fenics/dolfinx/dolfinx@sha256 1f374e90d5e918a71a4bdba994bf434cdaf84fedc47aa11ac33295864180fb76 build
pyproject.toml pypi
  • mpmath *
  • sympy *
docs/requirements.txt pypi
  • myst_parser *
  • sphinx-rtd-theme *
  • sphinxcontrib-bibtex *