blackoiltwophaseindices.hh
Go to the documentation of this file.
1// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2// vi: set et ts=4 sw=4 sts=4:
3/*
4 This file is part of the Open Porous Media project (OPM).
5
6 OPM is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 2 of the License, or
9 (at your option) any later version.
10
11 OPM is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with OPM. If not, see <http://www.gnu.org/licenses/>.
18
19 Consult the COPYING file in the top-level source directory of this
20 module for the precise wording of the license and the list of
21 copyright holders.
22*/
28#ifndef EWOMS_BLACK_OIL_TWO_PHASE_INDICES_HH
29#define EWOMS_BLACK_OIL_TWO_PHASE_INDICES_HH
30
31#include <opm/common/utility/ConstexprAssert.hpp>
32
33#include <cassert>
34
35namespace Opm {
36
42template<unsigned numSolventsV,
43 unsigned numExtbosV,
44 unsigned numPolymersV,
45 unsigned numEnergyV,
46 bool enableFoam,
47 bool enableBrine,
48 unsigned PVOffset,
49 unsigned disabledCanonicalCompIdx,
50 unsigned numBioCompV>
52{
54 static constexpr bool oilEnabled = disabledCanonicalCompIdx != 0;
55 static constexpr bool waterEnabled = disabledCanonicalCompIdx != 1;
56 static constexpr bool gasEnabled = disabledCanonicalCompIdx != 2;
57
59 static constexpr bool enableSolvent = numSolventsV > 0;
60
62 static constexpr bool enableExtbo = numExtbosV > 0;
63
65 static constexpr bool enablePolymer = numPolymersV > 0;
66
68 static constexpr bool enableEnergy = numEnergyV > 0;
69
71 static constexpr bool enableMICP = false;
72
74 static constexpr bool enableBiofilm = numBioCompV > 0;
75
77 static constexpr int numSolvents = enableSolvent ? numSolventsV : 0;
78
80 static constexpr int numExtbos = enableExtbo ? numExtbosV : 0;
81
83 static constexpr int numPolymers = enablePolymer ? numPolymersV : 0;
84
86 static constexpr int numEnergy = enableEnergy ? numEnergyV : 0;
87
89 static constexpr int numFoam = enableFoam? 1 : 0;
90
92 static constexpr int numBrine = enableBrine? 1 : 0;
93
95 static constexpr int numBioComp = enableBiofilm ? numBioCompV : 0;
96
98 static constexpr int numBioInWat = enableBiofilm ? 1 : 0;
99
101 static constexpr int numPhases = 2;
102
104 static constexpr int numEq = numPhases + numSolvents + numExtbos + numPolymers +
106
108 // Primary variable indices
110
119 static constexpr int waterSwitchIdx = waterEnabled ? PVOffset + 0 : -10000;
120
127 static constexpr int pressureSwitchIdx = waterEnabled ? PVOffset + 1 : PVOffset + 0;
128
135 static constexpr int compositionSwitchIdx = (gasEnabled && oilEnabled) ? PVOffset + 1 : -10000;
136
138 static constexpr int solventSaturationIdx =
139 enableSolvent ? PVOffset + numPhases : -1000;
140
142 static constexpr int zFractionIdx =
143 enableExtbo ? PVOffset + numPhases + numSolvents : -1000;
144
146 static constexpr int polymerConcentrationIdx =
147 enablePolymer ? PVOffset + numPhases + numSolvents : -1000;
148
150 static constexpr int polymerMoleWeightIdx =
151 numPolymers > 1 ? polymerConcentrationIdx + 1 : -1000;
152
154 static constexpr int microbialConcentrationIdx =
155 enableBiofilm ? PVOffset + numPhases + numSolvents : -1000;
156
158 static constexpr int biofilmVolumeFractionIdx =
159 enableBiofilm ? PVOffset + numPhases + numSolvents + 1 : -1000;
160
162 static constexpr int oxygenConcentrationIdx = -1000;
163 static constexpr int ureaConcentrationIdx = -1000;
164 static constexpr int calciteVolumeFractionIdx = -1000;
165
167 static constexpr int foamConcentrationIdx =
168 enableFoam ? PVOffset + numPhases + numSolvents + numPolymers + numBioComp : -1000;
169
171 static constexpr int saltConcentrationIdx =
172 enableBrine ? PVOffset + numPhases + numSolvents + numPolymers + numBioComp + numFoam : -1000;
173
175 static constexpr int temperatureIdx =
177
179 // Equation indices
181
183 static constexpr int conti0EqIdx = PVOffset + 0;
184 // one continuity equation follows
185
187 static constexpr int contiSolventEqIdx =
188 enableSolvent ? PVOffset + numPhases : -1000;
189
191 static constexpr int contiZfracEqIdx =
192 enableExtbo ? PVOffset + numPhases + numSolvents : -1000;
193
195 static constexpr int contiPolymerEqIdx =
196 enablePolymer ? PVOffset + numPhases + numSolvents : -1000;
197
199 static constexpr int contiPolymerMWEqIdx =
200 numPolymers > 1 ? contiPolymerEqIdx + 1 : -1000;
201
203 static constexpr int contiMicrobialEqIdx =
204 enableBiofilm ? PVOffset + numPhases + numSolvents : -1000;
205
207 static constexpr int contiBiofilmEqIdx =
208 enableBiofilm ? PVOffset + numPhases + numSolvents + 1 : -1000;
209
211 static constexpr int contiOxygenEqIdx = -1000;
212 static constexpr int contiUreaEqIdx = -1000;
213 static constexpr int contiCalciteEqIdx = -1000;
214
216 static constexpr int contiFoamEqIdx =
217 enableFoam ? PVOffset + numPhases + numSolvents + numPolymers + numBioComp : -1000;
218
220 static constexpr int contiBrineEqIdx =
221 enableBrine ? PVOffset + numPhases + numSolvents + numPolymers + numBioComp + numFoam : -1000;
222
224 static constexpr int contiEnergyEqIdx =
226};
227
228} // namespace Opm
229
230#endif
Definition: blackoilbioeffectsmodules.hh:43
The primary variable and equation indices for the black-oil model.
Definition: blackoiltwophaseindices.hh:52
static constexpr int numEnergy
Number of energy equations to be considered.
Definition: blackoiltwophaseindices.hh:86
static constexpr int solventSaturationIdx
Index of the primary variable for the first solvent.
Definition: blackoiltwophaseindices.hh:138
static constexpr int contiOxygenEqIdx
MICP only available for one phase indices.
Definition: blackoiltwophaseindices.hh:211
static constexpr bool enableSolvent
Are solvents involved?
Definition: blackoiltwophaseindices.hh:59
static constexpr int temperatureIdx
Index of the primary variable for temperature.
Definition: blackoiltwophaseindices.hh:175
static constexpr bool enableBiofilm
Are biofilms involved?
Definition: blackoiltwophaseindices.hh:74
static constexpr int numPhases
The number of fluid phases.
Definition: blackoiltwophaseindices.hh:101
static constexpr int contiBiofilmEqIdx
Index of the continuity equation for the biofilm component.
Definition: blackoiltwophaseindices.hh:207
static constexpr int contiEnergyEqIdx
Index of the continuity equation for energy.
Definition: blackoiltwophaseindices.hh:224
static constexpr int contiPolymerEqIdx
Index of the continuity equation for the first polymer component.
Definition: blackoiltwophaseindices.hh:195
static constexpr int ureaConcentrationIdx
Definition: blackoiltwophaseindices.hh:163
static constexpr int numBrine
Number of salt equations to be considered.
Definition: blackoiltwophaseindices.hh:92
static constexpr int foamConcentrationIdx
Index of the primary variable for the foam.
Definition: blackoiltwophaseindices.hh:167
static constexpr bool enableEnergy
Shall energy be conserved?
Definition: blackoiltwophaseindices.hh:68
static constexpr bool oilEnabled
Is phase enabled or not.
Definition: blackoiltwophaseindices.hh:54
static constexpr int oxygenConcentrationIdx
MICP only available for one phase indices.
Definition: blackoiltwophaseindices.hh:162
static constexpr int numSolvents
Number of solvent components to be considered.
Definition: blackoiltwophaseindices.hh:77
static constexpr bool gasEnabled
Definition: blackoiltwophaseindices.hh:56
static constexpr int contiSolventEqIdx
Index of the continuity equation for the first solvent component.
Definition: blackoiltwophaseindices.hh:187
static constexpr int contiMicrobialEqIdx
Index of the continuity equation for the first microbial component.
Definition: blackoiltwophaseindices.hh:203
static constexpr int numEq
The number of equations.
Definition: blackoiltwophaseindices.hh:104
static constexpr int contiBrineEqIdx
Index of the continuity equation for the salt component.
Definition: blackoiltwophaseindices.hh:220
static constexpr int saltConcentrationIdx
Index of the primary variable for the salt.
Definition: blackoiltwophaseindices.hh:171
static constexpr int polymerConcentrationIdx
Index of the primary variable for the first polymer.
Definition: blackoiltwophaseindices.hh:146
static constexpr bool enableMICP
MICP only available for one phase indices.
Definition: blackoiltwophaseindices.hh:71
static constexpr int numExtbos
Number of components to be considered for extbo.
Definition: blackoiltwophaseindices.hh:80
static constexpr int numBioComp
Number of biofilm equations to be considered.
Definition: blackoiltwophaseindices.hh:95
static constexpr int polymerMoleWeightIdx
Index of the primary variable for the second polymer primary variable (molecular weight)
Definition: blackoiltwophaseindices.hh:150
static constexpr int numPolymers
Number of polymer components to be considered.
Definition: blackoiltwophaseindices.hh:83
static constexpr int contiCalciteEqIdx
Definition: blackoiltwophaseindices.hh:213
static constexpr int contiZfracEqIdx
Index of the continuity equation for the first extbo component.
Definition: blackoiltwophaseindices.hh:191
static constexpr int contiPolymerMWEqIdx
Index of the continuity equation for the second polymer component (molecular weight)
Definition: blackoiltwophaseindices.hh:199
static constexpr bool waterEnabled
Definition: blackoiltwophaseindices.hh:55
static constexpr int conti0EqIdx
Index of the continuity equation of the first phase.
Definition: blackoiltwophaseindices.hh:183
static constexpr int numBioInWat
Number of biocomponents in the water phase.
Definition: blackoiltwophaseindices.hh:98
static constexpr int contiFoamEqIdx
Index of the continuity equation for the foam component.
Definition: blackoiltwophaseindices.hh:216
static constexpr int calciteVolumeFractionIdx
Definition: blackoiltwophaseindices.hh:164
static constexpr int pressureSwitchIdx
Index of the switching variable which determines the pressure.
Definition: blackoiltwophaseindices.hh:127
static constexpr int biofilmVolumeFractionIdx
Index of the primary variable for the biofilm component.
Definition: blackoiltwophaseindices.hh:158
static constexpr int numFoam
Number of foam equations to be considered.
Definition: blackoiltwophaseindices.hh:89
static constexpr bool enableExtbo
Is extbo invoked?
Definition: blackoiltwophaseindices.hh:62
static constexpr int microbialConcentrationIdx
Index of the primary variable for the first microbial component.
Definition: blackoiltwophaseindices.hh:154
static constexpr int contiUreaEqIdx
Definition: blackoiltwophaseindices.hh:212
static constexpr int zFractionIdx
Index of the primary variable for the first extbo component.
Definition: blackoiltwophaseindices.hh:142
static constexpr bool enablePolymer
Are polymers involved?
Definition: blackoiltwophaseindices.hh:65
static constexpr int waterSwitchIdx
Index of the switching variable which determines the composistion of the water phase.
Definition: blackoiltwophaseindices.hh:119
static constexpr int compositionSwitchIdx
Index of the switching variable which determines the composition of the hydrocarbon phases.
Definition: blackoiltwophaseindices.hh:135