RelpermDiagnostics.hpp

/*
  Copyright 2015 Statoil ASA.

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

#include <array>
#include <vector>

#include <opm/material/fluidmatrixinteractions/EclEpsScalingPoints.hpp>

namespace Opm {

    class EclipseState;
    template <typename Grid> class LevelCartesianIndexMapper;
    class MiscTable;
    class MsfnTable;
    class SgcwmisTable;
    class SgfnTable;
    class SgofTable;
    class SgwfnTable;
    class SlgofTable;
    class Sof2Table;
    class Sof3Table;
    class SorwmisTable;
    class SsfnTable;
    class SwfnTable;
    class SwofTable;
    class GsfTable;
    class WsfTable;

    class RelpermDiagnostics
    {
    public:
        template <class LevelCartesianIndexMapper>
        void diagnosis(const EclipseState& eclState,
                       const LevelCartesianIndexMapper& levelCartesianIndexMapper);

    private:
        enum FluidSystem {
            OilWater,
            OilGas,
            WaterGas,
            BlackOil,
            Solvent
        };

        FluidSystem fluidSystem_;

        enum SaturationFunctionFamily {
            FamilyI,
            FamilyII,
            FamilyIII,
            NoFamily
        };

        SaturationFunctionFamily satFamily_{NoFamily};

        std::vector<EclEpsScalingPointsInfo<double> > unscaledEpsInfo_{};
        std::vector<EclEpsScalingPointsInfo<double> > scaledEpsInfo_{};


        bool phaseCheck_(const EclipseState& es);

        void satFamilyCheck_(const EclipseState& eclState);

        void tableCheck_(const EclipseState& eclState);

        void unscaledEndPointsCheck_(const EclipseState& eclState);

        template <class LevelCartesianIndexMapper>
        void scaledEndPointsCheck_(const EclipseState& eclState,
                                   const LevelCartesianIndexMapper& levelCartesianIndexMapper);

        template<class TableType>
        void checkTable_(const TableType& tables,
                         const std::size_t satnumIdx);

        void analyzeFamily(const EclipseState& eclState,
                           const std::array<bool,3>& family);

        void blackoilChecks(const EclipseState& eclState,
                            const std::size_t satnumIdx);
    };

} //namespace Opm

#endif // OPM_RELPERMDIAGNOSTICS_HEADER_INCLUDED