From 75bbf22e6f2f728bd2b648209aeeac265aac1805 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Dennis=20Gl=C3=A4ser?= <dennis.glaeser@iws.uni-stuttgart.de>
Date: Mon, 16 Apr 2018 16:06:23 +0200
Subject: [PATCH] [2p][interfacesolver] improve docu
---
dumux/porousmediumflow/2p/boxmaterialinterfaceparams.hh | 2 +-
dumux/porousmediumflow/2p/saturationreconstruction.hh | 9 +++++----
2 files changed, 6 insertions(+), 5 deletions(-)
diff --git a/dumux/porousmediumflow/2p/boxmaterialinterfaceparams.hh b/dumux/porousmediumflow/2p/boxmaterialinterfaceparams.hh
index 62c56fdd82..7f227cedb0 100644
--- a/dumux/porousmediumflow/2p/boxmaterialinterfaceparams.hh
+++ b/dumux/porousmediumflow/2p/boxmaterialinterfaceparams.hh
@@ -19,7 +19,7 @@
/*!
* \file
* \ingroup TwoPModel
- * \brief copydoc Dumux::TwoPScvSaturationReconstruction
+ * \brief copydoc Dumux::BoxMaterialInterfaceParams
*/
#ifndef DUMUX_2P_BOX_MATERIAL_INTERFACE_PARAMS_HH
#define DUMUX_2P_BOX_MATERIAL_INTERFACE_PARAMS_HH
diff --git a/dumux/porousmediumflow/2p/saturationreconstruction.hh b/dumux/porousmediumflow/2p/saturationreconstruction.hh
index 54ddf4bec5..188a0a3b02 100644
--- a/dumux/porousmediumflow/2p/saturationreconstruction.hh
+++ b/dumux/porousmediumflow/2p/saturationreconstruction.hh
@@ -40,9 +40,10 @@ class TwoPScvSaturationReconstruction
{
public:
/*!
- * \brief Compute the non-wetting phase saturation.
- * \note In the general case, we don't do anything. We do
- * stuff only in the specialization for the box scheme below.
+ * \brief Compute the non-wetting phase saturation in an scv
+ * \note In the default case, we don't reconstruct anything. We do
+ * Reconstruction is only done when using the box method
+ * and enableReconstruction = true.
*
* \param SpatialParams Class encapsulating the spatial parameters
* \param element The finite element the scv is embedded in
@@ -66,7 +67,7 @@ class TwoPScvSaturationReconstruction<DiscretizationMethod::box, /*enableReconst
{
public:
/*!
- * \brief Compute
+ * \brief Compute the non-wetting phase saturation in an scv
*
* \param SpatialParams Class encapsulating the spatial parameters
* \param element The finite element the scv is embedded in
--
GitLab