Loading...
Searching...
No Matches
flashintensivequantities.hh
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_FLASH_INTENSIVE_QUANTITIES_HH
#define OPM_FLASH_INTENSIVE_QUANTITIES_HH
#include <dune/common/fmatrix.hh>
#include <dune/common/fvector.hh>
#include <opm/material/Constants.hpp>
#include <opm/material/common/Valgrind.hpp>
#include <opm/material/fluidstates/CompositionalFluidState.hpp>
#include <opm/models/common/energymodule.hh>
#include <opm/models/common/diffusionmodule.hh>
#include <opm/models/flash/flashproperties.hh>
#include <opm/models/ptflash/flashindices.hh>
#include <opm/models/ptflash/flashparameters.hh>
#include <array>
#include <iostream>
#include <string>
namespace Opm {
template <class TypeTag>
class FlashIntensiveQuantities
: public GetPropType<TypeTag, Properties::DiscIntensiveQuantities>
, public DiffusionIntensiveQuantities<TypeTag, getPropValue<TypeTag, Properties::EnableDiffusion>() >
, public EnergyIntensiveQuantities<TypeTag, getPropValue<TypeTag, Properties::EnableEnergy>() >
, public GetPropType<TypeTag, Properties::FluxModule>::FluxIntensiveQuantities
{
using ParentType = GetPropType<TypeTag, Properties::DiscIntensiveQuantities>;
using ElementContext = GetPropType<TypeTag, Properties::ElementContext>;
using MaterialLaw = GetPropType<TypeTag, Properties::MaterialLaw>;
using MaterialLawParams = GetPropType<TypeTag, Properties::MaterialLawParams>;
using Indices = GetPropType<TypeTag, Properties::Indices>;
using FluxModule = GetPropType<TypeTag, Properties::FluxModule>;
using GridView = GetPropType<TypeTag, Properties::GridView>;
using ThreadManager = GetPropType<TypeTag, Properties::ThreadManager>;
// primary variable indices
enum { z0Idx = Indices::z0Idx };
enum { numPhases = getPropValue<TypeTag, Properties::NumPhases>() };
enum { numComponents = getPropValue<TypeTag, Properties::NumComponents>() };
enum { enableDiffusion = getPropValue<TypeTag, Properties::EnableDiffusion>() };
enum { enableEnergy = getPropValue<TypeTag, Properties::EnableEnergy>() };
enum { dimWorld = GridView::dimensionworld };
enum { pressure0Idx = Indices::pressure0Idx };
enum { water0Idx = Indices::water0Idx};
static constexpr bool waterEnabled = Indices::waterEnabled;
using Scalar = GetPropType<TypeTag, Properties::Scalar>;
using Evaluation = GetPropType<TypeTag, Properties::Evaluation>;
using FluidSystem = GetPropType<TypeTag, Properties::FluidSystem>;
using FlashSolver = GetPropType<TypeTag, Properties::FlashSolver>;
using ComponentVector = Dune::FieldVector<Evaluation, numComponents>;
using DimMatrix = Dune::FieldMatrix<Scalar, dimWorld, dimWorld>;
using DiffusionIntensiveQuantities = ::Opm::DiffusionIntensiveQuantities<TypeTag, enableDiffusion>;
using EnergyIntensiveQuantities = ::Opm::EnergyIntensiveQuantities<TypeTag, enableEnergy>;
using FluxIntensiveQuantities = typename FluxModule::FluxIntensiveQuantities;
public:
using FluidState = CompositionalFluidState<Evaluation, FluidSystem, enableEnergy>;
FlashIntensiveQuantities() = default;
FlashIntensiveQuantities(const FlashIntensiveQuantities& other) = default;
FlashIntensiveQuantities& operator=(const FlashIntensiveQuantities& other) = default;
void update(const ElementContext& elemCtx, unsigned dofIdx, unsigned timeIdx)
{
ParentType::update(elemCtx, dofIdx, timeIdx);
EnergyIntensiveQuantities::updateTemperatures_(fluidState_, elemCtx, dofIdx, timeIdx);
const auto& priVars = elemCtx.primaryVars(dofIdx, timeIdx);
const auto& problem = elemCtx.problem();
const Scalar flashTolerance = Parameters::Get<Parameters::FlashTolerance<Scalar>>();
const int flashVerbosity = Parameters::Get<Parameters::FlashVerbosity>();
const std::string flashTwoPhaseMethod = Parameters::Get<Parameters::FlashTwoPhaseMethod>();
// TODO: the formulation here is still to begin with XMF and YMF values to derive ZMF value
// TODO: we should check how we update ZMF in the newton update, since it is the primary variables.
// extract the total molar densities of the components
ComponentVector z(0.);
{
Evaluation lastZ = 1.0;
for (unsigned compIdx = 0; compIdx < numComponents - 1; ++compIdx) {
z[compIdx] = priVars.makeEvaluation(z0Idx + compIdx, timeIdx);
lastZ -= z[compIdx];
}
z[numComponents - 1] = lastZ;
Evaluation sumz = 0.0;
for (unsigned compIdx = 0; compIdx < numComponents; ++compIdx) {
z[compIdx] = max(z[compIdx], 1e-8);
sumz += z[compIdx];
}
z /= sumz;
}
for (unsigned compIdx = 0; compIdx < numComponents; ++compIdx) {
fluidState_.setMoleFraction(compIdx, z[compIdx]);
}
Evaluation p = priVars.makeEvaluation(pressure0Idx, timeIdx);
for (int phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
fluidState_.setPressure(phaseIdx, p);
}
// Get initial K and L from storage initially (if enabled)
const auto* hint = elemCtx.thermodynamicHint(dofIdx, timeIdx);
if (hint) {
for (unsigned compIdx = 0; compIdx < numComponents; ++compIdx) {
const Evaluation& Ktmp = hint->fluidState().K(compIdx);
fluidState_.setKvalue(compIdx, Ktmp);
}
const Evaluation& Ltmp = hint->fluidState().L();
fluidState_.setLvalue(Ltmp);
}
else if (timeIdx == 0 && elemCtx.thermodynamicHint(dofIdx, 1)) {
// checking the storage cache
const auto& hint2 = elemCtx.thermodynamicHint(dofIdx, 1);
for (unsigned compIdx = 0; compIdx < numComponents; ++compIdx) {
const Evaluation& Ktmp = hint2->fluidState().K(compIdx);
fluidState_.setKvalue(compIdx, Ktmp);
}
const Evaluation& Ltmp = hint2->fluidState().L();
fluidState_.setLvalue(Ltmp);
}
else {
for (unsigned compIdx = 0; compIdx < numComponents; ++compIdx) {
const Evaluation Ktmp = fluidState_.wilsonK_(compIdx);
fluidState_.setKvalue(compIdx, Ktmp);
}
const Evaluation& Ltmp = -1.0;
fluidState_.setLvalue(Ltmp);
}
// Compute the phase compositions and densities
if (flashVerbosity >= 1) {
const int spatialIdx = elemCtx.globalSpaceIndex(dofIdx, timeIdx);
std::cout << " updating the intensive quantities for Cell " << spatialIdx << std::endl;
}
const auto& eos_type = problem.getEosType();
FlashSolver::solve(fluidState_, flashTwoPhaseMethod, flashTolerance, eos_type, flashVerbosity);
if (flashVerbosity >= 5) {
// printing of flash result after solve
const int spatialIdx = elemCtx.globalSpaceIndex(dofIdx, timeIdx);
std::cout << " \n After flash solve for cell " << spatialIdx << std::endl;
ComponentVector x, y;
for (unsigned comp_idx = 0; comp_idx < numComponents; ++comp_idx) {
x[comp_idx] = fluidState_.moleFraction(FluidSystem::oilPhaseIdx, comp_idx);
y[comp_idx] = fluidState_.moleFraction(FluidSystem::gasPhaseIdx, comp_idx);
}
for (unsigned comp_idx = 0; comp_idx < numComponents; ++comp_idx) {
std::cout << " x for component: " << comp_idx << " is:" << std::endl;
std::cout << x[comp_idx] << std::endl;
std::cout << " y for component: " << comp_idx << "is:" << std::endl;
std::cout << y[comp_idx] << std::endl;
}
const Evaluation& L = fluidState_.L();
std::cout << " L is:" << std::endl;
std::cout << L << std::endl;
}
// Update phases
typename FluidSystem::template ParameterCache<Evaluation> paramCache(eos_type);
paramCache.updatePhase(fluidState_, FluidSystem::oilPhaseIdx);
const Scalar R = Opm::Constants<Scalar>::R;
const Evaluation Z_L = (paramCache.molarVolume(FluidSystem::oilPhaseIdx) *
fluidState_.pressure(FluidSystem::oilPhaseIdx)) /
(R * fluidState_.temperature(FluidSystem::oilPhaseIdx));
paramCache.updatePhase(fluidState_, FluidSystem::gasPhaseIdx);
const Evaluation Z_V = (paramCache.molarVolume(FluidSystem::gasPhaseIdx) *
fluidState_.pressure(FluidSystem::gasPhaseIdx)) /
(R * fluidState_.temperature(FluidSystem::gasPhaseIdx));
// Update saturation
Evaluation Sw = 0.0;
if constexpr (waterEnabled) {
Sw = priVars.makeEvaluation(water0Idx, timeIdx);
}
const Evaluation L = fluidState_.L();
Evaluation So = max((1 - Sw) * (L * Z_L / ( L * Z_L + (1 - L) * Z_V)), 0.0);
Evaluation Sg = max(1 - So - Sw, 0.0);
const Scalar sumS = getValue(So) + getValue(Sg) + getValue(Sw);
So /= sumS;
Sg /= sumS;
fluidState_.setSaturation(FluidSystem::oilPhaseIdx, So);
fluidState_.setSaturation(FluidSystem::gasPhaseIdx, Sg);
if constexpr (waterEnabled) {
Sw /= sumS;
fluidState_.setSaturation(FluidSystem::waterPhaseIdx, Sw);
}
fluidState_.setCompressFactor(FluidSystem::oilPhaseIdx, Z_L);
fluidState_.setCompressFactor(FluidSystem::gasPhaseIdx, Z_V);
// Print saturation
if (flashVerbosity >= 5) {
std::cout << "So = " << So << std::endl;
std::cout << "Sg = " << Sg << std::endl;
std::cout << "Z_L = " << Z_L << std::endl;
std::cout << "Z_V = " << Z_V << std::endl;
}
// Compute rel. perm and viscosity and densities
const MaterialLawParams& materialParams = problem.materialLawParams(elemCtx, dofIdx, timeIdx);
// calculate relative permeability
MaterialLaw::relativePermeabilities(relativePermeability_,
materialParams, fluidState_);
Valgrind::CheckDefined(relativePermeability_);
// set the phase viscosity and density
for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
if (phaseIdx == static_cast<unsigned int>(FluidSystem::oilPhaseIdx) ||
phaseIdx == static_cast<unsigned int>(FluidSystem::gasPhaseIdx))
{
paramCache.updatePhase(fluidState_, phaseIdx);
}
const Evaluation& mu = FluidSystem::viscosity(fluidState_, paramCache, phaseIdx);
fluidState_.setViscosity(phaseIdx, mu);
mobility_[phaseIdx] = relativePermeability_[phaseIdx] / mu;
Valgrind::CheckDefined(mobility_[phaseIdx]);
const Evaluation& rho = FluidSystem::density(fluidState_, paramCache, phaseIdx);
fluidState_.setDensity(phaseIdx, rho);
}
// Compute the remaining quantities
// porosity
porosity_ = problem.porosity(elemCtx, dofIdx, timeIdx);
Valgrind::CheckDefined(porosity_);
// intrinsic permeability
intrinsicPerm_ = problem.intrinsicPermeability(elemCtx, dofIdx, timeIdx);
// update the quantities specific for the velocity model
FluxIntensiveQuantities::update_(elemCtx, dofIdx, timeIdx);
// energy related quantities
EnergyIntensiveQuantities::update_(fluidState_, paramCache, elemCtx, dofIdx, timeIdx);
// update the diffusion specific quantities of the intensive quantities
DiffusionIntensiveQuantities::update_(fluidState_, paramCache, elemCtx, dofIdx, timeIdx);
}
const FluidState& fluidState() const
{ return fluidState_; }
const DimMatrix& intrinsicPermeability() const
{ return intrinsicPerm_; }
const Evaluation& relativePermeability(unsigned phaseIdx) const
{ return relativePermeability_[phaseIdx]; }
const Evaluation& mobility(unsigned phaseIdx) const
{ return mobility_[phaseIdx]; }
const Evaluation& porosity() const
{ return porosity_; }
private:
DimMatrix intrinsicPerm_;
FluidState fluidState_;
Evaluation porosity_;
std::array<Evaluation,numPhases> relativePermeability_;
std::array<Evaluation,numPhases> mobility_;
};
} // namespace Opm
#endif
Opm::DiffusionIntensiveQuantities
Provides the volumetric quantities required for the calculation of molecular diffusive fluxes.
Definition diffusionmodule.hh:143
Opm::EnergyIntensiveQuantities
Provides the volumetric quantities required for the energy equation.
Definition energymodule.hh:535
Opm::FlashIntensiveQuantities
Contains the intensive quantities of the flash-based compositional multi-phase model.
Definition flashintensivequantities.hh:60
Opm::FlashIntensiveQuantities::mobility
const Evaluation & mobility(unsigned phaseIdx) const
Returns the effective mobility of a given phase within the control volume.
Definition flashintensivequantities.hh:327
Opm::FlashIntensiveQuantities::intrinsicPermeability
const DimMatrix & intrinsicPermeability() const
Returns the intrinsic permeability tensor a degree of freedom.
Definition flashintensivequantities.hh:315
Opm::FlashIntensiveQuantities::fluidState
const FluidState & fluidState() const
Returns the phase state for the control-volume.
Definition flashintensivequantities.hh:309
Opm::FlashIntensiveQuantities::porosity
const Evaluation & porosity() const
Returns the average porosity within the control volume.
Definition flashintensivequantities.hh:333
Opm::FlashIntensiveQuantities::relativePermeability
const Evaluation & relativePermeability(unsigned phaseIdx) const
Returns the relative permeability of a given phase within the control volume.
Definition flashintensivequantities.hh:321
Opm::FlashIntensiveQuantities::FluidState
CompositionalFluidState< Evaluation, FluidSystem, enableEnergy > FluidState
The type of the object returned by the fluidState() method.
Definition flashintensivequantities.hh:93
Opm::FlashIntensiveQuantities::update
void update(const ElementContext &elemCtx, unsigned dofIdx, unsigned timeIdx)
Definition flashintensivequantities.hh:112
diffusionmodule.hh
Classes required for molecular diffusion.
energymodule.hh
Contains the classes required to consider energy as a conservation quantity in a multi-phase module.
flashproperties.hh
Declares the properties required by the compositional multi-phase model based on flash calculations.
Opm
This file contains a set of helper functions used by VFPProd / VFPInj.
Definition blackoilbioeffectsmodules.hh:43
Opm::GetPropType
typename Properties::Detail::GetPropImpl< TypeTag, Property >::type::type GetPropType
get the type alias defined in the property (equivalent to old macro GET_PROP_TYPE(....
Definition propertysystem.hh:233
Opm::getPropValue
constexpr auto getPropValue()
get the value data member of a property
Definition propertysystem.hh:240
Opm::Parameters::Get
auto Get(bool errorIfNotRegistered=true)
Retrieve a runtime parameter.
Definition parametersystem.hpp:187
flashindices.hh
Defines the primary variable and equation indices for the compositional multi-phase model based on fl...
flashparameters.hh
Declares the parameters for the compositional multi-phase model based on flash calculations.