turtleFSI
turtleFSI: A Robust and Monolithic FEniCS-based Fluid-Structure Interaction Solver - Published in JOSS (2020)
Science Score: 49.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 3 DOI reference(s) in README -
✓Academic publication links
Links to: joss.theoj.org -
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.8%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
Monolithic Fluid-Structure Interaction (FSI) solver
Basic Info
- Host: GitHub
- Owner: KVSlab
- License: gpl-3.0
- Language: Python
- Default Branch: master
- Homepage: https://turtlefsi2.readthedocs.io/en/latest/
- Size: 52.2 MB
Statistics
- Stars: 70
- Watchers: 9
- Forks: 25
- Open Issues: 7
- Releases: 7
Topics
Metadata Files
README.md
turtleFSI - a Fluid-Structure Interaction Solver
To the left we show a turtle swimming (in turtleFSI), and to the right, the classical Turek benchmark (FSI2).
Description
turtleFSI is a monolithic fluid-structure interaction solver written in FEniCS, and has out-of-the-box high performance capabilities. The goal of turtleFSI is to provide research groups, and other individuals, with a simple, but robust solver to investigate fluid structure interaction problems.
Authors
turtleFSI is developed by:
- Andreas Slyngstad
- Sebastian Gjertsen
- Aslak W. Bergersen
- Alban Souche
- Kristian Valen-Sendstad
Licence
turtleFSI is licensed under the GNU GPL, version 3 or (at your option) any later version. turtleFSI is Copyright (2016-2019) by the authors.
Documentation
For an introduction to turtleFSI, and tutorials, please refer to the documentation.
If you wish to use turtleFSI for journal publications, please refer to the JOSS publication:
Bergersen et al., (2020). turtleFSI: A Robust and Monolithic FEniCS-based Fluid-Structure Interaction Solver. Journal of Open Source Software, 5(50), 2089, https://doi.org/10.21105/joss.02089
Installation
turtleFSI is build upon the open source Finite Elements FEniCS project (version 2018.1.0 or 2019.1.0). Please refer to the respective FEniCS documentation for installing the dependencies on your system.
However, if you are using Linux or MaxOSX you can install turtleFSI through anaconda::
conda create -n your_environment -c conda-forge turtleFSI
You can then activate your environment by runing source activate your_environment.
You are now all set, and can start running fluid-structure interaction simulations.
Use
Run turtleFSI with all the default parameters::
turtleFSI
See all the command line parameters run the following command::
turtleFSI -h
Run a specific problem file::
turtleFSI --problem [path_to_problem]
When calling a specific problem file, turtleFSI will first look for the file name locally, then check if the file name is present in the directory "/turtleFSI/problems/". Please refere to the documentation to learn how to define a new problem file and for a more complete description of usage.
Contact
The latest version of this software can be obtained from
https://github.com/KVSlab/turtleFSI
Please report bugs and other issues through the issue tracker at:
https://github.com/KVSlab/turtleFSI/issues
Owner
- Name: KVSlab
- Login: KVSlab
- Kind: organization
- Repositories: 6
- Profile: https://github.com/KVSlab
GitHub Events
Total
- Create event: 2
- Release event: 1
- Issues event: 3
- Watch event: 11
- Delete event: 1
- Issue comment event: 5
- Push event: 2
- Pull request event: 6
- Fork event: 1
Last Year
- Create event: 2
- Release event: 1
- Issues event: 3
- Watch event: 11
- Delete event: 1
- Issue comment event: 5
- Push event: 2
- Pull request event: 6
- Fork event: 1
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Aslak Bergersen | a****n@g****m | 95 |
| Kei | w****5@g****m | 94 |
| albansouche | a****e@g****m | 63 |
| DB_Ubuntu | d****0@g****m | 22 |
| Jørgen S. Dokken | d****n@s****o | 18 |
| johannesring | j****g@g****m | 13 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 49
- Total pull requests: 63
- Average time to close issues: about 1 month
- Average time to close pull requests: 3 days
- Total issue authors: 14
- Total pull request authors: 5
- Average comments per issue: 4.65
- Average comments per pull request: 0.7
- Merged pull requests: 60
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 2
- Pull requests: 2
- Average time to close issues: 28 days
- Average time to close pull requests: about 4 hours
- Issue authors: 2
- Pull request authors: 2
- Average comments per issue: 2.0
- Average comments per pull request: 1.5
- Merged pull requests: 2
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- keiyamamo (18)
- zhangmuElias (11)
- dlorod55 (4)
- johannesring (4)
- jorgensd (3)
- xfdywy (1)
- ArtemioA (1)
- jack-kcl (1)
- dbruneau-mie (1)
- mrazzaq19 (1)
- Panchal1810 (1)
- AMoriel (1)
- Badtreater (1)
- Han10th (1)
Pull Request Authors
- keiyamamo (37)
- johannesring (11)
- dbruneau-mie (9)
- jorgensd (3)
- aslakbergersen (3)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
- Total downloads: unknown
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 4
conda-forge.org: turtlefsi
TurtleFSI is a monolithic fluid structure intreaction solver, solving for Navier-Stokes in the fluid, and hyperelasticity in the solid. TurtleFSI benefits from the HPC capabilities in FEniCS.
- Homepage: https://turtlefsi2.readthedocs.io/en/latest/
- License: GPL-3.0-or-later
-
Latest release: 1.5
published over 5 years ago
Rankings
Dependencies
- actions/checkout v3 composite
- condaforge/mambaforge latest build
- cppimport *