fvbasenewtonmethod.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_FV_BASE_NEWTON_METHOD_HH
#define EWOMS_FV_BASE_NEWTON_METHOD_HH

#include "fvbasenewtonconvergencewriter.hh"

#include <ewoms/nonlinear/newtonmethod.hh>
#include <ewoms/common/propertysystem.hh>

namespace Ewoms {

template <class TypeTag>
class FvBaseNewtonMethod;

template <class TypeTag>
class FvBaseNewtonConvergenceWriter;
} // namespace Ewoms

namespace Ewoms {
namespace Properties {
NEW_TYPE_TAG(FvBaseNewtonMethod, INHERITS_FROM(NewtonMethod));

NEW_PROP_TAG(Model);

NEW_PROP_TAG(PrimaryVariables);

NEW_PROP_TAG(EqVector);

NEW_PROP_TAG(NumEq);

NEW_PROP_TAG(DiscNewtonMethod);

NEW_PROP_TAG(NewtonMethod);

NEW_PROP_TAG(EnablePartialRelinearization);

NEW_PROP_TAG(EnableLinearizationRecycling);

NEW_PROP_TAG(LinearSolverTolerance);

// set default values
SET_TYPE_PROP(FvBaseNewtonMethod, DiscNewtonMethod,
              Ewoms::FvBaseNewtonMethod<TypeTag>);
SET_TYPE_PROP(FvBaseNewtonMethod, NewtonMethod,
              typename GET_PROP_TYPE(TypeTag, DiscNewtonMethod));
SET_TYPE_PROP(FvBaseNewtonMethod, NewtonConvergenceWriter,
              Ewoms::FvBaseNewtonConvergenceWriter<TypeTag>);
} // namespace Properties

template <class TypeTag>
class FvBaseNewtonMethod : public NewtonMethod<TypeTag>
{
    typedef Ewoms::NewtonMethod<TypeTag> ParentType;
    typedef typename GET_PROP_TYPE(TypeTag, NewtonMethod) Implementation;

    typedef typename GET_PROP_TYPE(TypeTag, Scalar) Scalar;
    typedef typename GET_PROP_TYPE(TypeTag, Simulator) Simulator;
    typedef typename GET_PROP_TYPE(TypeTag, Model) Model;
    typedef typename GET_PROP_TYPE(TypeTag, Linearizer) Linearizer;
    typedef typename GET_PROP_TYPE(TypeTag, NewtonMethod) NewtonMethod;
    typedef typename GET_PROP_TYPE(TypeTag, GlobalEqVector) GlobalEqVector;
    typedef typename GET_PROP_TYPE(TypeTag, SolutionVector) SolutionVector;
    typedef typename GET_PROP_TYPE(TypeTag, PrimaryVariables) PrimaryVariables;
    typedef typename GET_PROP_TYPE(TypeTag, EqVector) EqVector;


public:
    FvBaseNewtonMethod(Simulator &simulator)
        : ParentType(simulator)
    { }

protected:
    friend class Ewoms::NewtonMethod<TypeTag>;

    void update_(SolutionVector &nextSolution,
                 const SolutionVector &currentSolution,
                 const GlobalEqVector &solutionUpdate,
                 const GlobalEqVector &currentResidual)
    {
        auto& model = this->model();
        auto& linearizer = model.linearizer();

        // first, write out the next solution to make convergence
        // analysis possible
        this->writeConvergence_(currentSolution, solutionUpdate);

        // make sure not to swallow non-finite values at this point
        if (!std::isfinite(solutionUpdate.two_norm2()))
            OPM_THROW(Opm::NumericalProblem, "Non-finite update!");

        Scalar relinearizationTol = 0.0;

        // compute the DOF and element colors for partial relinearization
        if (enablePartialRelinearization_()) {
            linearizer.updateRelinearizationErrors(solutionUpdate, currentResidual);

            // we chose to relinearize all DOFs for which the solution is to be deflected
            // by more than a thousandth of the maximum deflection.
            relinearizationTol = 1e-1*linearizer.maxDofError();

            // decrease the relinearization tolerance until at least 15% of the DOFs are
            // relinearized. (or by at most 6 orders of magnitude.)
            for (unsigned i = 0; i < 6; ++i) {
                unsigned numRelinearized = 0;
                for (unsigned dofIdx = 0; dofIdx < model.numGridDof(); ++dofIdx) {
                    if (linearizer.dofError(dofIdx) > relinearizationTol)
                        ++numRelinearized;
                }

                if (numRelinearized*100 >= model.numGridDof()*15)
                    break;

                relinearizationTol /= 10;
            }

            // tell the linarizer what tolerance it should use
            linearizer.setRelinearizationTolerance(relinearizationTol);
        }

        // update the solution for the grid DOFs
        for (unsigned dofIdx = 0; dofIdx < model.numGridDof(); ++dofIdx) {
            asImp_().updatePrimaryVariables_(dofIdx,
                                             nextSolution[dofIdx],
                                             currentSolution[dofIdx],
                                             solutionUpdate[dofIdx],
                                             currentResidual[dofIdx]);
            model.setIntensiveQuantitiesCacheEntryValidity(dofIdx, /*timeIdx=*/0, false);
        }

        // update the DOFs of the auxiliary equations
        int nTotalDof = model.numTotalDof();
        for (int dofIdx = model.numGridDof(); dofIdx < nTotalDof; ++dofIdx) {
            nextSolution[dofIdx] = currentSolution[dofIdx];
            nextSolution[dofIdx] -= solutionUpdate[dofIdx];
        }
    }

    void beginIteration_()
    {
        model_().syncOverlap();

        ParentType::beginIteration_();
    }

    void failed_()
    {
        ParentType::failed_();

        model_().linearizer().relinearizeAll();
    }

    void succeeded_()
    {
        ParentType::succeeded_();

        if (enableLinearizationRecycling_())
            model_().linearizer().setLinearizationReusable(true);
        else
            model_().linearizer().relinearizeAll();
    }

    Model &model_()
    { return ParentType::model(); }

    const Model &model_() const
    { return ParentType::model(); }

private:
    Implementation &asImp_()
    { return *static_cast<Implementation*>(this); }

    const Implementation &asImp_() const
    { return *static_cast<const Implementation*>(this); }

    bool enablePartialRelinearization_() const
    { return EWOMS_GET_PARAM(TypeTag, bool, EnablePartialRelinearization); }

    bool enableLinearizationRecycling_() const
    { return EWOMS_GET_PARAM(TypeTag, bool, EnableLinearizationRecycling); }
};
} // namespace Ewoms

#endif