From 51258f03f39ea42ce2adc44e638044088b47d60c Mon Sep 17 00:00:00 2001
From: Yue Wang <yue.wang@iws.uni-stuttgart.de>
Date: Tue, 25 Jun 2024 09:24:57 +0200
Subject: [PATCH] [materials] add descriptions of friction laws into subgoup
 page

---
 doc/doxygen/groups/material.md                              | 1 +
 .../fluidmatrixinteractions/dispersiontensors/fulltensor.hh | 5 +++++
 .../fluidmatrixinteractions/frictionlaws/frictionlaw.hh     | 6 +-----
 .../fluidmatrixinteractions/frictionlaws/manning.hh         | 5 +++++
 .../fluidmatrixinteractions/frictionlaws/nikuradse.hh       | 5 +++++
 .../fluidmatrixinteractions/frictionlaws/nofriction.hh      | 4 ++++
 .../fluidmatrixinteractions/frictionlaws/viscousnoslip.hh   | 4 ++++
 7 files changed, 25 insertions(+), 5 deletions(-)

diff --git a/doc/doxygen/groups/material.md b/doc/doxygen/groups/material.md
index 492279cd43..c6d78ce750 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 f6859ecf32..79b2994e2e 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 652bc2f831..ae7e15d303 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 3a69df5c4e..e0bfaf6abc 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 2fdf42c971..3dc13d61a9 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 144c5ed1d3..d59f197b07 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 4d4ff95d78..c362706440 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
-- 
GitLab