From 3c2b9fffd7b2498d07325842f13984d36c77c5b1 Mon Sep 17 00:00:00 2001
From: Christoph Grueninger <christoph.grueninger@iws.uni-stuttgart.de>
Date: Fri, 18 May 2012 07:39:05 +0000
Subject: [PATCH] Fixed doxygen comments, most got corrupted by the massive
renaming.
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@8326 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
dumux/boxmodels/1p/1plocalresidual.hh | 2 ++
dumux/boxmodels/2p2cni/2p2cnilocalresidual.hh | 6 +++---
dumux/boxmodels/3p3c/3p3clocalresidual.hh | 2 +-
dumux/boxmodels/3p3c/3p3cvolumevariables.hh | 2 +-
dumux/boxmodels/3p3cni/3p3cnivolumevariables.hh | 4 ++--
dumux/boxmodels/richards/richardsfluxvariables.hh | 4 ++--
dumux/boxmodels/richards/richardslocalresidual.hh | 2 +-
dumux/boxmodels/richards/richardsproblem.hh | 6 +++---
dumux/boxmodels/richards/richardsvolumevariables.hh | 4 ++--
dumux/decoupled/2p2c/fluxData2p2c.hh | 8 ++------
dumux/freeflow/stokes/stokeslocalresidual.hh | 2 +-
test/boxmodels/2p2c/injectionproblem.hh | 2 +-
test/boxmodels/2p2c/injectionspatialparams.hh | 2 +-
test/boxmodels/3p3cni/columnxylolproblem.hh | 2 +-
test/boxmodels/3p3cni/columnxylolspatialparams.hh | 4 ++--
test/boxmodels/3p3cni/kuevettespatialparams.hh | 2 +-
test/boxmodels/mpnc/obstaclespatialparams.hh | 6 +++---
17 files changed, 29 insertions(+), 31 deletions(-)
diff --git a/dumux/boxmodels/1p/1plocalresidual.hh b/dumux/boxmodels/1p/1plocalresidual.hh
index 57d1f1f9d8..8ca34c11b2 100644
--- a/dumux/boxmodels/1p/1plocalresidual.hh
+++ b/dumux/boxmodels/1p/1plocalresidual.hh
@@ -113,6 +113,8 @@ public:
*
* \param flux The flux over the SCV (sub-control-volume) face
* \param faceIdx The index of the SCV face
+ * \param onBoundary A boolean variable to specify whether the flux variables
+ * are calculated for interior SCV faces or boundary faces, default=false
*/
void computeFlux(PrimaryVariables &flux, const int faceIdx, const bool onBoundary=false) const
{
diff --git a/dumux/boxmodels/2p2cni/2p2cnilocalresidual.hh b/dumux/boxmodels/2p2cni/2p2cnilocalresidual.hh
index cceab00613..83f3490576 100644
--- a/dumux/boxmodels/2p2cni/2p2cnilocalresidual.hh
+++ b/dumux/boxmodels/2p2cni/2p2cnilocalresidual.hh
@@ -85,7 +85,7 @@ public:
* The result should be averaged over the volume (e.g. phase mass
* inside a sub control volume divided by the volume)
*
- * \param result The storage of the conservation quantitiy (mass or energy) within the sub-control volume
+ * \param storage The storage of the conservation quantitiy (mass or energy) within the sub-control volume
* \param scvIdx The SCV (sub-control-volume) index
* \param usePrevSol Evaluate function with solution of current or previous time step
*/
@@ -123,7 +123,7 @@ public:
* the flux vector.
*
* \param flux The advective flux over the SCV (sub-control-volume) face for each component
- * \param fluxData The flux variables at the current SCV face
+ * \param fluxVars The flux variables at the current SCV face
*
* This method is called by compute flux (base class)
*/
@@ -158,7 +158,7 @@ public:
* the face of a sub-control volume.
*
* \param flux The diffusive flux over the SCV (sub-control-volume) face for each conservation quantity (mass, energy)
- * \param fluxData The flux variables at the current SCV face
+ * \param fluxVars The flux variables at the current SCV face
*
* This method is called by compute flux (base class)
*/
diff --git a/dumux/boxmodels/3p3c/3p3clocalresidual.hh b/dumux/boxmodels/3p3c/3p3clocalresidual.hh
index 78c5ae1c1a..55910ca378 100644
--- a/dumux/boxmodels/3p3c/3p3clocalresidual.hh
+++ b/dumux/boxmodels/3p3c/3p3clocalresidual.hh
@@ -93,7 +93,7 @@ public:
* The result should be averaged over the volume (e.g. phase mass
* inside a sub control volume divided by the volume)
*
- * \param result The mass of the component within the sub-control volume
+ * \param storage The mass of the component within the sub-control volume
* \param scvIdx The SCV (sub-control-volume) index
* \param usePrevSol Evaluate function with solution of current or previous time step
*/
diff --git a/dumux/boxmodels/3p3c/3p3cvolumevariables.hh b/dumux/boxmodels/3p3c/3p3cvolumevariables.hh
index 52bf03b84b..42a427f0e5 100644
--- a/dumux/boxmodels/3p3c/3p3cvolumevariables.hh
+++ b/dumux/boxmodels/3p3c/3p3cvolumevariables.hh
@@ -114,7 +114,7 @@ public:
/*!
* \brief Update all quantities for a given control volume.
*
- * \param primaryVars The primary variables
+ * \param priVars The primary variables
* \param problem The problem
* \param element The element
* \param fvGeometry The finite-volume geometry in the box scheme
diff --git a/dumux/boxmodels/3p3cni/3p3cnivolumevariables.hh b/dumux/boxmodels/3p3cni/3p3cnivolumevariables.hh
index 2e1d3ee574..1a1742937a 100644
--- a/dumux/boxmodels/3p3cni/3p3cnivolumevariables.hh
+++ b/dumux/boxmodels/3p3cni/3p3cnivolumevariables.hh
@@ -75,8 +75,8 @@ public:
* \param priVars The solution primary variables
* \param problem The problem
* \param element The element
- * \param elemGeom Evaluate function with solution of current or previous time step
- * \param vertIdx The local index of the SCV (sub-control volume)
+ * \param fvGeomtry Evaluate function with solution of current or previous time step
+ * \param scvIdx The local index of the SCV (sub-control volume)
* \param isOldSol Evaluate function with solution of current or previous time step
*/
void update(const PrimaryVariables &priVars,
diff --git a/dumux/boxmodels/richards/richardsfluxvariables.hh b/dumux/boxmodels/richards/richardsfluxvariables.hh
index fdfdce4931..c60d34df17 100644
--- a/dumux/boxmodels/richards/richardsfluxvariables.hh
+++ b/dumux/boxmodels/richards/richardsfluxvariables.hh
@@ -70,8 +70,8 @@ public:
* \param problem The representation of the physical problem
* \param element The DUNE Codim<0> entity which contains the face of
* the finite volume
- * \param fvElemGeom The finite volume geometry of the element
- * \param scvfIdx The local index of the sub-control volume face in the
+ * \param fvGeometry The finite volume geometry of the element
+ * \param faceIdx The local index of the sub-control volume face in the
* element's finite volume geometry.
* \param elemVolVars An array containing the volume variables for all
* sub-control volumes of the element.
diff --git a/dumux/boxmodels/richards/richardslocalresidual.hh b/dumux/boxmodels/richards/richardslocalresidual.hh
index e1c8634dcf..3adcf40cfa 100644
--- a/dumux/boxmodels/richards/richardslocalresidual.hh
+++ b/dumux/boxmodels/richards/richardslocalresidual.hh
@@ -112,7 +112,7 @@ public:
*
* \param flux Stores the total mass fluxes over a sub-control volume face
* of the current element \f$\mathrm{[kg/s]}\f$
- * \param scvfIdx The sub control volume face index inside the current
+ * \param faceIdx The sub control volume face index inside the current
* element
* \param onBoundary A boolean variable to specify whether the flux variables
* are calculated for interior SCV faces or boundary faces, default=false
diff --git a/dumux/boxmodels/richards/richardsproblem.hh b/dumux/boxmodels/richards/richardsproblem.hh
index e061557aae..86010a2d67 100644
--- a/dumux/boxmodels/richards/richardsproblem.hh
+++ b/dumux/boxmodels/richards/richardsproblem.hh
@@ -78,10 +78,10 @@ public:
*
* This method MUST be overwritten by the actual problem.
*
- * \param element The DUNE Codim<0> enitiy which intersects with
+ * \param element The DUNE Codim<0> enitiy which intersects with
* the finite volume.
- * \param fvGeom The finite volume geometry of the element.
- * \param scvIdx The local index of the sub control volume inside the element
+ * \param fvGeometry The finite volume geometry of the element.
+ * \param scvIdx The local index of the sub control volume inside the element
*/
Scalar referencePressure(const Element &element,
const FVElementGeometry fvGeometry,
diff --git a/dumux/boxmodels/richards/richardsvolumevariables.hh b/dumux/boxmodels/richards/richardsvolumevariables.hh
index ab67187a75..7f823f3127 100644
--- a/dumux/boxmodels/richards/richardsvolumevariables.hh
+++ b/dumux/boxmodels/richards/richardsvolumevariables.hh
@@ -80,8 +80,8 @@ public:
* \param problem The physical problem which needs to be solved.
* \param element The DUNE Codim<0> enitity which intersects
* the control volume of the box method
- * \param elemGeom The element's finite volume geometry
- * \param scvIdx The local index of the sub control volume inside the element
+ * \param fvGeometry The element's finite volume geometry
+ * \param scvIdx The local index of the sub control volume inside the element
* \param isOldSol Specifies whether the solution is from
* the previous time step or from the current one
*/
diff --git a/dumux/decoupled/2p2c/fluxData2p2c.hh b/dumux/decoupled/2p2c/fluxData2p2c.hh
index eb66f5c001..49fcdf339d 100644
--- a/dumux/decoupled/2p2c/fluxData2p2c.hh
+++ b/dumux/decoupled/2p2c/fluxData2p2c.hh
@@ -72,11 +72,7 @@ private:
public:
- //! Constructs a VariableClass object
- /**
- * @param gridView a DUNE gridview object corresponding to diffusion and transport equation
- */
-
+ //! Constructor
FluxData2P2C()
{
isUpwindCell_.resize(2 * dim);
@@ -89,7 +85,7 @@ public:
{
isUpwindCell_.resize(size);
}
- /** functions returning upwind information **/
+ //! functions returning upwind information
const bool& isUpwindCell(int indexInInside, int equationIdx) const
{
return isUpwindCell_[indexInInside][equationIdx];
diff --git a/dumux/freeflow/stokes/stokeslocalresidual.hh b/dumux/freeflow/stokes/stokeslocalresidual.hh
index a927c6f855..d53d5c38f3 100644
--- a/dumux/freeflow/stokes/stokeslocalresidual.hh
+++ b/dumux/freeflow/stokes/stokeslocalresidual.hh
@@ -276,7 +276,7 @@ protected:
* and the gravity term evaluated.
*
* \param source The source/sink in the sub control volume for each component
- * \param scvIndex The local index of the sub-control volume
+ * \param scvIdx The local index of the sub-control volume
*/
void computeSource(PrimaryVariables &source, const int scvIdx)
{
diff --git a/test/boxmodels/2p2c/injectionproblem.hh b/test/boxmodels/2p2c/injectionproblem.hh
index 87dc6b7558..d859939335 100644
--- a/test/boxmodels/2p2c/injectionproblem.hh
+++ b/test/boxmodels/2p2c/injectionproblem.hh
@@ -336,7 +336,7 @@ public:
/*!
* \brief Return the initial phase state inside a control volume.
*
- * \param vert The vertex
+ * \param vertex The vertex
* \param globalIdx The index of the global vertex
* \param globalPos The global position
*/
diff --git a/test/boxmodels/2p2c/injectionspatialparams.hh b/test/boxmodels/2p2c/injectionspatialparams.hh
index 7a888eba95..7c6d82bb10 100644
--- a/test/boxmodels/2p2c/injectionspatialparams.hh
+++ b/test/boxmodels/2p2c/injectionspatialparams.hh
@@ -222,7 +222,7 @@ public:
* \param tempGrad The temperature gradient
* \param element The current finite element
* \param fvGeometry The finite volume geometry of the current element
- * \param scvfIdx The local index of the sub-control volume face where
+ * \param faceIdx The local index of the sub-control volume face where
* the matrix heat flux should be calculated
*/
void matrixHeatFlux(DimVector &heatFlux,
diff --git a/test/boxmodels/3p3cni/columnxylolproblem.hh b/test/boxmodels/3p3cni/columnxylolproblem.hh
index e769609ccd..80047050ba 100644
--- a/test/boxmodels/3p3cni/columnxylolproblem.hh
+++ b/test/boxmodels/3p3cni/columnxylolproblem.hh
@@ -246,7 +246,7 @@ public:
*
* \param values The initial values for the primary variables
* \param element The finite element
- * \param fvElemGeom The finite-volume geometry in the box scheme
+ * \param fvGeomtry The finite-volume geometry in the box scheme
* \param scvIdx The local vertex index
*
* For this method, the \a values parameter stores primary
diff --git a/test/boxmodels/3p3cni/columnxylolspatialparams.hh b/test/boxmodels/3p3cni/columnxylolspatialparams.hh
index 3c15542ffd..89a28eed56 100644
--- a/test/boxmodels/3p3cni/columnxylolspatialparams.hh
+++ b/test/boxmodels/3p3cni/columnxylolspatialparams.hh
@@ -104,7 +104,7 @@ public:
/*!
* \brief The constructor
*
- * \param gv The grid view
+ * \param gridView The grid view
*/
ColumnSpatialParams(const GridView &gridView)
: ParentType(gridView)
@@ -248,7 +248,7 @@ public:
*
* \param heatFlux The resulting heat flux vector
* \param fluxDat The flux variables
- * \param elemVolVarst The volume variables
+ * \param elemVolVars The volume variables
* \param tempGrad The temperature gradient
* \param element The current finite element
* \param fvGeomtry The finite volume geometry of the current element
diff --git a/test/boxmodels/3p3cni/kuevettespatialparams.hh b/test/boxmodels/3p3cni/kuevettespatialparams.hh
index 1bb3ef2257..f8b8620e88 100644
--- a/test/boxmodels/3p3cni/kuevettespatialparams.hh
+++ b/test/boxmodels/3p3cni/kuevettespatialparams.hh
@@ -106,7 +106,7 @@ public:
/*!
* \brief The constructor
*
- * \param gv The grid view
+ * \param gridView The grid view
*/
KuevetteSpatialParams(const GridView &gridView)
: ParentType(gridView)
diff --git a/test/boxmodels/mpnc/obstaclespatialparams.hh b/test/boxmodels/mpnc/obstaclespatialparams.hh
index fa443a06e2..6bc7df69ea 100644
--- a/test/boxmodels/mpnc/obstaclespatialparams.hh
+++ b/test/boxmodels/mpnc/obstaclespatialparams.hh
@@ -144,7 +144,7 @@ public:
* \brief Returns the intrinsic permeability tensor.
*
* \param element The current finite element
- * \param fvElemGeom The current finite volume geometry of the element
+ * \param fvGeometry The current finite volume geometry of the element
* \param scvIdx The index sub-control volume where the
* intrinsic permeability is given.
*/
@@ -161,7 +161,7 @@ public:
* \brief Define the porosity \f$[-]\f$ of the soil
*
* \param element The finite element
- * \param fvElemGeom The finite volume geometry
+ * \param fvGeometry The finite volume geometry
* \param scvIdx The local index of the sub-control volume where
* the porosity needs to be defined
*/
@@ -178,7 +178,7 @@ public:
* This is only required for non-isothermal models.
*
* \param element The finite element
- * \param fvElemGeom The finite volume geometry
+ * \param fvGeometry The finite volume geometry
* \param scvIdx The local index of the sub-control volume where
* the heat capacity needs to be defined
*/
--
GitLab