Commit e80f0410 authored by Christoph Grueninger's avatar Christoph Grueninger
Browse files

[doxygen] Get rid of some warnings.


git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@12701 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent 88d7db4b
......@@ -263,15 +263,17 @@ static Scalar sherwoodNumber(const Scalar reynoldsNumber,
else {
DUNE_THROW(Dune::NotImplemented, "wrong index");
}}
}
}
/*!
* \brief Calculate the thermal diffusivity alpha [m^2/s].
*
* The thermal diffusivity is a measure for how fast "temperature (not heat!) spreads".
* It is defined as \alpha = k / (rho c_p)
* with \alpha: k: thermal conductivity [W/mK], rho: density [kg/m^3], c_p: cpecific heat capacity at constant pressure [J/kgK].
* It is defined as \f$\alpha = \frac{k}{\rho c_p}\f$
* with \f$\alpha\f$: \f$k\f$: thermal conductivity [W/mK], \f$\rho\f$: density [kg/m^3],
* \f$c_p\f$: cpecific heat capacity at constant pressure [J/kgK].
*
* Source for thermal diffusivity definition: http://en.wikipedia.org/wiki/Thermal_diffusivity
*
......
......@@ -146,7 +146,7 @@ SET_SCALAR_PROP(DecoupledGeneralLensProblem, ImpetCFLFactor, 0.95);
}
/*!
* \ingroup TwoPBoxModel
* \ingroup TwoPModel
* \ingroup IMPETtests
*
* \brief Soil contamination problem where DNAPL infiltrates a fully
......
......@@ -679,8 +679,10 @@ public:
*
* The phaseIdx and transportCompIdx1 are predefined
*
* \todo boundaryVars1 violates naming convention
*
* \param elemVolVars1 All volume variables for the element
* \param boundaryVars1 Flux variables (\todo violates naming convention)
* \param boundaryVars1 Flux variables
* \param vertInElem1 Vertex index for the inside element
*/
Scalar computeAdvectiveVaporFluxes1(const ElementVolumeVariables1& elemVolVars1,
......@@ -698,8 +700,10 @@ public:
*
* The transportCompIdx1 is predefined
*
* \todo boundaryVars1 violates naming convention
*
* \param elemVolVars1 All volume variables for the element
* \param boundaryVars1 Flux variables (\todo violates naming convention)
* \param boundaryVars1 Flux variables
* \param vertInElem1 Vertex index for the inside elements
*/
Scalar computeDiffusiveVaporFluxes1(const ElementVolumeVariables1& elemVolVars1,
......
......@@ -649,8 +649,10 @@ public:
*
* The phaseIdx and transportCompIdx1 are predefined
*
* \todo boundaryVars1 violates naming convention
*
* \param elemVolVars1 All volume variables for the element
* \param boundaryVars1 Flux variables (\todo violates naming convention)
* \param boundaryVars1 Flux variables
* \param vertInElem1 Vertex index for the inside element
*/
Scalar computeAdvectiveVaporFluxes1(const ElementVolumeVariables1& elemVolVars1,
......@@ -668,8 +670,10 @@ public:
*
* The transportCompIdx1 is predefined
*
* \todo boundaryVars1 violates naming convention
*
* \param elemVolVars1 All volume variables for the element
* \param boundaryVars1 Flux variables (\todo violates naming convention)
* \param boundaryVars1 Flux variables
* \param vertInElem1 Vertex index for the inside elements
*/
Scalar computeDiffusiveVaporFluxes1(const ElementVolumeVariables1& elemVolVars1,
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment