Skip to content
Snippets Groups Projects
Commit 8c852f02 authored by Uli Sack's avatar Uli Sack Committed by usack
Browse files

reformat docu

[[Imported from SVN: r6544]]
parent 84b0aaa9
Branches
Tags
No related merge requests found
......@@ -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_;
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment