weightedresidreductioncriterion.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_WEIGHTED_RESIDUAL_REDUCTION_CRITERION_HH
#define EWOMS_ISTL_WEIGHTED_RESIDUAL_REDUCTION_CRITERION_HH

#include "convergencecriterion.hh"

#include <iostream>

namespace Ewoms {
template <class Vector, class CollectiveCommunication>
class WeightedResidualReductionCriterion : public ConvergenceCriterion<Vector>
{
    typedef typename Vector::field_type Scalar;
    typedef typename Vector::block_type BlockType;

public:
    WeightedResidualReductionCriterion(const CollectiveCommunication &comm)
        : comm_(comm)
    {}

    WeightedResidualReductionCriterion(const CollectiveCommunication &comm,
                                       const Vector &residWeights,
                                       Scalar fixPointTolerance,
                                       Scalar residualReductionTolerance,
                                       Scalar absResidualTolerance = 0.0)
        : comm_(comm),
          residWeightVec_(residWeights),
          fixPointTolerance_(fixPointTolerance),
          residualReductionTolerance_(residualReductionTolerance),
          absResidualTolerance_(absResidualTolerance)
    {
        Scalar minFixPointTolerance = 100*std::numeric_limits<Scalar>::epsilon();
        fixPointTolerance_ = std::max(fixPointTolerance_, minFixPointTolerance);
    }

    void setResidualWeight(const Vector &residWeightVec)
    { residWeightVec_ = residWeightVec; }

    Scalar residualWeight(int outerIdx, int innerIdx) const
    {
        return (residWeightVec_.size() == 0)
                   ? 1.0
                   : residWeightVec_[outerIdx][innerIdx];
    }

    void setResidualReductionTolerance(Scalar tol)
    { residualReductionTolerance_ = tol; }

    Scalar residualReductionTolerance() const
    { return residualReductionTolerance_; }

    void setResidualTolerance(Scalar tol)
    { absResidualTolerance_ = tol; }

    Scalar absResidualTolerance() const
    { return absResidualTolerance_; }

    Scalar residualAccuracy() const
    { return residualError_/std::max<Scalar>(1e-20, initialResidualError_); }

    void setFixPointTolerance(Scalar tol)
    { fixPointTolerance_ = tol; }

    Scalar fixPointTolerance() const
    { return fixPointTolerance_; }

    Scalar fixPointAccuracy() const
    { return fixPointError_; }

    void setInitial(const Vector &curSol, const Vector &curResid)
    {
        lastResidualError_ = 1e100;

        lastSolVec_ = curSol;
        updateErrors_(curSol, curResid);
        // the fix-point error is not applicable for the initial solution!
        fixPointError_ = 1e100;

        // make sure that we don't allow an initial error of 0 to avoid
        // divisions by zero
        residualError_ = std::max<Scalar>(residualError_, 1e-20);
        initialResidualError_ = residualError_;
    }

    void update(const Vector &curSol, const Vector &curResid)
    {
        lastResidualError_ = residualError_;
        updateErrors_(curSol, curResid);
    }

    bool converged() const
    {
        // we're converged if the solution is better than the tolerance
        // fix-point and residual tolerance.
        return
            fixPointError_ <= fixPointTolerance_ ||
            residualAccuracy() <= residualReductionTolerance() ||
            residualError_ <= absResidualTolerance_;
    }

    Scalar accuracy() const
    { return residualError_; }

    void printInitial(std::ostream &os = std::cout) const
    {
        os << std::setw(20) << " Iter ";
        os << std::setw(20) << " Delta ";
        os << std::setw(20) << " Residual ";
        os << std::setw(20) << " ResidRed ";
        os << std::setw(20) << " Rate ";
        os << std::endl;

        os << std::setw(20) << 0 << " ";
        os << std::setw(20) << " ";
        os << std::setw(20) << residualError_ << " ";
        os << std::setw(20) << 1/residualAccuracy() << " ";
        os << std::setw(20) << " ";
        os << std::endl << std::flush;
    }

    void print(Scalar iter, std::ostream &os = std::cout) const
    {
        os << std::setw(20) << iter << " ";
        os << std::setw(20) << fixPointAccuracy() << " ";
        os << std::setw(20) << residualError_ << " ";
        os << std::setw(20) << 1/residualAccuracy() << " ";
        os << std::setw(20) << lastResidualError_ / std::max<Scalar>(residualError_, 1e-80) << " ";
        os << std::endl << std::flush;
    }

private:
    // update the weighted absolute residual
    void updateErrors_(const Vector &curSol, const Vector &curResid)
    {
        residualError_ = 0.0;
        fixPointError_ = 0.0;
        for (size_t i = 0; i < curResid.size(); ++i) {
            for (size_t j = 0; j < BlockType::dimension; ++j) {
                residualError_ =
                    std::max<Scalar>(residualError_,
                                     residualWeight(i, j)*std::abs(curResid[i][j]));
                fixPointError_ =
                    std::max<Scalar>(fixPointError_,
                                     std::abs(curSol[i][j] - lastSolVec_[i][j])
                                     /std::max<Scalar>(1.0, curSol[i][j]));
            }
        }
        lastSolVec_ = curSol;

        residualError_ = comm_.max(residualError_);
        fixPointError_ = comm_.max(fixPointError_);
    }

    const CollectiveCommunication &comm_;

    // the weights of the components of the residual
    Vector residWeightVec_;

    // solution vector of the last iteration
    Vector lastSolVec_;

    // the maximum of the weighted difference between the last two
    // iterations
    Scalar fixPointError_;

    // the maximum allowed relative tolerance for difference of the
    // solution of two iterations
    Scalar fixPointTolerance_;

    // the maximum of the absolute weighted residual of the last
    // iteration
    Scalar residualError_;

    // the maximum of the absolute weighted difference of the last
    // iteration
    Scalar lastResidualError_;

    // the maximum of the absolute weighted residual of the initial
    // solution
    Scalar initialResidualError_;

    // the maximum allowed relative tolerance of the residual for the
    // solution to be considered converged
    Scalar residualReductionTolerance_;

    // the maximum allowed absolute tolerance of the residual for the
    // solution to be considered converged
    Scalar absResidualTolerance_;
};


} // end namespace Ewoms

#endif