diff --git a/dumux/decoupled/2p/impes/gridadaptionindicator2plocal.hh b/dumux/decoupled/2p/impes/gridadaptionindicator2plocal.hh index 7131b40554d5db3b65dbd5ab3a655130b954391c..e760a5016ea53270fc5129b03323a3b85c8b4e61 100644 --- a/dumux/decoupled/2p/impes/gridadaptionindicator2plocal.hh +++ b/dumux/decoupled/2p/impes/gridadaptionindicator2plocal.hh @@ -23,13 +23,13 @@ #include <dumux/decoupled/2p/2pproperties.hh> /** - * @file - * @brief Class defining a standard, saturation dependent indicator for grid adaption + * \file + * \brief Class defining a standard, saturation dependent indicator for grid adaption */ namespace Dumux { /*!\ingroup IMPES - * @brief Class defining a standard, saturation dependent indicator for grid adaption + * \brief Class defining a standard, saturation dependent indicator for grid adaption * * \tparam TypeTag The problem TypeTag */ @@ -250,17 +250,25 @@ public: coarsenBound_ = 0.; }; + /*! \brief Function for changing the indicatorVector values for refinement + * + * \param idx Index of cell which may be refined + */ void setIndicatorToRefine(int idx) { indicatorVector_[idx] = coarsenBound_+1; } + /*! \brief Function for changing the indicatorVector values for coarsening + * + * \param idx Index of cell which may be coarsen + */ void setIndicatorToCoarse(int idx) { indicatorVector_[idx] = refineBound_ - 1; } - /*! @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.