mirror of
https://github.com/OPM/opm-simulators.git
synced 2025-02-25 18:55:30 -06:00
if the initial solution is explicitly given by the deck using the PRESSURE, SWAT, etc. keywords, the specified state can be thermodynamically impossible. To avoid inconsistencies, we use a flash calculation to find a state that is in thermodynamic equilibrium and exhibits the same masses as the explicitly specified solution. Since the flash solver needs to compute quantities for all fluid phases, but two-phase blackoil simulations usually do not specify the properties of one phase, the flash solver crashed. This patch works around that issue by simply not using the flash solver in the twophase case, i.e., the explicit initial condition must be thermodynamically consistent in order to produce the stable results for a different choice of primary variables.
1422 lines
55 KiB
C++
1422 lines
55 KiB
C++
// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
|
|
// vi: set et ts=4 sw=4 sts=4:
|
|
/*
|
|
This file is part of the Open Porous Media project (OPM).
|
|
|
|
OPM is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 2 of the License, or
|
|
(at your option) any later version.
|
|
|
|
OPM is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with OPM. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
Consult the COPYING file in the top-level source directory of this
|
|
module for the precise wording of the license and the list of
|
|
copyright holders.
|
|
*/
|
|
/*!
|
|
* \file
|
|
*
|
|
* \copydoc Ewoms::EclProblem
|
|
*/
|
|
#ifndef EWOMS_ECL_PROBLEM_HH
|
|
#define EWOMS_ECL_PROBLEM_HH
|
|
|
|
// make sure that the EBOS_USE_ALUGRID macro. using the preprocessor for this is slightly
|
|
// hacky...
|
|
#if EBOS_USE_ALUGRID
|
|
//#define DISABLE_ALUGRID_SFC_ORDERING 1
|
|
#if !HAVE_DUNE_ALUGRID || !DUNE_VERSION_NEWER(DUNE_ALUGRID, 2,4)
|
|
#warning "ALUGrid was indicated to be used for the ECL black oil simulator, but this "
|
|
#warning "requires the presence of dune-alugrid >= 2.4. Falling back to Dune::CpGrid"
|
|
#undef EBOS_USE_ALUGRID
|
|
#define EBOS_USE_ALUGRID 0
|
|
#endif
|
|
#else
|
|
#define EBOS_USE_ALUGRID 0
|
|
#endif
|
|
|
|
#if EBOS_USE_ALUGRID
|
|
#include "eclalugridmanager.hh"
|
|
#else
|
|
#include "eclpolyhedralgridmanager.hh"
|
|
#include "eclcpgridmanager.hh"
|
|
#endif
|
|
#include "eclwellmanager.hh"
|
|
#include "eclequilinitializer.hh"
|
|
#include "eclwriter.hh"
|
|
#include "eclsummarywriter.hh"
|
|
#include "ecloutputblackoilmodule.hh"
|
|
#include "ecltransmissibility.hh"
|
|
#include "eclthresholdpressure.hh"
|
|
#include "ecldummygradientcalculator.hh"
|
|
#include "eclfluxmodule.hh"
|
|
#include "ecldeckunits.hh"
|
|
|
|
#include <ewoms/common/pffgridvector.hh>
|
|
#include <ewoms/models/blackoil/blackoilmodel.hh>
|
|
#include <ewoms/disc/ecfv/ecfvdiscretization.hh>
|
|
|
|
#include <opm/material/fluidmatrixinteractions/EclMaterialLawManager.hpp>
|
|
#include <opm/material/fluidstates/CompositionalFluidState.hpp>
|
|
#include <opm/material/fluidsystems/BlackOilFluidSystem.hpp>
|
|
#include <opm/material/fluidsystems/blackoilpvt/DryGasPvt.hpp>
|
|
#include <opm/material/fluidsystems/blackoilpvt/WetGasPvt.hpp>
|
|
#include <opm/material/fluidsystems/blackoilpvt/LiveOilPvt.hpp>
|
|
#include <opm/material/fluidsystems/blackoilpvt/DeadOilPvt.hpp>
|
|
#include <opm/material/fluidsystems/blackoilpvt/ConstantCompressibilityOilPvt.hpp>
|
|
#include <opm/material/fluidsystems/blackoilpvt/ConstantCompressibilityWaterPvt.hpp>
|
|
#include <opm/common/Valgrind.hpp>
|
|
#include <opm/parser/eclipse/Deck/Deck.hpp>
|
|
#include <opm/parser/eclipse/EclipseState/EclipseState.hpp>
|
|
#include <opm/parser/eclipse/EclipseState/Tables/Eqldims.hpp>
|
|
#include <opm/parser/eclipse/EclipseState/Schedule/Schedule.hpp>
|
|
#include <opm/common/ErrorMacros.hpp>
|
|
#include <opm/common/Exceptions.hpp>
|
|
|
|
#include <dune/common/version.hh>
|
|
#include <dune/common/fvector.hh>
|
|
#include <dune/common/fmatrix.hh>
|
|
|
|
#include <boost/date_time.hpp>
|
|
|
|
#include <vector>
|
|
#include <string>
|
|
|
|
namespace Ewoms {
|
|
template <class TypeTag>
|
|
class EclProblem;
|
|
|
|
namespace Properties {
|
|
#if EBOS_USE_ALUGRID
|
|
NEW_TYPE_TAG(EclBaseProblem, INHERITS_FROM(EclAluGridManager, EclOutputBlackOil));
|
|
#else
|
|
NEW_TYPE_TAG(EclBaseProblem, INHERITS_FROM(EclCpGridManager, EclOutputBlackOil));
|
|
//NEW_TYPE_TAG(EclBaseProblem, INHERITS_FROM(EclPolyhedralGridManager, EclOutputBlackOil));
|
|
#endif
|
|
|
|
// Write all solutions for visualization, not just the ones for the
|
|
// report steps...
|
|
NEW_PROP_TAG(EnableWriteAllSolutions);
|
|
|
|
// The number of time steps skipped between writing two consequtive restart files
|
|
NEW_PROP_TAG(RestartWritingInterval);
|
|
|
|
// Disable well treatment (for users which do this externally)
|
|
NEW_PROP_TAG(DisableWells);
|
|
|
|
// Enable the additional checks even if compiled in debug mode (i.e., with the NDEBUG
|
|
// macro undefined). Next to a slightly better performance, this also eliminates some
|
|
// print statements in debug mode.
|
|
NEW_PROP_TAG(EnableDebuggingChecks);
|
|
|
|
// If this property is set to false, the SWATINIT keyword will not be handled by ebos.
|
|
NEW_PROP_TAG(EnableSwatinit);
|
|
|
|
// Set the problem property
|
|
SET_TYPE_PROP(EclBaseProblem, Problem, Ewoms::EclProblem<TypeTag>);
|
|
|
|
// Select the element centered finite volume method as spatial discretization
|
|
SET_TAG_PROP(EclBaseProblem, SpatialDiscretizationSplice, EcfvDiscretization);
|
|
|
|
//! for ebos, use automatic differentiation to linearize the system of PDEs
|
|
SET_TAG_PROP(EclBaseProblem, LocalLinearizerSplice, AutoDiffLocalLinearizer);
|
|
|
|
// Set the material Law
|
|
SET_PROP(EclBaseProblem, MaterialLaw)
|
|
{
|
|
private:
|
|
typedef typename GET_PROP_TYPE(TypeTag, Scalar) Scalar;
|
|
typedef typename GET_PROP_TYPE(TypeTag, FluidSystem) FluidSystem;
|
|
|
|
typedef Opm::ThreePhaseMaterialTraits<Scalar,
|
|
/*wettingPhaseIdx=*/FluidSystem::waterPhaseIdx,
|
|
/*nonWettingPhaseIdx=*/FluidSystem::oilPhaseIdx,
|
|
/*gasPhaseIdx=*/FluidSystem::gasPhaseIdx> Traits;
|
|
|
|
public:
|
|
typedef Opm::EclMaterialLawManager<Traits> EclMaterialLawManager;
|
|
|
|
typedef typename EclMaterialLawManager::MaterialLaw type;
|
|
};
|
|
|
|
// Enable gravity
|
|
SET_BOOL_PROP(EclBaseProblem, EnableGravity, true);
|
|
|
|
// only write the solutions for the report steps to disk
|
|
SET_BOOL_PROP(EclBaseProblem, EnableWriteAllSolutions, false);
|
|
|
|
// The default for the end time of the simulation [s]
|
|
//
|
|
// By default, stop it after the universe will probably have stopped
|
|
// to exist. (the ECL problem will finish the simulation explicitly
|
|
// after it simulated the last episode specified in the deck.)
|
|
SET_SCALAR_PROP(EclBaseProblem, EndTime, 1e100);
|
|
|
|
// The default for the initial time step size of the simulation [s].
|
|
//
|
|
// The chosen value means that the size of the first time step is the
|
|
// one of the initial episode (if the length of the initial episode is
|
|
// not millions of trillions of years, that is...)
|
|
SET_SCALAR_PROP(EclBaseProblem, InitialTimeStepSize, 1e100);
|
|
|
|
// increase the default raw tolerance for the newton solver to 10^-4 because this is what
|
|
// everone else seems to be doing...
|
|
SET_SCALAR_PROP(EclBaseProblem, NewtonRawTolerance, 1e-4);
|
|
|
|
// reduce the maximum allowed Newton error to 0.1 kg/(m^3 s). The rationale is that if
|
|
// the error is above that limit, the time step is unlikely to succeed anyway and we can
|
|
// thus abort the futile attempt early.
|
|
SET_SCALAR_PROP(EclBaseProblem, NewtonMaxError, 0.1);
|
|
|
|
// set the maximum number of Newton iterations to 14 because the likelyhood that a time
|
|
// step succeeds at more than 14 Newton iteration is rather small
|
|
SET_INT_PROP(EclBaseProblem, NewtonMaxIterations, 14);
|
|
|
|
// also, reduce the target for the "optimum" number of Newton iterations to 6. Note that
|
|
// this is only relevant if the time step is reduced from the report step size for some
|
|
// reason. (because ebos first tries to do a report step using a single time step.)
|
|
SET_INT_PROP(EclBaseProblem, NewtonTargetIterations, 6);
|
|
|
|
// Disable the VTK output by default for this problem ...
|
|
SET_BOOL_PROP(EclBaseProblem, EnableVtkOutput, false);
|
|
|
|
// ... but enable the ECL output by default
|
|
SET_BOOL_PROP(EclBaseProblem, EnableEclOutput, true);
|
|
|
|
// also enable the summary output.
|
|
SET_BOOL_PROP(EclBaseProblem, EnableEclSummaryOutput, true);
|
|
|
|
// the cache for intensive quantities can be used for ECL problems and also yields a
|
|
// decent speedup...
|
|
SET_BOOL_PROP(EclBaseProblem, EnableIntensiveQuantityCache, true);
|
|
|
|
// the cache for the storage term can also be used and also yields a decent speedup
|
|
SET_BOOL_PROP(EclBaseProblem, EnableStorageCache, true);
|
|
|
|
// Use the "velocity module" which uses the Eclipse "NEWTRAN" transmissibilities
|
|
SET_TYPE_PROP(EclBaseProblem, FluxModule, Ewoms::EclTransFluxModule<TypeTag>);
|
|
|
|
// Use the dummy gradient calculator in order not to do unnecessary work.
|
|
SET_TYPE_PROP(EclBaseProblem, GradientCalculator, Ewoms::EclDummyGradientCalculator<TypeTag>);
|
|
|
|
// The default name of the data file to load
|
|
SET_STRING_PROP(EclBaseProblem, GridFile, "data/ecl.DATA");
|
|
|
|
// The frequency of writing restart (*.ers) files. This is the number of time steps
|
|
// between writing restart files
|
|
SET_INT_PROP(EclBaseProblem, RestartWritingInterval, 0xffffff); // disable
|
|
|
|
// By default, ebos should handle the wells internally, so we don't disable the well
|
|
// treatment
|
|
SET_BOOL_PROP(EclBaseProblem, DisableWells, false);
|
|
|
|
// By default, we enable the debugging checks if we're compiled in debug mode
|
|
SET_BOOL_PROP(EclBaseProblem, EnableDebuggingChecks, true);
|
|
|
|
// ebos handles the SWATINIT keyword by default
|
|
SET_BOOL_PROP(EclBaseProblem, EnableSwatinit, true);
|
|
} // namespace Properties
|
|
|
|
/*!
|
|
* \ingroup EclBlackOilSimulator
|
|
*
|
|
* \brief This problem simulates an input file given in the data format used by the
|
|
* commercial ECLiPSE simulator.
|
|
*/
|
|
template <class TypeTag>
|
|
class EclProblem : public GET_PROP_TYPE(TypeTag, BaseProblem)
|
|
{
|
|
typedef typename GET_PROP_TYPE(TypeTag, BaseProblem) ParentType;
|
|
|
|
typedef typename GET_PROP_TYPE(TypeTag, Scalar) Scalar;
|
|
typedef typename GET_PROP_TYPE(TypeTag, GridView) GridView;
|
|
typedef typename GET_PROP_TYPE(TypeTag, Stencil) Stencil;
|
|
typedef typename GET_PROP_TYPE(TypeTag, FluidSystem) FluidSystem;
|
|
|
|
// Grid and world dimension
|
|
enum { dim = GridView::dimension };
|
|
enum { dimWorld = GridView::dimensionworld };
|
|
|
|
// copy some indices for convenience
|
|
enum { numEq = GET_PROP_VALUE(TypeTag, NumEq) };
|
|
enum { numPhases = FluidSystem::numPhases };
|
|
enum { numComponents = FluidSystem::numComponents };
|
|
enum { gasPhaseIdx = FluidSystem::gasPhaseIdx };
|
|
enum { oilPhaseIdx = FluidSystem::oilPhaseIdx };
|
|
enum { waterPhaseIdx = FluidSystem::waterPhaseIdx };
|
|
enum { gasCompIdx = FluidSystem::gasCompIdx };
|
|
enum { oilCompIdx = FluidSystem::oilCompIdx };
|
|
enum { waterCompIdx = FluidSystem::waterCompIdx };
|
|
|
|
typedef typename GET_PROP_TYPE(TypeTag, PrimaryVariables) PrimaryVariables;
|
|
typedef typename GET_PROP_TYPE(TypeTag, RateVector) RateVector;
|
|
typedef typename GET_PROP_TYPE(TypeTag, BoundaryRateVector) BoundaryRateVector;
|
|
typedef typename GET_PROP_TYPE(TypeTag, Simulator) Simulator;
|
|
typedef typename GridView::template Codim<0>::Entity Element;
|
|
typedef typename GET_PROP_TYPE(TypeTag, ElementContext) ElementContext;
|
|
typedef typename GET_PROP(TypeTag, MaterialLaw)::EclMaterialLawManager EclMaterialLawManager;
|
|
typedef typename GET_PROP_TYPE(TypeTag, DofMapper) DofMapper;
|
|
typedef typename GET_PROP_TYPE(TypeTag, MaterialLaw) MaterialLaw;
|
|
typedef typename GET_PROP_TYPE(TypeTag, MaterialLawParams) MaterialLawParams;
|
|
typedef typename GET_PROP_TYPE(TypeTag, Evaluation) Evaluation;
|
|
|
|
typedef Opm::CompositionalFluidState<Scalar, FluidSystem> ScalarFluidState;
|
|
typedef Opm::MathToolbox<Evaluation> Toolbox;
|
|
typedef Ewoms::EclSummaryWriter<TypeTag> EclSummaryWriter;
|
|
typedef Dune::FieldMatrix<Scalar, dimWorld, dimWorld> DimMatrix;
|
|
|
|
typedef EclWriter<TypeTag> EclWriterType;
|
|
|
|
struct RockParams {
|
|
Scalar referencePressure;
|
|
Scalar compressibility;
|
|
};
|
|
|
|
public:
|
|
/*!
|
|
* \copydoc FvBaseProblem::registerParameters
|
|
*/
|
|
static void registerParameters()
|
|
{
|
|
ParentType::registerParameters();
|
|
|
|
Ewoms::EclOutputBlackOilModule<TypeTag>::registerParameters();
|
|
|
|
EWOMS_REGISTER_PARAM(TypeTag, bool, EnableWriteAllSolutions,
|
|
"Write all solutions to disk instead of only the ones for the "
|
|
"report steps");
|
|
EWOMS_REGISTER_PARAM(TypeTag, bool, EnableEclOutput,
|
|
"Write binary output which is compatible with the commercial "
|
|
"Eclipse simulator");
|
|
EWOMS_REGISTER_PARAM(TypeTag, unsigned, RestartWritingInterval,
|
|
"The frequencies of which time steps are serialized to disk");
|
|
}
|
|
|
|
/*!
|
|
* \copydoc Doxygen::defaultProblemConstructor
|
|
*/
|
|
EclProblem(Simulator& simulator)
|
|
: ParentType(simulator)
|
|
, transmissibilities_(simulator.gridManager())
|
|
, thresholdPressures_(simulator)
|
|
, wellManager_(simulator)
|
|
, deckUnits_(simulator)
|
|
, eclWriter_( EWOMS_GET_PARAM(TypeTag, bool, EnableEclOutput)
|
|
? new EclWriterType(simulator) : nullptr )
|
|
, summaryWriter_(simulator)
|
|
, pffDofData_(simulator.gridView(), this->elementMapper())
|
|
{
|
|
// add the output module for the Ecl binary output
|
|
simulator.model().addOutputModule(new Ewoms::EclOutputBlackOilModule<TypeTag>(simulator));
|
|
}
|
|
|
|
/*!
|
|
* \copydoc FvBaseProblem::finishInit
|
|
*/
|
|
void finishInit()
|
|
{
|
|
ParentType::finishInit();
|
|
|
|
auto& simulator = this->simulator();
|
|
|
|
// set the value of the gravity constant to the one used by the FLOW simulator
|
|
this->gravity_ = 0.0;
|
|
|
|
// the "NOGRAV" keyword from Frontsim disables gravity...
|
|
const auto& deck = simulator.gridManager().deck();
|
|
if (!deck.hasKeyword("NOGRAV") && EWOMS_GET_PARAM(TypeTag, bool, EnableGravity))
|
|
this->gravity_[dim - 1] = 9.80665;
|
|
|
|
initFluidSystem_();
|
|
updateElementDepths_();
|
|
readRockParameters_();
|
|
readMaterialParameters_();
|
|
transmissibilities_.finishInit();
|
|
readInitialCondition_();
|
|
|
|
// Set the start time of the simulation
|
|
const auto& timeMap = simulator.gridManager().eclState().getSchedule().getTimeMap();
|
|
tm curTime = boost::posix_time::to_tm(timeMap.getStartTime(/*timeStepIdx=*/0));
|
|
|
|
Scalar startTime = std::mktime(&curTime);
|
|
simulator.setStartTime(startTime);
|
|
|
|
// We want the episode index to be the same as the report step index to make
|
|
// things simpler, so we have to set the episode index to -1 because it is
|
|
// incremented inside beginEpisode(). The size of the initial time step and
|
|
// length of the initial episode is set to zero for the same reason.
|
|
simulator.setEpisodeIndex(-1);
|
|
simulator.setEpisodeLength(0.0);
|
|
simulator.setTimeStepSize(0.0);
|
|
|
|
updatePffDofData_();
|
|
}
|
|
|
|
void prefetch(const Element& elem) const
|
|
{ pffDofData_.prefetch(elem); }
|
|
|
|
/*!
|
|
* \brief This method restores the complete state of the well
|
|
* from disk.
|
|
*
|
|
* It is the inverse of the serialize() method.
|
|
*
|
|
* \tparam Restarter The deserializer type
|
|
*
|
|
* \param res The deserializer object
|
|
*/
|
|
template <class Restarter>
|
|
void deserialize(Restarter& res)
|
|
{
|
|
// reload the current episode/report step from the deck
|
|
beginEpisode(/*isOnRestart=*/true);
|
|
|
|
// deserialize the wells
|
|
wellManager_.deserialize(res);
|
|
}
|
|
|
|
/*!
|
|
* \brief This method writes the complete state of the well
|
|
* to the harddisk.
|
|
*/
|
|
template <class Restarter>
|
|
void serialize(Restarter& res)
|
|
{ wellManager_.serialize(res); }
|
|
|
|
/*!
|
|
* \brief Called by the simulator before an episode begins.
|
|
*/
|
|
void beginEpisode(bool isOnRestart = false)
|
|
{
|
|
// Proceed to the next report step
|
|
Simulator& simulator = this->simulator();
|
|
auto& eclState = this->simulator().gridManager().eclState();
|
|
const auto& schedule = eclState.getSchedule();
|
|
const auto& events = schedule.getEvents();
|
|
const auto& timeMap = schedule.getTimeMap();
|
|
|
|
// The first thing to do in the morning of an episode is update update the
|
|
// eclState and the deck if they need to be changed.
|
|
int nextEpisodeIdx = simulator.episodeIndex();
|
|
if (nextEpisodeIdx > 0 &&
|
|
events.hasEvent(Opm::ScheduleEvents::GEO_MODIFIER, nextEpisodeIdx))
|
|
{
|
|
// bring the contents of the keywords to the current state of the SCHEDULE
|
|
// section
|
|
//
|
|
// TODO (?): make grid topology changes possible (depending on what exactly
|
|
// has changed, the grid may need be re-created which has some serious
|
|
// implications on e.g., the solution of the simulation.)
|
|
const auto& miniDeck = schedule.getModifierDeck(nextEpisodeIdx);
|
|
eclState.applyModifierDeck(miniDeck);
|
|
|
|
// re-compute all quantities which may possibly be affected.
|
|
transmissibilities_.update();
|
|
updatePorosity_();
|
|
updatePffDofData_();
|
|
}
|
|
|
|
// Opm::TimeMap deals with points in time, so the number of time intervals (i.e.,
|
|
// report steps) is one less!
|
|
int numReportSteps = timeMap.size() - 1;
|
|
|
|
// start the next episode if there are additional report steps, else finish the
|
|
// simulation
|
|
while (nextEpisodeIdx < numReportSteps &&
|
|
simulator.time() >= timeMap.getTimePassedUntil(nextEpisodeIdx + 1)*(1 - 1e-10))
|
|
{
|
|
++ nextEpisodeIdx;
|
|
}
|
|
|
|
Scalar episodeLength = timeMap.getTimeStepLength(nextEpisodeIdx);
|
|
Scalar dt = episodeLength;
|
|
if (nextEpisodeIdx == 0) {
|
|
// allow the size of the initial time step to be set via an external parameter
|
|
Scalar initialDt = EWOMS_GET_PARAM(TypeTag, Scalar, InitialTimeStepSize);
|
|
dt = std::min(dt, initialDt);
|
|
}
|
|
|
|
if (nextEpisodeIdx < numReportSteps) {
|
|
simulator.startNextEpisode(episodeLength);
|
|
simulator.setTimeStepSize(dt);
|
|
}
|
|
|
|
if (updateHysteresis_())
|
|
this->model().invalidateIntensiveQuantitiesCache(/*timeIdx=*/0);
|
|
this->model().updateMaxOilSaturations();
|
|
|
|
if (!GET_PROP_VALUE(TypeTag, DisableWells))
|
|
// set up the wells
|
|
wellManager_.beginEpisode(this->simulator().gridManager().eclState(), isOnRestart);
|
|
}
|
|
|
|
/*!
|
|
* \brief Called by the simulator before each time integration.
|
|
*/
|
|
void beginTimeStep()
|
|
{
|
|
if (!GET_PROP_VALUE(TypeTag, DisableWells)) {
|
|
wellManager_.beginTimeStep();
|
|
|
|
// this is a little hack to write the initial condition, which we need to do
|
|
// before the first time step has finished.
|
|
static bool initialWritten = false;
|
|
if (this->simulator().episodeIndex() == 0 && !initialWritten) {
|
|
summaryWriter_.write(wellManager_, /*isInitial=*/true);
|
|
initialWritten = true;
|
|
}
|
|
}
|
|
}
|
|
|
|
/*!
|
|
* \brief Called by the simulator before each Newton-Raphson iteration.
|
|
*/
|
|
void beginIteration()
|
|
{
|
|
if (!GET_PROP_VALUE(TypeTag, DisableWells))
|
|
wellManager_.beginIteration();
|
|
}
|
|
|
|
/*!
|
|
* \brief Called by the simulator after each Newton-Raphson iteration.
|
|
*/
|
|
void endIteration()
|
|
{
|
|
if (!GET_PROP_VALUE(TypeTag, DisableWells))
|
|
wellManager_.endIteration();
|
|
}
|
|
|
|
/*!
|
|
* \brief Called by the simulator after each time integration.
|
|
*/
|
|
void endTimeStep()
|
|
{
|
|
#ifndef NDEBUG
|
|
if (GET_PROP_VALUE(TypeTag, EnableDebuggingChecks)) {
|
|
// in debug mode, we don't care about performance, so we check if the model does
|
|
// the right thing (i.e., the mass change inside the whole reservoir must be
|
|
// equivalent to the fluxes over the grid's boundaries plus the source rates
|
|
// specified by the problem)
|
|
this->model().checkConservativeness(/*tolerance=*/-1, /*verbose=*/true);
|
|
}
|
|
#endif // NDEBUG
|
|
|
|
if (!GET_PROP_VALUE(TypeTag, DisableWells)) {
|
|
wellManager_.endTimeStep();
|
|
|
|
// write the summary information after each time step
|
|
summaryWriter_.write(wellManager_);
|
|
}
|
|
}
|
|
|
|
/*!
|
|
* \brief Called by the simulator after the end of an episode.
|
|
*/
|
|
void endEpisode()
|
|
{
|
|
auto& simulator = this->simulator();
|
|
const auto& eclState = simulator.gridManager().eclState();
|
|
int episodeIdx = simulator.episodeIndex();
|
|
|
|
const auto& timeMap = eclState.getSchedule().getTimeMap();
|
|
int numReportSteps = timeMap.size() - 1;
|
|
if (episodeIdx + 1 >= numReportSteps) {
|
|
simulator.setFinished(true);
|
|
return;
|
|
}
|
|
}
|
|
|
|
/*!
|
|
* \brief Returns true if the current solution should be written
|
|
* to disk for visualization.
|
|
*
|
|
* For the ECL simulator we only write at the end of
|
|
* episodes/report steps...
|
|
*/
|
|
bool shouldWriteOutput() const
|
|
{
|
|
if (this->simulator().timeStepIndex() < 0)
|
|
// always write the initial solution
|
|
return true;
|
|
|
|
if (EWOMS_GET_PARAM(TypeTag, bool, EnableWriteAllSolutions))
|
|
return true;
|
|
|
|
return this->simulator().episodeWillBeOver();
|
|
}
|
|
|
|
/*!
|
|
* \brief Returns true if an eWoms restart file should be written to disk.
|
|
*/
|
|
bool shouldWriteRestartFile() const
|
|
{
|
|
unsigned n = EWOMS_GET_PARAM(TypeTag, unsigned, RestartWritingInterval);
|
|
unsigned i = this->simulator().timeStepIndex();
|
|
if (i > 0 && (i%n) == 0)
|
|
return true; // we don't write a restart file for the initial condition
|
|
return false;
|
|
}
|
|
|
|
/*!
|
|
* \brief Write the requested quantities of the current solution into the output
|
|
* files.
|
|
*/
|
|
void writeOutput(bool verbose = true)
|
|
{
|
|
// calculate the time _after_ the time was updated
|
|
Scalar t = this->simulator().time() + this->simulator().timeStepSize();
|
|
|
|
// prepare the ECL and the VTK writers
|
|
if ( eclWriter_ )
|
|
eclWriter_->beginWrite(t);
|
|
|
|
// use the generic code to prepare the output fields and to
|
|
// write the desired VTK files.
|
|
ParentType::writeOutput(verbose);
|
|
|
|
if ( eclWriter_ ) {
|
|
this->model().appendOutputFields(*eclWriter_);
|
|
eclWriter_->endWrite();
|
|
}
|
|
}
|
|
|
|
/*!
|
|
* \brief Returns the object which converts between SI and deck units.
|
|
*/
|
|
const EclDeckUnits<TypeTag>& deckUnits() const
|
|
{ return deckUnits_; }
|
|
|
|
/*!
|
|
* \copydoc FvBaseMultiPhaseProblem::intrinsicPermeability
|
|
*/
|
|
template <class Context>
|
|
const DimMatrix& intrinsicPermeability(const Context& context,
|
|
unsigned spaceIdx,
|
|
unsigned timeIdx) const
|
|
{
|
|
unsigned globalSpaceIdx = context.globalSpaceIndex(spaceIdx, timeIdx);
|
|
return transmissibilities_.permeability(globalSpaceIdx);
|
|
}
|
|
|
|
/*!
|
|
* \brief This method returns the intrinsic permeability tensor
|
|
* given a global element index.
|
|
*
|
|
* Its main (only?) usage is the ECL transmissibility calculation code...
|
|
*/
|
|
const DimMatrix& intrinsicPermeability(unsigned globalElemIdx) const
|
|
{ return transmissibilities_.permeability(globalElemIdx); }
|
|
|
|
/*!
|
|
* \copydoc BlackOilBaseProblem::transmissibility
|
|
*/
|
|
template <class Context>
|
|
Scalar transmissibility(const Context& context,
|
|
unsigned OPM_OPTIM_UNUSED fromDofLocalIdx,
|
|
unsigned toDofLocalIdx) const
|
|
{
|
|
assert(fromDofLocalIdx == 0);
|
|
return pffDofData_.get(context.element(), toDofLocalIdx).transmissibility;
|
|
}
|
|
|
|
/*!
|
|
* \brief Return a reference to the object that handles the "raw" transmissibilities.
|
|
*/
|
|
const EclTransmissibility<TypeTag>& eclTransmissibilities() const
|
|
{ return transmissibilities_; }
|
|
|
|
/*!
|
|
* \copydoc BlackOilBaseProblem::thresholdPressure
|
|
*/
|
|
Scalar thresholdPressure(unsigned elem1Idx, unsigned elem2Idx) const
|
|
{ return thresholdPressures_.thresholdPressure(elem1Idx, elem2Idx); }
|
|
|
|
/*!
|
|
* \copydoc FvBaseMultiPhaseProblem::porosity
|
|
*/
|
|
template <class Context>
|
|
Scalar porosity(const Context& context, unsigned spaceIdx, unsigned timeIdx) const
|
|
{
|
|
unsigned globalSpaceIdx = context.globalSpaceIndex(spaceIdx, timeIdx);
|
|
return porosity_[globalSpaceIdx];
|
|
}
|
|
|
|
/*!
|
|
* \brief Returns the porosity of an element
|
|
*
|
|
* Note that this method is *not* part of the generic eWoms problem API because it
|
|
* would bake the assumption that only the elements are the degrees of freedom into
|
|
* the interface.
|
|
*/
|
|
Scalar porosity(unsigned elementIdx) const
|
|
{ return porosity_[elementIdx]; }
|
|
|
|
/*!
|
|
* \brief Returns the depth of an degree of freedom [m]
|
|
*
|
|
* For ECL problems this is defined as the average of the depth of an element and is
|
|
* thus slightly different from the depth of an element's centroid.
|
|
*/
|
|
template <class Context>
|
|
Scalar dofCenterDepth(const Context& context, unsigned spaceIdx, unsigned timeIdx) const
|
|
{
|
|
unsigned globalSpaceIdx = context.globalSpaceIndex(spaceIdx, timeIdx);
|
|
return elementCenterDepth_[globalSpaceIdx];
|
|
}
|
|
|
|
/*!
|
|
* \copydoc BlackoilProblem::rockCompressibility
|
|
*/
|
|
template <class Context>
|
|
Scalar rockCompressibility(const Context& context, unsigned spaceIdx, unsigned timeIdx) const
|
|
{
|
|
if (rockParams_.empty())
|
|
return 0.0;
|
|
|
|
unsigned tableIdx = 0;
|
|
if (!rockTableIdx_.empty()) {
|
|
unsigned globalSpaceIdx = context.globalSpaceIndex(spaceIdx, timeIdx);
|
|
tableIdx = rockTableIdx_[globalSpaceIdx];
|
|
}
|
|
|
|
return rockParams_[tableIdx].compressibility;
|
|
}
|
|
|
|
/*!
|
|
* \copydoc BlackoilProblem::rockReferencePressure
|
|
*/
|
|
template <class Context>
|
|
Scalar rockReferencePressure(const Context& context, unsigned spaceIdx, unsigned timeIdx) const
|
|
{
|
|
if (rockParams_.empty())
|
|
return 1e5;
|
|
|
|
unsigned tableIdx = 0;
|
|
if (!rockTableIdx_.empty()) {
|
|
unsigned globalSpaceIdx = context.globalSpaceIndex(spaceIdx, timeIdx);
|
|
tableIdx = rockTableIdx_[globalSpaceIdx];
|
|
}
|
|
|
|
return rockParams_[tableIdx].referencePressure;
|
|
}
|
|
|
|
/*!
|
|
* \copydoc FvBaseMultiPhaseProblem::materialLawParams
|
|
*/
|
|
template <class Context>
|
|
const MaterialLawParams& materialLawParams(const Context& context,
|
|
unsigned spaceIdx, unsigned timeIdx) const
|
|
{
|
|
unsigned globalSpaceIdx = context.globalSpaceIndex(spaceIdx, timeIdx);
|
|
return materialLawParams(globalSpaceIdx);
|
|
}
|
|
|
|
const MaterialLawParams& materialLawParams(unsigned globalDofIdx) const
|
|
{ return materialLawManager_->materialLawParams(globalDofIdx); }
|
|
|
|
/*!
|
|
* \brief Returns the ECL material law manager
|
|
*
|
|
* Note that this method is *not* part of the generic eWoms problem API because it
|
|
* would force all problens use the ECL material laws.
|
|
*/
|
|
std::shared_ptr<const EclMaterialLawManager> materialLawManager() const
|
|
{ return materialLawManager_; }
|
|
|
|
/*!
|
|
* \copydoc materialLawManager()
|
|
*/
|
|
std::shared_ptr<EclMaterialLawManager> materialLawManager()
|
|
{ return materialLawManager_; }
|
|
|
|
/*!
|
|
* \brief Returns the index of the relevant region for thermodynmic properties
|
|
*/
|
|
template <class Context>
|
|
unsigned pvtRegionIndex(const Context& context, unsigned spaceIdx, unsigned timeIdx) const
|
|
{ return pvtRegionIndex(context.globalSpaceIndex(spaceIdx, timeIdx)); }
|
|
|
|
/*!
|
|
* \brief Returns the index the relevant PVT region given a cell index
|
|
*/
|
|
unsigned pvtRegionIndex(unsigned elemIdx) const
|
|
{
|
|
if (pvtnum_.empty())
|
|
return 0;
|
|
|
|
return pvtnum_[elemIdx];
|
|
}
|
|
|
|
/*!
|
|
* \copydoc FvBaseProblem::name
|
|
*/
|
|
std::string name() const
|
|
{ return this->simulator().gridManager().caseName(); }
|
|
|
|
/*!
|
|
* \copydoc FvBaseMultiPhaseProblem::temperature
|
|
*/
|
|
template <class Context>
|
|
Scalar temperature(const Context& context, unsigned spaceIdx, unsigned timeIdx) const
|
|
{
|
|
// use the temporally constant temperature, i.e. use the initial temperature of
|
|
// the DOF
|
|
unsigned globalDofIdx = context.globalSpaceIndex(spaceIdx, timeIdx);
|
|
return initialFluidStates_[globalDofIdx].temperature(/*phaseIdx=*/0);
|
|
}
|
|
|
|
/*!
|
|
* \copydoc FvBaseProblem::boundary
|
|
*
|
|
* ECLiPSE uses no-flow conditions for all boundaries. \todo really?
|
|
*/
|
|
template <class Context>
|
|
void boundary(BoundaryRateVector& values,
|
|
const Context& context OPM_UNUSED,
|
|
unsigned spaceIdx OPM_UNUSED,
|
|
unsigned timeIdx OPM_UNUSED) const
|
|
{ values.setNoFlow(); }
|
|
|
|
/*!
|
|
* \copydoc FvBaseProblem::initial
|
|
*
|
|
* The reservoir problem uses a constant boundary condition for
|
|
* the whole domain.
|
|
*/
|
|
template <class Context>
|
|
void initial(PrimaryVariables& values, const Context& context, unsigned spaceIdx, unsigned timeIdx) const
|
|
{
|
|
unsigned globalDofIdx = context.globalSpaceIndex(spaceIdx, timeIdx);
|
|
|
|
values.setPvtRegionIndex(pvtRegionIndex(context, spaceIdx, timeIdx));
|
|
|
|
if (useMassConservativeInitialCondition_) {
|
|
const auto& matParams = materialLawParams(context, spaceIdx, timeIdx);
|
|
values.assignMassConservative(initialFluidStates_[globalDofIdx], matParams);
|
|
}
|
|
else
|
|
values.assignNaive(initialFluidStates_[globalDofIdx]);
|
|
}
|
|
|
|
/*!
|
|
* \copydoc FvBaseProblem::initialSolutionApplied()
|
|
*/
|
|
void initialSolutionApplied()
|
|
{
|
|
if (!GET_PROP_VALUE(TypeTag, DisableWells)) {
|
|
// initialize the wells. Note that this needs to be done after initializing the
|
|
// intrinsic permeabilities and the after applying the initial solution because
|
|
// the well model uses these...
|
|
wellManager_.init(this->simulator().gridManager().eclState());
|
|
}
|
|
|
|
// let the object for threshold pressures initialize itself. this is done only at
|
|
// this point, because determining the threshold pressures may require to access
|
|
// the initial solution.
|
|
thresholdPressures_.finishInit();
|
|
|
|
// apply SWATINIT if requested by the programmer. this is only necessary if
|
|
// SWATINIT has not yet been considered at the first time the EquilInitializer
|
|
// was used, i.e., only if threshold pressures are enabled in addition to
|
|
// SWATINIT.
|
|
const auto& deck = this->simulator().gridManager().deck();
|
|
const auto& eclState = this->simulator().gridManager().eclState();
|
|
int numEquilRegions = eclState.getTableManager().getEqldims().getNumEquilRegions();
|
|
bool useThpres = deck.hasKeyword("THPRES") && numEquilRegions > 1;
|
|
bool useSwatinit =
|
|
GET_PROP_VALUE(TypeTag, EnableSwatinit) &&
|
|
eclState.get3DProperties().hasDeckDoubleGridProperty("SWATINIT");
|
|
|
|
if (useThpres && useSwatinit)
|
|
applySwatinit();
|
|
|
|
// release the memory of the EQUIL grid since it's no longer needed after this point
|
|
this->simulator().gridManager().releaseEquilGrid();
|
|
|
|
// the fluid states specifying the initial condition are also no longer required.
|
|
initialFluidStates_.clear();
|
|
}
|
|
|
|
/*!
|
|
* \copydoc FvBaseProblem::source
|
|
*
|
|
* For this problem, the source term of all components is 0 everywhere.
|
|
*/
|
|
template <class Context>
|
|
void source(RateVector& rate,
|
|
const Context& context,
|
|
unsigned spaceIdx,
|
|
unsigned timeIdx) const
|
|
{
|
|
rate = 0.0;
|
|
|
|
if (!GET_PROP_VALUE(TypeTag, DisableWells)) {
|
|
wellManager_.computeTotalRatesForDof(rate, context, spaceIdx, timeIdx);
|
|
|
|
// convert the source term from the total mass rate of the
|
|
// cell to the one per unit of volume as used by the model.
|
|
unsigned globalDofIdx = context.globalSpaceIndex(spaceIdx, timeIdx);
|
|
for (unsigned eqIdx = 0; eqIdx < numEq; ++ eqIdx)
|
|
rate[eqIdx] /= this->model().dofTotalVolume(globalDofIdx);
|
|
}
|
|
}
|
|
|
|
/*!
|
|
* \brief Returns a reference to the ECL well manager used by the problem.
|
|
*
|
|
* This can be used for inspecting wells outside of the problem.
|
|
*/
|
|
const EclWellManager<TypeTag>& wellManager() const
|
|
{ return wellManager_; }
|
|
|
|
/*!
|
|
* \brief Apply the necessary measures mandated by the SWATINIT keyword the the
|
|
* material law parameters.
|
|
*
|
|
* If SWATINIT is not used or if the method has already been called, this method is a
|
|
* no-op.
|
|
*/
|
|
void applySwatinit()
|
|
{
|
|
const auto& deck = this->simulator().gridManager().deck();
|
|
const auto& eclState = this->simulator().gridManager().eclState();
|
|
const auto& deckProps = eclState.get3DProperties();
|
|
|
|
if (!deckProps.hasDeckDoubleGridProperty("SWATINIT"))
|
|
return; // SWATINIT is not in the deck
|
|
else if (!deck.hasKeyword("EQUIL"))
|
|
// SWATINIT only applies if the initial solution is specified using the EQUIL
|
|
// keyword.
|
|
return;
|
|
|
|
// SWATINIT applies. We have to do a complete re-initialization here. this is a
|
|
// kludge, but to calculate the threshold pressures the initial solution without
|
|
// SWATINIT is required!
|
|
|
|
typedef Ewoms::EclEquilInitializer<TypeTag> EquilInitializer;
|
|
EquilInitializer equilInitializer(this->simulator(),
|
|
*materialLawManager_,
|
|
/*enableSwatinit=*/true);
|
|
auto& model = this->model();
|
|
size_t numElems = model.numGridDof();
|
|
for (size_t elemIdx = 0; elemIdx < numElems; ++elemIdx) {
|
|
const auto& fs = equilInitializer.initialFluidState(elemIdx);
|
|
auto& priVars0 = model.solution(/*timeIdx=*/0)[elemIdx];
|
|
auto& priVars1 = model.solution(/*timeIdx=*/1)[elemIdx];
|
|
|
|
priVars1.assignNaive(fs);
|
|
priVars0 = priVars1;
|
|
}
|
|
|
|
// the solution (most likely) has changed, so we need to invalidate the cache for
|
|
// intensive quantities
|
|
this->simulator().model().invalidateIntensiveQuantitiesCache(/*timeIdx=*/0);
|
|
}
|
|
|
|
private:
|
|
Scalar cellCenterDepth( const Element& element ) const
|
|
{
|
|
typedef typename Element :: Geometry Geometry;
|
|
static constexpr int zCoord = Geometry ::dimension - 1;
|
|
Scalar zz = 0.0;
|
|
|
|
const Geometry geometry = element.geometry();
|
|
|
|
const int corners = geometry.corners();
|
|
for (int i=0; i<corners; ++i)
|
|
{
|
|
zz += geometry.corner( i )[ zCoord ];
|
|
}
|
|
return zz/Scalar(corners);
|
|
}
|
|
|
|
void updateElementDepths_()
|
|
{
|
|
const auto& gridManager = this->simulator().gridManager();
|
|
const auto& gridView = gridManager.gridView();
|
|
const auto& elemMapper = this->elementMapper();;
|
|
|
|
int numElements = gridView.size(/*codim=*/0);
|
|
elementCenterDepth_.resize(numElements);
|
|
|
|
auto elemIt = gridView.template begin</*codim=*/0>();
|
|
const auto& elemEndIt = gridView.template end</*codim=*/0>();
|
|
for (; elemIt != elemEndIt; ++elemIt) {
|
|
const Element& element = *elemIt;
|
|
#if DUNE_VERSION_NEWER(DUNE_COMMON, 2,4)
|
|
const unsigned int elemIdx = elemMapper.index(element);
|
|
#else
|
|
const unsigned int elemIdx = elemMapper.map(element);
|
|
#endif
|
|
|
|
elementCenterDepth_[elemIdx] = cellCenterDepth( element );
|
|
}
|
|
}
|
|
|
|
void readRockParameters_()
|
|
{
|
|
const auto& deck = this->simulator().gridManager().deck();
|
|
const auto& eclState = this->simulator().gridManager().eclState();
|
|
const auto& gridManager = this->simulator().gridManager();
|
|
|
|
// the ROCK keyword has not been specified, so we don't need
|
|
// to read rock parameters
|
|
if (!deck.hasKeyword("ROCK"))
|
|
return;
|
|
|
|
const auto& rockKeyword = deck.getKeyword("ROCK");
|
|
rockParams_.resize(rockKeyword.size());
|
|
for (size_t rockRecordIdx = 0; rockRecordIdx < rockKeyword.size(); ++ rockRecordIdx) {
|
|
const auto& rockRecord = rockKeyword.getRecord(rockRecordIdx);
|
|
rockParams_[rockRecordIdx].referencePressure =
|
|
rockRecord.getItem("PREF").getSIDouble(0);
|
|
rockParams_[rockRecordIdx].compressibility =
|
|
rockRecord.getItem("COMPRESSIBILITY").getSIDouble(0);
|
|
}
|
|
|
|
// PVTNUM has not been specified, so everything is in the first region and we
|
|
// don't need to care...
|
|
if (!eclState.get3DProperties().hasDeckIntGridProperty("PVTNUM"))
|
|
return;
|
|
|
|
const std::vector<int>& pvtnumData =
|
|
eclState.get3DProperties().getIntGridProperty("PVTNUM").getData();
|
|
unsigned numElem = gridManager.gridView().size(0);
|
|
rockTableIdx_.resize(numElem);
|
|
for (size_t elemIdx = 0; elemIdx < numElem; ++ elemIdx) {
|
|
unsigned cartElemIdx = gridManager.cartesianIndex(elemIdx);
|
|
|
|
// reminder: Eclipse uses FORTRAN-style indices
|
|
rockTableIdx_[elemIdx] = pvtnumData[cartElemIdx] - 1;
|
|
}
|
|
}
|
|
|
|
void readMaterialParameters_()
|
|
{
|
|
const auto& gridManager = this->simulator().gridManager();
|
|
const auto& deck = gridManager.deck();
|
|
const auto& eclState = gridManager.eclState();
|
|
|
|
// the PVT region number
|
|
updatePvtnum_();
|
|
|
|
////////////////////////////////
|
|
// porosity
|
|
updatePorosity_();
|
|
////////////////////////////////
|
|
|
|
////////////////////////////////
|
|
// fluid-matrix interactions (saturation functions; relperm/capillary pressure)
|
|
size_t numDof = this->model().numGridDof();
|
|
std::vector<int> compressedToCartesianElemIdx(numDof);
|
|
for (unsigned elemIdx = 0; elemIdx < numDof; ++elemIdx)
|
|
compressedToCartesianElemIdx[elemIdx] = gridManager.cartesianIndex(elemIdx);
|
|
|
|
materialLawManager_ = std::make_shared<EclMaterialLawManager>();
|
|
materialLawManager_->initFromDeck(deck, eclState, compressedToCartesianElemIdx);
|
|
////////////////////////////////
|
|
}
|
|
|
|
void updatePorosity_()
|
|
{
|
|
const auto& gridManager = this->simulator().gridManager();
|
|
const auto& eclState = gridManager.eclState();
|
|
const auto& eclGrid = eclState.getInputGrid();
|
|
const auto& props = eclState.get3DProperties();
|
|
|
|
size_t numDof = this->model().numGridDof();
|
|
|
|
porosity_.resize(numDof);
|
|
|
|
const std::vector<double>& porvData =
|
|
props.getDoubleGridProperty("PORV").getData();
|
|
const std::vector<int>& actnumData =
|
|
props.getIntGridProperty("ACTNUM").getData();
|
|
|
|
int nx = eclGrid.getNX();
|
|
int ny = eclGrid.getNY();
|
|
for (size_t dofIdx = 0; dofIdx < numDof; ++ dofIdx) {
|
|
unsigned cartElemIdx = gridManager.cartesianIndex(dofIdx);
|
|
Scalar poreVolume = porvData[cartElemIdx];
|
|
|
|
// sum up the pore volume of the active cell and all inactive ones above it
|
|
// which were disabled due to their pore volume being too small
|
|
if (eclGrid.getMinpvMode() == Opm::MinpvMode::ModeEnum::OpmFIL) {
|
|
Scalar minPvValue = eclGrid.getMinpvValue();
|
|
for (int aboveElemCartIdx = static_cast<int>(cartElemIdx) - nx*ny;
|
|
aboveElemCartIdx >= 0;
|
|
aboveElemCartIdx -= nx*ny)
|
|
{
|
|
if (porvData[aboveElemCartIdx] >= minPvValue)
|
|
// the cartesian element above exhibits a pore volume which larger or
|
|
// equal to the minimum one
|
|
break;
|
|
|
|
Scalar aboveElemVolume = eclGrid.getCellVolume(aboveElemCartIdx);
|
|
if (actnumData[aboveElemCartIdx] == 0 && aboveElemVolume > 1e-3)
|
|
// stop at explicitly disabled elements, but only if their volume is
|
|
// greater than 10^-3 m^3
|
|
break;
|
|
|
|
poreVolume += porvData[aboveElemCartIdx];
|
|
}
|
|
}
|
|
|
|
// we define the porosity as the accumulated pore volume divided by the
|
|
// geometric volume of the element. Note that -- in pathetic cases -- it can
|
|
// be larger than 1.0!
|
|
Scalar dofVolume = this->simulator().model().dofTotalVolume(dofIdx);
|
|
assert(dofVolume > 0.0);
|
|
porosity_[dofIdx] = poreVolume/dofVolume;
|
|
}
|
|
}
|
|
|
|
void initFluidSystem_()
|
|
{
|
|
const auto& deck = this->simulator().gridManager().deck();
|
|
const auto& eclState = this->simulator().gridManager().eclState();
|
|
|
|
FluidSystem::initFromDeck(deck, eclState);
|
|
}
|
|
|
|
void readInitialCondition_()
|
|
{
|
|
const auto& gridManager = this->simulator().gridManager();
|
|
const auto& deck = gridManager.deck();
|
|
|
|
if (!deck.hasKeyword("EQUIL"))
|
|
readExplicitInitialCondition_();
|
|
else
|
|
readEquilInitialCondition_();
|
|
}
|
|
|
|
void readEquilInitialCondition_()
|
|
{
|
|
const auto& deck = this->simulator().gridManager().deck();
|
|
const auto& eclState = this->simulator().gridManager().eclState();
|
|
int numEquilRegions = eclState.getTableManager().getEqldims().getNumEquilRegions();
|
|
bool useThpres = deck.hasKeyword("THPRES") && numEquilRegions > 1;
|
|
bool useSwatinit =
|
|
GET_PROP_VALUE(TypeTag, EnableSwatinit) &&
|
|
eclState.get3DProperties().hasDeckDoubleGridProperty("SWATINIT");
|
|
|
|
// initial condition corresponds to hydrostatic conditions. The SWATINIT keyword
|
|
// can be considered here directly if threshold pressures are disabled.
|
|
typedef Ewoms::EclEquilInitializer<TypeTag> EquilInitializer;
|
|
EquilInitializer equilInitializer(this->simulator(),
|
|
*materialLawManager_,
|
|
/*enableSwatinit=*/useThpres && useSwatinit);
|
|
|
|
// since the EquilInitializer provides fluid states that are consistent with the
|
|
// black-oil model, we can use naive instead of mass conservative determination
|
|
// of the primary variables.
|
|
useMassConservativeInitialCondition_ = false;
|
|
|
|
size_t numElems = this->model().numGridDof();
|
|
initialFluidStates_.resize(numElems);
|
|
for (size_t elemIdx = 0; elemIdx < numElems; ++elemIdx) {
|
|
auto& elemFluidState = initialFluidStates_[elemIdx];
|
|
elemFluidState.assign(equilInitializer.initialFluidState(elemIdx));
|
|
}
|
|
}
|
|
|
|
void readExplicitInitialCondition_()
|
|
{
|
|
const auto& gridManager = this->simulator().gridManager();
|
|
const auto& deck = gridManager.deck();
|
|
const auto& eclState = gridManager.eclState();
|
|
|
|
// since the values specified in the deck do not need to be consistent, we use an
|
|
// initial condition that conserves the total mass specified by these values, but
|
|
// for this to work all three phases must be active.
|
|
useMassConservativeInitialCondition_ = (FluidSystem::numActivePhases() == 3);
|
|
|
|
// make sure all required quantities are enables
|
|
if (FluidSystem::phaseIsActive(waterPhaseIdx) && !deck.hasKeyword("SWAT"))
|
|
OPM_THROW(std::runtime_error,
|
|
"The ECL input file requires the presence of the SWAT keyword if "
|
|
"the water phase is active");
|
|
if (FluidSystem::phaseIsActive(gasPhaseIdx) && !deck.hasKeyword("SGAS"))
|
|
OPM_THROW(std::runtime_error,
|
|
"The ECL input file requires the presence of the SGAS keyword if "
|
|
"the gas phase is active");
|
|
|
|
if (!deck.hasKeyword("PRESSURE"))
|
|
OPM_THROW(std::runtime_error,
|
|
"The ECL input file requires the presence of the PRESSURE "
|
|
"keyword if the model is initialized explicitly");
|
|
if (FluidSystem::enableDissolvedGas() && !deck.hasKeyword("RS"))
|
|
OPM_THROW(std::runtime_error,
|
|
"The ECL input file requires the RS keyword to be present if"
|
|
" dissolved gas is enabled");
|
|
if (FluidSystem::enableVaporizedOil() && !deck.hasKeyword("RV"))
|
|
OPM_THROW(std::runtime_error,
|
|
"The ECL input file requires the RV keyword to be present if"
|
|
" vaporized oil is enabled");
|
|
|
|
size_t numDof = this->model().numGridDof();
|
|
|
|
initialFluidStates_.resize(numDof);
|
|
|
|
const auto& cartSize = this->simulator().gridManager().cartesianDimensions();
|
|
size_t numCartesianCells = cartSize[0] * cartSize[1] * cartSize[2];
|
|
|
|
std::vector<double> waterSaturationData;
|
|
if (FluidSystem::phaseIsActive(waterPhaseIdx))
|
|
waterSaturationData = deck.getKeyword("SWAT").getSIDoubleData();
|
|
else
|
|
waterSaturationData.resize(numCartesianCells, 0.0);
|
|
|
|
std::vector<double> gasSaturationData;
|
|
if (FluidSystem::phaseIsActive(gasPhaseIdx))
|
|
gasSaturationData = deck.getKeyword("SGAS").getSIDoubleData();
|
|
else
|
|
gasSaturationData.resize(numCartesianCells, 0.0);
|
|
|
|
const std::vector<double>& pressureData =
|
|
deck.getKeyword("PRESSURE").getSIDoubleData();
|
|
const std::vector<double> *rsData = 0;
|
|
if (FluidSystem::enableDissolvedGas())
|
|
rsData = &deck.getKeyword("RS").getSIDoubleData();
|
|
const std::vector<double> *rvData = 0;
|
|
if (FluidSystem::enableVaporizedOil())
|
|
rvData = &deck.getKeyword("RV").getSIDoubleData();
|
|
// initial reservoir temperature
|
|
const std::vector<double>& tempiData =
|
|
eclState.get3DProperties().getDoubleGridProperty("TEMPI").getData();
|
|
|
|
// make sure that the size of the data arrays is correct
|
|
#ifndef NDEBUG
|
|
assert(waterSaturationData.size() == numCartesianCells);
|
|
assert(gasSaturationData.size() == numCartesianCells);
|
|
assert(pressureData.size() == numCartesianCells);
|
|
if (FluidSystem::enableDissolvedGas())
|
|
assert(rsData->size() == numCartesianCells);
|
|
if (FluidSystem::enableVaporizedOil())
|
|
assert(rvData->size() == numCartesianCells);
|
|
#endif
|
|
|
|
// calculate the initial fluid states
|
|
for (size_t dofIdx = 0; dofIdx < numDof; ++dofIdx) {
|
|
auto& dofFluidState = initialFluidStates_[dofIdx];
|
|
|
|
int pvtRegionIdx = pvtRegionIndex(dofIdx);
|
|
size_t cartesianDofIdx = gridManager.cartesianIndex(dofIdx);
|
|
assert(0 <= cartesianDofIdx);
|
|
assert(cartesianDofIdx <= numCartesianCells);
|
|
|
|
//////
|
|
// set temperature
|
|
//////
|
|
Scalar temperature = tempiData[cartesianDofIdx];
|
|
if (!std::isfinite(temperature) || temperature <= 0)
|
|
temperature = FluidSystem::surfaceTemperature;
|
|
dofFluidState.setTemperature(temperature);
|
|
|
|
//////
|
|
// set saturations
|
|
//////
|
|
dofFluidState.setSaturation(FluidSystem::waterPhaseIdx,
|
|
waterSaturationData[cartesianDofIdx]);
|
|
dofFluidState.setSaturation(FluidSystem::gasPhaseIdx,
|
|
gasSaturationData[cartesianDofIdx]);
|
|
dofFluidState.setSaturation(FluidSystem::oilPhaseIdx,
|
|
1.0
|
|
- waterSaturationData[cartesianDofIdx]
|
|
- gasSaturationData[cartesianDofIdx]);
|
|
|
|
//////
|
|
// set phase pressures
|
|
//////
|
|
Scalar oilPressure = pressureData[cartesianDofIdx];
|
|
|
|
// this assumes that capillary pressures only depend on the phase saturations
|
|
// and possibly on temperature. (this is always the case for ECL problems.)
|
|
Dune::FieldVector< Scalar, numPhases > pc( 0 );
|
|
const auto& matParams = materialLawParams(dofIdx);
|
|
MaterialLaw::capillaryPressures(pc, matParams, dofFluidState);
|
|
Opm::Valgrind::CheckDefined(oilPressure);
|
|
Opm::Valgrind::CheckDefined(pc);
|
|
for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx)
|
|
dofFluidState.setPressure(phaseIdx, oilPressure + (pc[phaseIdx] - pc[oilPhaseIdx]));
|
|
|
|
//////
|
|
// set compositions
|
|
//////
|
|
|
|
// reset all mole fractions to 0
|
|
for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx)
|
|
for (unsigned compIdx = 0; compIdx < numComponents; ++compIdx)
|
|
dofFluidState.setMoleFraction(phaseIdx, compIdx, 0.0);
|
|
|
|
// by default, assume immiscibility for all phases
|
|
dofFluidState.setMoleFraction(waterPhaseIdx, waterCompIdx, 1.0);
|
|
dofFluidState.setMoleFraction(gasPhaseIdx, gasCompIdx, 1.0);
|
|
dofFluidState.setMoleFraction(oilPhaseIdx, oilCompIdx, 1.0);
|
|
|
|
if (FluidSystem::enableDissolvedGas()) {
|
|
Scalar RsSat = FluidSystem::saturatedDissolutionFactor(dofFluidState, oilPhaseIdx, pvtRegionIdx);
|
|
Scalar RsReal = (*rsData)[cartesianDofIdx];
|
|
|
|
if (RsReal > RsSat) {
|
|
std::array<int, 3> ijk;
|
|
gridManager.cartesianCoordinate(dofIdx, ijk);
|
|
std::cerr << "Warning: The specified amount gas (R_s = " << RsReal << ") is more"
|
|
<< " than the maximium\n"
|
|
<< " amount which can be dissolved in oil"
|
|
<< " (R_s,max=" << RsSat << ")"
|
|
<< " for cell (" << ijk[0] << ", " << ijk[1] << ", " << ijk[2] << ")."
|
|
<< " Using maximimum.\n";
|
|
RsReal = RsSat;
|
|
}
|
|
|
|
// calculate the initial oil phase composition in terms of mole fractions
|
|
Scalar XoGReal = FluidSystem::convertRsToXoG(RsReal, pvtRegionIdx);
|
|
Scalar xoGReal = FluidSystem::convertXoGToxoG(XoGReal, pvtRegionIdx);
|
|
|
|
// finally, set the oil-phase composition
|
|
dofFluidState.setMoleFraction(oilPhaseIdx, gasCompIdx, xoGReal);
|
|
dofFluidState.setMoleFraction(oilPhaseIdx, oilCompIdx, 1.0 - xoGReal);
|
|
}
|
|
|
|
if (FluidSystem::enableVaporizedOil()) {
|
|
Scalar RvSat = FluidSystem::saturatedDissolutionFactor(dofFluidState, gasPhaseIdx, pvtRegionIdx);
|
|
Scalar RvReal = (*rvData)[cartesianDofIdx];
|
|
|
|
if (RvReal > RvSat) {
|
|
std::array<int, 3> ijk;
|
|
gridManager.cartesianCoordinate(dofIdx, ijk);
|
|
std::cerr << "Warning: The specified amount oil (R_v = " << RvReal << ") is more"
|
|
<< " than the maximium\n"
|
|
<< " amount which can be dissolved in gas"
|
|
<< " (R_v,max=" << RvSat << ")"
|
|
<< " for cell (" << ijk[0] << ", " << ijk[1] << ", " << ijk[2] << ")."
|
|
<< " Using maximimum.\n";
|
|
RvReal = RvSat;
|
|
}
|
|
|
|
// calculate the initial gas phase composition in terms of mole fractions
|
|
Scalar XgOReal = FluidSystem::convertRvToXgO(RvReal, pvtRegionIdx);
|
|
Scalar xgOReal = FluidSystem::convertXgOToxgO(XgOReal, pvtRegionIdx);
|
|
|
|
// finally, set the gas-phase composition
|
|
dofFluidState.setMoleFraction(gasPhaseIdx, oilCompIdx, xgOReal);
|
|
dofFluidState.setMoleFraction(gasPhaseIdx, gasCompIdx, 1.0 - xgOReal);
|
|
}
|
|
}
|
|
}
|
|
|
|
// update the hysteresis parameters of the material laws for the whole grid
|
|
bool updateHysteresis_()
|
|
{
|
|
if (!materialLawManager_->enableHysteresis())
|
|
return false;
|
|
|
|
// we need to update the hysteresis data for _all_ elements (i.e., not just the
|
|
// interior ones) to avoid desynchronization of the processes in the parallel case!
|
|
ElementContext elemCtx(this->simulator());
|
|
const auto& gridManager = this->simulator().gridManager();
|
|
auto elemIt = gridManager.gridView().template begin</*codim=*/0>();
|
|
const auto& elemEndIt = gridManager.gridView().template end</*codim=*/0>();
|
|
for (; elemIt != elemEndIt; ++elemIt) {
|
|
const Element& elem = *elemIt;
|
|
|
|
elemCtx.updatePrimaryStencil(elem);
|
|
elemCtx.updatePrimaryIntensiveQuantities(/*timeIdx=*/0);
|
|
|
|
unsigned compressedDofIdx = elemCtx.globalSpaceIndex(/*spaceIdx=*/0, /*timeIdx=*/0);
|
|
const auto& intQuants = elemCtx.intensiveQuantities(/*spaceIdx=*/0, /*timeIdx=*/0);
|
|
materialLawManager_->updateHysteresis(intQuants.fluidState(), compressedDofIdx);
|
|
}
|
|
return true;
|
|
}
|
|
|
|
void updatePvtnum_()
|
|
{
|
|
const auto& eclState = this->simulator().gridManager().eclState();
|
|
const auto& eclProps = eclState.get3DProperties();
|
|
|
|
if (!eclProps.hasDeckIntGridProperty("PVTNUM"))
|
|
return;
|
|
|
|
const auto& pvtnumData = eclProps.getIntGridProperty("PVTNUM").getData();
|
|
const auto& gridManager = this->simulator().gridManager();
|
|
|
|
unsigned numElems = gridManager.gridView().size(/*codim=*/0);
|
|
pvtnum_.resize(numElems);
|
|
for (unsigned elemIdx = 0; elemIdx < numElems; ++elemIdx) {
|
|
unsigned cartElemIdx = gridManager.cartesianIndex(elemIdx);
|
|
pvtnum_[elemIdx] = pvtnumData[cartElemIdx] - 1;
|
|
}
|
|
}
|
|
|
|
struct PffDofData_
|
|
{
|
|
Scalar transmissibility;
|
|
};
|
|
|
|
// update the prefetch friendly data object
|
|
void updatePffDofData_()
|
|
{
|
|
const auto& distFn =
|
|
[this](PffDofData_& dofData,
|
|
const Stencil& stencil,
|
|
unsigned localDofIdx)
|
|
-> void
|
|
{
|
|
const auto& elementMapper = this->model().elementMapper();
|
|
|
|
#if DUNE_VERSION_NEWER(DUNE_COMMON, 2,4)
|
|
unsigned globalElemIdx = elementMapper.index(stencil.entity(localDofIdx));
|
|
#else
|
|
unsigned globalElemIdx = elementMapper.map(stencil.entity(localDofIdx));
|
|
#endif
|
|
|
|
if (localDofIdx != 0) {
|
|
#if DUNE_VERSION_NEWER(DUNE_COMMON, 2,4)
|
|
unsigned globalCenterElemIdx = elementMapper.index(stencil.entity(/*dofIdx=*/0));
|
|
#else
|
|
unsigned globalCenterElemIdx = elementMapper.map(stencil.entity(/*dofIdx=*/0));
|
|
#endif
|
|
dofData.transmissibility = transmissibilities_.transmissibility(globalCenterElemIdx, globalElemIdx);
|
|
}
|
|
};
|
|
|
|
pffDofData_.update(distFn);
|
|
}
|
|
|
|
std::vector<Scalar> porosity_;
|
|
std::vector<Scalar> elementCenterDepth_;
|
|
EclTransmissibility<TypeTag> transmissibilities_;
|
|
|
|
std::shared_ptr<EclMaterialLawManager> materialLawManager_;
|
|
|
|
EclThresholdPressure<TypeTag> thresholdPressures_;
|
|
|
|
std::vector<unsigned short> pvtnum_;
|
|
std::vector<unsigned short> rockTableIdx_;
|
|
std::vector<RockParams> rockParams_;
|
|
|
|
bool useMassConservativeInitialCondition_;
|
|
std::vector<ScalarFluidState> initialFluidStates_;
|
|
|
|
EclWellManager<TypeTag> wellManager_;
|
|
|
|
EclDeckUnits<TypeTag> deckUnits_;
|
|
|
|
std::unique_ptr< EclWriterType > eclWriter_;
|
|
EclSummaryWriter summaryWriter_;
|
|
|
|
PffGridVector<GridView, Stencil, PffDofData_, DofMapper> pffDofData_;
|
|
};
|
|
} // namespace Ewoms
|
|
|
|
#endif
|