From 136788871facbbd56f8819675c55bca44bf21592 Mon Sep 17 00:00:00 2001
From: Lena Walter <lena.mahl@gmx.de>
Date: Fri, 8 Oct 2010 09:45:09 +0000
Subject: [PATCH] doc
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@4402 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
dumux/boxmodels/2pni/2pnifluxvariables.hh | 11 +++++++++
dumux/boxmodels/2pni/2pniindices.hh | 3 +++
dumux/boxmodels/2pni/2pnilocalresidual.hh | 14 ++++++++++-
dumux/boxmodels/2pni/2pniproblem.hh | 6 +++++
dumux/boxmodels/2pni/2pnipropertydefaults.hh | 4 +++
dumux/boxmodels/2pni/2pnivolumevariables.hh | 26 +++++++++++++++++++-
6 files changed, 62 insertions(+), 2 deletions(-)
diff --git a/dumux/boxmodels/2pni/2pnifluxvariables.hh b/dumux/boxmodels/2pni/2pnifluxvariables.hh
index 420d0bcaa2..5f1450649a 100644
--- a/dumux/boxmodels/2pni/2pnifluxvariables.hh
+++ b/dumux/boxmodels/2pni/2pnifluxvariables.hh
@@ -70,6 +70,17 @@ class TwoPNIFluxVariables : public TwoPFluxVariables<TypeTag>
typedef Dune::FieldVector<CoordScalar, dimWorld> Vector;
public:
+
+ /*
+ * \brief The constructor
+ *
+ * \param problem The problem
+ * \param element The finite element
+ * \param elemGeom The finite-volume geometry in the box scheme
+ * \param faceIdx The local index of the SCV (sub-control-volume) face
+ * \param elemDat The volume variables of the current element
+ */
+
TwoPNIFluxVariables(const Problem &problem,
const Element &element,
const FVElementGeometry &elemGeom,
diff --git a/dumux/boxmodels/2pni/2pniindices.hh b/dumux/boxmodels/2pni/2pniindices.hh
index 5cdcdbc599..7e84fcd99a 100644
--- a/dumux/boxmodels/2pni/2pniindices.hh
+++ b/dumux/boxmodels/2pni/2pniindices.hh
@@ -39,6 +39,9 @@ class TwoPNIIndices : public TwoPIndices<PVOffset>
public:
static const int temperatureIdx = PVOffset + 2; //! The primary variable index for temperature
static const int energyEqIdx = PVOffset + 2; //! The equation index of the energy equation
+ // Phase indices
+ static const int wPhaseIdx = 0; //!< Index of the wetting phase in a phase vector
+ static const int nPhaseIdx = 1; //!< Index of the non-wetting phase in a phase vector
};
// \}
}
diff --git a/dumux/boxmodels/2pni/2pnilocalresidual.hh b/dumux/boxmodels/2pni/2pnilocalresidual.hh
index 77403f62e3..1ae7b921f3 100644
--- a/dumux/boxmodels/2pni/2pnilocalresidual.hh
+++ b/dumux/boxmodels/2pni/2pnilocalresidual.hh
@@ -81,10 +81,14 @@ class TwoPNILocalResidual : public TwoPLocalResidual<TypeTag>
public:
/*!
* \brief Evaluate the amount all conservation quantites
- * (e.g. phase mass) within a sub-control volume.
+ * (e.g. phase mass and energy storage) within a sub-control volume.
*
* The result should be averaged over the volume (e.g. phase mass
* inside a sub control volume divided by the volume)
+ *
+ * \param result The phase mass within the sub-control volume
+ * \param scvIdx The SCV (sub-control-volume) index
+ * \param usePrevSol Evaluate function with solution of current or previous time step
*/
void computeStorage(PrimaryVariables &result, int scvIdx, bool usePrevSol) const
{
@@ -116,6 +120,10 @@ public:
* over a face of a subcontrol volume and writes the result in
* the flux vector.
*
+ * \param flux The advective flux over the sub-control-volume face for each phase
+ * \param fluxVars The flux variables at the current SCV
+ *
+ *
* This method is called by compute flux (base class)
*/
void computeAdvectiveFlux(PrimaryVariables &flux,
@@ -158,6 +166,10 @@ public:
/*!
* \brief Adds the diffusive heat flux to the flux vector over
* the face of a sub-control volume.
+ *
+ * \param flux The diffusive flux over the sub-control-volume face for each phase
+ * \param fluxData The flux variables at the current SCV
+ *
*/
void computeDiffusiveFlux(PrimaryVariables &flux,
const FluxVariables &fluxData) const
diff --git a/dumux/boxmodels/2pni/2pniproblem.hh b/dumux/boxmodels/2pni/2pniproblem.hh
index 1d791661a9..10847cd526 100644
--- a/dumux/boxmodels/2pni/2pniproblem.hh
+++ b/dumux/boxmodels/2pni/2pniproblem.hh
@@ -44,6 +44,12 @@ class TwoPNIProblem : public TwoPProblem<TypeTag>
typedef typename GET_PROP_TYPE(TypeTag, PTAG(TimeManager)) TimeManager;
public:
+ /*!
+ * \brief The constructor
+ *
+ * \param timeManager The time manager
+ * \param gridView The grid view
+ */
TwoPNIProblem(TimeManager &timeManager, const GridView &gridView)
: ParentType(timeManager, gridView)
{}
diff --git a/dumux/boxmodels/2pni/2pnipropertydefaults.hh b/dumux/boxmodels/2pni/2pnipropertydefaults.hh
index 4812134d65..f70e191cd0 100644
--- a/dumux/boxmodels/2pni/2pnipropertydefaults.hh
+++ b/dumux/boxmodels/2pni/2pnipropertydefaults.hh
@@ -35,6 +35,10 @@
namespace Dumux
{
+/*!
+ * \addtogroup TwoPNIBoxModel
+ */
+
namespace Properties
{
//////////////////////////////////////////////////////////////////
diff --git a/dumux/boxmodels/2pni/2pnivolumevariables.hh b/dumux/boxmodels/2pni/2pnivolumevariables.hh
index c55d60c357..51349cd473 100644
--- a/dumux/boxmodels/2pni/2pnivolumevariables.hh
+++ b/dumux/boxmodels/2pni/2pnivolumevariables.hh
@@ -48,7 +48,8 @@ class TwoPNIVolumeVariables : public TwoPVolumeVariables<TypeTag>
dim = GridView::dimension,
dimWorld = GridView::dimensionworld,
- numPhases = GET_PROP_VALUE(TypeTag, PTAG(NumPhases))
+ numPhases = GET_PROP_VALUE(TypeTag, PTAG(NumPhases)),
+
};
typedef typename GET_PROP_TYPE(TypeTag, PTAG(TwoPIndices)) Indices;
@@ -65,6 +66,13 @@ class TwoPNIVolumeVariables : public TwoPVolumeVariables<TypeTag>
public:
/*!
* \brief Update all quantities for a given control volume.
+ * \param priVars The local primary variable vector
+ * \param problem The problem object
+ * \param element The current element
+ * \param elemGeom The finite-volume geometry in the box scheme
+ * \param scvIdx The local index of the SCV (sub-control volume)
+ * \param isOldSol Evaluate function with solution of current or previous time step
+ *
*/
void update(const PrimaryVariables &priVars,
const Problem &problem,
@@ -100,6 +108,17 @@ public:
Valgrind::CheckDefined(enthalpy_);
}
+ /*!
+ * \brief Update the temperature for a given control volume.
+ *
+ * \param priVars The local primary variable vector
+ * \param element The current element
+ * \param elemGeom The finite-volume geometry in the box scheme
+ * \param scvIdx The local index of the SCV (sub-control volume)
+ * \param problem The problem object
+ *
+ */
+
// this method gets called by the parent class
void updateTemperature_(const PrimaryVariables &priVars,
const Element &element,
@@ -120,6 +139,9 @@ public:
/*!
* \brief Returns the total internal energy of a phase in the
* sub-control volume.
+ *
+ * \param phaseIdx The phase index
+ *
*/
Scalar internalEnergy(int phaseIdx) const
{ return internalEnergy_[phaseIdx]; };
@@ -127,6 +149,8 @@ public:
/*!
* \brief Returns the total enthalpy of a phase in the sub-control
* volume.
+ *
+ * \param phaseIdx The phase index
*/
Scalar enthalpy(int phaseIdx) const
{ return enthalpy_[phaseIdx]; };
--
GitLab