OilfieldToolsNet/opm-simulators
4
0
Fork 0
mirror of https://github.com/OPM/opm-simulators.git synced 2025-02-25 18:55:30 -06:00
Code Issues Packages Projects Releases Wiki Activity

blackoilfoammodules: put parameters in separate class

Browse Source 
limits the amount of static variable declarations
This commit is contained in:
Arne Morten Kvarving 2022-09-13 08:51:22 +02:00
parent 36cce77c53
commit 6933875120
2 changed files with 110 additions and 91 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

116
opm/models/blackoil/blackoilfoammodules.hh
View File

@ -32,7 +32,7 @@
#include <opm/common/OpmLog/OpmLog.hpp> #include <opm/common/OpmLog/OpmLog.hpp>
#include <opm/material/common/Tabulated1DFunction.hpp> #include <opm/models/blackoil/blackoilfoamparams.hh>
#if HAVE_ECL_INPUT #if HAVE_ECL_INPUT
#include <opm/input/eclipse/EclipseState/EclipseState.hpp> #include <opm/input/eclipse/EclipseState/EclipseState.hpp>
@ -46,6 +46,7 @@
#include <math.h> #include <math.h>
namespace Opm { namespace Opm {
/*! /*!
* \ingroup BlackOil * \ingroup BlackOil
* \brief Contains the high level supplements required to extend the black oil * \brief Contains the high level supplements required to extend the black oil
@ -69,7 +70,7 @@ class BlackOilFoamModule
using Toolbox = MathToolbox<Evaluation>; using Toolbox = MathToolbox<Evaluation>;
using TabulatedFunction = Tabulated1DFunction<Scalar>; using TabulatedFunction = typename BlackOilFoamParams<Scalar>::TabulatedFunction;
static constexpr unsigned foamConcentrationIdx = Indices::foamConcentrationIdx; static constexpr unsigned foamConcentrationIdx = Indices::foamConcentrationIdx;
static constexpr unsigned contiFoamEqIdx = Indices::contiFoamEqIdx; static constexpr unsigned contiFoamEqIdx = Indices::contiFoamEqIdx;
@ -82,29 +83,6 @@ class BlackOilFoamModule
static constexpr unsigned numPhases = FluidSystem::numPhases; static constexpr unsigned numPhases = FluidSystem::numPhases;
public: public:
// a struct containing constants to calculate change to relative permeability,
// based on model (1-9) in Table 1 of
// Kun Ma, Guangwei Ren, Khalid Mateen, Danielle Morel, and Philippe Cordelier:
// "Modeling techniques for foam flow in porous media", SPE Journal, 20(03):453–470, jun 2015.
// The constants are provided by various deck keywords as shown in the comments below.
struct FoamCoefficients {
Scalar fm_min = 1e-20; // FOAMFSC
Scalar fm_mob = 1.0; // FOAMFRM
Scalar fm_surf = 1.0; // FOAMFSC
Scalar ep_surf = 1.0; // FOAMFSC
Scalar fm_oil = 1.0; // FOAMFSO
Scalar fl_oil = 0.0; // FOAMFSO
Scalar ep_oil = 0.0; // FOAMFSO
Scalar fm_cap = 1.0; // FOAMFCN
Scalar ep_cap = 0.0; // FOAMFCN
Scalar fm_dry = 1.0; // FOAMFSW
Scalar ep_dry = 0.0; // FOAMFSW
};
#if HAVE_ECL_INPUT #if HAVE_ECL_INPUT
/*! /*!
* \brief Initialize all internal data structures needed by the foam module * \brief Initialize all internal data structures needed by the foam module
@ -137,9 +115,9 @@ public:
const auto& tableManager = eclState.getTableManager(); const auto& tableManager = eclState.getTableManager();
const unsigned int numSatRegions = tableManager.getTabdims().getNumSatTables(); const unsigned int numSatRegions = tableManager.getTabdims().getNumSatTables();
setNumSatRegions(numSatRegions); params_.setNumSatRegions(numSatRegions);
const unsigned int numPvtRegions = tableManager.getTabdims().getNumPVTTables(); const unsigned int numPvtRegions = tableManager.getTabdims().getNumPVTTables();
setNumPvtRegions(numPvtRegions); params_.gasMobilityMultiplierTable_.resize(numPvtRegions);
// Get and check FOAMROCK data. // Get and check FOAMROCK data.
const FoamConfig& foamConf = eclState.getInitConfig().getFoamConfig(); const FoamConfig& foamConf = eclState.getInitConfig().getFoamConfig();
@ -161,16 +139,16 @@ public:
// Set data that vary with saturation region. // Set data that vary with saturation region.
for (std::size_t satReg = 0; satReg < numSatRegions; ++satReg) { for (std::size_t satReg = 0; satReg < numSatRegions; ++satReg) {
const auto& rec = foamConf.getRecord(satReg); const auto& rec = foamConf.getRecord(satReg);
foamCoefficients_[satReg] = FoamCoefficients(); params_.foamCoefficients_[satReg] = typename BlackOilFoamParams<Scalar>::FoamCoefficients();
foamCoefficients_[satReg].fm_min = rec.minimumSurfactantConcentration(); params_.foamCoefficients_[satReg].fm_min = rec.minimumSurfactantConcentration();
foamCoefficients_[satReg].fm_surf = rec.referenceSurfactantConcentration(); params_.foamCoefficients_[satReg].fm_surf = rec.referenceSurfactantConcentration();
foamCoefficients_[satReg].ep_surf = rec.exponent(); params_.foamCoefficients_[satReg].ep_surf = rec.exponent();
foamRockDensity_[satReg] = rec.rockDensity(); params_.foamRockDensity_[satReg] = rec.rockDensity();
foamAllowDesorption_[satReg] = rec.allowDesorption(); params_.foamAllowDesorption_[satReg] = rec.allowDesorption();
const auto& foamadsTable = foamadsTables.template getTable<FoamadsTable>(satReg); const auto& foamadsTable = foamadsTables.template getTable<FoamadsTable>(satReg);
const auto& conc = foamadsTable.getFoamConcentrationColumn(); const auto& conc = foamadsTable.getFoamConcentrationColumn();
const auto& ads = foamadsTable.getAdsorbedFoamColumn(); const auto& ads = foamadsTable.getAdsorbedFoamColumn();
adsorbedFoamTable_[satReg].setXYContainers(conc, ads); params_.adsorbedFoamTable_[satReg].setXYContainers(conc, ads);
} }
// Get and check FOAMMOB data. // Get and check FOAMMOB data.
@ -191,32 +169,11 @@ public:
const auto& foammobTable = foammobTables.template getTable<FoammobTable>(pvtReg); const auto& foammobTable = foammobTables.template getTable<FoammobTable>(pvtReg);
const auto& conc = foammobTable.getFoamConcentrationColumn(); const auto& conc = foammobTable.getFoamConcentrationColumn();
const auto& mobMult = foammobTable.getMobilityMultiplierColumn(); const auto& mobMult = foammobTable.getMobilityMultiplierColumn();
gasMobilityMultiplierTable_[pvtReg].setXYContainers(conc, mobMult); params_.gasMobilityMultiplierTable_[pvtReg].setXYContainers(conc, mobMult);
} }
} }
#endif #endif
/*!
* \brief Specify the number of saturation regions.
*/
static void setNumSatRegions(unsigned numRegions)
{
foamCoefficients_.resize(numRegions);
foamRockDensity_.resize(numRegions);
foamAllowDesorption_.resize(numRegions);
adsorbedFoamTable_.resize(numRegions);
}
/*!
* \brief Specify the number of PVT regions.
*/
static void setNumPvtRegions(unsigned numRegions)
{
gasMobilityMultiplierTable_.resize(numRegions);
}
/*! /*!
* \brief Register all run-time parameters for the black-oil foam module. * \brief Register all run-time parameters for the black-oil foam module.
*/ */
@ -389,7 +346,7 @@ public:
unsigned timeIdx) unsigned timeIdx)
{ {
unsigned satnumRegionIdx = elemCtx.problem().satnumRegionIndex(elemCtx, scvIdx, timeIdx); unsigned satnumRegionIdx = elemCtx.problem().satnumRegionIndex(elemCtx, scvIdx, timeIdx);
return foamRockDensity_[satnumRegionIdx]; return params_.foamRockDensity_[satnumRegionIdx];
} }
static bool foamAllowDesorption(const ElementContext& elemCtx, static bool foamAllowDesorption(const ElementContext& elemCtx,
@ -397,7 +354,7 @@ public:
unsigned timeIdx) unsigned timeIdx)
{ {
unsigned satnumRegionIdx = elemCtx.problem().satnumRegionIndex(elemCtx, scvIdx, timeIdx); unsigned satnumRegionIdx = elemCtx.problem().satnumRegionIndex(elemCtx, scvIdx, timeIdx);
return foamAllowDesorption_[satnumRegionIdx]; return params_.foamAllowDesorption_[satnumRegionIdx];
} }
static const TabulatedFunction& adsorbedFoamTable(const ElementContext& elemCtx, static const TabulatedFunction& adsorbedFoamTable(const ElementContext& elemCtx,
@ -405,7 +362,7 @@ public:
unsigned timeIdx) unsigned timeIdx)
{ {
unsigned satnumRegionIdx = elemCtx.problem().satnumRegionIndex(elemCtx, scvIdx, timeIdx); unsigned satnumRegionIdx = elemCtx.problem().satnumRegionIndex(elemCtx, scvIdx, timeIdx);
return adsorbedFoamTable_[satnumRegionIdx]; return params_.adsorbedFoamTable_[satnumRegionIdx];
} }
static const TabulatedFunction& gasMobilityMultiplierTable(const ElementContext& elemCtx, static const TabulatedFunction& gasMobilityMultiplierTable(const ElementContext& elemCtx,
@ -413,47 +370,25 @@ public:
unsigned timeIdx) unsigned timeIdx)
{ {
unsigned pvtnumRegionIdx = elemCtx.problem().pvtRegionIndex(elemCtx, scvIdx, timeIdx); unsigned pvtnumRegionIdx = elemCtx.problem().pvtRegionIndex(elemCtx, scvIdx, timeIdx);
return gasMobilityMultiplierTable_[pvtnumRegionIdx]; return params_.gasMobilityMultiplierTable_[pvtnumRegionIdx];
} }
static const FoamCoefficients& foamCoefficients(const ElementContext& elemCtx, static const typename BlackOilFoamParams<Scalar>::FoamCoefficients&
const unsigned scvIdx, foamCoefficients(const ElementContext& elemCtx,
const unsigned timeIdx) const unsigned scvIdx,
const unsigned timeIdx)
{ {
unsigned satnumRegionIdx = elemCtx.problem().satnumRegionIndex(elemCtx, scvIdx, timeIdx); unsigned satnumRegionIdx = elemCtx.problem().satnumRegionIndex(elemCtx, scvIdx, timeIdx);
return foamCoefficients_[satnumRegionIdx]; return params_.foamCoefficients_[satnumRegionIdx];
} }
private: private:
static std::vector<Scalar> foamRockDensity_; static BlackOilFoamParams<Scalar> params_;
static std::vector<bool> foamAllowDesorption_;
static std::vector<FoamCoefficients> foamCoefficients_;
static std::vector<TabulatedFunction> adsorbedFoamTable_;
static std::vector<TabulatedFunction> gasMobilityMultiplierTable_;
}; };
template <class TypeTag, bool enableFoam> template <class TypeTag, bool enableFoam>
std::vector<typename BlackOilFoamModule<TypeTag, enableFoam>::Scalar> BlackOilFoamParams<typename BlackOilFoamModule<TypeTag, enableFoam>::Scalar>
BlackOilFoamModule<TypeTag, enableFoam>::foamRockDensity_; BlackOilFoamModule<TypeTag, enableFoam>::params_;
template <class TypeTag, bool enableFoam>
std::vector<bool>
BlackOilFoamModule<TypeTag, enableFoam>::foamAllowDesorption_;
template <class TypeTag, bool enableFoam>
std::vector<typename BlackOilFoamModule<TypeTag, enableFoam>::FoamCoefficients>
BlackOilFoamModule<TypeTag, enableFoam>::foamCoefficients_;
template <class TypeTag, bool enableFoam>
std::vector<typename BlackOilFoamModule<TypeTag, enableFoam>::TabulatedFunction>
BlackOilFoamModule<TypeTag, enableFoam>::adsorbedFoamTable_;
template <class TypeTag, bool enableFoam>
std::vector<typename BlackOilFoamModule<TypeTag, enableFoam>::TabulatedFunction>
BlackOilFoamModule<TypeTag, enableFoam>::gasMobilityMultiplierTable_;
/*! /*!
* \ingroup BlackOil * \ingroup BlackOil
@ -594,7 +529,6 @@ public:
{ throw std::runtime_error("foamAdsorbed() called but foam is disabled"); } { throw std::runtime_error("foamAdsorbed() called but foam is disabled"); }
}; };
} // namespace Opm } // namespace Opm
#endif #endif

85
opm/models/blackoil/blackoilfoamparams.hh Normal file
View File

@ -0,0 +1,85 @@
// -*- 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
*
* \brief Contains the parameters to extend the black-oil model to include the effects of foam.
*/
#ifndef EWOMS_BLACK_OIL_FOAM_PARAMS_HH
#define EWOMS_BLACK_OIL_FOAM_PARAMS_HH
#include <opm/material/common/Tabulated1DFunction.hpp>
#include <vector>
namespace Opm {
//! \brief Struct holding the parameters for the BlackoilFoamModule class.
template<class Scalar>
struct BlackOilFoamParams {
using TabulatedFunction = Tabulated1DFunction<Scalar>;
/*!
* \brief Specify the number of saturation regions.
*/
void setNumSatRegions(unsigned numRegions)
{
foamCoefficients_.resize(numRegions);
foamRockDensity_.resize(numRegions);
foamAllowDesorption_.resize(numRegions);
adsorbedFoamTable_.resize(numRegions);
}
// a struct containing constants to calculate change to relative permeability,
// based on model (1-9) in Table 1 of
// Kun Ma, Guangwei Ren, Khalid Mateen, Danielle Morel, and Philippe Cordelier:
// "Modeling techniques for foam flow in porous media", SPE Journal, 20(03):453–470, jun 2015.
// The constants are provided by various deck keywords as shown in the comments below.
struct FoamCoefficients {
Scalar fm_min = 1e-20; // FOAMFSC
Scalar fm_mob = 1.0; // FOAMFRM
Scalar fm_surf = 1.0; // FOAMFSC
Scalar ep_surf = 1.0; // FOAMFSC
Scalar fm_oil = 1.0; // FOAMFSO
Scalar fl_oil = 0.0; // FOAMFSO
Scalar ep_oil = 0.0; // FOAMFSO
Scalar fm_cap = 1.0; // FOAMFCN
Scalar ep_cap = 0.0; // FOAMFCN
Scalar fm_dry = 1.0; // FOAMFSW
Scalar ep_dry = 0.0; // FOAMFSW
};
std::vector<Scalar> foamRockDensity_;
std::vector<bool> foamAllowDesorption_;
std::vector<FoamCoefficients> foamCoefficients_;
std::vector<TabulatedFunction> adsorbedFoamTable_;
std::vector<TabulatedFunction> gasMobilityMultiplierTable_;
};
} // namespace Opm
#endif