Loading...
Searching...
No Matches
WetHumidGasPvt.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_WET_HUMID_GAS_PVT_HPP
#define OPM_WET_HUMID_GAS_PVT_HPP
#include <opm/common/Exceptions.hpp>
#include <opm/common/OpmLog/OpmLog.hpp>
#include <opm/material/common/MathToolbox.hpp>
#include <opm/material/common/UniformXTabulated2DFunction.hpp>
#include <opm/material/common/Tabulated1DFunction.hpp>
#include <cstddef>
namespace Opm {
#if HAVE_ECL_INPUT
class EclipseState;
class Schedule;
class SimpleTable;
#endif
template <class Scalar>
class WetHumidGasPvt
{
using SamplingPoints = std::vector<std::pair<Scalar, Scalar>>;
public:
using TabulatedTwoDFunction = UniformXTabulated2DFunction<Scalar>;
using TabulatedOneDFunction = Tabulated1DFunction<Scalar>;
#if HAVE_ECL_INPUT
void initFromState(const EclipseState& eclState, const Schedule& schedule);
private:
void extendPvtgwTable_(unsigned regionIdx,
unsigned xIdx,
const SimpleTable& curTable,
const SimpleTable& masterTable);
void extendPvtgTable_(unsigned regionIdx,
unsigned xIdx,
const SimpleTable& curTable,
const SimpleTable& masterTable);
public:
#endif // HAVE_ECL_INPUT
void setNumRegions(std::size_t numRegions);
void setVapPars(const Scalar par1, const Scalar)
{
vapPar1_ = par1;
}
void setReferenceDensities(unsigned regionIdx,
Scalar rhoRefOil,
Scalar rhoRefGas,
Scalar rhoRefWater);
void setSaturatedGasWaterVaporizationFactor(unsigned regionIdx,
const SamplingPoints& samplePoints)
{ saturatedWaterVaporizationFactorTable_[regionIdx].setContainerOfTuples(samplePoints); }
void setSaturatedGasOilVaporizationFactor(unsigned regionIdx,
const SamplingPoints& samplePoints)
{ saturatedOilVaporizationFactorTable_[regionIdx].setContainerOfTuples(samplePoints); }
void initEnd();
unsigned numRegions() const
{ return gasReferenceDensity_.size(); }
template <class Evaluation>
Evaluation internalEnergy(unsigned,
const Evaluation&,
const Evaluation&,
const Evaluation&,
const Evaluation&) const
{
throw std::runtime_error("Requested the enthalpy of gas but the thermal "
"option is not enabled");
}
Scalar hVap(unsigned) const
{
throw std::runtime_error("Requested the hvap of oil but the thermal "
"option is not enabled");
}
template <class Evaluation>
Evaluation viscosity(unsigned regionIdx,
const Evaluation& /*temperature*/,
const Evaluation& pressure,
const Evaluation& Rv,
const Evaluation& Rvw) const
{
const Evaluation& temperature = 1E30;
if (Rv >= (1.0 - 1e-10) * saturatedOilVaporizationFactor(regionIdx, temperature, pressure)) {
const Evaluation& invBg = inverseGasBRvSat_[regionIdx].eval(pressure, Rvw, /*extrapolate=*/true);
const Evaluation& invMugBg = inverseGasBMuRvSat_[regionIdx].eval(pressure, Rvw, /*extrapolate=*/true);
return invBg / invMugBg;
}
else {
// for Rv undersaturated viscosity is evaluated at saturated Rvw values
const Evaluation& invBg = inverseGasBRvwSat_[regionIdx].eval(pressure, Rv, /*extrapolate=*/true);
const Evaluation& invMugBg = inverseGasBMuRvwSat_[regionIdx].eval(pressure, Rv, /*extrapolate=*/true);
return invBg / invMugBg;
}
}
template <class Evaluation>
Evaluation saturatedViscosity(unsigned regionIdx,
const Evaluation& /*temperature*/,
const Evaluation& pressure) const
{
const Evaluation& invBg = inverseSaturatedGasB_[regionIdx].eval(pressure, /*extrapolate=*/true);
const Evaluation& invMugBg = inverseSaturatedGasBMu_[regionIdx].eval(pressure, /*extrapolate=*/true);
return invBg / invMugBg;
}
// template <class Evaluation>
// Evaluation inverseFormationVolumeFactor(unsigned regionIdx,
// const Evaluation& /*temperature*/,
// const Evaluation& pressure,
// const Evaluation& Rw) const
// { return inverseGasB_[regionIdx].eval(pressure, Rw, /*extrapolate=*/true); }
template <class Evaluation>
Evaluation inverseFormationVolumeFactor(unsigned regionIdx,
const Evaluation& /*temperature*/,
const Evaluation& pressure,
const Evaluation& Rv,
const Evaluation& Rvw) const
{
const Evaluation& temperature = 1E30;
if (Rv >= (1.0 - 1e-10) * saturatedOilVaporizationFactor(regionIdx, temperature, pressure)) {
return inverseGasBRvSat_[regionIdx].eval(pressure, Rvw, /*extrapolate=*/true);
}
else {
// for Rv undersaturated Bg^-1 is evaluated at saturated Rvw values
return inverseGasBRvwSat_[regionIdx].eval(pressure, Rv, /*extrapolate=*/true);
}
}
template <class Evaluation>
Evaluation saturatedInverseFormationVolumeFactor(unsigned regionIdx,
const Evaluation& /*temperature*/,
const Evaluation& pressure) const
{ return inverseSaturatedGasB_[regionIdx].eval(pressure, /*extrapolate=*/true); }
template <class Evaluation>
Evaluation saturatedWaterVaporizationFactor(unsigned regionIdx,
const Evaluation& /*temperature*/,
const Evaluation& pressure) const
{
return saturatedWaterVaporizationFactorTable_[regionIdx].eval(pressure, /*extrapolate=*/true);
}
template <class Evaluation>
Evaluation saturatedWaterVaporizationFactor(unsigned regionIdx,
const Evaluation& /*temperature*/,
const Evaluation& pressure,
const Evaluation& saltConcentration) const
{
if (enableRwgSalt_) {
return saturatedWaterVaporizationSaltFactorTable_[regionIdx].eval(pressure, saltConcentration, /*extrapolate=*/true);
}
else {
return saturatedWaterVaporizationFactorTable_[regionIdx].eval(pressure, /*extrapolate=*/true);
}
}
template <class Evaluation>
Evaluation saturatedOilVaporizationFactor(unsigned regionIdx,
const Evaluation& /*temperature*/,
const Evaluation& pressure) const
{
return saturatedOilVaporizationFactorTable_[regionIdx].eval(pressure, /*extrapolate=*/true);
}
template <class Evaluation>
Evaluation saturatedOilVaporizationFactor(unsigned regionIdx,
const Evaluation& /*temperature*/,
const Evaluation& pressure,
const Evaluation& oilSaturation,
Evaluation maxOilSaturation) const
{
Evaluation tmp =
saturatedOilVaporizationFactorTable_[regionIdx].eval(pressure, /*extrapolate=*/true);
// apply the vaporization parameters for the gas phase (cf. the Eclipse VAPPARS
// keyword)
maxOilSaturation = min(maxOilSaturation, Scalar(1.0));
if (vapPar1_ > 0.0 && maxOilSaturation > 0.01 && oilSaturation < maxOilSaturation) {
constexpr const Scalar eps = 0.001;
const Evaluation& So = max(oilSaturation, eps);
tmp *= max(1e-3, pow(So / maxOilSaturation, vapPar1_));
}
return tmp;
}
//PJPE assume dependence on Rv
template <class Evaluation>
Evaluation saturationPressure(unsigned regionIdx,
const Evaluation&,
const Evaluation& Rw) const
{
using Toolbox = MathToolbox<Evaluation>;
const auto& RwTable = saturatedWaterVaporizationFactorTable_[regionIdx];
constexpr const Scalar eps = std::numeric_limits<typename Toolbox::Scalar>::epsilon() * 1e6;
// use the tabulated saturation pressure function to get a pretty good initial value
Evaluation pSat = saturationPressure_[regionIdx].eval(Rw, /*extrapolate=*/true);
// Newton method to do the remaining work. If the initial
// value is good, this should only take two to three
// iterations...
bool onProbation = false;
for (unsigned i = 0; i < 20; ++i) {
const Evaluation& f = RwTable.eval(pSat, /*extrapolate=*/true) - Rw;
const Evaluation& fPrime = RwTable.evalDerivative(pSat, /*extrapolate=*/true);
// If the derivative is "zero" Newton will not converge,
// so simply return our initial guess.
if (std::abs(scalarValue(fPrime)) < 1.0e-30) {
return pSat;
}
const Evaluation& delta = f / fPrime;
pSat -= delta;
if (pSat < 0.0) {
// if the pressure is lower than 0 Pascals, we set it back to 0. if this
// happens twice, we give up and just return 0 Pa...
if (onProbation) {
return 0.0;
}
onProbation = true;
pSat = 0.0;
}
if (std::abs(scalarValue(delta)) < std::abs(scalarValue(pSat))*eps) {
return pSat;
}
}
const std::string msg =
"Finding saturation pressure did not converge: "
"pSat = " + std::to_string(getValue(pSat)) +
", Rw = " + std::to_string(getValue(Rw));
OpmLog::debug("Wet gas saturation pressure", msg);
throw NumericalProblem(msg);
}
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 gasReferenceDensity(unsigned regionIdx) const
{ return gasReferenceDensity_[regionIdx]; }
Scalar oilReferenceDensity(unsigned regionIdx) const
{ return oilReferenceDensity_[regionIdx]; }
Scalar waterReferenceDensity(unsigned regionIdx) const
{ return waterReferenceDensity_[regionIdx]; }
const std::vector<TabulatedTwoDFunction>& inverseGasB() const
{ return inverseGasBRvSat_; }
const std::vector<TabulatedOneDFunction>& inverseSaturatedGasB() const
{ return inverseSaturatedGasB_; }
const std::vector<TabulatedTwoDFunction>& gasMu() const
{ return gasMuRvSat_; }
const std::vector<TabulatedTwoDFunction>& inverseGasBMu() const
{ return inverseGasBMuRvSat_; }
const std::vector<TabulatedOneDFunction>& inverseSaturatedGasBMu() const
{ return inverseSaturatedGasBMu_; }
const std::vector<TabulatedOneDFunction>& saturatedWaterVaporizationFactorTable() const
{ return saturatedWaterVaporizationFactorTable_; }
const std::vector<TabulatedTwoDFunction>& saturatedWaterVaporizationSaltFactorTable() const
{ return saturatedWaterVaporizationSaltFactorTable_; }
const std::vector<TabulatedOneDFunction>& saturatedOilVaporizationFactorTable() const
{ return saturatedOilVaporizationFactorTable_; }
const std::vector<TabulatedOneDFunction>& saturationPressure() const
{ return saturationPressure_; }
Scalar vapPar1() const
{ return vapPar1_; }
private:
void updateSaturationPressure_(unsigned regionIdx);
std::vector<Scalar> gasReferenceDensity_{};
std::vector<Scalar> oilReferenceDensity_{};
std::vector<Scalar> waterReferenceDensity_{};
std::vector<TabulatedTwoDFunction> inverseGasBRvwSat_{};
std::vector<TabulatedTwoDFunction> inverseGasBRvSat_{};
std::vector<TabulatedOneDFunction> inverseSaturatedGasB_{};
std::vector<TabulatedTwoDFunction> gasMuRvwSat_{};
std::vector<TabulatedTwoDFunction> gasMuRvSat_{};
std::vector<TabulatedTwoDFunction> inverseGasBMuRvwSat_{};
std::vector<TabulatedTwoDFunction> inverseGasBMuRvSat_{};
std::vector<TabulatedOneDFunction> inverseSaturatedGasBMu_{};
std::vector<TabulatedOneDFunction> saturatedWaterVaporizationFactorTable_{};
std::vector<TabulatedTwoDFunction> saturatedWaterVaporizationSaltFactorTable_{};
std::vector<TabulatedOneDFunction> saturatedOilVaporizationFactorTable_{};
std::vector<TabulatedOneDFunction> saturationPressure_{};
bool enableRwgSalt_ = false;
Scalar vapPar1_ = 0.0;
};
} // namespace Opm
#endif
Exceptions.hpp
Provides the OPM specific exception classes.
MathToolbox.hpp
A traits class which provides basic mathematical functions for arbitrary scalar floating point values...
Tabulated1DFunction.hpp
Implements a linearly interpolated scalar function that depends on one variable.
UniformXTabulated2DFunction.hpp
Implements a scalar function that depends on two variables and which is sampled uniformly in the X di...
Opm::EclipseState
Definition EclipseState.hpp:63
Opm::NumericalProblem
Definition Exceptions.hpp:40
Opm::Schedule
Definition Schedule.hpp:89
Opm::SimpleTable
Definition SimpleTable.hpp:35
Opm::Tabulated1DFunction
Implements a linearly interpolated scalar function that depends on one variable.
Definition Tabulated1DFunction.hpp:51
Opm::UniformXTabulated2DFunction
Implements a scalar function that depends on two variables and which is sampled uniformly in the X di...
Definition UniformXTabulated2DFunction.hpp:55
Opm::WetHumidGasPvt
This class represents the Pressure-Volume-Temperature relations of the gas phase with vaporized oil a...
Definition WetHumidGasPvt.hpp:53
Opm::WetHumidGasPvt::saturationPressure
Evaluation saturationPressure(unsigned regionIdx, const Evaluation &, const Evaluation &Rw) const
Returns the saturation pressure of the gas phase [Pa] depending on its mass fraction of the water com...
Definition WetHumidGasPvt.hpp:296
Opm::WetHumidGasPvt::numRegions
unsigned numRegions() const
Return the number of PVT regions which are considered by this PVT-object.
Definition WetHumidGasPvt.hpp:123
Opm::WetHumidGasPvt::setSaturatedGasOilVaporizationFactor
void setSaturatedGasOilVaporizationFactor(unsigned regionIdx, const SamplingPoints &samplePoints)
Initialize the function for the oil vaporization factor .
Definition WetHumidGasPvt.hpp:111
Opm::WetHumidGasPvt::viscosity
Evaluation viscosity(unsigned regionIdx, const Evaluation &, const Evaluation &pressure, const Evaluation &Rv, const Evaluation &Rvw) const
Returns the dynamic viscosity [Pa s] of the fluid phase given a set of parameters.
Definition WetHumidGasPvt.hpp:150
Opm::WetHumidGasPvt::saturatedWaterVaporizationFactor
Evaluation saturatedWaterVaporizationFactor(unsigned regionIdx, const Evaluation &, const Evaluation &pressure, const Evaluation &saltConcentration) const
Returns the water vaporization factor [m^3/m^3] of the water phase.
Definition WetHumidGasPvt.hpp:237
Opm::WetHumidGasPvt::saturatedInverseFormationVolumeFactor
Evaluation saturatedInverseFormationVolumeFactor(unsigned regionIdx, const Evaluation &, const Evaluation &pressure) const
Returns the formation volume factor [-] of water saturated gas at a given pressure.
Definition WetHumidGasPvt.hpp:217
Opm::WetHumidGasPvt::saturatedWaterVaporizationFactor
Evaluation saturatedWaterVaporizationFactor(unsigned regionIdx, const Evaluation &, const Evaluation &pressure) const
Returns the water vaporization factor [m^3/m^3] of the water phase.
Definition WetHumidGasPvt.hpp:226
Opm::WetHumidGasPvt::saturatedViscosity
Evaluation saturatedViscosity(unsigned regionIdx, const Evaluation &, const Evaluation &pressure) const
Returns the dynamic viscosity [Pa s] of oil saturated gas at a given pressure.
Definition WetHumidGasPvt.hpp:175
Opm::WetHumidGasPvt::saturatedOilVaporizationFactor
Evaluation saturatedOilVaporizationFactor(unsigned regionIdx, const Evaluation &, const Evaluation &pressure, const Evaluation &oilSaturation, Evaluation maxOilSaturation) const
Returns the oil vaporization factor [m^3/m^3] of the gas phase.
Definition WetHumidGasPvt.hpp:266
Opm::WetHumidGasPvt::setReferenceDensities
void setReferenceDensities(unsigned regionIdx, Scalar rhoRefOil, Scalar rhoRefGas, Scalar rhoRefWater)
Initialize the reference densities of all fluids for a given PVT region.
Definition WetHumidGasPvt.cpp:422
Opm::WetHumidGasPvt::inverseFormationVolumeFactor
Evaluation inverseFormationVolumeFactor(unsigned regionIdx, const Evaluation &, const Evaluation &pressure, const Evaluation &Rv, const Evaluation &Rvw) const
Returns the formation volume factor [-] of the fluid phase.
Definition WetHumidGasPvt.hpp:196
Opm::WetHumidGasPvt::internalEnergy
Evaluation internalEnergy(unsigned, const Evaluation &, const Evaluation &, const Evaluation &, const Evaluation &) const
Returns the specific enthalpy [J/kg] of gas given a set of parameters.
Definition WetHumidGasPvt.hpp:130
Opm::WetHumidGasPvt::initEnd
void initEnd()
Finish initializing the gas phase PVT properties.
Definition WetHumidGasPvt.cpp:433
Opm::WetHumidGasPvt::setSaturatedGasWaterVaporizationFactor
void setSaturatedGasWaterVaporizationFactor(unsigned regionIdx, const SamplingPoints &samplePoints)
Initialize the function for the water vaporization factor .
Definition WetHumidGasPvt.hpp:102
Opm
This class implements a small container which holds the transmissibility mulitpliers for all the face...
Definition Exceptions.hpp:30
Opm::MathToolbox
Definition MathToolbox.hpp:51