Skip to content
Snippets Groups Projects
Commit f16da16d authored by oliver.sander_at_tu-dresden.de's avatar oliver.sander_at_tu-dresden.de
Browse files

Explicitly say what the 'Linear' prefix means here

The class is called Linear... because it is a base class for
iteration steps that solve linear problems, *not* because it
is a base class for iteration steps that implement linear
algorithms.
parent 1f5d18b6
Branches
No related tags found
No related merge requests found
Pipeline #
...@@ -18,7 +18,17 @@ namespace Dune { ...@@ -18,7 +18,17 @@ namespace Dune {
namespace Solvers { namespace Solvers {
//! Base class for iteration steps being called by an iterative linear solver /** \brief Base class for iteration steps being called by an iterative solver for linear problems
*
* This class is called Linear, because all iteration step implementations that derive from it
* are supposed to solve linear problems. In particular, this means that the LinearIterationStep
* class knows about matrix data types, and it has the setProblem and setMatrix methods that
* allow to specify the matrix of the linear system to solve.
*
* The 'Linear' in the name is not about the type of algorithm. For example, one step of a
* CG solver would qualify as a LinearIterationStep: CG is not a linear algorithm, but it is
* a solver for solving linear problems.
*/
template<class MatrixType, class VectorType, class BitVectorType = Dune::Solvers::DefaultBitVector_t<VectorType> > template<class MatrixType, class VectorType, class BitVectorType = Dune::Solvers::DefaultBitVector_t<VectorType> >
class LinearIterationStep : public IterationStep<VectorType, BitVectorType>, class LinearIterationStep : public IterationStep<VectorType, BitVectorType>,
public Dune::Solvers::Preconditioner<MatrixType, public Dune::Solvers::Preconditioner<MatrixType,
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment