diff --git a/doc/doxygen/groups/material.md b/doc/doxygen/groups/material.md index 492279cd4373c5f732face19ebd58468ef509839..c6d78ce750d3990532f20b0449fc832f9db3e8de 100644 --- a/doc/doxygen/groups/material.md +++ b/doc/doxygen/groups/material.md @@ -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 diff --git a/dumux/material/fluidmatrixinteractions/dispersiontensors/fulltensor.hh b/dumux/material/fluidmatrixinteractions/dispersiontensors/fulltensor.hh index f6859ecf32ff05971d35c8ea7e07996384449ed1..79b2994e2e7e8617db4e33e0f933cb6571f1ccdf 100644 --- a/dumux/material/fluidmatrixinteractions/dispersiontensors/fulltensor.hh +++ b/dumux/material/fluidmatrixinteractions/dispersiontensors/fulltensor.hh @@ -10,6 +10,11 @@ #include <dune/common/fmatrix.hh> #include <dumux/common/properties.hh> +/*! + * \ingroup DispersionTensors + * \copydetails Dumux::FullDispersionTensor + */ + namespace Dumux { /*! diff --git a/dumux/material/fluidmatrixinteractions/frictionlaws/frictionlaw.hh b/dumux/material/fluidmatrixinteractions/frictionlaws/frictionlaw.hh index 652bc2f83128701d9d6da61e14fb3d8eff628e5a..ae7e15d303d3ee65663fdaa4a82821fe09632424 100644 --- a/dumux/material/fluidmatrixinteractions/frictionlaws/frictionlaw.hh +++ b/dumux/material/fluidmatrixinteractions/frictionlaws/frictionlaw.hh @@ -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. * diff --git a/dumux/material/fluidmatrixinteractions/frictionlaws/manning.hh b/dumux/material/fluidmatrixinteractions/frictionlaws/manning.hh index 3a69df5c4ecdb4fbe44e844f2db87e18c1e0d80b..e0bfaf6abc0268ed87b1ea3a59e9115f8f1ab61a 100644 --- a/dumux/material/fluidmatrixinteractions/frictionlaws/manning.hh +++ b/dumux/material/fluidmatrixinteractions/frictionlaws/manning.hh @@ -13,6 +13,11 @@ #include "frictionlaw.hh" namespace Dumux { +/*! + * \addtogroup FrictionLaws + * \copydetails Dumux::FrictionLawManning + */ + /*! * \ingroup FrictionLaws * \brief Implementation of the friction law after Manning. diff --git a/dumux/material/fluidmatrixinteractions/frictionlaws/nikuradse.hh b/dumux/material/fluidmatrixinteractions/frictionlaws/nikuradse.hh index 2fdf42c971956aeec4b3e3c782f79db682053654..3dc13d61a9f47ca18154fee382455208f4355761 100644 --- a/dumux/material/fluidmatrixinteractions/frictionlaws/nikuradse.hh +++ b/dumux/material/fluidmatrixinteractions/frictionlaws/nikuradse.hh @@ -13,6 +13,11 @@ #include "frictionlaw.hh" namespace Dumux { +/*! + * \addtogroup FrictionLaws + * \copydetails Dumux::FrictionLawNikuradse + */ + /*! * \ingroup FrictionLaws * \brief Implementation of the friction law after Nikuradse. diff --git a/dumux/material/fluidmatrixinteractions/frictionlaws/nofriction.hh b/dumux/material/fluidmatrixinteractions/frictionlaws/nofriction.hh index 144c5ed1d31642561f324150cf0bcdabd7332d90..d59f197b075393e8abfedf6c97e8ada5438a9a7c 100644 --- a/dumux/material/fluidmatrixinteractions/frictionlaws/nofriction.hh +++ b/dumux/material/fluidmatrixinteractions/frictionlaws/nofriction.hh @@ -10,6 +10,10 @@ #include "frictionlaw.hh" namespace Dumux { +/*! + * \addtogroup FrictionLaws + * \copydetails Dumux::FrictionLawNoFriction + */ /*! * \ingroup FrictionLaws diff --git a/dumux/material/fluidmatrixinteractions/frictionlaws/viscousnoslip.hh b/dumux/material/fluidmatrixinteractions/frictionlaws/viscousnoslip.hh index 4d4ff95d78791b90de27523ec955de5ddb9a4234..c362706440c7a0c5055744a333c39e02f0767d0c 100644 --- a/dumux/material/fluidmatrixinteractions/frictionlaws/viscousnoslip.hh +++ b/dumux/material/fluidmatrixinteractions/frictionlaws/viscousnoslip.hh @@ -14,6 +14,10 @@ #include <dumux/material/fluidmatrixinteractions/frictionlaws/frictionlaw.hh> namespace Dumux { +/*! + * \addtogroup FrictionLaws + * \copydetails Dumux::FrictionLawViscousNoSlip + */ /*! * \ingroup FrictionLaws