| Name | ambit-fe JSON |
| Version |
1.2.8
JSON |
| download |
| home_page | None |
| Summary | A FEniCS-based cardiovascular multi-physics solver |
| upload_time | 2024-05-26 14:05:54 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| 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. |
| keywords |
finite elements
solid mechanics
fluid mechanics
fluid-solid interaction
fsi
0d models
3d-0d coupling
monolithic
lumped-parameter models
model reduction
heart
circulation
cardiac
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# README #
[](https://doi.org/10.21105/joss.05744)
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](https://github.com/FEniCS/dolfinx#installation)
Latest Ambit-compatible dolfinx release version: v0.6.0\
Latest tested Ambit-compatible dolfinx development version dating to 19 Aug 2023
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 (including the dolfinx mixed branch):
```
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 ambit/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 ambit/tests and executing
```
./runtests.py
```
Build your input file and run it with the command
```
mpiexec -n <NUMBER_OF_CORES> python3 your_file.py
```
Raw data
{
"_id": null,
"home_page": null,
"name": "ambit-fe",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "finite elements, solid mechanics, fluid mechanics, fluid-solid interaction, fsi, 0D models, 3D-0D coupling, monolithic, lumped-parameter models, model reduction, heart, circulation, cardiac",
"author": null,
"author_email": "Marc Hirschvogel <marc.hirschvogel@ambit.net>",
"download_url": "https://files.pythonhosted.org/packages/d1/ed/c0a05c7a179f216720a57d67b32b91f2b31aa1952399be63cf50f306663f/ambit_fe-1.2.8.tar.gz",
"platform": null,
"description": "# README #\n\n[](https://doi.org/10.21105/joss.05744)\n\nAmbit 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.\nIt 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\nlinear algebra library PETSc.\n\nhttps://github.com/marchirschvogel/ambit/assets/52761273/a438ff55-9b37-4572-a1c5-499dd3cfba73\n\n**Heart cycle simulation of a generic bi-ventricular heart model coupled to a closed-loop circulation model.**\n\nhttps://github.com/marchirschvogel/ambit/assets/52761273/8e681cb6-7a4f-4d1f-b34a-cefb642f44b7\n\n**FSI simulation (Turek benchmark, FSI2 case) of an elastic flag in incompressible channel flow.**\n\nThe following is supported:\n\n* Solid mechanics\n - Finite strain elastodynamics, implementing a range of hyperelastic isotropic and anisotropic as well as viscous constitutive laws\n - Active stress for modeling of cardiac contraction mechanics\n - Quasi-static, generalized-alpha, or one-step theta time integration\n - Nearly incompressible as well as fully incompressible formulations (latter using pressure dofs)\n - Prestressing using MULF method in displacement formulation\n - Volumetric growth & remodeling\n* Fluid dynamics\n - Incompressible Navier-Stokes/Stokes equations, either in nonconservative or conservative formulation\n - Navier-Stokes/Stokes flow in an Arbitrary Lagrangian Eulerian (ALE) reference frame\n - One-step theta, or generalized-alpha time integration\n - SUPG/PSPG stabilization for equal-order approximations of velocity and pressure\n* Lumped (0D) models\n - Systemic and pulmonary circulation flow models\n - 2-element as well as 4-element Windkessel models\n - Signalling network model\n* Coupling of different physics:\n - Fluid-solid interaction (FSI): Monolithic FSI in ALE formulation using Lagrange multiplier\n - Monolithic coupling of 3D solid/fluid/ALE-fluid with lumped 0D flow models\n - Multiscale-in-time analysis of growth & remodeling (staggered solution of 3D-0D coupled solid-flow0d and G&R solid problem)\n* Fluid-reduced-solid interaction (FrSI)\n - Boundary subspace-projected physics-reduced solid model (incl. hyperelastic, viscous, and active parts) in an ALE fluid reference frame\n* POD-based model order reduction (MOR)\n - Projection-based model order reduction applicable to main fluid or solid field (also in a coupled problem), by either projecting\n the full problem or a boundary to a lower dimensional subspace spanned by POD modes\n\n- author: Dr.-Ing. Marc Hirschvogel, marc.hirschvogel@ambit.net\n\nStill experimental / to-do:\n\n- Finite strain plasticity\n- Electrophysiology/scalar transport\n- ... whatever might be wanted in some future ...\n\n### Documentation ###\n\nDocumentation can be viewed at https://ambit.readthedocs.io\n\n### Installation ###\n\nIn order to use Ambit, you need to [install FEniCSx](https://github.com/FEniCS/dolfinx#installation)\n\nLatest Ambit-compatible dolfinx release version: v0.6.0\\\nLatest tested Ambit-compatible dolfinx development version dating to 19 Aug 2023\n\nAmbit can then be installed using pip, either the current release\n```\npython3 -m pip install ambit-fe\n```\n\nor latest development version:\n```\npython3 -m pip install git+https://github.com/marchirschvogel/ambit.git\n```\n\nAlternatively, you can pull a pre-built Docker image with FEniCSx and Ambit installed:\n```\ndocker pull ghcr.io/marchirschvogel/ambit:latest\n```\n\nIf a Docker image for development is desired, the following image contains all dependencies needed to install and run Ambit (including the dolfinx mixed branch):\n```\ndocker pull ghcr.io/marchirschvogel/ambit:devenv\n```\n\n### Usage ###\n\nCheck 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\nat input files in ambit/tests and the file ambit_template.py in the main folder as example of all available input options.\n\n\nBest, check if all testcases run and pass, by navigating to ambit/tests and executing\n```\n./runtests.py\n```\n\nBuild your input file and run it with the command\n```\nmpiexec -n <NUMBER_OF_CORES> python3 your_file.py\n```\n",
"bugtrack_url": null,
"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. ",
"summary": "A FEniCS-based cardiovascular multi-physics solver",
"version": "1.2.8",
"project_urls": {
"Bug Tracker": "https://github.com/marchirschvogel/ambit/issues",
"Homepage": "https://github.com/marchirschvogel/ambit"
},
"split_keywords": [
"finite elements",
" solid mechanics",
" fluid mechanics",
" fluid-solid interaction",
" fsi",
" 0d models",
" 3d-0d coupling",
" monolithic",
" lumped-parameter models",
" model reduction",
" heart",
" circulation",
" cardiac"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "206e7f5da4ea8693268ca8cc0bf7ef197124729c399bd9599e728044abf43ee3",
"md5": "914b55b249f64e10311c3d55ba5b80bc",
"sha256": "ef93f6195dad397bb102b4aa76b39425e82e4eba3a55e1e722bf9995734be24c"
},
"downloads": -1,
"filename": "ambit_fe-1.2.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "914b55b249f64e10311c3d55ba5b80bc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 249062,
"upload_time": "2024-05-26T14:05:50",
"upload_time_iso_8601": "2024-05-26T14:05:50.990442Z",
"url": "https://files.pythonhosted.org/packages/20/6e/7f5da4ea8693268ca8cc0bf7ef197124729c399bd9599e728044abf43ee3/ambit_fe-1.2.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d1edc0a05c7a179f216720a57d67b32b91f2b31aa1952399be63cf50f306663f",
"md5": "c172a34d054dadb6f6b8a03699a83f90",
"sha256": "c05a259528b14cb8564c1966b719ae1089a04921399e5fb7357fcf121f39d14a"
},
"downloads": -1,
"filename": "ambit_fe-1.2.8.tar.gz",
"has_sig": false,
"md5_digest": "c172a34d054dadb6f6b8a03699a83f90",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 257435,
"upload_time": "2024-05-26T14:05:54",
"upload_time_iso_8601": "2024-05-26T14:05:54.313397Z",
"url": "https://files.pythonhosted.org/packages/d1/ed/c0a05c7a179f216720a57d67b32b91f2b31aa1952399be63cf50f306663f/ambit_fe-1.2.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-26 14:05:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "marchirschvogel",
"github_project": "ambit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ambit-fe"
}
