From 704bef8d1d77875a193c24e8b0d873f13106570c Mon Sep 17 00:00:00 2001
From: Benjamin Faigle <benjamin.faigle@posteo.de>
Date: Mon, 17 Feb 2014 10:31:27 +0000
Subject: [PATCH] Remove Doxygen Errors in decoupled
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@12489 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
.../fvmpfa/lmethod/fvmpfal3dinteractionvolumecontainer.hh | 4 ++--
.../fvmpfa/lmethod/fvmpfal3dpressure2padaptive.hh | 2 +-
.../2p/diffusion/fvmpfa/omethod/fvmpfao2dvelocity2p.hh | 4 ++--
dumux/decoupled/2p2c/fv2dpressure2p2cadaptive.hh | 3 ++-
dumux/decoupled/2p2c/variableclass2p2cadaptive.hh | 1 -
.../decoupled/common/fv/mpfa/mpfalinteractionvolume3d.hh | 2 +-
.../common/fv/mpfa/mpfalinteractionvolume3dadaptive.hh | 8 ++++----
7 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dinteractionvolumecontainer.hh b/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dinteractionvolumecontainer.hh
index bf2a0f36c9..120e70de26 100644
--- a/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dinteractionvolumecontainer.hh
+++ b/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dinteractionvolumecontainer.hh
@@ -150,7 +150,7 @@ public:
//! Returns an interaction volume
/*!
- * \param vertIdx Global index of a vertex in the DUNE grid
+ * \param vertexIdx Global index of a vertex in the DUNE grid
*/
InteractionVolume& interactionVolume(int vertexIdx)
{
@@ -159,7 +159,7 @@ public:
//! Returns an interaction volume
/*!
- * \param vertIdx Global index of a vertex in the DUNE grid
+ * \param vertexIdx Global index of a vertex in the DUNE grid
*/
InteractionVolume& interactionVolume(int vertexIdx) const
{
diff --git a/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dpressure2padaptive.hh b/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dpressure2padaptive.hh
index 053de2140a..4fcf50d9ec 100644
--- a/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dpressure2padaptive.hh
+++ b/dumux/decoupled/2p/diffusion/fvmpfa/lmethod/fvmpfal3dpressure2padaptive.hh
@@ -35,7 +35,7 @@ namespace Dumux
{
//! \ingroup FVPressure2p
/*! \brief 3-d finite volume MPFA L-method discretization of a two-phase flow pressure equation
- *! \of the sequential IMPES model on h-adaptive grids.
+ *! of the sequential IMPES model on h-adaptive grids.
*
* * Finite Volume-MPFAL-Implementation of the equation
*
diff --git a/dumux/decoupled/2p/diffusion/fvmpfa/omethod/fvmpfao2dvelocity2p.hh b/dumux/decoupled/2p/diffusion/fvmpfa/omethod/fvmpfao2dvelocity2p.hh
index 676d2d4936..cdeddb9b48 100644
--- a/dumux/decoupled/2p/diffusion/fvmpfa/omethod/fvmpfao2dvelocity2p.hh
+++ b/dumux/decoupled/2p/diffusion/fvmpfa/omethod/fvmpfao2dvelocity2p.hh
@@ -271,13 +271,13 @@ private:
// end of template
/*! \brief Calculates the velocities at the flux faces of an interation volume around a vertex
- *! \which is not a boundary vertex.
+ *! which is not a boundary vertex.
*
* Calculates the velocities at the flux faces of an interation volume around a vertex which is
* not a boundary vertex and adds them to the face velocity vectors in the <tt>CellData</tt> objects.
*
* \param interactionVolume An <tt>InteractionVolume</tt> object including the information for
- * \calculating the MPFA transmissibilities
+ * calculating the MPFA transmissibilities
* \param cellData1 <tt>CellData</tt> object of an IMPES model for sub-volume 1
* \param cellData2 <tt>CellData</tt> object of an IMPES model for sub-volume 2
* \param cellData3 <tt>CellData</tt> object of an IMPES model for sub-volume 3
diff --git a/dumux/decoupled/2p2c/fv2dpressure2p2cadaptive.hh b/dumux/decoupled/2p2c/fv2dpressure2p2cadaptive.hh
index 22840aa041..0f738a3ee7 100644
--- a/dumux/decoupled/2p2c/fv2dpressure2p2cadaptive.hh
+++ b/dumux/decoupled/2p2c/fv2dpressure2p2cadaptive.hh
@@ -493,7 +493,8 @@ void FV2dPressure2P2CAdaptive<TypeTag>::assemble(bool first)
* through the one unique interaction region on the hanging node if one
* halfedge is stored (eg on boundaries). Or using the second interaction
* region covering neighboring cells.
- * Due to that, the matrix and rhs entries are filled up within this function.
+ * The contribution in other cells than I or J make it necessary that
+ * the matrix and rhs entries are filled up within this function.
* \param intersectionIterator Iterator of the intersection between cell I and J
* \param cellDataI Data of cell I
*/
diff --git a/dumux/decoupled/2p2c/variableclass2p2cadaptive.hh b/dumux/decoupled/2p2c/variableclass2p2cadaptive.hh
index 18d58778cd..a929880225 100644
--- a/dumux/decoupled/2p2c/variableclass2p2cadaptive.hh
+++ b/dumux/decoupled/2p2c/variableclass2p2cadaptive.hh
@@ -448,7 +448,6 @@ public:
* \param irregularIs The current irregular intersection
* \param secondHalfEdgeIntersectionIt Iterator to the intersection connecting the second interaction region
* \param T1 Transmissitivity matrix for flux calculations: unique interaction region
- * \param T1_secondHalfEdge Second transmissitivity matrix for flux calculations for non-unique interaction region
* \param globalPos3 The position of the 3rd cell of the first interaction region
* \param globalIdx3 The index of the 3rd cell of the first interaction region
* \param globalPos4 The position of the 4th cell of the interaction region
diff --git a/dumux/decoupled/common/fv/mpfa/mpfalinteractionvolume3d.hh b/dumux/decoupled/common/fv/mpfa/mpfalinteractionvolume3d.hh
index 81f8087f6b..10290fa352 100644
--- a/dumux/decoupled/common/fv/mpfa/mpfalinteractionvolume3d.hh
+++ b/dumux/decoupled/common/fv/mpfa/mpfalinteractionvolume3d.hh
@@ -104,7 +104,7 @@ const int IndexTranslator::faceIndexFromElements_[subVolumeTotalNum][subVolumeTo
};
//! \endcond
-//! \ingroup IMPET
+//! \ingroup IMPET mpfa
/*! \brief Class including the information of a 3d interaction volume of a MPFA L-method that does not change with time.
*
* Includes information needed to calculate the transmissibility matrices of an L-interaction-volume.
diff --git a/dumux/decoupled/common/fv/mpfa/mpfalinteractionvolume3dadaptive.hh b/dumux/decoupled/common/fv/mpfa/mpfalinteractionvolume3dadaptive.hh
index 7f5234420a..3c90c77cb8 100644
--- a/dumux/decoupled/common/fv/mpfa/mpfalinteractionvolume3dadaptive.hh
+++ b/dumux/decoupled/common/fv/mpfa/mpfalinteractionvolume3dadaptive.hh
@@ -181,7 +181,7 @@ const int IndexTranslatorAdaptive::newEdgeIdxFromOldFaceIdxto0_[fluxFacesTotalNu
};
//! \endcond
-//! \ingroup IMPET
+//! \ingroup IMPET mpfa
/*! \brief Class including the information of a 3d interaction volume of an adaptive MPFA L-method that does not change with time.
*
* Includes information needed to calculate the transmissibility matrices of an L-interaction-volume.
@@ -253,14 +253,14 @@ public:
hangingNodeType_(noHangingNode)
{}
- //!\copydoc
+ //!\copydoc FvMpfaL3dInteractionVolume::reset()
void reset()
{
hangingNodeType_ = noHangingNode;
existingLevel_.clear();
}
- //!\copydoc
+ //!\copydoc FvMpfaL3dInteractionVolume::setSubVolumeElement()
void setSubVolumeElement(ElementPointer pointer, int subVolumeIdx)
{
ParentType::setSubVolumeElement(pointer, subVolumeIdx);
@@ -316,7 +316,7 @@ public:
return hangingNodeType_;
}
- //!\copydoc
+ //!\copydoc FvMpfaL3dInteractionVolume::printInteractionVolumeInfo()
void printInteractionVolumeInfo()
{
ParentType::printInteractionVolumeInfo();
--
GitLab