EquilibrationHelpers.hpp

Go to the documentation of this file.

// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// vi: set et ts=4 sw=4 sts=4:
/*
  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/>.

  Consult the COPYING file in the top-level source directory of this
  module for the precise wording of the license and the list of
  copyright holders.
*/
#ifndef OPM_EQUILIBRATION_HELPERS_HPP
#define OPM_EQUILIBRATION_HELPERS_HPP

#include <opm/material/common/Tabulated1DFunction.hpp>

#include <opm/input/eclipse/EclipseState/InitConfig/Equil.hpp>

#include <memory>
#include <vector>

/*
  ---- synopsis of EquilibrationHelpers.hpp ----

  namespace Opm
  {
  namespace EQUIL {

  namespace Miscibility {
  class RsFunction;
  class NoMixing;
  template <class FluidSystem>
  class RsVD;
  template <class FluidSystem>
  class RsSatAtContact;
  }

  class EquilReg;


  template <class FluidSystem, class MaterialLawManager>
  struct PcEq;

  template <class FluidSystem, class MaterialLawManager>
  double satFromPc(const MaterialLawManager& materialLawManager,
  const int phase,
  const int cell,
  const double targetPc,
  const bool increasing = false)
  template <class FluidSystem, class MaterialLawManager>
  double satFromSumOfPcs(const MaterialLawManager& materialLawManager,
  const int phase1,
  const int phase2,
  const int cell,
  const double targetPc)
  } // namespace Equil
  } // namespace Opm

  ---- end of synopsis of EquilibrationHelpers.hpp ----
*/

namespace Opm {

namespace EQUIL {

namespace Miscibility {

template<class Scalar>
class RsFunction
{
public:
    virtual ~RsFunction() = default;

    virtual Scalar operator()(const Scalar depth,
                              const Scalar press,
                              const Scalar temp,
                              const Scalar sat = 0.0) const = 0;
};


template<class Scalar>
class NoMixing : public RsFunction<Scalar>
{
public:
    Scalar
    operator()(const Scalar /* depth */,
               const Scalar /* press */,
               const Scalar /* temp */,
               const Scalar /* sat */ = 0.0) const override
    {
        return 0.0;
    }
};


template <class FluidSystem>
class RsVD : public RsFunction<typename FluidSystem::Scalar>
{
public:
    using Scalar = typename FluidSystem::Scalar;
    RsVD(const int pvtRegionIdx,
         const std::vector<Scalar>& depth,
         const std::vector<Scalar>& rs);

    Scalar operator()(const Scalar depth,
                      const Scalar press,
                      const Scalar temp,
                      const Scalar satGas = 0.0) const override;

private:
    using RsVsDepthFunc = Tabulated1DFunction<Scalar>;

    const int pvtRegionIdx_;
    RsVsDepthFunc rsVsDepth_;

    Scalar satRs(const Scalar press, const Scalar temp) const;
};


template <class FluidSystem>
class PBVD : public RsFunction<typename FluidSystem::Scalar>
{
public:
    using Scalar = typename FluidSystem::Scalar;
    PBVD(const int pvtRegionIdx,
         const std::vector<Scalar>& depth,
         const std::vector<Scalar>& pbub);

    Scalar operator()(const Scalar depth,
                      const Scalar cellPress,
                      const Scalar temp,
                      const Scalar satGas = 0.0) const override;

private:
    using PbubVsDepthFunc = Tabulated1DFunction<Scalar>;

    const int pvtRegionIdx_;
    PbubVsDepthFunc pbubVsDepth_;

    Scalar satRs(const Scalar press, const Scalar temp) const;
};


template <class FluidSystem>
class PDVD : public RsFunction<typename FluidSystem::Scalar>
{
    using Scalar = typename FluidSystem::Scalar;
public:
    PDVD(const int pvtRegionIdx,
         const std::vector<Scalar>& depth,
         const std::vector<Scalar>& pdew);

    Scalar operator()(const Scalar depth,
                      const Scalar cellPress,
                      const Scalar temp,
                      const Scalar satOil = 0.0) const override;

private:
    using PdewVsDepthFunc = Tabulated1DFunction<Scalar>;

    const int pvtRegionIdx_;
    PdewVsDepthFunc pdewVsDepth_;

    Scalar satRv(const Scalar press, const Scalar temp) const;
};


template <class FluidSystem>
class RvVD : public RsFunction<typename FluidSystem::Scalar>
{
    using Scalar = typename FluidSystem::Scalar;
public:
    RvVD(const int pvtRegionIdx,
         const std::vector<Scalar>& depth,
         const std::vector<Scalar>& rv);

    Scalar operator()(const Scalar depth,
                      const Scalar press,
                      const Scalar temp,
                      const Scalar satOil = 0.0) const override;

private:
    using RvVsDepthFunc = Tabulated1DFunction<Scalar>;

    const int pvtRegionIdx_;
    RvVsDepthFunc rvVsDepth_;

    Scalar satRv(const Scalar press, const Scalar temp) const;
};


template <class FluidSystem>
class RvwVD : public RsFunction<typename FluidSystem::Scalar>
{
    using Scalar = typename FluidSystem::Scalar;
public:
    RvwVD(const int pvtRegionIdx,
         const std::vector<Scalar>& depth,
         const std::vector<Scalar>& rvw);

    Scalar operator()(const Scalar depth,
                      const Scalar press,
                      const Scalar temp,
                      const Scalar satWat = 0.0) const override;

private:
    using RvwVsDepthFunc = Tabulated1DFunction<Scalar>;

    const int pvtRegionIdx_;
    RvwVsDepthFunc rvwVsDepth_;

    Scalar satRvw(const Scalar press, const Scalar temp) const;
};


template <class FluidSystem>
class RsSatAtContact : public RsFunction<typename FluidSystem::Scalar>
{
    using Scalar = typename FluidSystem::Scalar;
public:
    RsSatAtContact(const int pvtRegionIdx,
                   const Scalar pContact,
                   const Scalar T_contact);

    Scalar operator()(const Scalar depth,
                      const Scalar press,
                      const Scalar temp,
                      const Scalar satGas = 0.0) const override;

private:
    const int pvtRegionIdx_;
    Scalar rsSatContact_;

    Scalar satRs(const Scalar press, const Scalar temp) const;
};


template <class FluidSystem>
class RvSatAtContact : public RsFunction<typename FluidSystem::Scalar>
{
    using Scalar = typename FluidSystem::Scalar;
public:
    RvSatAtContact(const int pvtRegionIdx,
                   const Scalar pContact,
                   const Scalar T_contact);

    Scalar operator()(const Scalar depth,
                      const Scalar press,
                      const Scalar temp,
                      const Scalar satOil = 0.0) const override;

private:
    const int pvtRegionIdx_;
    Scalar rvSatContact_;

    Scalar satRv(const Scalar press, const Scalar temp) const;
};

template <class FluidSystem>
class RvwSatAtContact : public RsFunction<typename FluidSystem::Scalar>
{
    using Scalar = typename FluidSystem::Scalar;
public:
    RvwSatAtContact(const int pvtRegionIdx,
                    const Scalar pContact,
                    const Scalar T_contact);

    Scalar operator()(const Scalar depth,
                      const Scalar press,
                      const Scalar temp,
                      const Scalar satWat = 0.0) const override;

private:
    const int pvtRegionIdx_;
    Scalar rvwSatContact_;

    Scalar satRvw(const Scalar press, const Scalar temp) const;
};

template <class FluidSystem>
class RsConst : public RsFunction<typename FluidSystem::Scalar>
{
public:
    using Scalar = typename FluidSystem::Scalar;

    RsConst(const Scalar rs_constant,
            const Scalar pb_constant);

    Scalar operator()(const Scalar depth,
                      const Scalar press,
                      const Scalar temp,
                      const Scalar satGas = 0.0) const override;

    Scalar bubblePoint() const { return pb_constant_; }

    Scalar constantRs() const { return rs_constant_; }

    bool isConstantRs() const { return true; }

    Scalar satRs(const Scalar press, const Scalar temp) const;

private:
    Scalar rs_constant_{};
    Scalar pb_constant_{};
};

} // namespace Miscibility

template<class Scalar>
class EquilReg
{
    using TabulatedFunction = Tabulated1DFunction<Scalar>;

public:
    EquilReg(const EquilRecord& rec,
             std::shared_ptr<Miscibility::RsFunction<Scalar>> rs,
             std::shared_ptr<Miscibility::RsFunction<Scalar>> rv,
             std::shared_ptr<Miscibility::RsFunction<Scalar>> rvw,
             const TabulatedFunction& tempVdTable,
             const TabulatedFunction& saltVdTable,
             const int pvtIdx);

    using CalcDissolution = Miscibility::RsFunction<Scalar>;

    using CalcEvaporation = Miscibility::RsFunction<Scalar>;

    using CalcWaterEvaporation = Miscibility::RsFunction<Scalar>;


    Scalar datum() const;

    Scalar pressure() const;

    Scalar zwoc() const;

    Scalar pcowWoc() const;

    Scalar zgoc() const;

    Scalar pcgoGoc() const;

    int equilibrationAccuracy() const;

    const CalcDissolution& dissolutionCalculator() const;

    const CalcEvaporation& evaporationCalculator() const;

    const CalcWaterEvaporation& waterEvaporationCalculator() const;

    const TabulatedFunction& saltVdTable() const;
    const TabulatedFunction& tempVdTable() const;

    int pvtIdx() const;

private:
    EquilRecord rec_;     
    std::shared_ptr<Miscibility::RsFunction<Scalar>> rs_;      
    std::shared_ptr<Miscibility::RsFunction<Scalar>> rv_;      
    std::shared_ptr<Miscibility::RsFunction<Scalar>> rvw_;      
    const TabulatedFunction& tempVdTable_;
    const TabulatedFunction& saltVdTable_;
    const int pvtIdx_;
};



template <class FluidSystem, class MaterialLawManager>
struct PcEq
{
    using Scalar = typename FluidSystem::Scalar;
    PcEq(const MaterialLawManager& materialLawManager,
         const int phase,
         const int cell,
         const Scalar targetPc);

    Scalar operator()(Scalar s) const;

private:
    const MaterialLawManager& materialLawManager_;
    const int phase_;
    const int cell_;
    const Scalar targetPc_;
};

template <class FluidSystem, class MaterialLawManager>
typename FluidSystem::Scalar
minSaturations(const MaterialLawManager& materialLawManager,
                      const int phase, const int cell);

template <class FluidSystem, class MaterialLawManager>
typename FluidSystem::Scalar
maxSaturations(const MaterialLawManager& materialLawManager,
               const int phase, const int cell);

template <class FluidSystem, class MaterialLawManager>
typename FluidSystem::Scalar
satFromPc(const MaterialLawManager& materialLawManager,
          const int phase,
          const int cell,
          const typename FluidSystem::Scalar targetPc,
          const bool increasing = false);

template <class FluidSystem, class MaterialLawManager>
struct PcEqSum
{
    using Scalar = typename FluidSystem::Scalar;
    PcEqSum(const MaterialLawManager& materialLawManager,
            const int phase1,
            const int phase2,
            const int cell,
            const Scalar targetPc);

    Scalar operator()(Scalar s) const;

private:
    const MaterialLawManager& materialLawManager_;
    const int phase1_;
    const int phase2_;
    const int cell_;
    const Scalar targetPc_;
};

template <class FluidSystem, class MaterialLawManager>
typename FluidSystem::Scalar
satFromSumOfPcs(const MaterialLawManager& materialLawManager,
                const int phase1,
                const int phase2,
                const int cell,
                const typename FluidSystem::Scalar targetPc);

template <class FluidSystem, class MaterialLawManager>
typename FluidSystem::Scalar
satFromDepth(const MaterialLawManager& materialLawManager,
             const typename FluidSystem::Scalar cellDepth,
             const typename FluidSystem::Scalar contactDepth,
             const int phase,
             const int cell,
             const bool increasing = false);

template <class FluidSystem, class MaterialLawManager>
bool isConstPc(const MaterialLawManager& materialLawManager,
               const int phase,
               const int cell);

} // namespace Equil
} // namespace Opm

#endif // OPM_EQUILIBRATION_HELPERS_HPP