ResInsight/ThirdParty/custom-opm-flowdiag-app/opm-flowdiagnostics-applications/opm/utility/ECLUnitHandling.cpp

/*
  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/>.
*/

#if HAVE_CONFIG_H
#include <config.h>
#endif

#include <opm/utility/ECLUnitHandling.hpp>

#include <opm/utility/imported/Units.hpp>

#include <exception>
#include <stdexcept>
#include <string>

#include <ert/ecl/ecl_util.h>

namespace Opm { namespace ECLUnits {
    namespace Impl {
        ert_ecl_unit_enum getUnitConvention(const int usys);

        template <ert_ecl_unit_enum convention>
        class USys;

        using namespace ImportedOpm;

        template <>
        class USys<ECL_METRIC_UNITS> : public ::Opm::ECLUnits::UnitSystem
        {
        public:
            virtual std::unique_ptr<Opm::ECLUnits::UnitSystem>
            clone() const override
            {
                return std::unique_ptr<Opm::ECLUnits::UnitSystem> {
                    new USys<ECL_METRIC_UNITS>(*this)
                };
            }

            virtual double density() const override
            {
                return Metric::Density;
            }

            virtual double depth() const override
            {
                return Metric::Length;
            }

            virtual double pressure() const override
            {
                return Metric::Pressure;
            }

            virtual double reservoirRate() const override
            {
                return Metric::ReservoirVolume / Metric::Time;
            }

            virtual double reservoirVolume() const override
            {
                return Metric::ReservoirVolume;
            }

            virtual double surfaceVolumeGas() const override
            {
                return Metric::GasSurfaceVolume;
            }

            virtual double surfaceVolumeLiquid() const override
            {
                return Metric::LiquidSurfaceVolume;
            }

            virtual double time() const override
            {
                return Metric::Time;
            }

            virtual double transmissibility() const override
            {
                return Metric::Transmissibility;
            }

            virtual double viscosity() const override
            {
                return Metric::Viscosity;
            }
        };

        template <>
        class USys<ECL_FIELD_UNITS> : public ::Opm::ECLUnits::UnitSystem
        {
        public:
            virtual std::unique_ptr<Opm::ECLUnits::UnitSystem>
            clone() const override
            {
                return std::unique_ptr<Opm::ECLUnits::UnitSystem> {
                    new USys<ECL_FIELD_UNITS>(*this)
                };
            }

            virtual double density() const override
            {
                return Field::Density;
            }

            virtual double depth() const override
            {
                return Field::Length;
            }

            virtual double pressure() const override
            {
                return Field::Pressure;
            }

            virtual double reservoirRate() const override
            {
                return Field::ReservoirVolume / Field::Time;
            }

            virtual double reservoirVolume() const override
            {
                return Field::ReservoirVolume;
            }

            virtual double surfaceVolumeGas() const override
            {
                return Field::GasSurfaceVolume;
            }

            virtual double surfaceVolumeLiquid() const override
            {
                return Field::LiquidSurfaceVolume;
            }

            virtual double time() const override
            {
                return Field::Time;
            }

            virtual double transmissibility() const override
            {
                return Field::Transmissibility;
            }

            virtual double viscosity() const override
            {
                return Field::Viscosity;
            }
        };

        template <>
        class USys<ECL_LAB_UNITS> : public ::Opm::ECLUnits::UnitSystem
        {
        public:
            virtual std::unique_ptr<Opm::ECLUnits::UnitSystem>
            clone() const override
            {
                return std::unique_ptr<Opm::ECLUnits::UnitSystem> {
                    new USys<ECL_LAB_UNITS>(*this)
                };
            }

            virtual double density() const override
            {
                return Lab::Density;
            }

            virtual double depth() const override
            {
                return Lab::Length;
            }

            virtual double pressure() const override
            {
                return Lab::Pressure;
            }

            virtual double reservoirRate() const override
            {
                return Lab::ReservoirVolume / Lab::Time;
            }

            virtual double reservoirVolume() const override
            {
                return Lab::ReservoirVolume;
            }

            virtual double surfaceVolumeGas() const override
            {
                return Lab::GasSurfaceVolume;
            }

            virtual double surfaceVolumeLiquid() const override
            {
                return Lab::LiquidSurfaceVolume;
            }

            virtual double time() const override
            {
                return Lab::Time;
            }

            virtual double transmissibility() const override
            {
                return Lab::Transmissibility;
            }

            virtual double viscosity() const override
            {
                return Lab::Viscosity;
            }
        };

        template <>
        class USys<ECL_PVT_M_UNITS> : public ::Opm::ECLUnits::UnitSystem
        {
        public:
            virtual std::unique_ptr<Opm::ECLUnits::UnitSystem>
            clone() const override
            {
                return std::unique_ptr<Opm::ECLUnits::UnitSystem> {
                    new USys<ECL_PVT_M_UNITS>(*this)
                };
            }

            virtual double density() const override
            {
                using namespace prefix;
                using namespace unit;

                return kilogram / cubic(meter);
            }

            virtual double depth() const override
            {
                return unit::meter;
            }

            virtual double pressure() const override
            {
                return unit::atm;
            }

            virtual double reservoirRate() const override
            {
                using namespace prefix;
                using namespace unit;

                return cubic(meter) / day;
            }

            virtual double reservoirVolume() const override
            {
                using namespace prefix;
                using namespace unit;

                return cubic(meter);
            }

            virtual double surfaceVolumeGas() const override
            {
                return unit::cubic(unit::meter);
            }

            virtual double surfaceVolumeLiquid() const override
            {
                return unit::cubic(unit::meter);
            }

            virtual double time() const override
            {
                return unit::day;
            }

            virtual double transmissibility() const override
            {
                using namespace prefix;
                using namespace unit;

                return centi*Poise * cubic(meter) / (day * atm);
            }

            virtual double viscosity() const override
            {
                return prefix::centi*unit::Poise;
            }
        };
    } // namespace Impl
}} // namespace Opm::ECLUnits

ert_ecl_unit_enum
Opm::ECLUnits::Impl::getUnitConvention(const int usys)
{
    switch (usys) {
    case 1: return ECL_METRIC_UNITS;
    case 2: return ECL_FIELD_UNITS;
    case 3: return ECL_LAB_UNITS;
    case 4: return ECL_PVT_M_UNITS;
    }

    throw std::runtime_error("Unsupported Unit Convention: "
                             + std::to_string(usys));
}

double Opm::ECLUnits::UnitSystem::dissolvedGasOilRat() const
{
    return this->surfaceVolumeGas()
        /  this->surfaceVolumeLiquid();
}

double Opm::ECLUnits::UnitSystem::vaporisedOilGasRat() const
{
    return this->surfaceVolumeLiquid()
        /  this->surfaceVolumeGas();
}

std::unique_ptr<const ::Opm::ECLUnits::UnitSystem>
Opm::ECLUnits::createUnitSystem(const int usys)
{
    using UPtr =
        std::unique_ptr<const ::Opm::ECLUnits::UnitSystem>;

    switch (Impl::getUnitConvention(usys)) {
    case ECL_METRIC_UNITS:
        return UPtr{ new Impl::USys<ECL_METRIC_UNITS>{} };

    case ECL_FIELD_UNITS:
        return UPtr{ new Impl::USys<ECL_FIELD_UNITS>{} };

    case ECL_LAB_UNITS:
        return UPtr{ new Impl::USys<ECL_LAB_UNITS>{} };

    case ECL_PVT_M_UNITS:
        return UPtr{ new Impl::USys<ECL_PVT_M_UNITS>{} };
    }

    throw std::runtime_error("Unsupported Unit Convention: "
                             + std::to_string(usys));
}