opm-simulators
ncpindices.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_NCP_INDICES_HH
29 #define EWOMS_NCP_INDICES_HH
30 
32 
33 namespace Opm {
34 
41 template <class TypeTag, int PVOffset = 0>
42 struct NcpIndices
43  : public EnergyIndices<PVOffset +
44  getPropValue<TypeTag, Properties::NumComponents>() +
45  getPropValue<TypeTag, Properties::NumPhases>(),
46  getPropValue<TypeTag, Properties::EnableEnergy>()>
47 {
48 private:
50  static constexpr int numPhases = FluidSystem::numPhases;
51  static constexpr int numComponents = FluidSystem::numComponents;
52  enum { enableEnergy = getPropValue<TypeTag, Properties::EnableEnergy>() };
53 
55 
56 public:
60  static constexpr int numEq = numComponents + numPhases + EnergyIndices::numEq_;
61 
68  static constexpr int conti0EqIdx = PVOffset;
69 
75  static constexpr int ncp0EqIdx = conti0EqIdx + numComponents;
76 
83  static constexpr int fugacity0Idx = PVOffset;
84 
92  static constexpr int saturation0Idx = fugacity0Idx + numComponents;
93 
98  static constexpr int pressure0Idx = saturation0Idx + numPhases - 1;
99 };
100 
101 } // namespace Opm
102 
103 #endif
static constexpr int numEq
The number of primary variables / equations.
Definition: ncpindices.hh:60
static constexpr int fugacity0Idx
Index of the primary variable for the fugacity of the first component.
Definition: ncpindices.hh:83
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
Contains the classes required to consider energy as a conservation quantity in a multi-phase module...
static constexpr int pressure0Idx
Index of the first phase&#39; pressure in a vector of primary variables.
Definition: ncpindices.hh:98
This file contains a set of helper functions used by VFPProd / VFPInj.
Definition: blackoilbioeffectsmodules.hh:45
The primary variable and equation indices for the compositional multi-phase NCP model.
Definition: ncpindices.hh:42
static constexpr int saturation0Idx
Index of the saturation of the first phase in a vector of primary variables.
Definition: ncpindices.hh:92
static constexpr int ncp0EqIdx
Index of the first phase NCP equation.
Definition: ncpindices.hh:75
static constexpr int conti0EqIdx
Index of the equation for the continuity of mass of the first component.
Definition: ncpindices.hh:68
Provides the indices required for the energy equation.
Definition: energymodule.hh:494