From 27e252769a67cc5c137a6398e2ea4d53a0a127ab Mon Sep 17 00:00:00 2001
From: melaniel <melanie.lipp@iws.uni-stuttgart.de>
Date: Wed, 23 Feb 2022 15:52:13 +0100
Subject: [PATCH] [doc][doxygen] Introduce group FreeFlowPorousMediumCoupling
in modules.txt. This group has been used already before, although it did not
exist. Additionally, use it more consistently throughout the folder
dumux/multidomain/boundary/freeflowporousmedium.
---
doc/doxygen/modules.txt | 5 +++++
.../boundary/freeflowporousmedium/couplingconditions.hh | 2 +-
.../boundary/freeflowporousmedium/couplingmanager.hh | 4 ++--
.../freeflowporousmedium/ffmasspm/couplingmanager.hh | 2 +-
.../freeflowporousmedium/ffmomentumpm/couplingmanager.hh | 2 +-
.../freeflowporousmedium/ffmomentumpm/couplingmapper.hh | 4 ++--
6 files changed, 12 insertions(+), 7 deletions(-)
diff --git a/doc/doxygen/modules.txt b/doc/doxygen/modules.txt
index 49b4e926f1..3c8f2f9749 100644
--- a/doc/doxygen/modules.txt
+++ b/doc/doxygen/modules.txt
@@ -556,6 +556,11 @@
* \defgroup FreeFlowPoreNetworkCoupling Free flow-Pore network domain coupling
* \brief Couples domains with equal-dimension multi-physics problems in a Free flow-Pore network coupling.
*/
+ /*!
+ * \ingroup BoundaryCoupling
+ * \defgroup FreeFlowPorousMediumCoupling Free flow-Porous medium domain coupling
+ * \brief Couples domains with equal-dimension multi-physics problems in a Free flow-Porous medium coupling.
+ */
/*!
* \ingroup BoundaryCoupling
* \defgroup StokesDarcyCoupling Stokes-Darcy domain coupling
diff --git a/dumux/multidomain/boundary/freeflowporousmedium/couplingconditions.hh b/dumux/multidomain/boundary/freeflowporousmedium/couplingconditions.hh
index 376125a5c0..53906c32e8 100644
--- a/dumux/multidomain/boundary/freeflowporousmedium/couplingconditions.hh
+++ b/dumux/multidomain/boundary/freeflowporousmedium/couplingconditions.hh
@@ -84,7 +84,7 @@ template<class MDTraits, class CouplingManager, bool enableEnergyBalance, bool i
class FreeFlowPorousMediumCouplingConditionsImplementation;
/*!
-* \ingroup BoundaryCoupling
+* \ingroup FreeFlowPorousMediumCoupling
* \brief Data for the coupling of a Darcy model (cell-centered finite volume)
* with a (Navier-)Stokes model (staggerd grid).
*/
diff --git a/dumux/multidomain/boundary/freeflowporousmedium/couplingmanager.hh b/dumux/multidomain/boundary/freeflowporousmedium/couplingmanager.hh
index 4a053e637b..1b95223fcc 100644
--- a/dumux/multidomain/boundary/freeflowporousmedium/couplingmanager.hh
+++ b/dumux/multidomain/boundary/freeflowporousmedium/couplingmanager.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- * \ingroup BoundaryCoupling
+ * \ingroup FreeFlowPorousMediumCoupling
* \copydoc Dumux::FreeFlowPorousMediumCouplingManager
*/
@@ -144,7 +144,7 @@ struct CouplingManagers
/*!
- * \ingroup BoundaryCoupling
+ * \ingroup FreeFlowPorousMediumCoupling
* \brief Coupling manager for coupling freeflow and porous medium flow models
*/
template<class MDTraits>
diff --git a/dumux/multidomain/boundary/freeflowporousmedium/ffmasspm/couplingmanager.hh b/dumux/multidomain/boundary/freeflowporousmedium/ffmasspm/couplingmanager.hh
index e8156b9774..0a54d2657d 100644
--- a/dumux/multidomain/boundary/freeflowporousmedium/ffmasspm/couplingmanager.hh
+++ b/dumux/multidomain/boundary/freeflowporousmedium/ffmasspm/couplingmanager.hh
@@ -38,7 +38,7 @@
namespace Dumux {
/*!
- * \ingroup StokesDarcyCoupling
+ * \ingroup FreeFlowPorousMediumCoupling
* \brief Coupling manager for Stokes and Darcy domains with equal dimension.
*/
template<class MDTraits>
diff --git a/dumux/multidomain/boundary/freeflowporousmedium/ffmomentumpm/couplingmanager.hh b/dumux/multidomain/boundary/freeflowporousmedium/ffmomentumpm/couplingmanager.hh
index f957e9f65f..aa4e7267f9 100644
--- a/dumux/multidomain/boundary/freeflowporousmedium/ffmomentumpm/couplingmanager.hh
+++ b/dumux/multidomain/boundary/freeflowporousmedium/ffmomentumpm/couplingmanager.hh
@@ -39,7 +39,7 @@
namespace Dumux {
/*!
- * \ingroup StokesDarcyCoupling
+ * \ingroup FreeFlowPorousMediumCoupling
* \brief Coupling manager for Stokes and Darcy domains with equal dimension.
*/
template<class MDTraits>
diff --git a/dumux/multidomain/boundary/freeflowporousmedium/ffmomentumpm/couplingmapper.hh b/dumux/multidomain/boundary/freeflowporousmedium/ffmomentumpm/couplingmapper.hh
index d3c229d77a..2548a6cf21 100644
--- a/dumux/multidomain/boundary/freeflowporousmedium/ffmomentumpm/couplingmapper.hh
+++ b/dumux/multidomain/boundary/freeflowporousmedium/ffmomentumpm/couplingmapper.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- * \ingroup DarcyDarcyCoupling
+ * \ingroup FreeFlowPorousMediumCoupling
* \copydoc Dumux::FreeFlowMomentumPorousMediumCouplingMapper
*/
@@ -40,7 +40,7 @@
namespace Dumux {
/*!
- * \ingroup DarcyDarcyCoupling
+ * \ingroup FreeFlowPorousMediumCoupling
* \brief the default mapper for conforming equal dimension boundary coupling between two domains (box or cc)
* \todo how to extend to arbitrary number of domains?
*/
--
GitLab