From f79194cdf2af9b4b1358bcb193c5ecdfe7af0107 Mon Sep 17 00:00:00 2001
From: Max Kahnt <max.kahnt@fu-berlin.de>
Date: Tue, 2 Aug 2016 13:18:19 +0200
Subject: [PATCH] Add method description for error fraction marking.
---
dune/fufem/estimators/errorfractionmarking.hh | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/dune/fufem/estimators/errorfractionmarking.hh b/dune/fufem/estimators/errorfractionmarking.hh
index 48fb95be..f6d8e18d 100644
--- a/dune/fufem/estimators/errorfractionmarking.hh
+++ b/dune/fufem/estimators/errorfractionmarking.hh
@@ -48,6 +48,15 @@ class ErrorFractionMarkingStrategy
GridType& grid,
double fraction);
+ /**
+ * \brief Sorts the errors associated to all subentities of all grids
+ * and marks all those elements (for refimenent) that have a subentity
+ * among the top percentage.
+ * \param refinementIndicator For each grid, the errors associated with
+ * its entities are provided here.
+ * \param fraction Specifies the fraction of the error to be taken into
+ * account for refinement.
+ */
static void mark(const std::vector<RefinementIndicator<GridType>* >& refinementIndicator,
const std::vector<GridType*>& grids,
double fraction);
--
GitLab