Skip to content
Snippets Groups Projects
Commit ca6286d8 authored by Martin Schneider's avatar Martin Schneider
Browse files

Added the doxygen docu for setIndicatorToRefine and setIndicatorToCoarse functions

git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@11613 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent fe31c807
No related branches found
No related tags found
No related merge requests found
...@@ -23,13 +23,13 @@ ...@@ -23,13 +23,13 @@
#include <dumux/decoupled/2p/2pproperties.hh> #include <dumux/decoupled/2p/2pproperties.hh>
/** /**
* @file * \file
* @brief Class defining a standard, saturation dependent indicator for grid adaption * \brief Class defining a standard, saturation dependent indicator for grid adaption
*/ */
namespace Dumux namespace Dumux
{ {
/*!\ingroup IMPES /*!\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 * \tparam TypeTag The problem TypeTag
*/ */
...@@ -250,17 +250,25 @@ public: ...@@ -250,17 +250,25 @@ public:
coarsenBound_ = 0.; coarsenBound_ = 0.;
}; };
/*! \brief Function for changing the indicatorVector values for refinement
*
* \param idx Index of cell which may be refined
*/
void setIndicatorToRefine(int idx) void setIndicatorToRefine(int idx)
{ {
indicatorVector_[idx] = coarsenBound_+1; 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) void setIndicatorToCoarse(int idx)
{ {
indicatorVector_[idx] = refineBound_ - 1; 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. * 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. * 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.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment