residreductioncriterion.hh

Go to the documentation of this file.

// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// vi: set et ts=4 sw=4 sts=4:
/*
  Copyright (C) 2009-2013 by Andreas Lauser

  This file is part of the Open Porous Media project (OPM).

  OPM is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 2 of the License, or
  (at your option) any later version.

  OPM is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with OPM.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef EWOMS_ISTL_RESID_REDUCTION_CRITERION_HH
#define EWOMS_ISTL_RESID_REDUCTION_CRITERION_HH

#include "convergencecriterion.hh"

#include <dune/istl/scalarproducts.hh>

namespace Ewoms {
template <class Vector>
class ResidReductionCriterion : public ConvergenceCriterion<Vector>
{
    typedef typename Vector::field_type Scalar;

public:
    ResidReductionCriterion(Dune::ScalarProduct<Vector> &scalarProduct)
        : scalarProduct_(scalarProduct)
    {}

    ResidReductionCriterion(Dune::ScalarProduct<Vector> &scalarProduct,
                            Scalar reduction)
        : scalarProduct_(scalarProduct), defectReduction_(reduction)
    {}

    void setTolerance(Scalar tol)
    { defectReduction_ = tol; }

  Scalar tolerance() const
  {
    return initialDefect_*defectReduction_;
  }

    void setInitial(const Vector &curSol, const Vector &curResid)
    {
        // make sure that we don't allow an initial error of 0 to avoid
        // divisions by zero
        initialDefect_ = std::max(scalarProduct_.norm(curResid), 1e-20);
        curDefect_ = initialDefect_;
    }

    void update(const Vector &curSol, const Vector &curResid)
    { curDefect_ = scalarProduct_.norm(curResid); }

    bool converged() const
    { return curDefect_ <= tolerance(); }

    Scalar accuracy() const
    { return curDefect_; }

    void printInitial(std::ostream &os=std::cout) const
    {
        os << std::setw(20) << " Iter ";
        os << std::setw(20) << " Defect ";
        os << std::setw(20) << " Reduction ";
        os << std::endl;

        os << std::setw(20) << 0 << " ";
        os << std::setw(20) << curDefect_ << " ";
        os << std::setw(20) << defectReduction_ << " ";
        os << std::endl << std::flush;
    }

    void print(Scalar iter, std::ostream &os=std::cout) const
    {
        os << std::setw(20) << iter << " ";
        os << std::setw(20) << curDefect_ << " ";
        os << std::setw(20) << defectReduction_ << " ";
        os << std::endl << std::flush;
    }

private:
    Dune::ScalarProduct<Vector> &scalarProduct_;

    Scalar initialDefect_;
    Scalar curDefect_;
    Scalar defectReduction_;
};


} // end namespace Ewoms

#endif