From 608f0ce16da91957896c96c405d035cecbb0711c Mon Sep 17 00:00:00 2001
From: Jonathan Youett <youett@math.fu-berlin.de>
Date: Tue, 23 Feb 2016 15:22:33 +0100
Subject: [PATCH] Improve documentation
---
dune/solvers/transferoperators/mandelobsrestrictor.cc | 4 ----
dune/solvers/transferoperators/mandelobsrestrictor.hh | 9 +++++++++
2 files changed, 9 insertions(+), 4 deletions(-)
diff --git a/dune/solvers/transferoperators/mandelobsrestrictor.cc b/dune/solvers/transferoperators/mandelobsrestrictor.cc
index d5c9fad4..2593b433 100644
--- a/dune/solvers/transferoperators/mandelobsrestrictor.cc
+++ b/dune/solvers/transferoperators/mandelobsrestrictor.cc
@@ -22,10 +22,6 @@ restrict(const std::vector<BoxConstraint<field_type, blocksize> >&f,
for (size_t i=0; i<t.size(); i++)
t[i].clear();
- // The Mandel restriction computes the maximum $m$ of all nodal base coefficients
- // in the support of a given coarse grid base function \f$ \phi_c \f$. If the
- // coefficient of \f$ \phi_c \f$ is smaller than \f$ m \f$ , it is set to \f$ m \f$.
-
// We use the multigrid transfer matrix to find all relevant fine grid dofs
typedef typename Dune::BCRSMatrix<Dune::FieldMatrix<field_type,1,1> >::row_type RowType;
typedef typename RowType::ConstIterator ColumnIterator;
diff --git a/dune/solvers/transferoperators/mandelobsrestrictor.hh b/dune/solvers/transferoperators/mandelobsrestrictor.hh
index 9346d3de..0b8c66f3 100644
--- a/dune/solvers/transferoperators/mandelobsrestrictor.hh
+++ b/dune/solvers/transferoperators/mandelobsrestrictor.hh
@@ -8,6 +8,14 @@
#include <dune/solvers/transferoperators/multigridtransfer.hh>
#include <dune/solvers/common/boxconstraint.hh>
+/** \brief Mandel restriction to compute coarse grid obstacles, needed within montone multigrid methods.
+ *
+ * The Mandel restriction computes the maximum $m$ of all nodal base coefficients
+ * in the support of a given coarse grid base function \f$ \phi_c \f$. If the
+ * coefficient of \f$ \phi_c \f$ is smaller than \f$ m \f$ , it is set to \f$ m \f$.
+ *
+ * \tparam VectorType The block vector type of the algebraic problem.
+ */
template <class VectorType>
class MandelObstacleRestrictor : public ObstacleRestrictor<VectorType>
{
@@ -17,6 +25,7 @@ class MandelObstacleRestrictor : public ObstacleRestrictor<VectorType>
public:
+ //! Compute coarse grid obstacles using the mandel restriction
virtual void restrict(const std::vector<BoxConstraint<field_type,blocksize> >& f,
std::vector<BoxConstraint<field_type,blocksize> >& t,
const Dune::BitSetVector<blocksize>& fHasObstacle,
--
GitLab