From ed3e885a9c30195d9ef0d76e4df7697f517cf0af Mon Sep 17 00:00:00 2001
From: Andreas Lauser <and@poware.org>
Date: Tue, 2 Nov 2010 19:10:11 +0000
Subject: [PATCH] documentation: Fix all doxygen warnings in the stuff for
which I'm responsible
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@4559 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
dumux/boxmodels/2p2cni/2p2cnivolumevariables.hh | 3 ++-
dumux/boxmodels/common/boxlocalresidual.hh | 17 +++++++++++++++--
.../boxmodels/richards/richardsfluxvariables.hh | 4 ++--
.../boxmodels/richards/richardslocalresidual.hh | 6 +++---
.../richards/richardsvolumevariables.hh | 1 +
dumux/common/spline.hh | 8 ++++----
dumux/common/timemanager.hh | 2 ++
7 files changed, 29 insertions(+), 12 deletions(-)
diff --git a/dumux/boxmodels/2p2cni/2p2cnivolumevariables.hh b/dumux/boxmodels/2p2cni/2p2cnivolumevariables.hh
index 37afabd016..6e2295d2c9 100644
--- a/dumux/boxmodels/2p2cni/2p2cnivolumevariables.hh
+++ b/dumux/boxmodels/2p2cni/2p2cnivolumevariables.hh
@@ -39,6 +39,7 @@ namespace Dumux
template <class TypeTag>
class TwoPTwoCNIVolumeVariables : public TwoPTwoCVolumeVariables<TypeTag>
{
+ //! \cond 0
typedef TwoPTwoCVolumeVariables<TypeTag> ParentType;
typedef typename GET_PROP_TYPE(TypeTag, PTAG(Scalar)) Scalar;
@@ -59,11 +60,11 @@ class TwoPTwoCNIVolumeVariables : public TwoPTwoCVolumeVariables<TypeTag>
enum { numComponents = GET_PROP_VALUE(TypeTag, PTAG(NumComponents)) };
enum { temperatureIdx = Indices::temperatureIdx };
-
typedef typename GET_PROP(TypeTag, PTAG(ReferenceElements))::Container ReferenceElements;
typedef typename GET_PROP_TYPE(TypeTag, PTAG(PrimaryVariables)) PrimaryVariables;
typedef Dune::FieldVector<Scalar, numPhases> PhasesVector;
+ //! \endcond
public:
/*!
diff --git a/dumux/boxmodels/common/boxlocalresidual.hh b/dumux/boxmodels/common/boxlocalresidual.hh
index 641ff71369..89db341bd2 100644
--- a/dumux/boxmodels/common/boxlocalresidual.hh
+++ b/dumux/boxmodels/common/boxlocalresidual.hh
@@ -98,7 +98,16 @@ public:
~BoxLocalResidual()
{ }
-
+
+ /*!
+ * \brief Initialize the local residual.
+ *
+ * This assumes that all objects of the simulation have been fully
+ * allocated but not necessarrily initialized completely.
+ *
+ * \param prob The representation of the physical problem to be
+ * solved.
+ */
void init(Problem &prob)
{ problemPtr_ = &prob; }
@@ -199,8 +208,12 @@ public:
* \param element The DUNE Codim<0> entity for which the residual
* ought to be calculated
* \param fvGeom The finite-volume geometry of the element
+ * \param prevVolVars The volume averaged variables for all
+ * sub-contol volumes of the element at the previous
+ * time level
* \param curVolVars The volume averaged variables for all
- * sub-contol volumes of the element
+ * sub-contol volumes of the element at the current
+ * time level
* \param bcTypes The types of the boundary conditions for all
* vertices of the element
*/
diff --git a/dumux/boxmodels/richards/richardsfluxvariables.hh b/dumux/boxmodels/richards/richardsfluxvariables.hh
index 7917be9b21..cb4948e834 100644
--- a/dumux/boxmodels/richards/richardsfluxvariables.hh
+++ b/dumux/boxmodels/richards/richardsfluxvariables.hh
@@ -76,11 +76,11 @@ public:
RichardsFluxVariables(const Problem &problem,
const Element &element,
const FVElementGeometry &fvElemGeom,
- int scfvIdx,
+ int scvfIdx,
const ElementVolumeVariables &elemVolVars)
: fvElemGeom_(fvElemGeom)
{
- scvfIdx_ = scfvIdx;
+ scvfIdx_ = scvfIdx;
calculateGradients_(problem, element, elemVolVars);
calculateK_(problem, element, elemVolVars);
diff --git a/dumux/boxmodels/richards/richardslocalresidual.hh b/dumux/boxmodels/richards/richardslocalresidual.hh
index d4c84f7dbc..9016f2f928 100644
--- a/dumux/boxmodels/richards/richardslocalresidual.hh
+++ b/dumux/boxmodels/richards/richardslocalresidual.hh
@@ -139,10 +139,10 @@ public:
/*!
* \brief Calculate the source term of the equation
*
- * \param flux Stores the average source term of all phases inside a
- * sub-control volume of the current element [kg/(m^3 s)]
+ * \param q Stores the average source term of all phases inside a
+ * sub-control volume of the current element [kg/(m^3 s)]
* \param scvIdx The sub control volume index inside the current
- * element
+ * element
*/
void computeSource(PrimaryVariables &q, int scvIdx)
{
diff --git a/dumux/boxmodels/richards/richardsvolumevariables.hh b/dumux/boxmodels/richards/richardsvolumevariables.hh
index 50c925feff..5b92ee4eb2 100644
--- a/dumux/boxmodels/richards/richardsvolumevariables.hh
+++ b/dumux/boxmodels/richards/richardsvolumevariables.hh
@@ -73,6 +73,7 @@ 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 isOldSol Specifies whether the solution is from
* the previous time step or from the current one
diff --git a/dumux/common/spline.hh b/dumux/common/spline.hh
index 8d431e032d..e162accdb3 100644
--- a/dumux/common/spline.hh
+++ b/dumux/common/spline.hh
@@ -95,7 +95,7 @@ public:
/*!
* \brief Convenience constructor for a full spline
*
- * \param tuples An array of \f$(x,y)\f$ tuples of the spline's sampling points
+ * \param points An array of \f$(x,y)\f$ tuples of the spline's sampling points
* \param m0 The slope of the spline at \f$x_0\f$
* \param m1 The slope of the spline at \f$x_n\f$
*/
@@ -203,7 +203,7 @@ public:
* \brief Convenience constructor for a full spline
*
* \param nSamples The number of sampling points (must be >= 2)
- * \param tuples An array of \f$(x,y)\f$ tuples of the spline's sampling points
+ * \param points An array of \f$(x,y)\f$ tuples of the spline's sampling points
* \param m0 The slope of the spline at \f$x_0\f$
* \param m1 The slope of the spline at \f$x_n\f$
*/
@@ -232,7 +232,7 @@ public:
/*!
* \brief Convenience constructor for a full spline
*
- * \param tuples An array of \f$(x,y)\f$ tuples of the spline's sampling points (must have a size() method)
+ * \param points An array of \f$(x,y)\f$ tuples of the spline's sampling points (must have a size() method)
* \param m0 The slope of the spline at \f$x_0\f$
* \param m1 The slope of the spline at \f$x_n\f$
*/
@@ -294,7 +294,7 @@ public:
/*!
* \brief Convenience constructor for a full spline
*
- * \param tuples An array of \f$(x,y)\f$ tuples of the spline's sampling points
+ * \param points An array of \f$(x,y)\f$ tuples of the spline's sampling points
* \param m0 The slope of the spline at \f$x_0\f$
* \param m1 The slope of the spline at \f$x_n\f$
*/
diff --git a/dumux/common/timemanager.hh b/dumux/common/timemanager.hh
index b8571c0179..52c4148ee5 100644
--- a/dumux/common/timemanager.hh
+++ b/dumux/common/timemanager.hh
@@ -93,6 +93,8 @@ public:
* \param tStart The start time [s] of the simulation (typically 0)
* \param dtInitial The initial time step size [s]
* \param tEnd The time at which the simulation is finished [s]
+ * \param writeInitialSol Specifies whether the initial condition
+ * should be written to disk
*/
void init(Problem &problem,
Scalar tStart,
--
GitLab