From 8b234649e38b934cbf4a40b79bd58c204e10beda Mon Sep 17 00:00:00 2001
From: Theresa Schollenberger
Date: Wed, 29 Jun 2022 15:11:06 +0200
Subject: [PATCH 1/3] [flux][documentation] add description for Darcys law
---
dumux/flux/darcyslaw.hh | 27 +++++++++++++++++++++++----
1 file changed, 23 insertions(+), 4 deletions(-)
diff --git a/dumux/flux/darcyslaw.hh b/dumux/flux/darcyslaw.hh
index 5a47b4cc94..bde9f282a7 100644
--- a/dumux/flux/darcyslaw.hh
+++ b/dumux/flux/darcyslaw.hh
@@ -19,10 +19,29 @@
/*!
* \file
* \ingroup Flux
- * \brief Darcy's law specialized for different discretization schemes
- * This file contains the data which is required to calculate
- * volume and mass fluxes of fluid phases over a face of a finite volume by means
- * of the Darcy approximation. Specializations are provided for the different discretization methods.
+ * \brief
+ *
+ * Darcy's law describes the advective flux in porous media on the macro-scale and is valid for Reynolds numbers below 1.
+ * The advective flux characterizes the bulk flow for each fluid phase including all components in case of compositional flow.
+ * It is driven by the potential gradient \f$\textbf{grad}\, p - \varrho {\textbf g}\f$,
+ * accounting for both pressure difference and gravitation.
+ * The velocity is proportional to the potential gradient with the proportional factor \f$\frac{\textbf K}{\mu}\f$,
+ * including the intrinsic permeability of the porous medium, and the viscosity µ of the fluid phase. For one-phase flow it is:
+ * \f[
+ * v = - \frac{\mathbf K}{\mu}
+ * \left(\textbf{grad}\, p - \varrho {\mathbf g} \right)
+ * \f]
+ * This equation can be extended to calculate the velocity \f$v_\alpha\f$ of phase \f$\alpha\f$ in the case of multi-phase
+ * flow by considering the relative permeability \f$k_{r\alpha}\f$:
+ * \f[
+ * v_\alpha = - \frac{k_{r\alpha}}{\mu_\alpha} \mathbf{K}
+ * \left(\text{grad}\, p_\alpha - \varrho_{\alpha} \mathbf{g} \right)
+ * \f]
+ *
+ * Darcy's law is specialized for different discretization schemes.
+ * This file contains the data which is required to calculate
+ * volume and mass fluxes of fluid phases over a face of a finite volume by means
+ * of the Darcy approximation. See the corresponding header files for the specific different discretization methods.
*/
#ifndef DUMUX_FLUX_DARCYS_LAW_HH
#define DUMUX_FLUX_DARCYS_LAW_HH
--
GitLab
From 36acc428f15d3c7e52efb0ff580a28936fa397b0 Mon Sep 17 00:00:00 2001
From: Theresa Schollenberger
Date: Wed, 29 Jun 2022 18:50:34 +0200
Subject: [PATCH 2/3] [flux][documentation] add links to new Darcy law
description in models
---
dumux/porousmediumflow/1p/model.hh | 8 ++------
dumux/porousmediumflow/1pnc/model.hh | 9 ++-------
dumux/porousmediumflow/1pncmin/model.hh | 9 +++------
dumux/porousmediumflow/2p/model.hh | 9 +++------
dumux/porousmediumflow/2p1c/model.hh | 9 +++------
dumux/porousmediumflow/2pnc/model.hh | 9 +++------
dumux/porousmediumflow/2pncmin/model.hh | 9 +++------
dumux/porousmediumflow/3p/model.hh | 9 +++------
dumux/porousmediumflow/3p3c/model.hh | 9 +++------
dumux/porousmediumflow/3pwateroil/model.hh | 9 +++------
dumux/porousmediumflow/mpnc/model.hh | 2 +-
11 files changed, 29 insertions(+), 62 deletions(-)
diff --git a/dumux/porousmediumflow/1p/model.hh b/dumux/porousmediumflow/1p/model.hh
index f640740c64..f2e3aa07f5 100644
--- a/dumux/porousmediumflow/1p/model.hh
+++ b/dumux/porousmediumflow/1p/model.hh
@@ -22,13 +22,9 @@
* \brief A single-phase, isothermal flow model using the fully implicit scheme.
*
* Single-phase, isothermal flow model, which uses a standard Darcy approach as the
- * equation for the conservation of momentum:
- * \f[
- v = - \frac{\textbf K}{\mu}
- \left(\textbf{grad}\, p - \varrho {\textbf g} \right)
- * \f]
+ * equation for the conservation of momentum. For details on Darcy's law see dumux/flux/darcyslaw.hh.
*
- * and solves the mass continuity equation:
+ * Further it solves the mass continuity equation:
* \f[
\phi \frac{\partial \varrho}{\partial t} + \text{div} \left\lbrace
- \varrho \frac{\textbf K}{\mu} \left( \textbf{grad}\, p -\varrho {\textbf g} \right) \right\rbrace = q,
diff --git a/dumux/porousmediumflow/1pnc/model.hh b/dumux/porousmediumflow/1pnc/model.hh
index 53e63d40c8..8aa28412bb 100644
--- a/dumux/porousmediumflow/1pnc/model.hh
+++ b/dumux/porousmediumflow/1pnc/model.hh
@@ -23,14 +23,9 @@
*
* This model implements a one-phase flow of a compressible fluid, that consists
* of n components, using a standard Darcy approach as the equation for the
- * conservation of momentum:
- \f[
- v = - \frac{\textbf K}{\mu}
- \left(\textbf{grad}\, p - \varrho {\textbf g} \right)
- \f]
- *
+ * conservation of momentum. For details on Darcy's law see dumux/flux/darcyslaw.hh.
* Gravity can be enabled or disabled via the property system.
- * By inserting this into the continuity equation, one gets
+ * By inserting Darcy's law into the continuity equation, one gets
\f[
\phi\frac{\partial \varrho}{\partial t} - \text{div} \left\{
\varrho \frac{\textbf K}{\mu} \left(\textbf{grad}\, p - \varrho {\textbf g} \right)
diff --git a/dumux/porousmediumflow/1pncmin/model.hh b/dumux/porousmediumflow/1pncmin/model.hh
index fa649e56b7..b2fe6b22d6 100644
--- a/dumux/porousmediumflow/1pncmin/model.hh
+++ b/dumux/porousmediumflow/1pncmin/model.hh
@@ -24,13 +24,10 @@
* This model implements one-phase n-component flow of a compressible fluid composed of
* the n components \f$\kappa \f$ in combination with mineral precipitation and dissolution
* of the solid phases. The standard multi-phase Darcy
-* approach is used as the equation for the conservation of momentum:
-* \f[
-v = - \frac{k_{r}}{\mu} \mathbf{K}
-\left(\text{grad}\, p - \varrho_{f} \mathbf{g} \right)
-* \f]
+* approach is used as the equation for the conservation of momentum.
+* For details on Darcy's law see dumux/flux/darcyslaw.hh.
*
-* By inserting this into the equations for the conservation of the
+* By inserting Darcy's law into the equations for the conservation of the
* components, one gets one transport equation for each component
* \f[
\frac{\partial ( \varrho_f X^\kappa \phi )}
diff --git a/dumux/porousmediumflow/2p/model.hh b/dumux/porousmediumflow/2p/model.hh
index aff3ea5656..3eaf8e2a44 100644
--- a/dumux/porousmediumflow/2p/model.hh
+++ b/dumux/porousmediumflow/2p/model.hh
@@ -23,13 +23,10 @@
*
* This model implements two-phase flow of two immiscible fluids
* \f$\alpha \in \{ w, n \}\f$ using a standard multi-phase Darcy
- * approach as the equation for the conservation of momentum, i.e.
- \f[
- v_\alpha = - \frac{k_{r\alpha}}{\mu_\alpha} \textbf{K}
- \left(\textbf{grad}\, p_\alpha - \varrho_{\alpha} {\textbf g} \right)
- \f]
+ * approach as the equation for the conservation of momentum.
+ * For details on Darcy's law see dumux/flux/darcyslaw.hh.
*
- * By inserting this into the equation for the conservation of the
+ * By inserting Darcy's law into the equations for the conservation of the
* phase mass, one gets
\f[
\phi \frac{\partial \varrho_\alpha S_\alpha}{\partial t}
diff --git a/dumux/porousmediumflow/2p1c/model.hh b/dumux/porousmediumflow/2p1c/model.hh
index e92f5afaa4..71c940724b 100644
--- a/dumux/porousmediumflow/2p1c/model.hh
+++ b/dumux/porousmediumflow/2p1c/model.hh
@@ -29,13 +29,10 @@
* The model implements the flow of two phases and one component, i.e. a pure liquid (e.g. water)
* and its vapor (e.g. steam),
* \f$\alpha \in \{ w, n \}\f$ using a standard multi-phase Darcy
- * approach as the equation for the conservation of momentum, i.e.
- \f[
- v_\alpha = - \frac{k_{r\alpha}}{\mu_\alpha} \textbf{K}
- \left(\textbf{grad}\, p_\alpha - \varrho_{\alpha} {\textbf g} \right)
- \f]
+ * approach as the equation for the conservation of momentum.
+ * For details on Darcy's law see dumux/flux/darcyslaw.hh.
*
- * By inserting this into the equation for the conservation of the
+ * By inserting Darcy's law into the equations for the conservation of the
* phase mass, one gets
\f[
\phi \frac{\partial\ \sum_\alpha (\rho_\alpha S_\alpha)}{\partial t} \\-\sum \limits_ \alpha \text{div} \left \{\rho_\alpha \frac{k_{r\alpha}}{\mu_\alpha}
diff --git a/dumux/porousmediumflow/2pnc/model.hh b/dumux/porousmediumflow/2pnc/model.hh
index 0044e73fd4..db48d475ff 100644
--- a/dumux/porousmediumflow/2pnc/model.hh
+++ b/dumux/porousmediumflow/2pnc/model.hh
@@ -26,13 +26,10 @@
* partially miscible fluids \f$\alpha \in \{ w, n \}\f$ composed of the n components
* \f$\kappa \in \{ w, n,\cdots \}\f$ in combination with mineral precipitation and dissolution.
* The solid phases. The standard multiphase Darcy
- * approach is used as the equation for the conservation of momentum:
- * \f[
- * v_\alpha = - \frac{k_{r\alpha}}{\mu_\alpha} \mathbf{K}
- * \left(\text{grad}\, p_\alpha - \varrho_{\alpha} \mathbf{g} \right)
- * \f]
+ * approach is used as the equation for the conservation of momentum.
+ * For details on Darcy's law see dumux/flux/darcyslaw.hh.
*
- * By inserting this into the equations for the conservation of the
+ * By inserting Darcy's law into the equations for the conservation of the
* components, one gets one transport equation for each component
* \f{eqnarray*}{
* && \frac{\partial (\sum_\alpha \varrho_\alpha X_\alpha^\kappa \phi S_\alpha )}
diff --git a/dumux/porousmediumflow/2pncmin/model.hh b/dumux/porousmediumflow/2pncmin/model.hh
index 19b289505a..bca2f73907 100644
--- a/dumux/porousmediumflow/2pncmin/model.hh
+++ b/dumux/porousmediumflow/2pncmin/model.hh
@@ -26,13 +26,10 @@
* partially miscible fluids \f$\alpha \in \{ w, n \}\f$ composed of the n components
* \f$\kappa \in \{ w, n,\cdots \}\f$ in combination with mineral precipitation and dissolution.
* The solid phases. The standard multiphase Darcy
- * approach is used as the equation for the conservation of momentum:
- * \f[
- * v_\alpha = - \frac{k_{r\alpha}}{\mu_\alpha} \mathbf{K}
- * \left(\text{grad}\, p_\alpha - \varrho_{\alpha} \mathbf{g} \right)
- * \f]
+ * approach is used as the equation for the conservation of momentum.
+ * For details on Darcy's law see dumux/flux/darcyslaw.hh.
*
- * By inserting this into the equations for the conservation of the
+ * By inserting Darcy's law into the equations for the conservation of the
* components, one gets one transport equation for each component
* \f{eqnarray*}{
* && \frac{\partial (\sum_\alpha \varrho_\alpha X_\alpha^\kappa \phi S_\alpha )}
diff --git a/dumux/porousmediumflow/3p/model.hh b/dumux/porousmediumflow/3p/model.hh
index 6040375ca7..332dfc8ad3 100644
--- a/dumux/porousmediumflow/3p/model.hh
+++ b/dumux/porousmediumflow/3p/model.hh
@@ -24,13 +24,10 @@
* This model implements three-phase flow of three fluid phases
* \f$\alpha \in \{ water, gas, NAPL \}\f$.
* The standard multiphase Darcy
- * approach is used as the equation for the conservation of momentum, i.e.
- \f[
- v_\alpha = - \frac{k_{r\alpha}}{\mu_\alpha} \textbf{K}
- \left(\textbf{grad}\, p_\alpha - \varrho_{\alpha} {\textbf g} \right)
- \f]
+ * approach is used as the equation for the conservation of momentum.
+ * For details on Darcy's law see dumux/flux/darcyslaw.hh.
*
- * By inserting this into the equations for the conservation
+ * By inserting Darcy's law into the equations for the conservation
* of the phase mass, one gets
\f[
\phi \frac{\partial \varrho_\alpha S_\alpha}{\partial t}
diff --git a/dumux/porousmediumflow/3p3c/model.hh b/dumux/porousmediumflow/3p3c/model.hh
index bc365c4ff0..28a4cacecb 100644
--- a/dumux/porousmediumflow/3p3c/model.hh
+++ b/dumux/porousmediumflow/3p3c/model.hh
@@ -25,13 +25,10 @@
* This model implements three-phase three-component flow of three fluid phases
* \f$\alpha \in \{ water, gas, NAPL \}\f$ each composed of up to three components
* \f$\kappa \in \{ water, air, contaminant \}\f$. The standard multiphase Darcy
- * approach is used as the equation for the conservation of momentum:
- * \f[
- v_\alpha = - \frac{k_{r\alpha}}{\mu_\alpha} \mathbf{K}
- \left(\textbf{grad}\, p_\alpha - \varrho_{\alpha} \mathbf{g} \right)
- * \f]
+ * approach is used as the equation for the conservation of momentum.
+ * For details on Darcy's law see dumux/flux/darcyslaw.hh.
*
- * By inserting this into the equations for the conservation of the
+ * By inserting Darcy's law into the equations for the conservation of the
* components, one transport equation for each component is obtained as
* \f{eqnarray*}
&& \phi \frac{\partial (\sum_\alpha \varrho_{\alpha,mol} x_\alpha^\kappa
diff --git a/dumux/porousmediumflow/3pwateroil/model.hh b/dumux/porousmediumflow/3pwateroil/model.hh
index 8edbe4264e..6a5a25eb95 100644
--- a/dumux/porousmediumflow/3pwateroil/model.hh
+++ b/dumux/porousmediumflow/3pwateroil/model.hh
@@ -26,13 +26,10 @@
* This model implements three-phase two-component flow of three fluid phases
* \f$\alpha \in \{ water, gas, NAPL \}\f$ each composed of up to two components
* \f$\kappa \in \{ water, contaminant \}\f$. The standard multiphase Darcy
- * approach is used as the equation for the conservation of momentum:
- * \f[
- v_\alpha = - \frac{k_{r\alpha}}{\mu_\alpha} \mathbf{K}
- \left(\textbf{grad}\, p_\alpha - \varrho_{\alpha} \mathbf{g} \right)
- * \f]
+ * approach is used as the equation for the conservation of momentum.
+ * For details on Darcy's law see dumux/flux/darcyslaw.hh.
*
- * By inserting this into the equations for the conservation of the
+ * By inserting Darcy's law into the equations for the conservation of the
* components, one transport equation for each component is obtained as
* \f{eqnarray*}
&& \phi \frac{\partial (\sum_\alpha \varrho_\alpha X_\alpha^\kappa
diff --git a/dumux/porousmediumflow/mpnc/model.hh b/dumux/porousmediumflow/mpnc/model.hh
index f1c8e9083c..dddd5e6bef 100644
--- a/dumux/porousmediumflow/mpnc/model.hh
+++ b/dumux/porousmediumflow/mpnc/model.hh
@@ -30,7 +30,7 @@
*
* The momentum approximation can be selected via "BaseFluxVariables":
* Darcy (ImplicitDarcyFluxVariables) and Forchheimer (ImplicitForchheimerFluxVariables)
- * relations are available for all Box models.
+ * relations are available for all Box models. For details on Darcy's law see dumux/flux/darcyslaw.hh.
*
* By inserting this into the equations for the conservation of the
* mass of each component, one gets one mass-continuity equation for
--
GitLab
From 917a862e930c55f696b9bf0f22df4f2d5ac1850c Mon Sep 17 00:00:00 2001
From: Timo Koch
Date: Fri, 1 Jul 2022 08:11:37 +0000
Subject: [PATCH 3/3] [documentation][flux] improve description of Darcy flux
---
dumux/flux/darcyslaw.hh | 8 ++++----
dumux/porousmediumflow/1p/model.hh | 2 +-
2 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/dumux/flux/darcyslaw.hh b/dumux/flux/darcyslaw.hh
index bde9f282a7..6795a02968 100644
--- a/dumux/flux/darcyslaw.hh
+++ b/dumux/flux/darcyslaw.hh
@@ -19,12 +19,12 @@
/*!
* \file
* \ingroup Flux
- * \brief
+ * \brief Advective fluxes according to Darcy's law
*
- * Darcy's law describes the advective flux in porous media on the macro-scale and is valid for Reynolds numbers below 1.
+ * Darcy's law describes the advective flux in porous media on the macro-scale and is valid in the creeping flow regime (Reynolds number << 1).
* The advective flux characterizes the bulk flow for each fluid phase including all components in case of compositional flow.
* It is driven by the potential gradient \f$\textbf{grad}\, p - \varrho {\textbf g}\f$,
- * accounting for both pressure difference and gravitation.
+ * accounting for both pressure-driven and gravitationally-driven flow.
* The velocity is proportional to the potential gradient with the proportional factor \f$\frac{\textbf K}{\mu}\f$,
* including the intrinsic permeability of the porous medium, and the viscosity µ of the fluid phase. For one-phase flow it is:
* \f[
@@ -32,7 +32,7 @@
* \left(\textbf{grad}\, p - \varrho {\mathbf g} \right)
* \f]
* This equation can be extended to calculate the velocity \f$v_\alpha\f$ of phase \f$\alpha\f$ in the case of multi-phase
- * flow by considering the relative permeability \f$k_{r\alpha}\f$:
+ * flow by introducing a relative permeability \f$k_{r\alpha}\f$ restricting flow in the presence of other phases:
* \f[
* v_\alpha = - \frac{k_{r\alpha}}{\mu_\alpha} \mathbf{K}
* \left(\text{grad}\, p_\alpha - \varrho_{\alpha} \mathbf{g} \right)
diff --git a/dumux/porousmediumflow/1p/model.hh b/dumux/porousmediumflow/1p/model.hh
index f2e3aa07f5..8fc8209492 100644
--- a/dumux/porousmediumflow/1p/model.hh
+++ b/dumux/porousmediumflow/1p/model.hh
@@ -24,7 +24,7 @@
* Single-phase, isothermal flow model, which uses a standard Darcy approach as the
* equation for the conservation of momentum. For details on Darcy's law see dumux/flux/darcyslaw.hh.
*
- * Further it solves the mass continuity equation:
+ * Furthermore, it solves the mass continuity equation:
* \f[
\phi \frac{\partial \varrho}{\partial t} + \text{div} \left\lbrace
- \varrho \frac{\textbf K}{\mu} \left( \textbf{grad}\, p -\varrho {\textbf g} \right) \right\rbrace = q,
--
GitLab