From 8867540ec57833672a3f08d061e3a82c3a660e51 Mon Sep 17 00:00:00 2001
From: Lars Kaiser <71793357+kaiserls@users.noreply.github.com>
Date: Mon, 4 Dec 2023 15:59:04 +0100
Subject: [PATCH] [doc][fluidmatrixinteractions] Introduce more subgroups
---
doc/doxygen/groups/material.md | 12 ++++++++++++
.../dispersiontensors/fulltensor.hh | 5 +++--
.../dispersiontensors/scheidegger.hh | 5 +++--
.../frictionlaws/frictionlaw.hh | 4 ++--
.../fluidmatrixinteractions/frictionlaws/manning.hh | 5 +++--
.../frictionlaws/nikuradse.hh | 5 +++--
.../frictionlaws/nofriction.hh | 5 +++--
.../frictionlaws/viscousnoslip.hh | 5 +++--
.../porenetwork/pore/2p/localrulesforplatonicbody.hh | 10 +++++-----
.../porenetwork/pore/2p/multishapelocalrules.hh | 6 +++---
.../porenetwork/pore/2p/singleshapelocalrules.hh | 4 ++--
.../porenetwork/throat/emptycache.hh | 2 +-
.../throat/thresholdcapillarypressures.hh | 2 +-
.../porenetwork/throat/transmissibility1p.hh | 6 +++---
.../porenetwork/throat/transmissibility2p.hh | 2 +-
15 files changed, 48 insertions(+), 30 deletions(-)
diff --git a/doc/doxygen/groups/material.md b/doc/doxygen/groups/material.md
index 5ca720344f..9e134f2348 100644
--- a/doc/doxygen/groups/material.md
+++ b/doc/doxygen/groups/material.md
@@ -82,6 +82,18 @@ The following laws are implemented:
@details In porous media, the effective heat conductivity depends on the solid-fluid conductivity ratio, the volume fractions of the constituent phases, and the geometry of the solid-fluid interface \cite aichlmayr2006effective. The following laws are implemented:
@ingroup Fluidmatrixinteractions
+@defgroup FrictionLaws Friction Laws
+@brief Friction Laws
+@ingroup Fluidmatrixinteractions
+
+@defgroup DispersionTensors Dispersion Tensors
+@brief Dispersion Tensors
+@ingroup Fluidmatrixinteractions
+
+@defgroup PoreNetwork Pore Network
+@brief Constitutive Relations for pore networks models
+@ingroup Pore Network
+
<!-- FluidStates -->
@defgroup FluidStates Fluid States
diff --git a/dumux/material/fluidmatrixinteractions/dispersiontensors/fulltensor.hh b/dumux/material/fluidmatrixinteractions/dispersiontensors/fulltensor.hh
index 0cb60f55ee..73cbcf227d 100644
--- a/dumux/material/fluidmatrixinteractions/dispersiontensors/fulltensor.hh
+++ b/dumux/material/fluidmatrixinteractions/dispersiontensors/fulltensor.hh
@@ -6,7 +6,7 @@
//
/*!
* \file
- * \ingroup Fluidmatrixinteractions
+ * \ingroup DispersionTensors
* \copydoc Dumux::FullDispersionTensor
*/
#ifndef DUMUX_MATERIAL_FLUIDMATRIX_DISPERSIONTENSORS_FULLTENSOR_HH
@@ -18,7 +18,8 @@
namespace Dumux {
/*!
- * \ingroup Fluidmatrixinteractions
+ * \addtogroup DispersionTensors
+ * \ingroup DispersionTensors
* \brief Full dispersion tensor
*/
template<class TypeTag>
diff --git a/dumux/material/fluidmatrixinteractions/dispersiontensors/scheidegger.hh b/dumux/material/fluidmatrixinteractions/dispersiontensors/scheidegger.hh
index 842391839e..29e6459fa9 100644
--- a/dumux/material/fluidmatrixinteractions/dispersiontensors/scheidegger.hh
+++ b/dumux/material/fluidmatrixinteractions/dispersiontensors/scheidegger.hh
@@ -6,7 +6,7 @@
//
/*!
* \file
- * \ingroup Fluidmatrixinteractions
+ * \ingroup DispersionTensors
* \copydoc Dumux::ScheideggersDispersionTensor
*/
#ifndef DUMUX_MATERIAL_FLUIDMATRIX_DISPERSIONTENSORS_SCHEIDEGGER_HH
@@ -35,7 +35,8 @@ static constexpr bool hasVelocityInSpatialParams()
}
/*!
- * \ingroup Fluidmatrixinteractions
+ * \addtogroup DispersionTensors
+ * \ingroup DispersionTensors
* \brief Scheidegger's dispersion tensor
*/
template<class TypeTag>
diff --git a/dumux/material/fluidmatrixinteractions/frictionlaws/frictionlaw.hh b/dumux/material/fluidmatrixinteractions/frictionlaws/frictionlaw.hh
index 4a80100219..8203282f9c 100644
--- a/dumux/material/fluidmatrixinteractions/frictionlaws/frictionlaw.hh
+++ b/dumux/material/fluidmatrixinteractions/frictionlaws/frictionlaw.hh
@@ -6,7 +6,7 @@
//
/*!
* \file
- * \ingroup Fluidmatrixinteractions
+ * \ingroup FrictionLaws
* \copydoc Dumux::FrictionLaw
*/
#ifndef DUMUX_MATERIAL_FLUIDMATRIX_FRICTIONLAW_HH
@@ -19,7 +19,7 @@
namespace Dumux {
/*!
- * \ingroup Fluidmatrixinteractions
+ * \ingroup FrictionLaws
* \brief Implementation of the abstract base class for friction laws.
*
* A LET mobility model can be used to add an artificial water depth to
diff --git a/dumux/material/fluidmatrixinteractions/frictionlaws/manning.hh b/dumux/material/fluidmatrixinteractions/frictionlaws/manning.hh
index 9bbfcff0de..27b03d8a8f 100644
--- a/dumux/material/fluidmatrixinteractions/frictionlaws/manning.hh
+++ b/dumux/material/fluidmatrixinteractions/frictionlaws/manning.hh
@@ -6,7 +6,7 @@
//
/*!
* \file
- * \ingroup Fluidmatrixinteractions
+ * \ingroup FrictionLaws
* \copydoc Dumux::FrictionLawManning
*/
#ifndef DUMUX_MATERIAL_FLUIDMATRIX_FRICTIONLAW_MANNING_HH
@@ -19,7 +19,8 @@
namespace Dumux {
/*!
- * \ingroup Fluidmatrixinteractions
+ * \addtogroup FrictionLaws
+ * \ingroup FrictionLaws
* \brief Implementation of the friction law after Manning.
*
* The LET mobility model is used to limit the friction for small water
diff --git a/dumux/material/fluidmatrixinteractions/frictionlaws/nikuradse.hh b/dumux/material/fluidmatrixinteractions/frictionlaws/nikuradse.hh
index ae6fc335d1..4143f928ee 100644
--- a/dumux/material/fluidmatrixinteractions/frictionlaws/nikuradse.hh
+++ b/dumux/material/fluidmatrixinteractions/frictionlaws/nikuradse.hh
@@ -6,7 +6,7 @@
//
/*!
* \file
- * \ingroup Fluidmatrixinteractions
+ * \ingroup FrictionLaws
* \copydoc Dumux::FrictionLawNikuradse
*/
#ifndef DUMUX_MATERIAL_FLUIDMATRIX_FRICTIONLAW_NIKURADSE_HH
@@ -19,7 +19,8 @@
namespace Dumux {
/*!
- * \ingroup Fluidmatrixinteractions
+ * \addtogroup FrictionLaws
+ * \ingroup FrictionLaws
* \brief Implementation of the friction law after Nikuradse.
*
* The LET mobility model is used to limit the friction for small water
diff --git a/dumux/material/fluidmatrixinteractions/frictionlaws/nofriction.hh b/dumux/material/fluidmatrixinteractions/frictionlaws/nofriction.hh
index 5fa36b98b8..32eb85d763 100644
--- a/dumux/material/fluidmatrixinteractions/frictionlaws/nofriction.hh
+++ b/dumux/material/fluidmatrixinteractions/frictionlaws/nofriction.hh
@@ -6,7 +6,7 @@
//
/*!
* \file
- * \ingroup Fluidmatrixinteractions
+ * \ingroup FrictionLaws
* \copydoc Dumux::FrictionLawNoFriction
*/
#ifndef DUMUX_MATERIAL_FLUIDMATRIX_FRICTIONLAW_NOFRICTION_HH
@@ -17,7 +17,8 @@
namespace Dumux {
/*!
- * \ingroup Fluidmatrixinteractions
+ * \addtogroup FrictionLaws
+ * \ingroup FrictionLaws
* \brief A pseudo friction law with no bottom friction
*/
template <typename VolumeVariables>
diff --git a/dumux/material/fluidmatrixinteractions/frictionlaws/viscousnoslip.hh b/dumux/material/fluidmatrixinteractions/frictionlaws/viscousnoslip.hh
index d7626d7eba..428a088640 100644
--- a/dumux/material/fluidmatrixinteractions/frictionlaws/viscousnoslip.hh
+++ b/dumux/material/fluidmatrixinteractions/frictionlaws/viscousnoslip.hh
@@ -6,7 +6,7 @@
//
/*!
* \file
- * \ingroup Fluidmatrixinteractions
+ * \ingroup FrictionLaws
* \copydoc Dumux::FrictionLawViscousNoSlip
*/
#ifndef DUMUX_MATERIAL_FLUIDMATRIX_FRICTIONLAW_VISCOUS_NOSLIP_HH
@@ -21,7 +21,8 @@
namespace Dumux {
/*!
- * \ingroup Fluidmatrixinteractions
+ * \addtogroup FrictionLaws
+ * \ingroup FrictionLaws
* \brief Implementation of a viscous no-slip bottom friction law
*
* This assumes thin film flow with a parabolic velocity profile in depth
diff --git a/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/localrulesforplatonicbody.hh b/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/localrulesforplatonicbody.hh
index ed2b63109e..aefa056426 100644
--- a/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/localrulesforplatonicbody.hh
+++ b/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/localrulesforplatonicbody.hh
@@ -6,7 +6,7 @@
//
/*!
* \file
- * \ingroup Fluidmatrixinteractions
+ * \ingroup PoreNetwork
* \ingroup PoreNetworkModels
* \brief Pore-local pc-Sw curves for for platonic bodies
* (tetrahedron, cube, octahedron, dodecahedron, icosahedron).
@@ -82,7 +82,7 @@ private:
};
/*!
- * \ingroup Fluidmatrixinteractions
+ * \ingroup PoreNetwork
* \ingroup PoreNetworkModels
* \brief Implementation of the simplified pore-local capillary pressure-saturation curve
* for platonic bodies (tetrahedron, cube, octahedron, dodecahedron, icosahedron).
@@ -223,7 +223,7 @@ private:
};
/*!
- * \ingroup Fluidmatrixinteractions
+ * \ingroup PoreNetwork
* \ingroup PoreNetworkModels
* \brief Two-phase rules for regularizing the pc-SW for platonic bodies.
*/
@@ -575,7 +575,7 @@ private:
};
/*!
- * \ingroup Fluidmatrixinteractions
+ * \ingroup PoreNetwork
* \brief A default configuration for using the VanGenuchten material law
*/
template<Pore::Shape shape, typename Scalar = double>
@@ -585,7 +585,7 @@ using TwoPLocalRulesPlatonicBodyDefault = SingleShapeTwoPLocalRules<Scalar,
TwoPLocalRulesPlatonicBody<shape>>>;
/*!
- * \ingroup Fluidmatrixinteractions
+ * \ingroup PoreNetwork
* \brief A default configuration without regularization for using the VanGenuchten material law
*/
template<Pore::Shape shape, typename Scalar = double>
diff --git a/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/multishapelocalrules.hh b/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/multishapelocalrules.hh
index 9ef6c60f5b..ecc5d73a28 100644
--- a/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/multishapelocalrules.hh
+++ b/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/multishapelocalrules.hh
@@ -6,7 +6,7 @@
//
/*!
* \file
- * \ingroup Fluidmatrixinteractions
+ * \ingroup PoreNetwork
* \ingroup PoreNetworkModels
* \brief Implementation of capillary pressure curves for multiple pore body geometries
*/
@@ -19,7 +19,7 @@
namespace Dumux::PoreNetwork::FluidMatrix {
/*!
- * \ingroup Fluidmatrixinteractions
+ * \ingroup PoreNetwork
* \ingroup PoreNetworkModels
* \brief LocalRulesTraits for implementation of capillary pressure curves for multiple pore body geometries
*/
@@ -34,7 +34,7 @@ struct LocalRulesTraits
};
/*!
- * \ingroup Fluidmatrixinteractions
+ * \ingroup PoreNetwork
* \ingroup PoreNetworkModels
* \brief Implementation of capillary pressure curves for multiple pore body geometries
*/
diff --git a/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/singleshapelocalrules.hh b/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/singleshapelocalrules.hh
index b250b5a97d..03c8e21df1 100644
--- a/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/singleshapelocalrules.hh
+++ b/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/singleshapelocalrules.hh
@@ -6,7 +6,7 @@
//
/*!
* \file
- * \ingroup Fluidmatrixinteractions
+ * \ingroup PoreNetwork
* \ingroup PoreNetworkModels
* \brief Base classes for standard pore-local pc-Sw curves.
*/
@@ -21,7 +21,7 @@
namespace Dumux::PoreNetwork::FluidMatrix {
/*!
- * \ingroup Fluidmatrixinteractions
+ * \ingroup PoreNetwork
* \ingroup PoreNetworkModels
* \brief Base class for all standard pore-local pc-Sw curves.
*/
diff --git a/dumux/material/fluidmatrixinteractions/porenetwork/throat/emptycache.hh b/dumux/material/fluidmatrixinteractions/porenetwork/throat/emptycache.hh
index 9a9ccbc038..134067c5fb 100644
--- a/dumux/material/fluidmatrixinteractions/porenetwork/throat/emptycache.hh
+++ b/dumux/material/fluidmatrixinteractions/porenetwork/throat/emptycache.hh
@@ -6,7 +6,7 @@
//
/*!
* \file
- * \ingroup Fluidmatrixinteractions
+ * \ingroup PoreNetwork
* \ingroup PoreNetworkModels
* \brief An empty cache for transmissibility laws using only standard quantities
*/
diff --git a/dumux/material/fluidmatrixinteractions/porenetwork/throat/thresholdcapillarypressures.hh b/dumux/material/fluidmatrixinteractions/porenetwork/throat/thresholdcapillarypressures.hh
index f318d1b038..249103c4c5 100644
--- a/dumux/material/fluidmatrixinteractions/porenetwork/throat/thresholdcapillarypressures.hh
+++ b/dumux/material/fluidmatrixinteractions/porenetwork/throat/thresholdcapillarypressures.hh
@@ -7,7 +7,7 @@
/*!
* \file
- * \ingroup Fluidmatrixinteractions
+ * \ingroup PoreNetwork
* \ingroup PoreNetworkModels
* \brief Specification of threshold capillary pressures for the PNM.
*/
diff --git a/dumux/material/fluidmatrixinteractions/porenetwork/throat/transmissibility1p.hh b/dumux/material/fluidmatrixinteractions/porenetwork/throat/transmissibility1p.hh
index 1bdc6aad61..0d0d3a6586 100644
--- a/dumux/material/fluidmatrixinteractions/porenetwork/throat/transmissibility1p.hh
+++ b/dumux/material/fluidmatrixinteractions/porenetwork/throat/transmissibility1p.hh
@@ -6,7 +6,7 @@
//
/*!
* \file
- * \ingroup Fluidmatrixinteractions
+ * \ingroup PoreNetwork
* \ingroup PoreNetworkModels
* \brief Implementation of the single-phase transmissibility laws for throats
*/
@@ -20,7 +20,7 @@
namespace Dumux::PoreNetwork {
/*!
- * \ingroup Fluidmatrixinteractions
+ * \ingroup PoreNetwork
* \ingroup PoreNetworkModels
* \brief Collection of single-phase flow throat transmissibilities based on
* Bruus, H. (2011). Acoustofluidics 1: Governing equations in microfluidics. Lab on a Chip, 11(22), 3742-3751.
@@ -105,7 +105,7 @@ protected:
};
/*!
- * \ingroup Fluidmatrixinteractions
+ * \ingroup PoreNetwork
* \ingroup PoreNetworkModels
* \brief Single-phase flow throat transmissibility based on Patzek & Silin (2001) https://doi.org/10.1006/jcis.2000.7413
*/
diff --git a/dumux/material/fluidmatrixinteractions/porenetwork/throat/transmissibility2p.hh b/dumux/material/fluidmatrixinteractions/porenetwork/throat/transmissibility2p.hh
index 6d6aaf804b..62d087556e 100644
--- a/dumux/material/fluidmatrixinteractions/porenetwork/throat/transmissibility2p.hh
+++ b/dumux/material/fluidmatrixinteractions/porenetwork/throat/transmissibility2p.hh
@@ -6,7 +6,7 @@
//
/*!
* \file
- * \ingroup Fluidmatrixinteractions
+ * \ingroup PoreNetwork
* \ingroup PoreNetworkModels
* \brief Implementation of the transmissibility laws for throats
*/
--
GitLab