From dd3bc81988b895d70e5b92a99da5c445810a57c4 Mon Sep 17 00:00:00 2001
From: Beatrix Becker <beatrix.becker@iws.uni-stuttgart.de>
Date: Tue, 24 Sep 2013 15:00:43 +0000
Subject: [PATCH] corrected doku
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@11559 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
dumux/implicit/2p2cni/2p2cnifluxvariables.hh | 6 +++---
dumux/implicit/2p2cni/2p2cniindices.hh | 2 +-
dumux/implicit/2p2cni/2p2cnilocalresidual.hh | 14 +++++++-------
dumux/implicit/2p2cni/2p2cniproperties.hh | 2 +-
dumux/implicit/2p2cni/2p2cnivolumevariables.hh | 6 +++---
5 files changed, 15 insertions(+), 15 deletions(-)
diff --git a/dumux/implicit/2p2cni/2p2cnifluxvariables.hh b/dumux/implicit/2p2cni/2p2cnifluxvariables.hh
index 1ca0b0de0d..48a9d71740 100644
--- a/dumux/implicit/2p2cni/2p2cnifluxvariables.hh
+++ b/dumux/implicit/2p2cni/2p2cnifluxvariables.hh
@@ -39,7 +39,7 @@ namespace Dumux
* \ingroup ImplicitFluxVariables
* \brief This template class contains data which is required to
* calculate the heat fluxes over a face of a finite
- * volume for the non-isothermal two-phase, two-component model.
+ * volume for the non-isothermal two-phase two-component model.
* The mass fluxes are computed in the parent class.
*
* This means temperature gradients and the normal matrix
@@ -74,9 +74,9 @@ public:
* \param problem The problem
* \param element The finite element
* \param fvGeometry The finite-volume geometry in the fully implicit scheme
- * \param faceIdx The local index of the SCV (sub-control-volume) face
+ * \param faceIdx The local index of the sub-control-volume face
* \param elemVolVars The volume variables of the current element
- * \param onBoundary Distinguishes if we are on a SCV face or on a boundary face
+ * \param onBoundary Distinguishes if we are on a sub-control-volume face or on a boundary face
*/
TwoPTwoCNIFluxVariables(const Problem &problem,
const Element &element,
diff --git a/dumux/implicit/2p2cni/2p2cniindices.hh b/dumux/implicit/2p2cni/2p2cniindices.hh
index ec83b91631..982e4e1c45 100644
--- a/dumux/implicit/2p2cni/2p2cniindices.hh
+++ b/dumux/implicit/2p2cni/2p2cniindices.hh
@@ -33,7 +33,7 @@ namespace Dumux
/*!
* \ingroup TwoPTwoCNIModel
* \ingroup ImplicitIndices
- * \brief Indices for the non-isothermal 2-phase 2-component model
+ * \brief Indices for the non-isothermal two-phase two-component model
*
* \tparam formulation The formulation, either pwsn or pnsw.
* \tparam PVOffset The first index in a primary variable vector.
diff --git a/dumux/implicit/2p2cni/2p2cnilocalresidual.hh b/dumux/implicit/2p2cni/2p2cnilocalresidual.hh
index 34c2039dd8..4cc4cb38b9 100644
--- a/dumux/implicit/2p2cni/2p2cnilocalresidual.hh
+++ b/dumux/implicit/2p2cni/2p2cnilocalresidual.hh
@@ -70,14 +70,14 @@ public:
};
/*!
- * \brief Evaluate the amount all conservation quantities
+ * \brief Evaluate the amount of all conservation quantities
* (e.g. phase mass) 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 storage The storage of the conservation quantity (mass or energy) within the sub-control volume
- * \param scvIdx The SCV (sub-control-volume) index
+ * \param scvIdx The sub-control-volume index
* \param usePrevSol Evaluate function with solution of current or previous time step
*/
void computeStorage(PrimaryVariables &storage, const int scvIdx, bool usePrevSol) const
@@ -110,11 +110,11 @@ public:
/*!
* \brief Evaluates the advective mass flux and the heat flux
- * over a face of a subcontrol volume and writes the result in
+ * over a face of a sub-control volume and writes the result in
* the flux vector.
*
- * \param flux The advective flux over the SCV (sub-control-volume) face for each component
- * \param fluxVars The flux variables at the current SCV face
+ * \param flux The advective flux over the sub-control-volume face for each component
+ * \param fluxVars The flux variables at the current sub-control-volume face
*
* This method is called by compute flux (base class)
*/
@@ -146,8 +146,8 @@ 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 SCV (sub-control-volume) face for each conservation quantity (mass, energy)
- * \param fluxVars The flux variables at the current SCV face
+ * \param flux The diffusive flux over the sub-control-volume face for each conservation quantity (mass, energy)
+ * \param fluxVars The flux variables at the current sub-control-volume face
*
* This method is called by compute flux (base class)
*/
diff --git a/dumux/implicit/2p2cni/2p2cniproperties.hh b/dumux/implicit/2p2cni/2p2cniproperties.hh
index 55030b5018..243e051780 100644
--- a/dumux/implicit/2p2cni/2p2cniproperties.hh
+++ b/dumux/implicit/2p2cni/2p2cniproperties.hh
@@ -22,7 +22,7 @@
* \ingroup TwoPTwoCNIModel
* \file
*
- * \brief Defines the properties required for the non-isothermal two-phase,
+ * \brief Defines the properties required for the non-isothermal two-phase
* two-component fully implicit model.
*/
#ifndef DUMUX_2P2CNI_PROPERTIES_HH
diff --git a/dumux/implicit/2p2cni/2p2cnivolumevariables.hh b/dumux/implicit/2p2cni/2p2cnivolumevariables.hh
index 4627c26324..d2e2eb344e 100644
--- a/dumux/implicit/2p2cni/2p2cnivolumevariables.hh
+++ b/dumux/implicit/2p2cni/2p2cnivolumevariables.hh
@@ -20,7 +20,7 @@
* \file
*
* \brief Contains the quantities which are constant within a
- * finite volume in the non-isothermal two-phase, two-component
+ * finite volume in the non-isothermal two-phase two-component
* model.
*/
#ifndef DUMUX_2P2CNI_VOLUME_VARIABLES_HH
@@ -35,7 +35,7 @@ namespace Dumux
* \ingroup TwoPTwoCNIModel
* \ingroup ImplicitVolumeVariables
* \brief Contains the quantities which are are constant within a
- * finite volume in the non-isothermal two-phase, two-component
+ * finite volume in the non-isothermal two-phase two-component
* model.
*/
template <class TypeTag>
@@ -121,7 +121,7 @@ protected:
* \param problem The problem
* \param element The element
* \param fvGeometry The current finite volume geometry of the element
- * \param scvIdx The local index of the SCV (sub-control volume)
+ * \param scvIdx The local index of the sub-control volume
* \param isOldSol Evaluate function with solution of current or previous time step
*/
void updateEnergy_(const PrimaryVariables &sol,
--
GitLab