From d0bdff9380feac34da5e4b71b86fe14fbce09ee2 Mon Sep 17 00:00:00 2001
From: Martin Utz <martin.utz@baw.de>
Date: Thu, 14 Dec 2023 09:53:35 +0100
Subject: [PATCH] [doc][fluidmatrixinteractions] minor change of the
frictionlaws description
---
doc/doxygen/groups/material.md | 2 +-
.../fluidmatrixinteractions/frictionlaws/frictionlaw.hh | 2 +-
dumux/material/fluidmatrixinteractions/frictionlaws/manning.hh | 2 +-
.../material/fluidmatrixinteractions/frictionlaws/nikuradse.hh | 2 +-
.../material/fluidmatrixinteractions/frictionlaws/nofriction.hh | 2 +-
5 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/doc/doxygen/groups/material.md b/doc/doxygen/groups/material.md
index ef446c4042..8ceea0f344 100644
--- a/doc/doxygen/groups/material.md
+++ b/doc/doxygen/groups/material.md
@@ -84,7 +84,7 @@ The following laws are implemented:
@defgroup FrictionLaws Friction Laws
@brief Friction Laws for calculating bottom shear stress
-@details Friction laws calculate the stress between the flow and the bottom,
+@details 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.
diff --git a/dumux/material/fluidmatrixinteractions/frictionlaws/frictionlaw.hh b/dumux/material/fluidmatrixinteractions/frictionlaws/frictionlaw.hh
index 44627e2b5f..047800fd84 100644
--- a/dumux/material/fluidmatrixinteractions/frictionlaws/frictionlaw.hh
+++ b/dumux/material/fluidmatrixinteractions/frictionlaws/frictionlaw.hh
@@ -17,7 +17,7 @@ namespace Dumux {
* \ingroup FrictionLaws
* \brief Implementation of the abstract base class for friction laws.
*
- * Friction laws calculate the stress between the flow and the bottom,
+ * 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.
diff --git a/dumux/material/fluidmatrixinteractions/frictionlaws/manning.hh b/dumux/material/fluidmatrixinteractions/frictionlaws/manning.hh
index 326bfc65c7..782d29f892 100644
--- a/dumux/material/fluidmatrixinteractions/frictionlaws/manning.hh
+++ b/dumux/material/fluidmatrixinteractions/frictionlaws/manning.hh
@@ -19,7 +19,7 @@ namespace Dumux {
*
* ### Manning
*
- * This friction law calculates the stress between the flow and the bottom,
+ * This friction law calculates the stress between the flowing fluid and the bottom,
* which is called bottom shear stress, using the Manning friction law.
* 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.
diff --git a/dumux/material/fluidmatrixinteractions/frictionlaws/nikuradse.hh b/dumux/material/fluidmatrixinteractions/frictionlaws/nikuradse.hh
index 10b4110d14..6dfe514691 100644
--- a/dumux/material/fluidmatrixinteractions/frictionlaws/nikuradse.hh
+++ b/dumux/material/fluidmatrixinteractions/frictionlaws/nikuradse.hh
@@ -19,7 +19,7 @@ namespace Dumux {
*
* ### Nikuradse
*
- * This friction law calculates the stress between the flow and the bottom,
+ * This friction law calculates the stress between the flowing fluid and the bottom,
* which is called bottom shear stress, using the Nikuradse friction law.
* 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.
diff --git a/dumux/material/fluidmatrixinteractions/frictionlaws/nofriction.hh b/dumux/material/fluidmatrixinteractions/frictionlaws/nofriction.hh
index 730a75baed..144c5ed1d3 100644
--- a/dumux/material/fluidmatrixinteractions/frictionlaws/nofriction.hh
+++ b/dumux/material/fluidmatrixinteractions/frictionlaws/nofriction.hh
@@ -17,7 +17,7 @@ namespace Dumux {
*
* ### No Friction
*
- * This friction law sets the stress between the flow and the bottom,
+ * This friction law sets the stress between the flowing fluid and the bottom,
* which is called bottom shear stress, to zero.
* 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.
--
GitLab