28#ifndef EWOMS_BLACK_OIL_BRINE_MODULE_HH
29#define EWOMS_BLACK_OIL_BRINE_MODULE_HH
31#include <dune/common/fvector.hh>
53template <class TypeTag, bool enableBrineV = getPropValue<TypeTag, Properties::EnableBrine>()>
69 using Toolbox = MathToolbox<Evaluation>;
73 static constexpr unsigned saltConcentrationIdx = Indices::saltConcentrationIdx;
74 static constexpr unsigned contiBrineEqIdx = Indices::contiBrineEqIdx;
75 static constexpr unsigned waterPhaseIdx = FluidSystem::waterPhaseIdx;
76 static constexpr bool gasEnabled = Indices::gasEnabled;
77 static constexpr bool oilEnabled = Indices::oilEnabled;
78 static constexpr bool enableBrine = enableBrineV;
79 static constexpr bool enableSaltPrecipitation =
80 getPropValue<TypeTag, Properties::EnableSaltPrecipitation>();
82 static constexpr unsigned numEq = getPropValue<TypeTag, Properties::NumEq>();
83 static constexpr unsigned numPhases = FluidSystem::numPhases;
100 if constexpr (enableBrine) {
101 return pvIdx == saltConcentrationIdx;
111 template <
class Flu
idState>
113 const FluidState& fluidState)
115 if constexpr (enableBrine) {
116 priVars[saltConcentrationIdx] = fluidState.saltConcentration();
124 return "saltConcentration";
132 return static_cast<Scalar
>(1.0);
137 if constexpr (enableBrine) {
138 return eqIdx == contiBrineEqIdx;
145 static std::string
eqName([[maybe_unused]]
unsigned eqIdx)
149 return "conti^brine";
152 static Scalar
eqWeight([[maybe_unused]]
unsigned eqIdx)
157 return static_cast<Scalar
>(1.0);
161 template <
class LhsEval>
162 static void addStorage(Dune::FieldVector<LhsEval, numEq>& storage,
163 const IntensiveQuantities& intQuants)
165 if constexpr (enableBrine) {
166 const auto& fs = intQuants.fluidState();
169 const LhsEval surfaceVolumeWater =
170 max(Toolbox::template decay<LhsEval>(fs.saturation(waterPhaseIdx)) *
171 Toolbox::template decay<LhsEval>(fs.invB(waterPhaseIdx)) *
172 Toolbox::template decay<LhsEval>(intQuants.porosity()),
176 const LhsEval massBrine = surfaceVolumeWater *
177 Toolbox::template decay<LhsEval>(fs.saltConcentration());
179 if constexpr (enableSaltPrecipitation) {
180 const double saltDensity = intQuants.saltDensity();
181 const LhsEval solidSalt =
182 Toolbox::template decay<LhsEval>(intQuants.porosity()) /
183 (1.0 - Toolbox::template decay<LhsEval>(intQuants.saltSaturation()) + 1.e-8) *
185 Toolbox::template decay<LhsEval>(intQuants.saltSaturation());
187 storage[contiBrineEqIdx] += massBrine + solidSalt;
190 storage[contiBrineEqIdx] += massBrine;
196 [[maybe_unused]]
const ElementContext& elemCtx,
197 [[maybe_unused]]
unsigned scvfIdx,
198 [[maybe_unused]]
unsigned timeIdx)
201 if constexpr (enableBrine) {
202 const auto& extQuants = elemCtx.extensiveQuantities(scvfIdx, timeIdx);
204 const unsigned upIdx = extQuants.upstreamIndex(FluidSystem::waterPhaseIdx);
205 const unsigned inIdx = extQuants.interiorIndex();
206 const auto& up = elemCtx.intensiveQuantities(upIdx, timeIdx);
208 if (upIdx == inIdx) {
209 flux[contiBrineEqIdx] =
210 extQuants.volumeFlux(waterPhaseIdx) *
211 up.fluidState().invB(waterPhaseIdx) *
212 up.fluidState().saltConcentration();
215 flux[contiBrineEqIdx] =
216 extQuants.volumeFlux(waterPhaseIdx) *
217 decay<Scalar>(up.fluidState().invB(waterPhaseIdx)) *
218 decay<Scalar>(up.fluidState().saltConcentration());
232 return static_cast<Scalar
>(0.0);
235 template <
class DofEntity>
236 static void serializeEntity(
const Model& model, std::ostream& outstream,
const DofEntity& dof)
238 if constexpr (enableBrine) {
239 const unsigned dofIdx = model.dofMapper().index(dof);
240 const PrimaryVariables& priVars = model.solution(0)[dofIdx];
241 outstream << priVars[saltConcentrationIdx];
245 template <
class DofEntity>
248 if constexpr (enableBrine) {
249 const unsigned dofIdx = model.dofMapper().index(dof);
250 PrimaryVariables& priVars0 = model.solution(0)[dofIdx];
251 PrimaryVariables& priVars1 = model.solution(1)[dofIdx];
253 instream >> priVars0[saltConcentrationIdx];
256 priVars1[saltConcentrationIdx] = priVars0[saltConcentrationIdx];
264 const unsigned pvtnumRegionIdx = elemCtx.problem().pvtRegionIndex(elemCtx, scvIdx, timeIdx);
265 return params_.referencePressure_[pvtnumRegionIdx];
268 static const TabulatedFunction&
bdensityTable(
const ElementContext& elemCtx,
272 const unsigned pvtnumRegionIdx = elemCtx.problem().pvtRegionIndex(elemCtx, scvIdx, timeIdx);
273 return params_.bdensityTable_[pvtnumRegionIdx];
276 static const TabulatedFunction&
pcfactTable(
unsigned satnumRegionIdx)
277 {
return params_.pcfactTable_[satnumRegionIdx]; }
279 static const TabulatedFunction&
permfactTable(
const ElementContext& elemCtx,
283 const unsigned satnumRegionIdx = elemCtx.problem().satnumRegionIndex(elemCtx, scvIdx, timeIdx);
284 return params_.permfactTable_[satnumRegionIdx];
288 {
return params_.permfactTable_[satnumRegionIdx]; }
294 const unsigned pvtnumRegionIdx = elemCtx.problem().pvtRegionIndex(elemCtx, scvIdx, timeIdx);
295 return params_.saltsolTable_[pvtnumRegionIdx];
302 const unsigned pvtnumRegionIdx = elemCtx.problem().pvtRegionIndex(elemCtx, scvIdx, timeIdx);
303 return params_.saltdenTable_[pvtnumRegionIdx];
307 {
return !params_.bdensityTable_.empty(); }
310 {
return !params_.saltsolTable_.empty(); }
314 if constexpr (enableSaltPrecipitation) {
315 return !params_.pcfactTable_.empty();
323 {
return params_.saltsolTable_[regionIdx]; }
329template <
class TypeTag,
bool enableBrineV>
330BlackOilBrineParams<typename BlackOilBrineModule<TypeTag, enableBrineV>::Scalar>
331BlackOilBrineModule<TypeTag, enableBrineV>::params_;
333template <
class TypeTag,
bool enableBrineV>
343template <
class TypeTag>
358 enum { numPhases = getPropValue<TypeTag, Properties::NumPhases>() };
359 static constexpr int saltConcentrationIdx = Indices::saltConcentrationIdx;
360 static constexpr int waterPhaseIdx = FluidSystem::waterPhaseIdx;
361 static constexpr int gasPhaseIdx = FluidSystem::gasPhaseIdx;
362 static constexpr int oilPhaseIdx = FluidSystem::oilPhaseIdx;
363 static constexpr bool enableBrine =
true;
364 static constexpr bool enableSaltPrecipitation =
365 getPropValue<TypeTag, Properties::EnableSaltPrecipitation>();
366 static constexpr int contiBrineEqIdx = Indices::contiBrineEqIdx;
378 const PrimaryVariables& priVars = elemCtx.primaryVars(dofIdx, timeIdx);
380 auto& fs = asImp_().fluidState_;
382 if constexpr (enableSaltPrecipitation) {
383 const auto& saltsolTable = BrineModule::saltsolTable(elemCtx, dofIdx, timeIdx);
384 saltSolubility_ = saltsolTable;
386 const auto& saltdenTable = BrineModule::saltdenTable(elemCtx, dofIdx, timeIdx);
387 saltDensity_ = saltdenTable;
389 if (priVars.primaryVarsMeaningBrine() == PrimaryVariables::BrineMeaning::Sp) {
390 saltSaturation_ = priVars.makeEvaluation(saltConcentrationIdx, timeIdx);
391 fs.setSaltConcentration(saltSolubility_);
394 saltConcentration_ = priVars.makeEvaluation(saltConcentrationIdx, timeIdx);
395 fs.setSaltConcentration(saltConcentration_);
396 saltSaturation_ = 0.0;
398 fs.setSaltSaturation(saltSaturation_);
401 saltConcentration_ = priVars.makeEvaluation(saltConcentrationIdx, timeIdx);
402 fs.setSaltConcentration(saltConcentration_);
407 [[maybe_unused]]
unsigned dofIdx,
408 [[maybe_unused]]
unsigned timeIdx)
410 if constexpr (enableSaltPrecipitation) {
411 const Evaluation porosityFactor = min(1.0 - saltSaturation(), 1.0);
413 const auto& permfactTable = BrineModule::permfactTable(elemCtx, dofIdx, timeIdx);
415 permFactor_ = permfactTable.eval(porosityFactor);
416 for (
unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
417 if (!FluidSystem::phaseIsActive(phaseIdx)) {
421 asImp_().mobility_[phaseIdx] *= permFactor_;
427 {
return saltConcentration_; }
430 {
return refDensity_; }
433 {
return saltSaturation_; }
436 {
return saltSolubility_; }
439 {
return saltDensity_; }
442 {
return permFactor_; }
446 {
return *
static_cast<Implementation*
>(
this); }
456template <
class TypeTag>
475 {
throw std::runtime_error(
"saltConcentration() called but brine are disabled"); }
478 {
throw std::runtime_error(
"brineRefDensity() called but brine are disabled"); }
481 {
throw std::logic_error(
"saltSaturation() called but salt precipitation is disabled"); }
484 {
throw std::logic_error(
"saltSolubility() called but salt precipitation is disabled"); }
487 {
throw std::logic_error(
"saltDensity() called but salt precipitation is disabled"); }
490 {
throw std::logic_error(
"permFactor() called but salt precipitation is disabled"); }
Defines a type tags and some fundamental properties all models.
Contains the parameters required to extend the black-oil model by brine.
Declares the properties required by the black oil model.
void updateSaltConcentration_(const ElementContext &, unsigned, unsigned)
Definition: blackoilbrinemodules.hh:464
const Scalar saltDensity() const
Definition: blackoilbrinemodules.hh:486
const Evaluation & permFactor() const
Definition: blackoilbrinemodules.hh:489
const Evaluation & saltSaturation() const
Definition: blackoilbrinemodules.hh:480
void saltPropertiesUpdate_(const ElementContext &, unsigned, unsigned)
Definition: blackoilbrinemodules.hh:469
const Scalar saltSolubility() const
Definition: blackoilbrinemodules.hh:483
const Evaluation & brineRefDensity() const
Definition: blackoilbrinemodules.hh:477
const Evaluation & saltConcentration() const
Definition: blackoilbrinemodules.hh:474
void updateSaltConcentration_(const ElementContext &elemCtx, unsigned dofIdx, unsigned timeIdx)
Update the intensive properties needed to handle brine from the primary variables.
Definition: blackoilbrinemodules.hh:374
Evaluation refDensity_
Definition: blackoilbrinemodules.hh:449
const Evaluation & saltSaturation() const
Definition: blackoilbrinemodules.hh:432
const Evaluation & brineRefDensity() const
Definition: blackoilbrinemodules.hh:429
Evaluation permFactor_
Definition: blackoilbrinemodules.hh:451
Evaluation saltConcentration_
Definition: blackoilbrinemodules.hh:448
Scalar saltSolubility_
Definition: blackoilbrinemodules.hh:452
const Evaluation & permFactor() const
Definition: blackoilbrinemodules.hh:441
const Evaluation & saltConcentration() const
Definition: blackoilbrinemodules.hh:426
Scalar saltDensity_
Definition: blackoilbrinemodules.hh:453
Evaluation saltSaturation_
Definition: blackoilbrinemodules.hh:450
Scalar saltSolubility() const
Definition: blackoilbrinemodules.hh:435
Implementation & asImp_()
Definition: blackoilbrinemodules.hh:445
void saltPropertiesUpdate_(const ElementContext &elemCtx, unsigned dofIdx, unsigned timeIdx)
Definition: blackoilbrinemodules.hh:406
Scalar saltDensity() const
Definition: blackoilbrinemodules.hh:438
Definition: blackoilbrinemodules.hh:334
Contains the high level supplements required to extend the black oil model by brine.
Definition: blackoilbrinemodules.hh:55
static bool hasBDensityTables()
Definition: blackoilbrinemodules.hh:306
static const TabulatedFunction & bdensityTable(const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
Definition: blackoilbrinemodules.hh:268
static void serializeEntity(const Model &model, std::ostream &outstream, const DofEntity &dof)
Definition: blackoilbrinemodules.hh:236
static Scalar saltSol(unsigned regionIdx)
Definition: blackoilbrinemodules.hh:322
static std::string eqName(unsigned eqIdx)
Definition: blackoilbrinemodules.hh:145
static bool primaryVarApplies(unsigned pvIdx)
Definition: blackoilbrinemodules.hh:98
static const TabulatedFunction & pcfactTable(unsigned satnumRegionIdx)
Definition: blackoilbrinemodules.hh:276
static const Scalar saltdenTable(const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
Definition: blackoilbrinemodules.hh:298
static const TabulatedFunction & permfactTable(const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
Definition: blackoilbrinemodules.hh:279
static bool hasPcfactTables()
Definition: blackoilbrinemodules.hh:312
static std::string primaryVarName(unsigned pvIdx)
Definition: blackoilbrinemodules.hh:120
static void setParams(BlackOilBrineParams< Scalar > &¶ms)
Set parameters.
Definition: blackoilbrinemodules.hh:87
static void registerParameters()
Register all run-time parameters for the black-oil brine module.
Definition: blackoilbrinemodules.hh:95
static const TabulatedFunction & permfactTable(unsigned satnumRegionIdx)
Definition: blackoilbrinemodules.hh:287
static bool hasSaltsolTables()
Definition: blackoilbrinemodules.hh:309
static Scalar eqWeight(unsigned eqIdx)
Definition: blackoilbrinemodules.hh:152
static const Scalar saltsolTable(const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
Definition: blackoilbrinemodules.hh:290
static Scalar primaryVarWeight(unsigned pvIdx)
Definition: blackoilbrinemodules.hh:127
static void computeFlux(RateVector &flux, const ElementContext &elemCtx, unsigned scvfIdx, unsigned timeIdx)
Definition: blackoilbrinemodules.hh:195
static bool eqApplies(unsigned eqIdx)
Definition: blackoilbrinemodules.hh:135
static void assignPrimaryVars(PrimaryVariables &priVars, const FluidState &fluidState)
Assign the brine specific primary variables to a PrimaryVariables object.
Definition: blackoilbrinemodules.hh:112
static void deserializeEntity(Model &model, std::istream &instream, const DofEntity &dof)
Definition: blackoilbrinemodules.hh:246
static const Scalar & referencePressure(const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
Definition: blackoilbrinemodules.hh:260
static void addStorage(Dune::FieldVector< LhsEval, numEq > &storage, const IntensiveQuantities &intQuants)
Definition: blackoilbrinemodules.hh:162
static Scalar computeUpdateError(const PrimaryVariables &, const EqVector &)
Return how much a Newton-Raphson update is considered an error.
Definition: blackoilbrinemodules.hh:226
Declare the properties used by the infrastructure code of the finite volume discretizations.
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 BlackoilBrineModule class.
Definition: blackoilbrineparams.hpp:44
Tabulated1DFunction< Scalar > TabulatedFunction
Definition: blackoilbrineparams.hpp:50