From f35435167f0d6a1b7bd2ee2059bf3625f444d40e Mon Sep 17 00:00:00 2001
From: Klaus Mosthaf <klmos@env.dtu.dk>
Date: Tue, 21 Feb 2012 16:41:57 +0000
Subject: [PATCH] work on documentation
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@7845 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
dumux/freeflow/stokes/stokesmodel.hh | 7 +------
dumux/freeflow/stokes/stokesvolumevariables.hh | 5 ++---
dumux/freeflow/stokes2c/stokes2cfluxvariables.hh | 10 ++++++++--
dumux/freeflow/stokes2c/stokes2clocalresidual.hh | 16 +++++++++++-----
dumux/freeflow/stokes2c/stokes2cmodel.hh | 7 +------
dumux/freeflow/stokes2c/stokes2cproperties.hh | 4 ++--
.../stokes2c/stokes2cpropertydefaults.hh | 4 ++--
.../freeflow/stokes2c/stokes2cvolumevariables.hh | 2 +-
8 files changed, 28 insertions(+), 27 deletions(-)
diff --git a/dumux/freeflow/stokes/stokesmodel.hh b/dumux/freeflow/stokes/stokesmodel.hh
index a4f64abdc3..9f592e9104 100644
--- a/dumux/freeflow/stokes/stokesmodel.hh
+++ b/dumux/freeflow/stokes/stokesmodel.hh
@@ -217,12 +217,7 @@ public:
}
}
-
- /*!
- * \brief Append all quantities of interest which can be derived
- * from the solution of the current time step to the VTK
- * writer.
- */
+ //! \@copydoc BoxModel::addOutputVtkFields
template <class MultiWriter>
void addOutputVtkFields(const SolutionVector &sol, MultiWriter &writer)
{
diff --git a/dumux/freeflow/stokes/stokesvolumevariables.hh b/dumux/freeflow/stokes/stokesvolumevariables.hh
index 20b9e30eaa..338198ed59 100644
--- a/dumux/freeflow/stokes/stokesvolumevariables.hh
+++ b/dumux/freeflow/stokes/stokesvolumevariables.hh
@@ -73,9 +73,8 @@ class StokesVolumeVariables : public BoxVolumeVariables<TypeTag>
typedef Dune::FieldVector<Scalar, dim> VelocityVector;
public:
-
/*!
- * \brief Update all quantities for a given control volume.
+ * \@copydoc BoxModel::update()
*/
void update(const PrimaryVariables &primaryVars,
const Problem &problem,
@@ -98,7 +97,7 @@ public:
}
/*!
- * \@copydoc BoxModel::completeFluidState
+ * \@copydoc BoxModel::completeFluidState()
*/
static void completeFluidState(const PrimaryVariables& primaryVars,
const Problem& problem,
diff --git a/dumux/freeflow/stokes2c/stokes2cfluxvariables.hh b/dumux/freeflow/stokes2c/stokes2cfluxvariables.hh
index 3367edb59b..1e8cce3e45 100644
--- a/dumux/freeflow/stokes2c/stokes2cfluxvariables.hh
+++ b/dumux/freeflow/stokes2c/stokes2cfluxvariables.hh
@@ -50,8 +50,8 @@ NEW_PROP_TAG(Stokes2cIndices); //!< Enumerations for the compositional stokes mo
* calculate the component fluxes over a face of a finite
* volume for the compositional Stokes model.
*
- * This means concentration gradients, diffusion coefficients, mass fractions, etc.
- * at the integration point of a SCV or boundary face.
+ * This means concentration gradients, diffusion coefficient, mass fractions, etc.
+ * at the integration point of a SCV or boundary face.
*/
template <class TypeTag>
class Stokes2cFluxVariables : public StokesFluxVariables<TypeTag>
@@ -85,9 +85,15 @@ public:
calculateValues_(problem, element, elemVolVars);
}
+ /*!
+ * \brief Return the mass fraction at the integration point.
+ */
Scalar massFractionAtIP() const
{ return massFractionAtIP_; }
+ /*!
+ * \brief Return the diffusion coefficient at the integration point.
+ */
Scalar diffusionCoeffAtIP() const
{ return diffusionCoeffAtIP_; }
diff --git a/dumux/freeflow/stokes2c/stokes2clocalresidual.hh b/dumux/freeflow/stokes2c/stokes2clocalresidual.hh
index bd64a2362a..675a83b14d 100644
--- a/dumux/freeflow/stokes2c/stokes2clocalresidual.hh
+++ b/dumux/freeflow/stokes2c/stokes2clocalresidual.hh
@@ -24,7 +24,7 @@
* \file
*
* \brief Element-wise calculation of the Jacobian matrix for problems
- * using the compositional stokes box model.
+ * using the compositional Stokes box model.
*
*/
#ifndef DUMUX_STOKES2C_LOCAL_RESIDUAL_HH
@@ -55,7 +55,7 @@ class Stokes2cLocalResidual : public StokesLocalResidual<TypeTag>
enum { dim = GridView::dimension };
enum { transportIdx = Indices::transportIdx }; //!< Index of the transport equation
enum { lCompIdx = Indices::lCompIdx }; //!< Index of the liquid component
- enum { phaseIdx = GET_PROP_VALUE(TypeTag, PhaseIndex)};
+ enum { phaseIdx = GET_PROP_VALUE(TypeTag, PhaseIndex)}; //!< Index of the considered phase (only of interest when using two-phase fluidsystems)
typedef typename GET_PROP_TYPE(TypeTag, PrimaryVariables) PrimaryVariables;
typedef typename GET_PROP_TYPE(TypeTag, VolumeVariables) VolumeVariables;
@@ -65,7 +65,7 @@ class Stokes2cLocalResidual : public StokesLocalResidual<TypeTag>
public:
/*!
- * \brief Evaluate the stored amount of the additional quantities to the stokes model
+ * \brief Evaluate the stored amount of quantities additional to the Stokes model
* (transport equation).
*
* The result should be averaged over the volume (e.g. phase mass
@@ -95,10 +95,13 @@ public:
/*!
* \brief Evaluates the advective component (mass) 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.
*
- * This method is called by compute flux (base class)
+ * This method is called by compute flux (base class).
+ *
+ * \param flux The advective flux over the sub-control-volume face for each component
+ * \param fluxVars The flux variables at the current SCV/boundary face
*/
void computeAdvectiveFlux(PrimaryVariables &flux,
const FluxVariables &fluxVars) const
@@ -127,6 +130,9 @@ public:
/*!
* \brief Adds the diffusive component flux to the flux vector over
* the face of a sub-control volume.
+ *
+ * \param flux The diffusive flux over the SCV face or boundary face
+ * \param fluxVars The flux variables at the current SCV/boundary face
*/
void computeDiffusiveFlux(PrimaryVariables &flux,
const FluxVariables &fluxVars) const
diff --git a/dumux/freeflow/stokes2c/stokes2cmodel.hh b/dumux/freeflow/stokes2c/stokes2cmodel.hh
index 544a8749fa..9eb2d14941 100644
--- a/dumux/freeflow/stokes2c/stokes2cmodel.hh
+++ b/dumux/freeflow/stokes2c/stokes2cmodel.hh
@@ -66,7 +66,6 @@ namespace Dumux {
* This is discretized using a fully-coupled vertex
* centered finite volume (box) scheme as spatial and
* the implicit Euler method as temporal discretization.
- *
*/
template<class TypeTag>
class Stokes2cModel : public StokesModel<TypeTag>
@@ -89,11 +88,7 @@ class Stokes2cModel : public StokesModel<TypeTag>
typedef typename GET_PROP_TYPE(TypeTag, VolumeVariables) VolumeVariables;
public:
- /*!
- * \brief Append all quantities of interest which can be derived
- * from the solution of the current time step to the VTK
- * writer.
- */
+ //! \@copydoc BoxModel::addOutputVtkFields
template <class MultiWriter>
void addOutputVtkFields(const SolutionVector &sol, MultiWriter &writer)
{
diff --git a/dumux/freeflow/stokes2c/stokes2cproperties.hh b/dumux/freeflow/stokes2c/stokes2cproperties.hh
index faf29290ee..a2f2b58644 100644
--- a/dumux/freeflow/stokes2c/stokes2cproperties.hh
+++ b/dumux/freeflow/stokes2c/stokes2cproperties.hh
@@ -27,7 +27,7 @@
* \file
*
* \brief Defines the supplementary properties required for the compositional
- * stokes BOX model.
+ * Stokes box model.
*/
#ifndef DUMUX_STOKES2CPROPERTIES_HH
#define DUMUX_STOKES2CPROPERTIES_HH
@@ -43,7 +43,7 @@ namespace Properties
// Type tags
//////////////////////////////////////////////////////////////////
-//! The type tag for the compositional stokes problems
+//! The type tag for the compositional Stokes problems
NEW_TYPE_TAG(BoxStokes2c, INHERITS_FROM(BoxStokes));
//////////////////////////////////////////////////////////////////
diff --git a/dumux/freeflow/stokes2c/stokes2cpropertydefaults.hh b/dumux/freeflow/stokes2c/stokes2cpropertydefaults.hh
index 324b203d58..e4660e3fe7 100644
--- a/dumux/freeflow/stokes2c/stokes2cpropertydefaults.hh
+++ b/dumux/freeflow/stokes2c/stokes2cpropertydefaults.hh
@@ -58,12 +58,12 @@ SET_PROP(BoxStokes2c, NumEq) //!< set the number of equations
static constexpr int value = 2 + dim;
};
-//! Use the stokes2c local jacobian operator for the compositional stokes model
+//! Use the stokes2c local jacobian operator
SET_TYPE_PROP(BoxStokes2c,
LocalResidual,
Stokes2cLocalResidual<TypeTag>);
-//! the model property
+//! the Model property
SET_TYPE_PROP(BoxStokes2c, Model, Stokes2cModel<TypeTag>);
//! the VolumeVariables property
diff --git a/dumux/freeflow/stokes2c/stokes2cvolumevariables.hh b/dumux/freeflow/stokes2c/stokes2cvolumevariables.hh
index 371a5517e9..03dbe176ad 100644
--- a/dumux/freeflow/stokes2c/stokes2cvolumevariables.hh
+++ b/dumux/freeflow/stokes2c/stokes2cvolumevariables.hh
@@ -66,7 +66,7 @@ class Stokes2cVolumeVariables : public StokesVolumeVariables<TypeTag>
public:
/*!
- * \brief Update all additional quantities for a given control volume.
+ * \@copydoc BoxModel::update
*/
void update(const PrimaryVariables &primaryVars,
const Problem &problem,
--
GitLab