My Project
Loading...
Searching...
No Matches
blackoilfoamparams.hpp
Go to the documentation of this file.
1// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2// vi: set et ts=4 sw=4 sts=4:
3/*
4 This file is part of the Open Porous Media project (OPM).
5
6 OPM is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 2 of the License, or
9 (at your option) any later version.
10
11 OPM is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with OPM. If not, see <http://www.gnu.org/licenses/>.
18
19 Consult the COPYING file in the top-level source directory of this
20 module for the precise wording of the license and the list of
21 copyright holders.
22*/
28#ifndef OPM_BLACK_OIL_FOAM_PARAMS_HPP
29#define OPM_BLACK_OIL_FOAM_PARAMS_HPP
30
31#include <opm/material/common/Tabulated1DFunction.hpp>
32
33#include <vector>
34
35namespace Opm {
36
37enum class Phase;
38
39#if HAVE_ECL_INPUT
40class EclipseState;
41#endif
42
44template<class Scalar>
46{
47 using TabulatedFunction = Tabulated1DFunction<Scalar>;
48
49#if HAVE_ECL_INPUT
50 template<bool enableFoam>
51 void initFromState(const EclipseState& eclState);
52#endif
53
57 void setNumSatRegions(unsigned numRegions);
58
59 // a struct containing constants to calculate change to relative permeability,
60 // based on model (1-9) in Table 1 of
61 // Kun Ma, Guangwei Ren, Khalid Mateen, Danielle Morel, and Philippe Cordelier:
62 // "Modeling techniques for foam flow in porous media", SPE Journal, 20(03):453–470, jun 2015.
63 // The constants are provided by various deck keywords as shown in the comments below.
65 Scalar fm_min = 1e-20; // FOAMFSC
66 Scalar fm_mob = 1.0; // FOAMFRM
67
68 Scalar fm_surf = 1.0; // FOAMFSC
69 Scalar ep_surf = 1.0; // FOAMFSC
70
71 Scalar fm_oil = 1.0; // FOAMFSO
72 Scalar fl_oil = 0.0; // FOAMFSO
73 Scalar ep_oil = 0.0; // FOAMFSO
74
75 Scalar fm_cap = 1.0; // FOAMFCN
76 Scalar ep_cap = 0.0; // FOAMFCN
77
78 Scalar fm_dry = 1.0; // FOAMFSW
79 Scalar ep_dry = 0.0; // FOAMFSW
80 };
81
82 std::vector<Scalar> foamRockDensity_;
83 std::vector<bool> foamAllowDesorption_;
84 std::vector<FoamCoefficients> foamCoefficients_;
85 std::vector<TabulatedFunction> adsorbedFoamTable_;
86 std::vector<TabulatedFunction> gasMobilityMultiplierTable_;
87 Opm::Phase transport_phase_;
88};
89
90} // namespace Opm
91
92#endif // OPM_BLACK_OIL_FOAM_PARAMS_HPP
This file contains a set of helper functions used by VFPProd / VFPInj.
Definition blackoilboundaryratevector.hh:37
constexpr auto getPropValue()
get the value data member of a property
Definition propertysystem.hh:242
Definition blackoilfoamparams.hpp:64
Struct holding the parameters for the BlackoilFoamModule class.
Definition blackoilfoamparams.hpp:46
void setNumSatRegions(unsigned numRegions)
Specify the number of saturation regions.
Definition blackoilfoamparams.cpp:131