From 6ef77804ab0852142f0a5b9894f93929ff2dd569 Mon Sep 17 00:00:00 2001
From: Thomas Fetzer <thomas.fetzer@iws.uni-stuttgart.de>
Date: Tue, 22 May 2018 11:05:26 +0200
Subject: [PATCH] [doc][lowrekepsilon] Fix documentation
---
dumux/freeflow/rans/twoeq/lowrekepsilon/model.hh | 2 +-
.../rans/twoeq/lowrekepsilon/staggered/localresidual.hh | 4 ++--
dumux/freeflow/rans/twoeq/lowrekepsilon/volumevariables.hh | 2 +-
dumux/freeflow/rans/twoeq/lowrekepsilon/vtkoutputfields.hh | 4 ++--
4 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/dumux/freeflow/rans/twoeq/lowrekepsilon/model.hh b/dumux/freeflow/rans/twoeq/lowrekepsilon/model.hh
index 179b36bada..3bad183a27 100644
--- a/dumux/freeflow/rans/twoeq/lowrekepsilon/model.hh
+++ b/dumux/freeflow/rans/twoeq/lowrekepsilon/model.hh
@@ -223,4 +223,4 @@ public:
} // end namespace
-#endif // DUMUX_LOWREKEPSILON_MODEL_HH
+#endif
diff --git a/dumux/freeflow/rans/twoeq/lowrekepsilon/staggered/localresidual.hh b/dumux/freeflow/rans/twoeq/lowrekepsilon/staggered/localresidual.hh
index 024e42e610..df8afddffe 100644
--- a/dumux/freeflow/rans/twoeq/lowrekepsilon/staggered/localresidual.hh
+++ b/dumux/freeflow/rans/twoeq/lowrekepsilon/staggered/localresidual.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- * \ingroup LowReKepsilonModel
+ * \ingroup LowReKEpsilonModel
* \copydoc Dumux::LowReKepsilonResidualImpl
*/
#ifndef DUMUX_STAGGERED_LOWREKEPSILON_LOCAL_RESIDUAL_HH
@@ -36,7 +36,7 @@ template<class TypeTag, class BaseLocalResidual, DiscretizationMethod discMethod
class LowReKEpsilonResidualImpl;
/*!
- * \ingroup LowReKepsilonModel
+ * \ingroup LowReKEpsilonModel
* \brief Element-wise calculation of the residual for low-Reynolds k-epsilon models using the staggered discretization
*/
template<class TypeTag, class BaseLocalResidual>
diff --git a/dumux/freeflow/rans/twoeq/lowrekepsilon/volumevariables.hh b/dumux/freeflow/rans/twoeq/lowrekepsilon/volumevariables.hh
index 7cc2e6a2a6..f72b152fee 100644
--- a/dumux/freeflow/rans/twoeq/lowrekepsilon/volumevariables.hh
+++ b/dumux/freeflow/rans/twoeq/lowrekepsilon/volumevariables.hh
@@ -35,7 +35,7 @@ namespace Dumux
/*!
* \ingroup LowReKEpsilonModel
- * \brief Volume variables for the isothermal single-phase 0-Eq. model.
+ * \brief Volume variables for the isothermal single-phase low-Re k-epsilons model.
*/
template <class Traits, class NSVolumeVariables>
class LowReKEpsilonVolumeVariables
diff --git a/dumux/freeflow/rans/twoeq/lowrekepsilon/vtkoutputfields.hh b/dumux/freeflow/rans/twoeq/lowrekepsilon/vtkoutputfields.hh
index 78171bb5cb..6ba9d9f2fe 100644
--- a/dumux/freeflow/rans/twoeq/lowrekepsilon/vtkoutputfields.hh
+++ b/dumux/freeflow/rans/twoeq/lowrekepsilon/vtkoutputfields.hh
@@ -31,7 +31,7 @@ namespace Dumux
/*!
* \ingroup LowReKEpsilonModel
- * \brief Adds vtk output fields for the Reynolds-Averaged Navier-Stokes model
+ * \brief Adds vtk output fields for the low-Re k-epsilon turbulence model
*/
template<class FVGridGeometry>
class LowReKEpsilonVtkOutputFields : public RANSVtkOutputFields<FVGridGeometry>
@@ -39,7 +39,7 @@ class LowReKEpsilonVtkOutputFields : public RANSVtkOutputFields<FVGridGeometry>
enum { dim = FVGridGeometry::GridView::dimension };
public:
- //! Initialize the Navier-Stokes specific vtk output fields.
+ //! Initialize the Reynolds-averagedNavier-Stokes specific vtk output fields.
template <class VtkOutputModule>
static void init(VtkOutputModule& vtk)
{
--
GitLab