Commit d42173cb authored by Benjamin Faigle's avatar Benjamin Faigle
Browse files

Add new doxygen module for the MPFA backbone (data structure, transmissibility...

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
parent f9c4e270
......@@ -277,6 +277,12 @@
* \ingroup Sequential
* \defgroup IMPET Models
*/
/*!
* \ingroup IMPET
* \defgroup mpfa MPFA framework
*/
/*!
* \ingroup IMPET
* \defgroup OnePhase Single Phase (FV)
......
......@@ -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
};
......
......@@ -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.
......
......@@ -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.
......
......@@ -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.
......
......@@ -32,7 +32,7 @@
namespace Dumux
{
/*!
* \ingroup Adaptive2p2c
* \ingroup Adaptive2p2c mpfa
*/
//! Class holding additionally mpfa data of adaptive compositional models.
/*!
......
......@@ -19,7 +19,7 @@
/*!
* \ingroup IMPET
* \ingroup IMPETProperties
* \ingroup IMPETProperties mpfa
* \file
*
* \brief Properties for a MPFA method.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment