LinearMaterial.hpp

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 OPM_LINEAR_MATERIAL_HPP
#define OPM_LINEAR_MATERIAL_HPP

#include "LinearMaterialParams.hpp"

#include <opm/material/common/MathToolbox.hpp>
#include <opm/material/common/Valgrind.hpp>
#include <opm/common/Exceptions.hpp>
#include <opm/common/ErrorMacros.hpp>

#include <algorithm>
#include <type_traits>

namespace Opm {

template <class TraitsT, class ParamsT = LinearMaterialParams<TraitsT> >
class LinearMaterial : public TraitsT
{
public:
    typedef TraitsT Traits;
    typedef ParamsT Params;
    typedef typename Traits::Scalar Scalar;

    static const int numPhases = Traits::numPhases;

    static const bool implementsTwoPhaseApi = (numPhases == 2);

    static const bool implementsTwoPhaseSatApi = (numPhases == 2);

    static const bool isSaturationDependent = true;

    static const bool isPressureDependent = false;

    static const bool isTemperatureDependent = false;

    static const bool isCompositionDependent = false;

    template <class ContainerT, class FluidState>
    static void capillaryPressures(ContainerT &values,
                                   const Params &params,
                                   const FluidState &state)
    {
        typedef typename std::remove_reference<decltype(values[0])>::type Evaluation;
        typedef MathToolbox<typename FluidState::Scalar> FsToolbox;

        for (unsigned phaseIdx = 0; phaseIdx < Traits::numPhases; ++phaseIdx) {
            const Evaluation& S =
                FsToolbox::template toLhs<Evaluation>(state.saturation(phaseIdx));
            Valgrind::CheckDefined(S);

            values[phaseIdx] =
                S*params.pcMaxSat(phaseIdx) +
                (1.0 - S)*params.pcMinSat(phaseIdx);
        }
    }

    template <class ContainerT, class FluidState>
    static void saturations(ContainerT &/*values*/,
                            const Params &/*params*/,
                            const FluidState &/*state*/)
    {
        OPM_THROW(std::runtime_error, "Not implemented: LinearMaterial::saturations()");
    }

    template <class ContainerT, class FluidState>
    static void relativePermeabilities(ContainerT &values,
                                       const Params &/*params*/,
                                       const FluidState &state)
    {
        typedef typename std::remove_reference<decltype(values[0])>::type Evaluation;
        typedef MathToolbox<Evaluation> Toolbox;
        typedef MathToolbox<typename FluidState::Scalar> FsToolbox;

        for (unsigned phaseIdx = 0; phaseIdx < Traits::numPhases; ++phaseIdx) {
            const Evaluation& S =
                FsToolbox::template toLhs<Evaluation>(state.saturation(phaseIdx));
            Valgrind::CheckDefined(S);

            values[phaseIdx] = Toolbox::max(Toolbox::min(S,1.0),0.0);
        }
    }

    template <class FluidState, class Evaluation = typename FluidState::Scalar>
    static Evaluation pcnw(const Params &params, const FluidState &fs)
    {
        typedef MathToolbox<typename FluidState::Scalar> FsToolbox;
        const Evaluation& Sw =
            FsToolbox::template toLhs<Evaluation>(fs.saturation(Traits::wettingPhaseIdx));
        Valgrind::CheckDefined(Sw);

        const Evaluation& wPhasePressure =
            Sw*params.pcMaxSat(Traits::wettingPhaseIdx) +
            (1.0 - Sw)*params.pcMinSat(Traits::wettingPhaseIdx);

        const Evaluation& Sn =
            FsToolbox::template toLhs<Evaluation>(fs.saturation(Traits::nonWettingPhaseIdx));
        Valgrind::CheckDefined(Sn);

        const Evaluation& nPhasePressure =
            Sn*params.pcMaxSat(Traits::nonWettingPhaseIdx) +
            (1.0 - Sn)*params.pcMinSat(Traits::nonWettingPhaseIdx);

        return nPhasePressure - wPhasePressure;
    }


    template <class Evaluation = Scalar>
    static typename std::enable_if<Traits::numPhases == 2, Evaluation>::type
    twoPhaseSatPcnw(const Params &params, const Evaluation& Sw)
    {
        const Evaluation& wPhasePressure =
            Sw*params.pcMaxSat(Traits::wettingPhaseIdx) +
            (1.0 - Sw)*params.pcMinSat(Traits::wettingPhaseIdx);

        const Evaluation& nPhasePressure =
            (1.0 - Sw)*params.pcMaxSat(Traits::nonWettingPhaseIdx) +
            Sw*params.pcMinSat(Traits::nonWettingPhaseIdx);

        return nPhasePressure - wPhasePressure;
    }

    template <class FluidState, class Evaluation = typename FluidState::Scalar>
    static Evaluation Sw(const Params &/*params*/, const FluidState &/*fs*/)
    { OPM_THROW(std::runtime_error, "Not implemented: Sw()"); }

    template <class Evaluation = Scalar>
    static typename std::enable_if<Traits::numPhases == 2, Evaluation>::type
    twoPhaseSatSw(const Params &/*params*/, const Evaluation& /*Sw*/)
    { OPM_THROW(std::runtime_error, "Not implemented: twoPhaseSatSw()"); }

    template <class FluidState, class Evaluation = typename FluidState::Scalar>
    static Evaluation Sn(const Params &/*params*/, const FluidState &/*fs*/)
    { OPM_THROW(std::runtime_error, "Not implemented: Sn()"); }

    template <class Evaluation = Scalar>
    static typename std::enable_if<Traits::numPhases == 2, Evaluation>::type
    twoPhaseSatSn(const Params &/*params*/, const Evaluation& /*Sw*/)
    { OPM_THROW(std::runtime_error, "Not implemented: twoPhaseSatSn()"); }

    template <class FluidState, class Evaluation = typename FluidState::Scalar>
    static typename std::enable_if<Traits::numPhases == 3, Evaluation>::type
    Sg(const Params &/*params*/, const FluidState &/*fs*/)
    { OPM_THROW(std::runtime_error, "Not implemented: Sg()"); }

    template <class FluidState, class Evaluation = typename FluidState::Scalar>
    static Evaluation krw(const Params &/*params*/, const FluidState &fs)
    {
        typedef MathToolbox<Evaluation> Toolbox;
        typedef MathToolbox<typename FluidState::Scalar> FsToolbox;

        const Evaluation& Sw =
            FsToolbox::template toLhs<Evaluation>(fs.saturation(Traits::wettingPhaseIdx));
        return Toolbox::max(0.0, Toolbox::min(1.0, Sw));
    }

    template <class Evaluation = Scalar>
    static typename std::enable_if<Traits::numPhases == 2, Evaluation>::type
    twoPhaseSatKrw(const Params &/*params*/, const Evaluation& Sw)
    {
        typedef MathToolbox<Evaluation> Toolbox;

        return Toolbox::max(0.0, Toolbox::min(1.0, Sw));
    }

    template <class FluidState, class Evaluation = typename FluidState::Scalar>
    static Evaluation krn(const Params &/*params*/, const FluidState &fs)
    {
        typedef MathToolbox<Evaluation> Toolbox;
        typedef MathToolbox<typename FluidState::Scalar> FsToolbox;

        const Evaluation& Sn =
            FsToolbox::template toLhs<Evaluation>(fs.saturation(Traits::nonWettingPhaseIdx));
        return Toolbox::max(0.0, Toolbox::min(1.0, Sn));
    }

    template <class Evaluation = Scalar>
    static typename std::enable_if<Traits::numPhases == 2, Evaluation>::type
    twoPhaseSatKrn(const Params &/*params*/, const Evaluation& Sw)
    {
        typedef MathToolbox<Evaluation> Toolbox;

        return Toolbox::max(0.0, Toolbox::min(1.0, Sw));
    }

    template <class FluidState, class Evaluation = typename FluidState::Scalar>
    static typename std::enable_if<Traits::numPhases == 3, Evaluation>::type
    krg(const Params &/*params*/, const FluidState &fs)
    {
        typedef MathToolbox<Evaluation> Toolbox;
        typedef MathToolbox<typename FluidState::Scalar> FsToolbox;

        const Evaluation& Sg =
            FsToolbox::template toLhs<Evaluation>(fs.saturation(Traits::gasPhaseIdx));
        return Toolbox::max(0.0, Toolbox::min(1.0, Sg));
    }

    template <class FluidState, class Evaluation = Scalar>
    static typename std::enable_if<Traits::numPhases == 3, Evaluation>::type
    pcgn(const Params &params, const FluidState &fs)
    {
        typedef MathToolbox<typename FluidState::Scalar> FsToolbox;

        const Evaluation& Sn =
            FsToolbox::template toLhs<Evaluation>(fs.saturation(Traits::nonWettingPhaseIdx));
        Valgrind::CheckDefined(Sn);

        const Evaluation& nPhasePressure =
            Sn*params.pcMaxSat(Traits::nonWettingPhaseIdx) +
            (1.0 - Sn)*params.pcMinSat(Traits::nonWettingPhaseIdx);

        const Evaluation& Sg =
            FsToolbox::template toLhs<Evaluation>(fs.saturation(Traits::gasPhaseIdx));
        Valgrind::CheckDefined(Sg);

        const Evaluation& gPhasePressure =
            Sg*params.pcMaxSat(Traits::gasPhaseIdx) +
            (1.0 - Sg)*params.pcMinSat(Traits::gasPhaseIdx);

        return gPhasePressure - nPhasePressure;
    }
};
} // namespace Opm

#endif