Skip to content
Snippets Groups Projects
Commit 51258f03 authored by Yue Wang's avatar Yue Wang Committed by Timo Koch
Browse files

[materials] add descriptions of friction laws into subgoup page

parent 6c5d5ee4
No related branches found
No related tags found
1 merge request!3734Introduce subcategories in fluidmatrixinteractions with descriptions
......@@ -88,6 +88,7 @@ The following laws are implemented:
which is called bottom shear stress. The bottom shear stress is
needed to calculate on the one hand the loss of momentum due to
bottom friction and on the other hand the bedload transport rate.
The following laws can be implemented by deriving from the abstract base class, where the LET mobility model by Lomeland et al. \cite Lomeland2005 can be employed to introduce an artificial water depth, which helps to limit friction in scenarios with small water depths.
@ingroup Fluidmatrixinteractions
@defgroup DispersionTensors Dispersion Tensors
......
......@@ -10,6 +10,11 @@
#include <dune/common/fmatrix.hh>
#include <dumux/common/properties.hh>
/*!
* \ingroup DispersionTensors
* \copydetails Dumux::FullDispersionTensor
*/
namespace Dumux {
/*!
......
......@@ -13,15 +13,11 @@
#include <dune/common/fvector.hh>
namespace Dumux {
/*!
* \ingroup FrictionLaws
* \brief Implementation of the abstract base class for friction laws.
*
* Friction laws calculate the stress between the flowing fluid and the bottom,
* which is called bottom shear stress. The bottom shear stress is
* needed to calculate on the one hand the loss of momentum due to
* bottom friction and on the other hand the bedload transport rate.
*
* A LET mobility model of Lomeland et al. 2005 \cite Lomeland2005 can be used to add an
* artificial water depth to limit the friction for small water depths.
*
......
......@@ -13,6 +13,11 @@
#include "frictionlaw.hh"
namespace Dumux {
/*!
* \addtogroup FrictionLaws
* \copydetails Dumux::FrictionLawManning
*/
/*!
* \ingroup FrictionLaws
* \brief Implementation of the friction law after Manning.
......
......@@ -13,6 +13,11 @@
#include "frictionlaw.hh"
namespace Dumux {
/*!
* \addtogroup FrictionLaws
* \copydetails Dumux::FrictionLawNikuradse
*/
/*!
* \ingroup FrictionLaws
* \brief Implementation of the friction law after Nikuradse.
......
......@@ -10,6 +10,10 @@
#include "frictionlaw.hh"
namespace Dumux {
/*!
* \addtogroup FrictionLaws
* \copydetails Dumux::FrictionLawNoFriction
*/
/*!
* \ingroup FrictionLaws
......
......@@ -14,6 +14,10 @@
#include <dumux/material/fluidmatrixinteractions/frictionlaws/frictionlaw.hh>
namespace Dumux {
/*!
* \addtogroup FrictionLaws
* \copydetails Dumux::FrictionLawViscousNoSlip
*/
/*!
* \ingroup FrictionLaws
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment