WaterPhaseConsistencyChecks.hpp

/*
  Copyright 2024 Equinor AS

  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 3 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 WATER_PHASE_CONSISTENCY_CHECKS_HPP_INCLUDED
#define WATER_PHASE_CONSISTENCY_CHECKS_HPP_INCLUDED

#include <opm/simulators/utils/satfunc/PhaseCheckBase.hpp>
#include <opm/simulators/utils/satfunc/SatfuncConsistencyChecks.hpp>

#include <cstddef>
#include <string>

namespace Opm::Satfunc::PhaseChecks::Water {

    template <typename Scalar>
    class SWmin : public PhaseCheckBase<Scalar>
    {
    public:
        std::size_t numExportedCheckValues() const override { return 1; };

        void exportCheckValues(Scalar* exportedCheckValues) const override
        {
            exportedCheckValues[0] = this->swl_;
        }

        std::string description() const override
        {
            return { "Non-negative minimum water saturation" };
        }

        std::string condition() const override
        {
            return { "0 <= SWL < 1" };
        }

        void columnNames(std::string* headers) const override
        {
            headers[0] = "SWL";
        }

    private:
        Scalar swl_{};

        void testImpl(const EclEpsScalingPointsInfo<Scalar>& endPoints) override;
    };

    template <typename Scalar>
    class SWmax : public PhaseCheckBase<Scalar>
    {
    public:
        std::size_t numExportedCheckValues() const override { return 1; };

        void exportCheckValues(Scalar* exportedCheckValues) const override
        {
            exportedCheckValues[0] = this->swu_;
        }

        std::string description() const override
        {
            return { "Positive maximum water saturation" };
        }

        std::string condition() const override
        {
            return { "0 < SWU <= 1" };
        }

        void columnNames(std::string* headers) const override
        {
            headers[0] = "SWU";
        }

    private:
        Scalar swu_{};

        void testImpl(const EclEpsScalingPointsInfo<Scalar>& endPoints) override;
    };

    template <typename Scalar>
    class SWcr : public PhaseCheckBase<Scalar>
    {
    public:
        std::size_t numExportedCheckValues() const override { return 3; };

        void exportCheckValues(Scalar* exportedCheckValues) const override
        {
            exportedCheckValues[0] = this->swl_;
            exportedCheckValues[1] = this->swcr_;
            exportedCheckValues[2] = this->swu_;
        }

        std::string description() const override
        {
            return { "Mobile water saturation" };
        }

        std::string condition() const override
        {
            return { "SWL <= SWCR < SWU" };
        }

        void columnNames(std::string* headers) const override
        {
            headers[0] = "SWL";
            headers[1] = "SWCR";
            headers[2] = "SWU";
        }

    private:
        Scalar swl_{};

        Scalar swcr_{};

        Scalar swu_{};

        void testImpl(const EclEpsScalingPointsInfo<Scalar>& endPoints) override;
    };

} // namespace Opm::Satfunc::PhaseChecks::Water

#endif // WATER_PHASE_CONSISTENCY_CHECKS_HPP_INCLUDED