From 1e5bfd05f2a7d816b09d64136bf3eee678c8b7a1 Mon Sep 17 00:00:00 2001
From: Thomas Fetzer <thomas.fetzer@iws.uni-stuttgart.de>
Date: Wed, 3 Feb 2016 09:49:47 +0100
Subject: [PATCH] [todo][doxygen] Move todos such that they are visible in
doxygen
---
dumux/freeflow/stokes/localresidual.hh | 3 ++-
dumux/implicit/model.hh | 6 +++---
dumux/io/gridcreator.hh | 4 ++--
dumux/linear/amgbackend.hh | 2 +-
dumux/material/components/h2.hh | 4 ++--
5 files changed, 10 insertions(+), 9 deletions(-)
diff --git a/dumux/freeflow/stokes/localresidual.hh b/dumux/freeflow/stokes/localresidual.hh
index a8ecd19886..25d749ab45 100644
--- a/dumux/freeflow/stokes/localresidual.hh
+++ b/dumux/freeflow/stokes/localresidual.hh
@@ -166,6 +166,8 @@ protected:
* \brief Evaluates the advective fluxes over
* a face of a sub-control volume.
*
+ * \todo dilatation term has to be accounted for in outflow, coupling, neumann
+ *
* \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
*/
@@ -234,7 +236,6 @@ protected:
{
velGradComp = velGrad[velIdx];
- // TODO: dilatation term has to be accounted for in outflow, coupling, neumann
// velGradComp[velIdx] += 2./3*fluxVars.velocityDiv;
velGradComp *= fluxVars.dynamicViscosity() + fluxVars.dynamicEddyViscosity();
diff --git a/dumux/implicit/model.hh b/dumux/implicit/model.hh
index a7ef850f6c..59711a2fc3 100644
--- a/dumux/implicit/model.hh
+++ b/dumux/implicit/model.hh
@@ -888,6 +888,9 @@ protected:
/*!
* \brief Applies the initial solution for all vertices of the grid.
+ *
+ * \todo the initial condition needs to be unique for
+ * each vertex. we should think about the API...
*/
void applyInitialSolution_()
{
@@ -899,9 +902,6 @@ protected:
// iterate through leaf grid and evaluate initial
// condition at the center of each sub control volume
- //
- // TODO: the initial condition needs to be unique for
- // each vertex. we should think about the API...
for (const auto& element : elements(gridView_())) {
// deal with the current element
fvGeometry.update(gridView_(), element);
diff --git a/dumux/io/gridcreator.hh b/dumux/io/gridcreator.hh
index 923af3ad05..548d8913a3 100644
--- a/dumux/io/gridcreator.hh
+++ b/dumux/io/gridcreator.hh
@@ -20,6 +20,8 @@
* \file
* \brief Provides a grid creator for all supported grid managers with
* input file interfaces.
+ *
+ * \todo add Petrel grids with dune-cornerpoint
*/
#ifndef DUMUX_GRID_CREATOR_HH
#define DUMUX_GRID_CREATOR_HH
@@ -1284,8 +1286,6 @@ public:
#endif // HAVE_DUNE_FOAMGRID
-// TODO Petrel grids with dune-cornerpoint
-
} // namespace Dumux
#endif
diff --git a/dumux/linear/amgbackend.hh b/dumux/linear/amgbackend.hh
index 581b5812ab..05f0fcc565 100644
--- a/dumux/linear/amgbackend.hh
+++ b/dumux/linear/amgbackend.hh
@@ -125,7 +125,7 @@ public:
typedef Dune::Amg::CoarsenCriterion<Dune::Amg::SymmetricCriterion<BCRSMat,
Dune::Amg::FirstDiagonal> >
Criterion;
- // \todo Check whether the default accumulation mode atOnceAccu is needed.
+ //! \todo Check whether the default accumulation mode atOnceAccu is needed.
Dune::Amg::Parameters params(15,2000,1.2,1.6,Dune::Amg::atOnceAccu);
params.setDefaultValuesIsotropic(GET_PROP_TYPE(TypeTag, GridView)::Traits::Grid::dimension);
params.setDebugLevel(verbosity);
diff --git a/dumux/material/components/h2.hh b/dumux/material/components/h2.hh
index e590da7bc9..e6ea4c9948 100644
--- a/dumux/material/components/h2.hh
+++ b/dumux/material/components/h2.hh
@@ -87,6 +87,8 @@ public:
* Taken from:
*
* See: R. Reid, et al. (1987, pp 208-209, 669) \cite reid1987
+ *
+ * \todo implement the Gomez-Thodos approach...
*/
static Scalar vaporPressure(Scalar temperature)
{
@@ -96,8 +98,6 @@ public:
return 0; // H2 is solid: We don't take sublimation into
// account
- // TODO: the Gomez-Thodos approach would probably be better...
-
// antoine equatuion
const Scalar A = -7.76451;
const Scalar B = 1.45838;
--
GitLab