diff --git a/dumux/flux/shallowwater/exactriemann.hh b/dumux/flux/shallowwater/exactriemann.hh index c2c4fd8237953500ec96b85c3a0ebb77a9c0ae1a..e088351d856c1c1f20c985db650760a6e626c65f 100644 --- a/dumux/flux/shallowwater/exactriemann.hh +++ b/dumux/flux/shallowwater/exactriemann.hh @@ -41,7 +41,12 @@ struct RiemannSolution { /*! * \ingroup ShallowWaterFlux - * \brief Exact Riemann solver for Shallow water equations. + * \brief Exact Riemann solver for the shallow water equations. + * + * The flux of the 2D shallow water equations must be rotated + * to a 1D problem before the Riemann solver can be applied. + * The computed water flux is given in m^2/s, the momentum + * fluxes are given in m^3/s^2. * * This Riemann solver is described in the book * "Shock-capturing methods for free-surface shallow flows" diff --git a/dumux/flux/shallowwater/riemannproblem.hh b/dumux/flux/shallowwater/riemannproblem.hh index 2d7b514ef3d654d7f926a3fecd072dba95e57607..5c3b8391504fc49665f515ebfa3b94c7c18e6c4c 100644 --- a/dumux/flux/shallowwater/riemannproblem.hh +++ b/dumux/flux/shallowwater/riemannproblem.hh @@ -34,16 +34,16 @@ namespace ShallowWater { /*! * \ingroup ShallowWaterFlux - * \brief Construct Riemann Problem and solve it + * \brief Construct a Riemann problem and solve it * * - * Riemann Problem applies the hydrostatic reconstruction, uses the + * Riemann problem applies the hydrostatic reconstruction, uses the * Riemann invariants to transform the two-dimensional problem to an * one-dimensional problem and solves this new problem, and rotates * the problem back. Further it applies an flux limiter for the water * flux handle drying of elements. - * The correction of the bed slope surce terme leads to an - * non-symetric flux term at the interface for the momentum equations + * The correction of the bed slope source term leads to a + * non-symmetric flux term at the interface for the momentum equations * since DuMuX computes the fluxes twice from each side this does not * matter. * @@ -51,6 +51,11 @@ namespace ShallowWater { * after Audusse but further solvers and reconstructions ca be * implemented. * + * The computed water flux (localFlux[0]) is given in m^2/s, the + * momentum fluxes (localFlux[1], localFlux[2]) are given in m^3/s^2. + * Later this flux will be multiplied by the scvf.area() (given in m + * for a 2D problem) to get the flux over a face. + * * \param waterDepthLeft water depth on the left side * \param waterDepthRight water depth on the right side * \param velocityXLeft veloctiyX on the left side diff --git a/dumux/flux/shallowwaterflux.hh b/dumux/flux/shallowwaterflux.hh index 179b9709aa736b1722ed5cbf2bec43ee0e3ae7d1..e1e89fd968dd7b0db1f53f4abaaef6cc12d7a5c7 100644 --- a/dumux/flux/shallowwaterflux.hh +++ b/dumux/flux/shallowwaterflux.hh @@ -44,10 +44,15 @@ public: /*! * \ingroup Flux - * \brief Prepares the riemann problem for the advective flux for - * the 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 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. + * + * 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 */