From eecc871458a2fa1fae8daf3b9c2401828a4b1f0a Mon Sep 17 00:00:00 2001
From: Jonathan Youett <youett@mi.fu-berlin.de>
Date: Wed, 1 Feb 2012 11:06:16 +0000
Subject: [PATCH] add doxygen documentation
[[Imported from SVN: r5586]]
---
dune/solvers/iterationsteps/blockgsstep.hh | 15 ++++++++++++++-
1 file changed, 14 insertions(+), 1 deletion(-)
diff --git a/dune/solvers/iterationsteps/blockgsstep.hh b/dune/solvers/iterationsteps/blockgsstep.hh
index 2aa6b31b..70353bc0 100644
--- a/dune/solvers/iterationsteps/blockgsstep.hh
+++ b/dune/solvers/iterationsteps/blockgsstep.hh
@@ -5,6 +5,13 @@
#include "lineariterationstep.hh"
+/** \brief A linear Gauß-Seidel iteration step for convex problems which have a block-structure.
+ *
+ * \tparam OperatorType The linear operator type
+ * \tparam DiscFuncType The block vector type of the right hand side and the iterates
+ * \tparam BitVectorType The type of the bit-vector specifying degrees of freedom that shall be ignored.
+ *
+ */
template<class OperatorType,
class DiscFuncType,
class BitVectorType = Dune::BitSetVector<DiscFuncType::block_type::dimension> >
@@ -27,9 +34,15 @@ template<class OperatorType,
//! Perform one iteration
virtual void iterate();
-
+
+ //! Return the solution
virtual DiscFuncType getSol();
+ /** \brief Compute the residual of the current iterate of a (block) degree of freedom
+ *
+ * \param index Global index of the (block) degree of freedom
+ * \param r Write residual in this vector
+ */
virtual void residual(int index, VectorBlock& r) const;
};
--
GitLab