From 320c5813987c2a433f1acaed905106ffa33941d2 Mon Sep 17 00:00:00 2001
From: Thomas Fetzer <thomas.fetzer@iws.uni-stuttgart.de>
Date: Thu, 7 Mar 2013 18:29:29 +0000
Subject: [PATCH] [ implicit ] added or changed brief description, corrected to
two-phase blabla to MpNc
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@10352 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
dumux/implicit/2p2cni/2p2cnivolumevariables.hh | 2 +-
dumux/implicit/co2ni/co2nivolumevariables.hh | 2 +-
dumux/implicit/mpnc/diffusion/diffusion.hh | 6 ++++--
dumux/implicit/mpnc/diffusion/fluxvariables.hh | 2 +-
dumux/implicit/mpnc/mass/mpnclocalresidualmass.hh | 11 ++++++-----
dumux/implicit/mpnc/mpncnewtoncontroller.hh | 7 ++++++-
6 files changed, 19 insertions(+), 11 deletions(-)
diff --git a/dumux/implicit/2p2cni/2p2cnivolumevariables.hh b/dumux/implicit/2p2cni/2p2cnivolumevariables.hh
index 6ddf552ea2..4627c26324 100644
--- a/dumux/implicit/2p2cni/2p2cnivolumevariables.hh
+++ b/dumux/implicit/2p2cni/2p2cnivolumevariables.hh
@@ -41,7 +41,7 @@ namespace Dumux
template <class TypeTag>
class TwoPTwoCNIVolumeVariables : public TwoPTwoCVolumeVariables<TypeTag>
{
- //! \cond 0
+ //! \cond false
typedef TwoPTwoCVolumeVariables<TypeTag> ParentType;
typedef typename ParentType::FluidState FluidState;
diff --git a/dumux/implicit/co2ni/co2nivolumevariables.hh b/dumux/implicit/co2ni/co2nivolumevariables.hh
index 4644d0b62a..95a2209a5a 100644
--- a/dumux/implicit/co2ni/co2nivolumevariables.hh
+++ b/dumux/implicit/co2ni/co2nivolumevariables.hh
@@ -44,7 +44,7 @@ namespace Dumux
template <class TypeTag>
class CO2NIVolumeVariables : public CO2VolumeVariables<TypeTag>
{
- //! \cond 0
+ //! \cond false
typedef CO2VolumeVariables<TypeTag> ParentType;
typedef typename ParentType::FluidState FluidState;
diff --git a/dumux/implicit/mpnc/diffusion/diffusion.hh b/dumux/implicit/mpnc/diffusion/diffusion.hh
index 14919067c8..f61e8108d5 100644
--- a/dumux/implicit/mpnc/diffusion/diffusion.hh
+++ b/dumux/implicit/mpnc/diffusion/diffusion.hh
@@ -20,7 +20,7 @@
* \file
*
* \brief This file contains parts to calculate the diffusive flux in
- * the fully coupled two-phase N-component model
+ * the fully coupled MpNc model
*/
#ifndef DUMUX_MPNC_DIFFUSION_HH
#define DUMUX_MPNC_DIFFUSION_HH
@@ -31,7 +31,9 @@
#include <dumux/implicit/mpnc/mpncproperties.hh>
namespace Dumux {
-
+/*!
+ * \brief Calculates the diffusive flux in the fully coupled MpNc model.
+ */
template <class TypeTag, bool enableDiffusion>
class MPNCDiffusion
{
diff --git a/dumux/implicit/mpnc/diffusion/fluxvariables.hh b/dumux/implicit/mpnc/diffusion/fluxvariables.hh
index 342d065ff1..f7335f8607 100644
--- a/dumux/implicit/mpnc/diffusion/fluxvariables.hh
+++ b/dumux/implicit/mpnc/diffusion/fluxvariables.hh
@@ -19,7 +19,7 @@
/*!
* \file
* \brief This file contains the diffusion module for the flux data of
- * the fully coupled two-phase N-component model
+ * the fully coupled MpNc model
*/
#ifndef DUMUX_MPNC_DIFFUSION_FLUX_VARIABLES_HH
#define DUMUX_MPNC_DIFFUSION_FLUX_VARIABLES_HH
diff --git a/dumux/implicit/mpnc/mass/mpnclocalresidualmass.hh b/dumux/implicit/mpnc/mass/mpnclocalresidualmass.hh
index c487787fa1..d212d60bf3 100644
--- a/dumux/implicit/mpnc/mass/mpnclocalresidualmass.hh
+++ b/dumux/implicit/mpnc/mass/mpnclocalresidualmass.hh
@@ -16,6 +16,10 @@
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
+/*!
+ * \file
+ * \brief The mass conservation part of the MpNc model.
+ */
#ifndef DUMUX_MPNC_LOCAL_RESIDUAL_MASS_HH
#define DUMUX_MPNC_LOCAL_RESIDUAL_MASS_HH
@@ -32,11 +36,8 @@
namespace Dumux
{
/*!
- * \file
- * \brief The mass conservation part of the MpNc model.
- *
- * This is the class represents methods which are shared amongst all
- * mass conservation modules.
+ * \brief This class represents methods which are shared amongst all
+ * mass conservation modules.
*/
template<class TypeTag>
class MPNCLocalResidualMassCommon
diff --git a/dumux/implicit/mpnc/mpncnewtoncontroller.hh b/dumux/implicit/mpnc/mpncnewtoncontroller.hh
index 005def2ce2..92e8edd6b6 100644
--- a/dumux/implicit/mpnc/mpncnewtoncontroller.hh
+++ b/dumux/implicit/mpnc/mpncnewtoncontroller.hh
@@ -18,7 +18,8 @@
*****************************************************************************/
/*!
* \file
- * \brief A MpNc specific controller for the newton solver.
+ * \brief A MpNc specific controller for the newton solver, which knows
+ * 'physically meaningful' solution.
*
* This controller 'knows' what a 'physically meaningful' solution is
* which allows the newton method to abort quicker if the solution is
@@ -34,6 +35,10 @@
namespace Dumux {
+/*!
+ * \brief A MpNc specific controller for the newton solver, which knows
+ * 'physically meaningful' solution.
+ */
template <class TypeTag, bool enableKinetic /* = false */>
class MpNcNewtonChop
{
--
GitLab