28#ifndef OPM_BLACK_OIL_MICP_MODULE_HH
29#define OPM_BLACK_OIL_MICP_MODULE_HH
31#include <dune/common/fvector.hh>
33#include <opm/material/common/MathToolbox.hpp>
52template <class TypeTag, bool enableMICPV = getPropValue<TypeTag, Properties::EnableMICP>()>
69 using Toolbox = MathToolbox<Evaluation>;
73 enum { waterCompIdx = FluidSystem::waterCompIdx };
75 static constexpr unsigned microbialConcentrationIdx = Indices::microbialConcentrationIdx;
76 static constexpr unsigned oxygenConcentrationIdx = Indices::oxygenConcentrationIdx;
77 static constexpr unsigned ureaConcentrationIdx = Indices::ureaConcentrationIdx;
78 static constexpr unsigned biofilmConcentrationIdx = Indices::biofilmConcentrationIdx;
79 static constexpr unsigned calciteConcentrationIdx = Indices::calciteConcentrationIdx;
80 static constexpr unsigned contiMicrobialEqIdx = Indices::contiMicrobialEqIdx;
81 static constexpr unsigned contiOxygenEqIdx = Indices::contiOxygenEqIdx;
82 static constexpr unsigned contiUreaEqIdx = Indices::contiUreaEqIdx;
83 static constexpr unsigned contiBiofilmEqIdx = Indices::contiBiofilmEqIdx;
84 static constexpr unsigned contiCalciteEqIdx = Indices::contiCalciteEqIdx;
85 static constexpr unsigned waterPhaseIdx = FluidSystem::waterPhaseIdx;
87 static constexpr unsigned enableMICP = enableMICPV;
89 static constexpr unsigned numEq = getPropValue<TypeTag, Properties::NumEq>();
103 if constexpr (enableMICP) {
112 Simulator& simulator)
114 if constexpr (enableMICP) {
121 if constexpr (enableMICP) {
123 eqIdx == contiMicrobialEqIdx
124 || eqIdx == contiOxygenEqIdx
125 || eqIdx == contiUreaEqIdx
126 || eqIdx == contiBiofilmEqIdx
127 || eqIdx == contiCalciteEqIdx;
134 static Scalar
eqWeight([[maybe_unused]]
unsigned eqIdx)
139 return static_cast<Scalar
>(1.0);
143 template <
class LhsEval>
144 static void addStorage(Dune::FieldVector<LhsEval, numEq>& storage,
145 const IntensiveQuantities& intQuants)
147 if constexpr (enableMICP) {
148 const auto& fs = intQuants.fluidState();
151 const LhsEval surfaceVolumeWater =
152 max(Toolbox::template decay<LhsEval>(fs.invB(waterPhaseIdx)) *
153 Toolbox::template decay<LhsEval>(intQuants.porosity()),
157 const LhsEval massMicrobes = surfaceVolumeWater *
158 Toolbox::template decay<LhsEval>(intQuants.microbialConcentration());
159 const LhsEval accumulationMicrobes = massMicrobes;
160 storage[contiMicrobialEqIdx] += accumulationMicrobes;
163 const LhsEval massOxygen = surfaceVolumeWater *
164 Toolbox::template decay<LhsEval>(intQuants.oxygenConcentration());
165 const LhsEval accumulationOxygen = massOxygen;
166 storage[contiOxygenEqIdx] += accumulationOxygen;
169 const LhsEval massUrea = surfaceVolumeWater *
170 Toolbox::template decay<LhsEval>(intQuants.ureaConcentration());
171 const LhsEval accumulationUrea = massUrea;
172 storage[contiUreaEqIdx] += accumulationUrea;
173 storage[contiUreaEqIdx] *= getPropValue<TypeTag, Properties::BlackOilUreaScalingFactor>();
176 const LhsEval massBiofilm = Toolbox::template decay<LhsEval>(intQuants.biofilmConcentration());
177 const LhsEval accumulationBiofilm = massBiofilm;
178 storage[contiBiofilmEqIdx] += accumulationBiofilm;
181 const LhsEval massCalcite = Toolbox::template decay<LhsEval>(intQuants.calciteConcentration());
182 const LhsEval accumulationCalcite = massCalcite;
183 storage[contiCalciteEqIdx] += accumulationCalcite;
187 template <
class UpEval,
class Eval,
class IntensiveQuantities>
189 const Eval& volumeFlux,
190 const IntensiveQuantities& upFs)
192 if constexpr (enableMICP) {
193 flux[contiMicrobialEqIdx] += decay<UpEval>(upFs.microbialConcentration()) * volumeFlux;
194 flux[contiOxygenEqIdx] += decay<UpEval>(upFs.oxygenConcentration()) * volumeFlux;
195 flux[contiUreaEqIdx] += decay<UpEval>(upFs.ureaConcentration()) * volumeFlux;
202 if constexpr (enableMICP) {
203 flux[contiUreaEqIdx] *= getPropValue<TypeTag, Properties::BlackOilUreaScalingFactor>();
208 [[maybe_unused]]
const ElementContext& elemCtx,
209 [[maybe_unused]]
unsigned scvfIdx,
210 [[maybe_unused]]
unsigned timeIdx)
212 if constexpr (enableMICP) {
213 flux[contiMicrobialEqIdx] = 0.0;
214 flux[contiOxygenEqIdx] = 0.0;
215 flux[contiUreaEqIdx] = 0.0;
216 const auto& extQuants = elemCtx.extensiveQuantities(scvfIdx, timeIdx);
217 const unsigned focusIdx = elemCtx.focusDofIndex();
218 const unsigned upIdx = extQuants.upstreamIndex(waterPhaseIdx);
219 if (upIdx == focusIdx) {
220 addMICPFluxes_<Evaluation>(flux, elemCtx, scvfIdx, timeIdx);
223 addMICPFluxes_<Scalar>(flux, elemCtx, scvfIdx, timeIdx);
228 template <
class UpstreamEval>
230 const ElementContext& elemCtx,
234 const auto& extQuants = elemCtx.extensiveQuantities(scvfIdx, timeIdx);
235 const unsigned upIdx = extQuants.upstreamIndex(waterPhaseIdx);
236 const auto& up = elemCtx.intensiveQuantities(upIdx, timeIdx);
237 const auto& fs = up.fluidState();
238 const auto& volFlux = extQuants.volumeFlux(waterPhaseIdx);
239 addMICPFluxes_<UpstreamEval>(flux, volFlux, fs);
244 const Problem& problem,
245 const IntensiveQuantities& intQuants,
246 unsigned globalSpaceIdex)
248 if constexpr (enableMICP) {
249 const auto& velocityInf = problem.model().linearizer().getVelocityInfo();
250 const auto& velocityInfos = velocityInf[globalSpaceIdex];
251 const Scalar normVelocityCell =
252 std::accumulate(velocityInfos.begin(), velocityInfos.end(), 0.0,
253 [](
const auto acc,
const auto& info)
254 { return max(acc, std::abs(info.velocity[waterPhaseIdx])); });
257 const auto b = intQuants.fluidState().invB(waterPhaseIdx);
258 const unsigned satnumIdx = problem.satnumRegionIndex(globalSpaceIdex);
275 const Evaluation k_g =
276 intQuants.oxygenConcentration() < 0
277 ? mu * intQuants.oxygenConcentration() / k_o
278 : mu * intQuants.oxygenConcentration() / (k_o + intQuants.oxygenConcentration());
279 const Evaluation k_c =
280 intQuants.ureaConcentration() < 0
281 ? mu_u * intQuants.ureaConcentration() / k_u
282 : mu_u * intQuants.ureaConcentration() / (k_u + intQuants.ureaConcentration());
285 source[Indices::contiMicrobialEqIdx] += intQuants.microbialConcentration() * intQuants.porosity() *
286 b * (Y_sb * k_g - k_d - k_a) +
287 rho_b * intQuants.biofilmConcentration() * k_str * pow(normVelocityCell, eta);
289 source[Indices::contiOxygenEqIdx] -= (intQuants.microbialConcentration() * intQuants.porosity() *
290 b + rho_b * intQuants.biofilmConcentration()) * F * k_g;
292 source[Indices::contiUreaEqIdx] -= rho_b * intQuants.biofilmConcentration() * k_c;
294 source[Indices::contiBiofilmEqIdx] += intQuants.biofilmConcentration() * (Y_sb * k_g - k_d -
295 k_str * pow(normVelocityCell, eta) - Y_uc * (rho_b / rho_c) *
296 intQuants.biofilmConcentration() * k_c / (intQuants.porosity() +
297 intQuants.biofilmConcentration())) + k_a * intQuants.microbialConcentration() *
298 intQuants.porosity() * b / rho_b;
300 source[Indices::contiCalciteEqIdx] += (rho_b / rho_c) * intQuants.biofilmConcentration() * Y_uc * k_c;
303 source[Indices::contiUreaEqIdx] *= getPropValue<TypeTag, Properties::BlackOilUreaScalingFactor>();
307 static void addSource([[maybe_unused]] RateVector& source,
308 [[maybe_unused]]
const ElementContext& elemCtx,
309 [[maybe_unused]]
unsigned dofIdx,
310 [[maybe_unused]]
unsigned timeIdx)
312 if constexpr (enableMICP) {
313 const auto& problem = elemCtx.problem();
314 const auto& intQuants = elemCtx.intensiveQuantities(dofIdx, timeIdx);
315 addSource(source, problem, intQuants, dofIdx);
320 {
return params_.densityBiofilm_[satnumRegionIdx]; }
323 {
return params_.densityCalcite_[satnumRegionIdx]; }
326 {
return params_.detachmentRate_[satnumRegionIdx]; }
329 {
return params_.detachmentExponent_[satnumRegionIdx]; }
332 {
return params_.halfVelocityOxygen_[satnumRegionIdx]; }
335 {
return params_.halfVelocityUrea_[satnumRegionIdx]; }
338 {
return params_.maximumGrowthRate_[satnumRegionIdx]; }
341 {
return params_.maximumUreaUtilization_[satnumRegionIdx]; }
344 {
return params_.microbialAttachmentRate_[satnumRegionIdx]; }
347 {
return params_.microbialDeathRate_[satnumRegionIdx]; }
350 {
return params_.oxygenConsumptionFactor_[satnumRegionIdx]; }
353 {
return params_.yieldGrowthCoefficient_[satnumRegionIdx]; }
356 {
return params_.yieldUreaToCalciteCoefficient_[satnumRegionIdx]; }
359 {
return params_.microbialDiffusion_[pvtRegionIdx]; }
362 {
return params_.oxygenDiffusion_[pvtRegionIdx]; }
365 {
return params_.ureaDiffusion_[pvtRegionIdx]; }
367 static const TabulatedFunction&
permfactTable(
const ElementContext& elemCtx,
371 const unsigned satnumRegionIdx = elemCtx.problem().satnumRegionIndex(elemCtx, scvIdx, timeIdx);
372 return params_.permfactTable_[satnumRegionIdx];
376 {
return params_.permfactTable_[satnumRegionIdx]; }
382template <
class TypeTag,
bool enableMICPV>
383BlackOilMICPParams<typename BlackOilMICPModule<TypeTag, enableMICPV>::Scalar>
384BlackOilMICPModule<TypeTag, enableMICPV>::params_;
386template <
class TypeTag,
bool enableMICPV>
396template <
class TypeTag>
410 static constexpr int microbialConcentrationIdx = Indices::microbialConcentrationIdx;
411 static constexpr int oxygenConcentrationIdx = Indices::oxygenConcentrationIdx;
412 static constexpr int ureaConcentrationIdx = Indices::ureaConcentrationIdx;
413 static constexpr int biofilmConcentrationIdx = Indices::biofilmConcentrationIdx;
414 static constexpr int calciteConcentrationIdx = Indices::calciteConcentrationIdx;
415 static constexpr int waterPhaseIdx = FluidSystem::waterPhaseIdx;
427 const auto linearizationType = elemCtx.linearizationType();
428 const PrimaryVariables& priVars = elemCtx.primaryVars(dofIdx, timeIdx);
429 const Scalar referencePorosity_ = elemCtx.problem().referencePorosity(dofIdx, timeIdx);
431 microbialConcentration_ = priVars.makeEvaluation(microbialConcentrationIdx, timeIdx, linearizationType);
432 oxygenConcentration_ = priVars.makeEvaluation(oxygenConcentrationIdx, timeIdx, linearizationType);
433 ureaConcentration_ = priVars.makeEvaluation(ureaConcentrationIdx, timeIdx, linearizationType);
434 biofilmConcentration_ = priVars.makeEvaluation(biofilmConcentrationIdx, timeIdx, linearizationType);
435 calciteConcentration_ = priVars.makeEvaluation(calciteConcentrationIdx, timeIdx, linearizationType);
437 const Evaluation porosityFactor = min(1.0 - (biofilmConcentration_ + calciteConcentration_) /
438 (referencePorosity_ + 1e-8),
440 const unsigned satnumRegionIdx = elemCtx.problem().satnumRegionIndex(elemCtx, dofIdx, timeIdx);
441 const auto& permfactTable = MICPModule::permfactTable(satnumRegionIdx);
442 permFactor_ = permfactTable.eval(porosityFactor,
true);
444 biofilmMass_ = referencePorosity_*biofilmConcentration_*MICPModule::densityBiofilm(satnumRegionIdx);
445 calciteMass_ = referencePorosity_*calciteConcentration_*MICPModule::densityCalcite(satnumRegionIdx);
449 {
return microbialConcentration_; }
452 {
return oxygenConcentration_; }
455 {
return ureaConcentration_; }
458 {
return biofilmConcentration_; }
461 {
return calciteConcentration_; }
464 {
return biofilmMass_; }
467 {
return calciteMass_; }
470 {
return permFactor_; }
483template <
class TypeTag>
497 {
throw std::logic_error(
"microbialConcentration() called but MICP is disabled"); }
500 {
throw std::logic_error(
"oxygenConcentration() called but MICP is disabled"); }
503 {
throw std::logic_error(
"ureaConcentration() called but MICP is disabled"); }
506 {
throw std::logic_error(
"biofilmConcentration() called but MICP is disabled"); }
509 {
throw std::logic_error(
"calciteConcentration() called but MICP is disabled"); }
512 {
throw std::logic_error(
"biofilmMass() called but MICP is disabled"); }
515 {
throw std::logic_error(
"calciteMass() called but MICP is disabled"); }
518 {
throw std::logic_error(
"permFactor() called but MICP is disabled"); }
521template <
class TypeTag,
bool enableMICPV>
531template <
class TypeTag>
537template <
class TypeTag>
Contains the parameters required to extend the black-oil model by MICP.
Declares the properties required by the black oil model.
Provides the MICP specific extensive quantities to the generic black-oil module's extensive quantitie...
Definition: blackoilmicpmodules.hh:522
const Evaluation & biofilmMass() const
Definition: blackoilmicpmodules.hh:511
const Evaluation & calciteMass() const
Definition: blackoilmicpmodules.hh:514
const Evaluation & permFactor() const
Definition: blackoilmicpmodules.hh:517
void MICPPropertiesUpdate_(const ElementContext &, unsigned, unsigned)
Definition: blackoilmicpmodules.hh:491
const Evaluation & ureaConcentration() const
Definition: blackoilmicpmodules.hh:502
const Evaluation & oxygenConcentration() const
Definition: blackoilmicpmodules.hh:499
const Evaluation & microbialConcentration() const
Definition: blackoilmicpmodules.hh:496
const Evaluation & calciteConcentration() const
Definition: blackoilmicpmodules.hh:508
const Evaluation & biofilmConcentration() const
Definition: blackoilmicpmodules.hh:505
const Evaluation & permFactor() const
Definition: blackoilmicpmodules.hh:469
Evaluation oxygenConcentration_
Definition: blackoilmicpmodules.hh:474
const Evaluation & microbialConcentration() const
Definition: blackoilmicpmodules.hh:448
const Evaluation & calciteConcentration() const
Definition: blackoilmicpmodules.hh:460
const Evaluation biofilmMass() const
Definition: blackoilmicpmodules.hh:463
void MICPPropertiesUpdate_(const ElementContext &elemCtx, unsigned dofIdx, unsigned timeIdx)
Update the intensive properties needed to handle MICP from the primary variables.
Definition: blackoilmicpmodules.hh:423
const Evaluation & oxygenConcentration() const
Definition: blackoilmicpmodules.hh:451
const Evaluation & ureaConcentration() const
Definition: blackoilmicpmodules.hh:454
Evaluation microbialConcentration_
Definition: blackoilmicpmodules.hh:473
Evaluation calciteConcentration_
Definition: blackoilmicpmodules.hh:477
Evaluation calciteMass_
Definition: blackoilmicpmodules.hh:479
const Evaluation & biofilmConcentration() const
Definition: blackoilmicpmodules.hh:457
const Evaluation calciteMass() const
Definition: blackoilmicpmodules.hh:466
Evaluation ureaConcentration_
Definition: blackoilmicpmodules.hh:475
Evaluation biofilmConcentration_
Definition: blackoilmicpmodules.hh:476
Evaluation biofilmMass_
Definition: blackoilmicpmodules.hh:478
Evaluation permFactor_
Definition: blackoilmicpmodules.hh:480
Provides the volumetric quantities required for the equations needed by the MICP extension of the bla...
Definition: blackoilmicpmodules.hh:387
Contains the high level supplements required to extend the black oil model by MICP.
Definition: blackoilmicpmodules.hh:54
static void registerParameters()
Register all run-time parameters for the black-oil MICP module.
Definition: blackoilmicpmodules.hh:101
static void applyScaling(RateVector &flux)
Definition: blackoilmicpmodules.hh:200
static Scalar microbialDeathRate(unsigned satnumRegionIdx)
Definition: blackoilmicpmodules.hh:346
static Scalar eqWeight(unsigned eqIdx)
Definition: blackoilmicpmodules.hh:134
static Scalar detachmentExponent(unsigned satnumRegionIdx)
Definition: blackoilmicpmodules.hh:328
static void computeFlux(RateVector &flux, const ElementContext &elemCtx, unsigned scvfIdx, unsigned timeIdx)
Definition: blackoilmicpmodules.hh:207
static void addSource(RateVector &source, const ElementContext &elemCtx, unsigned dofIdx, unsigned timeIdx)
Definition: blackoilmicpmodules.hh:307
static Scalar yieldGrowthCoefficient(unsigned satnumRegionIdx)
Definition: blackoilmicpmodules.hh:352
static Scalar oxygenConsumptionFactor(unsigned satnumRegionIdx)
Definition: blackoilmicpmodules.hh:349
static bool eqApplies(unsigned eqIdx)
Definition: blackoilmicpmodules.hh:119
static Scalar ureaDiffusion(unsigned pvtRegionIdx)
Definition: blackoilmicpmodules.hh:364
static Scalar microbialAttachmentRate(unsigned satnumRegionIdx)
Definition: blackoilmicpmodules.hh:343
static void addSource(RateVector &source, const Problem &problem, const IntensiveQuantities &intQuants, unsigned globalSpaceIdex)
Definition: blackoilmicpmodules.hh:243
static Scalar densityBiofilm(unsigned satnumRegionIdx)
Definition: blackoilmicpmodules.hh:319
static void registerOutputModules(Model &model, Simulator &simulator)
Register all MICP specific VTK and ECL output modules.
Definition: blackoilmicpmodules.hh:111
static Scalar maximumGrowthRate(unsigned satnumRegionIdx)
Definition: blackoilmicpmodules.hh:337
static const TabulatedFunction & permfactTable(unsigned satnumRegionIdx)
Definition: blackoilmicpmodules.hh:375
static void addStorage(Dune::FieldVector< LhsEval, numEq > &storage, const IntensiveQuantities &intQuants)
Definition: blackoilmicpmodules.hh:144
static Scalar microbialDiffusion(unsigned pvtRegionIdx)
Definition: blackoilmicpmodules.hh:358
static Scalar detachmentRate(unsigned satnumRegionIdx)
Definition: blackoilmicpmodules.hh:325
static void addMICPFluxes_(RateVector &flux, const ElementContext &elemCtx, unsigned scvfIdx, unsigned timeIdx)
Definition: blackoilmicpmodules.hh:229
static void addMICPFluxes_(RateVector &flux, const Eval &volumeFlux, const IntensiveQuantities &upFs)
Definition: blackoilmicpmodules.hh:188
static void setParams(BlackOilMICPParams< Scalar > &¶ms)
Set parameters.
Definition: blackoilmicpmodules.hh:93
static Scalar yieldUreaToCalciteCoefficient(unsigned satnumRegionIdx)
Definition: blackoilmicpmodules.hh:355
static Scalar densityCalcite(unsigned satnumRegionIdx)
Definition: blackoilmicpmodules.hh:322
static const TabulatedFunction & permfactTable(const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
Definition: blackoilmicpmodules.hh:367
static Scalar oxygenDiffusion(unsigned pvtRegionIdx)
Definition: blackoilmicpmodules.hh:361
static Scalar maximumUreaUtilization(unsigned satnumRegionIdx)
Definition: blackoilmicpmodules.hh:340
static Scalar halfVelocityOxygen(unsigned satnumRegionIdx)
Definition: blackoilmicpmodules.hh:331
static Scalar halfVelocityUrea(unsigned satnumRegionIdx)
Definition: blackoilmicpmodules.hh:334
VTK output module for the MICP model's related quantities.
Definition: vtkblackoilmicpmodule.hpp:54
static void registerParameters()
Register all run-time parameters for the multi-phase VTK output module.
Definition: vtkblackoilmicpmodule.hpp:84
Definition: blackoilboundaryratevector.hh:39
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
Struct holding the parameters for the BlackOilMICPModule class.
Definition: blackoilmicpparams.hpp:44
Tabulated1DFunction< Scalar > TabulatedFunction
Definition: blackoilmicpparams.hpp:50