blackoilvariableandequationindices.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 OPM_BLACK_OIL_VARIABLE_AND_EQUATION_INDICES_HH
29#define OPM_BLACK_OIL_VARIABLE_AND_EQUATION_INDICES_HH
30
31namespace Opm {
32
38template<unsigned numSolventsV,
39 unsigned numExtbosV,
40 unsigned numPolymersV,
41 unsigned numEnergyV,
42 bool enableFoam,
43 bool enableBrine,
44 unsigned PVOffset,
45 unsigned numBioCompV>
47{
49 static constexpr int numPhases = 3;
50
52 static constexpr bool oilEnabled = true;
53 static constexpr bool waterEnabled = true;
54 static constexpr bool gasEnabled = true;
55
57 static constexpr bool enableSolvent = numSolventsV > 0;
58
60 static constexpr bool enableExtbo = numExtbosV > 0;
61
63 static constexpr bool enablePolymer = numPolymersV > 0;
64
66 static constexpr bool enableEnergy = numEnergyV > 0;
67
69 static constexpr bool enableMICP = false;
70 static constexpr bool enableBiofilm = false;
71 static constexpr int numBioInWat = 0;
72
74 static constexpr int numSolvents = enableSolvent ? numSolventsV : 0;
75
77 static constexpr int numExtbos = enableExtbo ? numExtbosV : 0;
78
80 static constexpr int numPolymers = enablePolymer ? numPolymersV : 0;
81
83 static constexpr int numEnergy = enableEnergy ? numEnergyV : 0;
84
86 static constexpr int numFoam = enableFoam? 1 : 0;
87
89 static constexpr int numBrine = enableBrine? 1 : 0;
90
92 static constexpr int numEq = numPhases + numSolvents + numExtbos + numPolymers +
94
96 // Primary variable indices
98
105 static constexpr int waterSwitchIdx = PVOffset + 0;
106
113 static constexpr int pressureSwitchIdx = PVOffset + 1;
114
123 static constexpr int compositionSwitchIdx = PVOffset + 2;
124
126 static constexpr int solventSaturationIdx =
127 enableSolvent ? PVOffset + numPhases : -1000;
128
130 static constexpr int zFractionIdx =
131 enableExtbo ? PVOffset + numPhases + numSolvents : -1000;
132
134 static constexpr int polymerConcentrationIdx =
135 enablePolymer ? PVOffset + numPhases + numSolvents : -1000;
136
138 static constexpr int polymerMoleWeightIdx =
139 numPolymers > 1 ? polymerConcentrationIdx + 1 : -1000;
140
142 static constexpr int microbialConcentrationIdx = -1000;
143 static constexpr int oxygenConcentrationIdx = -1000;
144 static constexpr int ureaConcentrationIdx = -1000;
145 static constexpr int biofilmVolumeFractionIdx = -1000;
146 static constexpr int calciteVolumeFractionIdx = -1000;
147
149 static constexpr int foamConcentrationIdx =
150 enableFoam ? PVOffset + numPhases + numSolvents + numExtbos + numPolymers : -1000;
151
153 static constexpr int saltConcentrationIdx =
154 enableBrine ? PVOffset + numPhases + numSolvents + numExtbos + numExtbos + numPolymers + numFoam : -1000;
155
157 static constexpr int temperatureIdx =
159
160
162 // Equation indices
164
166 static constexpr int conti0EqIdx = PVOffset + 0;
167 // two continuity equations follow
168
170 static constexpr int contiSolventEqIdx =
171 enableSolvent ? PVOffset + numPhases : -1000;
172
174 static constexpr int contiZfracEqIdx =
175 enableExtbo ? PVOffset + numPhases + numSolvents : -1000;
176
178 static constexpr int contiPolymerEqIdx =
179 enablePolymer ? PVOffset + numPhases + numSolvents + numExtbos : -1000;
180
182 static constexpr int contiPolymerMWEqIdx =
183 numPolymers > 1 ? contiPolymerEqIdx + 1 : -1000;
184
186 static constexpr int contiMicrobialEqIdx = -1000;
187 static constexpr int contiOxygenEqIdx = -1000;
188 static constexpr int contiUreaEqIdx = -1000;
189 static constexpr int contiBiofilmEqIdx = -1000;
190 static constexpr int contiCalciteEqIdx = -1000;
191
193 static constexpr int contiFoamEqIdx =
194 enableFoam ? PVOffset + numPhases + numSolvents + numExtbos + numPolymers : -1000;
195
197 static constexpr int contiBrineEqIdx =
198 enableBrine ? PVOffset + numPhases + numSolvents + numExtbos + numPolymers + numFoam : -1000;
199
201 static constexpr int contiEnergyEqIdx =
203};
204
205} // namespace Opm
206
207#endif
Definition: blackoilbioeffectsmodules.hh:43
The primary variable and equation indices for the three-phase black-oil model.
Definition: blackoilvariableandequationindices.hh:47
static constexpr int numBrine
Number of salt equations to be considered.
Definition: blackoilvariableandequationindices.hh:89
static constexpr bool enableExtbo
Is extbo invoked?
Definition: blackoilvariableandequationindices.hh:60
static constexpr int compositionSwitchIdx
Index of the switching variable which determines the composition of the hydrocarbon phases.
Definition: blackoilvariableandequationindices.hh:123
static constexpr int contiCalciteEqIdx
Definition: blackoilvariableandequationindices.hh:190
static constexpr int numPhases
Number of phases active at all times.
Definition: blackoilvariableandequationindices.hh:49
static constexpr int contiOxygenEqIdx
Definition: blackoilvariableandequationindices.hh:187
static constexpr int contiMicrobialEqIdx
No bioeffects for three phase indices.
Definition: blackoilvariableandequationindices.hh:186
static constexpr int oxygenConcentrationIdx
Definition: blackoilvariableandequationindices.hh:143
static constexpr int contiZfracEqIdx
Index of the continuity equation for the first extbo component.
Definition: blackoilvariableandequationindices.hh:174
static constexpr int numFoam
Number of foam equations to be considered.
Definition: blackoilvariableandequationindices.hh:86
static constexpr int numBioInWat
Definition: blackoilvariableandequationindices.hh:71
static constexpr int numExtbos
Number of components to be considered for extbo.
Definition: blackoilvariableandequationindices.hh:77
static constexpr int numEq
The number of equations.
Definition: blackoilvariableandequationindices.hh:92
static constexpr int contiPolymerMWEqIdx
Index of the continuity equation for the second polymer component (molecular weight)
Definition: blackoilvariableandequationindices.hh:182
static constexpr int contiUreaEqIdx
Definition: blackoilvariableandequationindices.hh:188
static constexpr int saltConcentrationIdx
Index of the primary variable for the brine.
Definition: blackoilvariableandequationindices.hh:153
static constexpr int waterSwitchIdx
Index of the switching variable which determines the composistion of the water phase.
Definition: blackoilvariableandequationindices.hh:105
static constexpr int polymerConcentrationIdx
Index of the primary variable for the first polymer.
Definition: blackoilvariableandequationindices.hh:134
static constexpr int temperatureIdx
Index of the primary variable for temperature.
Definition: blackoilvariableandequationindices.hh:157
static constexpr int zFractionIdx
Index of the primary variable for the first extbo component.
Definition: blackoilvariableandequationindices.hh:130
static constexpr int calciteVolumeFractionIdx
Definition: blackoilvariableandequationindices.hh:146
static constexpr int numSolvents
Number of solvent components to be considered.
Definition: blackoilvariableandequationindices.hh:74
static constexpr int ureaConcentrationIdx
Definition: blackoilvariableandequationindices.hh:144
static constexpr int contiBiofilmEqIdx
Definition: blackoilvariableandequationindices.hh:189
static constexpr int foamConcentrationIdx
Index of the primary variable for the foam.
Definition: blackoilvariableandequationindices.hh:149
static constexpr int numPolymers
Number of polymer components to be considered.
Definition: blackoilvariableandequationindices.hh:80
static constexpr int contiEnergyEqIdx
Index of the continuity equation for energy.
Definition: blackoilvariableandequationindices.hh:201
static constexpr bool enableBiofilm
Definition: blackoilvariableandequationindices.hh:70
static constexpr bool waterEnabled
Definition: blackoilvariableandequationindices.hh:53
static constexpr int numEnergy
Number of energy equations to be considered.
Definition: blackoilvariableandequationindices.hh:83
static constexpr bool enableMICP
No bioeffects for three phase indices.
Definition: blackoilvariableandequationindices.hh:69
static constexpr int contiFoamEqIdx
Index of the continuity equation for the foam component.
Definition: blackoilvariableandequationindices.hh:193
static constexpr int conti0EqIdx
Index of the continuity equation of the first phase.
Definition: blackoilvariableandequationindices.hh:166
static constexpr int microbialConcentrationIdx
No bioeffects for three phase indices.
Definition: blackoilvariableandequationindices.hh:142
static constexpr bool gasEnabled
Definition: blackoilvariableandequationindices.hh:54
static constexpr int solventSaturationIdx
Index of the primary variable for the first solvent.
Definition: blackoilvariableandequationindices.hh:126
static constexpr bool oilEnabled
All phases are enabled.
Definition: blackoilvariableandequationindices.hh:52
static constexpr int contiPolymerEqIdx
Index of the continuity equation for the first polymer component.
Definition: blackoilvariableandequationindices.hh:178
static constexpr int polymerMoleWeightIdx
Index of the primary variable for the second polymer primary variable (molecular weight)
Definition: blackoilvariableandequationindices.hh:138
static constexpr int contiSolventEqIdx
Index of the continuity equation for the first solvent component.
Definition: blackoilvariableandequationindices.hh:170
static constexpr bool enableEnergy
Shall energy be conserved?
Definition: blackoilvariableandequationindices.hh:66
static constexpr bool enableSolvent
Are solvents involved?
Definition: blackoilvariableandequationindices.hh:57
static constexpr int pressureSwitchIdx
Index of the switching variable which determines the pressure.
Definition: blackoilvariableandequationindices.hh:113
static constexpr int biofilmVolumeFractionIdx
Definition: blackoilvariableandequationindices.hh:145
static constexpr int contiBrineEqIdx
Index of the continuity equation for the salt water component.
Definition: blackoilvariableandequationindices.hh:197
static constexpr bool enablePolymer
Are polymers involved?
Definition: blackoilvariableandequationindices.hh:63