From 024c04a6e9236780c2bc449338edbfdb6e6dd1a1 Mon Sep 17 00:00:00 2001
From: Maziar Veyskarami <maziar.veyskarami@iws.uni-stuttgart.de>
Date: Sun, 9 Mar 2025 14:58:21 +0100
Subject: [PATCH] [doc][fluidmatrixinteractions] add \file back to the
beginning of the files
---
doc/doxygen/groups/material.md | 1 -
.../2p/thermalconductivity/johansen.hh | 6 ++++++
.../2p/thermalconductivity/simplefluidlumping.hh | 6 ++++++
.../2p/thermalconductivity/somerton.hh | 6 ++++++
.../3p/thermalconductivitysomerton3p.hh | 6 ++++++
.../diffusivityconstanttortuosity.hh | 6 ++++++
.../diffusivitymillingtonquirk.hh | 6 ++++++
.../dispersiontensors/fulltensor.hh | 6 ++++++
.../dispersiontensors/scheidegger.hh | 6 ++++++
.../fluidmatrixinteractions/fluidmatrixinteraction.hh | 1 +
.../frictionlaws/frictionlaw.hh | 6 ++++++
.../fluidmatrixinteractions/frictionlaws/manning.hh | 6 ++++++
.../fluidmatrixinteractions/frictionlaws/nikuradse.hh | 11 +++++++++++
.../frictionlaws/nofriction.hh | 6 ++++++
.../frictionlaws/viscousnoslip.hh | 6 ++++++
.../permeabilitykozenycarman.hh | 1 +
.../thermalconductivityaverage.hh | 6 ++++++
17 files changed, 91 insertions(+), 1 deletion(-)
diff --git a/doc/doxygen/groups/material.md b/doc/doxygen/groups/material.md
index 84ce2fa401..183ceaa654 100644
--- a/doc/doxygen/groups/material.md
+++ b/doc/doxygen/groups/material.md
@@ -74,7 +74,6 @@ of the tortuosity coefficient $\tau$. The two
quantities are related by $ \lambda = \sqrt{1/\tau} $.
The following laws are implemented:
-
@ingroup Fluidmatrixinteractions
@defgroup EffectiveHeatConductivity Effective heat conductivity in porous media
diff --git a/dumux/material/fluidmatrixinteractions/2p/thermalconductivity/johansen.hh b/dumux/material/fluidmatrixinteractions/2p/thermalconductivity/johansen.hh
index 23c4b9273b..fd099602b0 100644
--- a/dumux/material/fluidmatrixinteractions/2p/thermalconductivity/johansen.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/thermalconductivity/johansen.hh
@@ -4,6 +4,12 @@
// SPDX-FileCopyrightText: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
+/*!
+ * \file
+ * \ingroup EffectiveHeatConductivity
+ * \brief Relation for the saturation-dependent effective thermal conductivity
+ */
+
#ifndef DUMUX_MATERIAL_FLUIDMATRIX_THERMALCONDUCTIVITY_JOHANSEN_HH
#define DUMUX_MATERIAL_FLUIDMATRIX_THERMALCONDUCTIVITY_JOHANSEN_HH
diff --git a/dumux/material/fluidmatrixinteractions/2p/thermalconductivity/simplefluidlumping.hh b/dumux/material/fluidmatrixinteractions/2p/thermalconductivity/simplefluidlumping.hh
index cd3bee3b28..dda458640d 100644
--- a/dumux/material/fluidmatrixinteractions/2p/thermalconductivity/simplefluidlumping.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/thermalconductivity/simplefluidlumping.hh
@@ -4,6 +4,12 @@
// SPDX-FileCopyrightText: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
+/*!
+ * \file
+ * \ingroup EffectiveHeatConductivity
+ * \brief Relation for the saturation-dependent effective thermal conductivity
+ */
+
#ifndef DUMUX_MATERIAL_FLUIDMATRIX_THERMALCONDUCTIVITY_SIMPLE_FLUID_LUMPING_HH
#define DUMUX_MATERIAL_FLUIDMATRIX_THERMALCONDUCTIVITY_SIMPLE_FLUID_LUMPING_HH
diff --git a/dumux/material/fluidmatrixinteractions/2p/thermalconductivity/somerton.hh b/dumux/material/fluidmatrixinteractions/2p/thermalconductivity/somerton.hh
index 43fad627be..559ae3bff0 100644
--- a/dumux/material/fluidmatrixinteractions/2p/thermalconductivity/somerton.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/thermalconductivity/somerton.hh
@@ -4,6 +4,12 @@
// SPDX-FileCopyrightText: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
+/*!
+ * \file
+ * \ingroup EffectiveHeatConductivity
+ * \brief Effective thermal conductivity after Somerton
+ */
+
#ifndef DUMUX_MATERIAL_FLUIDMATRIX_THERMALCONDUCTIVITY_SOMERTON_TWO_P_HH
#define DUMUX_MATERIAL_FLUIDMATRIX_THERMALCONDUCTIVITY_SOMERTON_TWO_P_HH
diff --git a/dumux/material/fluidmatrixinteractions/3p/thermalconductivitysomerton3p.hh b/dumux/material/fluidmatrixinteractions/3p/thermalconductivitysomerton3p.hh
index daa3883f79..211cfeb897 100644
--- a/dumux/material/fluidmatrixinteractions/3p/thermalconductivitysomerton3p.hh
+++ b/dumux/material/fluidmatrixinteractions/3p/thermalconductivitysomerton3p.hh
@@ -4,6 +4,12 @@
// SPDX-FileCopyrightText: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
+/*!
+ * \file
+ * \ingroup EffectiveHeatConductivity
+ * \brief Effective thermal conductivity after Somerton
+ */
+
#ifndef DUMUX_MATERIAL_FLUIDMATRIX_THERMALCONDUCTIVITY_SOMERTON_THREE_P_HH
#define DUMUX_MATERIAL_FLUIDMATRIX_THERMALCONDUCTIVITY_SOMERTON_THREE_P_HH
diff --git a/dumux/material/fluidmatrixinteractions/diffusivityconstanttortuosity.hh b/dumux/material/fluidmatrixinteractions/diffusivityconstanttortuosity.hh
index 4b2fdc2437..7966d127b7 100644
--- a/dumux/material/fluidmatrixinteractions/diffusivityconstanttortuosity.hh
+++ b/dumux/material/fluidmatrixinteractions/diffusivityconstanttortuosity.hh
@@ -4,6 +4,12 @@
// SPDX-FileCopyrightText: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
+/*!
+* \file
+* \ingroup EffectiveDiffusivity
+* \brief Relation for the effective diffusion coefficient with constant tortuosity
+*/
+
#ifndef DUMUX_MATERIAL_DIFFUSIVITY_CONSTANT_TORTUOSITY_HH
#define DUMUX_MATERIAL_DIFFUSIVITY_CONSTANT_TORTUOSITY_HH
diff --git a/dumux/material/fluidmatrixinteractions/diffusivitymillingtonquirk.hh b/dumux/material/fluidmatrixinteractions/diffusivitymillingtonquirk.hh
index 00a2868829..bc052bf4d5 100644
--- a/dumux/material/fluidmatrixinteractions/diffusivitymillingtonquirk.hh
+++ b/dumux/material/fluidmatrixinteractions/diffusivitymillingtonquirk.hh
@@ -4,6 +4,12 @@
// SPDX-FileCopyrightText: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
+/*!
+ * \file
+ * \ingroup EffectiveDiffusivity
+ * \brief Relation for the effective diffusion coefficient after Millington and Quirk
+ */
+
#ifndef DUMUX_MATERIAL_DIFFUSIVITY_MILLINGTON_QUIRK_HH
#define DUMUX_MATERIAL_DIFFUSIVITY_MILLINGTON_QUIRK_HH
diff --git a/dumux/material/fluidmatrixinteractions/dispersiontensors/fulltensor.hh b/dumux/material/fluidmatrixinteractions/dispersiontensors/fulltensor.hh
index c1c8ef88ca..7d1edd29bc 100644
--- a/dumux/material/fluidmatrixinteractions/dispersiontensors/fulltensor.hh
+++ b/dumux/material/fluidmatrixinteractions/dispersiontensors/fulltensor.hh
@@ -4,6 +4,12 @@
// SPDX-FileCopyrightText: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
+/*!
+ * \file
+ * \ingroup DispersionTensors
+ * \brief Full dispersion tensor
+ */
+
#ifndef DUMUX_MATERIAL_FLUIDMATRIX_DISPERSIONTENSORS_FULLTENSOR_HH
#define DUMUX_MATERIAL_FLUIDMATRIX_DISPERSIONTENSORS_FULLTENSOR_HH
diff --git a/dumux/material/fluidmatrixinteractions/dispersiontensors/scheidegger.hh b/dumux/material/fluidmatrixinteractions/dispersiontensors/scheidegger.hh
index 57638c3c8e..d88a6b60b4 100644
--- a/dumux/material/fluidmatrixinteractions/dispersiontensors/scheidegger.hh
+++ b/dumux/material/fluidmatrixinteractions/dispersiontensors/scheidegger.hh
@@ -4,6 +4,12 @@
// SPDX-FileCopyrightText: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
+/*!
+ * \file
+ * \ingroup DispersionTensors
+ * \brief Scheidegger's dispersion tensor
+ */
+
#ifndef DUMUX_MATERIAL_FLUIDMATRIX_DISPERSIONTENSORS_SCHEIDEGGER_HH
#define DUMUX_MATERIAL_FLUIDMATRIX_DISPERSIONTENSORS_SCHEIDEGGER_HH
diff --git a/dumux/material/fluidmatrixinteractions/fluidmatrixinteraction.hh b/dumux/material/fluidmatrixinteractions/fluidmatrixinteraction.hh
index 8b4962b565..5d5cc1504a 100644
--- a/dumux/material/fluidmatrixinteractions/fluidmatrixinteraction.hh
+++ b/dumux/material/fluidmatrixinteractions/fluidmatrixinteraction.hh
@@ -10,6 +10,7 @@
* \brief Wrapper type to combine an arbitrary number of different laws
* for fluid-matrix interaction (e.g., pc-Sw-curves).
*/
+
#ifndef DUMUX_MATERIAL_FLUIDMATRIX_INTERACTIONS_FLUIDMATRIX_INTERACTION_HH
#define DUMUX_MATERIAL_FLUIDMATRIX_INTERACTIONS_FLUIDMATRIX_INTERACTION_HH
diff --git a/dumux/material/fluidmatrixinteractions/frictionlaws/frictionlaw.hh b/dumux/material/fluidmatrixinteractions/frictionlaws/frictionlaw.hh
index ae7e15d303..ae975ac5a5 100644
--- a/dumux/material/fluidmatrixinteractions/frictionlaws/frictionlaw.hh
+++ b/dumux/material/fluidmatrixinteractions/frictionlaws/frictionlaw.hh
@@ -4,6 +4,12 @@
// SPDX-FileCopyrightText: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
+/*!
+ * \file
+ * \ingroup FrictionLaws
+ * \brief Implementation of the abstract base class for friction laws.
+ */
+
#ifndef DUMUX_MATERIAL_FLUIDMATRIX_FRICTIONLAW_HH
#define DUMUX_MATERIAL_FLUIDMATRIX_FRICTIONLAW_HH
diff --git a/dumux/material/fluidmatrixinteractions/frictionlaws/manning.hh b/dumux/material/fluidmatrixinteractions/frictionlaws/manning.hh
index e0bfaf6abc..db7b2cc303 100644
--- a/dumux/material/fluidmatrixinteractions/frictionlaws/manning.hh
+++ b/dumux/material/fluidmatrixinteractions/frictionlaws/manning.hh
@@ -4,6 +4,12 @@
// SPDX-FileCopyrightText: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
+/*!
+ * \file
+ * \ingroup FrictionLaws
+ * \brief Implementation of the friction law after Manning.
+ */
+
#ifndef DUMUX_MATERIAL_FLUIDMATRIX_FRICTIONLAW_MANNING_HH
#define DUMUX_MATERIAL_FLUIDMATRIX_FRICTIONLAW_MANNING_HH
diff --git a/dumux/material/fluidmatrixinteractions/frictionlaws/nikuradse.hh b/dumux/material/fluidmatrixinteractions/frictionlaws/nikuradse.hh
index 3dc13d61a9..cf73dde75d 100644
--- a/dumux/material/fluidmatrixinteractions/frictionlaws/nikuradse.hh
+++ b/dumux/material/fluidmatrixinteractions/frictionlaws/nikuradse.hh
@@ -4,9 +4,20 @@
// SPDX-FileCopyrightText: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
+/*!
+ * \file
+ * \ingroup FrictionLaws
+ * \brief Implementation of the abstract base class for friction laws.
+ */
+
#ifndef DUMUX_MATERIAL_FLUIDMATRIX_FRICTIONLAW_NIKURADSE_HH
#define DUMUX_MATERIAL_FLUIDMATRIX_FRICTIONLAW_NIKURADSE_HH
+/*!
+ * \file
+ * \ingroup FrictionLaws
+ * \brief Implementation of the friction law after Nikuradse.
+ */
#include <algorithm>
#include <cmath>
#include <dune/common/math.hh>
diff --git a/dumux/material/fluidmatrixinteractions/frictionlaws/nofriction.hh b/dumux/material/fluidmatrixinteractions/frictionlaws/nofriction.hh
index d59f197b07..a2013baebe 100644
--- a/dumux/material/fluidmatrixinteractions/frictionlaws/nofriction.hh
+++ b/dumux/material/fluidmatrixinteractions/frictionlaws/nofriction.hh
@@ -4,6 +4,12 @@
// SPDX-FileCopyrightText: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
+/*!
+ * \file
+ * \ingroup FrictionLaws
+ * \brief A pseudo friction law with no bottom friction
+ */
+
#ifndef DUMUX_MATERIAL_FLUIDMATRIX_FRICTIONLAW_NOFRICTION_HH
#define DUMUX_MATERIAL_FLUIDMATRIX_FRICTIONLAW_NOFRICTION_HH
diff --git a/dumux/material/fluidmatrixinteractions/frictionlaws/viscousnoslip.hh b/dumux/material/fluidmatrixinteractions/frictionlaws/viscousnoslip.hh
index c362706440..4ba35b286d 100644
--- a/dumux/material/fluidmatrixinteractions/frictionlaws/viscousnoslip.hh
+++ b/dumux/material/fluidmatrixinteractions/frictionlaws/viscousnoslip.hh
@@ -4,6 +4,12 @@
// SPDX-FileCopyrightText: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
+/*!
+ * \file
+ * \ingroup FrictionLaws
+ * \brief Implementation of a viscous no-slip bottom friction law
+ */
+
#ifndef DUMUX_MATERIAL_FLUIDMATRIX_FRICTIONLAW_VISCOUS_NOSLIP_HH
#define DUMUX_MATERIAL_FLUIDMATRIX_FRICTIONLAW_VISCOUS_NOSLIP_HH
diff --git a/dumux/material/fluidmatrixinteractions/permeabilitykozenycarman.hh b/dumux/material/fluidmatrixinteractions/permeabilitykozenycarman.hh
index 9b567e80b8..cacb29ec51 100644
--- a/dumux/material/fluidmatrixinteractions/permeabilitykozenycarman.hh
+++ b/dumux/material/fluidmatrixinteractions/permeabilitykozenycarman.hh
@@ -9,6 +9,7 @@
* \ingroup Fluidmatrixinteractions
* \brief The Kozeny-Carman relationship for the calculation of a porosity-dependent permeability.
*/
+
#ifndef DUMUX_PERMEABILITY_KOZENY_CARMAN_HH
#define DUMUX_PERMEABILITY_KOZENY_CARMAN_HH
diff --git a/dumux/material/fluidmatrixinteractions/thermalconductivityaverage.hh b/dumux/material/fluidmatrixinteractions/thermalconductivityaverage.hh
index d3fad4e34e..a72a657da5 100644
--- a/dumux/material/fluidmatrixinteractions/thermalconductivityaverage.hh
+++ b/dumux/material/fluidmatrixinteractions/thermalconductivityaverage.hh
@@ -4,6 +4,12 @@
// SPDX-FileCopyrightText: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
+/*!
+ * \file
+ * \ingroup EffectiveHeatConductivity
+ * \brief Effective thermal conductivity based on weighted arithmetic average
+ */
+
#ifndef DUMUX_MATERIAL_THERMALCONDUCTIVITY_AVERAGED_HH
#define DUMUX_MATERIAL_THERMALCONDUCTIVITY_AVERAGED_HH
--
GitLab