OilfieldToolsNet/opm-common
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #3316 from akva2/blackoilfluidsystem_compile_unit

Browse Source 
BlackOilFluidSystem: move more code to compile unit
This commit is contained in:
Bård Skaflestad 2023-01-05 14:27:15 +01:00 committed by GitHub
commit 3e0184f3c0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 189 additions and 141 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CMakeLists_files.cmake
View File

@ -52,6 +52,7 @@ list (APPEND MAIN_SOURCE_FILES
src/opm/material/components/CO2.cpp
src/opm/material/densead/Evaluation.cpp
src/opm/material/fluidmatrixinteractions/EclEpsScalingPoints.cpp
src/opm/material/fluidsystems/BlackOilFluidSystem.cpp
src/opm/material/fluidsystems/blackoilpvt/DeadOilPvt.cpp
src/opm/material/fluidsystems/blackoilpvt/DryGasPvt.cpp
src/opm/material/fluidsystems/blackoilpvt/DryHumidGasPvt.cpp
@ -255,7 +256,6 @@ if(ENABLE_ECL_INPUT)
src/opm/material/fluidmatrixinteractions/EclEpsGridProperties.cpp
src/opm/material/fluidmatrixinteractions/EclHysteresisConfig.cpp
src/opm/material/fluidmatrixinteractions/EclMaterialLawManager.cpp
src/opm/material/fluidsystems/BlackOilFluidSystem.cpp
src/opm/material/fluidsystems/blackoilpvt/BrineCo2Pvt.cpp
src/opm/material/fluidsystems/blackoilpvt/Co2GasPvt.cpp
src/opm/material/fluidsystems/blackoilpvt/ConstantCompressibilityBrinePvt.cpp

151
opm/material/fluidsystems/BlackOilFluidSystem.hpp
View File

@ -41,6 +41,7 @@
#include <opm/material/common/HasMemberGeneratorMacros.hpp>
#include <array>
#include <cstddef>
#include <memory>
#include <stdexcept>
#include <vector>
@ -238,29 +239,7 @@ public:
* compressibility must be set. Before the fluid system can be used, initEnd() must
* be called to finalize the initialization.
*/
static void initBegin(size_t numPvtRegions)
{
isInitialized_ = false;
enableDissolvedGas_ = true;
enableDissolvedGasInWater_ = false;
enableVaporizedOil_ = false;
enableVaporizedWater_ = false;
enableDiffusion_ = false;
oilPvt_ = nullptr;
gasPvt_ = nullptr;
waterPvt_ = nullptr;
surfaceTemperature = 273.15 + 15.56; // [K]
surfacePressure = 1.01325e5; // [Pa]
setReservoirTemperature(surfaceTemperature);
numActivePhases_ = numPhases;
std::fill_n(&phaseIsActive_[0], numPhases, true);
resizeArrays_(numPvtRegions);
}
static void initBegin(std::size_t numPvtRegions);
/*!
* \brief Specify whether the fluid system should consider that the gas component can
@ -334,53 +313,12 @@ public:
static void setReferenceDensities(Scalar rhoOil,
Scalar rhoWater,
Scalar rhoGas,
unsigned regionIdx)
{
referenceDensity_[regionIdx][oilPhaseIdx] = rhoOil;
referenceDensity_[regionIdx][waterPhaseIdx] = rhoWater;
referenceDensity_[regionIdx][gasPhaseIdx] = rhoGas;
}
unsigned regionIdx);
/*!
* \brief Finish initializing the black oil fluid system.
*/
static void initEnd()
{
// calculate the final 2D functions which are used for interpolation.
size_t numRegions = molarMass_.size();
for (unsigned regionIdx = 0; regionIdx < numRegions; ++ regionIdx) {
// calculate molar masses
// water is simple: 18 g/mol
molarMass_[regionIdx][waterCompIdx] = 18e-3;
if (phaseIsActive(gasPhaseIdx)) {
// for gas, we take the density at standard conditions and assume it to be ideal
Scalar p = surfacePressure;
Scalar T = surfaceTemperature;
Scalar rho_g = referenceDensity_[/*regionIdx=*/0][gasPhaseIdx];
molarMass_[regionIdx][gasCompIdx] = Constants<Scalar>::R*T*rho_g / p;
}
else
// hydrogen gas. we just set this do avoid NaNs later
molarMass_[regionIdx][gasCompIdx] = 2e-3;
// finally, for oil phase, we take the molar mass from the spe9 paper
molarMass_[regionIdx][oilCompIdx] = 175e-3; // kg/mol
}
int activePhaseIdx = 0;
for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
if(phaseIsActive(phaseIdx)){
canonicalToActivePhaseIdx_[phaseIdx] = activePhaseIdx;
activeToCanonicalPhaseIdx_[activePhaseIdx] = phaseIdx;
activePhaseIdx++;
}
}
isInitialized_ = true;
}
static void initEnd();
static bool isInitialized()
{ return isInitialized_; }
@ -406,20 +344,7 @@ public:
static Scalar surfaceTemperature;
//! \copydoc BaseFluidSystem::phaseName
static const char* phaseName(unsigned phaseIdx)
{
switch (phaseIdx) {
case waterPhaseIdx:
return "water";
case oilPhaseIdx:
return "oil";
case gasPhaseIdx:
return "gas";
default:
throw std::logic_error("Phase index " + std::to_string(phaseIdx) + " is unknown");
}
}
static const char* phaseName(unsigned phaseIdx);
//! \copydoc BaseFluidSystem::isLiquid
static bool isLiquid(unsigned phaseIdx)
@ -459,54 +384,13 @@ public:
}
//! \brief returns the index of "primary" component of a phase (solvent)
static constexpr unsigned solventComponentIndex(unsigned phaseIdx)
{
switch (phaseIdx) {
case waterPhaseIdx:
return waterCompIdx;
case oilPhaseIdx:
return oilCompIdx;
case gasPhaseIdx:
return gasCompIdx;
default:
throw std::logic_error("Phase index " + std::to_string(phaseIdx) + " is unknown");
}
}
static unsigned solventComponentIndex(unsigned phaseIdx);
//! \brief returns the index of "secondary" component of a phase (solute)
static constexpr unsigned soluteComponentIndex(unsigned phaseIdx)
{
switch (phaseIdx) {
case waterPhaseIdx:
if (enableDissolvedGasInWater())
return gasCompIdx;
throw std::logic_error("The water phase does not have any solutes in the black oil model!");
case oilPhaseIdx:
return gasCompIdx;
case gasPhaseIdx:
return oilCompIdx;
default:
throw std::logic_error("Phase index " + std::to_string(phaseIdx) + " is unknown");
}
}
static unsigned soluteComponentIndex(unsigned phaseIdx);
//! \copydoc BaseFluidSystem::componentName
static const char* componentName(unsigned compIdx)
{
switch (compIdx) {
case waterCompIdx:
return "Water";
case oilCompIdx:
return "Oil";
case gasCompIdx:
return "Gas";
default:
throw std::logic_error("Component index " + std::to_string(compIdx) + " is unknown");
}
}
static const char* componentName(unsigned compIdx);
//! \copydoc BaseFluidSystem::molarMass
static Scalar molarMass(unsigned compIdx, unsigned regionIdx = 0)
@ -537,7 +421,7 @@ public:
*
* By default, this is 1.
*/
static size_t numRegions()
static std::size_t numRegions()
{ return molarMass_.size(); }
/*!
@ -1528,16 +1412,9 @@ public:
static void setReservoirTemperature(Scalar value)
{ reservoirTemperature_ = value; }
static short activeToCanonicalPhaseIdx(unsigned activePhaseIdx) {
assert(activePhaseIdx<numActivePhases());
return activeToCanonicalPhaseIdx_[activePhaseIdx];
}
static short activeToCanonicalPhaseIdx(unsigned activePhaseIdx);
static short canonicalToActivePhaseIdx(unsigned phaseIdx) {
assert(phaseIdx<numPhases);
assert(phaseIsActive(phaseIdx));
return canonicalToActivePhaseIdx_[phaseIdx];
}
static short canonicalToActivePhaseIdx(unsigned phaseIdx);
//! \copydoc BaseFluidSystem::diffusionCoefficient
static Scalar diffusionCoefficient(unsigned compIdx, unsigned phaseIdx, unsigned regionIdx = 0)
@ -1577,11 +1454,7 @@ public:
}
private:
static void resizeArrays_(size_t numRegions)
{
molarMass_.resize(numRegions);
referenceDensity_.resize(numRegions);
}
static void resizeArrays_(std::size_t numRegions);
static Scalar reservoirTemperature_;

177
src/opm/material/fluidsystems/BlackOilFluidSystem.cpp
View File

@ -26,19 +26,22 @@
#include <opm/common/ErrorMacros.hpp>
#if HAVE_ECL_INPUT
#include <opm/input/eclipse/EclipseState/EclipseState.hpp>
#include <opm/input/eclipse/EclipseState/Tables/FlatTable.hpp>
#include <opm/input/eclipse/EclipseState/Tables/TableManager.hpp>
#endif
#include <fmt/format.h>
namespace Opm {
#if HAVE_ECL_INPUT
template <class Scalar, class IndexTraits>
void BlackOilFluidSystem<Scalar,IndexTraits>::
initFromState(const EclipseState& eclState, const Schedule& schedule)
{
size_t numRegions = eclState.runspec().tabdims().getNumPVTTables();
std::size_t numRegions = eclState.runspec().tabdims().getNumPVTTables();
initBegin(numRegions);
numActivePhases_ = 0;
@ -159,6 +162,178 @@ initFromState(const EclipseState& eclState, const Schedule& schedule)
}
}
}
#endif
template <class Scalar, class IndexTraits>
void BlackOilFluidSystem<Scalar,IndexTraits>::
initBegin(std::size_t numPvtRegions)
{
isInitialized_ = false;
enableDissolvedGas_ = true;
enableDissolvedGasInWater_ = false;
enableVaporizedOil_ = false;
enableVaporizedWater_ = false;
enableDiffusion_ = false;
oilPvt_ = nullptr;
gasPvt_ = nullptr;
waterPvt_ = nullptr;
surfaceTemperature = 273.15 + 15.56; // [K]
surfacePressure = 1.01325e5; // [Pa]
setReservoirTemperature(surfaceTemperature);
numActivePhases_ = numPhases;
std::fill_n(&phaseIsActive_[0], numPhases, true);
resizeArrays_(numPvtRegions);
}
template <class Scalar, class IndexTraits>
void BlackOilFluidSystem<Scalar,IndexTraits>::
setReferenceDensities(Scalar rhoOil,
Scalar rhoWater,
Scalar rhoGas,
unsigned regionIdx)
{
referenceDensity_[regionIdx][oilPhaseIdx] = rhoOil;
referenceDensity_[regionIdx][waterPhaseIdx] = rhoWater;
referenceDensity_[regionIdx][gasPhaseIdx] = rhoGas;
}
template <class Scalar, class IndexTraits>
void BlackOilFluidSystem<Scalar,IndexTraits>::initEnd()
{
// calculate the final 2D functions which are used for interpolation.
std::size_t numRegions = molarMass_.size();
for (unsigned regionIdx = 0; regionIdx < numRegions; ++ regionIdx) {
// calculate molar masses
// water is simple: 18 g/mol
molarMass_[regionIdx][waterCompIdx] = 18e-3;
if (phaseIsActive(gasPhaseIdx)) {
// for gas, we take the density at standard conditions and assume it to be ideal
Scalar p = surfacePressure;
Scalar T = surfaceTemperature;
Scalar rho_g = referenceDensity_[/*regionIdx=*/0][gasPhaseIdx];
molarMass_[regionIdx][gasCompIdx] = Constants<Scalar>::R*T*rho_g / p;
}
else
// hydrogen gas. we just set this do avoid NaNs later
molarMass_[regionIdx][gasCompIdx] = 2e-3;
// finally, for oil phase, we take the molar mass from the spe9 paper
molarMass_[regionIdx][oilCompIdx] = 175e-3; // kg/mol
}
int activePhaseIdx = 0;
for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
if(phaseIsActive(phaseIdx)){
canonicalToActivePhaseIdx_[phaseIdx] = activePhaseIdx;
activeToCanonicalPhaseIdx_[activePhaseIdx] = phaseIdx;
activePhaseIdx++;
}
}
isInitialized_ = true;
}
template <class Scalar, class IndexTraits>
const char* BlackOilFluidSystem<Scalar,IndexTraits>::
phaseName(unsigned phaseIdx)
{
switch (phaseIdx) {
case waterPhaseIdx:
return "water";
case oilPhaseIdx:
return "oil";
case gasPhaseIdx:
return "gas";
default:
throw std::logic_error(fmt::format("Phase index {} is unknown", phaseIdx));
}
}
template <class Scalar, class IndexTraits>
unsigned BlackOilFluidSystem<Scalar,IndexTraits>::
solventComponentIndex(unsigned phaseIdx)
{
switch (phaseIdx) {
case waterPhaseIdx:
return waterCompIdx;
case oilPhaseIdx:
return oilCompIdx;
case gasPhaseIdx:
return gasCompIdx;
default:
throw std::logic_error(fmt::format("Phase index {} is unknown", phaseIdx));
}
}
template <class Scalar, class IndexTraits>
unsigned BlackOilFluidSystem<Scalar,IndexTraits>::
soluteComponentIndex(unsigned phaseIdx)
{
switch (phaseIdx) {
case waterPhaseIdx:
if (enableDissolvedGasInWater())
return gasCompIdx;
throw std::logic_error("The water phase does not have any solutes in the black oil model!");
case oilPhaseIdx:
return gasCompIdx;
case gasPhaseIdx:
return oilCompIdx;
default:
throw std::logic_error(fmt::format("Phase index {} is unknown", phaseIdx));
}
}
template <class Scalar, class IndexTraits>
const char* BlackOilFluidSystem<Scalar,IndexTraits>::
componentName(unsigned compIdx)
{
switch (compIdx) {
case waterCompIdx:
return "Water";
case oilCompIdx:
return "Oil";
case gasCompIdx:
return "Gas";
default:
throw std::logic_error(fmt::format("Component index {} is unknown", compIdx));
}
}
template <class Scalar, class IndexTraits>
short BlackOilFluidSystem<Scalar,IndexTraits>::
activeToCanonicalPhaseIdx(unsigned activePhaseIdx)
{
assert(activePhaseIdx<numActivePhases());
return activeToCanonicalPhaseIdx_[activePhaseIdx];
}
template <class Scalar, class IndexTraits>
short BlackOilFluidSystem<Scalar,IndexTraits>::
canonicalToActivePhaseIdx(unsigned phaseIdx)
{
assert(phaseIdx<numPhases);
assert(phaseIsActive(phaseIdx));
return canonicalToActivePhaseIdx_[phaseIdx];
}
template <class Scalar, class IndexTraits>
void BlackOilFluidSystem<Scalar,IndexTraits>::
resizeArrays_(std::size_t numRegions)
{
molarMass_.resize(numRegions);
referenceDensity_.resize(numRegions);
}
template class BlackOilFluidSystem<double,BlackOilDefaultIndexTraits>;
template class BlackOilFluidSystem<float,BlackOilDefaultIndexTraits>;