From 0652343e14e0b47496063b165d1047b366c08b10 Mon Sep 17 00:00:00 2001
From: Markus Wolff <markus.wolff@twt-gmbh.de>
Date: Thu, 26 Sep 2013 13:18:56 +0000
Subject: [PATCH] Improved doxygen documentation
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@11572 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
.../2p/diffusion/fvmpfa/lmethod/fvmpfal2dpressure2p.hh | 7 ++-----
.../lmethod/fvmpfal3dinteractionvolumecontainer.hh | 2 +-
.../fvmpfal3dinteractionvolumecontaineradaptive.hh | 2 +-
.../2p/diffusion/fvmpfa/lmethod/fvmpfal3dpressure2p.hh | 9 +++++++--
.../fvmpfa/lmethod/fvmpfal3dpressure2padaptive.hh | 9 ++++++---
.../lmethod/fvmpfal3dtransmissibilitycalculator.hh | 2 +-
6 files changed, 18 insertions(+), 13 deletions(-)
diff --git a/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal2dpressure2p.hh b/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal2dpressure2p.hh
index 719ca9a258..b1522fda28 100644
--- a/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal2dpressure2p.hh
+++ b/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal2dpressure2p.hh
@@ -43,12 +43,9 @@ namespace Dumux
* Here, \f$ \Phi_\alpha \f$ denotes the potential of phase \f$ \alpha \f$, \f$ \boldsymbol K \f$ the intrinsic permeability,
* \f$ \lambda_t \f$ the total mobility, \f$ f_\alpha \f$ the phase fractional flow function.
*
- * More details on the equations can be found in H. Hoteit, A. Firoozabadi.
- * Numerical modeling of thwo-phase flow in heterogeneous permeable media with different capillarity pressures. Adv Water Res (31), 2008
+ * More details on the equations can be found...
*
- * Remark1: only for 2-D quadrilateral grid
- *
- * Remark2: implemented for UGGrid, ALUGrid, or SGrid/YaspGrid
+ * Remark: only for 3-d hexahedral grids
*
*\tparam TypeTag The problem Type Tag
*/
diff --git a/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dinteractionvolumecontainer.hh b/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dinteractionvolumecontainer.hh
index 6efe579a9e..eb171fbb73 100644
--- a/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dinteractionvolumecontainer.hh
+++ b/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dinteractionvolumecontainer.hh
@@ -37,7 +37,7 @@ bool sort_compare(const std::vector<int>& entryI, const std::vector<int>& entryJ
return (entryI[1] < entryJ[1]);
}
-//! \ingroup diffusion
+//! \ingroup FVPressure2p
/*! Interactionvolume container for 3-d MPFA L-method
*/
template<class TypeTag>
diff --git a/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dinteractionvolumecontaineradaptive.hh b/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dinteractionvolumecontaineradaptive.hh
index c7878e6061..4169e8815d 100644
--- a/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dinteractionvolumecontaineradaptive.hh
+++ b/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dinteractionvolumecontaineradaptive.hh
@@ -33,7 +33,7 @@
namespace Dumux
{
-//! \ingroup diffusion
+//! \ingroup FVPressure2p
/*! Interactionvolume container for 3-d MPFA L-method
*/
template<class TypeTag>
diff --git a/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dpressure2p.hh b/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dpressure2p.hh
index 57bb073e04..91c56e8dfb 100644
--- a/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dpressure2p.hh
+++ b/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dpressure2p.hh
@@ -34,7 +34,7 @@
namespace Dumux
{
-//! \ingroup diffusion
+//! \ingroup FVPressure2p
/*! Finite Volume-MPFAL-Implementation of the equation
* \f$ - \text{div}\, \mathbf{v}_t = - \text{div}\, (\lambda_t \mathbf{K} \text{grad}\, \Phi_w + f_n \lambda_t \mathbf{K} \text{grad}\, \Phi_{cap} ) = 0, \f$, or
* \f$ - \text{div}\, \mathbf{v}_t = - \text{div}\, (\lambda_t \mathbf{K} \text{grad}\, \Phi_n - f_w \lambda_t \mathbf{K} \text{grad}\, \Phi_{cap} ) = 0, \f$.
@@ -43,8 +43,13 @@ namespace Dumux
* on \f$\Gamma_2\f$. Here,
* \f$Phi_\alpha \f$ denotes the potential of phase \f$\alpha\f$, \f$K\f$ the intrinsic permeability,
* \f$\lambda_t\f$ the total mobility, \f$this->f_\alpha\f$ the phase fractional flow function.
+ *
* More details on the equations can be found in
- * H. Hoteit, A. Firoozabadi. Numerical modeling of thwo-phase flow in heterogeneous permeable media with different capillarity pressures. Adv Water Res (31), 2008
+ * M. Wolff, Y. Cao, B. Flemisch, R. Helmig, and B. Wohlmuth (2013a). Multi-point flux
+ * approximation L-method in 3D: numerical convergence and application to two-phase
+ * flow through porous media. In P. Bastian, J. Kraus, R. Scheichl, and M. Wheeler,
+ * editors, Simulation of Flow in Porous Media - Applications in Energy and Environment. De Gruyter.
+ *
*/
template<class TypeTag>
class FvMpfaL3dPressure2p: public FVPressure<TypeTag>
diff --git a/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dpressure2padaptive.hh b/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dpressure2padaptive.hh
index 5459ae32a4..8446769870 100644
--- a/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dpressure2padaptive.hh
+++ b/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dpressure2padaptive.hh
@@ -33,7 +33,7 @@
namespace Dumux
{
-//! \ingroup diffusion
+//! \ingroup FVPressure2p
/*! Finite Volume-MPFAL-Implementation of the equation
* \f$ - \text{div}\, \mathbf{v}_t = - \text{div}\, (\lambda_t \mathbf{K} \text{grad}\, \Phi_w + f_n \lambda_t \mathbf{K} \text{grad}\, \Phi_{cap} ) = 0, \f$, or
* \f$ - \text{div}\, \mathbf{v}_t = - \text{div}\, (\lambda_t \mathbf{K} \text{grad}\, \Phi_n - f_w \lambda_t \mathbf{K} \text{grad}\, \Phi_{cap} ) = 0, \f$.
@@ -42,8 +42,11 @@ namespace Dumux
* on \f$\Gamma_2\f$. Here,
* \f$Phi_\alpha \f$ denotes the potential of phase \f$\alpha\f$, \f$K\f$ the intrinsic permeability,
* \f$\lambda_t\f$ the total mobility, \f$this->f_\alpha\f$ the phase fractional flow function.
- * More details on the equations can be found in
- * H. Hoteit, A. Firoozabadi. Numerical modeling of thwo-phase flow in heterogeneous permeable media with different capillarity pressures. Adv Water Res (31), 2008
+ *
+ * M. Wolff, Y. Cao, B. Flemisch, R. Helmig, and B. Wohlmuth (2013a). Multi-point flux
+ * approximation L-method in 3D: numerical convergence and application to two-phase
+ * flow through porous media. In P. Bastian, J. Kraus, R. Scheichl, and M. Wheeler,
+ * editors, Simulation of Flow in Porous Media - Applications in Energy and Environment. De Gruyter.
*/
template<class TypeTag>
class FvMpfaL3dPressure2pAdaptive: public FvMpfaL3dPressure2p<TypeTag>
diff --git a/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dtransmissibilitycalculator.hh b/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dtransmissibilitycalculator.hh
index 9c2bb469a4..d563843316 100644
--- a/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dtransmissibilitycalculator.hh
+++ b/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dtransmissibilitycalculator.hh
@@ -29,7 +29,7 @@
namespace Dumux
{
-//! \ingroup diffusion
+//! \ingroup FVPressure2p
/*! Provides methods for transmissibility calculation.
*/
template<class TypeTag>
--
GitLab