87 using typename FlowProblemType::Scalar;
88 using typename FlowProblemType::Simulator;
89 using typename FlowProblemType::GridView;
90 using typename FlowProblemType::FluidSystem;
91 using typename FlowProblemType::Vanguard;
92 using typename FlowProblemType::GlobalEqVector;
93 using typename FlowProblemType::EqVector;
94 using FlowProblemType::dim;
95 using FlowProblemType::dimWorld;
96 using FlowProblemType::numEq;
97 using FlowProblemType::numPhases;
98 using FlowProblemType::numComponents;
101 using FlowProblemType::enableConvectiveMixing;
102 using FlowProblemType::enableBrine;
103 using FlowProblemType::enableDiffusion;
104 using FlowProblemType::enableDispersion;
105 using FlowProblemType::enableEnergy;
106 using FlowProblemType::enableExperiments;
107 using FlowProblemType::enableExtbo;
108 using FlowProblemType::enableFoam;
109 using FlowProblemType::enableMICP;
110 using FlowProblemType::enablePolymer;
111 using FlowProblemType::enablePolymerMolarWeight;
112 using FlowProblemType::enableSaltPrecipitation;
113 using FlowProblemType::enableSolvent;
114 using FlowProblemType::enableTemperature;
115 using FlowProblemType::enableThermalFluxBoundaries;
117 using FlowProblemType::gasPhaseIdx;
118 using FlowProblemType::oilPhaseIdx;
119 using FlowProblemType::waterPhaseIdx;
121 using FlowProblemType::waterCompIdx;
122 using FlowProblemType::oilCompIdx;
123 using FlowProblemType::gasCompIdx;
126 using typename FlowProblemType::RateVector;
127 using typename FlowProblemType::PrimaryVariables;
128 using typename FlowProblemType::Indices;
129 using typename FlowProblemType::IntensiveQuantities;
130 using typename FlowProblemType::ElementContext;
132 using typename FlowProblemType::MaterialLaw;
133 using typename FlowProblemType::DimMatrix;
146 using InitialFluidState =
typename EquilInitializer<TypeTag>::ScalarFluidState;
164 EclWriterType::registerParameters();
166 DamarisWriterType::registerParameters();
176 , thresholdPressures_(simulator)
177 , mixControls_(simulator.vanguard().schedule())
178 , actionHandler_(simulator.vanguard().eclState(),
179 simulator.vanguard().schedule(),
180 simulator.vanguard().actionState(),
181 simulator.vanguard().summaryState(),
183 simulator.vanguard().grid().comm())
188 const auto& vanguard = simulator.vanguard();
192 enableSaltPrecipitation>(vanguard.eclState());
195 DiffusionModule::initFromState(vanguard.eclState());
196 DispersionModule::initFromState(vanguard.eclState());
219 eclWriter_ = std::make_unique<EclWriterType>(simulator);
220 enableEclOutput_ = Parameters::Get<Parameters::EnableEclOutput>();
225 enableDamarisOutput_ = Parameters::Get<Parameters::EnableDamarisOutput>();
236 auto& simulator = this->simulator();
238 const int episodeIdx = simulator.episodeIndex();
239 const auto& schedule = simulator.vanguard().schedule();
244 .evalUDQAssignments(
episodeIdx, simulator.vanguard().udqState());
248 if (
oilVap.getType() == OilVaporizationProperties::OilVaporization::VAPPARS) {
252 FluidSystem::setVapPars(0.0, 0.0);
256 ConvectiveMixingModule::beginEpisode(simulator.vanguard().eclState(), schedule,
episodeIdx,
257 this->moduleParams_.convectiveMixingModuleParam);
268 FlowProblemType::finishInit();
270 auto& simulator = this->simulator();
276 this->transmissibilities_.finishInit([&
vg = this->simulator().vanguard()](
const unsigned int it) {
277 return vg.gridIdxToEquilGridIdx(it);
287 if (enableEclOutput_) {
288 if (simulator.vanguard().grid().comm().size() > 1) {
289 if (simulator.vanguard().grid().comm().rank() == 0)
290 eclWriter_->setTransmissibilities(&simulator.vanguard().globalTransmissibility());
293 eclWriter_->setTransmissibilities(&simulator.problem().eclTransmissibilities());
296 std::function<
unsigned int(
unsigned int)>
equilGridToGrid = [&simulator](
unsigned int i) {
297 return simulator.vanguard().gridEquilIdxToGridIdx(i);
302 simulator.vanguard().releaseGlobalTransmissibilities();
304 const auto& eclState = simulator.vanguard().eclState();
305 const auto& schedule = simulator.vanguard().schedule();
308 simulator.setStartTime(schedule.getStartTime());
309 simulator.setEndTime(schedule.simTime(schedule.size() - 1));
315 simulator.setEpisodeIndex(-1);
316 simulator.setEpisodeLength(0.0);
321 this->gravity_ = 0.0;
322 if (Parameters::Get<Parameters::EnableGravity>() &&
323 eclState.getInitConfig().hasGravity())
326 this->gravity_[dim - 1] = unit::gravity;
329 if (this->enableTuning_) {
332 const auto&
tuning = schedule[0].tuning();
333 this->initialTimeStepSize_ =
tuning.TSINIT.has_value() ?
tuning.TSINIT.value() : -1.0;
334 this->maxTimeStepAfterWellEvent_ =
tuning.TMAXWC;
337 this->initFluidSystem_();
339 if (FluidSystem::phaseIsActive(FluidSystem::oilPhaseIdx) &&
340 FluidSystem::phaseIsActive(FluidSystem::gasPhaseIdx)) {
341 this->maxOilSaturation_.resize(this->model().numGridDof(), 0.0);
344 this->readRockParameters_(simulator.vanguard().cellCenterDepths(),
345 [&simulator](
const unsigned idx)
347 std::array<int,dim> coords;
348 simulator.vanguard().cartesianCoordinate(idx, coords);
349 for (auto& c : coords) {
355 this->readMaterialParameters_();
356 this->readThermalParameters_();
359 if (enableEclOutput_) {
360 this->eclWriter_->writeInit();
365 const auto&
initconfig = eclState.getInitConfig();
366 this->tracerModel_.init(
initconfig.restartRequested());
368 this->readEclRestartSolution_();
371 this->readInitialCondition_();
374 this->tracerModel_.prepareTracerBatches();
376 this->updatePffDofData_();
379 const auto& vanguard = this->simulator().vanguard();
380 const auto& gridView = vanguard.gridView();
382 this->polymer_.maxAdsorption.resize(
numElements, 0.0);
385 this->readBoundaryConditions_();
388 this->computeAndSetEqWeights_();
390 if (this->enableDriftCompensation_) {
391 this->drift_.resize(this->model().numGridDof());
398 if (!
initconfig.restartRequested() && !eclState.getIOConfig().initOnly()) {
399 simulator.startNextEpisode(schedule.seconds(1));
400 simulator.setEpisodeIndex(0);
401 simulator.setTimeStepIndex(0);
404 if (Parameters::Get<Parameters::CheckSatfuncConsistency>() &&
405 ! this->satfuncConsistencyRequirementsMet())
414 this->simulator().vanguard().grid().comm().barrier();
416 throw std::domain_error {
417 "Saturation function end-points do not "
418 "meet requisite consistency conditions"
425 this->mixControls_.init(this->model().numGridDof(),
426 this->episodeIndex(),
427 eclState.runspec().tabdims().getNumPVTTables());
429 if (this->enableVtkOutput_() && eclState.getIOConfig().initOnly()) {
430 simulator.setTimeStepSize(0.0);
431 simulator.model().applyInitialSolution();
441 FlowProblemType::endTimeStep();
442 this->endStepApplyAction();
445 void endStepApplyAction()
449 this->eclWriter().mutableOutputModule().invalidateLocalData();
452 const auto& grid = this->simulator().vanguard().gridView().grid();
454 using GridType = std::remove_cv_t<std::remove_reference_t<
decltype(grid)>>;
455 constexpr bool isCpGrid = std::is_same_v<GridType, Dune::CpGrid>;
456 if (!
isCpGrid || (grid.maxLevel() == 0)) {
457 const bool isSubStep = !this->simulator().episodeWillBeOver();
459 this->eclWriter_->evalSummaryState(
isSubStep);
466 auto& simulator = this->simulator();
470 this->simulator().vanguard().schedule().clearEvents(
episodeIdx);
474 .applyActions(
episodeIdx, simulator.time() + simulator.timeStepSize(),
475 [
this](
const bool global)
477 using TransUpdateQuantities = typename
478 Vanguard::TransmissibilityType::TransUpdateQuantities;
480 this->transmissibilities_
481 .update(global, TransUpdateQuantities::All,
482 [&vg = this->simulator().vanguard()]
483 (const unsigned int i)
485 return vg.gridIdxToEquilGridIdx(i);
491 if constexpr (enableMICP) {
492 auto& model = this->model();
493 const auto& residual = model.linearizer().residual();
495 for (
unsigned globalDofIdx = 0; globalDofIdx < residual.size(); ++globalDofIdx) {
496 auto& phi = this->referencePorosity_[1][globalDofIdx];
497 MICPModule::checkCloggingMICP(model, phi, globalDofIdx);
507 OPM_TIMEBLOCK(endEpisode);
520 .evalUDQAssignments(this->episodeIndex(), this->simulator().vanguard().udqState());
522 FlowProblemType::endEpisode();
527 if (this->enableEclOutput_) {
528 this->eclWriter_->writeReports(timer);
539 FlowProblemType::writeOutput(verbose);
541 bool isSubStep = !this->simulator().episodeWillBeOver();
543 data::Solution localCellData = {};
547 if (enableDamarisOutput_) {
548 damarisWriter_->writeOutput(localCellData, isSubStep) ;
551 if (enableEclOutput_){
552 eclWriter_->writeOutput(std::move(localCellData), isSubStep);
556 void finalizeOutput()
558 OPM_TIMEBLOCK(finalizeOutput);
570 FlowProblemType::initialSolutionApplied();
575 this->thresholdPressures_.finishInit();
578 const auto& grid = this->simulator().vanguard().gridView().grid();
580 using GridType = std::remove_cv_t<std::remove_reference_t<
decltype(grid)>>;
581 constexpr bool isCpGrid = std::is_same_v<GridType, Dune::CpGrid>;
583 if (!isCpGrid || (grid.maxLevel() == 0)) {
584 if (this->simulator().episodeIndex() == 0) {
585 eclWriter_->writeInitialFIPReport();
590 void addToSourceDense(RateVector& rate,
591 unsigned globalDofIdx,
592 unsigned timeIdx)
const override
594 this->aquiferModel_.addToSource(rate, globalDofIdx, timeIdx);
597 const auto& source = this->simulator().vanguard().schedule()[this->episodeIndex()].source();
598 std::array<int,3> ijk;
599 this->simulator().vanguard().cartesianCoordinate(globalDofIdx, ijk);
601 if (source.hasSource(ijk)) {
602 const int pvtRegionIdx = this->pvtRegionIndex(globalDofIdx);
603 static std::array<SourceComponent, 3> sc_map = {SourceComponent::WATER, SourceComponent::OIL, SourceComponent::GAS};
604 static std::array<int, 3> phidx_map = {FluidSystem::waterPhaseIdx, FluidSystem::oilPhaseIdx, FluidSystem::gasPhaseIdx};
605 static std::array<int, 3> cidx_map = {waterCompIdx, oilCompIdx, gasCompIdx};
607 for (
unsigned i = 0; i < phidx_map.size(); ++i) {
608 const auto phaseIdx = phidx_map[i];
609 const auto sourceComp = sc_map[i];
610 const auto compIdx = cidx_map[i];
611 if (!FluidSystem::phaseIsActive(phaseIdx)) {
614 Scalar mass_rate = source.rate({ijk, sourceComp}) / this->model().dofTotalVolume(globalDofIdx);
615 if constexpr (getPropValue<TypeTag, Properties::BlackoilConserveSurfaceVolume>()) {
616 mass_rate /= FluidSystem::referenceDensity(phaseIdx, pvtRegionIdx);
618 rate[Indices::canonicalToActiveComponentIndex(compIdx)] += mass_rate;
621 if constexpr (enableSolvent) {
622 Scalar mass_rate = source.rate({ijk, SourceComponent::SOLVENT}) / this->model().dofTotalVolume(globalDofIdx);
623 if constexpr (getPropValue<TypeTag, Properties::BlackoilConserveSurfaceVolume>()) {
624 const auto& solventPvt = SolventModule::solventPvt();
625 mass_rate /= solventPvt.referenceDensity(pvtRegionIdx);
627 rate[Indices::contiSolventEqIdx] += mass_rate;
629 if constexpr (enablePolymer) {
630 rate[Indices::polymerConcentrationIdx] += source.rate({ijk, SourceComponent::POLYMER}) / this->model().dofTotalVolume(globalDofIdx);
632 if constexpr (enableEnergy) {
633 for (
unsigned i = 0; i < phidx_map.size(); ++i) {
634 const auto phaseIdx = phidx_map[i];
635 if (!FluidSystem::phaseIsActive(phaseIdx)) {
638 const auto sourceComp = sc_map[i];
639 if (source.hasHrate({ijk, sourceComp})) {
640 rate[Indices::contiEnergyEqIdx] += source.hrate({ijk, sourceComp}) / this->model().dofTotalVolume(globalDofIdx);
642 const auto& intQuants = this->simulator().model().intensiveQuantities(globalDofIdx, 0);
643 auto fs = intQuants.fluidState();
645 if (source.hasTemperature({ijk, sourceComp})) {
646 Scalar temperature = source.temperature({ijk, sourceComp});
647 fs.setTemperature(temperature);
649 const auto& h = FluidSystem::enthalpy(fs, phaseIdx, pvtRegionIdx);
650 Scalar mass_rate = source.rate({ijk, sourceComp})/ this->model().dofTotalVolume(globalDofIdx);
651 Scalar energy_rate = getValue(h)*mass_rate;
652 rate[Indices::contiEnergyEqIdx] += energy_rate;
660 if (this->enableDriftCompensation_) {
661 const auto& simulator = this->simulator();
662 const auto& model = this->model();
667 Scalar maxCompensation = model.newtonMethod().tolerance()/10;
668 Scalar poro = this->porosity(globalDofIdx, timeIdx);
669 Scalar dt = simulator.timeStepSize();
670 EqVector dofDriftRate = this->drift_[globalDofIdx];
671 dofDriftRate /= dt*model.dofTotalVolume(globalDofIdx);
674 for (
unsigned eqIdx = 0; eqIdx < numEq; ++ eqIdx) {
675 Scalar cnv = std::abs(dofDriftRate[eqIdx])*dt*model.eqWeight(globalDofIdx, eqIdx)/poro;
676 if (cnv > maxCompensation) {
677 dofDriftRate[eqIdx] *= maxCompensation/cnv;
681 for (
unsigned eqIdx = 0; eqIdx < numEq; ++ eqIdx)
682 rate[eqIdx] -= dofDriftRate[eqIdx];
691 template <
class LhsEval>
694 OPM_TIMEBLOCK_LOCAL(permFactTransMultiplier);
695 if (!enableSaltPrecipitation)
698 const auto& fs = intQuants.fluidState();
699 unsigned tableIdx = this->simulator().problem().satnumRegionIndex(elementIdx);
701 LhsEval porosityFactor = decay<LhsEval>(1. - fs.saltSaturation());
702 porosityFactor = min(porosityFactor, 1.0);
703 const auto& permfactTable = BrineModule::permfactTable(tableIdx);
704 return permfactTable.eval(porosityFactor,
true);
708 const InitialFluidState& initialFluidState(
unsigned globalDofIdx)
const
709 {
return initialFluidStates_[globalDofIdx]; }
711 std::vector<InitialFluidState>& initialFluidStates()
712 {
return initialFluidStates_; }
714 const std::vector<InitialFluidState>& initialFluidStates()
const
715 {
return initialFluidStates_; }
717 const EclipseIO& eclIO()
const
718 {
return eclWriter_->eclIO(); }
720 void setSubStepReport(
const SimulatorReportSingle& report)
721 {
return eclWriter_->setSubStepReport(report); }
723 void setSimulationReport(
const SimulatorReport& report)
724 {
return eclWriter_->setSimulationReport(report); }
726 InitialFluidState boundaryFluidState(
unsigned globalDofIdx,
const int directionId)
const
728 OPM_TIMEBLOCK_LOCAL(boundaryFluidState);
729 const auto& bcprop = this->simulator().vanguard().schedule()[this->episodeIndex()].bcprop;
730 if (bcprop.size() > 0) {
731 FaceDir::DirEnum dir = FaceDir::FromIntersectionIndex(directionId);
735 if (this->bcindex_(dir)[globalDofIdx] == 0)
736 return initialFluidStates_[globalDofIdx];
738 const auto& bc = bcprop[this->bcindex_(dir)[globalDofIdx]];
739 if (bc.bctype == BCType::DIRICHLET )
741 InitialFluidState fluidState;
742 const int pvtRegionIdx = this->pvtRegionIndex(globalDofIdx);
743 fluidState.setPvtRegionIndex(pvtRegionIdx);
745 switch (bc.component) {
746 case BCComponent::OIL:
747 if (!FluidSystem::phaseIsActive(FluidSystem::oilPhaseIdx))
748 throw std::logic_error(
"oil is not active and you're trying to add oil BC");
750 fluidState.setSaturation(FluidSystem::oilPhaseIdx, 1.0);
752 case BCComponent::GAS:
753 if (!FluidSystem::phaseIsActive(FluidSystem::gasPhaseIdx))
754 throw std::logic_error(
"gas is not active and you're trying to add gas BC");
756 fluidState.setSaturation(FluidSystem::gasPhaseIdx, 1.0);
758 case BCComponent::WATER:
759 if (!FluidSystem::phaseIsActive(FluidSystem::waterPhaseIdx))
760 throw std::logic_error(
"water is not active and you're trying to add water BC");
762 fluidState.setSaturation(FluidSystem::waterPhaseIdx, 1.0);
764 case BCComponent::SOLVENT:
765 case BCComponent::POLYMER:
766 case BCComponent::NONE:
767 throw std::logic_error(
"you need to specify a valid component (OIL, WATER or GAS) when DIRICHLET type is set in BC");
769 fluidState.setTotalSaturation(1.0);
770 double pressure = initialFluidStates_[globalDofIdx].pressure(this->refPressurePhaseIdx_());
771 const auto pressure_input = bc.pressure;
772 if (pressure_input) {
773 pressure = *pressure_input;
776 std::array<Scalar, numPhases> pc = {0};
777 const auto& matParams = this->materialLawParams(globalDofIdx);
778 MaterialLaw::capillaryPressures(pc, matParams, fluidState);
779 Valgrind::CheckDefined(pressure);
780 Valgrind::CheckDefined(pc);
781 for (
unsigned activePhaseIdx = 0; activePhaseIdx < FluidSystem::numActivePhases(); ++activePhaseIdx) {
782 const auto phaseIdx = FluidSystem::activeToCanonicalPhaseIdx(activePhaseIdx);
784 fluidState.setPc(phaseIdx, pc[phaseIdx]);
785 if (Indices::oilEnabled)
786 fluidState.setPressure(phaseIdx, pressure + (pc[phaseIdx] - pc[oilPhaseIdx]));
787 else if (Indices::gasEnabled)
788 fluidState.setPressure(phaseIdx, pressure + (pc[phaseIdx] - pc[gasPhaseIdx]));
789 else if (Indices::waterEnabled)
791 fluidState.setPressure(phaseIdx, pressure);
794 double temperature = initialFluidStates_[globalDofIdx].temperature(0);
795 const auto temperature_input = bc.temperature;
796 if(temperature_input)
797 temperature = *temperature_input;
798 fluidState.setTemperature(temperature);
800 if (FluidSystem::enableDissolvedGas()) {
801 fluidState.setRs(0.0);
802 fluidState.setRv(0.0);
804 if (FluidSystem::enableDissolvedGasInWater()) {
805 fluidState.setRsw(0.0);
807 if (FluidSystem::enableVaporizedWater())
808 fluidState.setRvw(0.0);
810 for (
unsigned activePhaseIdx = 0; activePhaseIdx < FluidSystem::numActivePhases(); ++activePhaseIdx) {
811 const auto phaseIdx = FluidSystem::activeToCanonicalPhaseIdx(activePhaseIdx);
813 const auto& b = FluidSystem::inverseFormationVolumeFactor(fluidState, phaseIdx, pvtRegionIdx);
814 fluidState.setInvB(phaseIdx, b);
816 const auto& rho = FluidSystem::density(fluidState, phaseIdx, pvtRegionIdx);
817 fluidState.setDensity(phaseIdx, rho);
819 const auto& h = FluidSystem::enthalpy(fluidState, phaseIdx, pvtRegionIdx);
820 fluidState.setEnthalpy(phaseIdx, h);
823 fluidState.checkDefined();
827 return initialFluidStates_[globalDofIdx];
831 const EclWriterType& eclWriter()
const
832 {
return *eclWriter_; }
834 EclWriterType& eclWriter()
835 {
return *eclWriter_; }
843 return this->mixControls_.maxGasDissolutionFactor(timeIdx, globalDofIdx,
844 this->episodeIndex(),
845 this->pvtRegionIndex(globalDofIdx));
854 return this->mixControls_.maxOilVaporizationFactor(timeIdx, globalDofIdx,
855 this->episodeIndex(),
856 this->pvtRegionIndex(globalDofIdx));
869 int episodeIdx = this->episodeIndex();
870 return !this->mixControls_.drsdtActive(episodeIdx) &&
871 !this->mixControls_.drvdtActive(episodeIdx) &&
872 this->rockCompPoroMultWc_.empty() &&
873 this->rockCompPoroMult_.empty();
882 template <
class Context>
883 void initial(PrimaryVariables& values,
const Context& context,
unsigned spaceIdx,
unsigned timeIdx)
const
885 unsigned globalDofIdx = context.globalSpaceIndex(spaceIdx, timeIdx);
887 values.setPvtRegionIndex(pvtRegionIndex(context, spaceIdx, timeIdx));
888 values.assignNaive(initialFluidStates_[globalDofIdx]);
890 SolventModule::assignPrimaryVars(values,
891 enableSolvent ? this->solventSaturation_[globalDofIdx] : 0.0,
892 enableSolvent ? this->solventRsw_[globalDofIdx] : 0.0);
894 if constexpr (enablePolymer)
895 values[Indices::polymerConcentrationIdx] = this->polymer_.concentration[globalDofIdx];
897 if constexpr (enablePolymerMolarWeight)
898 values[Indices::polymerMoleWeightIdx]= this->polymer_.moleWeight[globalDofIdx];
900 if constexpr (enableBrine) {
901 if (enableSaltPrecipitation && values.primaryVarsMeaningBrine() == PrimaryVariables::BrineMeaning::Sp) {
902 values[Indices::saltConcentrationIdx] = initialFluidStates_[globalDofIdx].saltSaturation();
905 values[Indices::saltConcentrationIdx] = initialFluidStates_[globalDofIdx].saltConcentration();
909 if constexpr (enableMICP){
910 values[Indices::microbialConcentrationIdx] = this->micp_.microbialConcentration[globalDofIdx];
911 values[Indices::oxygenConcentrationIdx]= this->micp_.oxygenConcentration[globalDofIdx];
912 values[Indices::ureaConcentrationIdx]= this->micp_.ureaConcentration[globalDofIdx];
913 values[Indices::calciteConcentrationIdx]= this->micp_.calciteConcentration[globalDofIdx];
914 values[Indices::biofilmConcentrationIdx]= this->micp_.biofilmConcentration[globalDofIdx];
917 values.checkDefined();
921 Scalar drsdtcon(
unsigned elemIdx,
int episodeIdx)
const
923 return this->mixControls_.drsdtcon(elemIdx, episodeIdx,
924 this->pvtRegionIndex(elemIdx));
932 template <
class Context>
934 const Context& context,
936 unsigned timeIdx)
const
938 OPM_TIMEBLOCK_LOCAL(eclProblemBoundary);
939 if (!context.intersection(spaceIdx).boundary())
942 if constexpr (!enableEnergy || !enableThermalFluxBoundaries)
950 unsigned interiorDofIdx = context.interiorScvIndex(spaceIdx, timeIdx);
951 unsigned globalDofIdx = context.globalSpaceIndex(interiorDofIdx, timeIdx);
952 values.setThermalFlow(context, spaceIdx, timeIdx, this->initialFluidStates_[globalDofIdx] );
955 if (this->nonTrivialBoundaryConditions()) {
956 unsigned indexInInside = context.intersection(spaceIdx).indexInInside();
957 unsigned interiorDofIdx = context.interiorScvIndex(spaceIdx, timeIdx);
958 unsigned globalDofIdx = context.globalSpaceIndex(interiorDofIdx, timeIdx);
959 unsigned pvtRegionIdx = pvtRegionIndex(context, spaceIdx, timeIdx);
960 const auto [type, massrate] = this->boundaryCondition(globalDofIdx, indexInInside);
961 if (type == BCType::THERMAL)
962 values.setThermalFlow(context, spaceIdx, timeIdx, this->boundaryFluidState(globalDofIdx, indexInInside));
963 else if (type == BCType::FREE || type == BCType::DIRICHLET)
964 values.setFreeFlow(context, spaceIdx, timeIdx, this->boundaryFluidState(globalDofIdx, indexInInside));
965 else if (type == BCType::RATE)
966 values.setMassRate(massrate, pvtRegionIdx);
976 auto& simulator = this->simulator();
977 const auto& eclState = simulator.vanguard().eclState();
979 std::size_t numElems = this->model().numGridDof();
980 this->initialFluidStates_.resize(numElems);
981 if constexpr (enableSolvent) {
982 this->solventSaturation_.resize(numElems, 0.0);
983 this->solventRsw_.resize(numElems, 0.0);
986 if constexpr (enablePolymer)
987 this->polymer_.concentration.resize(numElems, 0.0);
989 if constexpr (enablePolymerMolarWeight) {
990 const std::string msg {
"Support of the RESTART for polymer molecular weight "
991 "is not implemented yet. The polymer weight value will be "
992 "zero when RESTART begins"};
993 OpmLog::warning(
"NO_POLYMW_RESTART", msg);
994 this->polymer_.moleWeight.resize(numElems, 0.0);
997 if constexpr (enableMICP) {
998 this->micp_.resize(numElems);
1002 this->mixControls_.init(numElems, restart_step, eclState.runspec().tabdims().getNumPVTTables());
1004 if constexpr (enableMICP) {
1005 this->micp_ = this->eclWriter_->outputModule().getMICP().getSolution();
1008 for (std::size_t elemIdx = 0; elemIdx < numElems; ++elemIdx) {
1009 auto& elemFluidState = this->initialFluidStates_[elemIdx];
1010 elemFluidState.setPvtRegionIndex(pvtRegionIndex(elemIdx));
1011 this->eclWriter_->outputModule().initHysteresisParams(simulator, elemIdx);
1012 this->eclWriter_->outputModule().assignToFluidState(elemFluidState, elemIdx);
1021 auto ssol = enableSolvent
1022 ? this->eclWriter_->outputModule().getSolventSaturation(elemIdx)
1025 this->processRestartSaturations_(elemFluidState, ssol);
1027 if constexpr (enableSolvent) {
1028 this->solventSaturation_[elemIdx] = ssol;
1029 this->solventRsw_[elemIdx] = this->eclWriter_->outputModule().getSolventRsw(elemIdx);
1034 bool isThermal = eclState.getSimulationConfig().isThermal();
1035 bool needTemperature = (eclState.runspec().co2Storage() || eclState.runspec().h2Storage());
1036 if (!isThermal && needTemperature) {
1037 const auto& fp = simulator.vanguard().eclState().fieldProps();
1038 elemFluidState.setTemperature(fp.get_double(
"TEMPI")[elemIdx]);
1041 this->mixControls_.updateLastValues(elemIdx, elemFluidState.Rs(), elemFluidState.Rv());
1043 if constexpr (enablePolymer)
1044 this->polymer_.concentration[elemIdx] = this->eclWriter_->outputModule().getPolymerConcentration(elemIdx);
1048 const int episodeIdx = this->episodeIndex();
1049 this->mixControls_.updateMaxValues(episodeIdx, simulator.timeStepSize());
1054 auto& sol = this->model().solution(0);
1055 const auto& gridView = this->gridView();
1056 ElementContext elemCtx(simulator);
1057 for (
const auto& elem : elements(gridView, Dune::Partitions::interior)) {
1058 elemCtx.updatePrimaryStencil(elem);
1059 int elemIdx = elemCtx.globalSpaceIndex(0, 0);
1060 this->initial(sol[elemIdx], elemCtx, 0, 0);
1068 this->model().syncOverlap();
1071 this->updateReferencePorosity_();
1072 this->mixControls_.init(this->model().numGridDof(),
1073 this->episodeIndex(),
1074 eclState.runspec().tabdims().getNumPVTTables());
1082 {
return thresholdPressures_.thresholdPressure(elem1Idx, elem2Idx); }
1085 {
return thresholdPressures_; }
1087 FlowThresholdPressure<TypeTag>& thresholdPressure()
1088 {
return thresholdPressures_; }
1090 const ModuleParams& moduleParams()
const
1092 return moduleParams_;
1095 template<
class Serializer>
1096 void serializeOp(Serializer& serializer)
1098 serializer(
static_cast<FlowProblemType&
>(*
this));
1099 serializer(mixControls_);
1100 serializer(*eclWriter_);
1104 void updateExplicitQuantities_(
int episodeIdx,
int timeStepSize,
const bool first_step_after_restart)
override
1106 this->updateExplicitQuantities_(first_step_after_restart);
1108 if constexpr (getPropValue<TypeTag, Properties::EnablePolymer>())
1109 updateMaxPolymerAdsorption_();
1111 mixControls_.updateExplicitQuantities(episodeIdx, timeStepSize);
1114 void updateMaxPolymerAdsorption_()
1117 this->updateProperty_(
"FlowProblemBlackoil::updateMaxPolymerAdsorption_() failed:",
1118 [
this](
unsigned compressedDofIdx,
const IntensiveQuantities& iq)
1120 this->updateMaxPolymerAdsorption_(compressedDofIdx,iq);
1124 bool updateMaxPolymerAdsorption_(
unsigned compressedDofIdx,
const IntensiveQuantities& iq)
1126 const Scalar pa = scalarValue(iq.polymerAdsorption());
1127 auto& mpa = this->polymer_.maxAdsorption;
1128 if (mpa[compressedDofIdx] < pa) {
1129 mpa[compressedDofIdx] = pa;
1136 void computeAndSetEqWeights_()
1138 std::vector<Scalar> sumInvB(numPhases, 0.0);
1139 const auto& gridView = this->gridView();
1140 ElementContext elemCtx(this->simulator());
1141 for(
const auto& elem: elements(gridView, Dune::Partitions::interior)) {
1142 elemCtx.updatePrimaryStencil(elem);
1143 int elemIdx = elemCtx.globalSpaceIndex(0, 0);
1144 const auto& dofFluidState = this->initialFluidStates_[elemIdx];
1145 for (
unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
1146 if (!FluidSystem::phaseIsActive(phaseIdx))
1149 sumInvB[phaseIdx] += dofFluidState.invB(phaseIdx);
1153 std::size_t numDof = this->model().numGridDof();
1154 const auto& comm = this->simulator().vanguard().grid().comm();
1155 comm.sum(sumInvB.data(),sumInvB.size());
1156 Scalar numTotalDof = comm.sum(numDof);
1158 for (
unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
1159 if (!FluidSystem::phaseIsActive(phaseIdx))
1162 Scalar avgB = numTotalDof / sumInvB[phaseIdx];
1163 unsigned solventCompIdx = FluidSystem::solventComponentIndex(phaseIdx);
1164 unsigned activeSolventCompIdx = Indices::canonicalToActiveComponentIndex(solventCompIdx);
1165 this->model().setEqWeight(activeSolventCompIdx, avgB);
1170 bool updateCompositionChangeLimits_()
1172 OPM_TIMEBLOCK(updateCompositionChangeLimits);
1175 int episodeIdx = this->episodeIndex();
1176 std::array<bool,3> active{this->mixControls_.drsdtConvective(episodeIdx),
1177 this->mixControls_.drsdtActive(episodeIdx),
1178 this->mixControls_.drvdtActive(episodeIdx)};
1179 if (!active[0] && !active[1] && !active[2]) {
1183 this->updateProperty_(
"FlowProblemBlackoil::updateCompositionChangeLimits_()) failed:",
1184 [
this,episodeIdx,active](
unsigned compressedDofIdx,
1185 const IntensiveQuantities& iq)
1187 const DimMatrix& perm = this->intrinsicPermeability(compressedDofIdx);
1188 const Scalar distZ = active[0] ? this->simulator().vanguard().cellThickness(compressedDofIdx) : 0.0;
1189 const int pvtRegionIdx = this->pvtRegionIndex(compressedDofIdx);
1190 this->mixControls_.update(compressedDofIdx,
1193 this->gravity_[dim - 1],
1194 perm[dim - 1][dim - 1],
1203 void readEclRestartSolution_()
1206 if(this->simulator().vanguard().grid().maxLevel() > 0) {
1207 throw std::invalid_argument(
"Refined grids are not yet supported for restart ");
1211 auto& simulator = this->simulator();
1212 const auto& schedule = simulator.vanguard().schedule();
1213 const auto& eclState = simulator.vanguard().eclState();
1214 const auto& initconfig = eclState.getInitConfig();
1215 const int restart_step = initconfig.getRestartStep();
1217 simulator.setTime(schedule.seconds(restart_step));
1219 simulator.startNextEpisode(simulator.startTime() + simulator.time(),
1220 schedule.stepLength(restart_step));
1221 simulator.setEpisodeIndex(restart_step);
1223 this->eclWriter_->beginRestart();
1225 Scalar dt = std::min(this->eclWriter_->restartTimeStepSize(), simulator.episodeLength());
1226 simulator.setTimeStepSize(dt);
1228 this->readSolutionFromOutputModule(restart_step,
false);
1230 this->eclWriter_->endRestart();
1233 void readEquilInitialCondition_()
override
1235 const auto& simulator = this->simulator();
1238 EquilInitializer<TypeTag> equilInitializer(simulator, *(this->materialLawManager_));
1240 std::size_t numElems = this->model().numGridDof();
1241 this->initialFluidStates_.resize(numElems);
1242 for (std::size_t elemIdx = 0; elemIdx < numElems; ++elemIdx) {
1243 auto& elemFluidState = this->initialFluidStates_[elemIdx];
1244 elemFluidState.assign(equilInitializer.initialFluidState(elemIdx));
1248 void readExplicitInitialCondition_()
override
1250 const auto& simulator = this->simulator();
1251 const auto& vanguard = simulator.vanguard();
1252 const auto& eclState = vanguard.eclState();
1253 const auto& fp = eclState.fieldProps();
1254 bool has_swat = fp.has_double(
"SWAT");
1255 bool has_sgas = fp.has_double(
"SGAS");
1256 bool has_rs = fp.has_double(
"RS");
1257 bool has_rsw = fp.has_double(
"RSW");
1258 bool has_rv = fp.has_double(
"RV");
1259 bool has_rvw = fp.has_double(
"RVW");
1260 bool has_pressure = fp.has_double(
"PRESSURE");
1261 bool has_salt = fp.has_double(
"SALT");
1262 bool has_saltp = fp.has_double(
"SALTP");
1265 if (Indices::numPhases > 1) {
1266 if (FluidSystem::phaseIsActive(waterPhaseIdx) && !has_swat)
1267 throw std::runtime_error(
"The ECL input file requires the presence of the SWAT keyword if "
1268 "the water phase is active");
1269 if (FluidSystem::phaseIsActive(gasPhaseIdx) && !has_sgas && FluidSystem::phaseIsActive(oilPhaseIdx))
1270 throw std::runtime_error(
"The ECL input file requires the presence of the SGAS keyword if "
1271 "the gas phase is active");
1274 throw std::runtime_error(
"The ECL input file requires the presence of the PRESSURE "
1275 "keyword if the model is initialized explicitly");
1276 if (FluidSystem::enableDissolvedGas() && !has_rs)
1277 throw std::runtime_error(
"The ECL input file requires the RS keyword to be present if"
1278 " dissolved gas is enabled and the model is initialized explicitly");
1279 if (FluidSystem::enableDissolvedGasInWater() && !has_rsw)
1280 OpmLog::warning(
"The model is initialized explicitly and the RSW keyword is not present in the"
1281 " ECL input file. The RSW values are set equal to 0");
1282 if (FluidSystem::enableVaporizedOil() && !has_rv)
1283 throw std::runtime_error(
"The ECL input file requires the RV keyword to be present if"
1284 " vaporized oil is enabled and the model is initialized explicitly");
1285 if (FluidSystem::enableVaporizedWater() && !has_rvw)
1286 throw std::runtime_error(
"The ECL input file requires the RVW keyword to be present if"
1287 " vaporized water is enabled and the model is initialized explicitly");
1288 if (enableBrine && !has_salt)
1289 throw std::runtime_error(
"The ECL input file requires the SALT keyword to be present if"
1290 " brine is enabled and the model is initialized explicitly");
1291 if (enableSaltPrecipitation && !has_saltp)
1292 throw std::runtime_error(
"The ECL input file requires the SALTP keyword to be present if"
1293 " salt precipitation is enabled and the model is initialized explicitly");
1295 std::size_t numDof = this->model().numGridDof();
1297 initialFluidStates_.resize(numDof);
1299 std::vector<double> waterSaturationData;
1300 std::vector<double> gasSaturationData;
1301 std::vector<double> pressureData;
1302 std::vector<double> rsData;
1303 std::vector<double> rswData;
1304 std::vector<double> rvData;
1305 std::vector<double> rvwData;
1306 std::vector<double> tempiData;
1307 std::vector<double> saltData;
1308 std::vector<double> saltpData;
1310 if (FluidSystem::phaseIsActive(waterPhaseIdx) && Indices::numPhases > 1)
1311 waterSaturationData = fp.get_double(
"SWAT");
1313 waterSaturationData.resize(numDof);
1315 if (FluidSystem::phaseIsActive(gasPhaseIdx) && FluidSystem::phaseIsActive(oilPhaseIdx))
1316 gasSaturationData = fp.get_double(
"SGAS");
1318 gasSaturationData.resize(numDof);
1320 pressureData = fp.get_double(
"PRESSURE");
1321 if (FluidSystem::enableDissolvedGas())
1322 rsData = fp.get_double(
"RS");
1324 if (FluidSystem::enableDissolvedGasInWater() && has_rsw)
1325 rswData = fp.get_double(
"RSW");
1327 if (FluidSystem::enableVaporizedOil())
1328 rvData = fp.get_double(
"RV");
1330 if (FluidSystem::enableVaporizedWater())
1331 rvwData = fp.get_double(
"RVW");
1334 tempiData = fp.get_double(
"TEMPI");
1337 if constexpr (enableBrine)
1338 saltData = fp.get_double(
"SALT");
1341 if constexpr (enableSaltPrecipitation)
1342 saltpData = fp.get_double(
"SALTP");
1345 for (std::size_t dofIdx = 0; dofIdx < numDof; ++dofIdx) {
1346 auto& dofFluidState = initialFluidStates_[dofIdx];
1348 dofFluidState.setPvtRegionIndex(pvtRegionIndex(dofIdx));
1353 Scalar temperatureLoc = tempiData[dofIdx];
1354 if (!std::isfinite(temperatureLoc) || temperatureLoc <= 0)
1355 temperatureLoc = FluidSystem::surfaceTemperature;
1356 dofFluidState.setTemperature(temperatureLoc);
1361 if constexpr (enableBrine)
1362 dofFluidState.setSaltConcentration(saltData[dofIdx]);
1367 if constexpr (enableSaltPrecipitation)
1368 dofFluidState.setSaltSaturation(saltpData[dofIdx]);
1373 if (FluidSystem::phaseIsActive(FluidSystem::waterPhaseIdx))
1374 dofFluidState.setSaturation(FluidSystem::waterPhaseIdx,
1375 waterSaturationData[dofIdx]);
1377 if (FluidSystem::phaseIsActive(FluidSystem::gasPhaseIdx)){
1378 if (!FluidSystem::phaseIsActive(FluidSystem::oilPhaseIdx)){
1379 dofFluidState.setSaturation(FluidSystem::gasPhaseIdx,
1381 - waterSaturationData[dofIdx]);
1384 dofFluidState.setSaturation(FluidSystem::gasPhaseIdx,
1385 gasSaturationData[dofIdx]);
1387 if (FluidSystem::phaseIsActive(FluidSystem::oilPhaseIdx)) {
1388 const Scalar soil = 1.0 - waterSaturationData[dofIdx] - gasSaturationData[dofIdx];
1389 if (soil < smallSaturationTolerance_) {
1390 dofFluidState.setSaturation(FluidSystem::oilPhaseIdx, 0.0);
1393 dofFluidState.setSaturation(FluidSystem::oilPhaseIdx, soil);
1400 Scalar pressure = pressureData[dofIdx];
1404 std::array<Scalar, numPhases> pc = {0};
1405 const auto& matParams = this->materialLawParams(dofIdx);
1406 MaterialLaw::capillaryPressures(pc, matParams, dofFluidState);
1407 Valgrind::CheckDefined(pressure);
1408 Valgrind::CheckDefined(pc);
1409 for (
unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
1410 if (!FluidSystem::phaseIsActive(phaseIdx))
1413 if (Indices::oilEnabled)
1414 dofFluidState.setPressure(phaseIdx, pressure + (pc[phaseIdx] - pc[oilPhaseIdx]));
1415 else if (Indices::gasEnabled)
1416 dofFluidState.setPressure(phaseIdx, pressure + (pc[phaseIdx] - pc[gasPhaseIdx]));
1417 else if (Indices::waterEnabled)
1419 dofFluidState.setPressure(phaseIdx, pressure);
1422 if (FluidSystem::enableDissolvedGas())
1423 dofFluidState.setRs(rsData[dofIdx]);
1424 else if (Indices::gasEnabled && Indices::oilEnabled)
1425 dofFluidState.setRs(0.0);
1427 if (FluidSystem::enableDissolvedGasInWater() && has_rsw)
1428 dofFluidState.setRsw(rswData[dofIdx]);
1430 if (FluidSystem::enableVaporizedOil())
1431 dofFluidState.setRv(rvData[dofIdx]);
1432 else if (Indices::gasEnabled && Indices::oilEnabled)
1433 dofFluidState.setRv(0.0);
1435 if (FluidSystem::enableVaporizedWater())
1436 dofFluidState.setRvw(rvwData[dofIdx]);
1441 for (
unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
1442 if (!FluidSystem::phaseIsActive(phaseIdx))
1445 const auto& b = FluidSystem::inverseFormationVolumeFactor(dofFluidState, phaseIdx, pvtRegionIndex(dofIdx));
1446 dofFluidState.setInvB(phaseIdx, b);
1448 const auto& rho = FluidSystem::density(dofFluidState, phaseIdx, pvtRegionIndex(dofIdx));
1449 dofFluidState.setDensity(phaseIdx, rho);
1456 void processRestartSaturations_(InitialFluidState& elemFluidState, Scalar& solventSaturation)
1460 Scalar sumSaturation = 0.0;
1461 for (std::size_t phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
1462 if (FluidSystem::phaseIsActive(phaseIdx)) {
1463 if (elemFluidState.saturation(phaseIdx) < smallSaturationTolerance_)
1464 elemFluidState.setSaturation(phaseIdx, 0.0);
1466 sumSaturation += elemFluidState.saturation(phaseIdx);
1470 if constexpr (enableSolvent) {
1471 if (solventSaturation < smallSaturationTolerance_)
1472 solventSaturation = 0.0;
1474 sumSaturation += solventSaturation;
1477 assert(sumSaturation > 0.0);
1479 for (std::size_t phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
1480 if (FluidSystem::phaseIsActive(phaseIdx)) {
1481 const Scalar saturation = elemFluidState.saturation(phaseIdx) / sumSaturation;
1482 elemFluidState.setSaturation(phaseIdx, saturation);
1485 if constexpr (enableSolvent) {
1486 solventSaturation = solventSaturation / sumSaturation;
1490 void readInitialCondition_()
override
1492 FlowProblemType::readInitialCondition_();
1494 if constexpr (enableSolvent || enablePolymer || enablePolymerMolarWeight || enableMICP)
1495 this->readBlackoilExtentionsInitialConditions_(this->model().numGridDof(),
1498 enablePolymerMolarWeight,
1503 void handleSolventBC(
const BCProp::BCFace& bc, RateVector& rate)
const override
1505 if constexpr (!enableSolvent)
1506 throw std::logic_error(
"solvent is disabled and you're trying to add solvent to BC");
1508 rate[Indices::solventSaturationIdx] = bc.rate;
1511 void handlePolymerBC(
const BCProp::BCFace& bc, RateVector& rate)
const override
1513 if constexpr (!enablePolymer)
1514 throw std::logic_error(
"polymer is disabled and you're trying to add polymer to BC");
1516 rate[Indices::polymerConcentrationIdx] = bc.rate;
1519 void updateExplicitQuantities_(
const bool first_step_after_restart)
1521 OPM_TIMEBLOCK(updateExplicitQuantities);
1522 const bool invalidateFromMaxWaterSat = this->updateMaxWaterSaturation_();
1523 const bool invalidateFromMinPressure = this->updateMinPressure_();
1526 const bool invalidateFromHyst = this->updateHysteresis_();
1527 const bool invalidateFromMaxOilSat = this->updateMaxOilSaturation_();
1530 const bool invalidateDRDT = !first_step_after_restart && this->updateCompositionChangeLimits_();
1533 const bool invalidateIntensiveQuantities
1534 = invalidateFromMaxWaterSat || invalidateFromMinPressure || invalidateFromHyst || invalidateFromMaxOilSat || invalidateDRDT;
1535 if (invalidateIntensiveQuantities) {
1536 OPM_TIMEBLOCK(beginTimeStepInvalidateIntensiveQuantities);
1537 this->model().invalidateAndUpdateIntensiveQuantities(0);
1540 this->updateRockCompTransMultVal_();
1543 bool satfuncConsistencyRequirementsMet()
const
1545 if (
const auto nph = FluidSystem::phaseIsActive(FluidSystem::oilPhaseIdx)
1546 + FluidSystem::phaseIsActive(FluidSystem::gasPhaseIdx)
1547 + FluidSystem::phaseIsActive(FluidSystem::waterPhaseIdx);
1556 const auto numSamplePoints =
static_cast<std::size_t
>
1557 (Parameters::Get<Parameters::NumSatfuncConsistencySamplePoints>());
1559 auto sfuncConsistencyChecks =
1560 Satfunc::PhaseChecks::SatfuncConsistencyCheckManager<Scalar> {
1561 numSamplePoints, this->simulator().vanguard().eclState(),
1562 [&cmap = this->simulator().vanguard().cartesianIndexMapper()](
const int elemIdx)
1563 {
return cmap.cartesianIndex(elemIdx); }
1566 const auto ioRank = 0;
1567 const auto isIoRank = this->simulator().vanguard()
1568 .grid().comm().rank() == ioRank;
1570 sfuncConsistencyChecks.collectFailuresTo(ioRank)
1571 .run(this->simulator().vanguard().grid().leafGridView(),
1572 [&vg = this->simulator().vanguard(),
1573 &emap = this->simulator().model().elementMapper()]
1575 {
return vg.gridIdxToEquilGridIdx(emap.index(elem)); });
1577 using ViolationLevel =
typename Satfunc::PhaseChecks::
1578 SatfuncConsistencyCheckManager<Scalar>::ViolationLevel;
1580 auto reportFailures = [&sfuncConsistencyChecks]
1581 (
const ViolationLevel level)
1583 sfuncConsistencyChecks.reportFailures
1584 (level, [](std::string_view record)
1585 { OpmLog::info(std::string { record }); });
1588 if (sfuncConsistencyChecks.anyFailedStandardChecks()) {
1590 OpmLog::warning(
"Saturation Function "
1591 "End-point Consistency Problems");
1593 reportFailures(ViolationLevel::Standard);
1597 if (sfuncConsistencyChecks.anyFailedCriticalChecks()) {
1599 OpmLog::error(
"Saturation Function "
1600 "End-point Consistency Failures");
1602 reportFailures(ViolationLevel::Critical);
1615 FlowThresholdPressure<TypeTag> thresholdPressures_;
1617 std::vector<InitialFluidState> initialFluidStates_;
1619 bool enableEclOutput_;
1620 std::unique_ptr<EclWriterType> eclWriter_;
1622 const Scalar smallSaturationTolerance_ = 1.e-6;
1624 bool enableDamarisOutput_ = false ;
1625 std::unique_ptr<DamarisWriterType> damarisWriter_;
1627 MixingRateControls<FluidSystem> mixControls_;
1629 ActionHandler<Scalar> actionHandler_;
1631 ModuleParams moduleParams_;