opm-simulators/opm/models/ncp/ncpindices.hh
2020-06-10 13:49:42 +02:00

105 lines
3.2 KiB
C++

// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// vi: set et ts=4 sw=4 sts=4:
/*
This file is part of the Open Porous Media project (OPM).
OPM is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
OPM is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with OPM. If not, see <http://www.gnu.org/licenses/>.
Consult the COPYING file in the top-level source directory of this
module for the precise wording of the license and the list of
copyright holders.
*/
/*!
* \file
*
* \copydoc Opm::NcpIndices
*/
#ifndef EWOMS_NCP_INDICES_HH
#define EWOMS_NCP_INDICES_HH
#include "ncpproperties.hh"
#include <opm/models/common/energymodule.hh>
namespace Opm {
/*!
* \ingroup NcpModel
*
* \brief The primary variable and equation indices for the
* compositional multi-phase NCP model.
*/
template <class TypeTag, int PVOffset = 0>
struct NcpIndices
: public EnergyIndices<PVOffset
+ getPropValue<TypeTag, Properties::NumComponents>()
+ getPropValue<TypeTag, Properties::NumPhases>(),
getPropValue<TypeTag, Properties::EnableEnergy>()>
{
private:
using FluidSystem = GetPropType<TypeTag, Properties::FluidSystem>;
enum { numPhases = FluidSystem::numPhases };
enum { numComponents = FluidSystem::numComponents };
enum { enableEnergy = getPropValue<TypeTag, Properties::EnableEnergy>() };
using EnergyIndices = Opm::EnergyIndices<PVOffset + numComponents + numPhases, enableEnergy>;
public:
/*!
* \brief The number of primary variables / equations.
*/
static const int numEq = numComponents + numPhases + EnergyIndices::numEq_;
/*!
* \brief Index of the equation for the continuity of mass of the
* first component.
*
* numComponents equations follow...
*/
static const int conti0EqIdx = PVOffset;
/*!
* \brief Index of the first phase NCP equation.
*
* The index for the remaining phases are consecutive.
*/
static const int ncp0EqIdx = conti0EqIdx + numComponents;
/*!
* \brief Index of the primary variable for the fugacity of the
* first component.
*
* numComponents primary variables follow...
*/
static const int fugacity0Idx = PVOffset;
/*!
* \brief Index of the saturation of the first phase in a vector
* of primary variables.
*
* The following (numPhases - 1) primary variables represent the
* saturations for the phases [1, ..., numPhases - 1]
*/
static const int saturation0Idx = fugacity0Idx + numComponents;
/*!
* \brief Index of the first phase' pressure in a vector of
* primary variables.
*/
static const int pressure0Idx = saturation0Idx + numPhases - 1;
};
} // namespace Opm
#endif