ptflash/flashindices.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_PTFLASH_INDICES_HH
29#define OPM_PTFLASH_INDICES_HH
30
33
34namespace Opm {
35
44// TODO: The indices class should handle whether phase is active, not the FluidSystem
45template <class TypeTag, int PVOffset>
46class FlashIndices
47 : public EnergyIndices<PVOffset + getPropValue<TypeTag, Properties::NumComponents>(),
48 getPropValue<TypeTag, Properties::EnableEnergy>()>
49{
50 static constexpr int numComponents = getPropValue<TypeTag, Properties::NumComponents>();
51 enum { enableEnergy = getPropValue<TypeTag, Properties::EnableEnergy>() };
52 enum { enableWater = getPropValue<TypeTag, Properties::EnableWater>() };
54
55public:
57 static constexpr bool waterEnabled = enableWater;
58 static constexpr bool gasEnabled = true;
59 static constexpr bool oilEnabled = true;
60
62 static constexpr int numPhases = enableWater ? 3 : 2;
63
65 static constexpr int numEq = numComponents + EnergyIndices::numEq_ + (enableWater ? 1 : 0);
66
67 // Primary variable indices
68
70 static constexpr int pressure0Idx = PVOffset;
71
73 static constexpr int z0Idx = pressure0Idx + 1;
74
76 static constexpr int water0Idx = enableWater ? z0Idx + numComponents - 1 : -1000;
77
78 // equation indices
79
82 static constexpr int conti0EqIdx = PVOffset;
83};
84
85} // namespace Opm
86
87#endif
static constexpr bool waterEnabled
All phases active (note: immiscible/"dummy" water phase)
Definition: ptflash/flashindices.hh:57
static const int numEq
number of equations/primary variables
Definition: flash/flashindices.hh:54
static constexpr int numPhases
number of active phases
Definition: ptflash/flashindices.hh:62
static const int conti0EqIdx
Definition: flash/flashindices.hh:66
static constexpr bool gasEnabled
Definition: ptflash/flashindices.hh:58
static constexpr bool oilEnabled
Definition: ptflash/flashindices.hh:59
static constexpr int z0Idx
Index of the molefraction of the first component.
Definition: ptflash/flashindices.hh:73
static constexpr int pressure0Idx
Index of the pressure.
Definition: ptflash/flashindices.hh:70
static constexpr int water0Idx
Index of water saturation.
Definition: ptflash/flashindices.hh:76
Contains the classes required to consider energy as a conservation quantity in a multi-phase module.
Defines the common properties required by the porous medium multi-phase models.
Definition: blackoilboundaryratevector.hh:39
Provides the indices required for the energy equation.
Definition: energymodule.hh:499