PhaseUsageInfo.hpp

// -*- 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_PHASEUSAGEINFO_HPP
#define OPM_PHASEUSAGEINFO_HPP

#include <opm/common/ErrorMacros.hpp>
#include <opm/input/eclipse/EclipseState/EclipseState.hpp>

#include <array>
#include <cassert>
#include <stdexcept>
#include <string>

#include <opm/common/utility/gpuDecorators.hpp>

namespace Opm
{
class Phases;

template <typename IndexTraits>
class PhaseUsageInfo {
public:
    static constexpr int numPhases = IndexTraits::numPhases;
    static constexpr int numComponents = IndexTraits::numComponents;

    static constexpr int waterPhaseIdx = IndexTraits::waterPhaseIdx;
    static constexpr int oilPhaseIdx = IndexTraits::oilPhaseIdx;
    static constexpr int gasPhaseIdx = IndexTraits::gasPhaseIdx;

    static constexpr int waterCompIdx = IndexTraits::waterCompIdx;
    static constexpr int oilCompIdx = IndexTraits::oilCompIdx;
    static constexpr int gasCompIdx = IndexTraits::gasCompIdx;

    PhaseUsageInfo();

    [[nodiscard]] OPM_HOST_DEVICE unsigned numActivePhases() const {
        return numActivePhases_;
    }

    [[nodiscard]] OPM_HOST_DEVICE bool phaseIsActive(unsigned phaseIdx) const {
        assert(phaseIdx < numPhases);
        return phaseIsActive_[phaseIdx];
    }

    [[nodiscard]] OPM_HOST_DEVICE short canonicalToActivePhaseIdx(unsigned phaseIdx) const {
        if (!phaseIsActive(phaseIdx)) {
            OPM_THROW(std::logic_error, "Canonical phase " + std::to_string(phaseIdx) + " is not active.");
        }
        return canonicalToActivePhaseIdx_[phaseIdx];
    }

    [[nodiscard]] OPM_HOST_DEVICE short activeToCanonicalPhaseIdx(unsigned activePhaseIdx) const {
        assert(activePhaseIdx< numActivePhases_);
        return activeToCanonicalPhaseIdx_[activePhaseIdx];
    }

    [[nodiscard]] OPM_HOST_DEVICE short activeToCanonicalCompIdx(unsigned activeCompIdx) const {
        // assert to remove an analyzer warning, at the current stage, numPhases == numComponents for black oil
        assert(numActivePhases_ <= numComponents);
        if (activeCompIdx >= numActivePhases()) {
            return activeCompIdx; // e.g. for solvent
        }
        return activeToCanonicalCompIdx_[activeCompIdx];
    }

    [[nodiscard]] OPM_HOST_DEVICE short canonicalToActiveCompIdx(unsigned compIdx) const {
        assert(compIdx < numComponents);
        return canonicalToActiveCompIdx_[compIdx];
    }

    [[nodiscard]] OPM_HOST_DEVICE short activePhaseToActiveCompIdx(unsigned activePhaseIdx) const {
        if (activePhaseIdx >= numActivePhases()) {
            return activePhaseIdx; // e.g. for solvent
        }
        const short canonicalPhaseIdx = activeToCanonicalPhaseIdx(activePhaseIdx);
        const short canonicalCompIdx = IndexTraits::phaseToComponentIdx(canonicalPhaseIdx);
        const short activeCompIdx = canonicalToActiveCompIdx(canonicalCompIdx);
        return activeCompIdx;
    }

    [[nodiscard]] OPM_HOST_DEVICE short activeCompToActivePhaseIdx(unsigned activeCompIdx) const {
        if (activeCompIdx >= numActivePhases()) {
            return activeCompIdx; // e.g. for solvent
        }
        const short canonicalCompIdx = activeToCanonicalCompIdx(activeCompIdx);
        const short canonicalPhaseIdx = IndexTraits::componentToPhaseIdx(canonicalCompIdx);
        const short activePhaseIdx = canonicalToActivePhaseIdx(canonicalPhaseIdx);
        return activePhaseIdx;
    }

    void initFromPhases(const Phases& phases);

    void initFromState(const EclipseState& eclState);

    OPM_HOST_DEVICE bool hasSolvent() const noexcept {
        return has_solvent;
    }

    OPM_HOST_DEVICE bool hasPolymer() const noexcept {
        return has_polymer;
    }

    OPM_HOST_DEVICE bool hasEnergy() const noexcept {
        return has_energy;
    }

    OPM_HOST_DEVICE bool hasPolymerMW() const noexcept {
        return has_polymermw;
    }

    OPM_HOST_DEVICE bool hasFoam() const noexcept {
        return has_foam;
    }

    OPM_HOST_DEVICE bool hasBrine() const noexcept {
        return has_brine;
    }

    OPM_HOST_DEVICE bool hasZFraction() const noexcept {
       return has_zFraction;
    }

    OPM_HOST_DEVICE bool hasBiofilm() const noexcept {
        return has_biofilm;
    }

    OPM_HOST_DEVICE bool hasMICP() const noexcept {
        return has_micp;
    }

    OPM_HOST_DEVICE bool hasCO2orH2Store() const noexcept {
        return has_co2_or_h2store;
    }

private:
    // only account for the three main phases: oil, water, gas
    unsigned char numActivePhases_ = 0;
    std::array<bool, numPhases> phaseIsActive_;
    std::array<short, numPhases> activeToCanonicalPhaseIdx_;
    std::array<short, numPhases> canonicalToActivePhaseIdx_;

    // numComponents only account for three main components: oil, water, gas
    std::array<short, numComponents> activeToCanonicalCompIdx_;
    std::array<short, numComponents> canonicalToActiveCompIdx_;

    bool has_solvent{};
    bool has_polymer{};
    bool has_energy{};
    // polymer molecular weight
    bool has_polymermw{};
    bool has_foam{};
    bool has_brine{};
    bool has_zFraction{};
    bool has_biofilm{};
    bool has_micp{};
    bool has_co2_or_h2store{};

    //  updating the mapping between active and canonical phase indices
    void updateIndexMapping_();

    void reset_();

};

}

#endif