richardsmodel.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:
/*
  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/>.

  Consult the COPYING file in the top-level source directory of this
  module for the precise wording of the license and the list of
  copyright holders.
*/
#ifndef EWOMS_RICHARDS_MODEL_HH
#define EWOMS_RICHARDS_MODEL_HH

#include <opm/material/components/NullComponent.hpp>
#include <opm/material/densead/Math.hpp>
#include <opm/material/fluidsystems/LiquidPhase.hpp>
#include <opm/material/fluidsystems/GasPhase.hpp>
#include <opm/material/fluidsystems/TwoPhaseImmiscibleFluidSystem.hpp>

#include <opm/models/common/multiphasebasemodel.hh>
#include <opm/models/richards/richardsproperties.hh>
#include <opm/models/richards/richardsindices.hh>
#include <opm/models/richards/richardslocalresidual.hh>
#include <opm/models/richards/richardsextensivequantities.hh>
#include <opm/models/richards/richardsratevector.hh>
#include <opm/models/richards/richardsboundaryratevector.hh>
#include <opm/models/richards/richardsprimaryvariables.hh>
#include <opm/models/richards/richardsintensivequantities.hh>
#include <opm/models/richards/richardsnewtonmethod.hh>

#include <cassert>
#include <sstream>
#include <string>
#include <tuple>

namespace Opm {

template <class TypeTag>
class RichardsModel;

}

namespace Opm::Properties {

// Create new type tags
namespace TTag {

struct Richards { using InheritsFrom = std::tuple<MultiPhaseBaseModel>; };

} // end namespace TTag

template<class TypeTag>
struct LiquidPhaseIndex<TypeTag, TTag::Richards>
{ static constexpr int value = 0; };

template<class TypeTag>
struct GasPhaseIndex<TypeTag, TTag::Richards>
{ static constexpr int value = 1 - getPropValue<TypeTag, Properties::LiquidPhaseIndex>(); };

template<class TypeTag>
struct LiquidComponentIndex<TypeTag, TTag::Richards>
{ static constexpr int value = getPropValue<TypeTag, Properties::LiquidPhaseIndex>(); };

template<class TypeTag>
struct GasComponentIndex<TypeTag, TTag::Richards>
{ static constexpr int value = 1 - getPropValue<TypeTag, Properties::LiquidComponentIndex>(); };

template<class TypeTag>
struct LocalResidual<TypeTag, TTag::Richards>
{ using type = RichardsLocalResidual<TypeTag>; };

template<class TypeTag>
struct Model<TypeTag, TTag::Richards>
{ using type = RichardsModel<TypeTag>; };

template<class TypeTag>
struct RateVector<TypeTag, TTag::Richards>
{ using type = RichardsRateVector<TypeTag>; };

template<class TypeTag>
struct BoundaryRateVector<TypeTag, TTag::Richards>
{ using type = RichardsBoundaryRateVector<TypeTag>; };

template<class TypeTag>
struct PrimaryVariables<TypeTag, TTag::Richards>
{ using type = RichardsPrimaryVariables<TypeTag>; };

template<class TypeTag>
struct IntensiveQuantities<TypeTag, TTag::Richards>
{ using type = RichardsIntensiveQuantities<TypeTag>; };

template<class TypeTag>
struct ExtensiveQuantities<TypeTag, TTag::Richards>
{ using type = RichardsExtensiveQuantities<TypeTag>; };

template<class TypeTag>
struct NewtonMethod<TypeTag, TTag::Richards>
{ using type = RichardsNewtonMethod<TypeTag>; };

template<class TypeTag>
struct Indices<TypeTag, TTag::Richards>
{ using type = RichardsIndices; };

template<class TypeTag>
struct WettingFluid<TypeTag, TTag::Richards>
{
private:
    using Scalar = GetPropType<TypeTag, Properties::Scalar>;

public:
    using type = LiquidPhase<Scalar, NullComponent<Scalar>>;
};

template<class TypeTag>
struct NonWettingFluid<TypeTag, TTag::Richards>
{
private:
    using Scalar = GetPropType<TypeTag, Properties::Scalar>;

public:
    using type = GasPhase<Scalar, NullComponent<Scalar>>;
};

template<class TypeTag>
struct FluidSystem<TypeTag, TTag::Richards>
{
private:
    using Scalar = GetPropType<TypeTag, Properties::Scalar>;
    using WettingFluid = GetPropType<TypeTag, Properties::WettingFluid>;
    using NonWettingFluid = GetPropType<TypeTag, Properties::NonWettingFluid>;

public:
    using type = TwoPhaseImmiscibleFluidSystem<Scalar, WettingFluid, NonWettingFluid>;
};


} // namespace Opm::Properties

namespace Opm {

template <class TypeTag>
class RichardsModel
    : public MultiPhaseBaseModel<TypeTag>
{
    using ParentType = MultiPhaseBaseModel<TypeTag>;

    using Simulator = GetPropType<TypeTag, Properties::Simulator>;

    using Scalar = GetPropType<TypeTag, Properties::Scalar>;
    using FluidSystem = GetPropType<TypeTag, Properties::FluidSystem>;
    using Indices = GetPropType<TypeTag, Properties::Indices>;

     static const unsigned numPhases = FluidSystem::numPhases;
     static const unsigned numComponents = FluidSystem::numComponents;

    static const unsigned liquidPhaseIdx = getPropValue<TypeTag, Properties::LiquidPhaseIndex>();
    static const unsigned gasPhaseIdx = getPropValue<TypeTag, Properties::GasPhaseIndex>();

    static const unsigned liquidCompIdx = getPropValue<TypeTag, Properties::LiquidComponentIndex>();
    static const unsigned gasCompIdx = getPropValue<TypeTag, Properties::GasComponentIndex>();

    // some consistency checks
    static_assert(numPhases == 2,
                  "Exactly two fluids are required for this model");
    static_assert(numComponents == 2,
                  "Exactly two components are required for this model");
    static_assert(liquidPhaseIdx != gasPhaseIdx,
                  "The liquid and the gas phases must be different");
    static_assert(liquidCompIdx != gasCompIdx,
                  "The liquid and the gas components must be different");

public:
    explicit RichardsModel(Simulator& simulator)
        : ParentType(simulator)
    {
        // the liquid phase must be liquid, the gas phase must be
        // gaseous. Think about it!
        assert(FluidSystem::isLiquid(liquidPhaseIdx));
        assert(!FluidSystem::isLiquid(gasPhaseIdx));
    }

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

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

    std::string primaryVarName(unsigned pvIdx) const
    {
        std::ostringstream oss;
        if (pvIdx == Indices::pressureWIdx) {
            oss << "pressure_" << FluidSystem::phaseName(liquidPhaseIdx);
        }
        else {
            assert(0);
        }

        return oss.str();
    }

    std::string eqName(unsigned eqIdx) const
    {
        std::ostringstream oss;
        if (eqIdx == Indices::contiEqIdx) {
            oss << "continuity_" << FluidSystem::phaseName(liquidPhaseIdx);
        }
        else {
            assert(0);
        }

        return oss.str();
    }

    Scalar primaryVarWeight(unsigned, unsigned pvIdx) const
    {
        if (Indices::pressureWIdx == pvIdx) {
            return 10 / referencePressure_;
        }

        return 1;
    }

    Scalar eqWeight(unsigned, [[maybe_unused]] unsigned eqIdx) const
    {
        assert((eqIdx - Indices::contiEqIdx) <= FluidSystem::numPhases);

        // make all kg equal
        return 1.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...
        for (unsigned dofIdx = 0; dofIdx < this->numGridDof(); ++ dofIdx) {
            if (this->isLocalDof(dofIdx)) {
                referencePressure_ =
                    this->solution(/*timeIdx=*/0)[dofIdx][/*pvIdx=*/Indices::pressureWIdx];
                break;
            }
        }
    }

    bool phaseIsConsidered(unsigned phaseIdx) const
    { return phaseIdx == liquidPhaseIdx; }

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

    Scalar referencePressure_{};
};

} // namespace Opm

#endif