ECLSaturationFunc.hpp

Go to the documentation of this file.

/*
  Copyright 2017 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_ECLSATURATIONFUNC_HEADER_INCLUDED
#define OPM_ECLSATURATIONFUNC_HEADER_INCLUDED
 
#include <opm/flowdiagnostics/DerivedQuantities.hpp>
#include <opm/utility/ECLEndPointScaling.hpp>
#include <opm/utility/ECLPhaseIndex.hpp>
#include <opm/utility/ECLUnitHandling.hpp>
 
#include <memory>
#include <vector>
 
 
namespace Opm {
    class ECLGraph;
    class ECLRestartData;
    class ECLInitFileData;
 
    std::vector<double>
    phaseSaturation(const ECLGraph&       G,
                    const ECLRestartData& rstrt,
                    const ECLPhaseIndex   phase);
 
    class ECLSaturationFunc
    {
    public:
        struct RawCurve
        {
            enum class Function {
                RelPerm,
 
                CapPress,
            };
 
            enum class SubSystem {
                OilGas,
 
                OilWater,
            };
 
            Function curve;
 
            SubSystem subsys;
 
            ECLPhaseIndex thisPh;
        };
 
        struct SatFuncScaling {
            enum Type : unsigned char {
                Horizontal = 1 << 0u,
                Vertical   = 1 << 1u,
            };
 
            SatFuncScaling()
                : enable(Type::Horizontal | Type::Vertical)
            {}
 
            // Default: Use both Horizontal and Vertical if specified.
            unsigned char enable;
        };
 
        ECLSaturationFunc(const ECLGraph&        G,
                          const ECLInitFileData& init);
 
        ~ECLSaturationFunc();
 
        ECLSaturationFunc(ECLSaturationFunc&& rhs);
 
        ECLSaturationFunc(const ECLSaturationFunc& rhs);
 
        ECLSaturationFunc& operator=(ECLSaturationFunc&& rhs);
 
        ECLSaturationFunc& operator=(const ECLSaturationFunc& rhs);
 
        void setOutputUnits(std::unique_ptr<const ECLUnits::UnitSystem> usys);
 
        std::vector<double>
        relperm(const ECLGraph&       G,
                const ECLRestartData& rstrt,
                const ECLPhaseIndex   p) const;
 
        std::vector<FlowDiagnostics::Graph>
        getSatFuncCurve(const std::vector<RawCurve>& func,
                        const int                    activeCell,
                        const bool                   useEPS = true) const;
 
        std::vector<FlowDiagnostics::Graph>
        getSatFuncCurve(const std::vector<RawCurve>& func,
                        const int                    activeCell,
                        const SatFuncScaling&        scaling) const;
 
    private:
        class Impl;
 
        std::unique_ptr<Impl> pImpl_;
    };
 
} // namespace Opm
 
#endif // OPM_ECLSATURATIONFUNC_HEADER_INCLUDED