blackoilonephaseindices.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_ONE_PHASE_INDICES_HH
29#define EWOMS_BLACK_OIL_ONE_PHASE_INDICES_HH
30
31#include <cassert>
32
33#include <opm/common/utility/ConstexprAssert.hpp>
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 canonicalCompIdx,
50 unsigned numBioCompV>
52{
54 static constexpr bool oilEnabled = canonicalCompIdx == 0;
55 static constexpr bool waterEnabled = canonicalCompIdx == 1;
56 static constexpr bool gasEnabled = canonicalCompIdx == 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 enableFullyImplicitThermal = numEnergyV > 0;
69
71 static constexpr bool enableMICP = numBioCompV == 5;
72
74 static constexpr bool enableBiofilm = false;
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 = enableFullyImplicitThermal ? 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 numPhases = 1;
96
98 static constexpr int numMICPs = enableMICP ? numBioCompV : 0;
99
101 static constexpr int numBioInWat = enableMICP ? 3 : 0;
102
104 static constexpr int numEq = numPhases + numSolvents + numExtbos + numPolymers +
106
108 static constexpr int numDerivatives = numEq;
109
111 // Primary variable indices
113
122 static constexpr int waterSwitchIdx = -10000;
123
130 static constexpr int pressureSwitchIdx = PVOffset + 0;
131
138 static constexpr int compositionSwitchIdx = -10000;
139
141 static constexpr int solventSaturationIdx =
142 enableSolvent ? PVOffset + numPhases : -1000;
143
145 static constexpr int zFractionIdx =
146 enableExtbo ? PVOffset + numPhases + numSolvents : -1000;
147
149 static constexpr int polymerConcentrationIdx =
150 enablePolymer ? PVOffset + numPhases + numSolvents : -1000;
151
153 static constexpr int polymerMoleWeightIdx =
154 numPolymers > 1 ? polymerConcentrationIdx + 1 : -1000;
155
157 static constexpr int microbialConcentrationIdx =
158 enableMICP ? PVOffset + numPhases + numSolvents : -1000;
159
161 static constexpr int oxygenConcentrationIdx =
162 numMICPs > 1 ? microbialConcentrationIdx + 1 : -1000;
163
165 static constexpr int ureaConcentrationIdx =
166 numMICPs > 2 ? oxygenConcentrationIdx + 1 : -1000;
167
169 static constexpr int biofilmVolumeFractionIdx =
170 numMICPs > 3 ? ureaConcentrationIdx + 1 : -1000;
171
173 static constexpr int calciteVolumeFractionIdx =
174 numMICPs > 4 ? biofilmVolumeFractionIdx + 1 : -1000;
175
177 static constexpr int foamConcentrationIdx =
178 enableFoam ? PVOffset + numPhases + numSolvents + numPolymers + numMICPs : -1000;
179
181 static constexpr int saltConcentrationIdx =
182 enableBrine ? PVOffset + numPhases + numSolvents + numExtbos + numPolymers + numMICPs + numFoam : -1000;
183
185 static constexpr int temperatureIdx =
187
189 // Equation indices
191
193 static constexpr int conti0EqIdx = PVOffset + 0;
194
196 static constexpr int contiSolventEqIdx =
197 enableSolvent ? PVOffset + numPhases : -1000;
198
200 static constexpr int contiZfracEqIdx =
201 enableExtbo ? PVOffset + numPhases + numSolvents : -1000;
202
204 static constexpr int contiPolymerEqIdx =
205 enablePolymer ? PVOffset + numPhases + numSolvents : -1000;
206
208 static constexpr int contiPolymerMWEqIdx =
209 numPolymers > 1 ? contiPolymerEqIdx + 1 : -1000;
210
212 static constexpr int contiMicrobialEqIdx =
213 enableMICP ? PVOffset + numPhases + numSolvents : -1000;
214
216 static constexpr int contiOxygenEqIdx =
217 numMICPs > 1 ? contiMicrobialEqIdx + 1 : -1000;
218
220 static constexpr int contiUreaEqIdx =
221 numMICPs > 2 ? contiOxygenEqIdx + 1 : -1000;
222
224 static constexpr int contiBiofilmEqIdx =
225 numMICPs > 3 ? contiUreaEqIdx + 1 : -1000;
226
228 static constexpr int contiCalciteEqIdx =
229 numMICPs > 4 ? contiBiofilmEqIdx + 1 : -1000;
230
232 static constexpr int contiFoamEqIdx =
233 enableFoam ? PVOffset + numPhases + numSolvents + numPolymers + numMICPs : -1000;
234
236 static constexpr int contiBrineEqIdx =
237 enableBrine ? PVOffset + numPhases + numSolvents + numExtbos + numPolymers + numMICPs + numFoam : -1000;
238
240 static constexpr int contiEnergyEqIdx =
242};
243
244} // namespace Opm
245
246#endif
Definition: blackoilbioeffectsmodules.hh:45
The primary variable and equation indices for the black-oil model.
Definition: blackoilonephaseindices.hh:52
static constexpr int numBioInWat
Number of biocomponents in the water phase.
Definition: blackoilonephaseindices.hh:101
static constexpr int numBrine
Number of salt equations to be considered.
Definition: blackoilonephaseindices.hh:92
static constexpr int ureaConcentrationIdx
Index of the primary variable for the third MICP component.
Definition: blackoilonephaseindices.hh:165
static constexpr int contiUreaEqIdx
Index of the continuity equation for the third MICP component.
Definition: blackoilonephaseindices.hh:220
static constexpr bool gasEnabled
Definition: blackoilonephaseindices.hh:56
static constexpr int contiEnergyEqIdx
Index of the continuity equation for energy.
Definition: blackoilonephaseindices.hh:240
static constexpr int numPolymers
Number of polymer components to be considered.
Definition: blackoilonephaseindices.hh:83
static constexpr int foamConcentrationIdx
Index of the primary variable for the foam.
Definition: blackoilonephaseindices.hh:177
static constexpr int numEq
The number of equations.
Definition: blackoilonephaseindices.hh:104
static constexpr int polymerConcentrationIdx
Index of the primary variable for the first polymer.
Definition: blackoilonephaseindices.hh:149
static constexpr int contiCalciteEqIdx
Index of the continuity equation for the fifth MICP component.
Definition: blackoilonephaseindices.hh:228
static constexpr int numPhases
The number of fluid phases.
Definition: blackoilonephaseindices.hh:95
static constexpr bool enableSolvent
Are solvents involved?
Definition: blackoilonephaseindices.hh:59
static constexpr int contiZfracEqIdx
Index of the continuity equation for the first extbo component.
Definition: blackoilonephaseindices.hh:200
static constexpr bool enablePolymer
Are polymers involved?
Definition: blackoilonephaseindices.hh:65
static constexpr bool enableExtbo
Is extbo invoked?
Definition: blackoilonephaseindices.hh:62
static constexpr int pressureSwitchIdx
Index of the switching variable which determines the pressure.
Definition: blackoilonephaseindices.hh:130
static constexpr int waterSwitchIdx
Index of the switching variable which determines the composistion of the water phase.
Definition: blackoilonephaseindices.hh:122
static constexpr int compositionSwitchIdx
Index of the switching variable which determines the composition of the hydrocarbon phases.
Definition: blackoilonephaseindices.hh:138
static constexpr int conti0EqIdx
Index of the continuity equation of the first (and only) phase.
Definition: blackoilonephaseindices.hh:193
static constexpr int contiPolymerEqIdx
Index of the continuity equation for the first polymer component.
Definition: blackoilonephaseindices.hh:204
static constexpr int numSolvents
Number of solvent components to be considered.
Definition: blackoilonephaseindices.hh:77
static constexpr int microbialConcentrationIdx
Index of the primary variable for the first MICP component.
Definition: blackoilonephaseindices.hh:157
static constexpr int contiFoamEqIdx
Index of the continuity equation for the foam component.
Definition: blackoilonephaseindices.hh:232
static constexpr int contiBiofilmEqIdx
Index of the continuity equation for the fourth MICP component.
Definition: blackoilonephaseindices.hh:224
static constexpr int temperatureIdx
Index of the primary variable for temperature.
Definition: blackoilonephaseindices.hh:185
static constexpr int calciteVolumeFractionIdx
Index of the primary variable for the fifth MICP component.
Definition: blackoilonephaseindices.hh:173
static constexpr bool enableFullyImplicitThermal
Shall energy be conserved?
Definition: blackoilonephaseindices.hh:68
static constexpr int contiMicrobialEqIdx
Index of the continuity equation for the first MICP component.
Definition: blackoilonephaseindices.hh:212
static constexpr int numMICPs
Number of MICP components to be considered.
Definition: blackoilonephaseindices.hh:98
static constexpr int numFoam
Number of foam equations to be considered.
Definition: blackoilonephaseindices.hh:89
static constexpr int zFractionIdx
Index of the primary variable for the first extbo component.
Definition: blackoilonephaseindices.hh:145
static constexpr int solventSaturationIdx
Index of the primary variable for the first solvent.
Definition: blackoilonephaseindices.hh:141
static constexpr bool enableMICP
Is MICP involved? (microbes, oxygen, urea, biofilm, and calcite)
Definition: blackoilonephaseindices.hh:71
static constexpr int numDerivatives
We may want to evaluate with more derivatives that equations, but not this time.
Definition: blackoilonephaseindices.hh:108
static constexpr bool oilEnabled
Is phase enabled or not.
Definition: blackoilonephaseindices.hh:54
static constexpr int oxygenConcentrationIdx
Index of the primary variable for the second MICP component.
Definition: blackoilonephaseindices.hh:161
static constexpr bool enableBiofilm
Biofilm effects on co2/h2store only for two phase indices.
Definition: blackoilonephaseindices.hh:74
static constexpr int contiPolymerMWEqIdx
Index of the continuity equation for the second polymer component (molecular weight)
Definition: blackoilonephaseindices.hh:208
static constexpr int polymerMoleWeightIdx
Index of the primary variable for the second polymer primary variable (molecular weight)
Definition: blackoilonephaseindices.hh:153
static constexpr int biofilmVolumeFractionIdx
Index of the primary variable for the fourth MICP component.
Definition: blackoilonephaseindices.hh:169
static constexpr int contiOxygenEqIdx
Index of the continuity equation for the second MICP component.
Definition: blackoilonephaseindices.hh:216
static constexpr int saltConcentrationIdx
Index of the primary variable for the salt.
Definition: blackoilonephaseindices.hh:181
static constexpr int contiBrineEqIdx
Index of the continuity equation for the salt component.
Definition: blackoilonephaseindices.hh:236
static constexpr int contiSolventEqIdx
Index of the continuity equation for the first solvent component.
Definition: blackoilonephaseindices.hh:196
static constexpr bool waterEnabled
Definition: blackoilonephaseindices.hh:55
static constexpr int numEnergy
Number of energy equations to be considered.
Definition: blackoilonephaseindices.hh:86
static constexpr int numExtbos
Number of components to be considered for extbo.
Definition: blackoilonephaseindices.hh:80