From c58408a778adfe9dd2401a051963e55864a62fd1 Mon Sep 17 00:00:00 2001
From: Karin Erbertseder <k.erbertseder@web.de>
Date: Wed, 6 Oct 2010 15:25:52 +0000
Subject: [PATCH] update of documentation
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@4377 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
dumux/boxmodels/1p2c/1p2cvolumevariables.hh | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/dumux/boxmodels/1p2c/1p2cvolumevariables.hh b/dumux/boxmodels/1p2c/1p2cvolumevariables.hh
index 7fc3ecd05b..c1cb07979c 100644
--- a/dumux/boxmodels/1p2c/1p2cvolumevariables.hh
+++ b/dumux/boxmodels/1p2c/1p2cvolumevariables.hh
@@ -71,6 +71,13 @@ class OnePTwoCVolumeVariables : public BoxVolumeVariables<TypeTag>
public:
/*!
* \brief Update all quantities for a given control volume.
+ *
+ * \param priVars A vector containing the primary variables
+ * \param problem The considered problem
+ * \param element The considered element of the grid
+ * \param elemGeom
+ * \param scvIdx The index of the considered subcontrol volume
+ * \param isOldSol A boolean parameter either the old or the new solution should be taken
*/
void update(const PrimaryVariables &priVars,
const Problem &problem,
@@ -123,18 +130,22 @@ public:
/*!
* \brief Returns mole fraction of a component in the phase
+ *
+ * \param compIdx The index of the component
*/
Scalar moleFrac(int compIdx) const
{ return fluidState_.moleFrac(phaseIndex, (compIdx==0)?comp1Index:comp2Index); }
/*!
* \brief Returns mass fraction of a component in the phase
+ * \param compIdx The index of the component
*/
Scalar massFrac(int compIdx) const
{ return fluidState_.massFrac(phaseIndex, (compIdx==0)?comp1Index:comp2Index); }
/*!
* \brief Returns concentration of a component in the phase
+ * \param compIdx The index of the component
*/
Scalar concentration(int compIdx) const
{ return fluidState_.concentration(phaseIndex, (compIdx==0)?comp1Index:comp2Index); }
--
GitLab