From 2baa138e230184b65c4cb0df2b9040e0ab2c97d0 Mon Sep 17 00:00:00 2001
From: Markus Wolff <markus.wolff@twt-gmbh.de>
Date: Fri, 17 Feb 2012 10:05:38 +0000
Subject: [PATCH] improved doxygen documentation for 2p-impes stuff
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@7809 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
.../2p/impes/gridadaptionindicator2p.hh | 30 ++++++++++++++++---
dumux/decoupled/2p/impes/impesproblem2p.hh | 17 ++++++-----
dumux/decoupled/2p/impes/impesproperties2p.hh | 9 +++---
.../2p/impes/impesproperties2padaptive.hh | 14 +++++----
4 files changed, 47 insertions(+), 23 deletions(-)
diff --git a/dumux/decoupled/2p/impes/gridadaptionindicator2p.hh b/dumux/decoupled/2p/impes/gridadaptionindicator2p.hh
index 95d8413062..333bec49d6 100644
--- a/dumux/decoupled/2p/impes/gridadaptionindicator2p.hh
+++ b/dumux/decoupled/2p/impes/gridadaptionindicator2p.hh
@@ -26,13 +26,13 @@
/**
* @file
- * @brief Base class for implementations of an saturation dependent indicator for grid adaption
+ * @brief Class defining a standard, saturation dependent indicator for grid adaption
* @author Markus Wolff
*/
namespace Dumux
{
-/*!\ingroup Saturation2p
- * @brief Base class for implementations of an saturation dependent indicator for grid adaption
+/*!\ingroup IMPES
+ * @brief Class defining a standard, saturation dependent indicator for grid adaption
*/
template<class TypeTag>
class GridAdaptionIndicator2P
@@ -71,6 +71,10 @@ private:
typedef Dune::FieldVector<Scalar, dimWorld> GlobalPosition;
public:
+ /*! \brief Calculates the indicator used for refinement/coarsening for each grid cell.
+ *
+ * This standard indicator is based on the saturation gradient.
+ */
void calculateIndicator()
{
// prepare an indicator for refinement
@@ -147,18 +151,36 @@ public:
coarsenBound_ = coarsentol_*globaldelta;
}
+ /*! \brief Indicator function for marking of grid cells for refinement
+ *
+ * Returns true if an element should be refined.
+ *
+ * \param element A grid element
+ */
bool refine(const Element& element)
{
return (indicatorVector_[problem_.elementMapper().map(element)] > refineBound_);
}
+ /*! \brief Indicator function for marking of grid cells for coarsening
+ *
+ * Returns true if an element should be coarsened.
+ *
+ * \param element A grid element
+ */
bool coarsen(const Element& element)
{
return (indicatorVector_[problem_.elementMapper().map(element)] < coarsenBound_);
}
- /*! @brief Constructs a GridAdaptionIndicator instance */
+ /*! @brief Constructs a GridAdaptionIndicator instance
+ *
+ * This standard indicator is based on the saturation gradient. It checks the local gradient compared to the maximum global gradient.
+ * The indicator is compared locally to a refinement/coarsening threshold to decide whether a cell should be marked for refinement or coarsening or should not be adapted.
+ *
+ * \param problem The problem object
+ */
GridAdaptionIndicator2P (Problem& problem):
problem_(problem)
{
diff --git a/dumux/decoupled/2p/impes/impesproblem2p.hh b/dumux/decoupled/2p/impes/impesproblem2p.hh
index 73aa17dcba..a9ede5a544 100644
--- a/dumux/decoupled/2p/impes/impesproblem2p.hh
+++ b/dumux/decoupled/2p/impes/impesproblem2p.hh
@@ -41,8 +41,7 @@ namespace Dumux
* \ingroup IMPES
* \brief Base class for all 2-phase problems which use an impes algorithm
*
- * @tparam TypeTag The Type Tag
- * @tparam Implementation The Problem implementation
+ * @tparam TypeTag The problem TypeTag
*/
template<class TypeTag>
class IMPESProblem2P : public IMPETProblem<TypeTag>
@@ -70,12 +69,13 @@ class IMPESProblem2P : public IMPETProblem<TypeTag>
typedef Dune::FieldVector<Scalar, dimWorld> GlobalPosition;
+ //Copy constructor
IMPESProblem2P(const IMPESProblem2P &)
{}
public:
/*!
- * \brief The constructor
+ * \brief Constructs an IMPESProblem2P object
*
* \param timeManager The time manager
* \param gridView The grid view
@@ -92,7 +92,7 @@ public:
gravity_[dim - 1] = - 9.81;
}
/*!
- * \brief The constructor
+ * \brief Constructs an IMPESProblem2P object
*
* \param timeManager The time manager
* \param gridView The grid view
@@ -109,7 +109,7 @@ public:
}
/*!
- * \brief The constructor
+ * \brief Constructs an IMPESProblem2P object
*
* \param gridView The grid view
* \param verbose Output flag for the time manager.
@@ -127,7 +127,7 @@ public:
gravity_[dim - 1] = - 9.81;
}
/*!
- * \brief The constructor
+ * \brief Constructs an IMPESProblem2P object
*
* \param gridView The grid view
* \param spatialParameters SpatialParameters instantiation
@@ -144,6 +144,7 @@ public:
gravity_[dim - 1] = - 9.81;
}
+ //! Destructor
virtual ~IMPESProblem2P()
{
if (newSpatialParams_)
@@ -223,7 +224,7 @@ public:
{ return *spatialParameters_; }
/*!
- * \copydoc Dumux::IMPESProblem2P::spatialParameters()
+ * \brief Returns the spatial parameters object.
*/
const SpatialParameters &spatialParameters() const
{ return *spatialParameters_; }
@@ -236,7 +237,7 @@ private:
Implementation &asImp_()
{ return *static_cast<Implementation *>(this); }
- //! \copydoc Dumux::IMPETProblem::asImp_()
+ //! Returns the implementation of the problem (i.e. static polymorphism)
const Implementation &asImp_() const
{ return *static_cast<const Implementation *>(this); }
diff --git a/dumux/decoupled/2p/impes/impesproperties2p.hh b/dumux/decoupled/2p/impes/impesproperties2p.hh
index dcbcd14eff..8676ae96d3 100644
--- a/dumux/decoupled/2p/impes/impesproperties2p.hh
+++ b/dumux/decoupled/2p/impes/impesproperties2p.hh
@@ -26,12 +26,12 @@
#include <dumux/decoupled/2p/2pproperties.hh>
/*!
- * \ingroup IMPET
+ * \ingroup IMPES
* \ingroup Properties
*/
/*!
* \file
- * \brief Base file for properties related to sequential IMPET algorithms
+ * \brief Properties related to the sequential IMPES algorithms
*/
namespace Dumux
{
@@ -40,16 +40,15 @@ namespace Properties
{
/*!
*
- * \brief General properties for sequential IMPET algorithms
+ * \brief General properties for sequential IMPES algorithms
*
- * This class holds properties necessary for the sequential IMPET solution.
*/
//////////////////////////////////////////////////////////////////
// Type tags tags
//////////////////////////////////////////////////////////////////
-//! The type tag for models based on the diffusion-scheme
+//! TypeTag for the two-phase IMPES scheme
NEW_TYPE_TAG(IMPESTwoP, INHERITS_FROM(IMPET, DecoupledTwoP));
//////////////////////////////////////////////////////////////////
diff --git a/dumux/decoupled/2p/impes/impesproperties2padaptive.hh b/dumux/decoupled/2p/impes/impesproperties2padaptive.hh
index 7762a41bae..53c720e426 100644
--- a/dumux/decoupled/2p/impes/impesproperties2padaptive.hh
+++ b/dumux/decoupled/2p/impes/impesproperties2padaptive.hh
@@ -26,12 +26,12 @@
#include <dumux/decoupled/2p/2pproperties.hh>
/*!
- * \ingroup IMPET
+ * \ingroup IMPES
* \ingroup Properties
*/
/*!
* \file
- * \brief Base file for properties related to sequential IMPET algorithms
+ * \brief Properties for adaptive implementations of the sequential IMPES algorithms
*/
namespace Dumux
{
@@ -40,16 +40,14 @@ namespace Properties
{
/*!
*
- * \brief General properties for sequential IMPET algorithms
- *
- * This class holds properties necessary for the sequential IMPET solution.
+ * \brief General properties for adaptive implementations of the sequential IMPES algorithms
*/
//////////////////////////////////////////////////////////////////
// Type tags tags
//////////////////////////////////////////////////////////////////
-//! The type tag for models based on the diffusion-scheme
+//! TypeTag for grid-adaptive two-phase IMPES scheme
NEW_TYPE_TAG(IMPESTwoPAdaptive, INHERITS_FROM(IMPET, DecoupledTwoP));
//////////////////////////////////////////////////////////////////
@@ -66,9 +64,13 @@ namespace Dumux
{
namespace Properties
{
+//! Enable adaptive grid
SET_BOOL_PROP(IMPESTwoPAdaptive, AdaptiveGrid, true);
+//! Set variable class for adaptive impet schemes
SET_TYPE_PROP(IMPESTwoPAdaptive, Variables, Dumux::VariableClassAdaptive<TypeTag>);
+//! Set cell data class for adaptive two-phase IMPES schemes
SET_TYPE_PROP(IMPESTwoPAdaptive, CellData, Dumux::CellData2PAdaptive<TypeTag>);
+//! Set the standard indicator class of two-phase models for adaption or coarsening
SET_TYPE_PROP(IMPESTwoPAdaptive, AdaptionIndicator, GridAdaptionIndicator2P<TypeTag>);
}
}
--
GitLab