Loading...
Searching...
No Matches
MaterialTraits.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_MATERIAL_TRAITS_HPP
#define OPM_MATERIAL_TRAITS_HPP
namespace Opm {
template <class ScalarT, int numPhasesV>
class NullMaterialTraits
{
public:
using Scalar = ScalarT;
static constexpr int numPhases = numPhasesV;
};
template <class ScalarT, int wettingPhaseIdxV, int nonWettingPhaseIdxV>
class TwoPhaseMaterialTraits
{
public:
using Scalar = ScalarT;
static constexpr int numPhases = 2;
static constexpr int wettingPhaseIdx = wettingPhaseIdxV;
static constexpr int nonWettingPhaseIdx = nonWettingPhaseIdxV;
// some safety checks...
static_assert(wettingPhaseIdx != nonWettingPhaseIdx,
"wettingPhaseIdx and nonWettingPhaseIdx must be different");
};
template <class ScalarT, int wettingPhaseIdxV, int nonWettingasPhaseIdxV, int gasPhaseIdxV,
bool enableHysteresisV, bool enableEndpointScalingV>
class ThreePhaseMaterialTraits
{
public:
using Scalar = ScalarT;
static constexpr int numPhases = 3;
static constexpr int wettingPhaseIdx = wettingPhaseIdxV;
static constexpr int nonWettingPhaseIdx = nonWettingasPhaseIdxV;
static constexpr int gasPhaseIdx = gasPhaseIdxV;
static constexpr bool enableHysteresis = enableHysteresisV;
static constexpr bool enableEndpointScaling = enableEndpointScalingV;
// some safety checks...
static_assert(0 <= wettingPhaseIdx && wettingPhaseIdx < numPhases,
"wettingPhaseIdx is out of range");
static_assert(0 <= nonWettingPhaseIdx && nonWettingPhaseIdx < numPhases,
"nonWettingPhaseIdx is out of range");
static_assert(0 <= gasPhaseIdx && gasPhaseIdx < numPhases,
"gasPhaseIdx is out of range");
static_assert(wettingPhaseIdx != nonWettingPhaseIdx,
"wettingPhaseIdx and nonWettingPhaseIdx must be different");
static_assert(wettingPhaseIdx != gasPhaseIdx,
"wettingPhaseIdx and gasPhaseIdx must be different");
static_assert(nonWettingPhaseIdx != gasPhaseIdx,
"nonWettingPhaseIdx and gasPhaseIdx must be different");
};
} // namespace Opm
#endif
Opm::NullMaterialTraits
A generic traits class which does not provide any indices.
Definition MaterialTraits.hpp:45
Opm::NullMaterialTraits::Scalar
ScalarT Scalar
The type used for scalar floating point values.
Definition MaterialTraits.hpp:48
Opm::NullMaterialTraits::numPhases
static constexpr int numPhases
The number of fluid phases.
Definition MaterialTraits.hpp:51
Opm::ThreePhaseMaterialTraits
A generic traits class for three-phase material laws.
Definition MaterialTraits.hpp:88
Opm::ThreePhaseMaterialTraits::Scalar
ScalarT Scalar
The type used for scalar floating point values.
Definition MaterialTraits.hpp:91
Opm::ThreePhaseMaterialTraits::gasPhaseIdx
static constexpr int gasPhaseIdx
The index of the gas phase (i.e., the least wetting phase).
Definition MaterialTraits.hpp:103
Opm::ThreePhaseMaterialTraits::nonWettingPhaseIdx
static constexpr int nonWettingPhaseIdx
The index of the non-wetting liquid phase.
Definition MaterialTraits.hpp:100
Opm::ThreePhaseMaterialTraits::wettingPhaseIdx
static constexpr int wettingPhaseIdx
The index of the wetting liquid phase.
Definition MaterialTraits.hpp:97
Opm::ThreePhaseMaterialTraits::numPhases
static constexpr int numPhases
The number of fluid phases.
Definition MaterialTraits.hpp:94
Opm::ThreePhaseMaterialTraits::enableHysteresis
static constexpr bool enableHysteresis
Is hysteresis enabled.
Definition MaterialTraits.hpp:106
Opm::ThreePhaseMaterialTraits::enableEndpointScaling
static constexpr bool enableEndpointScaling
Is endpoint scaling enabled.
Definition MaterialTraits.hpp:109
Opm::TwoPhaseMaterialTraits
A generic traits class for two-phase material laws.
Definition MaterialTraits.hpp:61
Opm::TwoPhaseMaterialTraits< typename Traits::Scalar, Traits::nonWettingPhaseIdx, Traits::gasPhaseIdx >::nonWettingPhaseIdx
static constexpr int nonWettingPhaseIdx
Definition MaterialTraits.hpp:73
Opm::TwoPhaseMaterialTraits< typename Traits::Scalar, Traits::nonWettingPhaseIdx, Traits::gasPhaseIdx >::wettingPhaseIdx
static constexpr int wettingPhaseIdx
Definition MaterialTraits.hpp:70
Opm::TwoPhaseMaterialTraits< typename Traits::Scalar, Traits::nonWettingPhaseIdx, Traits::gasPhaseIdx >::Scalar
typename Traits::Scalar Scalar
Definition MaterialTraits.hpp:64
Opm::TwoPhaseMaterialTraits< typename Traits::Scalar, Traits::nonWettingPhaseIdx, Traits::gasPhaseIdx >::numPhases
static constexpr int numPhases
Definition MaterialTraits.hpp:67
Opm
This class implements a small container which holds the transmissibility mulitpliers for all the face...
Definition Exceptions.hpp:30