blackoilvariableandequationindices.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 OPM_BLACK_OIL_VARIABLE_AND_EQUATION_INDICES_HH
#define OPM_BLACK_OIL_VARIABLE_AND_EQUATION_INDICES_HH

#include <limits>

namespace Opm {

template<unsigned numSolventsV,
         unsigned numExtbosV,
         unsigned numPolymersV,
         unsigned numEnergyV,
         bool enableFoam,
         bool enableBrine,
         int PVOffset,
         unsigned numBioCompV>
struct BlackOilVariableAndEquationIndices
{
    static constexpr int numPhases = 3;

    static constexpr bool oilEnabled = true;
    static constexpr bool waterEnabled = true;
    static constexpr bool gasEnabled = true;

    static constexpr bool enableSolvent = numSolventsV > 0;

    static constexpr bool enableExtbo = numExtbosV > 0;

    static constexpr bool enablePolymer = numPolymersV > 0;

    static constexpr bool enableFullyImplicitThermal = numEnergyV > 0;

    static constexpr bool enableMICP = false;
    static constexpr bool enableBiofilm = false;
    static constexpr int numBioInWat = 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 = enableFullyImplicitThermal ? numEnergyV : 0;

    static constexpr int numFoam = enableFoam? 1 : 0;

    static constexpr int numBrine = enableBrine? 1 : 0;

    static constexpr int numEq = numPhases + numSolvents + numExtbos + numPolymers +
                                 numEnergy + numFoam + numBrine;

    static constexpr int numDerivatives = numEq;


    // Primary variable indices

    static constexpr unsigned waterSwitchIdx = PVOffset + 0;

    static constexpr unsigned pressureSwitchIdx = PVOffset + 1;

    static constexpr unsigned compositionSwitchIdx = PVOffset + 2;

    static constexpr unsigned solventSaturationIdx =
        enableSolvent ? PVOffset + numPhases
                      : std::numeric_limits<unsigned>::max();

    static constexpr unsigned zFractionIdx =
        enableExtbo ? PVOffset + numPhases + numSolvents
                    : std::numeric_limits<unsigned>::max();

    static constexpr unsigned polymerConcentrationIdx =
        enablePolymer ? PVOffset + numPhases + numSolvents
                      : std::numeric_limits<unsigned>::max();

    static constexpr unsigned polymerMoleWeightIdx =
        numPolymers > 1 ? polymerConcentrationIdx + 1
                        : std::numeric_limits<unsigned>::max();

    static constexpr unsigned microbialConcentrationIdx = std::numeric_limits<unsigned>::max();
    static constexpr unsigned oxygenConcentrationIdx = std::numeric_limits<unsigned>::max();
    static constexpr unsigned ureaConcentrationIdx = std::numeric_limits<unsigned>::max();
    static constexpr unsigned biofilmVolumeFractionIdx = std::numeric_limits<unsigned>::max();
    static constexpr unsigned calciteVolumeFractionIdx = std::numeric_limits<unsigned>::max();

    static constexpr unsigned foamConcentrationIdx =
        enableFoam ? PVOffset + numPhases + numSolvents + numExtbos + numPolymers
                   : std::numeric_limits<unsigned>::max();

    static constexpr unsigned saltConcentrationIdx =
        enableBrine ? PVOffset + numPhases + numSolvents + numExtbos + numPolymers + numFoam
                    : std::numeric_limits<unsigned>::max();

    static constexpr unsigned temperatureIdx  =
        enableFullyImplicitThermal ? PVOffset + numPhases + numSolvents +
                                     numExtbos + numPolymers + numFoam + numBrine
                                   : std::numeric_limits<unsigned>::max();


    // Equation indices

    static constexpr int conti0EqIdx = PVOffset + 0;
    // two continuity equations follow

    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 + numExtbos : -1000;

    static constexpr int contiPolymerMWEqIdx =
        numPolymers > 1 ? contiPolymerEqIdx + 1 : -1000;

    static constexpr int contiMicrobialEqIdx = -1000;
    static constexpr int contiOxygenEqIdx = -1000;
    static constexpr int contiUreaEqIdx = -1000;
    static constexpr int contiBiofilmEqIdx = -1000;
    static constexpr int contiCalciteEqIdx = -1000;

    static constexpr int contiFoamEqIdx =
        enableFoam ? PVOffset + numPhases + numSolvents + numExtbos + numPolymers : -1000;

    static constexpr int contiBrineEqIdx =
        enableBrine ? PVOffset + numPhases + numSolvents + numExtbos + numPolymers + numFoam : -1000;

    static constexpr int contiEnergyEqIdx =
        enableFullyImplicitThermal ? PVOffset + numPhases + numSolvents + numExtbos + numPolymers + numFoam + numBrine: -1000;
};

} // namespace Opm

#endif