From 08a00b23a6e7ce00bd720e5e2aaa34e50982702e Mon Sep 17 00:00:00 2001
From: "leopold.stadler" <leopold.stadler@baw.de>
Date: Mon, 3 Oct 2022 12:26:18 +0200
Subject: [PATCH] Fix documentation for shallow water advective flux
---
dumux/flux/shallowwater/riemannproblem.hh | 4 ++--
dumux/flux/shallowwaterflux.hh | 24 ++++++++++++-----------
2 files changed, 15 insertions(+), 13 deletions(-)
diff --git a/dumux/flux/shallowwater/riemannproblem.hh b/dumux/flux/shallowwater/riemannproblem.hh
index 8cd6612075..641ce626f8 100644
--- a/dumux/flux/shallowwater/riemannproblem.hh
+++ b/dumux/flux/shallowwater/riemannproblem.hh
@@ -19,7 +19,7 @@
/*!
* \file
* \ingroup ShallowWaterFlux
- * \brief This file includes a function to construct the Riemann problem
+ * \brief This file includes a function to construct the Riemann problem.
*
*/
#ifndef DUMUX_FLUX_SHALLOW_WATER_RIEMANN_PROBLEM_HH
@@ -34,7 +34,7 @@ namespace ShallowWater {
/*!
* \ingroup ShallowWaterFlux
- * \brief Construct a Riemann problem and solve it
+ * \brief Construct a Riemann problem and solve it.
*
*
* Riemann problem applies the hydrostatic reconstruction, uses the
diff --git a/dumux/flux/shallowwaterflux.hh b/dumux/flux/shallowwaterflux.hh
index e1e89fd968..d51cd55739 100644
--- a/dumux/flux/shallowwaterflux.hh
+++ b/dumux/flux/shallowwaterflux.hh
@@ -31,7 +31,18 @@ namespace Dumux {
/*!
* \ingroup Flux
- * \brief Computes the shallow water flux by solving a riemann problem.
+ * \brief Prepare and compute the shallow water advective flux.
+ *
+ * Prepares the Riemann problem for the advective flux for the 2D shallow
+ * water model. The actual model uses an exact Riemann solver after Torro
+ * and the reconstruction after Audusse. A flux limiter is
+ * applied to limit water flow for small water depths.
+ *
+ * The computed water flux of the Riemann solver is given in m^2/s, the
+ * momentum fluxes are given in m^3/s^2. The Riemann flux is multiplied by
+ * scvf.area() (given in m) to obtain the flux over the face.
+ *
+ * \todo Add more numerical fluxes and reconstruction methods.
*/
template<class NumEqVector>
class ShallowWaterFlux
@@ -44,17 +55,8 @@ public:
/*!
* \ingroup Flux
- * \brief Prepares the Riemann problem for the advective flux for
- * the 2D shallow water model. The actual model uses an
- * exact Riemann solver after Torro and the reconstruction
- * after Audusse and a flux limiter for small water depths.
+ * \brief Prepares and compute the shallow water advective flux.
*
- * The computed water flux of the Riemann solver is given
- * in m^2/s, the momentum fluxes are given in m^3/s^2. The
- * Riemann flux is multiplied by scvf.area() (given in m
- * for a 2D domain) to get the flux over the face.
- *
- * \todo The choice of the Riemann solver should be more flexible
*/
template<class Problem, class FVElementGeometry, class ElementVolumeVariables>
static NumEqVector flux(const Problem& problem,
--
GitLab