From 5f0424523cc171ab31fadfd8aaabcaab42c6237f Mon Sep 17 00:00:00 2001
From: Lena Walter <lena.mahl@gmx.de>
Date: Fri, 8 Oct 2010 09:47:51 +0000
Subject: [PATCH] doc
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@4403 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
.../spatialparameters/boxspatialparameters.hh | 30 +++++++++++++++++--
1 file changed, 28 insertions(+), 2 deletions(-)
diff --git a/dumux/material/spatialparameters/boxspatialparameters.hh b/dumux/material/spatialparameters/boxspatialparameters.hh
index e9c2a41c0d..8c79df6559 100644
--- a/dumux/material/spatialparameters/boxspatialparameters.hh
+++ b/dumux/material/spatialparameters/boxspatialparameters.hh
@@ -36,6 +36,16 @@ NEW_PROP_TAG(SpatialParameters);
};
+/*!
+ * \ingroup Material
+ * \defgroup SpatialParameters Spatial parameters
+ */
+
+/*!
+ * \ingroup SpatialParameters
+ */
+
+
/**
* \brief The base class for spatial parameters of problems using the
* box method.
@@ -69,6 +79,11 @@ public:
* volume needs to be multiplied in order to get cubic
* meters.
*
+ * \param element The current finite element
+ * \param fvElemGeom The current finite volume geometry of the element
+ * \param scvIdx The index sub-control volume face where the
+ * factor ought to be calculated.
+ *
* By default that's just 1.0
*/
Scalar extrusionFactorScv(const Element &element,
@@ -81,6 +96,11 @@ public:
* volume face needs to be multiplied in order to get
* square meters.
*
+ * \param element The current finite element
+ * \param fvElemGeom The current finite volume geometry of the element
+ * \param scvIdx The index sub-control volume face where the
+ * factor ought to be calculated.
+ *
* By default it is the arithmetic mean of the extrusion factor of
* the face's two sub-control volumes.
*/
@@ -100,7 +120,10 @@ public:
}
/*!
- * \brief Averages the intrinsic permeability.
+ * \brief Averages the intrinsic permeability (Scalar).
+ * \param result averaged intrinsic permeability
+ * \param K1 intrinsic permeability of the first node
+ * \param K2 intrinsic permeability of the second node
*/
const void meanK(Tensor &result,
Scalar K1,
@@ -115,7 +138,10 @@ public:
}
/*!
- * \brief Averages the intrinsic permeability.
+ * \brief Averages the intrinsic permeability (Tensor).
+ * \param result averaged intrinsic permeability
+ * \param K1 intrinsic permeability of the first node
+ * \param K2 intrinsic permeability of the second node
*/
const void meanK(Tensor &result,
const Tensor &K1,
--
GitLab