mirror of
https://github.com/OPM/opm-simulators.git
synced 2024-12-26 17:20:59 -06:00
262 lines
9.8 KiB
C++
262 lines
9.8 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
|
|
*
|
|
* \copydoc Opm::NcpLocalResidual
|
|
*/
|
|
#ifndef EWOMS_NCP_LOCAL_RESIDUAL_HH
|
|
#define EWOMS_NCP_LOCAL_RESIDUAL_HH
|
|
|
|
#include "ncpproperties.hh"
|
|
|
|
#include <opm/models/common/diffusionmodule.hh>
|
|
#include <opm/models/common/energymodule.hh>
|
|
|
|
#include <opm/material/common/Valgrind.hpp>
|
|
|
|
namespace Opm {
|
|
/*!
|
|
* \ingroup NcpModel
|
|
*
|
|
* \brief Details needed to calculate the local residual in the
|
|
* compositional multi-phase NCP-model .
|
|
*/
|
|
template <class TypeTag>
|
|
class NcpLocalResidual : public GetPropType<TypeTag, Properties::DiscLocalResidual>
|
|
{
|
|
using ParentType = GetPropType<TypeTag, Properties::DiscLocalResidual>;
|
|
using Scalar = GetPropType<TypeTag, Properties::Scalar>;
|
|
using Evaluation = GetPropType<TypeTag, Properties::Evaluation>;
|
|
using EqVector = GetPropType<TypeTag, Properties::EqVector>;
|
|
using RateVector = GetPropType<TypeTag, Properties::RateVector>;
|
|
using IntensiveQuantities = GetPropType<TypeTag, Properties::IntensiveQuantities>;
|
|
using ElementContext = GetPropType<TypeTag, Properties::ElementContext>;
|
|
using Indices = GetPropType<TypeTag, Properties::Indices>;
|
|
|
|
enum { numEq = getPropValue<TypeTag, Properties::NumEq>() };
|
|
enum { numPhases = getPropValue<TypeTag, Properties::NumPhases>() };
|
|
enum { numComponents = getPropValue<TypeTag, Properties::NumComponents>() };
|
|
enum { ncp0EqIdx = Indices::ncp0EqIdx };
|
|
enum { conti0EqIdx = Indices::conti0EqIdx };
|
|
|
|
enum { enableDiffusion = getPropValue<TypeTag, Properties::EnableDiffusion>() };
|
|
using DiffusionModule = Opm::DiffusionModule<TypeTag, enableDiffusion>;
|
|
|
|
enum { enableEnergy = getPropValue<TypeTag, Properties::EnableEnergy>() };
|
|
using EnergyModule = Opm::EnergyModule<TypeTag, enableEnergy>;
|
|
|
|
using EvalEqVector = Dune::FieldVector<Evaluation, numEq>;
|
|
using ElemEvalEqVector = Dune::BlockVector<EvalEqVector>;
|
|
using Toolbox = Opm::MathToolbox<Evaluation>;
|
|
|
|
public:
|
|
/*!
|
|
* \copydoc ImmiscibleLocalResidual::addPhaseStorage
|
|
*/
|
|
template <class LhsEval>
|
|
void addPhaseStorage(Dune::FieldVector<LhsEval, numEq>& storage,
|
|
const ElementContext& elemCtx,
|
|
unsigned dofIdx,
|
|
unsigned timeIdx,
|
|
unsigned phaseIdx) const
|
|
{
|
|
const IntensiveQuantities& intQuants = elemCtx.intensiveQuantities(dofIdx, timeIdx);
|
|
const auto& fluidState = intQuants.fluidState();
|
|
|
|
// compute storage term of all components within all phases
|
|
for (unsigned compIdx = 0; compIdx < numComponents; ++compIdx) {
|
|
unsigned eqIdx = conti0EqIdx + compIdx;
|
|
storage[eqIdx] +=
|
|
Toolbox::template decay<LhsEval>(fluidState.molarity(phaseIdx, compIdx))
|
|
* Toolbox::template decay<LhsEval>(fluidState.saturation(phaseIdx))
|
|
* Toolbox::template decay<LhsEval>(intQuants.porosity());
|
|
}
|
|
|
|
EnergyModule::addPhaseStorage(storage, elemCtx.intensiveQuantities(dofIdx, timeIdx), phaseIdx);
|
|
}
|
|
|
|
/*!
|
|
* \copydoc ImmiscibleLocalResidual::computeStorage
|
|
*/
|
|
template <class LhsEval>
|
|
void computeStorage(Dune::FieldVector<LhsEval, numEq>& storage,
|
|
const ElementContext& elemCtx,
|
|
unsigned dofIdx,
|
|
unsigned timeIdx) const
|
|
{
|
|
storage = 0;
|
|
for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx)
|
|
addPhaseStorage(storage, elemCtx, dofIdx, timeIdx, phaseIdx);
|
|
|
|
EnergyModule::addSolidEnergyStorage(storage, elemCtx.intensiveQuantities(dofIdx, timeIdx));
|
|
}
|
|
|
|
/*!
|
|
* \copydoc ImmiscibleLocalResidual::computeFlux
|
|
*/
|
|
void computeFlux(RateVector& flux,
|
|
const ElementContext& elemCtx,
|
|
unsigned scvfIdx,
|
|
unsigned timeIdx) const
|
|
{
|
|
flux = 0.0;
|
|
addAdvectiveFlux(flux, elemCtx, scvfIdx, timeIdx);
|
|
Opm::Valgrind::CheckDefined(flux);
|
|
|
|
addDiffusiveFlux(flux, elemCtx, scvfIdx, timeIdx);
|
|
Opm::Valgrind::CheckDefined(flux);
|
|
}
|
|
|
|
/*!
|
|
* \copydoc ImmiscibleLocalResidual::addAdvectiveFlux
|
|
*/
|
|
void addAdvectiveFlux(RateVector& flux,
|
|
const ElementContext& elemCtx,
|
|
unsigned scvfIdx,
|
|
unsigned timeIdx) const
|
|
{
|
|
const auto& extQuants = elemCtx.extensiveQuantities(scvfIdx, timeIdx);
|
|
|
|
unsigned focusDofIdx = elemCtx.focusDofIndex();
|
|
for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
|
|
// data attached to upstream and the downstream DOFs
|
|
// of the current phase
|
|
unsigned upIdx = static_cast<unsigned>(extQuants.upstreamIndex(phaseIdx));
|
|
const IntensiveQuantities& up = elemCtx.intensiveQuantities(upIdx, timeIdx);
|
|
|
|
// this is a bit hacky because it is specific to the element-centered
|
|
// finite volume scheme. (N.B. that if finite differences are used to
|
|
// linearize the system of equations, it does not matter.)
|
|
if (upIdx == focusDofIdx) {
|
|
Evaluation tmp =
|
|
up.fluidState().molarDensity(phaseIdx)
|
|
* extQuants.volumeFlux(phaseIdx);
|
|
|
|
for (unsigned compIdx = 0; compIdx < numComponents; ++compIdx) {
|
|
flux[conti0EqIdx + compIdx] +=
|
|
tmp*up.fluidState().moleFraction(phaseIdx, compIdx);
|
|
}
|
|
}
|
|
else {
|
|
Evaluation tmp =
|
|
Toolbox::value(up.fluidState().molarDensity(phaseIdx))
|
|
* extQuants.volumeFlux(phaseIdx);
|
|
|
|
for (unsigned compIdx = 0; compIdx < numComponents; ++compIdx) {
|
|
flux[conti0EqIdx + compIdx] +=
|
|
tmp*Toolbox::value(up.fluidState().moleFraction(phaseIdx, compIdx));
|
|
}
|
|
}
|
|
}
|
|
|
|
EnergyModule::addAdvectiveFlux(flux, elemCtx, scvfIdx, timeIdx);
|
|
}
|
|
|
|
/*!
|
|
* \copydoc ImmiscibleLocalResidual::addDiffusiveFlux
|
|
*/
|
|
void addDiffusiveFlux(RateVector& flux,
|
|
const ElementContext& elemCtx,
|
|
unsigned scvfIdx,
|
|
unsigned timeIdx) const
|
|
{
|
|
DiffusionModule::addDiffusiveFlux(flux, elemCtx, scvfIdx, timeIdx);
|
|
EnergyModule::addDiffusiveFlux(flux, elemCtx, scvfIdx, timeIdx);
|
|
}
|
|
|
|
/*!
|
|
* \copydoc FvBaseLocalResidual::computeSource
|
|
*
|
|
* By default, this method only asks the problem to specify a
|
|
* source term.
|
|
*/
|
|
void computeSource(RateVector& source,
|
|
const ElementContext& elemCtx,
|
|
unsigned dofIdx,
|
|
unsigned timeIdx) const
|
|
{
|
|
Opm::Valgrind::SetUndefined(source);
|
|
elemCtx.problem().source(source, elemCtx, dofIdx, timeIdx);
|
|
Opm::Valgrind::CheckDefined(source);
|
|
|
|
// evaluate the NCPs (i.e., the "phase presence" equations)
|
|
for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
|
|
source[ncp0EqIdx + phaseIdx] =
|
|
phaseNcp(elemCtx, dofIdx, timeIdx, phaseIdx);
|
|
}
|
|
}
|
|
|
|
/*!
|
|
* \brief Returns the value of the NCP-function for a phase.
|
|
*/
|
|
template <class LhsEval = Evaluation>
|
|
LhsEval phaseNcp(const ElementContext& elemCtx,
|
|
unsigned dofIdx,
|
|
unsigned timeIdx,
|
|
unsigned phaseIdx) const
|
|
{
|
|
const auto& fluidState = elemCtx.intensiveQuantities(dofIdx, timeIdx).fluidState();
|
|
using FluidState = typename std::remove_const<typename std::remove_reference<decltype(fluidState)>::type>::type;
|
|
|
|
using LhsToolbox = Opm::MathToolbox<LhsEval>;
|
|
|
|
const LhsEval& a = phaseNotPresentIneq_<FluidState, LhsEval>(fluidState, phaseIdx);
|
|
const LhsEval& b = phasePresentIneq_<FluidState, LhsEval>(fluidState, phaseIdx);
|
|
return LhsToolbox::min(a, b);
|
|
}
|
|
|
|
private:
|
|
/*!
|
|
* \brief Returns the value of the inequality where a phase is
|
|
* present.
|
|
*/
|
|
template <class FluidState, class LhsEval>
|
|
LhsEval phasePresentIneq_(const FluidState& fluidState, unsigned phaseIdx) const
|
|
{
|
|
using FsToolbox = Opm::MathToolbox<typename FluidState::Scalar>;
|
|
|
|
return FsToolbox::template decay<LhsEval>(fluidState.saturation(phaseIdx));
|
|
}
|
|
|
|
/*!
|
|
* \brief Returns the value of the inequality where a phase is not
|
|
* present.
|
|
*/
|
|
template <class FluidState, class LhsEval>
|
|
LhsEval phaseNotPresentIneq_(const FluidState& fluidState, unsigned phaseIdx) const
|
|
{
|
|
using FsToolbox = Opm::MathToolbox<typename FluidState::Scalar>;
|
|
|
|
// difference of sum of mole fractions in the phase from 100%
|
|
LhsEval a = 1.0;
|
|
for (unsigned i = 0; i < numComponents; ++i)
|
|
a -= FsToolbox::template decay<LhsEval>(fluidState.moleFraction(phaseIdx, i));
|
|
return a;
|
|
}
|
|
};
|
|
|
|
} // namespace Opm
|
|
|
|
#endif
|