PhaseCheckBase.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 PHASE_CHECK_BASE_HPP_INCLUDED
#define PHASE_CHECK_BASE_HPP_INCLUDED

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

namespace Opm::Satfunc::PhaseChecks {

    template <typename Scalar>
    class PhaseCheckBase : public SatfuncConsistencyChecks<Scalar>::Check
    {
    public:
        void test(const EclEpsScalingPointsInfo<Scalar>& endPoints) override;

        bool isViolated() const override;

        bool isCritical() const override;

    protected:
        void setViolated();

        void setCritical();

    private:
        unsigned char flags_{0};

        virtual void testImpl(const EclEpsScalingPointsInfo<Scalar>& endPoints) = 0;
    };

} // namespace Opm::Satfunc::PhaseChecks

#endif // PHASE_CHECK_BASE_HPP_INCLUDED