Loading...
Searching...
No Matches
BlackOilDefaultFluidSystemIndices.hpp
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_DEFAULT_FLUID_SYSTEM_INDICES_HPP
#define OPM_BLACK_OIL_DEFAULT_FLUID_SYSTEM_INDICES_HPP
#include <cassert>
namespace Opm {
class BlackOilDefaultFluidSystemIndices
{
public:
static constexpr unsigned numPhases = 3;
static constexpr unsigned waterPhaseIdx = 0;
static constexpr unsigned oilPhaseIdx = 1;
static constexpr unsigned gasPhaseIdx = 2;
static constexpr unsigned numComponents = 3;
static constexpr int oilCompIdx = 0;
static constexpr int waterCompIdx = 1;
static constexpr int gasCompIdx = 2;
// TODO: the following two functions are for black oil only
// it remains to be formulated to be more generic
// it is likely moved out of the Indices class
static constexpr int componentToPhaseIdx(int compIdx) {
assert(compIdx >= 0 && compIdx < static_cast<int>(numComponents));
switch (compIdx) {
case oilCompIdx: return oilPhaseIdx;
case waterCompIdx: return waterPhaseIdx;
case gasCompIdx: return gasPhaseIdx;
default: return -1; // invalid index
}
}
static constexpr int phaseToComponentIdx(int phaseIdx) {
assert(phaseIdx >= 0 && phaseIdx < static_cast<int>(numPhases));
switch (phaseIdx) {
case waterPhaseIdx: return waterCompIdx;
case oilPhaseIdx: return oilCompIdx;
case gasPhaseIdx: return gasCompIdx;
default: return -1; // invalid index
}
}
};
} // namespace Opm
#endif
Opm::BlackOilDefaultFluidSystemIndices
The class which specifies the default phase and component indices for the black-oil fluid system.
Definition BlackOilDefaultFluidSystemIndices.hpp:39
Opm::BlackOilDefaultFluidSystemIndices::numComponents
static constexpr unsigned numComponents
Total number of components.
Definition BlackOilDefaultFluidSystemIndices.hpp:52
Opm::BlackOilDefaultFluidSystemIndices::waterPhaseIdx
static constexpr unsigned waterPhaseIdx
Index of the water phase.
Definition BlackOilDefaultFluidSystemIndices.hpp:45
Opm::BlackOilDefaultFluidSystemIndices::oilPhaseIdx
static constexpr unsigned oilPhaseIdx
Index of the oil phase.
Definition BlackOilDefaultFluidSystemIndices.hpp:47
Opm::BlackOilDefaultFluidSystemIndices::gasPhaseIdx
static constexpr unsigned gasPhaseIdx
Index of the gas phase.
Definition BlackOilDefaultFluidSystemIndices.hpp:49
Opm::BlackOilDefaultFluidSystemIndices::phaseToComponentIdx
static constexpr int phaseToComponentIdx(int phaseIdx)
Map phase index to component index.
Definition BlackOilDefaultFluidSystemIndices.hpp:76
Opm::BlackOilDefaultFluidSystemIndices::waterCompIdx
static constexpr int waterCompIdx
Index of the water component.
Definition BlackOilDefaultFluidSystemIndices.hpp:57
Opm::BlackOilDefaultFluidSystemIndices::oilCompIdx
static constexpr int oilCompIdx
Index of the oil component.
Definition BlackOilDefaultFluidSystemIndices.hpp:55
Opm::BlackOilDefaultFluidSystemIndices::gasCompIdx
static constexpr int gasCompIdx
Index of the gas component.
Definition BlackOilDefaultFluidSystemIndices.hpp:59
Opm::BlackOilDefaultFluidSystemIndices::componentToPhaseIdx
static constexpr int componentToPhaseIdx(int compIdx)
Map component index to phase index.
Definition BlackOilDefaultFluidSystemIndices.hpp:65
Opm::BlackOilDefaultFluidSystemIndices::numPhases
static constexpr unsigned numPhases
Total number of phases.
Definition BlackOilDefaultFluidSystemIndices.hpp:42
Opm
This class implements a small container which holds the transmissibility mulitpliers for all the face...
Definition Exceptions.hpp:30