From d42173cb5883176a81f1b2d72ebf92df5dd7bab1 Mon Sep 17 00:00:00 2001
From: Benjamin Faigle <benjamin.faigle@posteo.de>
Date: Tue, 11 Feb 2014 14:57:33 +0000
Subject: [PATCH] Add new doxygen module for the MPFA backbone (data structure,
transmissibility caluclation, properties) to improve overview given the
multitude of files.
Add the indice saturationN (etc) as an alternative to the preposterous saturationNw (etc.)
reviewed by Thomas
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@12458 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
doc/doxygen/modules | 6 ++++++
dumux/decoupled/2p/2pindices.hh | 9 ++++++---
.../lmethod/fvmpfal2dtransmissibilitycalculator.hh | 2 +-
.../lmethod/fvmpfal3dinteractionvolumecontainer.hh | 2 +-
.../fvmpfal3dinteractionvolumecontaineradaptive.hh | 2 +-
dumux/decoupled/2p2c/variableclass2p2cadaptive.hh | 2 +-
dumux/decoupled/common/fv/mpfa/fvmpfaproperties.hh | 2 +-
7 files changed, 17 insertions(+), 8 deletions(-)
diff --git a/doc/doxygen/modules b/doc/doxygen/modules
index 5648fd6cf1..186582d2aa 100644
--- a/doc/doxygen/modules
+++ b/doc/doxygen/modules
@@ -277,6 +277,12 @@
* \ingroup Sequential
* \defgroup IMPET Models
*/
+
+ /*!
+ * \ingroup IMPET
+ * \defgroup mpfa MPFA framework
+ */
+
/*!
* \ingroup IMPET
* \defgroup OnePhase Single Phase (FV)
diff --git a/dumux/decoupled/2p/2pindices.hh b/dumux/decoupled/2p/2pindices.hh
index e325c50753..12fe9e2cca 100644
--- a/dumux/decoupled/2p/2pindices.hh
+++ b/dumux/decoupled/2p/2pindices.hh
@@ -53,16 +53,19 @@ struct DecoupledTwoPCommonIndices
//saturation flags
static const int saturationW = 0; //!< Indicates wetting phase saturation
- static const int saturationNw = 1; //!< Indicates non-wetting phase saturation
+ static const int saturationN = 1; //!< Indicates non-wetting phase saturation
+ static const int saturationNw = saturationN; //!< Indicates non-wetting phase saturation
//pressure flags
static const int pressureW = 0; //!< Indicates wetting phase pressure
- static const int pressureNw = 1; //!< Indicates non-wetting phase pressure
+ static const int pressureN = 1; //!< Indicates non-wetting phase pressure
+ static const int pressureNw = pressureN; //!< Indicates non-wetting phase pressure
static const int pressureGlobal = 2; //!< Indicates global-pressure
//velocity flags
static const int velocityW = 0; //!< Indicates wetting phase velocity
- static const int velocityNw = 1; //!< Indicates non-wetting phase velocity
+ static const int velocityN = 1; //!< Indicates non-wetting phase velocity
+ static const int velocityNw = velocityN; //!< Indicates non-wetting phase velocity
static const int velocityTotal = 2; //!< Indicates total velocity
};
diff --git a/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal2dtransmissibilitycalculator.hh b/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal2dtransmissibilitycalculator.hh
index fb80cc97c8..57b94095c3 100644
--- a/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal2dtransmissibilitycalculator.hh
+++ b/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal2dtransmissibilitycalculator.hh
@@ -30,7 +30,7 @@
namespace Dumux
{
-//! \ingroup FVPressure2p
+//! \ingroup FVPressure2p mpfa
/*! \brief Provides methods for transmissibility calculation in 2-d.
*
* The transmissibilities are calculated using the MPFA L-method.
diff --git a/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dinteractionvolumecontainer.hh b/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dinteractionvolumecontainer.hh
index e1473b332f..bf2a0f36c9 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 FVPressure2p
+//! \ingroup FVPressure2p mpfa
/*! \brief Interactionvolume container for 3-d MPFA L-method
*
* Container class which stores MPFA-interaction-volume information for each vertex of a DUNE grid.
diff --git a/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dinteractionvolumecontaineradaptive.hh b/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dinteractionvolumecontaineradaptive.hh
index 3fc27a8bbb..891fbb4425 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 FVPressure2p
+//! \ingroup FVPressure2p mpfa
/*! \brief Interactionvolume container for 3-d MPFA L-method on an h-adaptive grid
*
* Container class which stores MPFA-interaction-volume information for each vertex of a DUNE grid.
diff --git a/dumux/decoupled/2p2c/variableclass2p2cadaptive.hh b/dumux/decoupled/2p2c/variableclass2p2cadaptive.hh
index 1f0a77c952..18d58778cd 100644
--- a/dumux/decoupled/2p2c/variableclass2p2cadaptive.hh
+++ b/dumux/decoupled/2p2c/variableclass2p2cadaptive.hh
@@ -32,7 +32,7 @@
namespace Dumux
{
/*!
- * \ingroup Adaptive2p2c
+ * \ingroup Adaptive2p2c mpfa
*/
//! Class holding additionally mpfa data of adaptive compositional models.
/*!
diff --git a/dumux/decoupled/common/fv/mpfa/fvmpfaproperties.hh b/dumux/decoupled/common/fv/mpfa/fvmpfaproperties.hh
index 74e7f7a55f..6069a2ea99 100644
--- a/dumux/decoupled/common/fv/mpfa/fvmpfaproperties.hh
+++ b/dumux/decoupled/common/fv/mpfa/fvmpfaproperties.hh
@@ -19,7 +19,7 @@
/*!
* \ingroup IMPET
- * \ingroup IMPETProperties
+ * \ingroup IMPETProperties mpfa
* \file
*
* \brief Properties for a MPFA method.
--
GitLab