Loading...
Searching...
No Matches
blackoilratevector.hh
Go to the documentation of this file.
// -*- 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.
*/
#ifndef EWOMS_BLACK_OIL_RATE_VECTOR_HH
#define EWOMS_BLACK_OIL_RATE_VECTOR_HH
#include <dune/common/fvector.hh>
#include <opm/material/common/MathToolbox.hpp>
#include <opm/material/common/Valgrind.hpp>
#include <opm/material/constraintsolvers/NcpFlash.hpp>
#include <opm/models/blackoil/blackoilbioeffectsmodules.hh>
#include <opm/models/blackoil/blackoilbrinemodules.hh>
#include <opm/models/blackoil/blackoilfoammodules.hh>
#include <opm/models/blackoil/blackoilpolymermodules.hh>
#include <opm/models/blackoil/blackoilsolventmodules.hh>
#include <opm/models/common/multiphasebaseproperties.hh>
#include <opm/models/discretization/common/fvbaseproperties.hh>
#include <stdexcept>
namespace Opm {
template <class TypeTag>
class BlackOilRateVector
: public Dune::FieldVector<GetPropType<TypeTag, Properties::Evaluation>,
getPropValue<TypeTag, Properties::NumEq>()>
{
using Scalar = GetPropType<TypeTag, Properties::Scalar>;
using Evaluation = GetPropType<TypeTag, Properties::Evaluation>;
using FluidSystem = GetPropType<TypeTag, Properties::FluidSystem>;
using Indices = GetPropType<TypeTag, Properties::Indices>;
using SolventModule = BlackOilSolventModule<TypeTag>;
using PolymerModule = BlackOilPolymerModule<TypeTag>;
using FoamModule = BlackOilFoamModule<TypeTag>;
using BrineModule = BlackOilBrineModule<TypeTag>;
enum { numEq = getPropValue<TypeTag, Properties::NumEq>() };
enum { numComponents = getPropValue<TypeTag, Properties::NumComponents>() };
enum { conti0EqIdx = Indices::conti0EqIdx };
enum { enableEnergy = getPropValue<TypeTag, Properties::EnableEnergy>() };
enum { enableSolvent = getPropValue<TypeTag, Properties::EnableSolvent>() };
enum { enablePolymer = getPropValue<TypeTag, Properties::EnablePolymer>() };
enum { enablePolymerMolarWeight = getPropValue<TypeTag, Properties::EnablePolymerMW>() };
enum { enableFoam = getPropValue<TypeTag, Properties::EnableFoam>() };
enum { enableBrine = getPropValue<TypeTag, Properties::EnableBrine>() };
enum { enableBioeffects = getPropValue<TypeTag, Properties::EnableBioeffects>() };
using Toolbox = MathToolbox<Evaluation>;
using ParentType = Dune::FieldVector<Evaluation, numEq>;
public:
BlackOilRateVector() : ParentType()
{ Valgrind::SetUndefined(*this); }
BlackOilRateVector(Scalar value) : ParentType(Toolbox::createConstant(value))
{}
void setMassRate(const ParentType& value, unsigned pvtRegionIdx = 0)
{
ParentType::operator=(value);
// convert to "surface volume" if requested
if constexpr (getPropValue<TypeTag, Properties::BlackoilConserveSurfaceVolume>()) {
if (FluidSystem::phaseIsActive(FluidSystem::gasPhaseIdx)) {
(*this)[FluidSystem::canonicalToActiveCompIdx(FluidSystem::gasCompIdx)] /=
FluidSystem::referenceDensity(FluidSystem::gasPhaseIdx, pvtRegionIdx);
}
if (FluidSystem::phaseIsActive(FluidSystem::oilPhaseIdx)) {
(*this)[FluidSystem::canonicalToActiveCompIdx(FluidSystem::oilCompIdx)] /=
FluidSystem::referenceDensity(FluidSystem::oilPhaseIdx, pvtRegionIdx);
}
if (FluidSystem::phaseIsActive(FluidSystem::waterPhaseIdx)) {
(*this)[FluidSystem::canonicalToActiveCompIdx(FluidSystem::waterCompIdx)] /=
FluidSystem::referenceDensity(FluidSystem::waterPhaseIdx, pvtRegionIdx);
}
if constexpr (enableSolvent) {
const auto& solventPvt = SolventModule::solventPvt();
(*this)[Indices::contiSolventEqIdx] /=
solventPvt.referenceDensity(pvtRegionIdx);
}
}
}
void setMolarRate(const ParentType& value, unsigned pvtRegionIdx = 0)
{
// first, assign molar rates
ParentType::operator=(value);
// then, convert them to mass rates
for (unsigned compIdx = 0; compIdx < numComponents; ++compIdx) {
(*this)[conti0EqIdx + compIdx] *= FluidSystem::molarMass(compIdx, pvtRegionIdx);
}
const auto& solventPvt = SolventModule::solventPvt();
(*this)[Indices::contiSolventEqIdx] *= solventPvt.molarMass(pvtRegionIdx);
if constexpr (enablePolymer) {
if constexpr (enablePolymerMolarWeight) {
throw std::logic_error("Set molar rate with polymer weight tracking not implemented");
}
(*this)[Indices::contiPolymerEqIdx] *= PolymerModule::molarMass(pvtRegionIdx);
}
if constexpr (enableFoam) {
throw std::logic_error("setMolarRate() not implemented for foam");
}
if constexpr (enableBrine) {
throw std::logic_error("setMolarRate() not implemented for salt water");
}
if constexpr (enableBioeffects) {
throw std::logic_error("setMolarRate() not implemented for bioeffects (biofilm/MICP)");
}
// convert to "surface volume" if requested
if constexpr (getPropValue<TypeTag, Properties::BlackoilConserveSurfaceVolume>()) {
if (FluidSystem::phaseIsActive(FluidSystem::gasPhaseIdx)) {
(*this)[FluidSystem::canonicalToActiveCompIdx(FluidSystem::gasCompIdx)] /=
FluidSystem::referenceDensity(FluidSystem::gasPhaseIdx, pvtRegionIdx);
}
if (FluidSystem::phaseIsActive(FluidSystem::oilPhaseIdx)) {
(*this)[FluidSystem::canonicalToActiveCompIdx(FluidSystem::oilCompIdx)] /=
FluidSystem::referenceDensity(FluidSystem::oilPhaseIdx, pvtRegionIdx);
}
if (FluidSystem::phaseIsActive(FluidSystem::waterPhaseIdx)) {
(*this)[FluidSystem::canonicalToActiveCompIdx(FluidSystem::waterCompIdx)] /=
FluidSystem::referenceDensity(FluidSystem::waterPhaseIdx, pvtRegionIdx);
}
if constexpr (enableSolvent) {
(*this)[Indices::contiSolventEqIdx] /=
solventPvt.referenceDensity(pvtRegionIdx);
}
}
}
template <class FluidState, class RhsEval>
void setVolumetricRate(const FluidState& fluidState,
unsigned phaseIdx,
const RhsEval& volume)
{
for (unsigned compIdx = 0; compIdx < numComponents; ++compIdx) {
(*this)[conti0EqIdx + compIdx] =
fluidState.density(phaseIdx) *
fluidState.massFraction(phaseIdx, compIdx) *
volume;
}
}
template <class RhsEval>
BlackOilRateVector& operator=(const RhsEval& value)
{
for (unsigned i = 0; i < this->size(); ++i) {
(*this)[i] = value;
}
return *this;
}
};
} // namespace Opm
#endif
blackoilbioeffectsmodules.hh
Contains the classes required to extend the black-oil model by bioeffects.
blackoilbrinemodules.hh
Contains the classes required to extend the black-oil model by brine.
blackoilfoammodules.hh
Contains the classes required to extend the black-oil model to include the effects of foam.
blackoilpolymermodules.hh
Contains the classes required to extend the black-oil model by polymer.
blackoilsolventmodules.hh
Contains the classes required to extend the black-oil model by solvents.
Opm::BlackOilBrineModule
Contains the high level supplements required to extend the black oil model by brine.
Definition blackoilbrinemodules.hh:56
Opm::BlackOilFoamModule
Contains the high level supplements required to extend the black oil model to include the effects of ...
Definition blackoilfoammodules.hh:58
Opm::BlackOilPolymerModule
Contains the high level supplements required to extend the black oil model by polymer.
Definition blackoilpolymermodules.hh:64
Opm::BlackOilRateVector::BlackOilRateVector
BlackOilRateVector(Scalar value)
Definition blackoilratevector.hh:93
Opm::BlackOilRateVector::setMolarRate
void setMolarRate(const ParentType &value, unsigned pvtRegionIdx=0)
Set a molar rate of the conservation quantities.
Definition blackoilratevector.hh:134
Opm::BlackOilRateVector::operator=
BlackOilRateVector & operator=(const RhsEval &value)
Assignment operator from a scalar or a function evaluation.
Definition blackoilratevector.hh:208
Opm::BlackOilRateVector::setVolumetricRate
void setVolumetricRate(const FluidState &fluidState, unsigned phaseIdx, const RhsEval &volume)
Set a volumetric rate of a phase.
Definition blackoilratevector.hh:192
Opm::BlackOilRateVector::setMassRate
void setMassRate(const ParentType &value, unsigned pvtRegionIdx=0)
Set a mass rate of the conservation quantities.
Definition blackoilratevector.hh:102
Opm::BlackOilSolventModule
Contains the high level supplements required to extend the black oil model by solvents.
Definition blackoilsolventmodules.hh:68
fvbaseproperties.hh
Declare the properties used by the infrastructure code of the finite volume discretizations.
multiphasebaseproperties.hh
Defines the common properties required by the porous medium multi-phase models.
Opm
This file contains a set of helper functions used by VFPProd / VFPInj.
Definition blackoilbioeffectsmodules.hh:43
Opm::GetPropType
typename Properties::Detail::GetPropImpl< TypeTag, Property >::type::type GetPropType
get the type alias defined in the property (equivalent to old macro GET_PROP_TYPE(....
Definition propertysystem.hh:233
Opm::getPropValue
constexpr auto getPropValue()
get the value data member of a property
Definition propertysystem.hh:240