From 71da3343e34ebee90e509005ce51ef71e17c6a58 Mon Sep 17 00:00:00 2001
From: Thomas Fetzer <thomas.fetzer@iws.uni-stuttgart.de>
Date: Wed, 17 Sep 2014 11:56:18 +0000
Subject: [PATCH] [doxygen] updated doxgen docu, 3 warnings left
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@13350 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
dumux/decoupled/1p/diffusion/fv/fvpressure1p.hh | 4 ++--
.../1p/diffusion/fv/fvpressurevelocity1p.hh | 4 ++--
dumux/decoupled/2p/diffusion/fv/fvpressure2p.hh | 3 +--
.../2p/diffusion/fv/fvpressure2padaptive.hh | 2 +-
.../diffusion/fvmpfa/lmethod/fvmpfal2dpressure2p.hh | 4 ++--
.../fvmpfa/lmethod/fvmpfal2dpressurevelocity2p.hh | 4 ++--
.../lmethod/fvmpfal2dpressurevelocity2padaptive.hh | 4 ++--
.../diffusion/fvmpfa/lmethod/fvmpfal3dpressure2p.hh | 5 ++---
.../fvmpfa/lmethod/fvmpfal3dpressurevelocity2p.hh | 5 ++---
.../diffusion/fvmpfa/omethod/fvmpfao2dpressure2p.hh | 6 ++----
.../fvmpfa/omethod/fvmpfao2dpressurevelocity2p.hh | 5 ++---
...mpfal3d2p2cinteractionvolumecontaineradaptive.hh | 4 ++--
.../mpnc/energy/mpnclocalresidualenergykinetic.hh | 13 +++++++------
dumux/linear/amgparallelhelpers.hh | 7 +++----
.../fluidmatrixinteractions/2p/heatpipelaw.hh | 3 +++
15 files changed, 35 insertions(+), 38 deletions(-)
diff --git a/dumux/decoupled/1p/diffusion/fv/fvpressure1p.hh b/dumux/decoupled/1p/diffusion/fv/fvpressure1p.hh
index ad7f3a5550..8786ec38a0 100644
--- a/dumux/decoupled/1p/diffusion/fv/fvpressure1p.hh
+++ b/dumux/decoupled/1p/diffusion/fv/fvpressure1p.hh
@@ -112,7 +112,7 @@ public:
/*! \brief Initializes the pressure model
*
- * \copydetails ParentType::initialize()
+ * \copydetails FVPressure::initialize()
*
* \param solveTwice indicates if more than one iteration is allowed to get an initial pressure solution
*/
@@ -132,7 +132,7 @@ public:
/*! \brief Pressure update
*
- * \copydetails ParentType::update()
+ * \copydetails FVPressure::update()
*
*/
void update()
diff --git a/dumux/decoupled/1p/diffusion/fv/fvpressurevelocity1p.hh b/dumux/decoupled/1p/diffusion/fv/fvpressurevelocity1p.hh
index 215bb35708..d1411fc0f9 100644
--- a/dumux/decoupled/1p/diffusion/fv/fvpressurevelocity1p.hh
+++ b/dumux/decoupled/1p/diffusion/fv/fvpressurevelocity1p.hh
@@ -59,7 +59,7 @@ template<class TypeTag> class FVPressureVelocity1P: public FVPressure1P<TypeTag>
public:
/*! \brief Initializes the pressure model
*
- * \copydetails ParentType::initialize()
+ * \copydetails FVPressure::initialize()
*/
void initialize()
{
@@ -69,7 +69,7 @@ public:
/*! \brief Pressure update
*
- * \copydetails ParentType::update()
+ * \copydetails FVPressure::update()
*
*/
void update()
diff --git a/dumux/decoupled/2p/diffusion/fv/fvpressure2p.hh b/dumux/decoupled/2p/diffusion/fv/fvpressure2p.hh
index 15c28b3971..1751ced59e 100644
--- a/dumux/decoupled/2p/diffusion/fv/fvpressure2p.hh
+++ b/dumux/decoupled/2p/diffusion/fv/fvpressure2p.hh
@@ -240,8 +240,7 @@ public:
/*! \brief Pressure update
*
- * \copydetails ParentType::update()
- *
+ * \copydetails FVPressure::update()
*/
void update()
{
diff --git a/dumux/decoupled/2p/diffusion/fv/fvpressure2padaptive.hh b/dumux/decoupled/2p/diffusion/fv/fvpressure2padaptive.hh
index a23a33afd2..aabcab61a0 100644
--- a/dumux/decoupled/2p/diffusion/fv/fvpressure2padaptive.hh
+++ b/dumux/decoupled/2p/diffusion/fv/fvpressure2padaptive.hh
@@ -120,7 +120,7 @@ public:
/*! \brief Pressure update
*
- * \copydetails FVPressure2P::update()
+ * \copydetails FVPressure::update()
*
* The grid-adaptive implementation also reconstructs the velocity directly after the pressure update.
* This is necessary to make sure the hanging nodes are treated correctly!
diff --git a/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal2dpressure2p.hh b/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal2dpressure2p.hh
index a87b7d8307..2d0e43fd64 100644
--- a/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal2dpressure2p.hh
+++ b/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal2dpressure2p.hh
@@ -186,7 +186,7 @@ public:
/*! \brief Initializes the pressure model
*
- * \copydetails ParentType::initialize()
+ * \copydetails FVPressure::initialize()
*/
void initialize()
{
@@ -285,7 +285,7 @@ public:
/*! \brief Pressure update
*
- * \copydetails ParentType::update()
+ * \copydetails FVPressure::update()
*
*/
void update()
diff --git a/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal2dpressurevelocity2p.hh b/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal2dpressurevelocity2p.hh
index 3d2787d798..fb5076f9c9 100644
--- a/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal2dpressurevelocity2p.hh
+++ b/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal2dpressurevelocity2p.hh
@@ -133,7 +133,7 @@ public:
/*! \brief Initializes pressure and velocity
*
- * \copydetails ParentType::initialize()
+ * \copydetails FVPressure::initialize()
*/
void initialize()
{
@@ -159,7 +159,7 @@ public:
/*! \brief Pressure and velocity update
*
- * \copydetails ParentType::update()
+ * \copydetails FVPressure::update()
*
*/
void update()
diff --git a/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal2dpressurevelocity2padaptive.hh b/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal2dpressurevelocity2padaptive.hh
index f392a69595..97e7247d5d 100644
--- a/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal2dpressurevelocity2padaptive.hh
+++ b/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal2dpressurevelocity2padaptive.hh
@@ -143,7 +143,7 @@ public:
/*! \brief Initializes pressure and velocity
*
- * \copydetails ParentType::initialize()
+ * \copydetails FVPressure::initialize()
*/
void initialize()
{
@@ -169,7 +169,7 @@ public:
/*! \brief Pressure and velocity update
*
- * \copydetails ParentType::update()
+ * \copydetails FVPressure::update()
*
*/
void update()
diff --git a/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dpressure2p.hh b/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dpressure2p.hh
index 4a9a92fc8c..9b98243fe8 100644
--- a/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dpressure2p.hh
+++ b/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dpressure2p.hh
@@ -176,7 +176,7 @@ public:
/*! \brief Initializes the pressure model
*
- * \copydetails ParentType::initialize()
+ * \copydetails FVPressure::initialize()
*/
void initialize(bool solveTwice = true)
{
@@ -269,8 +269,7 @@ public:
/*! \brief Pressure update
*
- * \copydetails ParentType::update()
- *
+ * \copydetails FVPressure::update()
*/
void update()
{
diff --git a/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dpressurevelocity2p.hh b/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dpressurevelocity2p.hh
index 75e2e3149d..c16a3b4764 100644
--- a/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dpressurevelocity2p.hh
+++ b/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dpressurevelocity2p.hh
@@ -128,7 +128,7 @@ public:
/*! \brief Initializes pressure and velocity
*
- * \copydetails ParentType::initialize()
+ * \copydetails FVPressure::initialize()
*/
void initialize(bool solveTwice = true)
{
@@ -155,8 +155,7 @@ public:
/*! \brief Pressure and velocity update
*
- * \copydetails ParentType::update()
- *
+ * \copydetails FVPressure::update()
*/
void update()
{
diff --git a/dumux/decoupled/2p/diffusion/fvmpfa/omethod/fvmpfao2dpressure2p.hh b/dumux/decoupled/2p/diffusion/fvmpfa/omethod/fvmpfao2dpressure2p.hh
index 3cbb42436a..d53618e429 100644
--- a/dumux/decoupled/2p/diffusion/fvmpfa/omethod/fvmpfao2dpressure2p.hh
+++ b/dumux/decoupled/2p/diffusion/fvmpfa/omethod/fvmpfao2dpressure2p.hh
@@ -170,8 +170,7 @@ public:
/*! \brief Initializes the pressure model
*
- * \copydetails ParentType::initialize()
- *
+ * \copydetails FVPressure::initialize()
*/
void initialize()
{
@@ -206,8 +205,7 @@ public:
/*! \brief Pressure update
*
- * \copydetails ParentType::update()
- *
+ * \copydetails FVPressure::update()
*/
void update()
{
diff --git a/dumux/decoupled/2p/diffusion/fvmpfa/omethod/fvmpfao2dpressurevelocity2p.hh b/dumux/decoupled/2p/diffusion/fvmpfa/omethod/fvmpfao2dpressurevelocity2p.hh
index 16b53da386..66973867e8 100644
--- a/dumux/decoupled/2p/diffusion/fvmpfa/omethod/fvmpfao2dpressurevelocity2p.hh
+++ b/dumux/decoupled/2p/diffusion/fvmpfa/omethod/fvmpfao2dpressurevelocity2p.hh
@@ -134,7 +134,7 @@ public:
/*! \brief Initializes pressure and velocity
*
- * \copydetails ParentType::initialize()
+ * \copydetails FVPressure::initialize()
*/
void initialize()
{
@@ -160,8 +160,7 @@ public:
/*! \brief Pressure and velocity update
*
- * \copydetails ParentType::update()
- *
+ * \copydetails FVPressure::update()
*/
void update()
{
diff --git a/dumux/decoupled/2p2c/fvmpfal3d2p2cinteractionvolumecontaineradaptive.hh b/dumux/decoupled/2p2c/fvmpfal3d2p2cinteractionvolumecontaineradaptive.hh
index d1750c6042..26e6678a4a 100644
--- a/dumux/decoupled/2p2c/fvmpfal3d2p2cinteractionvolumecontaineradaptive.hh
+++ b/dumux/decoupled/2p2c/fvmpfal3d2p2cinteractionvolumecontaineradaptive.hh
@@ -32,8 +32,8 @@
namespace Dumux
{
-//! \ingroup Adaptive2p2c mpfa
-/*! \brief Interactionvolume container for compositional adaptive 3-d (using MPFA L-method) Model
+/*! \ingroup Adaptive2p2c mpfa
+ * \brief Interactionvolume container for compositional adaptive 3-d (using MPFA L-method) Model
*
* Container class which stores MPFA-interaction-volume information for each vertex of a DUNE grid.
*
diff --git a/dumux/implicit/mpnc/energy/mpnclocalresidualenergykinetic.hh b/dumux/implicit/mpnc/energy/mpnclocalresidualenergykinetic.hh
index 626dbd6a61..ea2cbc991a 100644
--- a/dumux/implicit/mpnc/energy/mpnclocalresidualenergykinetic.hh
+++ b/dumux/implicit/mpnc/energy/mpnclocalresidualenergykinetic.hh
@@ -583,13 +583,14 @@ public:
+
(1.-massUpwindWeight_) * transportedThingDn ) ;
}
+
/*! \brief The heat conduction in the phase
- *
- * \param flux The flux over the SCV (sub-control-volume) face for each component
- * \param fluxVars The flux Variables
- * \param elemVolVars The volume variables of the current element
- * \param phaseIdx The local index of the phases
- */
+ *
+ * \param flux The flux over the SCV (sub-control-volume) face for each component
+ * \param fluxVars The flux Variables
+ * \param elemVolVars The volume variables of the current element
+ * \param energyEqIdx The index of the phase energy equation
+ */
static void computeHeatConduction(PrimaryVariables & flux,
const FluxVariables & fluxVars,
const ElementVolumeVariables & elemVolVars,
diff --git a/dumux/linear/amgparallelhelpers.hh b/dumux/linear/amgparallelhelpers.hh
index 4d720b4e64..fe9ddcfcf2 100644
--- a/dumux/linear/amgparallelhelpers.hh
+++ b/dumux/linear/amgparallelhelpers.hh
@@ -499,8 +499,7 @@ class EntityExchanger
public:
/*! \brief Constructor. Sets up the local to global relations.
-
- \param[in] gridView The grid view to operate on.
+ \param[in] problem The problem to be solved.
*/
EntityExchanger(const Problem& problem)
: problem_(problem)
@@ -633,7 +632,7 @@ public:
}
/** @brief Constructor
- @param[in] gridView Grid view.
+ @param[in] problem The problem to be solved.
@param[in] g2i Global to local index map.
@param[in] i2g Local to global index map.
@param[in] A Matrix to operate on.
@@ -739,7 +738,7 @@ public:
}
/** @brief Constructor
- @param[in] gridView Grid view.
+ @param[in] problem The problem to be solved.
@param[in] g2i Global to local index map.
@param[in] i2g Local to global index map.
@param[in] A Matrix to operate on.
diff --git a/dumux/material/fluidmatrixinteractions/2p/heatpipelaw.hh b/dumux/material/fluidmatrixinteractions/2p/heatpipelaw.hh
index 5197280472..9c9b28a8fe 100644
--- a/dumux/material/fluidmatrixinteractions/2p/heatpipelaw.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/heatpipelaw.hh
@@ -55,6 +55,7 @@ public:
/*!
* \brief The capillary pressure-saturation curve.
*
+ * \param params Array of parameters
* \param Sw Effective saturation of of the wetting phase \f$\overline{S}_w\f$
*/
static Scalar pc(const Params ¶ms, Scalar Sw)
@@ -118,6 +119,7 @@ public:
/*!
* \brief The relative permeability for the wetting phase.
*
+ * \param params Array of parameters
* \param Sw The mobile saturation of the wetting phase.
*/
static Scalar krw(const Params ¶ms, Scalar Sw)
@@ -128,6 +130,7 @@ public:
/*!
* \brief The relative permeability for the non-wetting phase.
*
+ * \param params Array of parameters
* \param Sw The mobile saturation of the wetting phase.
*/
static Scalar krn(const Params ¶ms, Scalar Sw)
--
GitLab