diff --git a/doc/doxygen/groups/material.md b/doc/doxygen/groups/material.md index 84ce2fa401187c6b62e072bc2f72782c9ffbcca6..183ceaa65413409f64561ffbf69c7947775d3c21 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 23c4b9273bc1184460872a83a22ba311562227ae..fd099602b085041327330f6915dc625724dda29b 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 cd3bee3b285c34470c4068401274ef2ca1b420c9..dda458640d16a193267162422488d68b027ded58 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 43fad627be54e9c611789cfd00120663ad6033d6..559ae3bff0a6f7b7f6a10e2d14f038bb5df91ac9 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 daa3883f796f52368b7f7c38c3d713da043746b7..211cfeb8974992de9875f514d5bca096e6603c9e 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 4b2fdc2437330a190fca5e65ee645350045defc3..7966d127b7e2bba50bba81e9052b31b8fa5910e6 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 00a2868829b12cfacebf046ce866c9c8b407749c..bc052bf4d5eb669596417d6cec8633775f82ce38 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 c1c8ef88caba6fa1304e3421f8fedc7c8ed98dd0..7d1edd29bc8b75fd4974ba966d1e3501e9f63cd6 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 57638c3c8ef157f8c565f86c81c3b4b575f6cb7b..d88a6b60b45a06f44d4c9972e1171e82d6a36c43 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 8b4962b565fc9613b3d02523b3ae07087d345fa3..5d5cc1504a02a36f49a847ce48b22e9a9ed400cf 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 ae7e15d303d3ee65663fdaa4a82821fe09632424..ae975ac5a5a900dcb9be5e536563f2121a8bf2db 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 e0bfaf6abc0268ed87b1ea3a59e9115f8f1ab61a..db7b2cc303c6b2b112e69d5d69f2f6ab1fb2ba74 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 3dc13d61a9f47ca18154fee382455208f4355761..cf73dde75d9af28d2a93b19fd5b8ed32357ebe9b 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 d59f197b075393e8abfedf6c97e8ada5438a9a7c..a2013baebe9f65478c2ca10f7aefa9297776a1c0 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 c362706440c7a0c5055744a333c39e02f0767d0c..4ba35b286ddb4f62a576ee21cf5b2ac028c1a0d1 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 9b567e80b82df3425ad0c6d94d16caebf7ba819b..cacb29ec5195350d9240baad0c924e80b24b17c2 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 d3fad4e34e271e31b685b4202133ed270220d776..a72a657da5404726025fdbd60a9caa053cca9be1 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