From 062df6e9611885cfe9bc665de313c213f09126d4 Mon Sep 17 00:00:00 2001
From: Dominik Riesterer <thedom.89@googlemail.com>
Date: Wed, 21 Aug 2013 12:13:51 +0000
Subject: [PATCH] Updated Documentation
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@11225 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
.../implicit/mpnc/diffusion/fluxvariables.hh | 43 ++++++++++++++++---
1 file changed, 38 insertions(+), 5 deletions(-)
diff --git a/dumux/implicit/mpnc/diffusion/fluxvariables.hh b/dumux/implicit/mpnc/diffusion/fluxvariables.hh
index 844dbbe4b5..531b732b2b 100644
--- a/dumux/implicit/mpnc/diffusion/fluxvariables.hh
+++ b/dumux/implicit/mpnc/diffusion/fluxvariables.hh
@@ -56,9 +56,20 @@ class MPNCFluxVariablesDiffusion
typedef Dune::FieldVector<Scalar, dim> DimVector;
public:
+ /*!
+ * \brief The constructor
+ */
MPNCFluxVariablesDiffusion()
{}
-
+ /*!
+ * \brief update
+ *
+ * \param problem The problem
+ * \param element The finite element
+ * \param fvGeometry The finite-volume geometry in the fully implicit scheme
+ * \param face The SCV (sub-control-volume) face
+ * \param elemVolVars The volume variables of the current element
+ */
void update(const Problem & problem,
const Element & element,
const FVElementGeometry & fvGeometry,
@@ -158,20 +169,31 @@ public:
}
}
}
-
+ /*!
+ * \brief The binary diffusion coefficient for each component in the fluid phase.
+ * \param compIdx The local index of the components
+ */
Scalar porousDiffCoeffL(const unsigned int compIdx) const
{
// TODO: tensorial diffusion coefficients
return porousDiffCoeffL_[compIdx];
}
-
+ /*!
+ * \brief The binary diffusion coefficient for each component in the gas phase.
+ * \param compIIdx The local index of the first component in the phase
+ * \param compIJdx The local index of the second component in the phase
+ */
Scalar porousDiffCoeffG(const unsigned int compIIdx,
const unsigned int compJIdx) const
{
// TODO: tensorial diffusion coefficients
return porousDiffCoeffG_[compIIdx][compJIdx];
}
-
+ /*!
+ * \brief The mole fraction and concentration gradient for all phases and components
+ * \param phaseIdx The local index of the phases
+ * \param compIdx The local index of the component
+ */
Scalar moleFraction(const unsigned int phaseIdx,
const unsigned int compIdx) const
{ return moleFraction_[phaseIdx][compIdx]; }
@@ -208,9 +230,20 @@ class MPNCFluxVariablesDiffusion<TypeTag, false>
typedef typename FVElementGeometry::SubControlVolumeFace SCVFace;
public:
+ /*!
+ * \brief The constructor
+ */
MPNCFluxVariablesDiffusion()
{}
-
+ /*!
+ * \brief update
+ *
+ * \param problem The problem
+ * \param element The finite element
+ * \param fvGeometry The finite-volume geometry in the fully implicit scheme
+ * \param face The SCV (sub-control-volume) face
+ * \param elemVolVars The volume variables of the current element
+ */
void update(const Problem & problem,
const Element & element,
const FVElementGeometry & fvGeometry,
--
GitLab