From 4876a152e8003a01b1c02e3055629988634792e3 Mon Sep 17 00:00:00 2001
From: Markus Wolff <markus.wolff@twt-gmbh.de>
Date: Fri, 17 Feb 2012 15:35:06 +0000
Subject: [PATCH] improved doxygen documentation of common 2p/diffusion stuff
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@7812 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
.../2p/diffusion/diffusionproblem2p.hh | 20 +++++++++++--------
.../2p/diffusion/diffusionproperties2p.hh | 4 ++--
2 files changed, 14 insertions(+), 10 deletions(-)
diff --git a/dumux/decoupled/2p/diffusion/diffusionproblem2p.hh b/dumux/decoupled/2p/diffusion/diffusionproblem2p.hh
index 71764e4693..636272a4b1 100644
--- a/dumux/decoupled/2p/diffusion/diffusionproblem2p.hh
+++ b/dumux/decoupled/2p/diffusion/diffusionproblem2p.hh
@@ -22,7 +22,7 @@
*****************************************************************************/
/*!
* \file
- * \brief Base class for stationary sequential 2-phase problems
+ * \brief Base class for stationary solution of a two-phase diffusion/pressure equation
* @author Markus Wolff
*/
#ifndef DUMUX_DIFFUSIONPROBLEM_2P_HH
@@ -40,10 +40,9 @@ SET_TYPE_PROP(PressureTwoP, Model, typename GET_PROP_TYPE(TypeTag, PressureModel
/*!
* \ingroup IMPETproblems
* \ingroup Pressure2p
- * \brief Base class for stationary sequential 2-phase problems
+ * \brief Base class for stationary solution of a two-phase diffusion/pressure equation
*
- * @tparam TypeTag The Type Tag
- * @tparam Implementation The Problem implementation
+ * @tparam TypeTag The problem TypeTag
*/
template<class TypeTag>
class DiffusionProblem2P: public OneModelProblem<TypeTag>
@@ -75,7 +74,7 @@ class DiffusionProblem2P: public OneModelProblem<TypeTag>
public:
/*!
- * \brief The constructor
+ * \brief Constructs a DiffusionProblem2P object
*
* \param timeManager the time manager
* \param gridView The grid view
@@ -90,7 +89,7 @@ public:
gravity_[dim - 1] = -9.81;
}
/*!
- * \brief The constructor
+ * \brief Constructs a DiffusionProblem2P object
*
* \param timeManager the time manager
* \param gridView The grid view
@@ -106,7 +105,7 @@ public:
}
/*!
- * \brief The constructor
+ * \brief Constructs a DiffusionProblem2P object
*
* \param gridView The grid view
*/
@@ -120,7 +119,7 @@ public:
gravity_[dim - 1] = -9.81;
}
/*!
- * \brief The constructor
+ * \brief Constructs a DiffusionProblem2P object
*
* \param gridView The grid view
* \param spatialParameters SpatialParameters instantiation
@@ -134,6 +133,7 @@ public:
gravity_[dim - 1] = -9.81;
}
+ //! Destructor
virtual ~DiffusionProblem2P()
{
if (newSpatialParams_)
@@ -147,6 +147,10 @@ public:
*/
// \{
+ /* \brief Time integration function called by the time manager
+ *
+ * For stationary diffusion problems this functions just finishes the simulation.
+ */
void timeIntegration()
{
//end simulation -> no time dependent problem!
diff --git a/dumux/decoupled/2p/diffusion/diffusionproperties2p.hh b/dumux/decoupled/2p/diffusion/diffusionproperties2p.hh
index 0649a5d744..935f50501f 100644
--- a/dumux/decoupled/2p/diffusion/diffusionproperties2p.hh
+++ b/dumux/decoupled/2p/diffusion/diffusionproperties2p.hh
@@ -26,12 +26,12 @@
#include <dumux/decoupled/2p/2pproperties.hh>
/*!
- * \ingroup Saturation2p
+ * \ingroup Pressure2p
* \ingroup Properties
*/
/*!
* \file
- * \brief Specifies the properties for immiscible 2p transport
+ * \brief Specifies the properties for immiscible 2p diffusion/pressure models
*/
namespace Dumux
{
--
GitLab