pvsmodel.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_PVS_MODEL_HH
#define EWOMS_PVS_MODEL_HH

#include <opm/material/localad/Math.hpp>

#include "pvsproperties.hh"
#include "pvslocalresidual.hh"
#include "pvsnewtonmethod.hh"
#include "pvsprimaryvariables.hh"
#include "pvsratevector.hh"
#include "pvsboundaryratevector.hh"
#include "pvsintensivequantities.hh"
#include "pvsextensivequantities.hh"
#include "pvsindices.hh"

#include <ewoms/models/common/multiphasebasemodel.hh>
#include <ewoms/models/common/diffusionmodule.hh>
#include <ewoms/models/common/energymodule.hh>
#include <ewoms/io/vtkcompositionmodule.hh>
#include <ewoms/io/vtkenergymodule.hh>
#include <ewoms/io/vtkdiffusionmodule.hh>
#include <opm/material/fluidmatrixinteractions/NullMaterial.hpp>
#include <opm/material/fluidmatrixinteractions/MaterialTraits.hpp>

#include <iostream>
#include <sstream>
#include <string>
#include <vector>

namespace Ewoms {
template <class TypeTag>
class PvsModel;
}

namespace Ewoms {
namespace Properties {
NEW_TYPE_TAG(PvsModel, INHERITS_FROM(MultiPhaseBaseModel,
                                     VtkPhasePresence,
                                     VtkComposition,
                                     VtkEnergy,
                                     VtkDiffusion));

SET_TYPE_PROP(PvsModel,
              LocalResidual,
              Ewoms::PvsLocalResidual<TypeTag>);

SET_TYPE_PROP(PvsModel, NewtonMethod, Ewoms::PvsNewtonMethod<TypeTag>);

SET_TYPE_PROP(PvsModel, Model, Ewoms::PvsModel<TypeTag>);

SET_TYPE_PROP(PvsModel, PrimaryVariables, Ewoms::PvsPrimaryVariables<TypeTag>);

SET_TYPE_PROP(PvsModel, RateVector, Ewoms::PvsRateVector<TypeTag>);

SET_TYPE_PROP(PvsModel, BoundaryRateVector, Ewoms::PvsBoundaryRateVector<TypeTag>);

SET_TYPE_PROP(PvsModel, IntensiveQuantities, Ewoms::PvsIntensiveQuantities<TypeTag>);

SET_TYPE_PROP(PvsModel, ExtensiveQuantities, Ewoms::PvsExtensiveQuantities<TypeTag>);

SET_TYPE_PROP(PvsModel, Indices, Ewoms::PvsIndices<TypeTag, /*PVIdx=*/0>);

// set the model to a medium verbosity
SET_INT_PROP(PvsModel, PvsVerbosity, 1);

SET_BOOL_PROP(PvsModel, EnableEnergy, false);

// disable molecular diffusion by default
SET_BOOL_PROP(PvsModel, EnableDiffusion, false);

SET_SCALAR_PROP(PvsModel, PvsPressureBaseWeight, 1.0);

SET_SCALAR_PROP(PvsModel, PvsSaturationsBaseWeight, 1.0);

SET_SCALAR_PROP(PvsModel, PvsMoleFractionsBaseWeight, 1.0);
} // namespace Properties

template <class TypeTag>
class PvsModel
    : public MultiPhaseBaseModel<TypeTag>
{
    typedef MultiPhaseBaseModel<TypeTag> ParentType;

    typedef typename GET_PROP_TYPE(TypeTag, Scalar) Scalar;
    typedef typename GET_PROP_TYPE(TypeTag, Simulator) Simulator;
    typedef typename GET_PROP_TYPE(TypeTag, FluidSystem) FluidSystem;
    typedef typename GET_PROP_TYPE(TypeTag, GridView) GridView;

    typedef typename GET_PROP_TYPE(TypeTag, PrimaryVariables) PrimaryVariables;
    typedef typename GET_PROP_TYPE(TypeTag, IntensiveQuantities) IntensiveQuantities;
    typedef typename GET_PROP_TYPE(TypeTag, ElementContext) ElementContext;
    typedef typename GET_PROP_TYPE(TypeTag, Indices) Indices;

    enum { numPhases = GET_PROP_VALUE(TypeTag, NumPhases) };
    enum { numComponents = GET_PROP_VALUE(TypeTag, NumComponents) };
    enum { enableDiffusion = GET_PROP_VALUE(TypeTag, EnableDiffusion) };
    enum { enableEnergy = GET_PROP_VALUE(TypeTag, EnableEnergy) };

    typedef typename GridView::template Codim<0>::Entity Element;
    typedef typename GridView::template Codim<0>::Iterator ElementIterator;

    typedef Ewoms::EnergyModule<TypeTag, enableEnergy> EnergyModule;

public:
    PvsModel(Simulator &simulator)
        : ParentType(simulator)
    {
        verbosity_ = EWOMS_GET_PARAM(TypeTag, int, PvsVerbosity);
        numSwitched_ = 0;
    }

    static void registerParameters()
    {
        ParentType::registerParameters();

        // register runtime parameters of the VTK output modules
        Ewoms::VtkPhasePresenceModule<TypeTag>::registerParameters();
        Ewoms::VtkCompositionModule<TypeTag>::registerParameters();

        if (enableDiffusion)
            Ewoms::VtkDiffusionModule<TypeTag>::registerParameters();

        if (enableEnergy)
            Ewoms::VtkEnergyModule<TypeTag>::registerParameters();

        EWOMS_REGISTER_PARAM(TypeTag, int, PvsVerbosity,
                             "The verbosity level of the primary variable "
                             "switching model");
    }

    static std::string name()
    { return "pvs"; }

    std::string primaryVarName(int pvIdx) const
    {
        std::string s;
        if (!(s = EnergyModule::primaryVarName(pvIdx)).empty())
            return s;

        std::ostringstream oss;
        if (pvIdx == Indices::pressure0Idx)
            oss << "pressure_" << FluidSystem::phaseName(/*phaseIdx=*/0);
        else if (Indices::switch0Idx <= pvIdx && pvIdx < Indices::switch0Idx
                                                         + numPhases - 1)
            oss << "switch_" << pvIdx - Indices::switch0Idx;
        else if (Indices::switch0Idx + numPhases - 1 <= pvIdx
                 && pvIdx < Indices::switch0Idx + numComponents - 1)
            oss << "auxMoleFrac^" << FluidSystem::componentName(pvIdx);
        else
            assert(false);

        return oss.str();
    }

    std::string eqName(int eqIdx) const
    {
        std::string s;
        if (!(s = EnergyModule::eqName(eqIdx)).empty())
            return s;

        std::ostringstream oss;
        if (Indices::conti0EqIdx <= eqIdx && eqIdx < Indices::conti0EqIdx
                                                     + numComponents) {
            int compIdx = eqIdx - Indices::conti0EqIdx;
            oss << "continuity^" << FluidSystem::componentName(compIdx);
        }
        else
            assert(false);

        return oss.str();
    }

    void updateFailed()
    {
        ParentType::updateFailed();
        numSwitched_ = 0;
    }

    void updateBegin()
    {
        ParentType::updateBegin();

        // find the a reference pressure. The first degree of freedom
        // might correspond to non-interior entities which would lead
        // to an undefined value, so we have to iterate...
        int nDof = this->numTotalDof();
        for (int dofIdx = 0; dofIdx < nDof; ++ dofIdx) {
            if (this->dofTotalVolume(dofIdx) > 0) {
                referencePressure_ =
                    this->solution(/*timeIdx=*/0)[dofIdx][/*pvIdx=*/Indices::pressure0Idx];
                break;
            }
        }
    }

    Scalar primaryVarWeight(int globalDofIdx, int pvIdx) const
    {
        Scalar tmp = EnergyModule::primaryVarWeight(*this, globalDofIdx, pvIdx);
        if (tmp > 0)
            // energy related quantity
            return tmp;

        if (Indices::pressure0Idx == pvIdx) {
            return 10 / referencePressure_;
        }

        if (Indices::switch0Idx <= pvIdx && pvIdx < Indices::switch0Idx
                                                    + numPhases - 1) {
            int phaseIdx = pvIdx - Indices::switch0Idx;

            if (!this->solution(/*timeIdx=*/0)[globalDofIdx].phaseIsPresent(phaseIdx))
                // for saturations, the weight is always 1
                return 1;

            // for saturations, the PvsMoleSaturationsBaseWeight
            // property determines the weight
            return GET_PROP_VALUE(TypeTag, PvsSaturationsBaseWeight);
        }

        // for mole fractions, the PvsMoleFractionsBaseWeight
        // property determines the weight
        return GET_PROP_VALUE(TypeTag, PvsMoleFractionsBaseWeight);
    }

    Scalar eqWeight(int globalDofIdx, int eqIdx) const
    {
        Scalar tmp = EnergyModule::eqWeight(*this, globalDofIdx, eqIdx);
        if (tmp > 0)
            // energy related equation
            return tmp;

        int compIdx = eqIdx - Indices::conti0EqIdx;
        assert(0 <= compIdx && compIdx <= numComponents);

        // make all kg equal
        return FluidSystem::molarMass(compIdx);
    }

    void advanceTimeLevel()
    {
        ParentType::advanceTimeLevel();
        numSwitched_ = 0;
    }

    bool switched() const
    { return numSwitched_ > 0; }

    template <class DofEntity>
    void serializeEntity(std::ostream &outstream, const DofEntity &dofEntity)
    {
        // write primary variables
        ParentType::serializeEntity(outstream, dofEntity);

#if DUNE_VERSION_NEWER(DUNE_COMMON, 2, 4)
        int dofIdx = this->dofMapper().index(dofEntity);
#else
        int dofIdx = this->dofMapper().map(dofEntity);
#endif
        if (!outstream.good())
            OPM_THROW(std::runtime_error, "Could not serialize DOF " << dofIdx);

        outstream << this->solution(/*timeIdx=*/0)[dofIdx].phasePresence() << " ";
    }

    template <class DofEntity>
    void deserializeEntity(std::istream &instream, const DofEntity &dofEntity)
    {
        // read primary variables
        ParentType::deserializeEntity(instream, dofEntity);

        // read phase presence
#if DUNE_VERSION_NEWER(DUNE_COMMON, 2, 4)
        int dofIdx = this->dofMapper().index(dofEntity);
#else
        int dofIdx = this->dofMapper().map(dofEntity);
#endif
        if (!instream.good())
            OPM_THROW(std::runtime_error,
                       "Could not deserialize DOF " << dofIdx);

        int tmp;
        instream >> tmp;
        this->solution(/*timeIdx=*/0)[dofIdx].setPhasePresence(tmp);
        this->solution(/*timeIdx=*/1)[dofIdx].setPhasePresence(tmp);
    }

    void switchPrimaryVars_()
    {
        numSwitched_ = 0;

        std::vector<bool> visited(this->numGridDof(), false);
        ElementContext elemCtx(this->simulator_);

        ElementIterator elemIt = this->gridView_.template begin<0>();
        ElementIterator elemEndIt = this->gridView_.template end<0>();
        for (; elemIt != elemEndIt; ++elemIt) {
            const Element& elem = *elemIt;
            if (elem.partitionType() != Dune::InteriorEntity)
                continue;
            elemCtx.updateStencil(elem);

            int numLocalDof = elemCtx.stencil(/*timeIdx=*/0).numPrimaryDof();
            for (int dofIdx = 0; dofIdx < numLocalDof; ++dofIdx) {
                int globalIdx = elemCtx.globalSpaceIndex(dofIdx, /*timeIdx=*/0);

                if (visited[globalIdx])
                    continue;
                visited[globalIdx] = true;

                // compute the intensive quantities of the current degree of freedom
                auto &priVars = this->solution(/*timeIdx=*/0)[globalIdx];
                elemCtx.updateIntensiveQuantities(priVars, dofIdx, /*timeIdx=*/0);
                const IntensiveQuantities &intQuants = elemCtx.intensiveQuantities(dofIdx, /*timeIdx=*/0);

                // evaluate primary variable switch
                short oldPhasePresence = priVars.phasePresence();

                // set the primary variables and the new phase state
                // from the current fluid state
                priVars.assignNaive(intQuants.fluidState());

                if (oldPhasePresence != priVars.phasePresence()) {
                    if (verbosity_ > 1)
                        printSwitchedPhases_(elemCtx,
                                             dofIdx,
                                             intQuants.fluidState(),
                                             oldPhasePresence,
                                             priVars);
                    this->linearizer().markDofRed(globalIdx);
                    ++numSwitched_;
                }
            }
        }

        // make sure that if there was a variable switch in an
        // other partition we will also set the switch flag
        // for our partition.
        numSwitched_ = this->gridView_.comm().sum(numSwitched_);

        if (verbosity_ > 0)
            this->simulator_.model().newtonMethod().endIterMsg()
                << ", num switched=" << numSwitched_;
    }

    template <class FluidState>
    void printSwitchedPhases_(const ElementContext &elemCtx,
                              int dofIdx,
                              const FluidState &fs,
                              int oldPhasePresence,
                              const PrimaryVariables &newPv) const
    {
        typedef Opm::MathToolbox<typename FluidState::Scalar> FsToolbox;

        for (int phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
            bool oldPhasePresent = (oldPhasePresence & (1 << phaseIdx)) > 0;
            bool newPhasePresent = newPv.phaseIsPresent(phaseIdx);
            if (oldPhasePresent == newPhasePresent)
                continue;

            const auto &pos = elemCtx.pos(dofIdx, /*timeIdx=*/0);
            if (oldPhasePresent && !newPhasePresent) {
                std::cout << "'" << FluidSystem::phaseName(phaseIdx)
                          << "' phase disappears at position " << pos
                          << ". saturation=" << fs.saturation(phaseIdx)
                          << std::flush;
            }
            else {
                Scalar sumx = 0;
                for (int compIdx = 0; compIdx < numComponents; ++compIdx)
                    sumx += FsToolbox::value(fs.moleFraction(phaseIdx, compIdx));

                std::cout << "'" << FluidSystem::phaseName(phaseIdx)
                          << "' phase appears at position " << pos
                          << " sum x = " << sumx  << std::flush;
            }
        }

        std::cout << ", new primary variables: ";
        newPv.print();
        std::cout << "\n"  << std::flush;
    }

    void registerOutputModules_()
    {
        ParentType::registerOutputModules_();

        // add the VTK output modules which are meaningful for the model
        this->addOutputModule(new Ewoms::VtkPhasePresenceModule<TypeTag>(this->simulator_));
        this->addOutputModule(new Ewoms::VtkCompositionModule<TypeTag>(this->simulator_));
        if (enableDiffusion)
            this->addOutputModule(new Ewoms::VtkDiffusionModule<TypeTag>(this->simulator_));
        if (enableEnergy)
            this->addOutputModule(new Ewoms::VtkEnergyModule<TypeTag>(this->simulator_));
    }

    mutable Scalar referencePressure_;

    // number of switches of the phase state in the last Newton
    // iteration
    int numSwitched_;

    // verbosity of the model
    int verbosity_;
};
}

#endif