This page is only a stub. I'll finish it when I find time. If you feel that you can improve it: go ahead
A three-dimensional two-phase flow solver, SedFoam, is presented for sediment transport applications. The solver is based on twoPhaseEulerFoam available in the 2.1.0 release of the open-source CFD software OpenFOAM. In this approach the sediment phase is modelled as a continuum, and constitutive laws have to be prescribed for the sediment stresses. In the proposed solver, two different inter-granular 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-$ and a $k-$ model. The numerical implementation is first demonstrated by two validation test cases, sedimentation of suspension and laminar bed-load, and two applications are then shown to illustrate the capabilities of to deal with complex turbulent sediment transport problems. Different combinations of inter-granular stress and turbulence models are tested. The source code and tutorial cases are disseminated at the public website: http://github.com/sedfoam/sedfoam and detailed tutorial description and documentation can be found at http://servforge.legi.grenoble-inp.fr/pub/soft-sedfoam/.
2 References and Citing
If you want to reference the model in your publications it should be called SedFoam, and state that is an evolution of twoPhaseEulerFoam, referencing any of the following research papers, in which the SedFoam implementation, validation and application details are published:
SedFoam-2.0: a 3D two-phase flow numerical model for sediment transport Julien Chauchat, Zhen Cheng, Tim Nagel, Cyrille Bonamy, and Tian-Jian Hsu.  Geosci. Model Dev. Discuss. http://dx.doi.org/10.5194/gmd-2017-101
For 5.0 OpenFOAM (or version 6 or OpenFOAM Plus version 1806 to 1912), Download the official SedFoam-3.0 package:
git clone http://github.org/sedfoam/sedfoam/
For 2.4.0 OpenFOAM, you can use the old version (SedFoam-2.0) : https://github.com/SedFoam/sedfoam/releases/tag/v2.0
This is a short overview of the installation process. A more detailed description is found here (consult these pages if you have problems during installation)
In the directory of the sources just do
and everything should be built.
You can found the explanations of the included tutorial here.
6 SedFOAM license
Copyright © 2018 by Cyrille Bonamy, Julien Chauchat, Tim Nagel, Antoine Mathieu, Zhen Cheng and Tian-Jian Hsu.
Permission to use, copy, modify, and distribute this software and its documentation under the terms of the GNU General Public License is hereby granted. No representations are made about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty. See the GNU General Public License for more details.