From 36a35262c45b82160183121cf0930bd7e71fae86 Mon Sep 17 00:00:00 2001
From: Christoph Grueninger <christoph.grueninger@iws.uni-stuttgart.de>
Date: Tue, 22 Jan 2013 07:37:18 +0000
Subject: [PATCH] [Doxygen] Fix documentation, added further comments. Remove
commented code, empty lines and other whitespace fixes.
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@10053 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
test/implicit/1p/1ptestproblem.hh | 11 +++++--
test/implicit/2p2c/injectionspatialparams.hh | 5 ++-
test/implicit/2p2cni/waterairproblem.hh | 6 ++++
test/implicit/2p2cni/waterairspatialparams.hh | 5 ++-
test/implicit/co2/heterogeneousproblem.hh | 20 +++++-------
test/implicit/co2ni/heterogeneousproblemni.hh | 32 +++++++++----------
6 files changed, 46 insertions(+), 33 deletions(-)
diff --git a/test/implicit/1p/1ptestproblem.hh b/test/implicit/1p/1ptestproblem.hh
index 799ab619a5..cb39c99726 100644
--- a/test/implicit/1p/1ptestproblem.hh
+++ b/test/implicit/1p/1ptestproblem.hh
@@ -174,11 +174,16 @@ public:
Scalar temperature() const
{ return 273.15 + 10; } // 10C
-
- void sourceAtPos(PrimaryVariables &priVars,
+ /*!
+ * \brief Return the sources within the domain.
+ *
+ * \param values Stores the source values, acts as return value
+ * \param globalPos The global position
+ */
+ void sourceAtPos(PrimaryVariables &values,
const GlobalPosition &globalPos) const
{
- priVars = 0;
+ values = 0;
}
// \}
/*!
diff --git a/test/implicit/2p2c/injectionspatialparams.hh b/test/implicit/2p2c/injectionspatialparams.hh
index 193e483fc6..5957c61461 100644
--- a/test/implicit/2p2c/injectionspatialparams.hh
+++ b/test/implicit/2p2c/injectionspatialparams.hh
@@ -213,7 +213,10 @@ public:
/*!
* \brief Returns the thermal conductivity \f$[W/m^2]\f$ of the porous material.
*
- * \param pos The global position
+ * \param element The finite element
+ * \param fvGeometry The finite volume geometry
+ * \param scvIdx The local index of the sub-control volume where
+ * the heat capacity needs to be defined
*/
Scalar thermalConductivitySolid(const Element &element,
const FVElementGeometry &fvGeometry,
diff --git a/test/implicit/2p2cni/waterairproblem.hh b/test/implicit/2p2cni/waterairproblem.hh
index 5d90179b23..23ca17b6ea 100644
--- a/test/implicit/2p2cni/waterairproblem.hh
+++ b/test/implicit/2p2cni/waterairproblem.hh
@@ -199,6 +199,12 @@ public:
};
#endif
+ /*!
+ * \brief Return the sources within the domain.
+ *
+ * \param values Stores the source values, acts as return value
+ * \param globalPos The global position
+ */
void sourceAtPos(PrimaryVariables &values,
const GlobalPosition &globalPos) const
{
diff --git a/test/implicit/2p2cni/waterairspatialparams.hh b/test/implicit/2p2cni/waterairspatialparams.hh
index df3b8e4dc0..dc7b10e706 100644
--- a/test/implicit/2p2cni/waterairspatialparams.hh
+++ b/test/implicit/2p2cni/waterairspatialparams.hh
@@ -209,7 +209,10 @@ public:
/*!
* \brief Returns the thermal conductivity \f$[W/m^2]\f$ of the porous material.
*
- * \param pos The global position
+ * \param element The finite element
+ * \param fvGeometry The finite volume geometry
+ * \param scvIdx The local index of the sub-control volume where
+ * the heat capacity needs to be defined
*/
Scalar thermalConductivitySolid(const Element &element,
const FVElementGeometry &fvGeometry,
diff --git a/test/implicit/co2/heterogeneousproblem.hh b/test/implicit/co2/heterogeneousproblem.hh
index 52e3fe3b45..95504a05ea 100644
--- a/test/implicit/co2/heterogeneousproblem.hh
+++ b/test/implicit/co2/heterogeneousproblem.hh
@@ -156,7 +156,6 @@ class HeterogeneousProblem : public ImplicitPorousMediaProblem<TypeTag>
contiCO2EqIdx = conti0EqIdx + CO2Idx
};
-
typedef typename GET_PROP_TYPE(TypeTag, PrimaryVariables) PrimaryVariables;
typedef typename GET_PROP_TYPE(TypeTag, BoundaryTypes) BoundaryTypes;
typedef typename GET_PROP_TYPE(TypeTag, TimeManager) TimeManager;
@@ -222,12 +221,9 @@ public:
* - Reporting whether it was used does not work
* - Overwriting on command line not possible
*/
-
GridPointer *gridPtr = &GridCreator::gridPtr();
this->spatialParams().setParams(gridPtr);
-
-
eps_ = 1e-6;
// initialize the tables of the fluid system
@@ -324,8 +320,6 @@ public:
*
* This problem assumes a temperature of 10 degrees Celsius.
*/
-
-
Scalar boxTemperature(const Element &element,
const FVElementGeometry &fvElemGeom,
int scvIdx) const
@@ -334,6 +328,12 @@ public:
return temperature_(globalPos);
};
+ /*!
+ * \brief Return the sources within the domain.
+ *
+ * \param values Stores the source values, acts as return value
+ * \param globalPos The global position
+ */
void sourceAtPos(PrimaryVariables &values,
const GlobalPosition &globalPos) const
{
@@ -354,7 +354,6 @@ public:
* \param values The boundary types for the conservation equations
* \param vertex The vertex for which the boundary type is set
*/
-
void boundaryTypes(BoundaryTypes &values, const Vertex &vertex) const
{
intersectionToVertexBC_.boundaryTypes(values, vertex);
@@ -368,8 +367,6 @@ public:
* \param is specifies the intersection at which boundary
* condition is to set
*/
-
-
void boundaryTypes(BoundaryTypes &values, const Intersection &is) const
{
int boundaryId = is.boundaryId();
@@ -400,14 +397,12 @@ public:
initial_(values, globalPos);
}
-
-
/*!
* \brief Evaluate the boundary conditions for a dirichlet
* boundary segment.
*
* \param values The dirichlet values for the primary variables
- * \param is The intersection between element and boundary
+ * \param globalPos The global position
*
* For this method, the \a values parameter stores primary variables.
*/
@@ -415,6 +410,7 @@ public:
{
initial_(values, globalPos);
}
+
/*!
* \brief Evaluate the boundary conditions for a neumann
* boundary segment.
diff --git a/test/implicit/co2ni/heterogeneousproblemni.hh b/test/implicit/co2ni/heterogeneousproblemni.hh
index b7f00385d7..1376d85d0d 100644
--- a/test/implicit/co2ni/heterogeneousproblemni.hh
+++ b/test/implicit/co2ni/heterogeneousproblemni.hh
@@ -321,36 +321,37 @@ public:
const std::string name() const
{ return name_; }
+ /*!
+ * \brief Returns the temperature within the domain.
+ *
+ * \param element The finite element
+ * \param fvElemGeom The finite-volume geometry in the box scheme
+ * \param scvIdx The local vertex index
+ */
Scalar boxTemperature(const Element &element,
- const FVElementGeometry &fvElemGeom,
- int scvIdx) const
+ const FVElementGeometry &fvElemGeom,
+ int scvIdx) const
{
const GlobalPosition globalPos = fvElemGeom.subContVol[scvIdx].global;
return temperature_(globalPos);
}
-// /*!
-// * \brief Returns the temperature within the domain.
-// * \param globalPos The global position
-// */
-// Scalar temperatureAtPos(const GlobalPosition globalPos) const
-// {
-// return temperature_(globalPos);
-// };
-
+ /*!
+ * \brief Returns the sources within the domain.
+ *
+ * \param values Stores the source values, acts as return value
+ * \param globalPos The global position
+ */
void sourceAtPos(PrimaryVariables &values,
const GlobalPosition &globalPos) const
{
values = 0;
}
-
-
/*!
* \name Boundary conditions
*/
-
/*!
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary segment.
@@ -372,8 +373,6 @@ public:
* \param is specifies the intersection at which boundary
* condition is to set
*/
-
-
void boundaryTypes(BoundaryTypes &values, const Intersection &is) const
{
int boundaryId = is.boundaryId();
@@ -417,6 +416,7 @@ public:
{
initial_(values, globalPos);
}
+
/*!
* \brief Evaluate the boundary conditions for a neumann
* boundary segment.
--
GitLab