Commit 0652343e authored by Markus Wolff's avatar Markus Wolff
Browse files

Improved doxygen documentation



git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@11572 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent b6467f62
......@@ -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
*/
......
......@@ -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>
......
......@@ -33,7 +33,7 @@
namespace Dumux
{
//! \ingroup diffusion
//! \ingroup FVPressure2p
/*! Interactionvolume container for 3-d MPFA L-method
*/
template<class TypeTag>
......
......@@ -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>
......
......@@ -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>
......
......@@ -29,7 +29,7 @@
namespace Dumux
{
//! \ingroup diffusion
//! \ingroup FVPressure2p
/*! Provides methods for transmissibility calculation.
*/
template<class TypeTag>
......
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