/home/brandes/workspace/LAMA/src/lama/solver/IterativeSolver.hpp

Go to the documentation of this file.

#ifndef LAMA_ITERATIVESOLVER_HPP_
#define LAMA_ITERATIVESOLVER_HPP_

// for dll_import
#include <lama/config.hpp>

// base classes
#include <lama/solver/Solver.hpp>

// others
#include <lama/solver/criteria/IterationCount.hpp>

// logging
#include <logging/Logger.hpp>

namespace lama
{

class LAMA_DLL_IMPORTEXPORT IterativeSolver : public Solver
{
public:
    IterativeSolver( const std::string& id );

    IterativeSolver( const std::string& id, LoggerPtr logger );

    IterativeSolver( const IterativeSolver& other );

    virtual ~IterativeSolver();

    virtual void initialize( const Matrix& coefficients );

    virtual void solveImpl();

    void setStoppingCriterion( const CriterionPtr criterion );

    void setPreconditioner( SolverPtr const conditioner);

    const SolverPtr getPreconditioner() const;

    int getIterationCount() const;

    virtual SolverPtr copy() =0;

    struct IterativeSolverRuntime : SolverRuntime
    {
        IterativeSolverRuntime();
        virtual ~IterativeSolverRuntime();

        IndexType mIterations;
    };

    virtual IterativeSolverRuntime& getRuntime() =0;

    virtual const IterativeSolverRuntime& getConstRuntime() const =0;

protected:

    bool criteriaAreSatisfied() const;

    virtual void iterate() = 0;

    SolverPtr mPreconditioner;

    CriterionPtr mCriterionRootComponent;

    void logStartSolve();
    void logEndSolve();
    void logIterationEndAndResidual();
    void logIterationStart();

    LAMA_LOG_DECL_STATIC_LOGGER(logger);
};

}// namespace lama

#endif // LAMA_ITERATIVESOLVER_HPP_