28#ifndef EWOMS_BLACK_OIL_BRINE_MODULE_HH
29#define EWOMS_BLACK_OIL_BRINE_MODULE_HH
38#include <dune/common/fvector.hh>
48template <class TypeTag, bool enableBrineV = getPropValue<TypeTag, Properties::EnableBrine>()>
64 using Toolbox = MathToolbox<Evaluation>;
68 static constexpr unsigned saltConcentrationIdx = Indices::saltConcentrationIdx;
69 static constexpr unsigned contiBrineEqIdx = Indices::contiBrineEqIdx;
70 static constexpr unsigned waterPhaseIdx = FluidSystem::waterPhaseIdx;
71 static constexpr bool gasEnabled = Indices::gasEnabled;
72 static constexpr bool oilEnabled = Indices::oilEnabled;
73 static constexpr unsigned enableBrine = enableBrineV;
74 static constexpr unsigned enableSaltPrecipitation = getPropValue<TypeTag, Properties::EnableSaltPrecipitation>();
76 static constexpr unsigned numEq = getPropValue<TypeTag, Properties::NumEq>();
77 static constexpr unsigned numPhases = FluidSystem::numPhases;
95 if constexpr (enableBrine)
96 return pvIdx == saltConcentrationIdx;
104 template <
class Flu
idState>
106 const FluidState& fluidState)
108 if constexpr (enableBrine)
109 priVars[saltConcentrationIdx] = fluidState.saltConcentration();
116 return "saltConcentration";
124 return static_cast<Scalar
>(1.0);
129 if constexpr (enableBrine)
130 return eqIdx == contiBrineEqIdx;
135 static std::string
eqName([[maybe_unused]]
unsigned eqIdx)
139 return "conti^brine";
142 static Scalar
eqWeight([[maybe_unused]]
unsigned eqIdx)
147 return static_cast<Scalar
>(1.0);
151 template <
class LhsEval>
152 static void addStorage(Dune::FieldVector<LhsEval, numEq>& storage,
153 const IntensiveQuantities& intQuants)
155 if constexpr (enableBrine) {
156 const auto& fs = intQuants.fluidState();
158 LhsEval surfaceVolumeWater =
159 Toolbox::template decay<LhsEval>(fs.saturation(waterPhaseIdx))
160 * Toolbox::template decay<LhsEval>(fs.invB(waterPhaseIdx))
161 * Toolbox::template decay<LhsEval>(intQuants.porosity());
164 surfaceVolumeWater = max(surfaceVolumeWater, 1e-10);
167 const LhsEval massBrine = surfaceVolumeWater
168 * Toolbox::template decay<LhsEval>(fs.saltConcentration());
170 if (enableSaltPrecipitation){
171 double saltDensity = intQuants.saltDensity();
172 const LhsEval solidSalt =
173 Toolbox::template decay<LhsEval>(intQuants.porosity())
174 / (1.0 - Toolbox::template decay<LhsEval>(intQuants.saltSaturation()) + 1.e-8)
176 * Toolbox::template decay<LhsEval>(intQuants.saltSaturation());
178 storage[contiBrineEqIdx] += massBrine + solidSalt;
180 else { storage[contiBrineEqIdx] += massBrine;}
185 [[maybe_unused]]
const ElementContext& elemCtx,
186 [[maybe_unused]]
unsigned scvfIdx,
187 [[maybe_unused]]
unsigned timeIdx)
190 if constexpr (enableBrine) {
191 const auto& extQuants = elemCtx.extensiveQuantities(scvfIdx, timeIdx);
193 const unsigned upIdx = extQuants.upstreamIndex(FluidSystem::waterPhaseIdx);
194 const unsigned inIdx = extQuants.interiorIndex();
195 const auto& up = elemCtx.intensiveQuantities(upIdx, timeIdx);
197 if (upIdx == inIdx) {
198 flux[contiBrineEqIdx] =
199 extQuants.volumeFlux(waterPhaseIdx)
200 *up.fluidState().invB(waterPhaseIdx)
201 *up.fluidState().saltConcentration();
204 flux[contiBrineEqIdx] =
205 extQuants.volumeFlux(waterPhaseIdx)
206 *decay<Scalar>(up.fluidState().invB(waterPhaseIdx))
207 *decay<Scalar>(up.fluidState().saltConcentration());
221 return static_cast<Scalar
>(0.0);
224 template <
class DofEntity>
225 static void serializeEntity(
const Model& model, std::ostream& outstream,
const DofEntity& dof)
227 if constexpr (enableBrine) {
228 unsigned dofIdx = model.dofMapper().index(dof);
229 const PrimaryVariables& priVars = model.solution(0)[dofIdx];
230 outstream << priVars[saltConcentrationIdx];
234 template <
class DofEntity>
237 if constexpr (enableBrine) {
238 unsigned dofIdx = model.dofMapper().index(dof);
239 PrimaryVariables& priVars0 = model.solution(0)[dofIdx];
240 PrimaryVariables& priVars1 = model.solution(1)[dofIdx];
242 instream >> priVars0[saltConcentrationIdx];
245 priVars1[saltConcentrationIdx] = priVars0[saltConcentrationIdx];
253 unsigned pvtnumRegionIdx = elemCtx.problem().pvtRegionIndex(elemCtx, scvIdx, timeIdx);
254 return params_.referencePressure_[pvtnumRegionIdx];
258 static const TabulatedFunction&
bdensityTable(
const ElementContext& elemCtx,
262 unsigned pvtnumRegionIdx = elemCtx.problem().pvtRegionIndex(elemCtx, scvIdx, timeIdx);
263 return params_.bdensityTable_[pvtnumRegionIdx];
266 static const TabulatedFunction&
pcfactTable(
unsigned satnumRegionIdx)
268 return params_.pcfactTable_[satnumRegionIdx];
271 static const TabulatedFunction&
permfactTable(
const ElementContext& elemCtx,
275 unsigned pvtnumRegionIdx = elemCtx.problem().pvtRegionIndex(elemCtx, scvIdx, timeIdx);
276 return params_.permfactTable_[pvtnumRegionIdx];
281 return params_.permfactTable_[pvtnumRegionIdx];
288 unsigned pvtnumRegionIdx = elemCtx.problem().pvtRegionIndex(elemCtx, scvIdx, timeIdx);
289 return params_.saltsolTable_[pvtnumRegionIdx];
296 unsigned pvtnumRegionIdx = elemCtx.problem().pvtRegionIndex(elemCtx, scvIdx, timeIdx);
297 return params_.saltdenTable_[pvtnumRegionIdx];
302 return !params_.bdensityTable_.empty();
307 return !params_.saltsolTable_.empty();
312 if constexpr (enableSaltPrecipitation)
313 return !params_.pcfactTable_.empty();
319 return params_.saltsolTable_[regionIdx];
327template <
class TypeTag,
bool enableBrineV>
328BlackOilBrineParams<typename BlackOilBrineModule<TypeTag, enableBrineV>::Scalar>
329BlackOilBrineModule<TypeTag, enableBrineV>::params_;
338template <class TypeTag, bool enableBrineV = getPropValue<TypeTag, Properties::EnableBrine>()>
353 enum { numPhases = getPropValue<TypeTag, Properties::NumPhases>() };
354 static constexpr int saltConcentrationIdx = Indices::saltConcentrationIdx;
355 static constexpr int waterPhaseIdx = FluidSystem::waterPhaseIdx;
356 static constexpr int gasPhaseIdx = FluidSystem::gasPhaseIdx;
357 static constexpr int oilPhaseIdx = FluidSystem::oilPhaseIdx;
358 static constexpr unsigned enableBrine = enableBrineV;
359 static constexpr unsigned enableSaltPrecipitation = getPropValue<TypeTag, Properties::EnableSaltPrecipitation>();
360 static constexpr int contiBrineEqIdx = Indices::contiBrineEqIdx;
373 const PrimaryVariables& priVars = elemCtx.primaryVars(dofIdx, timeIdx);
375 auto& fs =
asImp_().fluidState_;
377 if constexpr (enableSaltPrecipitation) {
384 if (priVars.primaryVarsMeaningBrine() == PrimaryVariables::BrineMeaning::Sp) {
385 saltSaturation_ = priVars.makeEvaluation(saltConcentrationIdx, timeIdx);
402 [[maybe_unused]]
unsigned dofIdx,
403 [[maybe_unused]]
unsigned timeIdx)
405 if constexpr (enableSaltPrecipitation) {
406 const Evaluation porosityFactor = min(1.0 -
saltSaturation(), 1.0);
411 for (
unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
412 if (!FluidSystem::phaseIsActive(phaseIdx))
440 {
return *
static_cast<Implementation*
>(
this); }
451template <
class TypeTag>
470 {
throw std::runtime_error(
"saltConcentration() called but brine are disabled"); }
473 {
throw std::runtime_error(
"brineRefDensity() called but brine are disabled"); }
476 {
throw std::logic_error(
"saltSaturation() called but salt precipitation is disabled"); }
479 {
throw std::logic_error(
"saltSolubility() called but salt precipitation is disabled"); }
482 {
throw std::logic_error(
"saltDensity() called but salt precipitation is disabled"); }
485 {
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:459
const Scalar saltDensity() const
Definition: blackoilbrinemodules.hh:481
const Evaluation & permFactor() const
Definition: blackoilbrinemodules.hh:484
const Evaluation & saltSaturation() const
Definition: blackoilbrinemodules.hh:475
void saltPropertiesUpdate_(const ElementContext &, unsigned, unsigned)
Definition: blackoilbrinemodules.hh:464
const Scalar saltSolubility() const
Definition: blackoilbrinemodules.hh:478
const Evaluation & brineRefDensity() const
Definition: blackoilbrinemodules.hh:472
const Evaluation & saltConcentration() const
Definition: blackoilbrinemodules.hh:469
Definition: blackoilbrinemodules.hh:340
void updateSaltConcentration_(const ElementContext &elemCtx, unsigned dofIdx, unsigned timeIdx)
Update the intensive properties needed to handle brine from the primary variables.
Definition: blackoilbrinemodules.hh:369
const Evaluation & brineRefDensity() const
Definition: blackoilbrinemodules.hh:423
const Evaluation & saltSaturation() const
Definition: blackoilbrinemodules.hh:426
Evaluation permFactor_
Definition: blackoilbrinemodules.hh:445
Evaluation refDensity_
Definition: blackoilbrinemodules.hh:443
Scalar saltDensity_
Definition: blackoilbrinemodules.hh:447
const Evaluation & saltConcentration() const
Definition: blackoilbrinemodules.hh:420
Scalar saltSolubility_
Definition: blackoilbrinemodules.hh:446
Implementation & asImp_()
Definition: blackoilbrinemodules.hh:439
Evaluation saltSaturation_
Definition: blackoilbrinemodules.hh:444
Scalar saltDensity() const
Definition: blackoilbrinemodules.hh:432
Evaluation saltConcentration_
Definition: blackoilbrinemodules.hh:442
const Evaluation & permFactor() const
Definition: blackoilbrinemodules.hh:435
Scalar saltSolubility() const
Definition: blackoilbrinemodules.hh:429
void saltPropertiesUpdate_(const ElementContext &elemCtx, unsigned dofIdx, unsigned timeIdx)
Definition: blackoilbrinemodules.hh:401
Contains the high level supplements required to extend the black oil model by brine.
Definition: blackoilbrinemodules.hh:50
static bool hasBDensityTables()
Definition: blackoilbrinemodules.hh:300
static const TabulatedFunction & bdensityTable(const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
Definition: blackoilbrinemodules.hh:258
static void serializeEntity(const Model &model, std::ostream &outstream, const DofEntity &dof)
Definition: blackoilbrinemodules.hh:225
static const TabulatedFunction & permfactTable(unsigned pvtnumRegionIdx)
Definition: blackoilbrinemodules.hh:279
static Scalar saltSol(unsigned regionIdx)
Definition: blackoilbrinemodules.hh:318
static std::string eqName(unsigned eqIdx)
Definition: blackoilbrinemodules.hh:135
static bool primaryVarApplies(unsigned pvIdx)
Definition: blackoilbrinemodules.hh:93
static const TabulatedFunction & pcfactTable(unsigned satnumRegionIdx)
Definition: blackoilbrinemodules.hh:266
static const Scalar saltdenTable(const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
Definition: blackoilbrinemodules.hh:292
static const TabulatedFunction & permfactTable(const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
Definition: blackoilbrinemodules.hh:271
static bool hasPcfactTables()
Definition: blackoilbrinemodules.hh:310
static std::string primaryVarName(unsigned pvIdx)
Definition: blackoilbrinemodules.hh:112
static void setParams(BlackOilBrineParams< Scalar > &¶ms)
Set parameters.
Definition: blackoilbrinemodules.hh:81
static void registerParameters()
Register all run-time parameters for the black-oil brine module.
Definition: blackoilbrinemodules.hh:89
static bool hasSaltsolTables()
Definition: blackoilbrinemodules.hh:305
static Scalar eqWeight(unsigned eqIdx)
Definition: blackoilbrinemodules.hh:142
static const Scalar saltsolTable(const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
Definition: blackoilbrinemodules.hh:284
static Scalar primaryVarWeight(unsigned pvIdx)
Definition: blackoilbrinemodules.hh:119
static void computeFlux(RateVector &flux, const ElementContext &elemCtx, unsigned scvfIdx, unsigned timeIdx)
Definition: blackoilbrinemodules.hh:184
static bool eqApplies(unsigned eqIdx)
Definition: blackoilbrinemodules.hh:127
static void assignPrimaryVars(PrimaryVariables &priVars, const FluidState &fluidState)
Assign the brine specific primary variables to a PrimaryVariables object.
Definition: blackoilbrinemodules.hh:105
static void deserializeEntity(Model &model, std::istream &instream, const DofEntity &dof)
Definition: blackoilbrinemodules.hh:235
static const Scalar & referencePressure(const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
Definition: blackoilbrinemodules.hh:249
static void addStorage(Dune::FieldVector< LhsEval, numEq > &storage, const IntensiveQuantities &intQuants)
Definition: blackoilbrinemodules.hh:152
static Scalar computeUpdateError(const PrimaryVariables &, const EqVector &)
Return how much a Newton-Raphson update is considered an error.
Definition: blackoilbrinemodules.hh:215
Declare the properties used by the infrastructure code of the finite volume discretizations.
Definition: blackoilboundaryratevector.hh:37
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:235
Struct holding the parameters for the BlackoilBrineModule class.
Definition: blackoilbrineparams.hpp:44
Tabulated1DFunction< Scalar > TabulatedFunction
Definition: blackoilbrineparams.hpp:50