From af135815c481870b63e54f4d0b8ab1a1489e4f2e Mon Sep 17 00:00:00 2001
From: Katherina Baber <katherina.baber@gmail.com>
Date: Tue, 14 Feb 2012 12:35:31 +0000
Subject: [PATCH] corrected documentation
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@7752 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
dumux/boxmodels/1p/1pfluxvariables.hh | 7 ++++---
dumux/boxmodels/1p/1pmodel.hh | 2 --
dumux/boxmodels/1p/1pvolumevariables.hh | 6 +++---
dumux/boxmodels/1p2c/1p2cfluxvariables.hh | 4 ++--
dumux/boxmodels/1p2c/1p2clocalresidual.hh | 4 ++--
dumux/boxmodels/1p2c/1p2cmodel.hh | 20 ++++++++++++--------
dumux/boxmodels/1p2c/1p2cproblem.hh | 2 +-
dumux/boxmodels/1p2c/1p2cvolumevariables.hh | 2 +-
dumux/boxmodels/common/boxlocalresidual.hh | 4 ++--
9 files changed, 27 insertions(+), 24 deletions(-)
diff --git a/dumux/boxmodels/1p/1pfluxvariables.hh b/dumux/boxmodels/1p/1pfluxvariables.hh
index 07b487deac..2154ad4056 100644
--- a/dumux/boxmodels/1p/1pfluxvariables.hh
+++ b/dumux/boxmodels/1p/1pfluxvariables.hh
@@ -106,9 +106,10 @@ public:
{ return potentialGrad_; }
/*!
- * \brief Return the local index of the upstream control volume
- * for a given phase, given the intrinisc permeability times the pressure
- * potential gradient and SCV face normal for a phase.
+ * \brief Given the intrinisc permeability times the pressure
+ * potential gradient and SCV-face normal for a phase,
+ * return the local index of the upstream control volume
+ * for a given phase.
*
* \param normalFlux The normal flux i.e. the given intrinsic permeability
* times the pressure potential gradient and SCV face normal.
diff --git a/dumux/boxmodels/1p/1pmodel.hh b/dumux/boxmodels/1p/1pmodel.hh
index 7c15dfa9f0..67f0745c7c 100644
--- a/dumux/boxmodels/1p/1pmodel.hh
+++ b/dumux/boxmodels/1p/1pmodel.hh
@@ -68,8 +68,6 @@ public:
/*!
* \brief \copybrief Dumux::BoxModel::addOutputVtkFields
*
- * \copydetails Dumux::BoxModel::addOutputVtkFields
- *
* Specialization for the OnePBoxModel, adding the pressure and
* the process rank to the VTK writer.
*/
diff --git a/dumux/boxmodels/1p/1pvolumevariables.hh b/dumux/boxmodels/1p/1pvolumevariables.hh
index e074cb2ac4..4839eeae32 100644
--- a/dumux/boxmodels/1p/1pvolumevariables.hh
+++ b/dumux/boxmodels/1p/1pvolumevariables.hh
@@ -92,7 +92,7 @@ public:
};
/*!
- * \@copydoc BoxModel::completeFluidState
+ * \copydoc BoxModel::completeFluidState
*/
static void completeFluidState(const PrimaryVariables& priVars,
const Problem& problem,
@@ -126,14 +126,14 @@ public:
* \brief Return temperature \f$\mathrm{[K]}\f$ inside the sub-control volume.
*
* Note that we assume thermodynamic equilibrium, i.e. the
- * temperature of the rock matrix and of all fluid phases are
+ * temperatures of the rock matrix and of all fluid phases are
* identical.
*/
Scalar temperature() const
{ return fluidState_.temperature(); }
/*!
- * \brief Returns the effective pressure \f$\mathrm{[Pa]}\f$ of a given phase within
+ * \brief Return the effective pressure \f$\mathrm{[Pa]}\f$ of a given phase within
* the control volume.
*
*/
diff --git a/dumux/boxmodels/1p2c/1p2cfluxvariables.hh b/dumux/boxmodels/1p2c/1p2cfluxvariables.hh
index 95d7471f46..0f11050a1f 100644
--- a/dumux/boxmodels/1p2c/1p2cfluxvariables.hh
+++ b/dumux/boxmodels/1p2c/1p2cfluxvariables.hh
@@ -119,8 +119,8 @@ public:
public:
/*!
* \brief Return the pressure potential multiplied with the
- * intrinsic permeability which goes from vertex i to
- * vertex j.
+ * intrinsic permeability and the face normal which
+ * goes from vertex i to vertex j.
*
* Note that the length of the face's normal is the area of the
* phase, so this is not the actual velocity but the integral of
diff --git a/dumux/boxmodels/1p2c/1p2clocalresidual.hh b/dumux/boxmodels/1p2c/1p2clocalresidual.hh
index f76f173fa0..c866b8d454 100644
--- a/dumux/boxmodels/1p2c/1p2clocalresidual.hh
+++ b/dumux/boxmodels/1p2c/1p2clocalresidual.hh
@@ -52,7 +52,7 @@ namespace Dumux
* \brief Calculate the local Jacobian for the single-phase,
* two-component model in the BOX scheme.
*
- * This class is used to fill the gaps in BoxLocalResidual for the 1p2c flow.
+ * This class is used to fill the gaps in BoxLocalResidual for the 1p2c flow and transport.
*/
template<class TypeTag>
class OnePTwoCLocalResidual : public BoxLocalResidual<TypeTag>
@@ -88,7 +88,7 @@ protected:
transEqIdx = Indices::transEqIdx
};
- //property that defines whether mole or mass fractions are used
+ //! property that defines whether mole or mass fractions are used
static const bool useMoles = GET_PROP_VALUE(TypeTag, UseMoles);
diff --git a/dumux/boxmodels/1p2c/1p2cmodel.hh b/dumux/boxmodels/1p2c/1p2cmodel.hh
index f18c9b73d7..f4559f90cd 100644
--- a/dumux/boxmodels/1p2c/1p2cmodel.hh
+++ b/dumux/boxmodels/1p2c/1p2cmodel.hh
@@ -80,6 +80,7 @@ class OnePTwoCBoxModel : public BoxModel<TypeTag>
typedef typename GET_PROP_TYPE(TypeTag, FVElementGeometry) FVElementGeometry;
typedef typename GET_PROP_TYPE(TypeTag, VolumeVariables) VolumeVariables;
typedef typename GET_PROP_TYPE(TypeTag, FluxVariables) FluxVariables;
+ typedef typename GET_PROP_TYPE(TypeTag, FluidSystem) FluidSystem;
typedef typename GET_PROP_TYPE(TypeTag, ElementVolumeVariables) ElementVolumeVariables;
typedef typename GET_PROP_TYPE(TypeTag, ElementBoundaryTypes) ElementBoundaryTypes;
typedef typename GET_PROP_TYPE(TypeTag, SolutionVector) SolutionVector;
@@ -110,8 +111,6 @@ public:
/*!
* \brief \copybrief Dumux::BoxModel::addOutputVtkFields
*
- * \copydetails Dumux::BoxModel::addOutputVtkFields
- *
* Specialization for the OnePTwoCBoxModel, adding pressure,
* mass and mole fractions, and the process rank to the VTK writer.
*/
@@ -131,7 +130,6 @@ public:
ScalarField &massFrac1 = *writer.allocateManagedBuffer(numVertices);
ScalarField &rho = *writer.allocateManagedBuffer(numVertices);
ScalarField &mu = *writer.allocateManagedBuffer(numVertices);
- ScalarField &delFrac= *writer.allocateManagedBuffer(numVertices);
#ifdef VELOCITY_OUTPUT // check if velocity output is demanded
ScalarField &velocityX = *writer.allocateManagedBuffer(numVertices);
ScalarField &velocityY = *writer.allocateManagedBuffer(numVertices);
@@ -191,7 +189,6 @@ public:
massFrac1[globalIdx] = volVars.massFraction(1);
rho[globalIdx] = volVars.density();
mu[globalIdx] = volVars.viscosity();
- delFrac[globalIdx] = volVars.massFraction(1)-volVars.moleFraction(1);
};
#ifdef VELOCITY_OUTPUT // check if velocity output is demanded
@@ -309,10 +306,17 @@ public:
if (dim > 2)
writer.attachVertexData(velocityZ, "Vz");
#endif
- writer.attachVertexData(moleFrac0, "x_H2O");
- writer.attachVertexData(moleFrac1, "x_N2");
- writer.attachVertexData(massFrac0, "X_H2O");
- writer.attachVertexData(massFrac1, "X_N2");
+ char nameMoleFrac0[42], nameMoleFrac1[42];
+ snprintf(nameMoleFrac0, 42, "x_%s", FluidSystem::componentName(0));
+ snprintf(nameMoleFrac1, 42, "x_%s", FluidSystem::componentName(1));
+ writer.attachVertexData(moleFrac0, nameMoleFrac0);
+ writer.attachVertexData(moleFrac0, nameMoleFrac1);
+
+ char nameMassFrac0[42], nameMassFrac1[42];
+ snprintf(nameMassFrac0, 42, "X_%s", FluidSystem::componentName(0));
+ snprintf(nameMassFrac1, 42, "X_%s", FluidSystem::componentName(1));
+ writer.attachVertexData(massFrac0, nameMassFrac0);
+ writer.attachVertexData(massFrac1, nameMassFrac1);
// writer.attachVertexData(delFrac, "delFrac_TRAIL");
writer.attachVertexData(rho, "rho");
writer.attachVertexData(mu, "mu");
diff --git a/dumux/boxmodels/1p2c/1p2cproblem.hh b/dumux/boxmodels/1p2c/1p2cproblem.hh
index dd0803b1d9..eb01b41afc 100644
--- a/dumux/boxmodels/1p2c/1p2cproblem.hh
+++ b/dumux/boxmodels/1p2c/1p2cproblem.hh
@@ -123,7 +123,7 @@ public:
/*!
* \brief Return the acceleration due to gravity \f$\mathrm{[m/s^2]}\f$.
- *.
+ *
* This is the box discretization specific interface. By default
* it just calls gravityAtPos().
*
diff --git a/dumux/boxmodels/1p2c/1p2cvolumevariables.hh b/dumux/boxmodels/1p2c/1p2cvolumevariables.hh
index 7d774faffd..843659c32b 100644
--- a/dumux/boxmodels/1p2c/1p2cvolumevariables.hh
+++ b/dumux/boxmodels/1p2c/1p2cvolumevariables.hh
@@ -124,7 +124,7 @@ public:
}
/*!
- * \@copydoc BoxModel::completeFluidState
+ * \copydoc BoxModel::completeFluidState
*/
static void completeFluidState(const PrimaryVariables& priVars,
const Problem& problem,
diff --git a/dumux/boxmodels/common/boxlocalresidual.hh b/dumux/boxmodels/common/boxlocalresidual.hh
index d9adae11b4..f0dccd7370 100644
--- a/dumux/boxmodels/common/boxlocalresidual.hh
+++ b/dumux/boxmodels/common/boxlocalresidual.hh
@@ -287,8 +287,8 @@ public:
{ }
/*!
- * \brief Returns the local residual for a given sub-control
- * volume of the element.
+ * \brief Returns the local residual for all sub-control
+ * volumes of the element.
*/
const ElementSolutionVector &residual() const
{ return residual_; }
--
GitLab