SolventPvt.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 2 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_SOLVENT_PVT_HPP
#define OPM_SOLVENT_PVT_HPP
 
#include <opm/material/common/Tabulated1DFunction.hpp>
 
#if HAVE_ECL_INPUT
#include <opm/input/eclipse/EclipseState/EclipseState.hpp>
#include <opm/input/eclipse/Schedule/Schedule.hpp>
#include <opm/input/eclipse/EclipseState/Tables/TableManager.hpp>
#include <opm/input/eclipse/EclipseState/Tables/PvdsTable.hpp>
#endif
 
#include <vector>
 
namespace Opm {
template <class Scalar>
class SolventPvt
{
    using SamplingPoints = std::vector<std::pair<Scalar, Scalar>>;
 
public:
    using TabulatedOneDFunction = Tabulated1DFunction<Scalar>;
 
    explicit SolventPvt() = default;
    SolventPvt(const std::vector<Scalar>& solventReferenceDensity,
               const std::vector<TabulatedOneDFunction>& inverseSolventB,
               const std::vector<TabulatedOneDFunction>& solventMu,
               const std::vector<TabulatedOneDFunction>& inverseSolventBMu)
        : solventReferenceDensity_(solventReferenceDensity)
        , inverseSolventB_(inverseSolventB)
        , solventMu_(solventMu)
        , inverseSolventBMu_(inverseSolventBMu)
    {
    }
 
#if HAVE_ECL_INPUT
    void initFromState(const EclipseState& eclState, const Schedule&)
    {
        const auto& pvdsTables = eclState.getTableManager().getPvdsTables();
        const auto& sdensityTables = eclState.getTableManager().getSolventDensityTables();
 
        assert(pvdsTables.size() == sdensityTables.size());
 
        size_t numRegions = pvdsTables.size();
        setNumRegions(numRegions);
 
        for (unsigned regionIdx = 0; regionIdx < numRegions; ++ regionIdx) {
            Scalar rhoRefS = sdensityTables[regionIdx].getSolventDensityColumn().front();
 
            setReferenceDensity(regionIdx, rhoRefS);
 
            const auto& pvdsTable = pvdsTables.getTable<PvdsTable>(regionIdx);
 
            // say 99.97% of all time: "premature optimization is the root of all
            // evil". Eclipse does this "optimization" for apparently no good reason!
            std::vector<Scalar> invB(pvdsTable.numRows());
            const auto& Bg = pvdsTable.getFormationFactorColumn();
            for (unsigned i = 0; i < Bg.size(); ++ i) {
                invB[i] = 1.0/Bg[i];
            }
 
            size_t numSamples = invB.size();
            inverseSolventB_[regionIdx].setXYArrays(numSamples, pvdsTable.getPressureColumn(), invB);
            solventMu_[regionIdx].setXYArrays(numSamples, pvdsTable.getPressureColumn(), pvdsTable.getViscosityColumn());
        }
 
        initEnd();
    }
#endif
 
    void setNumRegions(size_t numRegions)
    {
        solventReferenceDensity_.resize(numRegions);
        inverseSolventB_.resize(numRegions);
        inverseSolventBMu_.resize(numRegions);
        solventMu_.resize(numRegions);
    }
 
    void setReferenceDensity(unsigned regionIdx, Scalar rhoRefSolvent)
    { solventReferenceDensity_[regionIdx] = rhoRefSolvent; }
 
    void setSolventViscosity(unsigned regionIdx, const TabulatedOneDFunction& mug)
    { solventMu_[regionIdx] = mug; }
 
    void setSolventFormationVolumeFactor(unsigned regionIdx, const SamplingPoints& samplePoints)
    {
        SamplingPoints tmp(samplePoints);
        auto it = tmp.begin();
        const auto& endIt = tmp.end();
        for (; it != endIt; ++ it)
            std::get<1>(*it) = 1.0/std::get<1>(*it);
 
        inverseSolventB_[regionIdx].setContainerOfTuples(tmp);
        assert(inverseSolventB_[regionIdx].monotonic());
    }
 
    void initEnd()
    {
        // calculate the final 2D functions which are used for interpolation.
        size_t numRegions = solventMu_.size();
        for (unsigned regionIdx = 0; regionIdx < numRegions; ++ regionIdx) {
            // calculate the table which stores the inverse of the product of the solvent
            // formation volume factor and its viscosity
            const auto& solventMu = solventMu_[regionIdx];
            const auto& invSolventB = inverseSolventB_[regionIdx];
            assert(solventMu.numSamples() == invSolventB.numSamples());
 
            std::vector<Scalar> pressureValues(solventMu.numSamples());
            std::vector<Scalar> invSolventBMuValues(solventMu.numSamples());
            for (unsigned pIdx = 0; pIdx < solventMu.numSamples(); ++pIdx) {
                pressureValues[pIdx] = invSolventB.xAt(pIdx);
                invSolventBMuValues[pIdx] = invSolventB.valueAt(pIdx) * (1.0/solventMu.valueAt(pIdx));
            }
 
            inverseSolventBMu_[regionIdx].setXYContainers(pressureValues, invSolventBMuValues);
        }
    }
 
    unsigned numRegions() const
    { return solventReferenceDensity_.size(); }
 
    template <class Evaluation>
    Evaluation viscosity(unsigned regionIdx,
                                  const Evaluation&,
                                  const Evaluation& pressure) const
    {
        const Evaluation& invBg = inverseSolventB_[regionIdx].eval(pressure, /*extrapolate=*/true);
        const Evaluation& invMugBg = inverseSolventBMu_[regionIdx].eval(pressure, /*extrapolate=*/true);
 
        return invBg/invMugBg;
    }
 
    template <class Evaluation>
    Evaluation diffusionCoefficient(const Evaluation& /*temperature*/,
                                    const Evaluation& /*pressure*/,
                                    unsigned /*compIdx*/) const
    {
        throw std::runtime_error("Not implemented: The PVT model does not provide a diffusionCoefficient()");
    }
 
    Scalar referenceDensity(unsigned regionIdx) const
    { return solventReferenceDensity_[regionIdx]; }
 
    template <class Evaluation>
    Evaluation inverseFormationVolumeFactor(unsigned regionIdx,
                                            const Evaluation&,
                                            const Evaluation& pressure) const
    { return inverseSolventB_[regionIdx].eval(pressure, /*extrapolate=*/true); }
 
    const std::vector<Scalar>& solventReferenceDensity() const
    { return solventReferenceDensity_; }
 
    const std::vector<TabulatedOneDFunction>& inverseSolventB() const
    { return inverseSolventB_; }
 
    const std::vector<TabulatedOneDFunction>& solventMu() const
    { return solventMu_; }
 
    const std::vector<TabulatedOneDFunction>& inverseSolventBMu() const
    { return inverseSolventBMu_; }
 
    bool operator==(const SolventPvt<Scalar>& data) const
    {
        return solventReferenceDensity_ == data.solventReferenceDensity_ &&
               inverseSolventB_ == data.inverseSolventB_ &&
               solventMu_ == data.solventMu_ &&
               inverseSolventBMu_ == data.inverseSolventBMu_;
    }
 
private:
    std::vector<Scalar> solventReferenceDensity_;
    std::vector<TabulatedOneDFunction> inverseSolventB_;
    std::vector<TabulatedOneDFunction> solventMu_;
    std::vector<TabulatedOneDFunction> inverseSolventBMu_;
};
 
} // namespace Opm
 
#endif