From 8c852f02745723be8c4594dceb559b1cf597611a Mon Sep 17 00:00:00 2001
From: Uli Sack <usack@math.fu-berlin.de>
Date: Mon, 23 Jul 2012 13:59:27 +0000
Subject: [PATCH] reformat docu
[[Imported from SVN: r6544]]
---
dune/solvers/solvers/loopsolver.hh | 23 ++++++++++++-----------
1 file changed, 12 insertions(+), 11 deletions(-)
diff --git a/dune/solvers/solvers/loopsolver.hh b/dune/solvers/solvers/loopsolver.hh
index c167f2c9..5cbbb675 100644
--- a/dune/solvers/solvers/loopsolver.hh
+++ b/dune/solvers/solvers/loopsolver.hh
@@ -6,15 +6,15 @@
#include <dune/solvers/norms/norm.hh>
/** \brief A solver which consists of a single loop
- *
- This class basically implements a loop that calls an iteration procedure
- (which is to be supplied by the user). It also monitors convergence.
-*/
+ *
+ * This class basically implements a loop that calls an iteration procedure
+ * (which is to be supplied by the user). It also monitors convergence.
+ */
template <class VectorType, class BitVectorType = Dune::BitSetVector<VectorType::block_type::dimension> >
class LoopSolver : public IterativeSolver<VectorType, BitVectorType>
{
public:
-
+
/** \brief Constructor taking all relevant data */
LoopSolver(IterationStep<VectorType, BitVectorType>* iterationStep,
int maxIterations,
@@ -32,15 +32,16 @@ public:
referenceSolution_(referenceSolution)
{}
- /** \brief Checks whether all relevant member variables are set
- * \exception SolverError if the iteration step is not set up properly
- */
+ /** \brief Checks whether all relevant member variables are set
+ * \exception SolverError if the iteration step is not set up properly
+ */
virtual void check() const;
- /** \brief Loop, call the iteration procedure
- * and monitor convergence */
+ /** \brief Loop, call the iteration procedure
+ * and monitor convergence
+ */
virtual void solve();
-
+
//! The iteration step used by the algorithm
IterationStep<VectorType, BitVectorType>* iterationStep_;
--
GitLab