NullMaterial.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) 2008-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_NULL_MATERIAL_HPP
#define OPM_NULL_MATERIAL_HPP

#include "NullMaterialParams.hpp"

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

#include <algorithm>

namespace Opm
{
template <class TraitsT>
class NullMaterial : public TraitsT
{
public:
    typedef TraitsT Traits;
    typedef NullMaterialParams<TraitsT> 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 &/*fluidState*/)
    {
        for (int phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx)
            values[phaseIdx] = 0.0;
    }

    template <class ContainerT, class FluidState>
    static void saturations(ContainerT &/*values*/,
                            const Params &/*params*/,
                            const FluidState &/*fluidState*/)
    { OPM_THROW(std::logic_error, "Not defined: NullMaterial::saturations()"); }

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

        for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
            const Evaluation& S =
                FsToolbox::template toLhs<Evaluation>(fluidState.saturation(phaseIdx));
            values[phaseIdx] = Toolbox::max(Toolbox::min(S, 1.0), 0.0);
        }
    }

    template <class FluidState, class Evaluation  = typename FluidState::Scalar>
    static typename std::enable_if<(numPhases > 1), Evaluation>::type
    pcnw(const Params &/*params*/, const FluidState &/*fluidState*/)
    { return 0; }

    template <class Evaluation>
    static typename std::enable_if<numPhases == 2, Evaluation>::type
    twoPhaseSatPcnw(const Params &/*params*/, const Evaluation& /*Sw*/)
    { return 0; }

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

    template <class Evaluation>
    static typename std::enable_if<numPhases == 2, Evaluation>::type
    twoPhaseSatSw(const Params &/*params*/, const Evaluation& /*pcnw*/)
    { OPM_THROW(std::logic_error, "Not defined: twoPhaseSatSw()"); }

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

    template <class Evaluation>
    static typename std::enable_if<numPhases == 2, Evaluation>::type
    twoPhaseSatSn(const Params &/*params*/, const Evaluation& /*pcnw*/)
    { OPM_THROW(std::logic_error, "Not defined: twoPhaseSatSn()"); }

    template <class FluidState, class Evaluation = typename FluidState::Scalar>
    static typename std::enable_if< (numPhases > 2), Evaluation>::type
    Sg(const Params &/*params*/, const FluidState &/*fluidState*/)
    { OPM_THROW(std::logic_error, "Not defined: Sg()"); }

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

        const Evaluation& Sw =
            FsToolbox::template toLhs<Evaluation>(fluidState.saturation(Traits::wettingPhaseIdx));

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

    template <class Evaluation>
    static typename std::enable_if<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 typename std::enable_if<(numPhases > 1), Evaluation>::type
    krn(const Params &/*params*/, const FluidState &fluidState)
    {
        typedef MathToolbox<typename FluidState::Scalar> FsToolbox;
        typedef MathToolbox<Evaluation> Toolbox;

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

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

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

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

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

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

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

    template <class FluidState, class Evaluation = typename FluidState::Scalar>
    static typename std::enable_if< (Traits::numPhases > 2), Evaluation>::type
    pcgn(const Params &/*params*/, const FluidState &/*fluidState*/)
    { return 0; }
};
} // namespace Opm

#endif