blackoiltwophaseindices.hh

Go to the documentation of this file.

// -*- 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.
*/
#ifndef EWOMS_BLACK_OIL_TWO_PHASE_INDICES_HH
#define EWOMS_BLACK_OIL_TWO_PHASE_INDICES_HH
 
#include <cassert>
 
namespace Opm {
 
template<unsigned numSolventsV,
         unsigned numExtbosV,
         unsigned numPolymersV,
         unsigned numEnergyV,
         bool enableFoam,
         bool enableBrine,
         unsigned PVOffset,
         unsigned disabledCanonicalCompIdx,
         unsigned numMICPsV>
struct BlackOilTwoPhaseIndices
{
    static constexpr bool oilEnabled = disabledCanonicalCompIdx != 0;
    static constexpr bool waterEnabled = disabledCanonicalCompIdx != 1;
    static constexpr bool gasEnabled = disabledCanonicalCompIdx != 2;
 
    static constexpr bool enableSolvent = numSolventsV > 0;
 
    static constexpr bool enableExtbo = numExtbosV > 0;
 
    static constexpr bool enablePolymer = numPolymersV > 0;
 
    static constexpr bool enableEnergy = numEnergyV > 0;
 
    static constexpr bool enableMICP = numMICPsV > 0;
 
    static constexpr int numSolvents = enableSolvent ? numSolventsV : 0;
 
    static constexpr int numExtbos = enableExtbo ? numExtbosV : 0;
 
    static constexpr int numPolymers = enablePolymer ? numPolymersV : 0;
 
    static constexpr int numEnergy = enableEnergy ? numEnergyV : 0;
 
    static constexpr int numFoam = enableFoam? 1 : 0;
 
    static constexpr int numBrine = enableBrine? 1 : 0;
 
    static constexpr int numPhases = 2;
 
    static constexpr int numMICPs = enableMICP ? numMICPsV : 0;
 
    static constexpr int numEq = numPhases + numSolvents + numExtbos + numPolymers +
                                 numEnergy + numFoam + numBrine + numMICPs;
 
    // Primary variable indices
 
    static constexpr int waterSwitchIdx  = waterEnabled ? PVOffset + 0 : -10000;
 
    static constexpr int pressureSwitchIdx  = waterEnabled ? PVOffset + 1 : PVOffset + 0;
 
    static constexpr int compositionSwitchIdx = (gasEnabled && oilEnabled) ? PVOffset + 1 : -10000;
 
    static constexpr int solventSaturationIdx =
        enableSolvent ? PVOffset + numPhases : -1000;
 
    static constexpr int zFractionIdx =
        enableExtbo ? PVOffset + numPhases + numSolvents : -1000;
 
    static constexpr int polymerConcentrationIdx =
        enablePolymer ? PVOffset + numPhases + numSolvents : -1000;
 
    static constexpr int polymerMoleWeightIdx =
        numPolymers > 1 ? polymerConcentrationIdx + 1 : -1000;
 
    static constexpr int microbialConcentrationIdx =
        enableMICP ? PVOffset + numPhases + numSolvents : -1000;
 
    static constexpr int oxygenConcentrationIdx =
        numMICPs > 1 ? microbialConcentrationIdx + 1 : -1000;
 
    static constexpr int ureaConcentrationIdx =
        numMICPs > 2 ? oxygenConcentrationIdx + 1 : -1000;
 
    static constexpr int biofilmConcentrationIdx =
        numMICPs > 3 ? ureaConcentrationIdx + 1 : -1000;
 
    static constexpr int calciteConcentrationIdx =
        numMICPs > 4 ? biofilmConcentrationIdx + 1 : -1000;
 
    static constexpr int foamConcentrationIdx =
        enableFoam ? PVOffset + numPhases + numSolvents + numPolymers + numMICPs : -1000;
 
    static constexpr int saltConcentrationIdx =
        enableBrine ? PVOffset + numPhases + numSolvents + numPolymers + numMICPs + numFoam : -1000;
 
    static constexpr int temperatureIdx  =
        enableEnergy ? PVOffset + numPhases + numSolvents + numExtbos + numPolymers + numMICPs + numFoam + numBrine : - 1000;
 
    // Equation indices
 
    static unsigned canonicalToActiveComponentIndex(unsigned compIdx)
    {
        // assumes canonical oil = 0, water = 1, gas = 2;
        if (!gasEnabled) {
            assert(compIdx != 2);
            // oil = 0, water = 1
            return compIdx;
        } else if (!waterEnabled) {
            assert(compIdx != 1);
            // oil = 0, gas = 1
            return compIdx / 2;
        } else {
            assert(!oilEnabled);
            assert(compIdx != 0);
        }
 
        // water = 0, gas = 1;
        return compIdx - 1;
    }
 
    static unsigned activeToCanonicalComponentIndex(unsigned compIdx)
    {
        // assumes canonical oil = 0, water = 1, gas = 2;
        assert(compIdx < 2);
        if (!gasEnabled) {
            // oil = 0, water = 1
            return compIdx;
        } else if (!waterEnabled) {
            // oil = 0, gas = 1
            return compIdx * 2;
        } else {
            assert(!oilEnabled);
        }
 
        // water = 0, gas = 1;
        return compIdx + 1;
    }
 
    static constexpr int conti0EqIdx = PVOffset + 0;
    // one continuity equation follows
 
    static constexpr int contiSolventEqIdx =
        enableSolvent ? PVOffset + numPhases : -1000;
 
    static constexpr int contiZfracEqIdx =
        enableExtbo ? PVOffset + numPhases + numSolvents : -1000;
 
    static constexpr int contiPolymerEqIdx =
        enablePolymer ? PVOffset + numPhases + numSolvents : -1000;
 
    static constexpr int contiPolymerMWEqIdx =
        numPolymers > 1 ? contiPolymerEqIdx + 1 : -1000;
 
    static constexpr int contiMicrobialEqIdx =
        enableMICP ? PVOffset + numPhases + numSolvents : -1000;
 
    static constexpr int contiOxygenEqIdx =
        numMICPs > 1 ? contiMicrobialEqIdx + 1 : -1000;
 
    static constexpr int contiUreaEqIdx =
        numMICPs > 2 ? contiOxygenEqIdx + 1 : -1000;
 
    static constexpr int contiBiofilmEqIdx =
        numMICPs > 3 ? contiUreaEqIdx + 1 : -1000;
 
    static constexpr int contiCalciteEqIdx =
        numMICPs > 4 ? contiBiofilmEqIdx + 1 : -1000;
 
    static constexpr int contiFoamEqIdx =
        enableFoam ? PVOffset + numPhases + numSolvents + numPolymers + numMICPs : -1000;
 
    static constexpr int contiBrineEqIdx =
        enableBrine ? PVOffset + numPhases + numSolvents + numPolymers + numMICPs + numFoam : -1000;
 
    static constexpr int contiEnergyEqIdx =
        enableEnergy ? PVOffset + numPhases + numSolvents + numExtbos + numPolymers + numMICPs + numFoam + numBrine: -1000;
};
 
} // namespace Opm
 
#endif