mirror of
https://github.com/OPM/opm-simulators.git
synced 2024-12-30 11:06:55 -06:00
480 lines
17 KiB
C++
480 lines
17 KiB
C++
// -*- 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.
|
|
*/
|
|
/*!
|
|
* \file
|
|
*
|
|
* \brief Classes required for molecular diffusion.
|
|
*/
|
|
#ifndef EWOMS_DIFFUSION_MODULE_HH
|
|
#define EWOMS_DIFFUSION_MODULE_HH
|
|
|
|
#include <opm/models/discretization/common/fvbaseproperties.hh>
|
|
|
|
#include <opm/material/common/Valgrind.hpp>
|
|
#include <opm/material/common/Unused.hpp>
|
|
|
|
#include <dune/common/fvector.hh>
|
|
|
|
#include <stdexcept>
|
|
|
|
namespace Opm {
|
|
|
|
/*!
|
|
* \ingroup Diffusion
|
|
* \class Opm::BlackOilDiffusionModule
|
|
* \brief Provides the auxiliary methods required for consideration of the
|
|
* diffusion equation.
|
|
*/
|
|
template <class TypeTag, bool enableDiffusion>
|
|
class BlackOilDiffusionModule;
|
|
|
|
/*!
|
|
* \copydoc Opm::BlackOilDiffusionModule
|
|
*/
|
|
template <class TypeTag>
|
|
class BlackOilDiffusionModule<TypeTag, /*enableDiffusion=*/false>
|
|
{
|
|
using Scalar = GetPropType<TypeTag, Properties::Scalar>;
|
|
using FluidSystem = GetPropType<TypeTag, Properties::FluidSystem>;
|
|
using RateVector = GetPropType<TypeTag, Properties::RateVector>;
|
|
|
|
public:
|
|
/*!
|
|
* \brief Register all run-time parameters for the diffusion module.
|
|
*/
|
|
static void registerParameters()
|
|
{}
|
|
|
|
/*!
|
|
* \brief Adds the diffusive mass flux flux to the flux vector over a flux
|
|
* integration point.
|
|
*/
|
|
template <class Context>
|
|
static void addDiffusiveFlux(RateVector&,
|
|
const Context&,
|
|
unsigned,
|
|
unsigned)
|
|
{}
|
|
};
|
|
|
|
/*!
|
|
* \copydoc Opm::BlackOilDiffusionModule
|
|
*/
|
|
template <class TypeTag>
|
|
class BlackOilDiffusionModule<TypeTag, /*enableDiffusion=*/true>
|
|
{
|
|
using Scalar = GetPropType<TypeTag, Properties::Scalar>;
|
|
using Evaluation = GetPropType<TypeTag, Properties::Evaluation>;
|
|
using RateVector = GetPropType<TypeTag, Properties::RateVector>;
|
|
using FluidSystem = GetPropType<TypeTag, Properties::FluidSystem>;
|
|
using Indices = GetPropType<TypeTag, Properties::Indices>;
|
|
|
|
enum { numPhases = FluidSystem::numPhases };
|
|
enum { numComponents = FluidSystem::numComponents };
|
|
enum { conti0EqIdx = Indices::conti0EqIdx };
|
|
|
|
using Toolbox = MathToolbox<Evaluation>;
|
|
|
|
public:
|
|
/*!
|
|
* \brief Register all run-time parameters for the diffusion module.
|
|
*/
|
|
static void registerParameters()
|
|
{}
|
|
|
|
/*!
|
|
* \brief Adds the mass flux due to molecular diffusion to the flux vector over the
|
|
* flux integration point.
|
|
*/
|
|
template <class Context>
|
|
static void addDiffusiveFlux(RateVector& flux, const Context& context,
|
|
unsigned spaceIdx, unsigned timeIdx)
|
|
{
|
|
// Only work if diffusion is enabled run-time by DIFFUSE in the deck
|
|
if(!FluidSystem::enableDiffusion())
|
|
return;
|
|
|
|
const auto& extQuants = context.extensiveQuantities(spaceIdx, timeIdx);
|
|
const auto& fluidStateI = context.intensiveQuantities(extQuants.interiorIndex(), timeIdx).fluidState();
|
|
const auto& fluidStateJ = context.intensiveQuantities(extQuants.exteriorIndex(), timeIdx).fluidState();
|
|
for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
|
|
if (!FluidSystem::phaseIsActive(phaseIdx)) {
|
|
continue;
|
|
}
|
|
|
|
// no diffusion in water for blackoil models
|
|
if (FluidSystem::waterPhaseIdx == phaseIdx) {
|
|
continue;
|
|
}
|
|
|
|
// arithmetic mean of the phase's b factor weighed by saturation
|
|
Evaluation bSAvg = fluidStateI.saturation(phaseIdx) * fluidStateI.invB(phaseIdx);
|
|
bSAvg += Toolbox::value(fluidStateJ.saturation(phaseIdx)) * Toolbox::value(fluidStateJ.invB(phaseIdx));
|
|
bSAvg /= 2;
|
|
|
|
// phase not present, skip
|
|
if(bSAvg < 1.0e-6)
|
|
continue;
|
|
|
|
// mass flux of solvent component (oil in oil or gas in gas)
|
|
unsigned solventCompIdx = FluidSystem::solventComponentIndex(phaseIdx);
|
|
unsigned activeSolventCompIdx = Indices::canonicalToActiveComponentIndex(solventCompIdx);
|
|
flux[conti0EqIdx + activeSolventCompIdx] +=
|
|
-bSAvg
|
|
* extQuants.moleFractionGradientNormal(phaseIdx, solventCompIdx)
|
|
* extQuants.effectiveDiffusionCoefficient(phaseIdx, solventCompIdx);
|
|
// mass flux of solute component (gas in oil or oil in gas)
|
|
unsigned soluteCompIdx = FluidSystem::soluteComponentIndex(phaseIdx);
|
|
unsigned activeSoluteCompIdx = Indices::canonicalToActiveComponentIndex(soluteCompIdx);
|
|
flux[conti0EqIdx + activeSoluteCompIdx] +=
|
|
-bSAvg
|
|
* extQuants.moleFractionGradientNormal(phaseIdx, soluteCompIdx)
|
|
* extQuants.effectiveDiffusionCoefficient(phaseIdx, soluteCompIdx);
|
|
}
|
|
}
|
|
};
|
|
|
|
/*!
|
|
* \ingroup Diffusion
|
|
* \class Opm::BlackOilDiffusionIntensiveQuantities
|
|
*
|
|
* \brief Provides the volumetric quantities required for the
|
|
* calculation of molecular diffusive fluxes.
|
|
*/
|
|
template <class TypeTag, bool enableDiffusion>
|
|
class BlackOilDiffusionIntensiveQuantities;
|
|
|
|
/*!
|
|
* \copydoc Opm::DiffusionIntensiveQuantities
|
|
*/
|
|
template <class TypeTag>
|
|
class BlackOilDiffusionIntensiveQuantities<TypeTag, /*enableDiffusion=*/false>
|
|
{
|
|
using Scalar = GetPropType<TypeTag, Properties::Scalar>;
|
|
using ElementContext = GetPropType<TypeTag, Properties::ElementContext>;
|
|
using FluidSystem = GetPropType<TypeTag, Properties::FluidSystem>;
|
|
|
|
public:
|
|
/*!
|
|
* \brief Returns the tortuousity of the sub-domain of a fluid
|
|
* phase in the porous medium.
|
|
*/
|
|
Scalar tortuosity(unsigned) const
|
|
{
|
|
throw std::logic_error("Method tortuosity() does not make sense "
|
|
"if diffusion is disabled");
|
|
}
|
|
|
|
/*!
|
|
* \brief Returns the molecular diffusion coefficient for a
|
|
* component in a phase.
|
|
*/
|
|
Scalar diffusionCoefficient(unsigned, unsigned) const
|
|
{
|
|
throw std::logic_error("Method diffusionCoefficient() does not "
|
|
"make sense if diffusion is disabled");
|
|
}
|
|
|
|
/*!
|
|
* \brief Returns the effective molecular diffusion coefficient of
|
|
* the porous medium for a component in a phase.
|
|
*/
|
|
Scalar effectiveDiffusionCoefficient(unsigned, unsigned) const
|
|
{
|
|
throw std::logic_error("Method effectiveDiffusionCoefficient() "
|
|
"does not make sense if diffusion is disabled");
|
|
}
|
|
|
|
protected:
|
|
/*!
|
|
* \brief Update the quantities required to calculate diffusive
|
|
* mass fluxes.
|
|
*/
|
|
template <class FluidState>
|
|
void update_(FluidState&,
|
|
typename FluidSystem::template ParameterCache<typename FluidState::Scalar>&,
|
|
const ElementContext&,
|
|
unsigned,
|
|
unsigned)
|
|
{ }
|
|
};
|
|
|
|
/*!
|
|
* \copydoc Opm::DiffusionIntensiveQuantities
|
|
*/
|
|
template <class TypeTag>
|
|
class BlackOilDiffusionIntensiveQuantities<TypeTag, /*enableDiffusion=*/true>
|
|
{
|
|
using Scalar = GetPropType<TypeTag, Properties::Scalar>;
|
|
using Evaluation = GetPropType<TypeTag, Properties::Evaluation>;
|
|
using ElementContext = GetPropType<TypeTag, Properties::ElementContext>;
|
|
using FluidSystem = GetPropType<TypeTag, Properties::FluidSystem>;
|
|
|
|
enum { numPhases = FluidSystem::numPhases };
|
|
enum { numComponents = FluidSystem::numComponents };
|
|
|
|
public:
|
|
/*!
|
|
* \brief Returns the molecular diffusion coefficient for a
|
|
* component in a phase.
|
|
*/
|
|
Evaluation diffusionCoefficient(unsigned phaseIdx, unsigned compIdx) const
|
|
{ return diffusionCoefficient_[phaseIdx][compIdx]; }
|
|
|
|
/*!
|
|
* \brief Returns the tortuousity of the sub-domain of a fluid
|
|
* phase in the porous medium.
|
|
*/
|
|
Evaluation tortuosity(unsigned phaseIdx) const
|
|
{ return tortuosity_[phaseIdx]; }
|
|
|
|
/*!
|
|
* \brief Returns the effective molecular diffusion coefficient of
|
|
* the porous medium for a component in a phase.
|
|
*/
|
|
Evaluation effectiveDiffusionCoefficient(unsigned phaseIdx, unsigned compIdx) const
|
|
{ return tortuosity_[phaseIdx] * diffusionCoefficient_[phaseIdx][compIdx]; }
|
|
|
|
protected:
|
|
/*!
|
|
* \brief Update the quantities required to calculate diffusive
|
|
* mass fluxes.
|
|
*/
|
|
template <class FluidState>
|
|
void update_(FluidState& fluidState,
|
|
typename FluidSystem::template ParameterCache<typename FluidState::Scalar>& paramCache,
|
|
const ElementContext& elemCtx,
|
|
unsigned dofIdx,
|
|
unsigned timeIdx)
|
|
{
|
|
// Only work if diffusion is enabled run-time by DIFFUSE in the deck
|
|
if(!FluidSystem::enableDiffusion())
|
|
return;
|
|
|
|
using Toolbox = MathToolbox<Evaluation>;
|
|
const auto& intQuants = elemCtx.intensiveQuantities(dofIdx, timeIdx);
|
|
for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
|
|
if (!FluidSystem::phaseIsActive(phaseIdx)) {
|
|
continue;
|
|
}
|
|
|
|
// no diffusion in water for blackoil models
|
|
if (FluidSystem::waterPhaseIdx == phaseIdx) {
|
|
continue;
|
|
}
|
|
|
|
// Based on Millington, R. J., & Quirk, J. P. (1961).
|
|
const Evaluation& base =
|
|
Toolbox::max(0.0001,
|
|
intQuants.porosity()
|
|
* intQuants.fluidState().saturation(phaseIdx));
|
|
tortuosity_[phaseIdx] =
|
|
1.0 / (intQuants.porosity() * intQuants.porosity())
|
|
* Toolbox::pow(base, 10.0/3.0);
|
|
|
|
for (unsigned compIdx = 0; compIdx < numComponents; ++compIdx) {
|
|
diffusionCoefficient_[phaseIdx][compIdx] =
|
|
FluidSystem::diffusionCoefficient(fluidState,
|
|
paramCache,
|
|
phaseIdx,
|
|
compIdx);
|
|
}
|
|
}
|
|
}
|
|
|
|
private:
|
|
Evaluation tortuosity_[numPhases];
|
|
Evaluation diffusionCoefficient_[numPhases][numComponents];
|
|
};
|
|
|
|
/*!
|
|
* \ingroup Diffusion
|
|
* \class Opm::BlackOilDiffusionExtensiveQuantities
|
|
*
|
|
* \brief Provides the quantities required to calculate diffusive mass fluxes.
|
|
*/
|
|
template <class TypeTag, bool enableDiffusion>
|
|
class BlackOilDiffusionExtensiveQuantities;
|
|
|
|
/*!
|
|
* \copydoc Opm::DiffusionExtensiveQuantities
|
|
*/
|
|
template <class TypeTag>
|
|
class BlackOilDiffusionExtensiveQuantities<TypeTag, /*enableDiffusion=*/false>
|
|
{
|
|
using Scalar = GetPropType<TypeTag, Properties::Scalar>;
|
|
using Evaluation = GetPropType<TypeTag, Properties::Evaluation>;
|
|
using ElementContext = GetPropType<TypeTag, Properties::ElementContext>;
|
|
|
|
protected:
|
|
/*!
|
|
* \brief Update the quantities required to calculate
|
|
* the diffusive mass fluxes.
|
|
*/
|
|
void update_(const ElementContext&,
|
|
unsigned,
|
|
unsigned)
|
|
{}
|
|
|
|
template <class Context, class FluidState>
|
|
void updateBoundary_(const Context&,
|
|
unsigned,
|
|
unsigned,
|
|
const FluidState&)
|
|
{}
|
|
|
|
public:
|
|
/*!
|
|
* \brief The the gradient of the mole fraction times the face normal.
|
|
*
|
|
* \copydoc Doxygen::phaseIdxParam
|
|
* \copydoc Doxygen::compIdxParam
|
|
*/
|
|
const Evaluation& moleFractionGradientNormal(unsigned,
|
|
unsigned) const
|
|
{
|
|
throw std::logic_error("The method moleFractionGradient() does not "
|
|
"make sense if diffusion is disabled.");
|
|
}
|
|
|
|
/*!
|
|
* \brief The effective diffusion coeffcient of a component in a
|
|
* fluid phase at the face's integration point
|
|
*
|
|
* \copydoc Doxygen::phaseIdxParam
|
|
* \copydoc Doxygen::compIdxParam
|
|
*/
|
|
const Evaluation& effectiveDiffusionCoefficient(unsigned,
|
|
unsigned) const
|
|
{
|
|
throw std::logic_error("The method effectiveDiffusionCoefficient() "
|
|
"does not make sense if diffusion is disabled.");
|
|
}
|
|
};
|
|
|
|
/*!
|
|
* \copydoc Opm::BlackOilDiffusionExtensiveQuantities
|
|
*/
|
|
template <class TypeTag>
|
|
class BlackOilDiffusionExtensiveQuantities<TypeTag, /*enableDiffusion=*/true>
|
|
{
|
|
using Scalar = GetPropType<TypeTag, Properties::Scalar>;
|
|
using Evaluation = GetPropType<TypeTag, Properties::Evaluation>;
|
|
using ElementContext = GetPropType<TypeTag, Properties::ElementContext>;
|
|
using GridView = GetPropType<TypeTag, Properties::GridView>;
|
|
using FluidSystem = GetPropType<TypeTag, Properties::FluidSystem>;
|
|
|
|
enum { dimWorld = GridView::dimensionworld };
|
|
enum { numPhases = getPropValue<TypeTag, Properties::NumPhases>() };
|
|
enum { numComponents = getPropValue<TypeTag, Properties::NumComponents>() };
|
|
|
|
using DimVector = Dune::FieldVector<Scalar, dimWorld>;
|
|
using DimEvalVector = Dune::FieldVector<Evaluation, dimWorld>;
|
|
|
|
protected:
|
|
/*!
|
|
* \brief Update the quantities required to calculate
|
|
* the diffusive mass fluxes.
|
|
*/
|
|
void update_(const ElementContext& elemCtx, unsigned faceIdx, unsigned timeIdx)
|
|
{
|
|
// Only work if diffusion is enabled run-time by DIFFUSE in the deck
|
|
if(!FluidSystem::enableDiffusion())
|
|
return;
|
|
|
|
const auto& stencil = elemCtx.stencil(timeIdx);
|
|
const auto& face = stencil.interiorFace(faceIdx);
|
|
const auto& extQuants = elemCtx.extensiveQuantities(faceIdx, timeIdx);
|
|
const auto& intQuantsInside = elemCtx.intensiveQuantities(extQuants.interiorIndex(), timeIdx);
|
|
const auto& intQuantsOutside = elemCtx.intensiveQuantities(extQuants.exteriorIndex(), timeIdx);
|
|
|
|
const Scalar diffusivity = elemCtx.problem().diffusivity(elemCtx, face.interiorIndex(), face.exteriorIndex());
|
|
const Scalar faceArea = face.area();
|
|
|
|
for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
|
|
if (!FluidSystem::phaseIsActive(phaseIdx)) {
|
|
continue;
|
|
}
|
|
// no diffusion in water for blackoil models
|
|
if (FluidSystem::waterPhaseIdx == phaseIdx) {
|
|
continue;
|
|
}
|
|
for (unsigned compIdx = 0; compIdx < numComponents; ++compIdx) {
|
|
moleFractionGradientNormal_[phaseIdx][compIdx] =
|
|
(intQuantsOutside.fluidState().moleFraction(phaseIdx, compIdx)
|
|
-
|
|
intQuantsInside.fluidState().moleFraction(phaseIdx, compIdx))
|
|
* diffusivity / faceArea; //opm-models expects pr area flux
|
|
Valgrind::CheckDefined(moleFractionGradientNormal_[phaseIdx][compIdx]);
|
|
|
|
// use the arithmetic average for the effective
|
|
// diffusion coefficients.
|
|
effectiveDiffusionCoefficient_[phaseIdx][compIdx] =
|
|
(intQuantsInside.effectiveDiffusionCoefficient(phaseIdx, compIdx)
|
|
+
|
|
intQuantsOutside.effectiveDiffusionCoefficient(phaseIdx, compIdx))
|
|
/ 2;
|
|
|
|
Valgrind::CheckDefined(effectiveDiffusionCoefficient_[phaseIdx][compIdx]);
|
|
}
|
|
}
|
|
}
|
|
|
|
template <class Context, class FluidState>
|
|
void updateBoundary_(const Context&,
|
|
unsigned,
|
|
unsigned,
|
|
const FluidState&)
|
|
{
|
|
throw std::runtime_error("Not implemented: Diffusion across boundary not implemented for blackoil");
|
|
}
|
|
|
|
public:
|
|
/*!
|
|
* \brief The the gradient of the mole fraction times the face normal.
|
|
*
|
|
* \copydoc Doxygen::phaseIdxParam
|
|
* \copydoc Doxygen::compIdxParam
|
|
*/
|
|
const Evaluation& moleFractionGradientNormal(unsigned phaseIdx, unsigned compIdx) const
|
|
{ return moleFractionGradientNormal_[phaseIdx][compIdx]; }
|
|
|
|
/*!
|
|
* \brief The effective diffusion coeffcient of a component in a
|
|
* fluid phase at the face's integration point
|
|
*
|
|
* \copydoc Doxygen::phaseIdxParam
|
|
* \copydoc Doxygen::compIdxParam
|
|
*/
|
|
const Evaluation& effectiveDiffusionCoefficient(unsigned phaseIdx, unsigned compIdx) const
|
|
{ return effectiveDiffusionCoefficient_[phaseIdx][compIdx]; }
|
|
|
|
private:
|
|
Evaluation moleFractionGradientNormal_[numPhases][numComponents];
|
|
Evaluation effectiveDiffusionCoefficient_[numPhases][numComponents];
|
|
};
|
|
|
|
} // namespace Opm
|
|
|
|
#endif
|