From 898c5d91d78a6a8762d3a39890a013df7bbf3a22 Mon Sep 17 00:00:00 2001
From: Max Kahnt <max.kahnt@fu-berlin.de>
Date: Tue, 2 Aug 2016 13:18:02 +0200
Subject: [PATCH] Add method description for fractional marking.
---
dune/fufem/estimators/fractionalmarking.hh | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/dune/fufem/estimators/fractionalmarking.hh b/dune/fufem/estimators/fractionalmarking.hh
index 0ba81484..99cac762 100644
--- a/dune/fufem/estimators/fractionalmarking.hh
+++ b/dune/fufem/estimators/fractionalmarking.hh
@@ -15,6 +15,7 @@
#include <dune/fufem/estimators/refinementindicator.hh>
+//! \brief See static method @mark for details.
template <class GridType, class field_type = double>
class FractionalMarkingStrategy
{
@@ -40,6 +41,17 @@ public:
const std::vector<GridType*>& grids,
field_type fraction);
+ /**
+ * \brief Sorts the elements of all grids according to the maximal error
+ * associated with any of its subentities and marks the top percentage of
+ * those (for refinement).
+ * \param refinementIndicator For each grid, the errors associated with its
+ * entities are provided here.
+ * \param fraction Specifies the total number of elements to be refined in
+ * terms of percentage/100 of all elements of all grids.
+ */
+ // TODO: IMHO the implementation does not provide a mechanism that prevents
+ // refining elements where all associated errors are zero.
static void mark(const std::vector<std::shared_ptr<RefinementIndicator<GridType> > >& refinementIndicator,
const std::vector<GridType*>& grids,
field_type fraction);
--
GitLab