Science Score: 67.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 8 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.7%) to scientific vocabulary
Keywords
Repository
SedFoam solver for OpenFoam toolbox
Basic Info
- Host: GitHub
- Owner: SedFoam
- License: gpl-3.0
- Language: C++
- Default Branch: master
- Homepage: https://sedfoam.github.io
- Size: 578 MB
Statistics
- Stars: 106
- Watchers: 14
- Forks: 68
- Open Issues: 2
- Releases: 8
Topics
Metadata Files
README.md
sedfoam
This repository provides the SedFoam solver.
Status
The sedfoam solver is in development and is not yet fully functional.
Pull requests are encouraged!
Features
A three-dimensional two-phase flow solver, SedFoam, has been developed for sediment transport applications. The solver is extended from twoPhaseEulerFoam available in the 2.1.0 release of the open-source CFD (computational fluid dynamics) toolbox OpenFOAM. In this approach the sediment phase is modeled as a continuum, and constitutive laws have to be prescribed for the sediment stresses. In the proposed solver, two different intergranular stress models are implemented: the kinetic theory of granular flows and the dense granular flow rheology μ(I). For the fluid stress, laminar or turbulent flow regimes can be simulated and three different turbulence models are available for sediment transport: a simple mixing length model (one-dimensional configuration only), a k − ε, a classical k − ω and a k − ω from Wilcox (2006).
Installation
bash
cd $WM_PROJECT_USER_DIR
git clone --recurse-submodules https://github.com/sedfoam/sedfoam sedfoam
cd sedfoam
./Allwclean
./Allwmake
Usage
There are tutorials located in tutorials and details can be found here.
How to cite
The sedfoam solver should be referenced using the GMD paper :
Julien Chauchat, Zhen Cheng, Tim Nagel, Cyrille Bonamy, and Tian-Jian Hsu (2017) SedFoam-2.0: a 3-D two-phase flow numerical model for sediment transport (Geosci. Model Dev., 10, 4367-4392)
and the reference in which a specific configuration and/or feature has been first presented (please see list of references in the documentation).
If you are using a sedFoam version without modification, you should also refer to the Zenodo DOI of the version, current version is
Publications
Publications of research work using sedFoam are available Here.
Developers
- Cyrille Bonamy
- Julien Chauchat
- Antoine Mathieu
- Eduard Puig Montellà
- Rémi Chassagne
- Zhen Cheng
- Tim Nagel
- Benjamin Tsai
- Tian-Jian Hsu
Contributors
- Ali Salimi-Tarazouj
- Hugo Divel
- Pablo Higuera
Acknowledgements
OpenFOAM is the free, open source CFD software developed primarily by OpenCFD Ltd since 2004. The OpenFOAM trademark is owned by OpenCFD Ltd.

Owner
- Name: SedFoam
- Login: SedFoam
- Kind: organization
- Repositories: 2
- Profile: https://github.com/SedFoam
Citation (CITATION.cff)
authors:
- family-names: "Bonamy"
given-names: "Cyrille"
orcid: "https://orcid.org/0000-0003-3868-7090"
- family-names: "Chauchat"
given-names: "Julien"
orcid: "https://orcid.org/0000-0002-5979-0620"
- family-names: "Hsu"
given-names: "Tian-Jian"
- family-names: "Puig-Montella"
given-names: "Eduard"
orcid: "https://orcid.org/0000-0001-7184-0945"
- family-names: "Chassagne"
given-names: "Rémi"
- family-names: "Mathieu"
given-names: "Antoine"
orcid: "https://orcid.org/0000-0003-1607-4787"
- family-names: "Cheng"
given-names: "Zhen"
- family-names: "Nagel"
given-names: "Tim"
- family-names: "Salimi-Tarazouj"
given-names: "Ali"
- family-names: "Tsai"
given-names: "Benjamin"
- family-names: "Higuera"
given-names: "Pablo"
title: "sedfoam"
doi: 10.5281/zenodo.836642
url: "https://github.com/sedfoam/sedfoam"
cff-version: "1.2.0"
date-released: 2021-07-13
message: "If you use this software, please cite it as below."
version: 2312
CodeMeta (codemeta.json)
{
"@context": "https://doi.org/10.5063/schema/codemeta-2.0",
"@type": "SoftwareSourceCode",
"license": "https://spdx.org/licenses/GPL-3.0-or-later",
"codeRepository": "https://github.com/sedfoam/sedfoam",
"contIntegration": "https://circleci.com/gh/SedFoam/sedfoam",
"dateModified": "2022-07-08",
"issueTracker": "https://github.com/sedfoam/sedfoam/issues",
"name": "sedFoam",
"version": "2412",
"identifier": "https://doi.org/10.5281/zenodo.836642",
"description": "A three-dimensional two-phase flow solver, SedFoam, has been developed for sediment transport applications. The solver is extended from twoPhaseEulerFoam available in the 2.1.0 release of the open-source CFD (computational fluid dynamics) toolbox OpenFOAM. In this approach the sediment phase is modeled as a continuum, and constitutive laws have to be prescribed for the sediment stresses. In the proposed solver, two different intergranular stress models are implemented: the kinetic theory of granular flows and the dense granular flow rheology (I). For the fluid stress, laminar or turbulent flow regimes can be simulated and three different turbulence models are available for sediment transport: a simple mixing length model (one-dimensional configuration only), a k, a classical k and a k from Wilcox (2006).",
"applicationCategory": "Fluid Mechanics",
"developmentStatus": "active",
"referencePublication": "https://doi.org/10.5194/gmd-10-4367-2017",
"keywords": [
"scour",
"diphasic",
"sediment",
"Fluid Mechanics"
],
"programmingLanguage": [
"C++",
"OpenFoam"
],
"operatingSystem": [
"Linux",
"Windows"
],
"softwareRequirements": [
"OpenFoam (ESI version)"
],
"relatedLink": [
"https://sedfoam.github.io/",
"https://www.openfoam.com/"
],
"author": [
{
"@type": "Person",
"@id": "https://orcid.org/0000-0003-3868-7090",
"givenName": "Cyrille",
"familyName": "Bonamy",
"email": "cyrille.bonamy@cnrs.fr",
"affiliation": {
"@type": "Organization",
"name": "LEGI - CNRS - UGA"
}
},
{
"@type": "Person",
"@id": "https://orcid.org/0000-0002-5979-0620",
"givenName": "Julien",
"familyName": "Chauchat",
"email": "julien.chauchat@univ-grenoble-alpes.fr",
"affiliation": {
"@type": "Organization",
"name": "LEGI - CNRS - UGA"
}
},
{
"@type": "Person",
"@id": "https://orcid.org/0000-0003-1607-4787",
"givenName": "Antoine",
"familyName": "Mathieu",
"email": "amathieu@udel.edu",
"affiliation": {
"@type": "Organization",
"name": "LEGI - CNRS - UGA - University of Delaware"
}
},
{
"@type": "Person",
"@id": "https://orcid.org/0000-0001-7184-0945",
"givenName": "Eduard",
"familyName": "Puig Montella",
"email": "Eduard.Puig-Montella@univ-grenoble-alpes.fr",
"affiliation": {
"@type": "Organization",
"name": "LEGI - CNRS - UGA"
}
},
{
"@type": "Person",
"givenName": "Rmi",
"familyName": "Chassagne",
"email": "remi.chassagne@univ-grenoble-alpes.fr",
"affiliation": {
"@type": "Organization",
"name": "LEGI - CNRS - UGA"
}
},
{
"@type": "Person",
"givenName": "Zhen",
"familyName": "Cheng",
"email": "zcheng@udel.edu",
"affiliation": {
"@type": "Organization",
"name": "University of Delaware, Civil & Environmental Engineering, Center for Applied Coastal Research Now at Convergence CFD"
}
},
{
"@type": "Person",
"givenName": "Tim",
"familyName": "Nagel",
"email": "tim.nagel@meteo.fr",
"affiliation": {
"@type": "Organization",
"name": "Mto France"
}
},
{
"@type": "Person",
"givenName": "Benjamin",
"familyName": "Tsai",
"email": "btsai@udel.edu",
"affiliation": {
"@type": "Organization",
"name": "University of Delaware, Civil & Environmental Engineering, Center for Applied Coastal Research Now at Convergence CFD"
}
},
{
"@type": "Person",
"givenName": "Tian-Jian",
"familyName": "Hsu",
"email": "thsu@udel.edu",
"affiliation": {
"@type": "Organization",
"name": "University of Delaware, Civil & Environmental Engineering, Center for Applied Coastal Research Now at Convergence CFD"
}
}
],
"contributor": [
{
"@type": "Person",
"givenName": "Ali",
"familyName": "Salimi-Tarazouj",
"affiliation": {
"@type": "Organization",
"name": "University of Delaware, Civil & Environmental Engineering, Center for Applied Coastal Research Now at Convergence CFD"
}
},
{
"@type": "Person",
"givenName": "Hugo",
"familyName": "Divel",
"affiliation": {
"@type": "Organization",
"name": "LEGI - CNRS - UGA"
}
},
{
"@type": "Person",
"givenName": "Pablo",
"familyName": "Higuera",
"affiliation": {
"@type": "Organization",
"name": "The University of Auckland"
}
}
]
}
GitHub Events
Total
- Issues event: 6
- Watch event: 15
- Issue comment event: 6
- Push event: 31
- Pull request review event: 4
- Pull request review comment event: 8
- Pull request event: 37
- Fork event: 17
- Create event: 1
Last Year
- Issues event: 6
- Watch event: 15
- Issue comment event: 6
- Push event: 31
- Pull request review event: 4
- Pull request review comment event: 8
- Pull request event: 37
- Fork event: 17
- Create event: 1
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 2
- Total pull requests: 17
- Average time to close issues: 19 days
- Average time to close pull requests: 4 days
- Total issue authors: 2
- Total pull request authors: 7
- Average comments per issue: 2.0
- Average comments per pull request: 0.0
- Merged pull requests: 17
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 2
- Pull requests: 17
- Average time to close issues: 19 days
- Average time to close pull requests: 4 days
- Issue authors: 2
- Pull request authors: 7
- Average comments per issue: 2.0
- Average comments per pull request: 0.0
- Merged pull requests: 17
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- Paperanti1983 (1)
- dml177825934065 (1)
- risktaker5 (1)
- arbaz-khalid (1)
Pull Request Authors
- CyrilleBonamy (12)
- puigmontella (7)
- remichassagne (4)
- alban3 (1)
- benjaminb115 (1)
- dralmanohar (1)
- jchauchat (1)
- dependabot[bot] (1)
- ggiamagas (1)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- opencfd/openfoam2106-default latest build
