28#ifndef EWOMS_BLACK_OIL_FOAM_MODULE_HH
29#define EWOMS_BLACK_OIL_FOAM_MODULE_HH
31#include <dune/common/fvector.hh>
33#include <opm/common/ErrorMacros.hpp>
34#include <opm/common/OpmLog/OpmLog.hpp>
35#include <opm/common/utility/gpuDecorators.hpp>
37#include <opm/input/eclipse/EclipseState/Phase.hpp>
56template <
class TypeTag,
bool enableFoamV>
64template <
class TypeTag>
79 using Toolbox = MathToolbox<Evaluation>;
83 static constexpr unsigned foamConcentrationIdx = Indices::foamConcentrationIdx;
84 static constexpr unsigned contiFoamEqIdx = Indices::contiFoamEqIdx;
85 static constexpr unsigned gasPhaseIdx = FluidSystem::gasPhaseIdx;
86 static constexpr unsigned waterPhaseIdx = FluidSystem::waterPhaseIdx;
88 static constexpr bool enableFoam =
true;
90 static constexpr unsigned numEq = getPropValue<TypeTag, Properties::NumEq>();
92 static constexpr bool enableSolvent = getPropValue<TypeTag, Properties::EnableSolvent>();
113 if (Parameters::Get<Parameters::EnableVtkOutput>()) {
114 OpmLog::warning(
"VTK output requested, currently unsupported by the foam module.");
121 return pvIdx == foamConcentrationIdx;
126 assert(primaryVarApplies(pvIdx));
127 return "foam_concentration";
132 assert(primaryVarApplies(pvIdx));
135 return static_cast<Scalar
>(1.0);
140 return eqIdx == contiFoamEqIdx;
143 static std::string
eqName([[maybe_unused]]
unsigned eqIdx)
145 assert(eqApplies(eqIdx));
150 static Scalar
eqWeight([[maybe_unused]]
unsigned eqIdx)
152 assert(eqApplies(eqIdx));
155 return static_cast<Scalar
>(1.0);
159 template <
class StorageType>
161 const IntensiveQuantities& intQuants)
163 using LhsEval =
typename StorageType::value_type;
165 const auto& fs = intQuants.fluidState();
167 LhsEval surfaceVolume = Toolbox::template decay<LhsEval>(intQuants.porosity());
168 if (params_.transport_phase_ == Phase::WATER) {
169 surfaceVolume *= Toolbox::template decay<LhsEval>(fs.saturation(waterPhaseIdx)) *
170 Toolbox::template decay<LhsEval>(fs.invB(waterPhaseIdx));
171 }
else if (params_.transport_phase_ == Phase::GAS) {
172 surfaceVolume *= Toolbox::template decay<LhsEval>(fs.saturation(gasPhaseIdx)) *
173 Toolbox::template decay<LhsEval>(fs.invB(gasPhaseIdx));
174 }
else if (params_.transport_phase_ == Phase::SOLVENT) {
175 if constexpr (enableSolvent) {
176 surfaceVolume *= Toolbox::template decay<LhsEval>( intQuants.solventSaturation()) *
177 Toolbox::template decay<LhsEval>(intQuants.solventInverseFormationVolumeFactor());
180 OPM_THROW(std::runtime_error,
"Transport phase is GAS/WATER/SOLVENT");
184 surfaceVolume = max(surfaceVolume, 1e-10);
187 const LhsEval freeFoam = surfaceVolume *
188 Toolbox::template decay<LhsEval>(intQuants.foamConcentration());
191 const LhsEval adsorbedFoam =
192 Toolbox::template decay<LhsEval>(1.0 - intQuants.porosity()) *
193 Toolbox::template decay<LhsEval>(intQuants.foamRockDensity()) *
194 Toolbox::template decay<LhsEval>(intQuants.foamAdsorbed());
196 const LhsEval accumulationFoam = freeFoam + adsorbedFoam;
197 storage[contiFoamEqIdx] += accumulationFoam;
201 const ElementContext& elemCtx,
205 const auto& extQuants = elemCtx.extensiveQuantities(scvfIdx, timeIdx);
206 const unsigned inIdx = extQuants.interiorIndex();
208 flux[contiFoamEqIdx] = 0.0;
213 switch (transportPhase()) {
215 const unsigned upIdx = extQuants.upstreamIndex(waterPhaseIdx);
216 const auto& up = elemCtx.intensiveQuantities(upIdx, timeIdx);
217 if (upIdx == inIdx) {
218 addFoamFluxes_<Evaluation>(
219 flux, waterPhaseIdx, extQuants.volumeFlux(waterPhaseIdx), up);
221 addFoamFluxes_<Scalar>(
222 flux, waterPhaseIdx, extQuants.volumeFlux(waterPhaseIdx), up);
227 const unsigned upIdx = extQuants.upstreamIndex(gasPhaseIdx);
228 const auto& up = elemCtx.intensiveQuantities(upIdx, timeIdx);
229 if (upIdx == inIdx) {
230 addFoamFluxes_<Evaluation>(
231 flux, gasPhaseIdx, extQuants.volumeFlux(gasPhaseIdx), up);
233 addFoamFluxes_<Scalar>(
234 flux, gasPhaseIdx, extQuants.volumeFlux(gasPhaseIdx), up);
239 if constexpr (enableSolvent) {
240 const unsigned upIdx = extQuants.solventUpstreamIndex();
241 const auto& up = elemCtx.intensiveQuantities(upIdx, timeIdx);
242 if (upIdx == inIdx) {
243 addFoamSolventFluxes_<Evaluation>(flux, extQuants.solventVolumeFlux(), up);
245 addFoamSolventFluxes_<Scalar>(flux, extQuants.solventVolumeFlux(), up);
248 throw std::runtime_error(
"Foam transport phase is SOLVENT but SOLVENT is not activated.");
252 throw std::runtime_error(
"Foam transport phase must be GAS/WATER/SOLVENT.");
267 template <
class UpEval>
269 const unsigned phaseIdx,
270 const Evaluation& volumeFlux,
271 const IntensiveQuantities& up)
273 if ((phaseIdx == waterPhaseIdx && transportPhase() == Phase::WATER)
274 || (phaseIdx == gasPhaseIdx && transportPhase() == Phase::GAS)) {
275 flux[contiFoamEqIdx] += volumeFlux
276 * decay<UpEval>(up.fluidState().invB(phaseIdx))
277 * decay<UpEval>(up.foamConcentration());
291 template <
class UpEval>
293 const Evaluation& solventVolumeFlux,
294 const IntensiveQuantities& up)
296 if (transportPhase() == Phase::SOLVENT) {
297 flux[contiFoamEqIdx] += solventVolumeFlux
298 * decay<UpEval>(up.solventInverseFormationVolumeFactor())
299 * decay<UpEval>(up.foamConcentration());
311 return static_cast<Scalar
>(0.0);
314 template <
class DofEntity>
316 [[maybe_unused]] std::ostream& outstream,
317 [[maybe_unused]]
const DofEntity& dof)
319 const unsigned dofIdx = model.dofMapper().index(dof);
320 const PrimaryVariables& priVars = model.solution(0)[dofIdx];
321 outstream << priVars[foamConcentrationIdx];
324 template <
class DofEntity>
326 [[maybe_unused]] std::istream& instream,
327 [[maybe_unused]]
const DofEntity& dof)
329 const unsigned dofIdx = model.dofMapper().index(dof);
330 PrimaryVariables& priVars0 = model.solution(0)[dofIdx];
331 PrimaryVariables& priVars1 = model.solution(1)[dofIdx];
333 instream >> priVars0[foamConcentrationIdx];
336 priVars1[foamConcentrationIdx] = priVars0[foamConcentrationIdx];
343 const unsigned satnumRegionIdx = elemCtx.problem().satnumRegionIndex(elemCtx, scvIdx, timeIdx);
344 return params_.foamRockDensity_[satnumRegionIdx];
351 const unsigned satnumRegionIdx = elemCtx.problem().satnumRegionIndex(elemCtx, scvIdx, timeIdx);
352 return params_.foamAllowDesorption_[satnumRegionIdx];
359 const unsigned satnumRegionIdx = elemCtx.problem().satnumRegionIndex(elemCtx, scvIdx, timeIdx);
360 return params_.adsorbedFoamTable_[satnumRegionIdx];
367 const unsigned pvtnumRegionIdx = elemCtx.problem().pvtRegionIndex(elemCtx, scvIdx, timeIdx);
368 return params_.gasMobilityMultiplierTable_[pvtnumRegionIdx];
373 const unsigned scvIdx,
374 const unsigned timeIdx)
376 const unsigned satnumRegionIdx = elemCtx.problem().satnumRegionIndex(elemCtx, scvIdx, timeIdx);
377 return params_.foamCoefficients_[satnumRegionIdx];
381 {
return params_.foamRockDensity_[satnumRegionIdx]; }
384 {
return params_.foamAllowDesorption_[satnumRegionIdx]; }
387 {
return params_.adsorbedFoamTable_[satnumRegionIdx]; }
390 {
return params_.gasMobilityMultiplierTable_[pvtnumRegionIdx]; }
394 {
return params_.foamCoefficients_[satnumRegionIdx]; }
397 {
return params_.transport_phase_; }
403template <
class TypeTag>
404BlackOilFoamParams<typename BlackOilFoamModule<TypeTag, true>::Scalar>
405BlackOilFoamModule<TypeTag, true>::params_;
414template <
class TypeTag>
430 static constexpr bool enableSolvent = getPropValue<TypeTag, Properties::EnableSolvent>();
432 static constexpr unsigned foamConcentrationIdx = Indices::foamConcentrationIdx;
433 static constexpr unsigned waterPhaseIdx = FluidSystem::waterPhaseIdx;
434 static constexpr unsigned oilPhaseIdx = FluidSystem::oilPhaseIdx;
435 static constexpr int gasPhaseIdx = FluidSystem::gasPhaseIdx;
444 const PrimaryVariables& priVars,
445 const unsigned globalSpaceIdx,
446 const unsigned timeIdx)
448 const auto linearizationType = problem.model().linearizer().getLinearizationType();
449 const unsigned satnumRegionIdx = problem.satnumRegionIndex(globalSpaceIdx);
451 = priVars.makeEvaluation(foamConcentrationIdx, timeIdx, linearizationType);
452 const auto& fs = asImp_().fluidState_;
455 Evaluation mobilityReductionFactor = 1.0;
456 if constexpr (
false) {
460 const auto& foamCoefficients = FoamModule::foamCoefficients(satnumRegionIdx);
462 const Scalar fm_mob = foamCoefficients.fm_mob;
464 const Scalar fm_surf = foamCoefficients.fm_surf;
465 const Scalar ep_surf = foamCoefficients.ep_surf;
467 const Scalar fm_oil = foamCoefficients.fm_oil;
468 const Scalar fl_oil = foamCoefficients.fl_oil;
469 const Scalar ep_oil = foamCoefficients.ep_oil;
471 const Scalar fm_dry = foamCoefficients.fm_dry;
472 const Scalar ep_dry = foamCoefficients.ep_dry;
474 const Scalar fm_cap = foamCoefficients.fm_cap;
475 const Scalar ep_cap = foamCoefficients.ep_cap;
477 const Evaluation C_surf = foamConcentration_;
478 const Evaluation Ca = 1e10;
479 const Evaluation S_o = fs.saturation(oilPhaseIdx);
480 const Evaluation S_w = fs.saturation(waterPhaseIdx);
482 const Evaluation F1 = pow(C_surf / fm_surf, ep_surf);
483 const Evaluation F2 = pow((fm_oil - S_o) / (fm_oil - fl_oil), ep_oil);
484 const Evaluation F3 = pow(fm_cap / Ca, ep_cap);
485 const Evaluation F7 = 0.5 + atan(ep_dry * (S_w - fm_dry)) / std::numbers::pi_v<Scalar>;
487 mobilityReductionFactor = 1. / (1. + fm_mob * F1 * F2 * F3 * F7);
492 const auto& gasMobilityMultiplier
493 = FoamModule::gasMobilityMultiplierTable(problem.pvtRegionIndex(globalSpaceIdx));
494 mobilityReductionFactor = gasMobilityMultiplier.eval(foamConcentration_,
true);
498 switch (FoamModule::transportPhase()) {
500 asImp_().mobility_[waterPhaseIdx] *= mobilityReductionFactor;
503 asImp_().mobility_[gasPhaseIdx] *= mobilityReductionFactor;
506 if constexpr (enableSolvent) {
507 asImp_().solventMobility_ *= mobilityReductionFactor;
509 throw std::runtime_error(
"Foam transport phase is SOLVENT but SOLVENT is not activated.");
513 throw std::runtime_error(
"Foam transport phase must be GAS/WATER/SOLVENT.");
516 foamRockDensity_ = FoamModule::foamRockDensity(satnumRegionIdx);
518 const auto& adsorbedFoamTable = FoamModule::adsorbedFoamTable(satnumRegionIdx);
519 foamAdsorbed_ = adsorbedFoamTable.eval(foamConcentration_,
true);
520 if (!FoamModule::foamAllowDesorption(satnumRegionIdx)) {
521 throw std::runtime_error(
"Foam module does not support the 'no desorption' option.");
529 foamPropertiesUpdate_(elemCtx.problem(),
530 elemCtx.primaryVars(dofIdx, timeIdx),
531 elemCtx.globalSpaceIndex(dofIdx, timeIdx),
536 {
return foamConcentration_; }
539 {
return foamRockDensity_; }
542 {
return foamAdsorbed_; }
546 {
return *
static_cast<Implementation*
>(
this); }
Contains the parameters to extend the black-oil model to include the effects of foam.
Contains classes extending the black-oil model. \detail This file holds dummy definitions,...
Declares the properties required by the black oil model.
Evaluation foamConcentration_
Definition: blackoilfoammodules.hh:548
void foamPropertiesUpdate_(const Problem &problem, const PrimaryVariables &priVars, const unsigned globalSpaceIdx, const unsigned timeIdx)
Update the intensive properties needed to handle polymers from the primary variables.
Definition: blackoilfoammodules.hh:443
void foamPropertiesUpdate_(const ElementContext &elemCtx, unsigned dofIdx, unsigned timeIdx)
Definition: blackoilfoammodules.hh:525
const Evaluation & foamAdsorbed() const
Definition: blackoilfoammodules.hh:541
Scalar foamRockDensity() const
Definition: blackoilfoammodules.hh:538
Evaluation foamAdsorbed_
Definition: blackoilfoammodules.hh:550
Implementation & asImp_()
Definition: blackoilfoammodules.hh:545
const Evaluation & foamConcentration() const
Definition: blackoilfoammodules.hh:535
Scalar foamRockDensity_
Definition: blackoilfoammodules.hh:549
Provides the volumetric quantities required for the equations needed by the polymers extension of the...
Contains the high level supplements required to extend the black oil model to include the effects of ...
Definition: blackoilfoammodules.hh:66
static const TabulatedFunction & adsorbedFoamTable(const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
Definition: blackoilfoammodules.hh:355
static bool foamAllowDesorption(unsigned satnumRegionIdx)
Definition: blackoilfoammodules.hh:383
static Scalar primaryVarWeight(unsigned pvIdx)
Definition: blackoilfoammodules.hh:130
static void deserializeEntity(Model &model, std::istream &instream, const DofEntity &dof)
Definition: blackoilfoammodules.hh:325
static const TabulatedFunction & gasMobilityMultiplierTable(const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
Definition: blackoilfoammodules.hh:363
static void registerParameters()
Register all run-time parameters for the black-oil foam module.
Definition: blackoilfoammodules.hh:104
static Phase transportPhase()
Definition: blackoilfoammodules.hh:396
static void serializeEntity(const Model &model, std::ostream &outstream, const DofEntity &dof)
Definition: blackoilfoammodules.hh:315
static bool primaryVarApplies(unsigned pvIdx)
Definition: blackoilfoammodules.hh:119
static void computeFlux(RateVector &flux, const ElementContext &elemCtx, unsigned scvfIdx, unsigned timeIdx)
Definition: blackoilfoammodules.hh:200
static const BlackOilFoamParams< Scalar >::FoamCoefficients & foamCoefficients(unsigned satnumRegionIdx)
Definition: blackoilfoammodules.hh:393
static bool eqApplies(unsigned eqIdx)
Definition: blackoilfoammodules.hh:138
static Scalar eqWeight(unsigned eqIdx)
Definition: blackoilfoammodules.hh:150
static Scalar foamRockDensity(unsigned satnumRegionIdx)
Definition: blackoilfoammodules.hh:380
static const TabulatedFunction & gasMobilityMultiplierTable(unsigned pvtnumRegionIdx)
Definition: blackoilfoammodules.hh:389
static Scalar computeUpdateError(const PrimaryVariables &, const EqVector &)
Return how much a Newton-Raphson update is considered an error.
Definition: blackoilfoammodules.hh:306
static void registerOutputModules(Model &, Simulator &)
Register all foam specific VTK and ECL output modules.
Definition: blackoilfoammodules.hh:110
static std::string primaryVarName(unsigned pvIdx)
Definition: blackoilfoammodules.hh:124
static OPM_HOST_DEVICE void addStorage(StorageType &storage, const IntensiveQuantities &intQuants)
Definition: blackoilfoammodules.hh:160
static void addFoamSolventFluxes_(RateVector &flux, const Evaluation &solventVolumeFlux, const IntensiveQuantities &up)
Add the foam flux carried by the solvent over a face.
Definition: blackoilfoammodules.hh:292
static std::string eqName(unsigned eqIdx)
Definition: blackoilfoammodules.hh:143
static const Scalar foamRockDensity(const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
Definition: blackoilfoammodules.hh:339
static void setParams(BlackOilFoamParams< Scalar > &¶ms)
Set parameters.
Definition: blackoilfoammodules.hh:96
static const BlackOilFoamParams< Scalar >::FoamCoefficients & foamCoefficients(const ElementContext &elemCtx, const unsigned scvIdx, const unsigned timeIdx)
Definition: blackoilfoammodules.hh:372
static const TabulatedFunction & adsorbedFoamTable(unsigned satnumRegionIdx)
Definition: blackoilfoammodules.hh:386
static void addFoamFluxes_(RateVector &flux, const unsigned phaseIdx, const Evaluation &volumeFlux, const IntensiveQuantities &up)
Add the foam flux carried by the water or gas phase over a face.
Definition: blackoilfoammodules.hh:268
static bool foamAllowDesorption(const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
Definition: blackoilfoammodules.hh:347
Definition: blackoilfoammodules.hh:57
Declare the properties used by the infrastructure code of the finite volume discretizations.
Declare the properties used by the infrastructure code of the finite volume discretizations.
Phase
Phase indices for reservoir coupling, we currently only support black-oil phases (oil,...
Definition: ReservoirCoupling.hpp:184
Definition: blackoilbioeffectsmodules.hh:45
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
Definition: blackoilfoamparams.hpp:60
Struct holding the parameters for the BlackoilFoamModule class.
Definition: blackoilfoamparams.hpp:44
Tabulated1DFunction< Scalar > TabulatedFunction
Definition: blackoilfoamparams.hpp:45