From b7b7409cf8b0ddf245656cbab8723aec430ff2c4 Mon Sep 17 00:00:00 2001
From: Dominik Riesterer <thedom.89@googlemail.com>
Date: Wed, 21 Aug 2013 12:17:15 +0000
Subject: [PATCH] Updated Documentation
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@11234 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
.../mpnc/mass/mpnclocalresidualmasskinetic.hh | 14 ++++++++++++++
1 file changed, 14 insertions(+)
diff --git a/dumux/implicit/mpnc/mass/mpnclocalresidualmasskinetic.hh b/dumux/implicit/mpnc/mass/mpnclocalresidualmasskinetic.hh
index 057c3f06ae..593f4c79bb 100644
--- a/dumux/implicit/mpnc/mass/mpnclocalresidualmasskinetic.hh
+++ b/dumux/implicit/mpnc/mass/mpnclocalresidualmasskinetic.hh
@@ -83,6 +83,9 @@ public:
/*!
* \brief Calculate the storage for all mass balance equations
+ *
+ * \param storage The mass of the component within the sub-control volume
+ * \param volVars The volume variables
*/
static void computeStorage(PrimaryVariables & storage,
const VolumeVariables & volVars)
@@ -99,6 +102,10 @@ public:
/*!
* \brief Calculate the storage for all mass balance equations
* within a single fluid phase
+ *
+ * \param storage The mass of the component within the sub-control volume
+ * \param volVars The volume variables
+ * \param phaseIdx phaseIdx The index of the fluid phase
*/
static void addPhaseStorage(PrimaryVariables & storage,
const VolumeVariables & volVars,
@@ -131,6 +138,10 @@ public:
/*!
* \brief Calculate the storage for all mass balance equations
+ *
+ * \param flux The flux over the SCV (sub-control-volume) face for each component
+ * \param fluxVars The flux Variables
+ * \param elemVolVars The volume variables of the current element
*/
static void computeFlux(PrimaryVariables & flux,
const FluxVariables & fluxVars,
@@ -181,6 +192,9 @@ public:
/*!
* \brief Calculate the source terms for all mass balance equations
+ *
+ * \param source The source/sink in the sub-control volume for each component
+ * \param volVars the volume variables
*/
static void computeSource(PrimaryVariables & source,
const VolumeVariables & volVars)
--
GitLab