/home/brandes/workspace/LAMA/src/lama/solver/criteria/ResidualThreshold.hpp

Go to the documentation of this file.

#ifndef LAMA_RESIDUALTHRESHOLD_HPP_
#define LAMA_RESIDUALTHRESHOLD_HPP_

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

// base classes
#include <lama/solver/criteria/Criterion.hpp>

// others
#include <lama/Scalar.hpp>

#include <lama/norm/Norm.hpp>

namespace lama
{

class LAMA_DLL_IMPORTEXPORT ResidualThreshold : public Criterion
{
public:
    enum ResidualThresholdCheckMode
    {
        Absolute,   
        Relative    
    };

    /*
     * @brief Empty constructor first. Configured by setter methods.
     */
    ResidualThreshold();

    ResidualThreshold(const NormPtr norm);

    ResidualThreshold(const NormPtr norm, Scalar precision, ResidualThresholdCheckMode checkMode);

    ResidualThreshold(const ResidualThreshold& other);

    virtual ~ResidualThreshold();

    virtual Criterion* copy() const;

    bool isSatisfied(const IterativeSolver& solver);

    ResidualThresholdCheckMode getCheckMode() const;
    IndexType getIterationExtrema() const;
    Scalar getFirstNormResult() const;
    const NormPtr getNorm() const;
    Scalar getPrecision() const;

    void setCheckMode(ResidualThresholdCheckMode mCheckMode);
    void setFirstNormResult(Scalar firstNormResult);
    void setPrecision( Scalar precision );

    virtual void writeAt(std::ostream& stream) const;

protected:
    LAMA_LOG_USING( Criterion::logger );
private:
    const NormPtr mNorm;
    ResidualThresholdCheckMode mCheckMode;
    Scalar mPrecision;
    Scalar mFirstNormResult;
};

} //namespace lama

#endif // LAMA_RESIDUALTHRESHOLD_HPP_